Struct SideTable 

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

Facts attached to nodes by NodeId, stored beside the tree.

See the module docs for the residency decision and the densification trigger.

Implementations

impl<T> SideTable<T>

pub fn new() -> Self

An empty table.

pub fn with_capacity(capacity: usize) -> Self

An empty table sized for capacity facts.

pub fn insert(&mut self, id: NodeId, value: T) -> Option<T>

Attach value to id, returning the fact it replaced.

pub fn get(&self, id: NodeId) -> Option<&T>

The fact attached to id, if any.

pub fn get_mut(&mut self, id: NodeId) -> Option<&mut T>

The fact attached to id, mutably.

pub fn remove(&mut self, id: NodeId) -> Option<T>

Detach and return the fact attached to id.

pub fn contains_id(&self, id: NodeId) -> bool

Whether id carries a fact.

Named for its key the way HashMap::contains_key is, rather than a bare contains: a keyed table’s membership question is about the id, not the value, and the bare name reads as a value search.

pub fn len(&self) -> usize

How many nodes carry a fact.

pub fn is_empty(&self) -> bool

Whether no node carries a fact.

pub fn clear(&mut self)

Drop every fact, keeping the allocation.

pub fn iter(&self) -> impl Iterator<Item = (NodeId, &T)>

Iterate the facts in unspecified order.

Correct for folds and counts. Never use it to print a folio page or to build any other byte-stable artifact — see SideTable::sorted_entries.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (NodeId, &mut T)>

Iterate the facts mutably, in unspecified order.

pub fn sorted_entries(&self) -> Vec<(NodeId, &T)>

The facts in ascending NodeId order.

This is the folio-printing path (folio-format.md: sorted map iteration). It allocates a Vec of references, which is why it is a separate, differently-named method rather than the Iterator impl: the cost is visible at the call site.

Trait Implementations

impl<T: Clone> Clone for SideTable<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SideTable<T>

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

Formats the value using the given formatter.

impl<T> Default for SideTable<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq> Eq for SideTable<T>

impl<T> FromIterator<(NodeId, T)> for SideTable<T>

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

Creates a value from an iterator.

impl<T: PartialEq> PartialEq for SideTable<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for SideTable<T>