Skip to main content

HookExecutor

Struct HookExecutor 

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

Executes hook commands in response to agent lifecycle events.

Implementations§

Source§

impl HookExecutor

Source

pub fn new(hooks: Vec<HookConfig>) -> Self

Create an executor with the given hook configurations.

Source

pub fn empty() -> Self

Create an executor with no hooks (a no-op executor).

Source

pub fn has_hooks(&self) -> bool

Whether any hooks are configured.

Source

pub async fn run_pre_tool_use( &self, tool_name: &str, ctx: &HookContext, ) -> PreHookResult

Run all matching PreToolUse hooks and return the aggregate result.

If any hook returns Block, the overall result is Block. If any hook returns Modify, the last Modify wins. If a hook times out, crashes, or produces non-JSON output, it degrades to Allow (the tool call is not disrupted).

Source

pub async fn run_post_tool_use(&self, tool_name: &str, ctx: &HookContext)

Run all matching PostToolUse hooks (fire-and-forget).

Errors are silently swallowed — post-hooks are advisory.

Source

pub async fn run_user_prompt_submit( &self, prompt: &str, session_id: &str, cwd: &str, ) -> UserPromptHookResult

Run every UserPromptSubmit hook in registration order. Aggregates results following CC’s contract:

  • Any hook returning decision: "block" (or exit non-zero) → the whole prompt is blocked; first reason wins.
  • Hooks emitting hookSpecificOutput.additionalContext (JSON) or plain text on stdout → concatenated and surfaced to the agent as extra context to append to the user message.
  • Empty stdout / unparseable JSON → treated as a silent continue, so a hook author can still print(...) debug noise without accidentally injecting it into every prompt.

Each hook receives the payload as JSON on stdin (CC parity), so scripts using json.load(sys.stdin) work unchanged.

Source

pub async fn run_session_event(&self, event: HookEvent, ctx: &HookContext)

Run all hooks matching a session-level event (fire-and-forget).

Source

pub async fn execute_hook( &self, hook: &HookConfig, ctx: &HookContext, ) -> Result<String>

Execute a single hook command and return its stdout.

The hook receives context via environment variables:

  • ATOMCODE_HOOK_EVENT — the event name (e.g. pre_tool_use)
  • ATOMCODE_TOOL_NAME — tool name, if applicable
  • ATOMCODE_HOOK_CONTEXT — full JSON-serialized HookContext

The command is killed after hook.timeout_ms milliseconds.

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> 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> 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> 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, 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<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