Struct MpscProducer 

pub struct MpscProducer { /* private fields */ }

MPSC producer handle for a SharedLayout events region.

Semantics (v1):

• at-most-once delivery
• per-producer ordering preserved; cross-producer ordering not guaranteed
• bounded capacity; publish* returns Error::Full when saturated

Implementations

impl MpscProducer

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

Publish a byte payload.

Returns:

• Ok(()) if the message was committed
• Err(Error::TooLarge) if data.len() > INDEXBUS_SLOT_DATA_SIZE
• Err(Error::Full) if bounded capacity is exhausted

pub fn publish_with<F, E>(&self, f: F) -> Result<(), PublishWithError<E>>

where F: FnOnce(&mut [u8]) -> Result<usize, E>,

Publish by writing directly into the slot buffer.

The closure must return the number of bytes written. That length becomes the published message length.

Errors

• PublishWithError::Encode: the closure returned an error; no message is published.
• PublishWithError::Core: capacity/layout failures (e.g. full), or len > INDEXBUS_SLOT_DATA_SIZE.

pub fn try_publish_slot(&self, slot: EventsSlot) -> Result<(), PublishSlotError>

Publish a previously-received slot by forwarding its slot index into this producer’s queue.

On failure, returns the original slot back to the caller.

pub fn publish_slot(&self, slot: EventsSlot) -> Result<(), Error>

Publish a previously-received slot, discarding it on failure.

Trait Implementations

impl Send for MpscProducer

impl Sync for MpscProducer