Enum ToolOutput 

#[non_exhaustive]
pub enum ToolOutput {
    Preliminary(JsonValue),
    Final(JsonValue),
}

One output of a tool execution.

Streaming tools emit any number of ToolOutput::Preliminary values followed by exactly one ToolOutput::Final; single-value tools emit only the final value.

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.

Preliminary(JsonValue)

An intermediate result (preliminary: true in the reference model).

Final(JsonValue)

The final result.

Implementations

impl ToolOutput

pub fn is_final(&self) -> bool

Returns true for the final output.

pub fn value(&self) -> &JsonValue

The JSON value.

pub fn into_value(self) -> JsonValue

Consumes the output, returning the JSON value.

Trait Implementations

impl Clone for ToolOutput

fn clone(&self) -> ToolOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolOutput

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

Formats the value using the given formatter.

impl Eq for ToolOutput

impl PartialEq for ToolOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolOutput