pub enum FinishReason {
Stop,
Length,
ToolUse,
SafetyBreach,
Other(String),
}Expand description
How the model decided to stop generating.
Maps the provider-specific finish-reason strings to a closed enum
callers can match on. Unmapped values land in Other(s) so the
raw string is still recoverable for diagnostics.
Variants§
Stop
Natural end of generation (Anthropic end_turn, OpenAI stop,
Gemini STOP).
Length
Hit max_tokens budget (Anthropic max_tokens, OpenAI length,
Gemini MAX_TOKENS).
ToolUse
Model invoked a tool (Anthropic tool_use, OpenAI tool_calls).
SafetyBreach
Provider’s content filter blocked output (OpenAI content_filter,
Gemini SAFETY, Anthropic empty + end_turn).
Other(String)
Anything else; carries the raw provider string.
Implementations§
Source§impl FinishReason
impl FinishReason
Sourcepub fn from_provider(provider: &str, raw: &str) -> Self
pub fn from_provider(provider: &str, raw: &str) -> Self
Map a raw provider string into the enum.
Sourcepub fn is_safety_breach(&self) -> bool
pub fn is_safety_breach(&self) -> bool
True iff this finish reason is the provider’s safety classifier
blocking output. Used by BackendError::SafetyBreach lifting.
Trait Implementations§
Source§impl Clone for FinishReason
impl Clone for FinishReason
Source§fn clone(&self) -> FinishReason
fn clone(&self) -> FinishReason
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for FinishReason
impl Debug for FinishReason
impl Eq for FinishReason
Source§impl PartialEq for FinishReason
impl PartialEq for FinishReason
Source§fn eq(&self, other: &FinishReason) -> bool
fn eq(&self, other: &FinishReason) -> bool
Tests for
self and other values to be equal, and is used by ==.impl StructuralPartialEq for FinishReason
Auto Trait Implementations§
impl Freeze for FinishReason
impl RefUnwindSafe for FinishReason
impl Send for FinishReason
impl Sync for FinishReason
impl Unpin for FinishReason
impl UnsafeUnpin for FinishReason
impl UnwindSafe for FinishReason
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreCreates a shared type from an unshared type.