Struct AttrMap 

pub struct AttrMap { /* private fields */ }

An attribute map that keeps its keys in INSERTION order, as the Python dict it stands for does (br-r37-c1-6hyf1).

It was a BTreeMap, which lists keys sorted. networkx hands out dicts in the order their keys were set, so every attribute dict with two or more keys that were not already sorted needed a Python mirror dict beside the store just to remember that order - an extra dict, a write-watch adoption and a (String, String) map entry per edge, about 30% of a multi-key add_edges_from. With the order kept here, a dict rebuilt from the store is the caller’s dict, and only a value the store cannot hold (a tuple, a nested dict, an object) still needs a mirror.

The entries live in one Vec, in insertion order: an attribute map almost always holds a handful of keys, which a scan finds faster than a hash, and one allocation per map is what the batch and copy kernels pay per edge (an IndexMap made two and grew CgseValue from 32 to 64 bytes, and single-key add_edges_from measured ~10% slower on it). Past INDEXED_LEN keys a hash index is kept beside the entries, so a map with thousands of keys - an adversarial graph - still finds one in O(1) rather than O(keys).

Removal keeps the other keys in order (a dict’s del). Equality ignores order, as a dict’s does.

Implementations

impl AttrMap

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get(&self, key: &str) -> Option<&CgseValue>

pub fn get_key_value(&self, key: &str) -> Option<(&String, &CgseValue)>

pub fn get_mut(&mut self, key: &str) -> Option<&mut CgseValue>

pub fn contains_key(&self, key: &str) -> bool

pub fn insert(&mut self, key: String, value: CgseValue) -> Option<CgseValue>

Set key: an existing key keeps its place, a new one goes last (a dict’s d[k] = v). Returns the value it replaced.

pub fn remove(&mut self, key: &str) -> Option<CgseValue>

Remove key, keeping every other key where it was (a dict’s del).

pub fn clear(&mut self)

pub fn retain(&mut self, keep: impl FnMut(&String, &mut CgseValue) -> bool)

pub fn iter(&self) -> AttrMapIter<'_>

pub fn iter_mut(&mut self) -> AttrMapIterMut<'_>

pub fn keys( &self, ) -> impl DoubleEndedIterator<Item = &String> + ExactSizeIterator + Clone

pub fn values( &self, ) -> impl DoubleEndedIterator<Item = &CgseValue> + ExactSizeIterator + Clone

pub fn values_mut( &mut self, ) -> impl DoubleEndedIterator<Item = &mut CgseValue> + ExactSizeIterator

pub fn into_values( self, ) -> impl DoubleEndedIterator<Item = CgseValue> + ExactSizeIterator

Trait Implementations

impl Clone for AttrMap

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttrMap

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

Formats the value using the given formatter.

impl Default for AttrMap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AttrMap

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

Deserialize this value from the given Serde deserializer.

impl Eq for AttrMap

impl Extend<(String, CgseValue)> for AttrMap

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬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<const N: usize> From<[(String, CgseValue); N]> for AttrMap

fn from(entries: [(String, CgseValue); N]) -> Self

Converts to this type from the input type.

impl FromIterator<(String, CgseValue)> for AttrMap

fn from_iter<I: IntoIterator<Item = (String, CgseValue)>>(iter: I) -> Self

Creates a value from an iterator.

impl Index<&str> for AttrMap

fn index(&self, key: &str) -> &CgseValue

The value for key; panics when there is none, as a map’s index does.

type Output = CgseValue

The returned type after indexing.

impl IntoIterator for AttrMap

type Item = (String, CgseValue)

The type of the elements being iterated over.

type IntoIter = IntoIter<(String, CgseValue)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a AttrMap

type Item = (&'a String, &'a CgseValue)

The type of the elements being iterated over.

type IntoIter = AttrMapIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut AttrMap

type Item = (&'a String, &'a mut CgseValue)

The type of the elements being iterated over.

type IntoIter = AttrMapIterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for AttrMap

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AttrMap

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

Serialize this value into the given Serde serializer.