Skip to main content

HookInput

Enum HookInput 

Source
pub enum HookInput {
    PreToolUse {
        tool_name: String,
        tool_input: Value,
        call_id: ToolCallId,
    },
    PostToolUse {
        tool_name: String,
        tool_input: Value,
        tool_output: ToolOutput,
        call_id: ToolCallId,
    },
    PostToolFailure {
        tool_name: String,
        tool_input: Value,
        error: String,
        call_id: ToolCallId,
    },
    UserPromptSubmit {
        prompt: String,
    },
    SessionStart {
        session_id: SessionId,
    },
    SessionEnd {
        session_id: SessionId,
        reason: String,
    },
    Stop {
        finish_reason: String,
    },
    SubAgentStart {
        agent_name: String,
    },
    PreCompact {
        trigger: String,
        tokens_before: u64,
    },
    PostCompact {
        trigger: String,
        tokens_after: u64,
    },
}
Expand description

Hook 输入 — 每个 HookEvent 携带的上下文数据。

使用 enum 确保类型安全,Hook 实现方通过 match 获取精确类型。 所有变体均可序列化,支持跨进程 Hook(如 shell command hook)。

§Examples

use katu_core::hook::{HookEvent, HookInput};
use katu_core::ToolCallId;
use serde_json::json;

let input = HookInput::PreToolUse {
    tool_name: "bash".into(),
    tool_input: json!({"command": "ls -la"}),
    call_id: ToolCallId::new("call_1"),
};
assert_eq!(input.event(), HookEvent::PreToolUse);
assert_eq!(input.tool_name(), Some("bash"));

Variants§

§

PreToolUse

工具执行前。

Fields

§tool_name: String
§tool_input: Value
§call_id: ToolCallId
§

PostToolUse

工具执行成功后。

Fields

§tool_name: String
§tool_input: Value
§tool_output: ToolOutput
§call_id: ToolCallId
§

PostToolFailure

工具执行失败后。

Fields

§tool_name: String
§tool_input: Value
§error: String
§call_id: ToolCallId
§

UserPromptSubmit

用户提交 prompt 前。

Fields

§prompt: String
§

SessionStart

Session 开始。

Fields

§session_id: SessionId
§

SessionEnd

Session 结束。

Fields

§session_id: SessionId
§reason: String
§

Stop

Agent loop 单步结束判定。

Fields

§finish_reason: String
§

SubAgentStart

SubAgent 启动前。

Fields

§agent_name: String
§

PreCompact

上下文压缩前。

Fields

§trigger: String
§tokens_before: u64
§

PostCompact

上下文压缩后。

Fields

§trigger: String
§tokens_after: u64

Implementations§

Source§

impl HookInput

Source

pub fn event(&self) -> HookEvent

返回此输入对应的事件类型。

Source

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

如果是 Tool 相关事件,返回工具名。

Source

pub fn call_id(&self) -> Option<&ToolCallId>

如果是 Tool 相关事件,返回 call_id。

Trait Implementations§

Source§

impl Clone for HookInput

Source§

fn clone(&self) -> HookInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HookInput

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for HookInput

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,