Guard

Enum Guard 

Source
pub enum Guard {
    Spec(Pred),
    Custom(Arc<dyn Fn(&FlowCtx<'_>) -> bool + Send + Sync>),
}
Expand description

A boolean predicate over (state, marking) — the only predicate type.

Use the constructors (Guard::is_true, Guard::captured, Guard::called_ok, …) for the serializable closed atoms, or Guard::custom for a bespoke closure (not serializable).

Variants§

§

Spec(Pred)

A serializable predicate built from the closed atom set.

§

Custom(Arc<dyn Fn(&FlowCtx<'_>) -> bool + Send + Sync>)

A code-only escape hatch. Not serializable.

Implementations§

Source§

impl Guard

Source

pub fn always() -> Self

Always true.

Source

pub fn is_true(key: impl Into<String>) -> Self

State key holds boolean true.

Source

pub fn is_set(key: impl Into<String>) -> Self

State key is present.

Source

pub fn eq(key: impl Into<String>, value: impl Into<Value>) -> Self

State key equals the given JSON value.

Source

pub fn captured<I, S>(fields: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

All of the given state keys are present (extracted slots).

Source

pub fn called_ok(tool: impl Into<String>) -> Self

The named tool has completed successfully.

Source

pub fn done(step: impl Into<String>) -> Self

The named step is done.

Source

pub fn resolved(name: impl AsRef<str>) -> Self

True once an orchestrated agent named name has produced a result (its {name}:result state key is set). Pairs with the orchestration call/dispatch/background.

Source

pub fn all(guards: impl IntoIterator<Item = Guard>) -> Self

Conjunction.

If every input is a serializable atom, the result is a serializable Pred::All. If any input is a Guard::custom, the result is itself a custom guard that evaluates the conjunction at runtime — the custom guard is never silently dropped (it merely makes the combinator non-serializable, which surfaces as an error only if you try to serialize the flow).

Source

pub fn any(guards: impl IntoIterator<Item = Guard>) -> Self

Disjunction.

Mirrors Guard::all: custom inputs are preserved as a runtime closure rather than erased.

Source

pub fn not(guard: Guard) -> Self

Negation of a serializable atom.

Source

pub fn describe(&self) -> String

This guard as a short prose clause, for telling a model what a refusal is waiting on.

A refusal that names only the tool leaves the model to guess the precondition, and a wrong guess is indistinguishable from a wrong model: in the governed collections evaluation, record_promise_to_pay was refused with “not available in the current step”, and the model — with nothing else to go on — decided it must need to re-verify the caller and asked for the card digits it had already checked.

Source

pub fn custom(f: impl Fn(&FlowCtx<'_>) -> bool + Send + Sync + 'static) -> Self

A bespoke closure over (state, marking). Not serializable.

Source

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

Evaluate the guard.

Source

pub fn eval_state(&self, state: &State) -> bool

Evaluate against state alone, with an empty Marking.

For contexts outside a governed flow (phase transitions, watcher conditions) where no marking exists: called_ok/done atoms evaluate false there — a validator should reject them in such positions.

Source

pub fn explain_trace(&self, ctx: &FlowCtx<'_>) -> GuardTrace

Evaluate to a GuardTrace — the predicate tree with per-node truth values. A Guard::custom yields a single opaque node.

Trait Implementations§

Source§

impl Clone for Guard

Source§

fn clone(&self) -> Guard

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

impl Debug for Guard

Source§

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

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

impl<'de> Deserialize<'de> for Guard

Source§

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for Guard

Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

impl Serialize for Guard

Source§

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Guard

§

impl !RefUnwindSafe for Guard

§

impl Send for Guard

§

impl Sync for Guard

§

impl Unpin for Guard

§

impl !UnwindSafe for Guard

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

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

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,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

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