Struct driver_net::NetBuffer

source ·
pub struct NetBuffer<'a> { /* private fields */ }
Expand description

A RAII network buffer.

It should be allocated from the NetBufferPool, and it will be deallocated into the pool automatically when dropped.

The layout of the buffer is:

  ______________________ capacity ______________________
 /                                                      \
+------------------+------------------+------------------+
|      Header      |      Packet      |      Unused      |
+------------------+------------------+------------------+
|\__ header_len __/ \__ packet_len __/
|
buf_ptr

Implementations§

source§

impl<'a> NetBuffer<'a>

source

pub const fn capacity(&self) -> usize

Returns the capacity of the buffer.

source

pub const fn header(&self) -> &[u8]

Returns the header part of the buffer.

source

pub const fn packet(&self) -> &[u8]

Returns the packet part of the buffer.

source

pub const fn packet_mut(&mut self) -> &mut [u8]

Returns the mutable reference to the packet part.

source

pub const fn packet_with_header(&self) -> &[u8]

Returns both the header and the packet parts, as a contiguous slice.

source

pub const fn raw_buf(&self) -> &[u8]

Returns the entire buffer.

source

pub const fn raw_buf_mut(&mut self) -> &mut [u8]

Returns the mutable reference to the entire buffer.

source

pub fn set_header_len(&mut self, header_len: usize)

Set the length of the header part.

source

pub fn set_packet_len(&mut self, packet_len: usize)

Set the length of the packet part.

Trait Implementations§

source§

impl Drop for NetBuffer<'_>

source§

fn drop(&mut self)

Deallocates the buffer into the NetBufferPool.

source§

impl Send for NetBuffer<'_>

source§

impl Sync for NetBuffer<'_>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for NetBuffer<'a>

§

impl<'a> Unpin for NetBuffer<'a>

§

impl<'a> !UnwindSafe for NetBuffer<'a>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.