Struct OrderedSet

pub struct OrderedSet<K: 'static> { /* private fields */ }

An order-preserving set which can be constructed at compile time.

“Order-preserving” means iteration order is guaranteed to match the definition order.

Implementations

impl<K> OrderedSet<K>

pub const fn new() -> Self

Create an set map.

pub const fn len(&self) -> usize

Returns the number of entries in the map.

pub const fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn get<T: ?Sized>(&self, key: &T) -> Option<&K>

where K: PhfKeyProxy<T>,

Returns a reference to the value that key maps to.

pub fn contains<T: ?Sized>(&self, key: &T) -> bool

where K: PhfKeyProxy<T>,

Determines if key is in the OrderedMap.

pub fn get_index<T: ?Sized>(&self, key: &T) -> Option<usize>

where K: PhfKeyProxy<T>,

Returns the index of the key within the list used to initialize the ordered map.

pub fn index(&self, index: usize) -> Option<&K>

Returns references to both the key and values at an index within the list used to initialize the ordered map. See .get_index(key).

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

Returns an iterator over the values in the set.

Values are returned in the same order in which they were defined.

pub fn is_disjoint(&self, other: &OrderedSet<K>) -> bool

where K: PhfKeyProxy<K>,

Returns true if other shares no elements with self.

pub fn is_subset(&self, other: &OrderedSet<K>) -> bool

where K: PhfKeyProxy<K>,

Returns true if other contains all values in self.

pub fn is_superset(&self, other: &OrderedSet<K>) -> bool

where K: PhfKeyProxy<K>,

Returns true if self contains all values in other.

Trait Implementations

impl<T> Debug for OrderedSet<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<K> Default for OrderedSet<K>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> IntoIterator for &'a OrderedSet<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) -> Iter<'a, T>

Creates an iterator from a value.

impl<T> PartialEq for OrderedSet<T>

where T: PartialEq,

fn eq(&self, other: &Self) -> 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> Eq for OrderedSet<T>

where T: Eq,