Skip to main content

TraversalEvent

graphos_adapters::plugins::algorithms

Enum TraversalEvent

pub enum TraversalEvent {
    Discover(NodeId),
    TreeEdge {
        source: NodeId,
        target: NodeId,
        edge: EdgeId,
    },
    NonTreeEdge {
        source: NodeId,
        target: NodeId,
        edge: EdgeId,
    },
    BackEdge {
        source: NodeId,
        target: NodeId,
        edge: EdgeId,
    },
    Finish(NodeId),
}

Expand description

Events emitted during graph traversal (BFS/DFS).

These events follow the visitor pattern, allowing algorithms to react to different stages of the traversal.

Variants§

Discover(NodeId)

A node is discovered for the first time.

TreeEdge

A tree edge is traversed (edge to an undiscovered node).

Fields

§source: NodeId

The source node of the edge.

§target: NodeId

The target node of the edge.

§edge: EdgeId

The edge ID.

NonTreeEdge

A non-tree edge is traversed (edge to an already-discovered node). In BFS, this is a cross edge. In DFS, this could be a back edge or cross edge.

Fields

§source: NodeId

The source node of the edge.

§target: NodeId

The target node of the edge.

§edge: EdgeId

The edge ID.

BackEdge

A back edge is traversed (DFS only - edge to an ancestor).

Fields

§source: NodeId

The source node of the edge.

§target: NodeId

The target node of the edge.

§edge: EdgeId

The edge ID.

Finish(NodeId)

Processing of a node is complete.

Implementations§

impl TraversalEvent

pub fn source(&self) -> Option<NodeId>

Returns the source node of this event, if applicable.

pub fn target(&self) -> Option<NodeId>

Returns the target node of this event, if applicable.

Trait Implementations§

impl Clone for TraversalEvent

fn clone(&self) -> TraversalEvent

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for TraversalEvent

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

Formats the value using the given formatter. Read more

impl PartialEq for TraversalEvent

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

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

1.0.0 · 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.

impl Copy for TraversalEvent

impl Eq for TraversalEvent

impl StructuralPartialEq for TraversalEvent

Auto Trait Implementations§

impl Freeze for TraversalEvent

impl RefUnwindSafe for TraversalEvent

impl Send for TraversalEvent

impl Sync for TraversalEvent

impl Unpin for TraversalEvent

impl UnwindSafe for TraversalEvent

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more