Struct pfx::set::PrefixTreeSet

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

An ordered set based on a prefix tree.

Implementations

impl<T> PrefixTreeSet<T>

pub const fn new() -> Self

Creates an empty set. The same as Default.

pub const fn len(&self) -> usize

Returns the number of items in this set.

pub const fn is_empty(&self) -> bool

Returns true if and only if this set is empty.

pub fn contains<Q>(&self, item: &Q) -> bool

where Q: ?Sized + AsRef<[u8]>,

Returns true if the key is found in the map, false otherwise.

pub fn remove<Q>(&mut self, key: &Q) -> bool

where Q: ?Sized + AsRef<[u8]>,

Removes a key if it existed. Returns true if a removal happened, and false if the key did not exist in the first place.

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

Returns an iterator over the borrowed items.

pub fn compact(&mut self)

Removes all internal nodes which are not useful. See the documentation of crate::map::PrefixTreeMap::compact for more details on why this is useful.

impl<T: AsRef<[u8]>> PrefixTreeSet<T>

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

Inserts the key if it did not exist.

Returns true if an insertion happened, and false if the key already existed.

pub fn union<I>(self, other: I) -> Self

where I: IntoIterator<Item = T>,

Takes the union of self with another set of elements. Elements that already exist in self will be overwritten by other.

pub fn union_in_place<I>(&mut self, other: I)

where I: IntoIterator<Item = T>,

Takes the union of self with another set of elements. Elements that already exist in self will be overwritten by other.

pub fn intersection<I>(&self, other: I) -> Self

where I: IntoIterator<Item = T>,

Takes the intersection of self with another set of elements.

This takes &self by reference and not self by value because computing the intersection always incurs the allocation of a new set. For the same reason, there is no intersection_in_place() method, either.

pub fn difference<I>(self, other: I) -> Self

where I: IntoIterator, I::Item: AsRef<[u8]>,

Removes the items of other from self.

pub fn difference_in_place<I>(&mut self, other: I)

where I: IntoIterator, I::Item: AsRef<[u8]>,

Removes the items of other from self.

pub fn symmetric_difference<I>(self, other: I) -> Self

where I: IntoIterator<Item = T>,

Add elements that are missing from self, and remove elements contained in self.

pub fn symmetric_difference_in_place<I>(&mut self, other: I)

where I: IntoIterator<Item = T>,

Add elements that are missing from self, and remove elements contained in self.

Trait Implementations

impl<T, I> BitAnd<I> for &PrefixTreeSet<T>

where T: AsRef<[u8]>, I: IntoIterator<Item = T>,

Produces the intersection of self and other.

type Output = PrefixTreeSet<T>

The resulting type after applying the & operator.

fn bitand(self, other: I) -> Self::Output

Performs the & operation.

impl<T, I> BitAnd<I> for PrefixTreeSet<T>

where T: AsRef<[u8]>, I: IntoIterator<Item = T>,

Produces the intersection of self and other.

type Output = PrefixTreeSet<T>

The resulting type after applying the & operator.

fn bitand(self, other: I) -> Self::Output

Performs the & operation.

impl<T, I> BitAndAssign<I> for PrefixTreeSet<T>

where T: AsRef<[u8]>, I: IntoIterator<Item = T>,

Produces the intersection of self and other.

fn bitand_assign(&mut self, other: I)

Performs the &= operation.

impl<T, I> BitOr<I> for PrefixTreeSet<T>

where T: AsRef<[u8]>, I: IntoIterator<Item = T>,

Produces the union of self and other.

type Output = PrefixTreeSet<T>

The resulting type after applying the | operator.

fn bitor(self, other: I) -> Self::Output

Performs the | operation.

impl<T, I> BitOrAssign<I> for PrefixTreeSet<T>

where T: AsRef<[u8]>, I: IntoIterator<Item = T>,

Produces the union of self and other.

fn bitor_assign(&mut self, other: I)

Performs the |= operation.

impl<T, I> BitXor<I> for PrefixTreeSet<T>

where T: AsRef<[u8]>, I: IntoIterator<Item = T>,

Produces the symmetric difference of self and other.

type Output = PrefixTreeSet<T>

The resulting type after applying the ^ operator.

fn bitxor(self, other: I) -> Self::Output

Performs the ^ operation.

impl<T, I> BitXorAssign<I> for PrefixTreeSet<T>

where T: AsRef<[u8]>, I: IntoIterator<Item = T>,

Produces the symmetric difference of self and other.

fn bitxor_assign(&mut self, other: I)

Performs the ^= operation.

impl<T: Clone> Clone for PrefixTreeSet<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PrefixTreeSet<T>

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

Formats the value using the given formatter.

impl<T> Default for PrefixTreeSet<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: AsRef<[u8]>> Extend<T> for PrefixTreeSet<T>

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<K, const N: usize> From<[K; N]> for PrefixTreeSet<K>

where K: AsRef<[u8]>,

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

Converts to this type from the input type.

impl<T: AsRef<[u8]>> FromIterator<T> for PrefixTreeSet<T>

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<T: Hash> Hash for PrefixTreeSet<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> IntoIterator for &'a PrefixTreeSet<T>

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

type Item = &'a T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for PrefixTreeSet<T>

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for PrefixTreeSet<T>

fn cmp(&self, other: &PrefixTreeSet<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<T: PartialEq> PartialEq for PrefixTreeSet<T>

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

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

impl<T> StructuralPartialEq for PrefixTreeSet<T>