Skip to main content

Producer

Struct Producer 

Source
pub struct Producer<T, const CAPACITY: usize, A>
where T: AnyBitPattern, A: Allocator,
{ /* private fields */ }
Available on non-crate feature tests_loom only.
Expand description

The publishing handle of an SPMC broadcast queue.

Created together with its Consumer by new. A Producer is Send but not Sync: at most one thread may publish at a time. To enforce that, the type is neither Clone nor Copy.

Publishing never blocks and never allocates: when the queue is full the oldest slot is overwritten, and any consumer that hasn’t read past that slot will observe a ReadResult::Lapped on its next read.

Implementations§

Source§

impl<T, const CAPACITY: usize, A> Producer<T, CAPACITY, A>
where T: AnyBitPattern, A: Allocator,

Source

pub fn publish(&self, value: T)

Publishes value into the next slot.

Wait-free. Never blocks, never allocates. If the queue is full, the oldest slot is silently overwritten; consumers that haven’t read past that slot will observe a ReadResult::Lapped on their next try_read.

§Examples
use low_latency_data_structures::spmc::{self, ReadResult, new};
use low_latency_data_structures::mem::global::GlobalAllocator;

let (producer, mut consumer) = new::<u64, 16, GlobalAllocator>(
    spmc::Options::global_mlocked(),
);
producer.publish(42);
assert_eq!(consumer.try_read(), ReadResult::Value(42));

Trait Implementations§

Source§

impl<T, const CAPACITY: usize, A> Debug for Producer<T, CAPACITY, A>
where T: AnyBitPattern, A: Allocator,

Source§

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

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

impl<T, const CAPACITY: usize, A> Send for Producer<T, CAPACITY, A>
where A: Allocator, T: AnyBitPattern + Send, A::Allocation<Slot<T>>: Send,

Auto Trait Implementations§

§

impl<T, const CAPACITY: usize, A> !Sync for Producer<T, CAPACITY, A>

§

impl<T, const CAPACITY: usize, A> Freeze for Producer<T, CAPACITY, A>
where Arc<Queue<T, CAPACITY, A>>: Freeze,

§

impl<T, const CAPACITY: usize, A> RefUnwindSafe for Producer<T, CAPACITY, A>
where Arc<Queue<T, CAPACITY, A>>: RefUnwindSafe,

§

impl<T, const CAPACITY: usize, A> Unpin for Producer<T, CAPACITY, A>
where Arc<Queue<T, CAPACITY, A>>: Unpin,

§

impl<T, const CAPACITY: usize, A> UnsafeUnpin for Producer<T, CAPACITY, A>
where Arc<Queue<T, CAPACITY, A>>: UnsafeUnpin,

§

impl<T, const CAPACITY: usize, A> UnwindSafe for Producer<T, CAPACITY, A>
where Arc<Queue<T, CAPACITY, A>>: UnwindSafe,

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.