Enum aery::for_each::TCF

pub enum TCF {
    Continue,
    Close,
    Probe,
    Exit,
}

Control flow enum for Traverse operations.

Illustrations

Pink == traversed.

Close

fn sys(query: Query<(&E, Relations<R>)>, roots: Query<Entity, Root<R>>) {
   query.traverse::<R>(roots.iter()).for_each(|E(e), _| {
       if *e == 2 { return TCF::Close }

       // do stuff

       TCF::Continue
   })
}

flowchart BT classDef pink fill:#f66 E1:::pink --R--> E0:::pink E2:::pink --R--> E0:::pink E3:::pink --R--> E0:::pink E4:::pink --R--> E1:::pink E5:::pink --R--> E1:::pink E6 --R--> E2:::pink E7 --R--> E2:::pink E8:::pink --R--> E3 E9:::pink --R--> E3

Probe

fn sys(query: Query<(&E, Relations<R>)>, roots: Query<Entity, Root<R>>) {
   query.traverse::<R>(roots.iter()).for_each(|E(e), _| {
       if *e == 2 { return TCF::Probe }

       // do stuff

       TCF::Continue
   })
}

flowchart BT classDef pink fill:#f66 E1:::pink --R--> E0:::pink E2:::pink --R--> E0:::pink E3 --R--> E0:::pink E4 --R--> E1:::pink E5 --R--> E1:::pink E6:::pink --R--> E2:::pink E7:::pink --R--> E2:::pink E8 --R--> E3 E9 --R--> E3

Variants

Continue

Continue going through the graph.

Close

Close the current node off from expansion. Traversal will not go deeper into the graph through this node.

Probe

Immediately expand the current node’s edges & close all other open paths for further expansion.

Exit

Terminate the loop.

Trait Implementations

impl From<()> for TCF

fn from(_: ()) -> Self

Converts to this type from the input type.