Struct Edge

pub struct Edge<'id, N, ET, const TAG_BITS: u32>(/* private fields */);

Implementations

impl<'id, N: NodeBase, ET: Tag, const TAG_BITS: u32> Edge<'id, N, ET, TAG_BITS>

pub fn as_ptr(&self) -> NonNull<()>

pub unsafe fn from_ptr(ptr: NonNull<()>) -> Self

Create an edge from a raw pointer

This method does neither modify the pointer nor change reference counters in any way. The user is responsible for pointer tagging etc. Hence, using this method is dangerous. Still, it is required by TerminalManager implementations.

Safety

ptr must be tagged accordingly.

If the pointer is tagged as referring to an inner node, then it must actually point to an inner node stored in the manager associated with the 'id brand. Furthermore, the caller must have ownership of one reference (in terms of the reference count).

If the pointer is tagged as referring to a terminal node, then the the pointer must be valid as defined by the TerminalManager implementation of the manager associated with the 'id brand.

pub fn addr(&self) -> usize

Get the address portion of the underlying pointer

pub fn is_inner(&self) -> bool

Returns true if this edge points to an inner node

Trait Implementations

impl<N, ET, const TAG_BITS: u32> Drop for Edge<'_, N, ET, TAG_BITS>

fn drop(&mut self)

Executes the destructor for this type.

impl<'id, ET: Tag, const TAG_BITS: u32, const ARITY: usize> DropWith<Edge<'id, NodeWithLevel<'id, ET, TAG_BITS, ARITY>, ET, TAG_BITS>> for NodeWithLevel<'id, ET, TAG_BITS, ARITY>

fn drop_with(self, drop_edge: impl Fn(Edge<'id, Self, ET, TAG_BITS>))

Drop self

fn drop_with_manager<M>(self, manager: &M)

where M: Manager<Edge = E>,

Drop self

impl<N: NodeBase, ET: Tag, const TAG_BITS: u32> Edge for Edge<'_, N, ET, TAG_BITS>

type Tag = ET

Edge tag

fn borrowed(&self) -> Borrowed<'_, Self>

Turn a reference into a borrowed handle

fn with_tag(&self, tag: Self::Tag) -> Borrowed<'_, Self>

Get a version of this Edge with the given tag

fn with_tag_owned(self, tag: Self::Tag) -> Self

Get a version of this Edge with the given tag

fn tag(&self) -> Self::Tag

Get the Tag of this Edge

fn node_id(&self) -> NodeID

Returns some unique identifier for the node, e.g. for I/O purposes

impl<N, ET, const TAG_BITS: u32> Hash for Edge<'_, N, ET, TAG_BITS>

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<'id, ET: Tag, const TAG_BITS: u32, const ARITY: usize> InnerNode<Edge<'id, NodeWithLevel<'id, ET, TAG_BITS, ARITY>, ET, TAG_BITS>> for NodeWithLevel<'id, ET, TAG_BITS, ARITY>

const ARITY: usize = 2usize

The node’s arity (upper bound)

type ChildrenIter<'a> = BorrowedEdgeIter<'a, Edge<'id, NodeWithLevel<'id, ET, TAG_BITS, ARITY>, ET, TAG_BITS>, Iter<'a, Edge<'id, NodeWithLevel<'id, ET, TAG_BITS, ARITY>, ET, TAG_BITS>>> where Self: 'a

Iterator over children of an inner node

fn new( level: LevelNo, children: impl IntoIterator<Item = Edge<'id, Self, ET, TAG_BITS>>, ) -> Self

Create a new node

fn check_level(&self, check: impl FnOnce(LevelNo) -> bool) -> bool

Returns the result of check applied to the node’s level in case this node type stores levels, otherwise returns true.

fn assert_level_matches(&self, level: LevelNo)

Panics if the node types stores a level and the node’s level is not level

fn children(&self) -> Self::ChildrenIter<'_>

Get the children of this node as an iterator

fn child(&self, n: usize) -> Borrowed<'_, Edge<'id, Self, ET, TAG_BITS>>

Get the n-th child of this node

unsafe fn set_child( &self, n: usize, child: Edge<'id, Self, ET, TAG_BITS>, ) -> Edge<'id, Self, ET, TAG_BITS>

Set the n-th child of this node

fn ref_count(&self) -> usize

Get the node’s reference count

impl<'a, 'id, N, ET, TM, R, MD, const PAGE_SIZE: usize, const TAG_BITS: u32> LevelView<Edge<'id, N, ET, TAG_BITS>, N> for LevelView<'a, 'id, N, ET, TM, R, MD, PAGE_SIZE, TAG_BITS>

where N: NodeBase + InnerNode<Edge<'id, N, ET, TAG_BITS>>, ET: Tag, TM: TerminalManager<'id, N, ET, MD, PAGE_SIZE, TAG_BITS>, R: DiagramRules<Edge<'id, N, ET, TAG_BITS>, N, TM::TerminalNode>, MD: DropWith<Edge<'id, N, ET, TAG_BITS>> + GCContainer<Manager<'id, N, ET, TM, R, MD, PAGE_SIZE, TAG_BITS>>,

type Iterator<'b> = LevelViewIter<'b, 'id, N, ET, TAG_BITS> where Self: 'b

Iterator over Edges pointing to nodes at this level

type Taken = TakenLevelView<'a, 'id, N, ET, TM, R, MD, PAGE_SIZE, TAG_BITS>

Taken level view, see LevelView::take()

fn len(&self) -> usize

Get the number of nodes on this level

fn level_no(&self) -> LevelNo

Get the level number of this level

fn reserve(&mut self, additional: usize)

Reserve space for additional nodes on this level

fn get(&self, node: &N) -> Option<&Edge<'id, N, ET, TAG_BITS>>

Get the edge corresponding to the given node (if present)

fn insert(&mut self, edge: Edge<'id, N, ET, TAG_BITS>) -> bool

Insert the given edge into the unique table at this level, assuming that the referenced node is already stored in the associated manager.

fn get_or_insert(&mut self, node: N) -> AllocResult<Edge<'id, N, ET, TAG_BITS>>

Get the edge corresponding to level and node if present, or insert it.

unsafe fn gc(&mut self)

Perform garbage collection on this level

unsafe fn remove(&mut self, node: &N) -> bool

Remove node from (this level of) the manager

unsafe fn swap(&mut self, other: &mut Self)

Move all nodes from this level to the other level and vice versa.

fn iter(&self) -> Self::Iterator<'_>

Iterate over all the edges at this level

fn take(&mut self) -> Self::Taken

Clear this level, returning a level view containing all the previous edges.

fn is_empty(&self) -> bool

Returns true iff this level contains nodes

impl<'id, N, ET, TM, R, MD, const PAGE_SIZE: usize, const TAG_BITS: u32> LevelView<Edge<'id, N, ET, TAG_BITS>, N> for TakenLevelView<'_, 'id, N, ET, TM, R, MD, PAGE_SIZE, TAG_BITS>

where N: NodeBase + InnerNode<Edge<'id, N, ET, TAG_BITS>>, ET: Tag, TM: TerminalManager<'id, N, ET, MD, PAGE_SIZE, TAG_BITS>, R: DiagramRules<Edge<'id, N, ET, TAG_BITS>, N, TM::TerminalNode>, MD: DropWith<Edge<'id, N, ET, TAG_BITS>> + GCContainer<Manager<'id, N, ET, TM, R, MD, PAGE_SIZE, TAG_BITS>>,

type Iterator<'b> = LevelViewIter<'b, 'id, N, ET, TAG_BITS> where Self: 'b

Iterator over Edges pointing to nodes at this level

type Taken = TakenLevelView<'_, 'id, N, ET, TM, R, MD, PAGE_SIZE, TAG_BITS>

Taken level view, see LevelView::take()

fn len(&self) -> usize

Get the number of nodes on this level

fn level_no(&self) -> LevelNo

Get the level number of this level

fn reserve(&mut self, additional: usize)

Reserve space for additional nodes on this level

fn get(&self, node: &N) -> Option<&Edge<'id, N, ET, TAG_BITS>>

Get the edge corresponding to the given node (if present)

fn insert(&mut self, edge: Edge<'id, N, ET, TAG_BITS>) -> bool

Insert the given edge into the unique table at this level, assuming that the referenced node is already stored in the associated manager.

fn get_or_insert(&mut self, node: N) -> AllocResult<Edge<'id, N, ET, TAG_BITS>>

Get the edge corresponding to level and node if present, or insert it.

unsafe fn remove(&mut self, node: &N) -> bool

Remove node from (this level of) the manager

unsafe fn gc(&mut self)

Perform garbage collection on this level

unsafe fn swap(&mut self, other: &mut Self)

Move all nodes from this level to the other level and vice versa.

fn iter(&self) -> Self::Iterator<'_>

Iterate over all the edges at this level

fn take(&mut self) -> Self::Taken

Clear this level, returning a level view containing all the previous edges.

fn is_empty(&self) -> bool

Returns true iff this level contains nodes

impl<'id, InnerNode, ET, const PAGE_SIZE: usize, const TAG_BITS: u32> NodeSet<Edge<'id, InnerNode, ET, TAG_BITS>> for NodeSet<PAGE_SIZE, TAG_BITS>

fn len(&self) -> usize

Get the number of nodes in the set

fn insert(&mut self, edge: &Edge<'id, InnerNode, ET, TAG_BITS>) -> bool

Add a node (the node to which edge points) to the set

fn contains(&self, edge: &Edge<'id, InnerNode, ET, TAG_BITS>) -> bool

Return true if the set contains the given node

fn remove(&mut self, edge: &Edge<'id, InnerNode, ET, TAG_BITS>) -> bool

Remove a node from the set

fn is_empty(&self) -> bool

Returns true iff there are no nodes in the set

impl<N, ET, const TAG_BITS: u32> Ord for Edge<'_, N, ET, TAG_BITS>

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl<N, ET, const TAG_BITS: u32> PartialEq for Edge<'_, N, ET, TAG_BITS>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N, ET, const TAG_BITS: u32> PartialOrd for Edge<'_, N, ET, TAG_BITS>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<N, ET, const TAG_BITS: u32> Eq for Edge<'_, N, ET, TAG_BITS>

impl<N: Send + Sync, ET: Send + Sync, const TAG_BITS: u32> Send for Edge<'_, N, ET, TAG_BITS>

impl<N: Send + Sync, ET: Send + Sync, const TAG_BITS: u32> Sync for Edge<'_, N, ET, TAG_BITS>