Skip to main content

Module hooks

Module hooks 

Source
Expand description

Hooks 系统

支持在工具调用前后执行自定义脚本或回调

Re-exports§

pub use internal::*;

Modules§

internal
内部钩子事件系统

Structs§

AgentHookConfig
Agent Hook 配置
CommandHookConfig
Command Hook 配置
HookInput
Hook 输入数据
HookRegistry
Hook 注册表
HookResult
Hook 执行结果
LegacyHookConfig
旧版 Hook 配置(兼容性)
McpHookConfig
MCP Hook 配置
PromptHookConfig
Prompt Hook 配置
UrlHookConfig
URL Hook 配置

Enums§

CompactTrigger
压缩触发方式
HookConfig
Hook 配置(联合类型)
HookDecision
Hook 决策
HookErrorType
错误类型
HookEvent
Hook 事件类型
HookType
Hook 类型
HttpMethod
HTTP 方法
NotificationType
通知类型
SessionEndReason
会话结束原因
SessionSource
会话启动来源

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§

RegisteredHooks
已注册的 Hooks 存储
SharedHookRegistry
共享的 Hook 注册表