Struct SliceMut

pub struct SliceMut<'a, A, const N: usize> { /* private fields */ }

An indexable representation of a mutable subset of a RingBuffer.

Implementations

impl<'a, A: 'a, const N: usize> SliceMut<'a, A, N>

pub fn unmut(self) -> Slice<'a, A, N>

Downgrade this slice into a non-mutable slice.

pub unsafe fn get_unchecked(&self, index: usize) -> &A

Get an unchecked reference to the value at the given index.

Safety

You must ensure the index is not out of bounds.

pub unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut A

Get an unchecked mutable reference to the value at the given index.

Safety

You must ensure the index is not out of bounds.

pub fn iter(&self) -> Iter<'_, A, N>

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

pub fn iter_mut(&mut self) -> IterMut<'_, A, N>

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

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.

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.

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: 'a, const N: usize> Array for SliceMut<'a, A, N>

fn get(&self, index: usize) -> Option<&A>

Get a reference to the value at a given index.

fn first(&self) -> Option<&Self::Output>

Get a reference to the first element in the array.

fn last(&self) -> Option<&Self::Output>

Get a reference to the last element in the array.

fn contains(&self, target: &Self::Output) -> bool

where Self::Output: PartialEq,

Return true if an element equivalent to target exists in the array.

fn binary_search(&self, target: &Self::Output) -> Result<usize, usize>

where Self::Output: Ord,

Perform a binary search for target.

fn binary_search_by<F>(&self, compare: F) -> Result<usize, usize>

where F: FnMut(&Self::Output) -> Ordering,

Perform a binary search using a comparator function.

fn binary_search_by_key<K, F>( &self, key: &K, extract: F, ) -> Result<usize, usize>

where F: FnMut(&Self::Output) -> K, K: Ord,

Perform a binary search using a key and a key extractor function.

fn is_sorted(&self) -> bool

where Self::Output: PartialOrd,

Test whether the array is sorted.

fn is_sorted_by<F>(&self, compare: F) -> bool

where F: FnMut(&Self::Output, &Self::Output) -> Option<Ordering>,

Test whether the array is sorted using a comparator function.

fn is_sorted_by_key<K, F>(&self, extract: F) -> bool

where F: FnMut(&Self::Output) -> K, K: PartialOrd,

Test whether the array is sorted using a key extractor function.

fn starts_with(&self, slice: &[Self::Output]) -> bool

where Self::Output: Sized + PartialEq,

Test whether the array starts with the elements in slice.

fn ends_with(&self, slice: &[Self::Output]) -> bool

where Self::Output: Sized + PartialEq,

Test whether the array ends with the elements in slice.

impl<'a, A: 'a, const N: usize> ArrayMut for SliceMut<'a, A, N>

fn get_mut(&mut self, index: usize) -> Option<&mut A>

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

fn first_mut(&mut self) -> Option<&mut Self::Output>

Get a mutable reference to the first element in the array.

fn last_mut(&mut self) -> Option<&mut Self::Output>

Get a mutable reference to the last element in the array.

fn set(&mut self, index: usize, value: Self::Output) -> Option<Self::Output>

where Self::Output: Sized,

Set the value of the element at the given index.

fn swap(&mut self, index1: usize, index2: usize)

where Self::Output: Sized,

Swap the elements at two indexes.

fn map_pair<F, A>(&mut self, index1: usize, index2: usize, f: F) -> A

where F: FnMut(&mut Self::Output, &mut Self::Output) -> A,

Get mutable references to the elements at two indexes and call a function on them.

fn sort_unstable(&mut self)

where Self::Output: Sized + Ord,

Sort the elements of the array.

fn sort_unstable_by<F>(&mut self, compare: F)

where Self::Output: Sized, F: FnMut(&Self::Output, &Self::Output) -> Ordering,

Sort the elements of the array using a comparator function.

fn sort_unstable_by_key<F, K>(&mut self, extract: F)

where F: FnMut(&Self::Output) -> K, K: Ord, Self::Output: Sized,

Sort the elements of the array using a key extractor function.

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

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

Formats the value using the given formatter.

impl<'a, A: 'a, const N: usize> From<&'a mut RingBuffer<A, N>> for SliceMut<'a, A, N>

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

Converts to this type from the input type.

impl<'a, A: 'a, const N: usize> HasLength for SliceMut<'a, A, N>

fn len(&self) -> usize

Get the length of the slice.

fn is_empty(&self) -> bool

Return whether the data structure is empty.

impl<'a, A: Hash + 'a, const N: usize> 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

type Output = A

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

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

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl<'a, A: 'a, const N: usize> Into<Slice<'a, A, N>> for SliceMut<'a, A, N>

fn into(self) -> Slice<'a, A, N>

Converts this type into the (usually inferred) input type.

impl<'a, 'b, A: 'a, const N: usize> 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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, A: 'a, const N: usize> 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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, A: PartialEq + 'a, const N: usize> PartialEq<RingBuffer<A, N>> for SliceMut<'a, A, N>

fn eq(&self, other: &RingBuffer<A, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: PartialEq + 'a, S, const N: usize> PartialEq<S> for SliceMut<'a, A, N>

where S: Borrow<[A]>,

fn eq(&self, other: &S) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: PartialEq + 'a, const N: usize> PartialEq<Slice<'a, A, N>> for SliceMut<'a, A, N>

fn eq(&self, other: &Slice<'a, A, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A, const N: usize> PartialEq<SliceMut<'_, A, N>> for RingBuffer<A, N>

where A: PartialEq,

fn eq(&self, other: &SliceMut<'_, A, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: PartialEq + 'a, const N: usize> PartialEq<SliceMut<'a, A, N>> for Slice<'a, A, N>

fn eq(&self, other: &SliceMut<'a, A, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

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