Struct NEOrderedSet 

pub struct NEOrderedSet<T: Ord>(/* private fields */);

An ordered non-empty set type guaranteeing at least one element.

Implementations

impl<T: Ord> NEOrderedSet<T>

pub fn new(head: T, tail: Vec<T>) -> Self

Creates a new non-empty ordered set from one element and optional additional elements.

pub fn singleton(value: T) -> Self

Creates a singleton ordered non-empty set.

pub fn from(set: BTreeSet<T>) -> Result<Self, NonEmptyError>

Attempts to create a non-empty ordered set from a BTreeSet. Returns an error if the provided set is empty.

pub fn into_set(self) -> BTreeSet<T>

Extracts the underlying ordered set.

pub fn is_empty(&self) -> bool

Always returns false since the set is never empty.

pub fn insert(&mut self, value: T) -> bool

Adds an element. Returns true if the set did not already contain the value.

pub fn remove(&mut self, value: &T) -> bool

Removes an element. Returns true if the set contained the value.

pub fn contains(&self, value: &T) -> bool

Returns true if the set contains a value.

pub fn len(&self) -> usize

Returns the number of elements in the set.

Trait Implementations

impl<T: Clone + Ord> Clone for NEOrderedSet<T>

fn clone(&self) -> NEOrderedSet<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Ord> Debug for NEOrderedSet<T>

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

Formats the value using the given formatter.

impl<T: Ord> From<NEOrderedSet<T>> for BTreeSet<T>

fn from(set: NEOrderedSet<T>) -> Self

Converts to this type from the input type.

impl<'a, T: Ord> IntoIterator for &'a NEOrderedSet<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<T: Ord> IntoIterator for NEOrderedSet<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: Ord + Ord> Ord for NEOrderedSet<T>

fn cmp(&self, other: &NEOrderedSet<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,

Restrict a value to a certain interval.

impl<T: PartialEq + Ord> PartialEq for NEOrderedSet<T>

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

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

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

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

impl<T: PartialOrd + Ord> PartialOrd for NEOrderedSet<T>

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

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

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

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

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

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

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

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

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

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

impl<T: Ord> TryFrom<BTreeSet<T>> for NEOrderedSet<T>

type Error = NonEmptyError

The type returned in the event of a conversion error.

fn try_from(set: BTreeSet<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq + Ord> Eq for NEOrderedSet<T>

impl<T: Ord> StructuralPartialEq for NEOrderedSet<T>