Enum StopReason

#[non_exhaustive]
pub enum StopReason {
    RequestedByTool(ToolCall),
    ToolCallsOverLimit(ToolCall),
    FeedbackRequired {
        tool_call: ToolCall,
        payload: Option<Value>,
    },
    Error,
    NoNewMessages,
    Other(String),
}

The reason the agent stopped

StopReason::Other has some convenience methods to convert from any AsRef<str>

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.

RequestedByTool(ToolCall)

A tool called stop

ToolCallsOverLimit(ToolCall)

A tool repeatedly failed

FeedbackRequired

A tool requires feedback before it will continue

Fields

tool_call: ToolCall

payload: Option<Value>

Error

There was an error

NoNewMessages

No new messages; stopping completions

Other(String)

Implementations

impl StopReason

pub const fn is_requested_by_tool(&self) -> bool

Returns true if the enum is StopReason::RequestedByTool otherwise false

pub const fn is_tool_calls_over_limit(&self) -> bool

Returns true if the enum is StopReason::ToolCallsOverLimit otherwise false

pub const fn is_feedback_required(&self) -> bool

Returns true if the enum is StopReason::FeedbackRequired otherwise false

pub const fn is_error(&self) -> bool

Returns true if the enum is StopReason::Error otherwise false

pub const fn is_no_new_messages(&self) -> bool

Returns true if the enum is StopReason::NoNewMessages otherwise false

pub const fn is_other(&self) -> bool

Returns true if the enum is StopReason::Other otherwise false

impl StopReason

pub fn as_requested_by_tool(&self) -> Option<&ToolCall>

pub fn as_tool_calls_over_limit(&self) -> Option<&ToolCall>

pub fn as_feedback_required(&self) -> Option<(&ToolCall, Option<&Value>)>

pub fn as_error(&self) -> Option<()>

pub fn as_no_new_messages(&self) -> Option<()>

pub fn as_other(&self) -> Option<&str>

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> StopReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopReason

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

Formats the value using the given formatter.

impl Default for StopReason

fn default() -> Self

Returns the “default value” for a type.

impl<S: AsRef<str>> From<S> for StopReason

fn from(value: S) -> Self

Converts to this type from the input type.