Type Alias nunny::Vec

pub type Vec<T> = NonEmpty<Vec<T>>;

A non-empty, heap allocated Vec.

Aliased Type

struct Vec<T> { /* private fields */ }

Implementations

impl<T> Vec<T>

Vec methods

pub fn new_ref(src: &Vec<T>) -> Option<&Self>

Create a new NonEmpty heap-allocated vec

Returns None if src is empty.

pub fn new_mut(src: &mut Vec<T>) -> Option<&mut Self>

Create a new NonEmpty heap-allocated vec

Returns None if src is empty.

pub unsafe fn new_unchecked(src: Vec<T>) -> Self

Create a new NonEmpty heap-allocated vec

Safety

• src must not be empty

pub unsafe fn new_ref_unchecked(src: &Vec<T>) -> &Self

Create a new NonEmpty heap-allocated vec

Safety

• src must not be empty

pub unsafe fn new_mut_unchecked(src: &mut Vec<T>) -> &mut Self

Create a new NonEmpty heap-allocated vec

Safety

• src must not be empty

pub fn new(src: Vec<T>) -> Result<Self, Vec<T>>

Create a new NonEmpty heap-allocated vec, returning the original allocation if it was empty.

pub fn of(item: T) -> Self

Create a NonEmpty heap-allocated vec, of a single element.

pub fn of_with_capacity(item: T, capacity: usize) -> Self

Create a NonEmpty heap-allocated vec, of a single element, with capacity for capacity elements without (re)-allocating.

pub fn of_extending<A>(first: T, rest: impl IntoIterator<Item = A>) -> Self

where Self: Extend<A>,

Creating a NonEmpty heap-allocated vec where the first element is known.

This is an convenience method, equivalent to

let mut it = nunny::vec!["first"];
it.extend(["this", "is", "the", "rest"]);

pub fn filled(value: T, len: NonZeroUsize) -> Self

where T: Clone,

Create a NonEmpty heap-allocated vec with len items, filled with Clones of the given value.

See also Self::filled_with.

pub fn filled_with<F>(f: F, len: NonZeroUsize) -> Self

where F: FnMut() -> T,

Create a NonEmpty heap-allocated vec with len items, filled with values returned from repeating the closure f.

See also Self::filled.

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 into_vec(self) -> Vec<T>

Returns a std::vec::Vec.

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 into_boxed_slice(self) -> Box<Slice<T>>

Return a NonEmpty boxed slice.

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 leak<'a>(self) -> &'a mut Slice<T>

Returns a NonEmpty slice.

See leak.

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

See spare_capacity_mut.

impl<T> Vec<T>

Known non-empty iterator for Vec.

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

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> Arbitrary for Vec<T>

where T: Arbitrary,

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl<T> AsMut<[T]> for Vec<T>

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

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

impl<T> AsMut<NonEmpty<[T]>> for Vec<T>

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

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

impl<T> AsMut<NonEmpty<Vec<T>>> for Vec<T>

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

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

impl<T> AsRef<[T]> for Vec<T>

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

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

impl<T> AsRef<NonEmpty<[T]>> for Vec<T>

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

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

impl<T> AsRef<NonEmpty<Vec<T>>> for Vec<T>

fn as_ref(&self) -> &Self

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

impl<T> Borrow<[T]> for Vec<T>

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

Immutably borrows from an owned value.

impl<T> Borrow<NonEmpty<[T]>> for Vec<T>

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

Immutably borrows from an owned value.

impl<T> BorrowMut<[T]> for Vec<T>

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

Mutably borrows from an owned value.

impl<T> BorrowMut<NonEmpty<[T]>> for Vec<T>

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

Mutably borrows from an owned value.

impl<T> Deref for Vec<T>

Vec to Slice

type Target = NonEmpty<[T]>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Vec<T>

Vec to Slice

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

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for Vec<T>

where T: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, T> Extend<&'a T> for Vec<T>

where T: Copy + 'a,

fn extend<II: IntoIterator<Item = &'a T>>(&mut self, iter: II)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<T> Extend<T> for Vec<T>

fn extend<II: IntoIterator<Item = T>>(&mut self, iter: II)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<T> From<&NonEmpty<[T]>> for Vec<T>

where T: Clone,

fn from(value: &Slice<T>) -> Self

Converts to this type from the input type.

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

where T: Clone,

fn from(value: &Array<T, N>) -> Self

Converts to this type from the input type.

impl<T> From<&mut NonEmpty<[T]>> for Vec<T>

where T: Clone,

fn from(value: &mut Slice<T>) -> Self

Converts to this type from the input type.

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

where T: Clone,

fn from(value: &mut Array<T, N>) -> Self

Converts to this type from the input type.

impl<T> From<Box<NonEmpty<[T]>>> for Vec<T>

fn from(value: Box<Slice<T>>) -> Self

Converts to this type from the input type.

impl<'a, T> From<Cow<'a, NonEmpty<[T]>>> for Vec<T>

where Slice<T>: ToOwned<Owned = Vec<T>>,

fn from(value: Cow<'a, Slice<T>>) -> Self

Converts to this type from the input type.

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

fn from(value: Array<T, N>) -> Self

Converts to this type from the input type.

impl<'a, T> IntoIterator for &'a Vec<T>

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> IntoIterator for &'a mut Vec<T>

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<T> IntoIterator for Vec<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> JsonSchema for Vec<T>

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<T> Ord for Vec<T>

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<T, U> PartialEq<&NonEmpty<[U]>> for Vec<T>

where T: PartialEq<U>,

fn eq(&self, other: &&Slice<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<&NonEmpty<[U; N]>> for Vec<T>

where T: PartialEq<U>,

fn eq(&self, other: &&Array<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<T, U> PartialEq<&mut NonEmpty<[U]>> for Vec<T>

where T: PartialEq<U>,

fn eq(&self, other: &&mut Slice<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> PartialEq<[U]> for Vec<T>

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 Vec<T>

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<T, U> PartialEq<NonEmpty<[U]>> for Vec<T>

where T: PartialEq<U>,

fn eq(&self, other: &Slice<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<NonEmpty<[U; N]>> for Vec<T>

where T: PartialEq<U>,

fn eq(&self, other: &Array<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<T, U> PartialEq<NonEmpty<Vec<U>>> for Vec<T>

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, U> PartialEq<Vec<U>> for Vec<T>

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> PartialOrd<[T]> for Vec<T>

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 Vec<T>

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> PartialOrd<Vec<T>> for Vec<T>

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<T> PartialOrd for Vec<T>

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<T> Serialize for Vec<T>

where T: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, T> TryFrom<&'a Vec<T>> for &'a Vec<T>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, T> TryFrom<&'a mut Vec<T>> for &'a mut Vec<T>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> TryFrom<Vec<T>> for Vec<T>

type Error = 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.