Skip to main content

Producer

Struct Producer 

Source
pub struct Producer<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> { /* private fields */ }

Implementations§

Source§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

Source

pub fn new( mcache: &'a MCache<MCACHE_DEPTH>, dcache: &'a DCache<CHUNK_COUNT, CHUNK_SIZE>, fseq: &'a Fseq, ) -> Self

Create a producer for a shared mcache/dcache pair.

Without flow control, this producer will freely overwrite chunks. Use with_flow_control for backpressure.

Source

pub fn with_flow_control( mcache: &'a MCache<MCACHE_DEPTH>, dcache: &'a DCache<CHUNK_COUNT, CHUNK_SIZE>, fseq: &'a Fseq, fctl: &'a Fctl, ) -> Self

Create a producer with credit-based flow control.

The producer will acquire a credit before allocating a chunk. Initialize fctl with CHUNK_COUNT credits.

Source

pub fn with_metrics(self, metrics: &'a Metrics) -> Self

Attach metrics tracking to this producer.

Returns a new producer with the same configuration plus metrics.

Source

pub fn publish( &self, payload: &[u8], sig: u64, ctl: u16, ts: u32, ) -> Result<FragmentMetadata, TangoError>

Publish a payload fragment and its metadata.

If flow control is enabled, returns TangoError::NoCredits when no credits are available (consumer hasn’t caught up).

Source

pub fn publish_blocking( &self, payload: &[u8], sig: u64, ctl: u16, ts: u32, ) -> Result<FragmentMetadata, TangoError>

Try to publish, spinning until credits are available or mcache stops.

Only useful when flow control is enabled.

Source

pub fn publish_batch(&self, payloads: &[&[u8]], sig: u64, ctl: u16) -> usize

Publish multiple payloads in a batch.

Returns the number of successfully published messages. Stops on the first error (e.g., NoCredits).

This can be more efficient than calling publish() in a loop as it reduces function call overhead.

Trait Implementations§

Source§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Clone for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

Source§

fn clone(&self) -> Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Debug for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Copy for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

Auto Trait Implementations§

§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Freeze for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> !RefUnwindSafe for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Send for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Sync for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> Unpin for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> UnsafeUnpin for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

§

impl<'a, const MCACHE_DEPTH: usize, const CHUNK_COUNT: usize, const CHUNK_SIZE: usize> !UnwindSafe for Producer<'a, MCACHE_DEPTH, CHUNK_COUNT, CHUNK_SIZE>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.