Type Alias nunny::Array

pub type Array<T, const N: usize> = NonEmpty<[T; N]>;

A non-empty array of known size.

Aliased Type

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

Implementations

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

Array methods

pub const fn new_ref(src: &[T; N]) -> Option<&Self>

Returns a NonEmpty array.

Returns None if src is empty.

pub fn new_mut(src: &mut [T; N]) -> Option<&mut Self>

Returns a NonEmpty array.

Returns None if src is empty.

pub fn new(src: [T; N]) -> Option<Self>

Returns a NonEmpty array.

Returns None if src is empty.

pub const unsafe fn new_ref_unchecked(src: &[T; N]) -> &Self

Create a NonEmpty array.

Safety

• src must not be empty

pub unsafe fn new_mut_unchecked(src: &mut [T; N]) -> &mut Self

Create a NonEmpty array.

Safety

• src must not be empty

pub const unsafe fn new_unchecked(src: [T; N]) -> Self

Create a NonEmpty array.

Safety

• src must not be empty

pub fn each_ref(&self) -> Array<&T, N>

Borrows each element and returns a NonEmpty array of references with the same size as self.

pub fn each_mut(&mut self) -> Array<&mut T, N>

Borrows each element mutably and returns a NonEmpty array of mutable references with the same size as self.

pub fn each_map<F, U>(self, f: F) -> Array<U, N>

where F: FnMut(T) -> U,

Returns a NonEmpty array of the same size as self, with function f applied to each element in order.

pub const fn as_slice_ne(&self) -> &Slice<T>

Returns a NonEmpty slice.

pub fn as_mut_slice_ne(&mut self) -> &mut Slice<T>

Returns a NonEmpty slice.

pub const fn as_array(&self) -> &[T; N]

Returns a primitive array.

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

Returns a primitive array.

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

Returns a primitive array.

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

Known non-empty iterator for Array.

pub fn into_iter_ne(self) -> NonEmpty<IntoIter<T, N>>

impl<T> Array<T, 1>

Special case for Arrays of length one

pub const fn of(item: T) -> Self

Create a NonEmpty array of a single element

pub fn of_mut(item: &mut T) -> &mut Self

Create a NonEmpty array of a single mutable reference

pub const fn of_ref(item: &T) -> &Self

Create a NonEmpty array of a single reference

Methods from Deref<Target = Slice<T>>

pub fn each_ref(&self) -> Array<&T, N>

Borrows each element and returns a NonEmpty array of references with the same size as self.

pub fn each_mut(&mut self) -> Array<&mut T, N>

Borrows each element mutably and returns a NonEmpty array of mutable references with the same size as self.

pub fn as_slice_ne(&self) -> &Slice<T>

Returns a NonEmpty slice.

pub fn as_mut_slice_ne(&mut self) -> &mut Slice<T>

Returns a NonEmpty slice.

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

Returns a primitive array.

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

Returns a primitive array.

pub fn peek(&mut self) -> &I::Item

Peek this NonEmpty iterator, without advancing it.

See Self::peekable.

pub fn peek_mut(&mut self) -> &mut I::Item

Peek and modify this NonEmpty iterator, without advancing it.

See Self::peekable.

pub fn as_slice(&self) -> &[T]

Returns a primitive slice.

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

Returns a primitive slice.

pub fn len_ne(&self) -> NonZeroUsize

Returns the known non-zero length.

pub fn first(&self) -> &T

Returns the first element, guaranteed.

pub fn split_first(&self) -> (&T, &[T])

Returns the first element, guaranteed, and the rest of the elements.

pub fn split_last(&self) -> (&T, &[T])

Returns the last element, guaranteed, and the rest of the elements.

pub fn last(&self) -> &T

Returns the last element, guaranteed.

pub fn first_mut(&mut self) -> &mut T

Returns the first element, guaranteed.

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

Returns the first element, guaranteed, and the rest of the elements.

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

Returns the last element, guaranteed, and the rest of the elements.

pub fn last_mut(&mut self) -> &mut T

Returns the last element, guaranteed.

pub fn iter_ne(&self) -> NonEmpty<Iter<'_, T>>

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

pub fn as_vec(&self) -> &Vec<T>

Returns a std::vec::Vec.

pub unsafe fn as_mut_vec(&mut self) -> &mut Vec<T>

Returns a std::vec::Vec.

Safety

• returned vec must not be emptied through this reference

pub fn as_slice_ne(&self) -> &Slice<T>

Returns a NonEmpty slice.

pub fn as_mut_slice_ne(&mut self) -> &mut Slice<T>

Returns a NonEmpty slice.

pub fn capacity(&self) -> NonZeroUsize

Returns the known non-zero length.

pub fn reserve(&mut self, additional: usize)

See reserve.

pub fn reserve_exact(&mut self, additional: usize)

See reserve_exact.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

See try_reserve.

pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>

See try_reserve_exact.

pub fn shrink_to_fit(&mut self)

See shrink_to_fit.

pub fn shrink_to(&mut self, min_capacity: usize)

See shrink_to.

pub fn truncate(&mut self, len: NonZeroUsize)

Shortens the vector to a guaranteed-nonzero length

See truncate.

pub unsafe fn set_len(&mut self, new_len: NonZeroUsize)

Safety

• See set_len.

pub fn insert(&mut self, index: usize, element: T)

See insert.

pub fn dedup_by_key<F, K>(&mut self, key: F)

where F: FnMut(&mut T) -> K, K: PartialEq,

See dedup_by_key.

pub fn dedup_by<F>(&mut self, same_bucket: F)

where F: FnMut(&mut T, &mut T) -> bool,

See dedup_by.

pub fn push(&mut self, value: T)

See push.

pub fn append(&mut self, other: &mut Vec<T>)

See append.

pub fn resize_with<F>(&mut self, new_len: NonZeroUsize, f: F)

where F: FnMut() -> T,

See resize_with.

pub fn spare_capacity_mut(&mut self) -> &mut [MaybeUninit<T>]

See spare_capacity_mut.

Trait Implementations

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

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

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

impl<T, const N: usize> AsMut<NonEmpty<[T]>> for Array<T, N>

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

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

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

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

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

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

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

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

impl<T, const N: usize> AsRef<NonEmpty<[T]>> for Array<T, N>

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

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

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

fn as_ref(&self) -> &Self

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

impl<T, const N: usize> Borrow<[T]> for Array<T, N>

fn borrow(&self) -> &[T]

Immutably borrows from an owned value.

impl<T, const N: usize> Borrow<NonEmpty<[T]>> for Array<T, N>

fn borrow(&self) -> &Slice<T>

Immutably borrows from an owned value.

impl<T, const N: usize> BorrowMut<[T]> for Array<T, N>

fn borrow_mut(&mut self) -> &mut [T]

Mutably borrows from an owned value.

impl<T, const N: usize> BorrowMut<NonEmpty<[T]>> for Array<T, N>

fn borrow_mut(&mut self) -> &mut Slice<T>

Mutably borrows from an owned value.

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

Array to Slice

type Target = NonEmpty<[T]>

The resulting type after dereferencing.

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

Dereferences the value.

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

Array to Slice

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

Mutably dereferences the value.

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'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> IntoIterator for &'a mut Array<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<const N: usize, T> IntoIterator for Array<T, N>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, const N: usize> JsonSchema for Array<T, N>

where T: JsonSchema,

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl<const N: usize, T> Ord for Array<T, N>

where T: Ord,

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<A, B, const N: usize> PartialEq<&NonEmpty<[B]>> for Array<A, N>

where A: PartialEq<B>,

fn eq(&self, other: &&Slice<B>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

impl<A, B, const N: usize> PartialEq<&mut NonEmpty<[B]>> for Array<A, N>

where A: PartialEq<B>,

fn eq(&self, other: &&mut Slice<B>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

impl<T, U, const N: usize> PartialEq<[U]> for Array<T, N>

where T: PartialEq<U>,

fn eq(&self, other: &[U]) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

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

where T: PartialEq<U>,

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

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

fn ne(&self, other: &Rhs) -> bool

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

impl<A, B, const N: usize> PartialEq<NonEmpty<[B]>> for Array<A, N>

where A: PartialEq<B>,

fn eq(&self, other: &Slice<B>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

impl<A, B, const N: usize> PartialEq<NonEmpty<[B; N]>> for Array<A, N>

where A: PartialEq<B>,

fn eq(&self, other: &Array<B, N>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

impl<T, U, const N: usize> PartialEq<Vec<U>> for Array<T, N>

where T: PartialEq<U>,

fn eq(&self, other: &Vec<U>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method 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]> for Array<T, N>

where T: PartialOrd,

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<T, const N: usize> PartialOrd<[T; N]> for Array<T, N>

where T: PartialOrd,

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: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<T, const N: usize> PartialOrd<Vec<T>> for Array<T, N>

where T: PartialOrd,

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<const N: usize, T> PartialOrd for Array<T, N>

where T: PartialOrd,

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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, T, const N: usize> TryFrom<&'a [T; N]> for &'a Array<T, N>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromSliceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, const N: usize> TryFrom<&NonEmpty<[T]>> for Array<T, N>

where T: Copy,

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from(value: &Slice<T>) -> Result<Self, Self::Error>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = TryFromSliceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, const N: usize> TryFrom<&mut NonEmpty<[T]>> for Array<T, N>

where T: Copy,

type Error = TryFromSliceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, const N: usize> TryFrom<[T; N]> for Array<T, N>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: [T; N]) -> Result<Self, Self::Error>

Performs the conversion.

impl<T, const N: usize> TryFrom<Box<NonEmpty<[T]>>> for Box<Array<T, N>>

type Error = Box<NonEmpty<[T]>>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, const N: usize> TryFrom<NonEmpty<Vec<T>>> for Box<Array<T, N>>

type Error = NonEmpty<Vec<T>>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, const N: usize> TryFrom<NonEmpty<Vec<T>>> for Array<T, N>

type Error = NonEmpty<Vec<T>>

The type returned in the event of a conversion error.

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

Performs the conversion.