Struct ArrayChain

pub struct ArrayChain<T, const N: usize> { /* private fields */ }

Implementations

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

pub fn new_uninit() -> ArrayChain<MaybeUninit<T>, N>

pub fn new_zeroed() -> ArrayChain<MaybeUninit<T>, N>

impl<T, const N: usize> ArrayChain<MaybeUninit<T>, N>

pub unsafe fn assume_init(self) -> ArrayChain<T, N>

Assumes all slots inside the array are initialised according to T’s requirements, and converts into an array of T

Note: this implementation is currently subpar, as it does fully copy self into a new container using ptr::read. We have to do this because, at the time of writing:

• transmute is a bit too dumb, and is not able to prove [T; N] and [MaybeUninit<T>; N] are guaranteed to be equal sized, even though we can see and prove it
• transmute_unchecked is like transmute but without that compile time size check, but it is unstable, and according to a code comment will almost certainly never be stabilised (reasoning is that it’s too unsafe, too much power to give users :p, and to hopefully find other methods for doing things without it so that it isn’t needed)
• MaybeUninit::array_assume_init is unstable (it internally makes use of transmute_unchecked)

We don’t know of any other option than to perform a ptr cast, then read from it.

Safety

All slots in self must be fully initialised with valid values of T.

Trait Implementations

impl<T, const N: usize> AsChainInner<[T; N]> for ArrayChain<T, N>

fn as_inner(&self) -> &[T; N]

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

impl<T, const N: usize> AsMut<[T; N]> for ArrayChain<T, N>

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

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

impl<T, const N: usize> AsRef<[T; N]> for ArrayChain<T, N>

fn as_ref(&self) -> &[T; N]

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

impl<T, const N: usize> Chain for ArrayChain<T, N>

type Inner = [T; N]

fn into_inner(self) -> Self::Inner

fn from_inner(inner: Self::Inner) -> Self

fn as_inner(&self) -> &Self::Inner

fn as_inner_mut(&mut self) -> &mut Self::Inner

fn with_inner<F, Void>(self, f: F) -> Self

where F: FnOnce(&mut Self::Inner) -> Void,

Takes a closure that is called, passing in a reference to the inner value

impl<T, const N: usize> Clone for ArrayChain<T, N>

where [T; N]: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

where [T; N]: Debug,

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

Formats the value using the given formatter.

impl<T, const N: usize> Default for ArrayChain<T, N>

where [T; N]: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize> Display for ArrayChain<T, N>

where [T; N]: Display,

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

Formats the value using the given formatter.

impl<T, const N: usize> From<&[T; N]> for ArrayChain<T, N>

where [T; N]: Clone,

fn from(inner: &[T; N]) -> Self

Converts to this type from the input type.

impl<T, const N: usize> From<&ArrayChain<T, N>> for [T; N]

where [T; N]: Clone,

fn from(chain: &ArrayChain<T, N>) -> Self

Converts to this type from the input type.

impl<T, const N: usize> From<&mut [T; N]> for ArrayChain<T, N>

where [T; N]: Clone,

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

Converts to this type from the input type.

impl<T, const N: usize> From<&mut ArrayChain<T, N>> for [T; N]

where [T; N]: Clone,

fn from(chain: &mut ArrayChain<T, N>) -> Self

Converts to this type from the input type.

impl<T, const N: usize> From<[T; N]> for ArrayChain<T, N>

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

Converts to this type from the input type.

impl<T, const N: usize> From<ArrayChain<T, N>> for [T; N]

fn from(chain: ArrayChain<T, N>) -> Self

Converts to this type from the input type.

impl<T, const N: usize> PartialEq<[T; N]> for ArrayChain<T, N>

where [T; N]: PartialEq<[T; N]>,

fn eq(&self, other: &[T; N]) -> bool

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

fn ne(&self, other: &[T; N]) -> bool

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

impl<T, const N: usize> PartialEq<ArrayChain<T, N>> for [T; N]

where [T; N]: PartialEq<[T; N]>,

fn eq(&self, other: &ArrayChain<T, N>) -> bool

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

fn ne(&self, other: &ArrayChain<T, N>) -> bool

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

impl<T, const N: usize> PartialEq for ArrayChain<T, N>

where [T; N]: PartialEq<[T; N]>,

fn eq(&self, other: &ArrayChain<T, N>) -> bool

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

fn ne(&self, other: &ArrayChain<T, N>) -> bool

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

impl<T, const N: usize> PartialOrd<[T; N]> for ArrayChain<T, N>

where [T; N]: PartialOrd<[T; N]>,

fn partial_cmp(&self, other: &[T; N]) -> Option<Ordering>

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

fn lt(&self, other: &[T; N]) -> bool

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

fn le(&self, other: &[T; N]) -> bool

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

fn gt(&self, other: &[T; N]) -> bool

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

fn ge(&self, other: &[T; N]) -> bool

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

impl<T, const N: usize> PartialOrd<ArrayChain<T, N>> for [T; N]

where [T; N]: PartialOrd<[T; N]>,

fn partial_cmp(&self, other: &ArrayChain<T, N>) -> Option<Ordering>

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

fn lt(&self, other: &ArrayChain<T, N>) -> bool

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

fn le(&self, other: &ArrayChain<T, N>) -> bool

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

fn gt(&self, other: &ArrayChain<T, N>) -> bool

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

fn ge(&self, other: &ArrayChain<T, N>) -> bool

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

impl<T, const N: usize> PartialOrd for ArrayChain<T, N>

where [T; N]: PartialOrd<[T; N]>,

fn partial_cmp(&self, other: &ArrayChain<T, N>) -> Option<Ordering>

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

fn lt(&self, other: &ArrayChain<T, N>) -> bool

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

fn le(&self, other: &ArrayChain<T, N>) -> bool

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

fn gt(&self, other: &ArrayChain<T, N>) -> bool

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

fn ge(&self, other: &ArrayChain<T, N>) -> bool

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

impl<T, const N: usize> Copy for ArrayChain<T, N>

where [T; N]: Copy,