summaryrefslogtreecommitdiffstats
path: root/headers/src/header_components/word.rs
diff options
context:
space:
mode:
authorPhilipp Korber <philippkorber@gmail.com>2019-03-14 14:51:18 +0100
committerPhilipp Korber <p.korber@dac.eu>2019-10-11 16:33:19 +0200
commitb3026512aa9ce16c9a159d6d7de22ba0c0b93eb7 (patch)
treec5e5bb27e93de9d28a25c4e0ec5d4714bb6b2420 /headers/src/header_components/word.rs
parent02f02d0165beaf9f4b54de0c10a37d45cef1f8af (diff)
doc(headers): added warnings about using some parts likely to change in the future.
Diffstat (limited to 'headers/src/header_components/word.rs')
-rw-r--r--headers/src/header_components/word.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/headers/src/header_components/word.rs b/headers/src/header_components/word.rs
index 84713ca..448b0da 100644
--- a/headers/src/header_components/word.rs
+++ b/headers/src/header_components/word.rs
@@ -14,7 +14,9 @@ use ::data::Input;
use super::CFWS;
-
+/// A ward as in the mail grammar (RFC 5322).
+///
+/// **Warning: This is likely to change in the future before the 1.0 release**.
#[derive( Debug, Clone, Eq, PartialEq, Hash )]
pub struct Word {
pub left_padding: Option<CFWS>,