Enum SuspendReason 

#[non_exhaustive]
pub enum SuspendReason {
    Human {
        prompt: String,
        schema: Option<Value>,
    },
    External {
        token: String,
    },
}

Why a run stopped and what would restart it.

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.

Human

Waiting on a person.

Fields

prompt: String

What to ask them.

schema: Option<Value>

JSON Schema the answer should satisfy, when a shape is expected.

External

Waiting on something outside the run entirely.

Fields

token: String

Opaque correlation token; whoever resumes the run quotes it back.

Implementations

impl SuspendReason

pub fn label(&self) -> String

A short description, for an error message or an event payload.

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

The kind, as a stable token events can be grouped by.

Trait Implementations

impl Clone for SuspendReason

fn clone(&self) -> SuspendReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SuspendReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SuspendReason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SuspendReason

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

where __S: Serializer,

Serialize this value into the given Serde serializer.