Struct ImapLayer 

pub struct ImapLayer {
    pub index: LayerIndex,
}

A zero-copy view into an IMAP layer within a packet buffer.

Fields

index: LayerIndex

Implementations

impl ImapLayer

pub fn new(index: LayerIndex) -> Self

pub fn at_start(len: usize) -> Self

pub fn is_untagged(&self, buf: &[u8]) -> bool

Returns true if this is an untagged server response (starts with “* “).

pub fn is_continuation(&self, buf: &[u8]) -> bool

Returns true if this is a continuation request (starts with “+ “).

pub fn is_tagged_response(&self, buf: &[u8]) -> bool

Returns true if this is a tagged server response.

pub fn is_client_command(&self, buf: &[u8]) -> bool

Returns true if this is a client command.

pub fn tag(&self, buf: &[u8]) -> Result<String, FieldError>

Returns the tag from a tagged command or response.

Returns “*” for untagged, “+” for continuation.

Errors

Returns FieldError::InvalidValue if the payload is not valid UTF-8.

pub fn command(&self, buf: &[u8]) -> Result<String, FieldError>

Returns the command verb for a client command.

Errors

Returns FieldError::InvalidValue if the IMAP line cannot be parsed.

pub fn args(&self, buf: &[u8]) -> Result<String, FieldError>

Returns the arguments / data portion of the line.

Errors

Returns FieldError::InvalidValue if the payload is not valid UTF-8.

pub fn status(&self, buf: &[u8]) -> Result<String, FieldError>

Returns the status from a tagged or untagged server response (OK/NO/BAD/BYE/PREAUTH).

Errors

Returns FieldError::InvalidValue if the command verb is not a known status keyword.

pub fn text(&self, buf: &[u8]) -> Result<String, FieldError>

Returns the text body of a server response (after the status code).

Errors

Returns FieldError::InvalidValue if the payload is not valid UTF-8.

pub fn raw(&self, buf: &[u8]) -> String

Returns the raw payload as a string.

pub fn get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Trait Implementations

impl Clone for ImapLayer

fn clone(&self) -> ImapLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImapLayer

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

Formats the value using the given formatter.

impl From<ImapLayer> for LayerEnum

fn from(v: ImapLayer) -> LayerEnum

Converts to this type from the input type.

impl Layer for ImapLayer

fn kind(&self) -> LayerKind

Get the kind of this layer

fn summary(&self, buf: &[u8]) -> String

Get a human-readable summary of this layer

fn header_len(&self, buf: &[u8]) -> usize

Get the header length for this layer

fn hashret(&self, buf: &[u8]) -> Vec<u8>

Compute a hash for packet matching.

fn field_names(&self) -> &'static [&'static str]

Get the list of field names for this layer

fn answers(&self, _data: &[u8], _other: &Self, _other_data: &[u8]) -> bool

Check if this packet answers another packet.

fn extract_padding<'a>(&self, data: &'a [u8]) -> (&'a [u8], &'a [u8])

Extract padding from the packet.

impl LayerDispatch for ImapLayer

fn dispatch_kind(&self) -> LayerKind

Get the kind of this layer.

fn dispatch_index(&self) -> &LayerIndex

Get the layer index (start/end offsets).

fn dispatch_summary(&self, buf: &[u8]) -> String

Get a human-readable summary.

fn dispatch_header_len(&self, buf: &[u8]) -> usize

Get the header length in bytes.

fn dispatch_hashret(&self, buf: &[u8]) -> Vec<u8>

Compute a hash for packet matching.

fn dispatch_field_names(&self) -> &'static [&'static str]

Get field names for this layer type.

fn dispatch_get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.

fn dispatch_set_field( &self, _buf: &mut [u8], _name: &str, _value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.

fn dispatch_show_fields(&self, buf: &[u8]) -> Vec<(&'static str, String)>

Get show-fields output.

impl TryInto<ImapLayer> for LayerEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ImapLayer, <Self as TryInto<ImapLayer>>::Error>

Performs the conversion.