Struct OutgoingRing

pub struct OutgoingRing<M: RingMem> { /* private fields */ }

The sending side of a ring buffer.

Implementations

impl<M: RingMem> OutgoingRing<M>

pub fn new(mem: M) -> Result<Self, Error>

Returns a new outgoing ring over mem.

pub fn outgoing(&self) -> Result<OutgoingOffset, Error>

Returns the current outgoing offset, for passing to write and ultimately commit_write.

pub fn set_pending_send_size(&self, len: usize) -> Result<(), Error>

Sets the pending send size: the number of bytes that should be free in the ring before the opposite endpoint sends a ring-non-full signal.

Fails if the packet size is larger than the ring’s maximum packet size.

pub fn maximum_packet_size(&self) -> usize

Returns the maximum packet size that can fit in the ring.

pub fn can_write( &self, ptrs: &mut OutgoingOffset, len: usize, ) -> Result<bool, Error>

Returns whether a packet can fit in the ring starting at the specified offset.

pub fn commit_write(&self, ptrs: &mut OutgoingOffset) -> bool

Commits a series of writes that ended at the specified offset, returning whether the opposite endpoint should be signaled.

pub fn write( &self, ptrs: &mut OutgoingOffset, packet: &OutgoingPacket<'_>, ) -> Result<RingRange, WriteError>

Writes the header of the next packet and returns the ring range for the payload. The caller should write the payload, then commit the write (or multiple writes) with commit_write.

Returns Err(RingFull(len)) if the ring is full, where len is the number of bytes needed to write the requested packet.

Trait Implementations

impl<M: Debug + RingMem> Debug for OutgoingRing<M>

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

Formats the value using the given formatter.

impl<M: RingMem> Inspect for OutgoingRing<M>

fn inspect(&self, req: Request<'_>)

Inspects the object.

impl<M: RingMem> Ring for OutgoingRing<M>

type Memory = M

The underlying memory type.

fn mem(&self) -> &Self::Memory

The backing memory of the ring buffer.