Skip to main content

SpscConsumer

Struct SpscConsumer 

Source
pub struct SpscConsumer<T, const N: usize> { /* private fields */ }
Expand description

Consumer half of an SpscRing.

Implementations§

Source§

impl<T, const N: usize> SpscConsumer<T, N>

Source

pub fn pop(&self) -> Option<T>

Attempts to pop the next buffered item without blocking.

Source

pub const fn pop_async(&self) -> PopFuture<'_, T, N>

Returns a future that resolves to the next buffered item, or None once the producer has been dropped and the ring is empty.

Source

pub fn buffered_count(&self) -> usize

Returns the current buffered item count.

Source

pub fn capacity(&self) -> usize

Returns the runtime capacity of the ring.

Source

pub fn is_closed(&self) -> bool

Returns true if the producer has been dropped.

Source

pub const fn stream(&self) -> SpscConsumerStream<'_, T, N>

Available on crate feature futures-stream only.

Trait Implementations§

Source§

impl<T, const N: usize> Debug for SpscConsumer<T, N>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T, const N: usize> Freeze for SpscConsumer<T, N>

§

impl<T, const N: usize> !RefUnwindSafe for SpscConsumer<T, N>

§

impl<T, const N: usize> Send for SpscConsumer<T, N>
where T: Send,

§

impl<T, const N: usize> Sync for SpscConsumer<T, N>
where T: Send,

§

impl<T, const N: usize> Unpin for SpscConsumer<T, N>

§

impl<T, const N: usize> UnsafeUnpin for SpscConsumer<T, N>

§

impl<T, const N: usize> !UnwindSafe for SpscConsumer<T, N>

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.