Enum EffectResult 

#[non_exhaustive]
pub enum EffectResult {
    Llm(LlmResponse),
    Tool {
        output: Value,
        is_error: bool,
    },
    Graph(Value),
    Node(Value),
    Slept,
    Custom(Value),
    Failed {
        message: String,
    },
}

What came back from performing an effect.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Llm(LlmResponse)

A model’s reply to Effect::Llm.

Tool

A tool’s output, or its error text.

Fields

output: Value

What the tool produced — its error text when is_error is set.

is_error: bool

The tool ran and reported failure. Reported, not raised, so the step (or the model, told via a tool-result block) can adapt.

Graph(Value)

The output of the sub-graph run requested by Effect::Graph.

Node(Value)

What a node spawned by crate::step::Transition::Spawn produced.

Slept

The sleep elapsed — or was replayed from the journal, and nobody slept.

Custom(Value)

Whatever a host-supplied handler returned for Effect::Custom.

Failed

The effect could not be performed. Handed to the step rather than raised, so it can retry, fall back, or give up deliberately.

Fields

message: String

What went wrong, as text the step can quote or act on.

Implementations

impl EffectResult

pub fn is_error(&self) -> bool

Did this effect fail — either outright (Self::Failed) or as a tool that ran and reported an error?

pub fn value(&self) -> Option<&Value>

The value this result carries, if it carries one.

Trait Implementations

impl Clone for EffectResult

fn clone(&self) -> EffectResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EffectResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.