diff options
| author | Philipp Korber <philippkorber@gmail.com> | 2019-03-14 14:51:18 +0100 |
|---|---|---|
| committer | Philipp Korber <p.korber@dac.eu> | 2019-10-11 16:33:19 +0200 |
| commit | b3026512aa9ce16c9a159d6d7de22ba0c0b93eb7 (patch) | |
| tree | c5e5bb27e93de9d28a25c4e0ec5d4714bb6b2420 | |
| parent | 02f02d0165beaf9f4b54de0c10a37d45cef1f8af (diff) | |
doc(headers): added warnings about using some parts likely to change in the future.
| -rw-r--r-- | headers/src/header_components/phrase.rs | 5 | ||||
| -rw-r--r-- | headers/src/header_components/word.rs | 4 |
2 files changed, 8 insertions, 1 deletions
diff --git a/headers/src/header_components/phrase.rs b/headers/src/header_components/phrase.rs index 8f6a9ce..0d58d2c 100644 --- a/headers/src/header_components/phrase.rs +++ b/headers/src/header_components/phrase.rs @@ -16,6 +16,11 @@ use super::{ CFWS, FWS }; /// /// It is recommended to use the [`Phrase.new()`] constructor, which creates the right phrase /// for your input. +/// +/// **Warning: Details of this type, expect `Phrase::new` and `Phrase::try_from`, are likely to +/// change with some of the coming braking changes.** If you just create it using `try_from` +/// or `new` changes should not affect you, but if you create it from a vec of `Word`'s things +/// might be different. #[derive( Debug, Clone, Eq, PartialEq, Hash )] pub struct Phrase( //FIXME hide this away or at last turn it into a struct field, with next braking change. 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>, |