Enum StopReason 

pub enum StopReason {
    Completed,
    Length,
    ToolUse,
    PauseTurn,
    Cancelled,
    Error,
    Unknown(String),
}

Normalized assistant stop reason with forward-compatible unknown values.

Variants

Completed

Model completed normally.

Length

Model reached an output limit.

ToolUse

Model requested one or more tools.

PauseTurn

Provider paused a server-side tool loop and requires transcript replay.

Cancelled

Operation was cancelled.

Error

Provider or runtime failed.

Unknown(String)

A future provider-neutral value not known by this crate.

Implementations

impl StopReason

pub fn as_str(&self) -> &str

Returns the serialized reason.

pub const fn is_success(&self) -> bool

Returns whether this reason represents normal completion.

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> StopReason

Returns a duplicate of the value.

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<'de> Deserialize<'de> for StopReason

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StopReason

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

Formats the value using the given formatter.

impl Eq for StopReason

impl Hash for StopReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StopReason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StopReason

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 StopReason