Struct PacketRef 

pub struct PacketRef<'pool> { /* private fields */ }

Owned handle to a PacketBuffer allocated from a PacketPool.

Provides Deref/DerefMut access to the underlying buffer and automatically returns it to the pool on drop. Use into_index when the buffer must be handed off by index (e.g. to a ring buffer) without triggering the auto-free.

Implementations

impl PacketRef<'_>

pub fn index(&self) -> u32

Returns the buffer’s index in the pool.

pub fn into_index(self) -> u32

Consumes the handle and returns the raw buffer index without freeing the buffer back to the pool.

The caller is responsible for eventually freeing the buffer (e.g. via PacketPool::free_by_index).

Methods from Deref<Target = PacketBuffer>

pub fn index(&self) -> u32

Returns the buffer index.

pub fn len(&self) -> usize

Returns the current data length.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

pub fn set_len(&mut self, len: usize)

Sets the data length.

pub fn as_slice(&self) -> &[u8]

Returns the buffer data as a slice.

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

Returns the buffer data as a mutable slice.

pub fn as_full_slice(&self) -> &[u8]

Returns the full buffer capacity.

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

Returns the full buffer as mutable.

pub fn as_ptr(&self) -> *const u8

Returns a pointer to the buffer data.

pub fn as_mut_ptr(&mut self) -> *mut u8

Returns a mutable pointer to the buffer data.

pub fn add_ref(&self)

Increments the reference count.

pub fn release(&self) -> bool

Decrements the reference count and returns true if it reached zero.

pub fn refcount(&self) -> u32

Returns the current reference count.

pub fn reset(&mut self)

Resets the buffer for reuse.

pub fn copy_from_slice(&mut self, data: &[u8]) -> Result<()>

Copies data into the buffer.

Errors

Returns an error if the data is too large.

Trait Implementations

impl Debug for PacketRef<'_>

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

Formats the value using the given formatter.

impl Deref for PacketRef<'_>

type Target = PacketBuffer

The resulting type after dereferencing.

fn deref(&self) -> &PacketBuffer

Dereferences the value.

impl DerefMut for PacketRef<'_>

fn deref_mut(&mut self) -> &mut PacketBuffer

Mutably dereferences the value.

impl Drop for PacketRef<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.