Skip to main content

InternalHookRegistry

Struct InternalHookRegistry 

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

内部钩子注册表

管理事件与处理器的映射关系。支持按事件键(type:action)或 事件类型(type)注册处理器。

§线程安全

使用 RwLock 保护内部数据结构,支持多线程并发访问。

§事件键格式

注册方式事件键示例触发条件
类型级别agent所有 Agent 事件
动作级别agent:start仅 Agent Start 事件

§示例

use aster::hooks::internal::{InternalHookRegistry, InternalHookHandlerFn};
use std::sync::Arc;

let registry = InternalHookRegistry::new();

// 注册处理器
let handler: InternalHookHandlerFn = Arc::new(|event| {
    Box::pin(async move {
        println!("Event: {}", event.event_key());
        Ok(())
    })
});
registry.register("agent:start", handler);

// 查询已注册的事件键
let keys = registry.get_registered_keys();
assert!(keys.contains(&"agent:start".to_string()));

Implementations§

Source§

impl InternalHookRegistry

Source

pub fn new() -> Self

创建新的内部钩子注册表

§返回值

返回一个空的注册表实例。

§示例
use aster::hooks::internal::InternalHookRegistry;

let registry = InternalHookRegistry::new();
assert!(registry.get_registered_keys().is_empty());
Source

pub fn register(&self, event_key: &str, handler: InternalHookHandlerFn)

注册处理器

将处理器注册到指定的事件键。支持两种注册方式:

  • 类型级别:使用事件类型作为键(如 "agent"),匹配该类型的所有事件
  • 动作级别:使用 type:action 格式(如 "agent:start"),匹配特定事件

同一事件键可以注册多个处理器,按注册顺序调用。

§参数
  • event_key: 事件键,可以是类型(如 "agent")或 type:action 格式
  • handler: 处理器函数
§示例
use aster::hooks::internal::{InternalHookRegistry, InternalHookHandlerFn};
use std::sync::Arc;

let registry = InternalHookRegistry::new();

// 注册类型级别处理器(匹配所有 Agent 事件)
let type_handler: InternalHookHandlerFn = Arc::new(|_| Box::pin(async { Ok(()) }));
registry.register("agent", type_handler);

// 注册动作级别处理器(仅匹配 agent:start 事件)
let action_handler: InternalHookHandlerFn = Arc::new(|_| Box::pin(async { Ok(()) }));
registry.register("agent:start", action_handler);
Source

pub fn unregister( &self, event_key: &str, handler: &InternalHookHandlerFn, ) -> bool

取消注册处理器

从指定事件键中移除处理器。使用 Arc::ptr_eq 比较处理器指针。

§参数
  • event_key: 事件键
  • handler: 要移除的处理器
§返回值
  • true: 成功移除处理器
  • false: 未找到匹配的处理器
§示例
use aster::hooks::internal::{InternalHookRegistry, InternalHookHandlerFn};
use std::sync::Arc;

let registry = InternalHookRegistry::new();

let handler: InternalHookHandlerFn = Arc::new(|_| Box::pin(async { Ok(()) }));
registry.register("agent:start", handler.clone());

// 取消注册
let removed = registry.unregister("agent:start", &handler);
assert!(removed);

// 再次取消注册返回 false
let removed_again = registry.unregister("agent:start", &handler);
assert!(!removed_again);
Source

pub fn clear(&self)

清除所有处理器

移除注册表中的所有处理器和事件键。

§示例
use aster::hooks::internal::{InternalHookRegistry, InternalHookHandlerFn};
use std::sync::Arc;

let registry = InternalHookRegistry::new();

let handler: InternalHookHandlerFn = Arc::new(|_| Box::pin(async { Ok(()) }));
registry.register("agent:start", handler.clone());
registry.register("session:create", handler);

assert_eq!(registry.get_registered_keys().len(), 2);

registry.clear();
assert!(registry.get_registered_keys().is_empty());
Source

pub fn get_registered_keys(&self) -> Vec<String>

获取已注册的事件键

返回所有已注册处理器的事件键列表。

§返回值

事件键列表,顺序不保证。

§示例
use aster::hooks::internal::{InternalHookRegistry, InternalHookHandlerFn};
use std::sync::Arc;

let registry = InternalHookRegistry::new();

let handler: InternalHookHandlerFn = Arc::new(|_| Box::pin(async { Ok(()) }));
registry.register("agent:start", handler.clone());
registry.register("agent:stop", handler.clone());
registry.register("session:create", handler);

let keys = registry.get_registered_keys();
assert_eq!(keys.len(), 3);
assert!(keys.contains(&"agent:start".to_string()));
assert!(keys.contains(&"agent:stop".to_string()));
assert!(keys.contains(&"session:create".to_string()));
Source

pub fn get_handlers(&self, event_key: &str) -> Vec<InternalHookHandlerFn>

获取指定事件键的处理器列表

返回注册到指定事件键的所有处理器的克隆列表。 此方法主要用于内部触发事件时获取处理器。

§参数
  • event_key: 事件键
§返回值

处理器列表,如果没有注册任何处理器则返回空列表。

Source

pub async fn trigger(&self, event: &mut InternalHookEvent) -> Result<()>

触发事件

先调用类型级别处理器(如 "agent"),再调用动作级别处理器(如 "agent:start")。 处理器错误会被捕获并记录日志,不影响其他处理器执行。

§执行顺序
  1. 获取类型级别处理器(使用 event.event_type.to_string() 作为键)
  2. 获取动作级别处理器(使用 event.event_key() 作为键)
  3. 按注册顺序依次调用所有处理器
§错误处理
  • 处理器返回 Err: 记录错误日志,继续执行下一个处理器
  • 处理器超时: 记录警告日志,继续执行下一个处理器
§参数
  • event: 可变的事件引用,处理器可以修改事件的 messages 字段
§返回值

始终返回 Ok(()),处理器错误不会导致整体失败。

§示例
use aster::hooks::internal::{InternalHookRegistry, InternalHookEvent, InternalHookEventType, InternalHookAction, InternalHookHandlerFn};
use std::sync::Arc;
use serde_json::json;

let registry = InternalHookRegistry::new();

// 注册类型级别处理器
let type_handler: InternalHookHandlerFn = Arc::new(|event| {
    Box::pin(async move {
        event.messages.push("Type handler called".to_string());
        Ok(())
    })
});
registry.register("agent", type_handler);

// 注册动作级别处理器
let action_handler: InternalHookHandlerFn = Arc::new(|event| {
    Box::pin(async move {
        event.messages.push("Action handler called".to_string());
        Ok(())
    })
});
registry.register("agent:start", action_handler);

// 触发事件
let mut event = InternalHookEvent::new(
    InternalHookEventType::Agent,
    InternalHookAction::Start,
    None,
    json!({}),
);

// 在异步上下文中调用
// registry.trigger(&mut event).await.unwrap();
// assert_eq!(event.messages, vec!["Type handler called", "Action handler called"]);
Source

pub fn is_empty(&self) -> bool

检查是否有注册的处理器

§返回值
  • true: 注册表为空
  • false: 有注册的处理器
Source

pub fn handler_count(&self) -> usize

获取注册的处理器总数

§返回值

所有事件键下注册的处理器总数。

Trait Implementations§

Source§

impl Debug for InternalHookRegistry

Source§

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

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

impl Default for InternalHookRegistry

Source§

fn default() -> Self

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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
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> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,