Skip to main content

OverlayState

Struct OverlayState 

Source
pub struct OverlayState { /* private fields */ }
Expand description

Mutable overlay state for sync replay and query freshness.

All collections are private so the by_source/by_target adjacency indexes cannot desync from added_edges: callers mutate exclusively through push_edge, remove_edge, tombstone_edge, tombstone_node, clear, and the from_edges constructor, each of which keeps the indexes consistent.

Implementations§

Source§

impl OverlayState

Source

pub fn from_edges(edges: impl IntoIterator<Item = OverlayEdge>) -> Self

Builds an overlay from a sequence of inserted edges, with the adjacency indexes constructed once up front.

§Performance

This function is O(a log a) for a edges.

Source

pub fn added_edges(&self) -> &[OverlayEdge]

Returns the inserted overlay edges in insertion order.

§Performance

This method is O(1).

Source

pub const fn overlay_edge_count(&self) -> usize

Returns the number of inserted overlay edges.

§Performance

This method is O(1).

Source

pub fn tombstoned_edge_count(&self) -> usize

Returns the number of tombstoned base edges.

§Performance

This method is O(1).

Source

pub fn tombstoned_node_count(&self) -> usize

Returns the number of tombstoned nodes.

§Performance

This method is O(1).

Source

pub fn tombstone_edge(&mut self, edge_id: u32)

Records a base edge tombstone.

§Performance

This method is O(log t) for t tombstoned edge ids.

Source

pub fn tombstone_node(&mut self, node_id: u32)

Records a node tombstone.

§Performance

This method is O(log t) for t tombstoned node ids.

Source

pub fn clear(&mut self)

Clears all overlay buffers and adjacency indexes.

Source

pub fn has_edge_tombstones(&self) -> bool

Returns whether any base edge tombstones are recorded.

Source

pub fn has_node_tombstones(&self) -> bool

Returns whether any node tombstones are recorded.

Source

pub fn edge_visible(&self, edge_id: u32) -> bool

Returns whether an edge id is visible to traversal.

§Performance

This method is O(log t) for t tombstoned edge ids.

Source

pub fn node_visible(&self, node_id: u32) -> bool

Returns whether a node id is visible to traversal.

§Performance

This method is O(log t) for t tombstoned node ids.

Source

pub fn push_edge(&mut self, edge: OverlayEdge)

Records an overlay edge and updates adjacency indexes.

§Performance

This method is O(log s + log t) for index map sizes s and t.

Source

pub fn overlay_targets(&self, source: u32) -> &[u32]

Returns overlay outgoing targets for source (empty when none).

§Performance

This method is O(log s) for s indexed sources.

Source

pub fn overlay_sources(&self, target: u32) -> &[u32]

Returns overlay incoming sources for target (empty when none).

§Performance

This method is O(log t) for t indexed targets.

Source

pub fn remove_edge(&mut self, source: u32, target: u32)

Removes one overlay edge and rebuilds adjacency indexes.

§Performance

This method is O(a) for a overlay edges.

Trait Implementations§

Source§

impl Clone for OverlayState

Source§

fn clone(&self) -> OverlayState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OverlayState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OverlayState

Source§

fn default() -> OverlayState

Returns the “default value” for a type. Read more
Source§

impl Eq for OverlayState

Source§

impl PartialEq for OverlayState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for OverlayState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.