Expand description
Hooks 系统
支持在工具调用前后执行自定义脚本或回调
Re-exports§
pub use internal::*;
Modules§
- internal
- 内部钩子事件系统
Structs§
- Agent
Hook Config - Agent Hook 配置
- Command
Hook Config - Command Hook 配置
- Hook
Input - Hook 输入数据
- Hook
Registry - Hook 注册表
- Hook
Result - Hook 执行结果
- Legacy
Hook Config - 旧版 Hook 配置(兼容性)
- McpHook
Config - MCP Hook 配置
- Prompt
Hook Config - Prompt Hook 配置
- UrlHook
Config - URL Hook 配置
Enums§
- Compact
Trigger - 压缩触发方式
- Hook
Config - Hook 配置(联合类型)
- Hook
Decision - Hook 决策
- Hook
Error Type - 错误类型
- Hook
Event - Hook 事件类型
- Hook
Type - Hook 类型
- Http
Method - HTTP 方法
- Notification
Type - 通知类型
- Session
EndReason - 会话结束原因
- Session
Source - 会话启动来源
Constants§
- DEFAULT_
HOOK_ TIMEOUT - 默认超时时间(毫秒)
Functions§
- clear_
hooks - 清除全局注册表
- get_
event_ hook_ count - 获取指定事件的 hook 数量
- get_
hook_ count - 获取 hook 总数
- global_
registry - 获取全局注册表
- is_
blocked - 检查是否有任何 hook 阻塞操作
- load_
hooks_ from_ file - 从配置文件加载 hooks
- load_
hooks_ to_ registry - 从注册表加载 hooks
- load_
project_ hooks - 从项目目录加载 hooks
- register_
hook - 注册 hook 到全局注册表
- register_
legacy_ hook - 注册旧版 hook 到全局注册表
- run_
hooks - 运行所有匹配的 hooks
- run_
notification_ hooks - Notification hook
- run_
permission_ request_ hooks - PermissionRequest hook
- run_
post_ tool_ use_ failure_ hooks - PostToolUseFailure hook
- run_
post_ tool_ use_ hooks - PostToolUse hook 辅助函数
- run_
pre_ compact_ hooks - PreCompact hook
- run_
pre_ tool_ use_ hooks - PreToolUse hook 辅助函数
- run_
session_ end_ hooks - SessionEnd hook
- run_
session_ start_ hooks - SessionStart hook
- run_
stop_ hooks - Stop hook
- run_
subagent_ start_ hooks - SubagentStart hook
- run_
subagent_ stop_ hooks - SubagentStop hook
- run_
user_ prompt_ submit_ hooks - UserPromptSubmit hook
Type Aliases§
- Registered
Hooks - 已注册的 Hooks 存储
- Shared
Hook Registry - 共享的 Hook 注册表