Struct HookContext 

pub struct HookContext {
    pub event: HookEvent,
    pub tool_name: Option<String>,
    pub tool_args: Option<Value>,
    pub tool_result: Option<String>,
    pub is_error: Option<bool>,
    pub session_id: Option<String>,
    pub session_cwd: Option<PathBuf>,
    pub extra: Option<Value>,
}

Payload passed to a hook. Serialised to JSON on the script’s stdin.

Fields

event: HookEvent

Event being fired.

tool_name: Option<String>

Tool name (PreToolUse/PostToolUse/SubagentStop).

tool_args: Option<Value>

Tool arguments (PreToolUse). For PostToolUse the input is omitted to keep the payload small; consumers that need it can match by tool_name.

tool_result: Option<String>

Tool result content (PostToolUse).

is_error: Option<bool>

Whether the result was an error (PostToolUse).

session_id: Option<String>

Identifier of the owning session.

session_cwd: Option<PathBuf>

CWD of the owning session.

extra: Option<Value>

Escape hatch for future fields without breaking the contract.

Trait Implementations

impl Clone for HookContext

fn clone(&self) -> HookContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookContext

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

Formats the value using the given formatter.

impl Default for HookContext

fn default() -> HookContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HookContext

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HookContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.