Struct Producer

Source
pub struct Producer<T> { /* private fields */ }
Expand description

Producer handle for pushing items into the ring buffer.

This type is Send but not Clone - only one producer should exist.

Implementations§

Source§

impl<T> Producer<T>

Source

pub fn try_push(&mut self, value: T) -> Result<(), T>

Attempts to push a value into the buffer.

Returns Ok(()) if successful, or Err(value) if the buffer is full. This operation is lock-free and will never block.

Source

pub fn len(&self) -> usize

Returns the number of items currently in the buffer.

This is an approximate count and may be stale by the time it’s used.

Source

pub fn is_full(&self) -> bool

Returns true if the buffer is full.

Source

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

Source

pub fn capacity(&self) -> usize

Returns the capacity of the buffer.

Trait Implementations§

Source§

impl<T: Send> Send for Producer<T>

Auto Trait Implementations§

§

impl<T> Freeze for Producer<T>

§

impl<T> !RefUnwindSafe for Producer<T>

§

impl<T> Sync for Producer<T>
where T: Send,

§

impl<T> Unpin for Producer<T>

§

impl<T> !UnwindSafe for Producer<T>

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 = 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.