Enum FinishReason 

#[non_exhaustive]
pub enum FinishReason {
    Stop,
    Length,
    ToolCalls,
    ContentFilter,
    Other(String),
}

Normalized generation ending. Unmapped provider values remain in Self::Other. Failure statuses may accompany parseable output; callers must decide whether such output is usable rather than treating every response as successful.

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

Natural end of the response.

Length

The response hit the output-token limit.

ToolCalls

The model stopped to call one or more tools.

ContentFilter

The provider filtered the content.

Other(String)

A provider-specific reason outside the normalized vocabulary, carried verbatim in the provider’s own wire spelling.

Implementations

impl FinishReason

pub fn reconcile_with_output(self, has_tool_call: bool) -> Self

Changes Self::Stop to Self::ToolCalls when output contains a tool call. All other reasons remain unchanged. Response builders and streaming aggregation apply this reconciliation.

pub fn truncated_output(&self) -> bool

Returns whether the reason is Self::Length or Self::ContentFilter. These reasons permit answerless turns without treating absent content as a malformed response. Unknown reasons are not classified as truncation.

pub fn no_answer_message(&self) -> String

Formats an answerless-turn diagnostic with budget or filtering advice for known truncation reasons, and a generic explanation otherwise.

Trait Implementations

impl Clone for FinishReason

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 FinishReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FinishReason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FinishReason

impl PartialEq for FinishReason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FinishReason

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 FinishReason