Struct cl_array_ext::SliceN

#[repr(C)]
pub struct SliceN<T, const N: usize> {
    pub head: [T; N],
    pub tail: [T],
}

A slice with at least N elements. Can be dereferenced back into a regular slice on demand.

use cl_array_ext::SliceN;
let a: &mut [_] = &mut [1, 2, 3, 4, 5];
let b: &mut SliceN<_, 3> = a.try_into().unwrap();

b.head = [3, 2, 1];
b.tail.reverse();

assert_eq!(a, [3, 2, 1, 5, 4]);

Fields

head: [T; N]

Head of the slice, where N items are guaranteed to exist

tail: [T]

Tail of the slice, may be empty

Implementations

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

pub unsafe fn increase_unchecked<const M: usize>(&self) -> &SliceN<T, { N + M }>

Increases the bounds of the slice into a new known length.

Safety

There must be at least M elements in the tail available, otherwise this will result in UB

pub unsafe fn increase_unchecked_mut<const M: usize>(
    &mut self
) -> &mut SliceN<T, { N + M }>

Increases the bounds of the slice into a new known length.

Safety

There must be at least M elements in the tail available, otherwise this will result in UB

pub fn increase<const M: usize>(
    &self
) -> Result<&SliceN<T, { N + M }>, NotEnoughEntries>

Increases the bounds of the slice into a new known length.

Errors

There should be at least M elements in the tail available, otherwise this will return an error

pub fn increase_mut<const M: usize>(
    &mut self
) -> Result<&mut SliceN<T, { N + M }>, NotEnoughEntries>

Increases the bounds of the slice into a new known length.

Errors

There should be at least M elements in the tail available, otherwise this will return an error

pub fn downsize<const M: usize>(&self) -> &SliceN<T, M> where
    [T; N - M]: Sized, 

Decreases the bounds of the slice to a smaller known length.

pub fn downsize_mut<const M: usize>(&mut self) -> &mut SliceN<T, M> where
    [T; N - M]: Sized, 

Decreases the bounds of the slice to a smaller known length.

pub unsafe fn from_unchecked(slice: &[T]) -> &Self

Convert a slice into one that is guaranteed to have at least N elements

Safety

The length of the slice must be >= N, otherwise this will result in UB

pub unsafe fn from_unchecked_mut(slice: &mut [T]) -> &mut Self

Convert a mut slice into one that is guaranteed to have at least N elements

Safety

The length of the slice must be >= N, otherwise this will result in UB

Trait Implementations

impl<T: Debug, const N: usize> Debug for SliceN<T, N>

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

Formats the value using the given formatter.

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

type Target = [T]

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

impl<'a, T, const N: usize> TryFrom<&'a [T]> for &'a SliceN<T, N>

type Error = NotEnoughEntries

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, T, const N: usize> TryFrom<&'a mut [T]> for &'a mut SliceN<T, N>

type Error = NotEnoughEntries

The type returned in the event of a conversion error.

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

Performs the conversion.