Struct async_ringbuf::ring_buffer::AsyncRb

pub struct AsyncRb<T, B: Rb<T>> { /* private fields */ }

Implementations

impl<T, B: Rb<T>> AsyncRb<T, B>

pub fn from_base(base: B) -> Self

pub fn into_base(self) -> B

pub fn split_ref(
    &mut self
) -> (AsyncProducer<T, &Self>, AsyncConsumer<T, &Self>)

impl<T, C: Container<T>> AsyncRb<T, LocalRb<T, C>>

pub fn split(self) -> (AsyncProducer<T, Rc<Self>>, AsyncConsumer<T, Rc<Self>>)

impl<T, C: Container<T>> AsyncRb<T, SharedRb<T, C>>

pub fn split(self) -> (AsyncProducer<T, Arc<Self>>, AsyncConsumer<T, Arc<Self>>)

impl<T> AsyncRb<T, HeapRb<T>>

pub fn new(capacity: usize) -> Self

Trait Implementations

impl<T, B: Rb<T>> AsyncRbBase<T> for AsyncRb<T, B>

fn is_closed(&self) -> bool

impl<T, B: Rb<T>> AsyncRbRead<T> for AsyncRb<T, B>

unsafe fn register_tail_waker(&self, waker: &Waker)

unsafe fn close_head(&self)

impl<T, B: Rb<T>> AsyncRbWrite<T> for AsyncRb<T, B>

unsafe fn register_head_waker(&self, waker: &Waker)

unsafe fn close_tail(&self)

impl<T, B: Rb<T>> Rb<T> for AsyncRb<T, B>

fn capacity(&self) -> usize

Returns capacity of the ring buffer.

fn len(&self) -> usize

The number of items stored in the ring buffer.

fn free_len(&self) -> usize

The number of remaining free places in the buffer.

fn as_slices(&self) -> (&[T], &[T])

Returns a pair of slices which contain, in order, the contents of the ring buffer.

fn as_mut_slices(&mut self) -> (&mut [T], &mut [T])

Returns a pair of mutable slices which contain, in order, the contents of the ring buffer.

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

Removes latest item from the ring buffer and returns it.

fn pop_iter(&mut self) -> PopIterator<'_, T, RbWrap<Self>>

Returns an iterator that removes items one by one from the ring buffer.

fn iter(&self) -> Chain<Iter<'_, T>, Iter<'_, T>>

Returns a front-to-back iterator containing references to items in the ring buffer.

fn iter_mut(&mut self) -> Chain<IterMut<'_, T>, IterMut<'_, T>>

Returns a front-to-back iterator that returns mutable references to items in the ring buffer.

fn skip(&mut self, count: usize) -> usize

Removes exactly n items from the buffer and safely drops them.

fn clear(&mut self) -> usize

Removes all items from the buffer and safely drops them.

fn push(&mut self, elem: T) -> Result<(), T>

Appends an item to the ring buffer.

fn push_overwrite(&mut self, elem: T) -> Option<T>

Pushes an item to the ring buffer overwriting the latest item if the buffer is full.

fn push_iter<I>(&mut self, iter: &mut I)where
    I: Iterator<Item = T>,

Appends items from an iterator to the ring buffer. Elements that haven’t been added to the ring buffer remain in the iterator.

fn push_iter_overwrite<I>(&mut self, iter: I)where
    I: Iterator<Item = T>,

Appends items from an iterator to the ring buffer.

impl<T, B: Rb<T>> RbBase<T> for AsyncRb<T, B>

unsafe fn data(&self) -> &mut [MaybeUninit<T>]

Returns underlying raw ring buffer memory as slice.

fn capacity_nonzero(&self) -> NonZeroUsize

Capacity of the ring buffer.

fn head(&self) -> usize

Head position.

fn tail(&self) -> usize

Tail position.

fn modulus(&self) -> NonZeroUsize

Modulus for head and tail values.

fn occupied_len(&self) -> usize

The number of items stored in the buffer at the moment.

fn vacant_len(&self) -> usize

The number of vacant places in the buffer at the moment.

fn is_empty(&self) -> bool

Checks if the occupied range is empty.

fn is_full(&self) -> bool

Checks if the vacant range is empty.

impl<T, B: Rb<T>> RbRead<T> for AsyncRb<T, B>

unsafe fn set_head(&self, value: usize)

Sets the new head position.

unsafe fn advance_head(&self, count: usize)

Move head position by count items forward.

fn occupied_ranges(&self) -> (Range<usize>, Range<usize>)

Returns a pair of ranges of Self::occupied_slices location in underlying container.

unsafe fn occupied_slices(
    &self
) -> (&mut [MaybeUninit<T>], &mut [MaybeUninit<T>])

Provides a direct mutable access to the ring buffer occupied memory.

unsafe fn skip_internal(&self, count_or_all: Option<usize>) -> usize

Removes items from the head of ring buffer and drops them.

impl<T, B: Rb<T>> RbWrite<T> for AsyncRb<T, B>

unsafe fn set_tail(&self, value: usize)

Sets the new tail position.

unsafe fn advance_tail(&self, count: usize)

Move tail position by count items forward.

fn vacant_ranges(&self) -> (Range<usize>, Range<usize>)

Returns a pair of ranges of Self::vacant_slices location in underlying container.

unsafe fn vacant_slices(&self) -> (&mut [MaybeUninit<T>], &mut [MaybeUninit<T>])

Provides a direct access to the ring buffer vacant memory. Returns a pair of slices of uninitialized memory, the second one may be empty.