Enum HookEventName 

pub enum HookEventName {
    SessionStart,
    SessionEnd,
    UserPromptSubmit,
    PreToolUse,
    PostToolUse,
    PostToolUseFailure,
    Notification,
    Stop,
    SubagentStart,
    SubagentStop,
    PreCompact,
    PostCompact,
    PermissionRequest,
    PermissionDenied,
    Elicitation,
    ElicitationResult,
    WorktreeCreate,
    WorktreeRemove,
    FileChanged,
    CwdChanged,
    InstructionsLoaded,
    ConfigChange,
    Setup,
    TeammateIdle,
    TaskCreated,
    TaskCompleted,
    StopFailure,
    PostSampling,
}

Canonical hook event name.

Variants

SessionStart

SessionEnd

UserPromptSubmit

PreToolUse

PostToolUse

PostToolUseFailure

Notification

Stop

SubagentStart

SubagentStop

PreCompact

PostCompact

PermissionRequest

PermissionDenied

Elicitation

ElicitationResult

WorktreeCreate

WorktreeRemove

FileChanged

CwdChanged

InstructionsLoaded

ConfigChange

Setup

TeammateIdle

TaskCreated

TaskCompleted

StopFailure

PostSampling

Implementations

impl HookEventName

pub fn canonical_name(self) -> &'static str

Canonical PascalCase event spelling.

pub fn matcher_field(self) -> Option<&'static str>

Payload field used for event matcher evaluation.

pub fn from_alias(alias: &str) -> Option<Self>

Resolve an alias (PascalCase, snake_case, or camelCase) to its canonical variant. strum::EnumString with ascii_case_insensitive handles case variants; we strip underscores so pre_tool_use normalizes to PreToolUse without per-variant serde aliases.

Trait Implementations

impl Clone for HookEventName

fn clone(&self) -> HookEventName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HookEventName

impl Debug for HookEventName

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

Formats the value using the given formatter.

impl Eq for HookEventName

impl<'_derivative_strum> From<&'_derivative_strum HookEventName> for &'static str

fn from(x: &'_derivative_strum HookEventName) -> &'static str

Converts to this type from the input type.

impl From<HookEventName> for &'static str

fn from(x: HookEventName) -> &'static str

Converts to this type from the input type.

impl FromStr for HookEventName

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<HookEventName, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for HookEventName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HookEventName

fn cmp(&self, other: &HookEventName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HookEventName

fn eq(&self, other: &HookEventName) -> 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 PartialOrd for HookEventName

fn partial_cmp(&self, other: &HookEventName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for HookEventName

impl TryFrom<&str> for HookEventName

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<HookEventName, <Self as TryFrom<&str>>::Error>

Performs the conversion.