Struct ImapCodec 

pub struct ImapCodec { /* private fields */ }

Tokio codec for IMAP. Switches between line mode (CRLF-terminated commands + responses) and literal mode (raw byte-counted payloads).

IMAP uses literals (e.g. {12}\r\nHello world!) for arbitrary binary content — passwords with special chars, APPEND payloads, FETCH BODY[…] data. The protocol layer parses the {N} marker, then calls expect_literal to tell the codec to read the next N bytes as raw data instead of splitting on CRLF.

Implementations

impl ImapCodec

pub fn new() -> Self

New codec in line mode.

pub fn expect_literal(&mut self, size: u32)

Switch the codec into literal mode for the next decode. size is the byte count parsed from the IMAP {N} marker. After exactly size bytes have been read, the codec auto-switches back to line mode (consuming any trailing CRLF if present).

Trait Implementations

impl Decoder for ImapCodec

type Item = ImapInput

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for ImapCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Vec<u8>> for ImapCodec

type Error = Error

The type of encoding errors.

fn encode( &mut self, item: Vec<u8>, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.