Struct PacketBuffer

pub struct PacketBuffer<'a, H: 'a> { /* private fields */ }

An UDP packet ring buffer.

Implementations

impl<'a, H> PacketBuffer<'a, H>

pub fn new<MS, PS>( metadata_storage: MS, payload_storage: PS, ) -> PacketBuffer<'a, H>

where MS: Into<ManagedSlice<'a, PacketMetadata<H>>>, PS: Into<ManagedSlice<'a, u8>>,

Create a new packet buffer with the provided metadata and payload storage.

Metadata storage limits the maximum number of packets in the buffer and payload storage limits the maximum total size of packets.

pub fn is_empty(&self) -> bool

Query whether the buffer is empty.

pub fn is_full(&self) -> bool

Query whether the buffer is full.

pub fn enqueue(&mut self, size: usize, header: H) -> Result<&mut [u8], Full>

Enqueue a single packet with the given header into the buffer, and return a reference to its payload, or return Err(Full) if the buffer is full.

pub fn enqueue_with_infallible<'b, F>( &'b mut self, max_size: usize, header: H, f: F, ) -> Result<usize, Full>

where F: FnOnce(&'b mut [u8]) -> usize,

Call f with a packet from the buffer large enough to fit max_size bytes. The packet is shrunk to the size returned from f and enqueued into the buffer.

pub fn dequeue_with<'c, R, E, F>( &'c mut self, f: F, ) -> Result<Result<R, E>, Empty>

where F: FnOnce(&mut H, &'c mut [u8]) -> Result<R, E>,

Call f with a single packet from the buffer, and dequeue the packet if f returns successfully, or return Err(EmptyError) if the buffer is empty.

pub fn dequeue(&mut self) -> Result<(H, &mut [u8]), Empty>

Dequeue a single packet from the buffer, and return a reference to its payload as well as its header, or return Err(Error::Exhausted) if the buffer is empty.

pub fn peek(&mut self) -> Result<(&H, &[u8]), Empty>

Peek at a single packet from the buffer without removing it, and return a reference to its payload as well as its header, or return Err(Error:Exhausted) if the buffer is empty.

This function otherwise behaves identically to dequeue.

pub fn packet_capacity(&self) -> usize

Return the maximum number packets that can be stored.

pub fn payload_capacity(&self) -> usize

Return the maximum number of bytes in the payload ring buffer.

Trait Implementations

impl<'a, H: Debug + 'a> Debug for PacketBuffer<'a, H>

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

Formats the value using the given formatter.