Skip to main content

Condition

Enum Condition 

Source
pub enum Condition<S> {
    Always,
    Never,
    OnSkip,
    OnError,
    Named(NamedConditionId),
    And(Vec<Condition<S>>),
    Or(Vec<Condition<S>>),
    Not(Box<Condition<S>>),
    Custom {
        label: String,
        f: ConditionFn<S>,
    },
}
Expand description

A declarative predicate deciding whether an edge fires.

The engine evaluates a completed node’s outgoing edges in declaration order; every edge whose condition matches fires (emits an activation token). Write mutually exclusive conditions for branch selection — e.g. an is_done / not_done named pair — and prefer an Condition::Always fallback so a node can never strand into a dead-end.

The S parameter appears only in the Condition::Custom escape hatch; the serializable subset is entirely S-free (see crate::def::ConditionDef).

Variants§

§

Always

Always fires when the source completes successfully (the dataflow-profile default).

§

Never

Never fires. Useful to park an edge in a saved graph without deleting it.

§

OnSkip

Fires when the source execution carried a BspSkip marker (dataflow profile).

§

OnError

Fires when the source node failed and its recovery policy is crate::recovery::RecoveryPolicy::RouteToErrorEdge. Error paths become visible, GUI-renderable topology instead of implicit aborts.

§

Named(NamedConditionId)

Consumer-registered named predicate over &S + value store.

§

And(Vec<Condition<S>>)

Ordered short-circuit conjunction over conditions.

§

Or(Vec<Condition<S>>)

Ordered short-circuit disjunction over conditions.

§

Not(Box<Condition<S>>)

Negation of a condition.

§

Custom

Escape hatch for the long tail. Never serializes its closure: the definition layer keeps only label, and instantiation fails closed unless a condition with that label is re-registered. The GUI renders it as an opaque gray box. Use sparingly.

Fields

§label: String

Human-readable label shown in the GUI and used as the re-registration key.

§f: ConditionFn<S>

The predicate over consumer state and value store.

Implementations§

Source§

impl<S> Condition<S>

Source

pub fn eval(&self, ctx: &ConditionEval<'_, S>) -> bool

Evaluates the condition in the given context.

A missing Condition::Named registration evaluates to false; graph validation (crate::engine::BspEngine::validate_with_report / BspGraph::from_def) reports unknown names loudly before a run ever starts.

Source

pub fn label(&self) -> String

A short human-readable label for interceptor events and GUI badges.

Source

pub fn collect_named(&self, out: &mut Vec<String>)

Collects every named-condition reference in this condition tree.

Used by validation to check registry completeness.

Source

pub fn collect_custom_labels(&self, out: &mut Vec<String>)

Collects the labels of every Condition::Custom leaf in this condition tree.

Custom closures do not serialize; definitions carrying them fail closed at instantiation unless the label is registered as a named condition.

Trait Implementations§

Source§

impl<S> Clone for Condition<S>

Source§

fn clone(&self) -> Self

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<S> Debug for Condition<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for Condition<S>

§

impl<S> !UnwindSafe for Condition<S>

§

impl<S> Freeze for Condition<S>
where Vec<Condition<S>>: Freeze, Box<Condition<S>>: Freeze, Arc<dyn Fn(&S, &ValueStore) -> bool + Send + Sync>: Freeze,

§

impl<S> Send for Condition<S>
where Vec<Condition<S>>: Send, Box<Condition<S>>: Send, Arc<dyn Fn(&S, &ValueStore) -> bool + Send + Sync>: Send,

§

impl<S> Sync for Condition<S>
where Vec<Condition<S>>: Sync, Box<Condition<S>>: Sync, Arc<dyn Fn(&S, &ValueStore) -> bool + Send + Sync>: Sync,

§

impl<S> Unpin for Condition<S>
where Vec<Condition<S>>: Unpin, Box<Condition<S>>: Unpin, Arc<dyn Fn(&S, &ValueStore) -> bool + Send + Sync>: Unpin,

§

impl<S> UnsafeUnpin for Condition<S>

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> CloneDebuggableStorage for T

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> CloneableStorage for T
where T: Any + Send + Sync + Clone,

Source§

impl<T> DebuggableStorage for T
where T: Any + Send + Sync + Debug,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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