Enum StopReason 

pub enum StopReason {
    EndOfSpeech,
    FrameCapReached,
    DurationLimitReached,
    Cancelled,
}

Why a generation stopped.

The reason travels with every result because two of these produce audio that sounds finished and are not.

Variants

EndOfSpeech

The model emitted end-of-speech. The only clean completion.

FrameCapReached

The frame cap was reached without end-of-speech — the audio is cut off mid-utterance.

DurationLimitReached

A hard duration limit stopped generation — also a cut-off.

Cancelled

The caller cancelled.

Implementations

impl StopReason

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

The stable wire string, for robot mode.

pub const fn is_truncated(self) -> bool

Whether the audio was cut off rather than completed.

The predicate the CLI branches its exit code on. An agent cannot hear a truncated word, so this must be inspectable rather than audible.

pub const fn is_clean_completion(self) -> bool

Whether this outcome may be reported as an unqualified success.

Only StopReason::EndOfSpeech may. Anything else is either truncated or cancelled, and reporting it as plain success is the counterfeit green Doctrine #0.4 forbids.

pub const fn remedy(self) -> Option<&'static str>

A caller-facing explanation of what to do about it.

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

impl Debug for StopReason

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

Formats the value using the given formatter.

impl Display for StopReason

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

Formats the value using the given formatter.

impl Eq for StopReason

impl PartialEq for StopReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StopReason