Struct HookSpecBuilder 

pub struct HookSpecBuilder { /* private fields */ }

Builder for HookSpec.

Implementations

impl HookSpecBuilder

pub fn command_program<I, S>(self, program: impl Into<String>, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the program and arguments the harness should execute when the hook fires.

Integrations that only accept shell strings render this command with POSIX shell quoting, so arguments containing spaces or shell metacharacters remain arguments instead of becoming shell syntax.

pub fn command_shell_unchecked(self, command: impl Into<String>) -> Self

Set an unchecked raw shell command.

This is intentionally explicit: the command string is passed through as shell syntax for harnesses and generated scripts. Use this only when the full command is trusted and already sanitized.

pub fn matcher(self, m: Matcher) -> Self

Set the tool-call matcher.

pub fn event(self, e: Event) -> Self

Set the lifecycle event to attach to.

pub fn rules(self, content: impl Into<String>) -> Self

Attach a markdown rules block to be injected into the harness’s memory file.

pub fn script(self, script: ScriptTemplate) -> Self

Attach a script template (shell or TS) for harnesses that need one.

pub fn friendly_name(self, name: impl Into<String>) -> Self

Set a human-friendly display name shown in install reports.

pub fn timeout_seconds(self, timeout: u64) -> Self

Set the hook execution timeout in seconds.

pub fn status_message(self, msg: impl Into<String>) -> Self

Set the status message to show during execution.

pub fn async_run(self, val: bool) -> Self

Set whether the hook is run asynchronously.

pub fn shell(self, sh: impl Into<String>) -> Self

Set the custom shell to execute the command.

pub fn windows_command(self, cmd: HookCommand) -> Self

Set the Windows-specific command override.

pub fn codex_inline_toml(self, val: bool) -> Self

Set whether Codex should install this hook inline in config.toml.

pub fn build(self) -> HookSpec

Finalize the spec, panicking on missing or invalid fields.

Convenience wrapper around try_build() for tests and examples. Production code should prefer try_build() to propagate errors instead of panicking.

Panics

Panics if command was never set.

pub fn try_build(self) -> Result<HookSpec, AgentConfigError>

Finalize the spec, returning Result on missing or invalid fields.

This is the recommended way to build a spec in production code. See crate-level documentation for a full example.

Errors

• AgentConfigError::InvalidTag when tag, the matcher string, or any custom event name fails identifier or hook-string validation.
• AgentConfigError::MissingSpecField (field = "command") when neither HookSpecBuilder::command_program nor HookSpecBuilder::command_shell_unchecked was called.
• AgentConfigError::InvalidTag from command.validate() when the command string is empty or contains control characters.

Trait Implementations

impl Clone for HookSpecBuilder

fn clone(&self) -> HookSpecBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookSpecBuilder

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

Formats the value using the given formatter.