Struct ConstFixedArray 

pub struct ConstFixedArray<const TSIZE: usize, T: Sized + Copy> { /* private fields */ }

A fixed-capacity array. This type is a const (as in: compile time) analogue of FixedArray.

Notes

For the array to be usable in const context, the T type needs to be Copy (which implies “no Drop”). And in that case ConstFixedArray doesn’t need to be (and actually cannot be to work in const context) Drop as well.

Unlike FixedArray, this type does not implement any of the convenient traits such as ImmutableArray or PartialEq. These are NOT usable in const context anyway.

Implementations

impl<const TSIZE: usize, T: Sized + Copy> ConstFixedArray<TSIZE, T>

pub const fn new() -> Self

Creates a new, empty ConstFixedArray.

Panics

This function will panic if the TSIZE is invalid, i.e. when either TSIZE is 0 or exceeds [Length::MAX_LENGTH].

pub const fn length(&self) -> Length

Returns the length of the ConstFixedArray.

pub const fn is_empty(&self) -> bool

pub const fn capacity(&self) -> Length

Returns the capacity of the ConstFixedArray. This is TSIZE as [Length].

pub const fn as_slice_const(&self) -> &[T]

Returns the ConstFixedArray as immutable slice.

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

Returns the ConstFixedArray as mutable slice.

pub const fn try_push_array_const<const TARRSIZE: usize>( &mut self, arr: [T; TARRSIZE], ) -> Result<(), ArrayError>

Pushes a raw array to the ConstFixedArray.

Errors

For errors see ArrayError.

pub const fn push_array_const<const TARRSIZE: usize>( &mut self, arr: [T; TARRSIZE], )

Pushes a raw array to the ConstFixedArray.

Panics

Panics if the array is full. Should be consistent with ConstFixedArray::try_push_array_const.

pub const fn try_push_slice_const( &mut self, slice: &[T], ) -> Result<(), ArrayError>

Pushes a slice to the ConstFixedArray.

Errors

For errors see ArrayError.

pub const fn push_slice_const(&mut self, slice: &[T])

Pushes a slice to the ConstFixedArray.

Panics

Panics if the array is full. Should be consistent with ConstFixedArray::try_push_slice_const.

pub const fn try_push_const(&mut self, value: T) -> Result<(), ArrayError>

Pushes a single element to the ConstFixedArray.

Errors

For errors see ArrayError.

pub const fn push_const(&mut self, value: T)

Pushes a single element to the ConstFixedArray.

Panics

Panics if the array is full. Should be consistent with ConstFixedArray::try_push_const.

pub const fn try_pop_const(&mut self) -> Result<T, ArrayIsEmptyError>

Removes an element from the top of the ConstFixedArray.

Errors

Returns ArrayIsEmptyError when the array is empty.

pub const fn pop_const(&mut self) -> T

Removes an element from the top of the ConstFixedArray.

Panics

Panics if the array is empty. Should be consistent with ConstFixedArray::try_pop_const.

pub const fn clone_const(&self) -> Self

Clones the ConstFixedArray.

pub const unsafe fn as_raw_slice_const(&self) -> &[T; TSIZE]

Returns the raw immutable reference to the underlying array.

Safety

This function is unsafe because only the buffer up to Length is guaranteed to be filled with a valid data.

pub const unsafe fn as_raw_slice_mut_const(&mut self) -> &mut [T; TSIZE]

Returns the raw mutable reference to the underlying array.

Safety

This function is unsafe because only the buffer up to Length is guaranteed to be filled with a valid data.

pub const fn drain(&mut self)

Drains the ConstFixedArray. This call sets the internal length of ConstFixedArray to 0, making it effectively empty.

Trait Implementations

impl<const TSIZE: usize, T: ReprC + Sized + Copy> ReprC for ConstFixedArray<TSIZE, T>

const CHECK: ()

This field is used for const checks only.