Struct Pop3Layer 

pub struct Pop3Layer {
    pub index: LayerIndex,
}

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

Fields

index: LayerIndex

Implementations

impl Pop3Layer

pub fn new(index: LayerIndex) -> Self

pub fn at_start(len: usize) -> Self

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

Returns true if this is a server response (starts with +OK or -ERR).

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

Returns true if this is a positive response (+OK).

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

Returns true if this is a negative response (-ERR).

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

Returns the response text after +OK or -ERR (trimmed).

Errors

Returns FieldError::InvalidValue if the payload is not valid UTF-8 or does not begin with +OK or -ERR.

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

Returns the command verb (for client commands).

Errors

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

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

Returns the command arguments.

Errors

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

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

Returns the raw payload.

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

Trait Implementations

impl Clone for Pop3Layer

fn clone(&self) -> Pop3Layer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pop3Layer

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

Formats the value using the given formatter.

impl From<Pop3Layer> for LayerEnum

fn from(v: Pop3Layer) -> LayerEnum

Converts to this type from the input type.

impl Layer for Pop3Layer

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 Pop3Layer

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<Pop3Layer> for LayerEnum

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.