FlowBuilder

Struct FlowBuilder 

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

Builder for a Flow using the cemented verbs.

Implementations§

Source§

impl FlowBuilder

Source

pub fn step(self, id: impl Into<String>) -> Self

Declare a new step.

Source

pub fn after(self, dep: impl Into<String>) -> Self

Add a dependency (call multiple times for multiple deps).

Source

pub fn after_when(self, dep: impl Into<String>, when: Guard) -> Self

Add a conditional dependency: satisfied only while when holds. Conditional edges out of one source are how a flow branches; pair with join_any on the merge step.

Source

pub fn join_any(self) -> Self

Any one satisfied edge makes this step eligible (the merge node after a branch). Default is all — a synchronizing join.

Source

pub fn gate(self, g: Guard) -> Self

Extra eligibility guard beyond dependencies.

Source

pub fn done(self, g: Guard) -> Self

Completion condition.

Source

pub fn posture(self, text: impl Into<String>) -> Self

Instruction imposed while active.

Source

pub fn ground(self, template: impl Into<String>) -> Self

A grounding template projected while active — a curated, State- interpolated fact line that pins the model to known values. {key} interpolates a value; {key?yes:no} picks by truthiness. See render_ground.

Source

pub fn allow<I, S>(self, tools: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Tools available while active (whitelist).

Source

pub fn deny<I, S>(self, tools: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Tools forbidden while active.

Source

pub fn terminal(self) -> Self

Mark the current step terminal.

Source

pub fn once(self, tool: impl Into<String>) -> Self

A tool may run at most once.

Source

pub fn before(self, a: impl Into<String>, b: impl Into<String>) -> Self

Ordering invariant: a before b.

Source

pub fn require<I, S>(self, steps: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Required terminal steps for completion.

Source

pub fn ambient<I, S>(self, tools: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Exempt cross-cutting tools from every step’s allow whitelist.

Flow-level, and order-independent with respect to .step(..). Use it for tools that serve the conversation rather than any one step of it — memory recall, escalation, logging. A tool named here still obeys deny, once and never(..).until(..); see Flow::ambient.

let flow = Flow::new()
    .ambient(["recall_context"])
    .step("book")
    .allow(["book_table"])
    .done(Guard::called_ok("book_table"))
    .build()
    .unwrap();
assert_eq!(flow.ambient, ["recall_context"]);
Source

pub fn reset<I, S>(self, steps: I) -> ResetBuilder
where I: IntoIterator<Item = S>, S: Into<String>,

Un-latch steps whenever the guard given to when becomes true — the loop primitive. See Constraint::Reset for the exact forgiveness semantics.

Source

pub fn never(self, tool: impl Into<String>) -> NeverBuilder

Forbid a tool until a guard holds (never(tool).until(guard)).

Source

pub fn commit(self, tool: impl Into<String>, until: Guard) -> Self

Commit-tool sugar: at most once, gated until until, and flagged for confirmation. Composes once + never…until + the confirmation seam.

Source

pub fn build(self) -> Result<Flow, ConfigError>

Finalize and validate the flow.

Trait Implementations§

Source§

impl Default for FlowBuilder

Source§

fn default() -> FlowBuilder

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

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,