Enum HookShape 

pub enum HookShape {
    Asks,
    DenyOnly,
    CamelCase,
    Context,
    Steps,
    CursorShell,
    Cursor,
}

The hook contract a call arrived in, told apart by its stdin. It decides which field carries the answer. A rule that fired is an allow with one warning line in every shape, and a rule that blocks is that shape’s deny on a tool call.

Variants

Asks

snake_case stdin; the warning goes in additionalContext.

DenyOnly

snake_case stdin carrying turn_id, the command harness PreToolUse; the warning goes in additionalContext.

CamelCase

camelCase stdin (hookEventName, toolInput), the build harness; the warning goes in additionalContext.

Context

lower-case event names (pre_llm_call, pre_tool_call) with the prompt under extra.user_message; a top-level context is injected and carries the warning.

Steps

camelCase stdin with conversationId, no event name (the hook is told it with --event), the command under toolCall.args, the prompt only in the transcript. A tool gate answers decision: allow with the warning as its reason; context goes in as injectSteps; a Stop is held with decision: continue.

CursorShell

The editor harness’s beforeShellExecution: snake_case stdin carrying cursor_version, the command at the top level. Answers permission: allow with the warning in user_message and agent_message. The editor harness blocks the command when the answer is not JSON.

Cursor

Every other editor harness event. Context reaches the model as additional_context only on postToolUse, postToolUseFailure and sessionStart. A stop is held with followup_message. preToolUse answers as beforeShellExecution does, which is the shell shape.

Implementations

impl HookShape

pub fn holds_prompt_note(self) -> bool

Whether the runner discards a prompt hook’s context, so the note is held and delivered on the first tool result instead.

pub fn is_cursor(self) -> bool

the editor harness, on either of its event shapes.

Trait Implementations

impl Clone for HookShape

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HookShape

impl Debug for HookShape

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

Formats the value using the given formatter.

impl Default for HookShape

fn default() -> Self

Returns the “default value” for a type.

impl Eq for HookShape

impl PartialEq for HookShape

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HookShape