Enum Answer 

#[non_exhaustive]
pub enum Answer {
    Allow {
        stderr: Option<String>,
    },
    Deny {
        reason: String,
    },
    Continue {
        reason: String,
    },
    Context {
        text: String,
    },
}

What a hook decides. Each harness renders it in its own form (Harness::answer).

As JSON (the hook contract’s answer): {"answer": "allow", "stderr"?}, {"answer": "deny", "reason"}, {"answer": "continue", "reason"} or {"answer": "context", "text"}.

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.

Allow

Nothing to say; at stop, the agent may stop. stderr carries text for the user, e.g. a report the hook already blocked on.

Fields

stderr: Option<String>

Text for stderr, when there is one.

Deny

Before a tool or a prompt: refuse it, with the reason.

Fields

reason: String

The reason, shown to the agent and the user.

Continue

At stop: keep the agent going, with the reason as its input.

Fields

reason: String

The reason.

Context

Session start, prompt submit, after a tool: text added to the agent’s context.

Fields

text: String

The text.

Implementations

impl Answer

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

The answer’s name in an error, e.g. deny.

pub fn stderr(&self) -> Option<&str>

The text for stderr, when there is one.

Trait Implementations

impl Clone for Answer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Answer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Answer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Answer

impl JsonSchema for Answer

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 Answer

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Answer

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 Answer