Struct cl_traits::ArrayWrapper

pub struct ArrayWrapper<A> { /* fields omitted */ }

With const-generics feature, wraps an arbitrary length array. Otherwise, wraps an array with a selected number of elements. Necessary for third-party and std implementations.

This structure will be removed once const-generics is stabilized.

Implementations

impl<A> ArrayWrapper<A> where
    A: Array, 

pub fn new(array: A) -> Self

Wraps array into this structure.

Trait Implementations

impl<A> AsMut<[<A as Array>::Item]> for ArrayWrapper<A> where
    A: Array, 

fn as_mut(&mut self) -> &mut [A::Item]

Performs the conversion.

impl<A> AsMut<A> for ArrayWrapper<A> where
    A: Array, 

fn as_mut(&mut self) -> &mut A

Performs the conversion.

impl<A> AsRef<[<A as Array>::Item]> for ArrayWrapper<A> where
    A: Array, 

fn as_ref(&self) -> &[A::Item]

Performs the conversion.

impl<A> AsRef<A> for ArrayWrapper<A> where
    A: Array, 

fn as_ref(&self) -> &A

Performs the conversion.

impl<A> Borrow<[<A as Array>::Item]> for ArrayWrapper<A> where
    A: Array, 

fn borrow(&self) -> &[A::Item]

Immutably borrows from an owned value.

impl<A> Borrow<A> for ArrayWrapper<A> where
    A: Array, 

fn borrow(&self) -> &A

Immutably borrows from an owned value.

impl<A> BorrowMut<[<A as Array>::Item]> for ArrayWrapper<A> where
    A: Array, 

fn borrow_mut(&mut self) -> &mut [A::Item]

Mutably borrows from an owned value.

impl<A> BorrowMut<A> for ArrayWrapper<A> where
    A: Array, 

fn borrow_mut(&mut self) -> &mut A

Mutably borrows from an owned value.

impl<A> Capacity for ArrayWrapper<A> where
    A: Array, 

let mut structure = cl_traits::doc_tests::array_wrapper();
assert_eq!(cl_traits::Capacity::capacity(&structure), 3);

type Output = usize

Output

fn capacity(&self) -> Self::Output

The number of elements that the implementation is able to store, not necessary equal to its length.

impl<A> Clone for ArrayWrapper<A> where
    A: Array + Clone,
    A::Item: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Copy for ArrayWrapper<A> where
    A: Array + Copy,
    A::Item: Copy, 

impl<A> Debug for ArrayWrapper<A> where
    A: Array,
    A::Item: Debug, 

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

Formats the value using the given formatter.

impl<A> Default for ArrayWrapper<A> where
    A: Array,
    A::Item: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<A> Deref for ArrayWrapper<A> where
    A: Array, 

type Target = A

The resulting type after dereferencing.

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

Dereferences the value.

impl<A> DerefMut for ArrayWrapper<A> where
    A: Array, 

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

Mutably dereferences the value.

impl<A> Eq for ArrayWrapper<A> where
    A: Array,
    A::Item: Eq, 

impl<A> From<A> for ArrayWrapper<A> where
    A: Array, 

fn from(from: A) -> Self

Performs the conversion.

impl<I, A> Index<I> for ArrayWrapper<A> where
    A: Array,
    I: SliceIndex<[A::Item]>, 

type Output = <I as SliceIndex<[A::Item]>>::Output

The returned type after indexing.

fn index(&self, idx: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I, A> IndexMut<I> for ArrayWrapper<A> where
    A: Array,
    I: SliceIndex<[A::Item]>, 

fn index_mut(&mut self, idx: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, A> IntoIterator for &'a ArrayWrapper<A> where
    A: Array, 

type Item = &'a A::Item

The type of the elements being iterated over.

type IntoIter = Iter<'a, A::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, A> IntoIterator for &'a mut ArrayWrapper<A> where
    A: Array, 

type Item = &'a mut A::Item

The type of the elements being iterated over.

type IntoIter = IterMut<'a, A::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A> Length for ArrayWrapper<A> where
    A: Array, 

let structure = cl_traits::doc_tests::array_wrapper();
assert_eq!(cl_traits::Length::length(&structure), 3);

type Output = usize

Output

fn length(&self) -> Self::Output

Holds a certain number of elements.

impl<A> Ord for ArrayWrapper<A> where
    A: Array,
    A::Item: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<A> PartialEq<ArrayWrapper<A>> for ArrayWrapper<A> where
    A: Array,
    A::Item: PartialEq, 

fn eq(&self, other: &Self) -> bool

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

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

This method tests for !=.

impl<A> PartialOrd<ArrayWrapper<A>> for ArrayWrapper<A> where
    A: Array,
    A::Item: PartialOrd, 

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

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

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

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

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

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

impl<A> Storage for ArrayWrapper<A> where
    A: Array, 

type Item = A::Item

Storage item

impl<A> Swap for ArrayWrapper<A> where
    A: Array, 

let mut structure = cl_traits::doc_tests::array_wrapper();
cl_traits::Swap::swap(&mut structure, [0, 2]);
assert_eq!(structure.get(0), Some(&3));
assert_eq!(structure.get(2), Some(&1));

type Input = [usize; 2]

Input

type Output = ()

Output

fn swap(&mut self, [a, b]: Self::Input)

Swaps two elements referencied by Input.

impl<A> WithCapacity for ArrayWrapper<A> where
    A: Array,
    A::Item: Default, 

use cl_traits::Capacity;
let structure: cl_traits::ArrayWrapper<[i32; 5]>;
structure = cl_traits::WithCapacity::with_capacity(Default::default());
assert_eq!(structure.capacity(), 5);

type Input = usize

Input

fn with_capacity(_: Self::Input) -> Self

Creates a new instance based on an initial holding capacity provided by Input.