Struct imap_codec::core::Literal

pub struct Literal<'a> { /* private fields */ }

A literal.

“A literal is a sequence of zero or more octets (including CR and LF), prefix-quoted with an octet count in the form of an open brace (”{“), the number of octets, close brace (”}“), and CRLF. In the case of literals transmitted from server to client, the CRLF is immediately followed by the octet data. In the case of literals transmitted from client to server, the client MUST wait to receive a command continuation request (…) before sending the octet data (and the remainder of the command).

Note: Even if the octet count is 0, a client transmitting a literal MUST wait to receive a command continuation request.“ (RFC 3501)

Implementations

impl<'a> Literal<'a>

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

pub fn data(&self) -> &[u8]

pub fn new_unchecked(data: Cow<'a, [u8]>) -> Literal<'a>

Create a literal from a byte sequence without checking that it conforms to IMAP’s literal specification.

Safety

Call this function only when you are sure that the byte sequence is a valid literal, i.e., that it does not contain 0x00.

Trait Implementations

impl<'a> AsRef<[u8]> for Literal<'a>

fn as_ref(&self) -> &[u8]

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

impl<'a> Clone for Literal<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Literal<'a>

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

Formats the value using the given formatter.

impl<'a> Encode for Literal<'a>

fn encode(&self, writer: &mut impl Write) -> Result<(), Error>

fn encode_detached(&self) -> Result<Vec<u8, Global>, Error>

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

fn from(value: Literal<'a>) -> AString<'a>

Converts to this type from the input type.

impl<'a> From<Literal<'a>> for IString<'a>

fn from(value: Literal<'a>) -> IString<'a>

Converts to this type from the input type.

impl<'a> Hash for Literal<'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> PartialEq<Literal<'a>> for Literal<'a>

fn eq(&self, other: &Literal<'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> TryFrom<&'a [u8]> for Literal<'a>

type Error = LiteralError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = LiteralError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = LiteralError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = LiteralError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> Eq for Literal<'a>

impl<'a> StructuralEq for Literal<'a>

impl<'a> StructuralPartialEq for Literal<'a>