Struct idmap::set::IdSet

pub struct IdSet<T: IntegerId> { /* fields omitted */ }

A set, whose implement IntegerId

This is implemented directly as a bitset, so it may not be appropriate if you know you'll have large ids but few entries.

Implementations

impl<T: IntegerId> IdSet<T>

pub fn new() -> IdSet<T>

Create a new IdSet

pub fn with_capacity(indexes: usize) -> IdSet<T>

Initialize the set with the given capacity

Since the underlying storage is a simple bitset, this hints at the maximum capacity and not the length

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

Inserts the specified element into the set, returning true if it was already in the set and false if it wasn't.

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

Remove the specified value from the set if it is present, returning whether or not it was present.

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

Check if this set contains the specified value

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

Iterate over the values in this set

pub fn clear(&mut self)

Clear the values in this set

pub fn len(&self) -> usize

The number of entries in this set

An IdSet internally tracks this length, so this is a O(1) operation

pub fn is_empty(&self) -> bool

If this set is empty

pub fn retain<F: FnMut(&T) -> bool>(&mut self, func: F)

Retain values in the set if the specified closure returns true

Otherwise they are removed

Trait Implementations

impl<T: Clone + IntegerId> Clone for IdSet<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: IntegerId> Debug for IdSet<T>

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

Formats the value using the given formatter.

impl<T: IntegerId> Default for IdSet<T>

fn default() -> Self

Returns the "default value" for a type.

impl<'de, T> Deserialize<'de> for IdSet<T> where
    T: IntegerId + Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<T: IntegerId + Eq> Eq for IdSet<T>

impl<'a, T: IntegerId + 'a> Extend<&'a T> for IdSet<T>

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

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: IntegerId> Extend<T> for IdSet<T>

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

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<'a, T: IntegerId + 'a> FromIterator<&'a T> for IdSet<T>

fn from_iter<I: IntoIterator<Item = &'a T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: IntegerId> FromIterator<T> for IdSet<T>

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

Creates a value from an iterator.

impl<T: IntegerId + Hash> Hash for IdSet<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, 

Feeds a slice of this type into the given [Hasher].

impl<'a, T: IntegerId + 'a> Index<&'a T> for IdSet<T>

type Output = bool

The returned type after indexing.

fn index(&self, index: &'a T) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: IntegerId + 'a> Index<T> for IdSet<T>

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, T: IntegerId + 'a> IntoIterator for &'a IdSet<T>

type Item = 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: IntegerId + Ord> Ord for IdSet<T>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: IntegerId + PartialEq> PartialEq<IdSet<T>> for IdSet<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: IntegerId + PartialOrd> PartialOrd<IdSet<T>> for IdSet<T>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]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 IdSet<T> where
    T: IntegerId + Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T: IntegerId> VisitMap<T> for IdSet<T>

fn visit(&mut self, a: T) -> bool

Mark a as visited.

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

Return whether a has been visited before.