Enum ToolOutcome 

pub enum ToolOutcome {
    Success,
    Error,
    PermissionRejected,
    PermissionCancelled,
    Followup,
    HookDenied,
    InvalidTool,
    Cancelled,
}

Fine-grained outcome of a tool invocation lifecycle.

Mirrors the outcome taxonomy used by the runtime: status remains the coarse lifecycle signal (Completed / Failed / InProgress), while outcome captures why the invocation terminated. Consumers that only need success/failure can continue to read status; analytics and the UI layer use outcome for richer classification.

Variants

Success

Tool executed and returned a result.

Error

Tool executed but returned an error.

PermissionRejected

User rejected the permission prompt.

PermissionCancelled

User cancelled the permission prompt (e.g. Ctrl+C / Esc).

Followup

User provided a followup message instead of approving.

HookDenied

A user-configured hook blocked execution.

InvalidTool

Tool not found or arguments couldn’t be parsed.

Cancelled

Tool was cancelled during execution or closed before dispatch when its turn ended.

Implementations

impl ToolOutcome

pub const fn is_terminal(self) -> bool

Trait Implementations

impl Clone for ToolOutcome

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ToolOutcome

impl Debug for ToolOutcome

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

Formats the value using the given formatter.

impl Default for ToolOutcome

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolOutcome

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolOutcome

impl JsonSchema for ToolOutcome

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ToolOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolOutcome

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 ToolOutcome