Struct rubble::link::queue::Producer

pub struct Producer { /* fields omitted */ }

Writing end of a packet queue.

Methods

impl Producer

pub fn has_space(&mut self, space: usize) -> bool

Queries whether there is a free contiguous chunk of memory of at least space bytes.

pub fn free_space(&mut self) -> usize

Returns the size of the largest contiguous free space in the queue (in Bytes).

pub fn produce_with<E>(
    &mut self,
    f: impl FnOnce(&mut ByteWriter) -> Result<Llid, E>
) -> Result<(), E> where
    E: From<Error>, 

Enqueue a new data channel PDU by passing a ByteWriter to a closure.

The closure has to write the PDU payload into the ByteWriter and must return the Llid to set in the header. The payload size is determined and written to the header automatically.

pub fn produce_pdu<L: ToBytes>(&mut self, payload: Pdu<L>) -> Result<(), Error>

Enqueues a data channel PDU.

Returns Error::Eof when the queue does not have enough free space for both header and payload.

pub fn produce_raw(
    &mut self,
    header: Header,
    payload: &[u8]
) -> Result<(), Error>

Enqueues a data channel PDU, where the payload is given as raw bytes.

The payload will not be checked for validity.