Struct imap_codec::core::AtomExt

pub struct AtomExt<'a>(_);

A string subset to model IMAP’s 1*ASTRING-CHAR (“extended atom”).

This type is required due to the use of 1*ASTRING-CHAR in astring, see ABNF definition below.

Rules:

• Length must be >= 1
• Only some characters are allowed, e.g., no whitespace

ABNF definition

astring      = 1*ASTRING-CHAR / string
;              ^^^^^^^^^^^^^^
;              |
;              `AtomExt`

ASTRING-CHAR = ATOM-CHAR / resp-specials
;              ^^^^^^^^^   ^^^^^^^^^^^^^
;              |           |
;              |           Additionally allowed in `AtomExt`
;              See `Atom`

Implementations

impl<'a> AtomExt<'a>

pub fn validate(value: impl AsRef<[u8]>) -> Result<(), AtomExtError>

Validates if value conforms to extended atom’s ABNF definition.

pub fn inner(&self) -> &str

Returns a reference to the inner value.

pub fn into_inner(self) -> Cow<'a, str>

Consumes the atom, returning the inner value.

pub fn unvalidated<C>(inner: C) -> AtomExt<'a>where C: Into<Cow<'a, str>>,

Constructs an extended atom without validation.

Warning: IMAP conformance

The caller must ensure that inner is valid according to Self::validate. Failing to do so may create invalid/unparsable IMAP messages, or even produce unintended protocol flows. Do not call this constructor with untrusted data.

Trait Implementations

impl<'a> Arbitrary<'a> for AtomExt<'a>

fn arbitrary(u: &mut Unstructured<'a>) -> Result<AtomExt<'a>, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<'a> AsRef<str> for AtomExt<'a>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for AtomExt<'a>

fn clone(&self) -> AtomExt<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for AtomExt<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for AtomExt<'a>

fn deserialize<__D>( __deserializer: __D ) -> Result<AtomExt<'a>, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<Atom<'a>> for AtomExt<'a>

fn from(value: Atom<'a>) -> AtomExt<'a>

Converts to this type from the input type.

impl<'a> From<AtomExt<'a>> for AString<'a>

fn from(atom: AtomExt<'a>) -> AString<'a>

Converts to this type from the input type.

impl<'a> Hash for AtomExt<'a>

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoBoundedStatic for AtomExt<'a>

type Static = AtomExt<'static>

The target type is bounded by the 'static lifetime.

fn into_static(self) -> <AtomExt<'a> as IntoBoundedStatic>::Static

Convert an owned T into an owned T such that T: 'static.

impl<'a> PartialEq<AtomExt<'a>> for AtomExt<'a>

fn eq(&self, other: &AtomExt<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for AtomExt<'a>

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> ToBoundedStatic for AtomExt<'a>

type Static = AtomExt<'static>

The target type is bounded by the 'static lifetime.

fn to_static(&self) -> <AtomExt<'a> as ToBoundedStatic>::Static

Convert an &T to an owned T such that T: 'static.

impl<'a> TryFrom<&'a [u8]> for AtomExt<'a>

type Error = AtomExtError

The type returned in the event of a conversion error.

fn try_from( value: &'a [u8] ) -> Result<AtomExt<'a>, <AtomExt<'a> as TryFrom<&'a [u8]>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for AtomExt<'a>

type Error = AtomExtError

The type returned in the event of a conversion error.

fn try_from( value: &'a str ) -> Result<AtomExt<'a>, <AtomExt<'a> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<'a> TryFrom<String> for AtomExt<'a>

type Error = AtomExtError

The type returned in the event of a conversion error.

fn try_from( value: String ) -> Result<AtomExt<'a>, <AtomExt<'a> as TryFrom<String>>::Error>

Performs the conversion.

impl<'a> TryFrom<Vec<u8, Global>> for AtomExt<'a>

type Error = AtomExtError

The type returned in the event of a conversion error.

fn try_from( value: Vec<u8, Global> ) -> Result<AtomExt<'a>, <AtomExt<'a> as TryFrom<Vec<u8, Global>>>::Error>

Performs the conversion.

impl<'a> Eq for AtomExt<'a>

impl<'a> StructuralEq for AtomExt<'a>

impl<'a> StructuralPartialEq for AtomExt<'a>