Struct slice_cell::ArrayCell

#[repr(transparent)]
pub struct ArrayCell<T, const N: usize> { /* private fields */ }

A Cell<[T; N]>-like type that has some additional slice-like API.

This type dereferences to SliceCell<T>.

Under the assume_cell_layout cargo feature, this type can be converted to and from Cell<[T; N]> and [Cell<T>; N] in several ways.

Implementations

impl<T, const N: usize> ArrayCell<T, N>

pub fn as_std_ref(&self) -> &Cell<[T; N]>

View this ArrayCell as a Cell of an array of N elements.

pub fn as_std_transposed_ref(&self) -> &[Cell<T>; N]

View this ArrayCell as an array of N Cells.

pub fn from_std_ref(std: &Cell<[T; N]>) -> &Self

View a Cell of an array of N elements as an ArrayCell.

pub fn from_std_transposed_ref(std: &[Cell<T>; N]) -> &Self

View an array of N Cells as an ArrayCell.

pub fn as_std_mut(&mut self) -> &mut Cell<[T; N]>

View this ArrayCell as a Cell of an array of N elements.

pub fn as_std_transposed_mut(&mut self) -> &mut [Cell<T>; N]

View this ArrayCell as an array of N Cells.

pub fn from_std_mut(std: &mut Cell<[T; N]>) -> &mut Self

View a Cell of an array of N elements as an ArrayCell.

pub fn from_std_transposed_mut(std: &mut [Cell<T>; N]) -> &mut Self

View an array of N Cells as an ArrayCell.

impl<T, const N: usize> ArrayCell<T, N>

pub fn into_std_boxed(self: Box<Self>) -> Box<Cell<[T; N]>>

View this ArrayCell as a Cell of an array of N elements.

pub fn into_std_transposed_boxed(self: Box<Self>) -> Box<[Cell<T>; N]>

View this ArrayCell as an array of N Cells.

pub fn from_std_boxed(std: Box<Cell<[T; N]>>) -> Box<Self>

View a Cell of an array of N elements as an ArrayCell.

pub fn from_std_transposed_boxed(std: Box<[Cell<T>; N]>) -> Box<Self>

View an array of N Cells as an ArrayCell.

impl<T, const N: usize> ArrayCell<T, N>

pub fn into_std_rc(self: Rc<Self>) -> Rc<Cell<[T; N]>>

View this ArrayCell as a Cell of an array of N elements.

pub fn into_std_transposed_rc(self: Rc<Self>) -> Rc<[Cell<T>; N]>

View this ArrayCell as an array of N Cells.

pub fn from_std_rc(std: Rc<Cell<[T; N]>>) -> Rc<Self>

View a Cell of an array of N elements as an ArrayCell.

pub fn from_std_transposed_rc(std: Rc<[Cell<T>; N]>) -> Rc<Self>

View an array of N Cells as an ArrayCell.

impl<T, const N: usize> ArrayCell<T, N>

pub fn as_ptr(&self) -> *mut [T; N]

Returns a raw pointer to the underlying data in this ArrayCell.

pub fn into_inner(self) -> [T; N]

Consumes the ArrayCell, returning the wrapped array.

pub fn new(inner: [T; N]) -> Self

Wraps an array in an ArrayCell.

pub fn new_boxed(inner: Box<[T; N]>) -> Box<Self>

Wraps a boxed array in an ArrayCell.

pub fn try_new_rc(inner: Rc<[T; N]>) -> Result<Rc<Self>, Rc<[T; N]>>

Wraps a reference-counted array in an ArrayCell, if it is uniquely owned.

pub fn try_into_inner_rc(self: Rc<Self>) -> Result<Rc<[T; N]>, Rc<Self>>

Unwraps a reference-counted ArrayCell into an array, if it is uniquely owned.

pub fn unsize_rc(self: Rc<Self>) -> Rc<SliceCell<T>>

Replacement for From impl, since Rc is not fundamental

pub fn get_mut(&mut self) -> &mut [T; N]

Unwraps a uniquely borrowed ArrayCell into an array.

pub fn from_mut(inner: &mut [T; N]) -> &mut Self

Wraps a uniquely borrowed array in an ArrayCell.

pub const fn len(&self) -> usize

Returns the length of the ArrayCell.

Methods from Deref<Target = SliceCell<T>>

pub fn as_std_ref(&self) -> &Cell<[T]>

View this SliceCell as a Cell of a slice.

pub fn as_std_transposed_ref(&self) -> &[Cell<T>]

View this SliceCell as a slice of Cells.

pub fn as_std_mut(&mut self) -> &mut Cell<[T]>

View this SliceCell as a Cell of a slice.

pub fn as_std_transposed_mut(&mut self) -> &mut [Cell<T>]

View this SliceCell as a slice of Cells.

pub fn into_std_rc(self: Rc<Self>) -> Rc<Cell<[T]>>

View this SliceCell as a Cell of a slice.

pub fn into_std_transposed_rc(self: Rc<Self>) -> Rc<[Cell<T>]>

View this SliceCell as a slice of Cells.

pub fn as_ptr(&self) -> *mut [T]

Returns a raw pointer to the underlying data in this SliceCell.

pub fn try_into_inner_rc(self: Rc<Self>) -> Result<Rc<[T]>, Rc<Self>>

Unwraps a reference-counted SliceCell into an slice, if it is uniquely owned.

pub fn get_mut(&mut self) -> &mut [T]

Unwraps a uniquely borrowed SliceCell into a slice.

pub fn len(&self) -> usize

Returns the length of the SliceCell.

pub fn split_at(&self, mid: usize) -> (&SliceCell<T>, &SliceCell<T>)

Divide one SliceCell into two at an index.

Panics if mid > self.len().

See slice::split_at

pub fn split_at_mut(
    &mut self,
    mid: usize
) -> (&mut SliceCell<T>, &mut SliceCell<T>)

Divide one mutable SliceCell into two at an index.

Panics if mid > self.len().

See slice::split_at_mut

pub fn split_first(&self) -> Option<(&Cell<T>, &SliceCell<T>)>

Returns the first and all the rest of the elements of the SliceCell, or None if it is empty.

See slice::split_first

pub fn split_first_mut(&mut self) -> Option<(&mut Cell<T>, &mut SliceCell<T>)>

Returns the first and all the rest of the elements of the SliceCell, or None if it is empty.

See slice::split_first_mut

pub fn split_last(&self) -> Option<(&Cell<T>, &SliceCell<T>)>

Returns the last and all the rest of the elements of the SliceCell, or None if it is empty.

See slice::split_last

pub fn split_last_mut(&mut self) -> Option<(&mut Cell<T>, &mut SliceCell<T>)>

Returns the last and all the rest of the elements of the SliceCell, or None if it is empty.

See slice::split_last_mut

pub fn copy_from_slice(&self, src: &[T])where
    T: Copy,

Copies all elements from src into self, using a memcpy.

The length of src must be the same as self.

See slice::copy_from_slice.

pub fn clone_from_slice(&self, src: &[T])where
    T: Clone,

Clones all elements from src into self.

The length of src must be the same as self.

See slice::copy_from_slice.

pub fn take_into_slice(&self, dst: &mut [T])where
    T: Default,

Take all elements from this SliceCell into a mutable slice, leaving T::default() in each cell

pub fn take_into_vec(&self) -> Vec<T>where
    T: Default,

Take all elements from this SliceCell into a newly allocated Vec<T>, leaving T::default() in each cell.

pub fn copy_into_slice(&self, dst: &mut [T])where
    T: Copy,

Copy all elements from this SliceCell into a mutable slice.

pub fn copy_into_vec(&self) -> Vec<T>where
    T: Copy,

Copy all elements from this SliceCell into a newly allocated Vec<T>.

pub fn replace_with_vec(&self, src: Vec<T>)

pub fn swap_with_slice(&self, val: &mut [T])

pub fn swap(&self, a: usize, b: usize)

Swaps two elements in the slice.

See <[T]>::swap.

pub fn rotate_left(&self, mid: usize)

See <[T]>::rotate_left

pub fn rotate_right(&self, mid: usize)

See <[T]>::rotate_right

pub fn fill(&self, val: T)where
    T: Clone,

Fills self with elements by cloning value.

See also: <[T]>::fill.

pub fn fill_with<F>(&self, f: F)where
    F: FnMut() -> T,

Fills self with elements returned by calling a closure repeatedly.

See also: <[T]>::fill_with.

pub fn try_size_rc<const N: usize>(
    self: Rc<Self>
) -> Result<Rc<ArrayCell<T, N>>, Rc<Self>>

Replacement for TryFrom impl, since Rc is not fundamental

pub fn as_chunks<const N: usize>(&self) -> (&SliceCell<[T; N]>, &Self)

N should not be 0.

Splits the slice into a slice of N-element arrays, starting at the beginning of the slice, and a remainder slice with length strictly less than N.

pub fn as_rchunks<const N: usize>(&self) -> (&Self, &SliceCell<[T; N]>)

N should not be 0.

Splits the slice into a slice of N-element arrays, starting at the end of the slice, and a remainder slice with length strictly less than N.

pub fn as_chunks_mut<const N: usize>(
    &mut self
) -> (&mut SliceCell<[T; N]>, &mut Self)

N should not be 0.

Splits the slice into a slice of N-element arrays, starting at the beginning of the slice, and a remainder slice with length strictly less than N.

pub fn as_rchunks_mut<const N: usize>(
    &mut self
) -> (&mut Self, &mut SliceCell<[T; N]>)

N should not be 0.

Splits the slice into a slice of N-element arrays, starting at the end of the slice, and a remainder slice with length strictly less than N.

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

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

pub fn flatten(&self) -> &SliceCell<T>

pub fn flatten_mut(&mut self) -> &mut SliceCell<T>

Trait Implementations

impl<T, const N: usize> AsMut<SliceCell<T>> for ArrayCell<T, N>

fn as_mut(&mut self) -> &mut SliceCell<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, const N: usize> AsRef<SliceCell<T>> for ArrayCell<T, N>

fn as_ref(&self) -> &SliceCell<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, const N: usize> Deref for ArrayCell<T, N>

type Target = SliceCell<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, const N: usize> DerefMut for ArrayCell<T, N>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T, const N: usize> From<&'a ArrayCell<T, N>> for &'a SliceCell<T>

fn from(value: &'a ArrayCell<T, N>) -> Self

Converts to this type from the input type.

impl<'a, T, const N: usize> From<&'a mut ArrayCell<T, N>> for &'a mut SliceCell<T>

fn from(value: &'a mut ArrayCell<T, N>) -> Self

Converts to this type from the input type.

impl<'a, T, const N: usize> IntoIterator for &'a ArrayCell<T, N>

type Item = &'a Cell<T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Cell<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> IntoIterator for &'a mut ArrayCell<T, N>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, const N: usize> TryFrom<&'a SliceCell<T>> for &'a ArrayCell<T, N>

type Error = &'a SliceCell<T>

The type returned in the event of a conversion error.

fn try_from(value: &'a SliceCell<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T, const N: usize> TryFrom<&'a mut SliceCell<T>> for &'a mut ArrayCell<T, N>

type Error = &'a mut SliceCell<T>

The type returned in the event of a conversion error.

fn try_from(value: &'a mut SliceCell<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T, const N: usize> TryFrom<Box<SliceCell<T>, Global>> for Box<ArrayCell<T, N>>

type Error = Box<SliceCell<T>, Global>

The type returned in the event of a conversion error.

fn try_from(value: Box<SliceCell<T>>) -> Result<Self, Self::Error>

Performs the conversion.