Enum StopReason 

#[non_exhaustive]
pub enum StopReason {
    EndTurn,
    ToolUse,
    MaxTokens,
    StopSequence,
    Refusal,
    ModelContextWindowExceeded,
    Unknown,
}

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.

EndTurn

ToolUse

MaxTokens

StopSequence

Refusal

ModelContextWindowExceeded

Unknown

A stop reason this version of the SDK does not recognize.

Providers may introduce new stop reasons at any time. Rather than failing deserialization of an otherwise-valid response (or a persisted/replayed audit row), unknown values map here via #[serde(other)]. Consumers should treat it like StopReason::EndTurn (turn finished, nothing actionable) unless they have a more specific fallback.

Implementations

impl StopReason

pub const fn as_str(&self) -> &'static str

Stable discriminant string used for durable rows, metrics, and dashboards. Matches the serde representation.

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StopReason

fn deserialize<__D>( __deserializer: __D, ) -> Result<StopReason, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StopReason

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StopReason

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StopReason

impl Eq for StopReason

impl StructuralPartialEq for StopReason