Enum StopReason 

#[non_exhaustive]
pub enum StopReason {
    Stop,
    Length,
    ToolUse,
    Error(String),
    Aborted(String),
}

How an assistant turn ended.

A turn that ended in Self::Error or Self::Aborted is kept in history but never replayed to a model.

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.

Stop

The model finished.

Length

The output-token limit cut the turn.

ToolUse

The model stopped to call tools.

Error(String)

The provider failed the turn or refused it, with its explanation.

Aborted(String)

The caller cancelled the turn.

Implementations

impl StopReason

pub fn is_failure(&self) -> bool

Whether the turn is incomplete and must not be replayed.

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> Self

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 Eq for StopReason

impl PartialEq for StopReason

fn eq(&self, other: &Self) -> 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