Enum HookCommand 

#[non_exhaustive]
pub enum HookCommand {
    Program {
        program: String,
        args: Vec<String>,
    },
    ShellUnchecked {
        command: String,
    },
}

Hook command representation.

HookCommand::Program is the safe default. It stores argv-like program and argument values, then renders them with POSIX shell quoting (see HookCommand::render_shell) for harnesses whose hook APIs only accept strings. HookCommand::ShellUnchecked is an escape hatch for trusted raw shell syntax — including the case where the target shell is not POSIX (e.g. PowerShell on native Windows).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Program

A program plus arguments, rendered safely when a shell string is needed.

Fields

program: String

Executable name or path.

args: Vec<String>

Command arguments.

ShellUnchecked

Trusted raw shell syntax.

Fields

command: String

Shell command passed through without quoting or escaping.

Implementations

impl HookCommand

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

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

Construct a safe program command.

pub fn shell_unchecked(command: impl Into<String>) -> Self

Construct an unchecked raw shell command.

pub fn render_shell(&self) -> String

Render the command for harnesses whose hook contract accepts a shell command string.

The output is POSIX-shell quoted: arguments are escaped using single-quote rules suitable for sh/bash. It is not safe for cmd.exe or PowerShell; on native Windows, callers targeting a non-POSIX shell should construct HookCommand::ShellUnchecked and quote the command themselves.

Integrations that store the rendered string in a JSON or YAML field (Copilot’s bash field, Windsurf’s bash, Gemini’s command, etc.) inherit POSIX semantics through this method. A platform-aware shell abstraction (ShellKind/PowerShell quoting) is intentionally deferred; see the project README for the supported-platforms model.

Trait Implementations

impl Clone for HookCommand

fn clone(&self) -> HookCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookCommand

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

Formats the value using the given formatter.

impl PartialEq for HookCommand

fn eq(&self, other: &HookCommand) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HookCommand

impl StructuralPartialEq for HookCommand