Struct capsule::Mbuf

pub struct Mbuf { /* fields omitted */ }

A DPDK message buffer that carries the network packet.

Remarks

Multi-segment Mbuf is not supported. It's the application's responsibilty to ensure that the ethernet device's MTU is less than the default size of a single Mbuf segment (RTE_MBUF_DEFAULT_DATAROOM = 2048).

Implementations

impl Mbuf

pub fn new() -> Fallible<Self>

Creates a new message buffer.

The Mbuf is allocated from the Mempool assigned to the current executing thread by the Runtime. The call will fail if invoked from a thread not managed by the Runtime.

pub fn from_bytes(data: &[u8]) -> Fallible<Self>

Creates a new message buffer from a byte array.

pub fn data_len(&self) -> usize

Returns amount of data stored in the buffer.

pub fn extend(&mut self, offset: usize, len: usize) -> Fallible<()>

Extends the data buffer at offset by len bytes.

If the offset is not at the end of the data. The data after the offset is shifted down to make room.

pub fn shrink(&mut self, offset: usize, len: usize) -> Fallible<()>

Shrinks the data buffer at offset by len bytes.

The data at offset is shifted up.

pub fn resize(&mut self, offset: usize, len: isize) -> Fallible<()>

Resizes the data buffer.

pub fn truncate(&mut self, to_len: usize) -> Fallible<()>

Truncates the data buffer to len.

pub fn read_data<T: SizeOf>(&self, offset: usize) -> Fallible<NonNull<T>>

Reads the data at offset as T and returns it as a raw pointer.

pub fn write_data<T: SizeOf>(
    &mut self,
    offset: usize,
    item: &T
) -> Fallible<NonNull<T>>

Writes T to the data buffer at offset and returns the new copy as a raw pointer.

Before writing to the data buffer, should call Mbuf::extend first to make sure enough space is allocated for the write and data is not being overridden.

pub fn read_data_slice<T: SizeOf>(
    &self,
    offset: usize,
    count: usize
) -> Fallible<NonNull<[T]>>

Reads the data at offset as a slice of T and returns the slice as a raw pointer.

pub fn write_data_slice<T: SizeOf>(
    &mut self,
    offset: usize,
    slice: &[T]
) -> Fallible<NonNull<[T]>>

Writes a slice of T to the data buffer at offset and returns the new copy as a raw pointer.

Before writing to the data buffer, should call Mbuf::extend first to make sure enough space is allocated for the write and data is not being overridden.

pub fn alloc_bulk(len: usize) -> Fallible<Vec<Mbuf>>

Allocates a Vec of Mbufs of len size.

Trait Implementations

impl Arbitrary for Mbuf

type Parameters = ()

The type of parameters that [arbitrary_with] accepts for configuration of the generated [Strategy]. Parameters must implement [Default].

type Strategy = fn() -> Self

The type of [Strategy] used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a [Strategy] for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a [Strategy] for producing arbitrary values of type the implementing type (Self).

impl Debug for Mbuf

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

Formats the value using the given formatter.

impl Drop for Mbuf

fn drop(&mut self)

Executes the destructor for this type.

impl Packet for Mbuf

type Envelope = Mbuf

The preceding packet type that encapsulates this packet.

fn envelope(&self) -> &Self::Envelope

Returns a reference to the envelope.

fn envelope_mut(&mut self) -> &mut Self::Envelope

Returns a mutable reference to the envelope.

fn mbuf(&self) -> &Mbuf

Returns a reference to the raw message buffer.

fn mbuf_mut(&mut self) -> &mut Mbuf

Returns a mutable reference to the raw message buffer.

fn offset(&self) -> usize

Returns the buffer offset where the current packet begins.

fn header_len(&self) -> usize

Returns the length of the packet header.

unsafe fn clone(&self, _internal: Internal) -> Self

Returns a copy of the packet.

fn try_parse(envelope: Self::Envelope, _internal: Internal) -> Fallible<Self>

Parses the envelope's payload as this packet type.

fn try_push(envelope: Self::Envelope, _internal: Internal) -> Fallible<Self>

Prepends a new packet to the beginning of the envelope's payload.

fn deparse(self) -> Self::Envelope

Deparses the packet back to the envelope's packet type.

fn remove(self) -> Fallible<Self::Envelope>

Removes this packet's header from the message buffer.

fn reset(self) -> Mbuf

Resets the parsed packet back to Mbuf.

fn reconcile_all(&mut self)

Reconciles against the changes recursively through all layers.

fn payload_offset(&self) -> usize

Returns the buffer offset where the packet payload begins.

fn len(&self) -> usize

Returns the length of the packet with the payload.

fn payload_len(&self) -> usize

Returns the length of the packet payload.

fn parse<T: Packet<Envelope = Self>>(self) -> Fallible<T> where
    Self: Sized, 

Parses the packet's payload as a packet of type T.

fn peek<T: Packet<Envelope = Self>>(&self) -> Fallible<Immutable<T>> where
    Self: Sized, 

Peeks into the packet's payload as a packet of type T.

fn push<T: Packet<Envelope = Self>>(self) -> Fallible<T> where
    Self: Sized, 

Prepends a new packet of type T to the beginning of the envelope's payload.

fn remove_payload(&mut self) -> Fallible<()>

Removes the packet's payload from the message buffer.

fn reconcile(&mut self)

Reconciles the derivable header fields against the changes made to the packet.

impl Send for Mbuf