Enum StopKind 

pub enum StopKind {
    EndTurn,
    ToolUse,
    LimitReached,
    Cancelled,
    Error {
        message: String,
    },
    Other {
        reason: String,
    },
}

Why an agent run reached a terminal boundary.

Harness-neutral projection of a harness’s native stop/finish reason. Other carries the harness’s raw reason label for reasons this neutral set does not enumerate, so no stop reason is ever silently dropped.

Variants

EndTurn

The agent completed its turn normally (produced its result).

ToolUse

The agent stopped to await a tool result before continuing.

LimitReached

The run hit a configured resource limit (tokens / turns / time).

Cancelled

The run was cancelled (e.g. by an intervention or shutdown).

Error

The run stopped because of an error.

Fields

message: String

Human-readable error description.

Other

A stop reason this neutral set does not enumerate; carries the harness’s raw label.

Fields

reason: String

The harness’s raw stop-reason label.

Implementations

impl StopKind

pub fn canonical_stop_reason(&self) -> &'static str

The canonical snake_case stop_reason string for this stop kind.

This is the ONE mapping from the neutral stop vocabulary onto the AgentOutcome::stop_reason wire strings. The detail payloads of StopKind::Error and StopKind::Other deliberately do not reach the canonical string: the canonical vocabulary is closed, and the detail belongs to the transcript channel that carries the full StopKind.

Trait Implementations

impl Clone for StopKind

fn clone(&self) -> StopKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StopKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StopKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StopKind

impl PartialEq for StopKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StopKind

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 StopKind

impl TS for StopKind

type WithoutGenerics = StopKind

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = StopKind

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.