Struct ErrorStopReason 

#[non_exhaustive]
pub struct ErrorStopReason {
    pub error: Option<Box<Error>>,
}

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Details of a failure that ended a child’s foreground work.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

error: Option<Box<Error>>

The failure, as a JSON-RPC error object.

Optional. Omitted or null both mean the agent is not reporting failure details. Agents SHOULD include it.

Implementations

impl ErrorStopReason

pub fn new() -> ErrorStopReason

Available on crate feature unstable_subagents only.

Builds ErrorStopReason with the required fields set; optional fields start unset or empty.

pub fn error(self, error: impl IntoOption<Error>) -> ErrorStopReason

Available on crate feature unstable_subagents only.

The failure, as a JSON-RPC error object.

Trait Implementations

impl Clone for ErrorStopReason

fn clone(&self) -> ErrorStopReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorStopReason

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

Formats the value using the given formatter.

impl Default for ErrorStopReason

fn default() -> ErrorStopReason

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ErrorStopReason

fn deserialize<__D>( __deserializer: __D, ) -> Result<ErrorStopReason, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ErrorStopReason

impl From<ErrorStopReason> for IdleStopReason

Available on crate feature unstable_subagents only.

fn from(value: ErrorStopReason) -> IdleStopReason

Converts to this type from the input type.

impl JsonSchema for ErrorStopReason

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ErrorStopReason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ErrorStopReason

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ErrorStopReason