Struct FtpLayer 

pub struct FtpLayer {
    pub index: LayerIndex,
}

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

FTP is text-based, so all field access involves parsing ASCII text from the buffer slice on demand.

Fields

index: LayerIndex

Implementations

impl FtpLayer

pub fn new(index: LayerIndex) -> Self

pub fn at_start(len: usize) -> Self

pub fn message_kind(&self, buf: &[u8]) -> FtpMessageKind

Determine if this message is a reply (starts with 3-digit code) or command.

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

Returns the FTP command verb (for client messages).

Returns Err if this is a server reply, not a command.

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 (everything after the verb on the first line).

Errors

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

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

Returns the 3-digit reply code (for server replies).

Errors

Returns FieldError::BufferTooShort if fewer than 3 bytes are available, or FieldError::InvalidValue if the first 3 bytes are not ASCII digits.

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

Returns the reply text (text following the code, stripped of CR/LF).

Errors

Returns FieldError::InvalidValue if the payload is not valid UTF-8 or does not begin with a valid 3-digit reply code.

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

Returns true if this is a server reply (starts with a 3-digit code).

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

Returns true if this is a multi-line reply (code followed by -).

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

Returns the raw payload as a UTF-8 string (best effort).

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

Get a field by name.

Trait Implementations

impl Clone for FtpLayer

fn clone(&self) -> FtpLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FtpLayer

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

Formats the value using the given formatter.

impl From<FtpLayer> for LayerEnum

fn from(v: FtpLayer) -> LayerEnum

Converts to this type from the input type.

impl Layer for FtpLayer

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 FtpLayer

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

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.