Enum ToolCallState 

pub enum ToolCallState {
    PendingApproval,
    Running,
    Succeeded {
        output: ToolOutput,
    },
    Failed {
        error: SharedString,
    },
    Refused {
        reason: SharedString,
    },
}

Where one invocation has got to.

The five are a closed set rather than flags, so a card cannot be running and failed at once, and cannot be refused without a reason: the host that declined has to say what it declined.

Variants

PendingApproval

Nothing has run. Somebody has to allow it first.

Running

Succeeded

Fields

output: ToolOutput

Failed

The tool ran and did not succeed, in the host’s own words.

Fields

error: SharedString

Refused

The host declined to run it, in the host’s own words. Nothing ran, so there is no result and no error — only a decision.

Fields

reason: SharedString

Implementations

impl ToolCallState

pub fn succeeded(output: impl Into<ToolBody>) -> Self

pub fn succeeded_silently() -> Self

A call that ran, succeeded, and returned nothing.

pub fn failed(error: impl Into<SharedString>) -> Self

pub fn refused(reason: impl Into<SharedString>) -> Self

pub fn as_str(&self) -> &'static str

The name the semantic node publishes, so a test asserts the state the card reported rather than the colour it painted.

pub fn reason(&self) -> Option<&SharedString>

Why this call did not produce a result, when that is a thing the host said. A failure’s error and a refusal’s reason are different sentences and are never rendered in the same place.

Trait Implementations

impl Clone for ToolCallState

fn clone(&self) -> ToolCallState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCallState

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

Formats the value using the given formatter.

impl Eq for ToolCallState

impl PartialEq for ToolCallState

fn eq(&self, other: &ToolCallState) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ToolCallState