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.

Implementations

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 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.

#[must_use]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.

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

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

#[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 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, N: ChunkLength<A> + 'a> Array for SliceMut<'a, A, N>

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

Get a reference to the value at a given index.

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

Get a reference to the first element in the array.

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

Get a reference to the last element in the array.

pub fn contains(&self, target: &Self::Output) -> bool where
    Self::Output: PartialEq<Self::Output>, 

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

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

Perform a binary search for target.

pub 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.

pub fn binary_search_by_key<K, F>(
    &self,
    key: &K,
    extract: F
) -> Result<usize, usize> where
    K: Ord,
    F: FnMut(&Self::Output) -> K, 

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

pub fn is_sorted(&self) -> bool where
    Self::Output: PartialOrd<Self::Output>, 

Test whether the array is sorted.

pub 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.

pub fn is_sorted_by_key<K, F>(&self, extract: F) -> bool where
    K: PartialOrd<K>,
    F: FnMut(&Self::Output) -> K, 

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

pub fn starts_with(&self, slice: &[Self::Output]) -> bool where
    Self::Output: PartialEq<Self::Output>,
    Self::Output: Sized, 

Test whether the array starts with the elements in slice.

pub fn ends_with(&self, slice: &[Self::Output]) -> bool where
    Self::Output: PartialEq<Self::Output>,
    Self::Output: Sized, 

Test whether the array ends with the elements in slice.

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

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

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

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

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

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

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

pub 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.

pub fn swap(&mut self, index1: usize, index2: usize) where
    Self::Output: Sized, 

Swap the elements at two indexes.

pub 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.

pub fn sort_unstable(&mut self) where
    Self::Output: Ord,
    Self::Output: Sized, 

Sort the elements of the array.

pub fn sort_unstable_by<F>(&mut self, compare: F) where
    F: FnMut(&Self::Output, &Self::Output) -> Ordering,
    Self::Output: Sized, 

Sort the elements of the array using a comparator function.

pub fn sort_unstable_by_key<F, K>(&mut self, extract: F) where
    K: Ord,
    F: FnMut(&Self::Output) -> K,
    Self::Output: Sized, 

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

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: 'a, N: ChunkLength<A> + 'a> HasLength for SliceMut<'a, A, N>

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

Get the length of the slice.

pub fn is_empty(&self) -> bool

Return whether the data structure is empty.

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.

pub 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.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

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

This method tests for !=.

impl<A, N> PartialEq<SliceMut<'_, A, N>> for RingBuffer<A, N> where
    A: PartialEq,
    N: ChunkLength<A>, 

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

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

#[must_use]pub 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 Slice<'a, A, N>

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

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

#[must_use]pub 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]pub 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]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

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

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