Skip to main content

HookManager

Struct HookManager 

Source
pub struct HookManager { /* private fields */ }
Expand description

Hook 管理器:管理四级 hook(内置、用户级、项目级、session 级)

执行顺序:内置 → 用户级 → 项目级 → Session 级,链式执行。 前者的输出会更新到 context 中,影响后者的输入。任何 stopskip 立即中止整条链。

Implementations§

Source§

impl HookManager

Source

pub fn load() -> Self

加载用户级(~/.jdata/agent/hooks/)+ 项目级(.jcli/hooks/)hook

Source

pub fn register_builtin( &mut self, event: HookEvent, name: impl Into<String>, handler: impl Fn(&HookContext) -> Option<HookResult> + Send + Sync + 'static, )

注册内置 hook(程序初始化时调用)

Source

pub fn register_session_hook(&mut self, event: HookEvent, def: HookDef)

注册 session 级 hook(由 register_hook 工具调用)

Source

pub fn session_hooks_snapshot(&self) -> Vec<SessionHookPersist>

获取所有 session 级 hook 的可序列化快照(用于 session 持久化) 只保存 Shell 和 Llm 类型(Builtin 不可序列化)

Source

pub fn clear_session_hooks(&mut self)

清除所有 session 级 hook(session 切换时使用)

Source

pub fn restore_session_hooks(&mut self, hooks: &[SessionHookPersist])

从持久化快照恢复 session 级 hook

Source

pub fn register_session_hook_kind(&mut self, event: HookEvent, kind: HookKind)

注册 session 级 hook(直接传入 HookKind)

Source

pub fn set_provider(&mut self, provider: Arc<Mutex<ModelProvider>>)

注入 LLM provider(用于 LLM hook 执行)

Source

pub fn remove_session_hook(&mut self, event: HookEvent, index: usize) -> bool

移除 session 级 hook(按事件和索引)

Source

pub fn list_hooks(&self) -> Vec<HookEntry>

列出所有 hook(含来源标记和摘要信息)

Source

pub fn has_hooks_for(&self, event: HookEvent) -> bool

热重载用户级和项目级 hook 配置

检查某个事件是否有任何 hook 注册(内置/用户级/项目级/session 级) 用于调用方在构建 HookContext 之前短路,避免不必要的 clone 和内存分配

Source

pub fn execute_fire_and_forget( manager: Arc<Mutex<HookManager>>, event: HookEvent, context: HookContext, disabled_hooks: Vec<String>, )

Fire-and-forget 执行:在后台线程中执行 hook,不阻塞调用方 适用于 PostSendMessage、SessionEnd 等不需要返回值的 hook

Source

pub fn execute( &self, event: HookEvent, context: HookContext, disabled_hooks: &[String], ) -> Option<HookResult>

链式执行所有 hook(内置→用户→项目→session)

返回 Some(HookResult) 如果有任何修改或 stop/skip,否则 None。 链式执行中,前一个 hook 的输出会更新到 context 中,成为下一个 hook 的输入。 disabled_hooks 为被禁用的 hook 标识列表(来自 AgentConfig.disabled_hooks)。

注意:调用方应先用 has_hooks_for() 检查,再构建 HookContext 并调用此方法, 避免在没有 hook 注册时进行不必要的内存分配。

Trait Implementations§

Source§

impl Clone for HookManager

Source§

fn clone(&self) -> Self

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 HookManager

Source§

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

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

impl Default for HookManager

Source§

fn default() -> HookManager

Returns the “default value” for a type. 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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more