Skip to main content

GenericLayer

Struct GenericLayer 

Source
pub struct GenericLayer {
    pub index: LayerIndex,
    pub name: Arc<str>,
    pub field_descs: Arc<Vec<GenericFieldDesc>>,
}
Expand description

A dynamically-defined protocol layer for custom / user-defined protocols.

The field descriptors are shared (Arc) so they can be defined once and reused across many packet instances efficiently.

Fields§

§index: LayerIndex

Position of this layer within the packet buffer.

§name: Arc<str>

Protocol name as defined by the caller.

§field_descs: Arc<Vec<GenericFieldDesc>>

Shared field descriptors.

Implementations§

Source§

impl GenericLayer

Source

pub fn new( index: LayerIndex, name: Arc<str>, field_descs: Arc<Vec<GenericFieldDesc>>, ) -> Self

Create a new GenericLayer.

Source

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

Human-readable summary: "<name> (<N> fields)".

Source

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

Header length = sum of all field sizes.

Source

pub fn field_names_dynamic(&self) -> Vec<String>

Dynamic list of field names (not &'static str because names come from user-defined strings at runtime).

Source

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

Read a field from the buffer.

Returns:

  • Some(Ok(value)) if the field was found and the buffer is long enough.
  • Some(Err(e)) if the field was found but the buffer is too short.
  • None if no field with this name exists in this layer.
Source

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

Write a field into the (mutable) buffer.

Returns:

  • Some(Ok(())) if the field was found and written successfully.
  • Some(Err(e)) if the field was found but the buffer is too short or the value type is wrong.
  • None if no field with this name exists in this layer.

Trait Implementations§

Source§

impl Clone for GenericLayer

Source§

fn clone(&self) -> GenericLayer

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 GenericLayer

Source§

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

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

impl Layer for GenericLayer

Source§

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

The Layer trait requires &'static [&'static str], which is not possible for dynamically-generated field names. Returns an empty slice; callers that need the full list should call field_names_dynamic directly.

Source§

fn kind(&self) -> LayerKind

Get the kind of this layer
Source§

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

Get a human-readable summary of this layer
Source§

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

Get the header length for this layer
Source§

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

Compute a hash for packet matching.
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