Struct safe_network::types::prefix_map::PrefixMap

pub struct PrefixMap<T>(_)
 where
    T: Borrow<Prefix>;

Container that acts as a map whose keys are prefixes.

It differs from a normal map of Prefix -> T in a couple of ways:

1. It allows to keep the prefix and the value in the same type which makes it internally more similar to a set of (Prefix, T) rather than map of Prefix -> T while still providing convenient map-like API
2. It automatically prunes redundant entries. That is, when the prefix of an entry is fully covered by other prefixes, that entry is removed. For example, when there is entry with prefix (00) and we insert entries with (000) and (001), the (00) prefix becomes fully covered and is automatically removed.
3. It provides some additional lookup API for convenience (get_equal_or_ancestor, get_matching, …)

Implementations

impl<T> PrefixMap<T> where
    T: Borrow<Prefix>, 

pub fn new() -> Self

Create empty PrefixMap.

pub fn insert(&mut self, entry: T) -> Option<T>

Inserts new entry into the map. Replaces previous entry at the same prefix. Removes those ancestors of the inserted prefix that are now fully covered by their descendants. Does not insert anything if any descendant of the prefix of entry is already present in the map. Returns the previous entry with the same prefix, if any.

pub fn get(&self, prefix: &Prefix) -> Option<&T>

Get the entry at prefix, if any.

pub fn get_matching(&self, name: &XorName) -> Option<&T>

Get the entry at the prefix that matches name. In case of multiple matches, returns the one with the longest prefix.

pub fn iter(&self) -> impl Iterator<Item = &T> + Clone

Returns an iterator over the entries, in order by prefixes.

pub fn descendants<'a>(
    &'a self,
    prefix: &'a Prefix
) -> impl Iterator<Item = &'a T> + Clone + 'a

Returns an iterator over all entries whose prefixes are descendants (extensions) of prefix.

Trait Implementations

impl<T: Clone> Clone for PrefixMap<T> where
    T: Borrow<Prefix>, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PrefixMap<T> where
    T: Borrow<Prefix>, 

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

Formats the value using the given formatter.

impl<T> Default for PrefixMap<T> where
    T: Borrow<Prefix>, 

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for PrefixMap<T> where
    T: Borrow<Prefix>,
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> From<PrefixMap<T>> for BTreeSet<T> where
    T: Borrow<Prefix> + Ord, 

fn from(map: PrefixMap<T>) -> Self

Performs the conversion.

impl<T> IntoIterator for PrefixMap<T> where
    T: Borrow<Prefix>, 

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> PartialEq<PrefixMap<T>> for PrefixMap<T> where
    T: Borrow<Prefix> + PartialEq, 

fn eq(&self, other: &Self) -> 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 !=.

impl<T> Serialize for PrefixMap<T> where
    T: Borrow<Prefix>,
    T: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T> Eq for PrefixMap<T> where
    T: Borrow<Prefix> + Eq,