Struct HookCallbackMatcher 

pub struct HookCallbackMatcher {
    pub name: Option<String>,
    pub matcher: Option<String>,
    pub hooks: Vec<Arc<dyn Fn(HookInput, Option<String>, CancellationToken) -> Pin<Box<dyn Future<Output = Result<HookOutput, HookError>> + Send>> + Send + Sync>>,
    pub timeout: Option<u64>,
    pub requires: Option<HookRequirements>,
}

Hook configuration with optional regex matcher pattern.

Groups one or more callbacks with a regex filter. The matcher pattern is tested against the hook’s filter field (typically the tool name for tool-related hooks). If no matcher is set, the hooks run for every event of their type.

Example

use starpod_hooks::{hook_fn, HookCallbackMatcher, HookOutput};

let matcher = HookCallbackMatcher::new(vec![
    hook_fn(|_input, _id, _cancel| async move {
        Ok(HookOutput::default())
    }),
])
.with_matcher("Bash|Write")
.with_timeout(30);

assert!(matcher.matches("Bash").unwrap());
assert!(!matcher.matches("Read").unwrap());

Fields

name: Option<String>

Human-readable name for this hook group (used by circuit breaker and logging).

matcher: Option<String>

Regex pattern to match against the event’s filter field (e.g., tool name). If None, the hook runs for every event of its type.

hooks: Vec<Arc<dyn Fn(HookInput, Option<String>, CancellationToken) -> Pin<Box<dyn Future<Output = Result<HookOutput, HookError>> + Send>> + Send + Sync>>

Array of callback functions to execute when the pattern matches.

timeout: Option<u64>

Timeout in seconds for all hooks in this matcher.

requires: Option<HookRequirements>

Eligibility requirements (binaries, env vars, OS).

Implementations

impl HookCallbackMatcher

pub fn new( hooks: Vec<Arc<dyn Fn(HookInput, Option<String>, CancellationToken) -> Pin<Box<dyn Future<Output = Result<HookOutput, HookError>> + Send>> + Send + Sync>>, ) -> HookCallbackMatcher

pub fn with_name(self, name: impl Into<String>) -> HookCallbackMatcher

pub fn with_matcher(self, matcher: impl Into<String>) -> HookCallbackMatcher

pub fn with_timeout(self, timeout: u64) -> HookCallbackMatcher

pub fn with_requirements( self, requires: HookRequirements, ) -> HookCallbackMatcher

pub fn matches(&self, target: &str) -> Result<bool, HookError>

Check if this matcher applies to the given target string.

Returns Ok(true) if no matcher is set (matches everything) or if the regex pattern matches the target.

Trait Implementations

impl Clone for HookCallbackMatcher

fn clone(&self) -> HookCallbackMatcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookCallbackMatcher

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

Formats the value using the given formatter.