Enum HookInput 

pub enum HookInput {
    PreToolUse {
        base: BaseHookInput,
        tool_name: String,
        tool_input: Value,
        tool_use_id: String,
    },
    PostToolUse {
        base: BaseHookInput,
        tool_name: String,
        tool_input: Value,
        tool_response: Value,
        tool_use_id: String,
    },
    PostToolUseFailure {
        base: BaseHookInput,
        tool_name: String,
        tool_input: Value,
        tool_use_id: String,
        error: String,
        is_interrupt: Option<bool>,
    },
    Notification {
        base: BaseHookInput,
        message: String,
        title: Option<String>,
        notification_type: String,
    },
    UserPromptSubmit {
        base: BaseHookInput,
        prompt: String,
    },
    SessionStart {
        base: BaseHookInput,
        source: SessionStartSource,
        model: Option<String>,
    },
    SessionEnd {
        base: BaseHookInput,
        reason: String,
    },
    Stop {
        base: BaseHookInput,
        stop_hook_active: bool,
        last_assistant_message: Option<String>,
    },
    SubagentStart {
        base: BaseHookInput,
        agent_id: String,
        agent_type: String,
    },
    SubagentStop {
        base: BaseHookInput,
        stop_hook_active: bool,
        agent_id: String,
        agent_transcript_path: String,
        agent_type: String,
        last_assistant_message: Option<String>,
    },
    PreCompact {
        base: BaseHookInput,
        trigger: CompactTriggerType,
        custom_instructions: Option<String>,
    },
    PermissionRequest {
        base: BaseHookInput,
        tool_name: String,
        tool_input: Value,
        permission_suggestions: Option<Vec<PermissionUpdate>>,
    },
    Setup {
        base: BaseHookInput,
        trigger: SetupTrigger,
    },
    TeammateIdle {
        base: BaseHookInput,
        teammate_name: String,
        team_name: String,
    },
    TaskCompleted {
        base: BaseHookInput,
        task_id: String,
        task_subject: String,
        task_description: Option<String>,
        teammate_name: Option<String>,
        team_name: Option<String>,
    },
    ConfigChange {
        base: BaseHookInput,
        source: ConfigChangeSource,
        file_path: Option<String>,
    },
    WorktreeCreate {
        base: BaseHookInput,
        name: String,
    },
    WorktreeRemove {
        base: BaseHookInput,
        worktree_path: String,
    },
}

Union of all hook input types, tagged by event name.

Each variant carries the BaseHookInput plus event-specific fields.

Example

use starpod_hooks::{HookInput, BaseHookInput};

let input = HookInput::UserPromptSubmit {
    base: BaseHookInput {
        session_id: "sess-1".into(),
        transcript_path: String::new(),
        cwd: "/tmp".into(),
        permission_mode: None,
        agent_id: None,
        agent_type: None,
    },
    prompt: "Hello!".into(),
};
assert_eq!(input.event_name(), "UserPromptSubmit");
assert!(input.tool_name().is_none());

Variants

PreToolUse

Fields

base: BaseHookInput

tool_name: String

tool_input: Value

tool_use_id: String

PostToolUse

Fields

base: BaseHookInput

tool_name: String

tool_input: Value

tool_response: Value

tool_use_id: String

PostToolUseFailure

Fields

base: BaseHookInput

tool_name: String

tool_input: Value

tool_use_id: String

error: String

is_interrupt: Option<bool>

Notification

Fields

base: BaseHookInput

message: String

title: Option<String>

notification_type: String

UserPromptSubmit

Fields

base: BaseHookInput

prompt: String

SessionStart

Fields

base: BaseHookInput

source: SessionStartSource

model: Option<String>

SessionEnd

Fields

base: BaseHookInput

reason: String

Stop

Fields

base: BaseHookInput

stop_hook_active: bool

last_assistant_message: Option<String>

SubagentStart

Fields

base: BaseHookInput

agent_id: String

agent_type: String

SubagentStop

Fields

base: BaseHookInput

stop_hook_active: bool

agent_id: String

agent_transcript_path: String

agent_type: String

last_assistant_message: Option<String>

PreCompact

Fields

base: BaseHookInput

trigger: CompactTriggerType

custom_instructions: Option<String>

PermissionRequest

Fields

base: BaseHookInput

tool_name: String

tool_input: Value

permission_suggestions: Option<Vec<PermissionUpdate>>

Setup

Fields

base: BaseHookInput

trigger: SetupTrigger

TeammateIdle

Fields

base: BaseHookInput

teammate_name: String

team_name: String

TaskCompleted

Fields

base: BaseHookInput

task_id: String

task_subject: String

task_description: Option<String>

teammate_name: Option<String>

team_name: Option<String>

ConfigChange

Fields

base: BaseHookInput

source: ConfigChangeSource

file_path: Option<String>

WorktreeCreate

Fields

base: BaseHookInput

name: String

WorktreeRemove

Fields

base: BaseHookInput

worktree_path: String

Implementations

impl HookInput

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

Returns the tool name if this is a tool-related hook.

pub fn event_name(&self) -> &str

Returns the hook event name as a string.

pub fn base(&self) -> &BaseHookInput

Returns a reference to the base input fields.

Trait Implementations

impl Clone for HookInput

fn clone(&self) -> HookInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HookInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HookInput

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.