Struct Outcome 

#[non_exhaustive]
pub struct Outcome {
    pub agent: Agent,
    pub session: Option<String>,
    pub text: String,
    pub usage: Usage,
    pub stop: Stop,
    pub rate_limit: Option<RateLimit>,
    pub exit_code: i32,
    pub stderr: String,
    pub unparsed: usize,
    pub first_unparsed: Option<String>,
    pub structured: Option<Value>,
}

The result of one completed run.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

agent: Agent

Which agent produced it.

session: Option<String>

The native session id, when the run had or produced one. This is the handle a later turn resumes with.

text: String

The assistant’s final text.

usage: Usage

Token and cost accounting.

stop: Stop

Why it stopped.

rate_limit: Option<RateLimit>

The last quota signal seen, if any.

exit_code: i32

The process exit code.

stderr: String

Raw stderr, kept for diagnostics and capped at crate::MAX_CAPTURE.

unparsed: usize

How many output lines could not be parsed, with the first as a sample.

Agents interleave banners with their JSON, so a non-zero count is not automatically a fault. It becomes one when paired with an empty Self::text, which is what a vendor changing its output shape looks like from here. See Outcome::looks_like_a_format_change.

first_unparsed: Option<String>

The first line that failed to parse.

structured: Option<Value>

The answer parsed against the schema given to crate::Request::schema.

None when no schema was asked for, or when the agent’s answer did not parse as JSON. Never a re-interpretation of prose: this is only set from a value the agent produced under a schema.

Implementations

impl Outcome

pub fn is_ok(&self) -> bool

Whether the run finished cleanly: a zero exit and no error result.

pub fn looks_like_a_format_change(&self) -> bool

Whether this run looks like the agent changed its output format.

The signature is a process that exited successfully while every line it printed was unreadable: the CLI is healthy and this crate’s parser is not. Worth logging loudly, because the alternative symptom is a successful run that mysteriously returns nothing.

impl Outcome

Reported by an agent that exited cleanly but said nothing useful.

pub fn is_empty(&self) -> bool

Whether the agent produced any answer at all.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Outcome

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Outcome

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Outcome

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Outcome

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Outcome