Skip to main content

FtpLayer

Struct FtpLayer 

Source
pub struct FtpLayer {
    pub index: LayerIndex,
}
Expand description

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§

Source§

impl FtpLayer

Source

pub fn new(index: LayerIndex) -> Self

Source

pub fn at_start(len: usize) -> Self

Source

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

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

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

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

Source

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

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

Source

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

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

Source

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

Get a field by name.

Trait Implementations§

Source§

impl Clone for FtpLayer

Source§

fn clone(&self) -> FtpLayer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FtpLayer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Layer for FtpLayer

Source§

fn kind(&self) -> LayerKind

Get the kind of this layer
Source§

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

Get a human-readable summary of this layer
Source§

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

Get the header length for this layer
Source§

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

Compute a hash for packet matching.
Source§

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

Get the list of field names for this layer
Source§

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

Check if this packet answers another packet.
Source§

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

Extract padding from the packet.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V