Struct indexmap_nostd::set::IndexSet

pub struct IndexSet<T> { /* private fields */ }

A b-tree set where the iteration order of the values is independent of the ordering of the values.

The interface is closely compatible with the indexmap crate and a subset of the features that is relevant for the wasmparser-nostd crate.

Differences to original IndexSet

Since the goal of this crate was to maintain a simple no_std compatible fork of the indexmap crate there are some downsides and differences.

• Some operations such as IndexSet::insert now require K: Clone.
• It is to be expected that this fork performs worse than the original indexmap crate implementation.
• The implementation is based on BTreeMap internally instead of HashMap which has the effect that methods no longer require K: Hash but K: Ord instead.

Implementations

impl<T> IndexSet<T>

pub fn new() -> Self

Makes a new, empty IndexSet.

Does not allocate anything on its own.

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty IndexSet with at least the specified capacity.

Does not allocate if capacity is zero.

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

Reserve capacity for at least additional more values.

pub fn len(&self) -> usize

Returns the number of elements in the set.

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

pub fn is_disjoint(&self, other: &Self) -> bool where
    T: Ord, 

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

pub fn is_subset(&self, other: &Self) -> bool where
    T: Ord, 

Returns true if the set is a subset of another, i.e., other contains at least all the elements in self.

pub fn is_superset(&self, other: &Self) -> bool where
    T: Ord, 

Returns true if the set is a superset of another, i.e., self contains at least all the elements in other.

pub fn contains<Q: ?Sized>(&self, key: &Q) -> bool where
    T: Borrow<Q> + Ord,
    Q: Ord, 

Returns true if the set contains an element equal to the value.

The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element type.

pub fn get<Q: ?Sized>(&self, value: &Q) -> Option<&T> where
    T: Borrow<Q> + Ord,
    Q: Ord, 

Returns a reference to the element in the set, if any, that is equal to the value.

The value may be any borrowed form of the set’s element type, but the ordering on the borrowed form must match the ordering on the element type.

pub fn get_full<Q: ?Sized>(&self, key: &Q) -> Option<(usize, &T)> where
    T: Borrow<Q> + Ord,
    Q: Ord, 

Returns the index-value pair corresponding to the supplied value.

The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_index_of<Q: ?Sized>(&self, key: &Q) -> Option<usize> where
    T: Borrow<Q> + Ord,
    Q: Ord, 

Returns the unique index corresponding to the supplied value.

The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

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

Returns a shared reference to the value at the given index.

pub fn insert(&mut self, value: T) -> bool where
    T: Ord + Clone, 

Adds a value to the set.

Returns whether the value was newly inserted. That is:

• If the set did not previously contain an equal value, true is returned.
• If the set already contained an equal value, false is returned, and the entry is not updated.

pub fn insert_full(&mut self, value: T) -> (usize, bool) where
    T: Ord + Clone, 

Adds a value to the set.

Returns the unique index to the value as well as a bool flag telling whether the value was newly inserted. That is:

• If the set did not previously contain an equal value, true is returned.
• If the set already contained an equal value, false is returned, and the entry is not updated.

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

Gets an iterator that visits the elements in the IndexSet in the order in which they have been inserted into the set unless there have been removals.

pub fn clear(&mut self)

Clears the set, removing all elements.

Trait Implementations

impl<T: Clone> Clone for IndexSet<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for IndexSet<T>

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

Formats the value using the given formatter.

impl<T> Default for IndexSet<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for IndexSet<T> where
    T: Deserialize<'de> + Ord + Clone, 

Requires crate feature "serde"

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 IndexSet<T> where
    T: Ord + Copy, 

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

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 IndexSet<T> where
    T: Ord + Clone, 

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

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, const N: usize> From<[T; N]> for IndexSet<T> where
    T: Ord + Clone, 

fn from(items: [T; N]) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for IndexSet<T> where
    T: Ord + Clone, 

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = T>, 

Creates a value from an iterator.

impl<T> Index<usize> for IndexSet<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'de, T, E> IntoDeserializer<'de, E> for IndexSet<T> where
    T: IntoDeserializer<'de, E> + Ord,
    E: Error, 

type Deserializer = SeqDeserializer<<IndexSet<T> as IntoIterator>::IntoIter, E>

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

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

fn cmp(&self, other: &IndexSet<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<IndexSet<T>> for IndexSet<T>

fn eq(&self, other: &IndexSet<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<T: PartialOrd> PartialOrd<IndexSet<T>> for IndexSet<T>

fn partial_cmp(&self, other: &IndexSet<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 IndexSet<T> where
    T: Serialize + Ord, 

Requires crate feature "serde"

fn serialize<Se>(&self, serializer: Se) -> Result<Se::Ok, Se::Error> where
    Se: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for IndexSet<T>

impl<T> StructuralEq for IndexSet<T>

impl<T> StructuralPartialEq for IndexSet<T>