Enum imap_codec::decode::CommandDecodeError

pub enum CommandDecodeError<'a> {
    Incomplete,
    LiteralFound {
        tag: Tag<'a>,
        length: u32,
        mode: LiteralMode,
    },
    Failed,
}

Error during command decoding.

Variants

Incomplete

More data is needed.

LiteralFound

Fields

tag: Tag<'a>

The corresponding command (tag) to which this literal is bound.

This is required to reject literals, e.g., when their size exceeds a limit.

length: u32

Literal length.

mode: LiteralMode

Literal mode, i.e., sync or non-sync.

More data is needed (and further action may be necessary).

The decoder stopped at the beginning of literal data. Typically, a server MUST send a command continuation request to agree to the receival of the remaining data. This behaviour is different when LITERAL+/LITERAL- is used.

With LITERAL+/LITERAL-

When the mode is sync, everything is the same as above.

When the mode is non-sync, and the server advertised the LITERAL+ capability, it MUST NOT send a command continuation request and accept the data right away.

When the mode is non-sync, and the server advertised the LITERAL- capability, and the literal length is smaller or equal than 4096, it MUST NOT send a command continuation request and accept the data right away.

When the mode is non-sync, and the server advertised the LITERAL- capability, and the literal length is greater than 4096, it MUST be handled as sync.

match mode {
    LiteralMode::Sync => /* Same as sync. */
    LiteralMode::Sync => match advertised {
        Capability::LiteralPlus => /* Accept data right away. */
        Capability::LiteralMinus => {
            if literal_length <= 4096 {
                /* Accept data right away. */
            } else {
                /* Same as sync. */
            }
        }
    }
}

Failed

Decoding failed.

Trait Implementations

impl<'a> Clone for CommandDecodeError<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommandDecodeError<'a>

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

Formats the value using the given formatter.

impl<'a> IntoBoundedStatic for CommandDecodeError<'a>

type Static = CommandDecodeError<'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<CommandDecodeError<'a>> for CommandDecodeError<'a>

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

type Static = CommandDecodeError<'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> Eq for CommandDecodeError<'a>

impl<'a> StructuralEq for CommandDecodeError<'a>

impl<'a> StructuralPartialEq for CommandDecodeError<'a>