Struct sized_chunks::ring_buffer::SliceMut

pub struct SliceMut<'a, A, N: ChunkLength<A>> { /* fields omitted */ }

An indexable representation of a mutable subset of a RingBuffer.

Methods

impl<'a, A: 'a, N: ChunkLength<A> + 'a> SliceMut<'a, A, N>

#[must_use] pub fn unmut(self) -> Slice<'a, A, N>

Downgrade this slice into a non-mutable slice.

#[must_use] pub fn len(&self) -> usize

Get the length of the slice.

#[must_use] pub fn is_empty(&self) -> bool

Test if the slice is empty.

#[must_use] pub fn get(&self, index: usize) -> Option<&'a A>

Get a reference to the value at a given index.

#[must_use] pub fn get_mut(&mut self, index: usize) -> Option<&'a mut A>

Get a mutable reference to the value at a given index.

#[must_use] pub fn first(&self) -> Option<&A>

Get a reference to the first value in the slice.

#[must_use] pub fn first_mut(&mut self) -> Option<&mut A>

Get a mutable reference to the first value in the slice.

#[must_use] pub fn last(&self) -> Option<&A>

Get a reference to the last value in the slice.

#[must_use] pub fn last_mut(&mut self) -> Option<&mut A>

Get a mutable reference to the last value in the slice.

Important traits for Iter<'a, A, N>

impl<'a, A, N> Iterator for Iter<'a, A, N> where
    N: ChunkLength<A>,  type Item = &'a A;

#[must_use] pub fn iter(&self) -> Iter<A, N>

Get an iterator over references to the items in the slice in order.

Important traits for IterMut<'a, A, N>

impl<'a, A, N> Iterator for IterMut<'a, A, N> where
    N: ChunkLength<A>,  type Item = &'a mut A;

#[must_use] pub fn iter_mut(&mut self) -> IterMut<A, N>

Get an iterator over mutable references to the items in the slice in order.

#[must_use] pub fn slice<R: RangeBounds<usize>>(self, range: R) -> SliceMut<'a, A, N>

Create a subslice of this slice.

This consumes the slice. Because the slice works like a mutable reference, you can only have one slice over a given subset of a RingBuffer at any one time, so that's just how it's got to be.

#[must_use] pub fn split_at(self, index: usize) -> (SliceMut<'a, A, N>, SliceMut<'a, A, N>)

Split the slice into two subslices at the given index.

#[must_use] pub fn set(&mut self, index: usize, value: A) -> A

Update the value at index index, returning the old value.

Panics if index is out of bounds.

Important traits for RingBuffer<u8, N>

impl<N: ChunkLength<u8>> Read for RingBuffer<u8, N>impl<N: ChunkLength<u8>> Write for RingBuffer<u8, N>

#[must_use] pub fn to_owned(&self) -> RingBuffer<A, N> where
    A: Clone, 

Construct a new RingBuffer by copying the elements in this slice.

Trait Implementations

impl<'a, A: Debug + 'a, N: ChunkLength<A> + 'a> Debug for SliceMut<'a, A, N>

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

Formats the value using the given formatter.

impl<'a, A: Eq + 'a, N: ChunkLength<A> + 'a> Eq for SliceMut<'a, A, N>

impl<'a, A: 'a, N: ChunkLength<A> + 'a> From<&'a mut RingBuffer<A, N>> for SliceMut<'a, A, N>

#[must_use] fn from(buffer: &'a mut RingBuffer<A, N>) -> Self

Performs the conversion.

impl<'a, A: Hash + 'a, N: ChunkLength<A> + 'a> Hash for SliceMut<'a, A, N>

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a, A: 'a, N: ChunkLength<A> + 'a> Index<usize> for SliceMut<'a, A, N>

type Output = A

The returned type after indexing.

#[must_use] fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, A: 'a, N: ChunkLength<A> + 'a> IndexMut<usize> for SliceMut<'a, A, N>

#[must_use] fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, A: 'a, N: ChunkLength<A> + 'a> Into<Slice<'a, A, N>> for SliceMut<'a, A, N>

#[must_use] fn into(self) -> Slice<'a, A, N>

Performs the conversion.

impl<'a, 'b, A: 'a, N: ChunkLength<A> + 'a> IntoIterator for &'a SliceMut<'a, A, N>

type Item = &'a A

The type of the elements being iterated over.

type IntoIter = Iter<'a, A, N>

Which kind of iterator are we turning this into?

#[must_use] fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, A: 'a, N: ChunkLength<A> + 'a> IntoIterator for &'a mut SliceMut<'a, A, N>

type Item = &'a mut A

The type of the elements being iterated over.

type IntoIter = IterMut<'a, A, N>

Which kind of iterator are we turning this into?

#[must_use] fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, A: Ord + 'a, N: ChunkLength<A> + 'a> Ord for SliceMut<'a, A, N>

#[must_use] fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a, A: PartialEq + 'a, N: ChunkLength<A> + 'a, S> PartialEq<S> for SliceMut<'a, A, N> where
    S: Borrow<[A]>, 

#[must_use] fn eq(&self, other: &S) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, A: PartialEq + 'a, N: ChunkLength<A> + 'a> PartialEq<SliceMut<'a, A, N>> for SliceMut<'a, A, N>

#[must_use] fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, A: PartialOrd + 'a, N: ChunkLength<A> + 'a> PartialOrd<SliceMut<'a, A, N>> for SliceMut<'a, A, N>

#[must_use] fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.