Trait ringbuf::storage::Storage

pub unsafe trait Storage {
    type Item: Sized;

    // Required methods
    fn len(&self) -> usize;
    fn as_mut_ptr(&self) -> *mut MaybeUninit<Self::Item>;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn as_ptr(&self) -> *const MaybeUninit<Self::Item> { ... }
    unsafe fn slice(&self, range: Range<usize>) -> &[MaybeUninit<Self::Item>] { ... }
    unsafe fn slice_mut(
        &self,
        range: Range<usize>
    ) -> &mut [MaybeUninit<Self::Item>] { ... }
}

Abstract storage for the ring buffer.

Storage items must be stored as a contiguous array.

Safety

Must not alias with its contents (it must be safe to store mutable references to storage itself and to its data at the same time).

Self::as_mut_ptr must point to underlying data.

Self::len must always return the same value.

Required Associated Types

type Item: Sized

Stored item.

Required Methods

fn len(&self) -> usize

Length of the storage.

fn as_mut_ptr(&self) -> *mut MaybeUninit<Self::Item>

Return mutable pointer to the beginning of the storage items.

Provided Methods

fn is_empty(&self) -> bool

fn as_ptr(&self) -> *const MaybeUninit<Self::Item>

Return pointer to the beginning of the storage items.

unsafe fn slice(&self, range: Range<usize>) -> &[MaybeUninit<Self::Item>]

Returns a mutable slice of storage in specified range.

Safety

Slice must not overlab with existing mutable slices.

unsafe fn slice_mut( &self, range: Range<usize> ) -> &mut [MaybeUninit<Self::Item>]

Returns a mutable slice of storage in specified range.

Safety

Slices must not overlap.

Implementors

impl<'a, T> Storage for Ref<'a, T>

type Item = T

impl<T> Storage for Heap<T>

type Item = T

impl<T> Storage for Slice<T>

type Item = T

impl<T, const N: usize> Storage for Array<T, N>

type Item = T