Struct BlobProducer 

pub struct BlobProducer<M: Copy + 'static> { /* private fields */ }

Producer for variable-sized binary blobs and metadata in shared memory.

Implementations

impl<M: Copy + 'static> BlobProducer<M>

pub fn create<P: AsRef<Path>>( path: P, capacity: u64, arena_capacity: usize, ) -> Result<Self>

Creates a new blob producer with default options. capacity is the number of ring slots (power of 2). arena_capacity is the byte capacity of the payload arena (power of 2, e.g. 16MB).

pub fn create_with_options<P: AsRef<Path>>( path: P, options: BlobProducerBuilder, ) -> Result<Self>

Creates a new blob producer with custom builder options.

pub fn push(&mut self, meta: &M, payload: &[u8]) -> Result<u64>

Publishes a message with metadata and binary payload. Returns the assigned sequence number.

pub fn push_with<F, R>( &mut self, meta: &M, len: usize, f: F, ) -> Result<(u64, R)>

where F: FnOnce(&mut [u8]) -> R,

Publishes with zero-copy writing directly into the payload arena.

pub fn min_reader_seq(&self) -> Option<u64>

Minimum sequence across all currently living registered readers.

pub fn reader_lag(&self) -> u64

Maximum lag across registered readers.

pub fn headroom(&self) -> u64

Remaining write headroom before the slowest reader is lapped.

pub fn active_readers(&self) -> Vec<ReaderInfo>

Status of all registered active readers.

pub fn sequence(&self) -> u64

Current sequence number of the producer.

impl BlobProducer<()>

Convenience methods for producers with no metadata (M = ()).

pub fn push_payload(&mut self, payload: &[u8]) -> Result<u64>

Trait Implementations

impl<M: Copy + 'static> Debug for BlobProducer<M>

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

Formats the value using the given formatter.

impl<M: Copy + 'static> Drop for BlobProducer<M>

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.

impl<M: Copy + Send + 'static> Send for BlobProducer<M>