Struct nonempty_collections::slice::NESlice

pub struct NESlice<'a, T> {
    pub head: &'a T,
    pub tail: &'a [T],
}

A non-empty slice. Like crate::NEVec, but guaranteed to have borrowed contents.

NESlice::from_slice is the simplest way to construct this from borrowed data.

Unfortunately there is no macro for this, but if you want one, just use nev! and handle the ownership manually. Also consider crate::NEVec::as_nonempty_slice.

Fields

head: &'a T

The element of the non-empty slice. Always exists.

tail: &'a [T]

The remaining elements of the non-empty slice, perhaps empty.

Implementations

impl<'a, T> NESlice<'a, T>

pub fn new(head: &'a T, tail: &'a [T]) -> Self

Create a new non-empty slice with an initial element.

pub const fn first(&self) -> &T

Get the first element. Never fails.

pub fn from_slice(slice: &'a [T]) -> Option<Self>

Using from_slice gives a proof that the input slice is non-empty in the Some branch.

pub fn len(&self) -> NonZeroUsize

Get the length of the slice.

pub fn is_empty(&self) -> bool

No, this slice is not empty.

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

Generates a standard iterator.

pub fn nonempty_chunks(&'a self, chunk_size: NonZeroUsize) -> NEChunks<'a, T>

Returns a non-empty iterator over chunk_size elements of the NESlice at a time, starting at the beginning of the NESlice.

use nonempty_collections::*;
use std::num::NonZeroUsize;

let v = nev![1,2,3,4,5,6];
let s = v.as_nonempty_slice();
let n = NonZeroUsize::new(2).unwrap();
let r = s.nonempty_chunks(n).collect::<NEVec<_>>();

let a = nev![1,2];
let b = nev![3,4];
let c = nev![5,6];

assert_eq!(r, nev![a.as_nonempty_slice(), b.as_nonempty_slice(), c.as_nonempty_slice()]);

Trait Implementations

impl<'a, T: Clone> Clone for NESlice<'a, T>

fn clone(&self) -> NESlice<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for NESlice<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Hash> Hash for NESlice<'a, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> IntoNonEmptyIterator for NESlice<'a, T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of NonEmptyIterator are we turning this into?

fn into_nonempty_iter(self) -> Self::IntoIter

Creates a NonEmptyIterator from a value.

impl<'a, T: Ord> Ord for NESlice<'a, T>

fn cmp(&self, other: &NESlice<'a, T>) -> 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, T: PartialEq> PartialEq for NESlice<'a, T>

fn eq(&self, other: &NESlice<'a, T>) -> 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, T: PartialOrd> PartialOrd for NESlice<'a, T>

fn partial_cmp(&self, other: &NESlice<'a, 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<'a, T: Eq> Eq for NESlice<'a, T>

impl<'a, T> StructuralPartialEq for NESlice<'a, T>