Struct driver_net::NetBuf

pub struct NetBuf { /* private fields */ }

A RAII network buffer.

It should be allocated from the NetBufPool, 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

impl NetBuf

pub const fn capacity(&self) -> usize

Returns the capacity of the buffer.

pub const fn header_len(&self) -> usize

Returns the length of the header part.

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

Returns the header part of the buffer.

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

Returns the packet part of the buffer.

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

Returns the mutable reference to the packet part.

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

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

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

Returns the entire buffer.

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

Returns the mutable reference to the entire buffer.

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

Set the length of the header part.

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

Set the length of the packet part.

pub fn into_buf_ptr(self: Box<Self>) -> NetBufPtr

Converts the buffer into a NetBufPtr.

pub unsafe fn from_buf_ptr(ptr: NetBufPtr) -> Box<Self>

Restore NetBuf struct from a raw pointer.

Safety

This function is unsafe because it may cause some memory issues, so we must ensure that it is called after calling into_buf_ptr.

Trait Implementations

impl Drop for NetBuf

fn drop(&mut self)

Deallocates the buffer into the NetBufPool.

impl Send for NetBuf

impl Sync for NetBuf