Struct imap_types::core::Text

pub struct Text<'a>(_);

A human-readable text string used in some server responses.

Example

S: * OK IMAP4rev1 server ready
//      ^^^^^^^^^^^^^^^^^^^^^^
//      |
//      `Text`

ABNF definition

text      = 1*TEXT-CHAR
TEXT-CHAR = <any CHAR except CR and LF>
CHAR      = %x01-7F                     ; any 7-bit US-ASCII character, excluding NUL
CR        = %x0D                        ; carriage return
LF        = %x0A                        ; linefeed

Implementations

impl<'a> Text<'a>

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

pub fn inner(&self) -> &str

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

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

Available on crate feature unvalidated only.

Constructs a text 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 Text<'a>

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

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 Text<'a>

fn as_ref(&self) -> &str

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

impl<'a> Clone for Text<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Text<'a>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<'a> Hash for Text<'a>

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

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 Text<'a>

type Static = Text<'static>

The target type is bounded by the 'static lifetime.

fn into_static(self) -> Self::Static

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

impl<'a> PartialEq<Text<'a>> for Text<'a>

fn eq(&self, other: &Text<'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 Text<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> ToBoundedStatic for Text<'a>

type Static = Text<'static>

The target type is bounded by the 'static lifetime.

fn to_static(&self) -> Self::Static

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

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

type Error = TextError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TextError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TextError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

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

type Error = TextError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for Text<'a>

impl<'a> StructuralEq for Text<'a>

impl<'a> StructuralPartialEq for Text<'a>