Struct HookDef 

pub struct HookDef {
    pub name: String,
    pub role: Role,
    pub runner: Runner,
    pub timeout: u64,
    pub env: Vec<String>,
    pub files: Vec<String>,
    pub definition: Value,
}

One [hooks.<name>] table.

Fields

name: String

The table’s name.

role: Role

Gate or observer.

runner: Runner

What it runs.

timeout: u64

Seconds before it is stopped.

env: Vec<String>

Variable names passed through the scrubbed environment.

files: Vec<String>

More files it depends on (its configuration, scripts a shell line runs): digested with it, never writable by the model.

definition: Value

The table as canonical JSON: what a digest and a trust prompt cover.

Implementations

impl HookDef

pub const fn at(&self) -> Option<Point>

The point this gate stands at; None for an observer.

pub fn hears(&self, event: &str) -> bool

Whether this observer hears event.

pub fn listens(&self) -> String

What it guards or hears, in words: before tick, hears task.ticked, task.stopped.

pub fn argv(&self) -> Option<&[String]>

The command it runs, if it runs one.

Trait Implementations

impl Clone for HookDef

fn clone(&self) -> HookDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookDef

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

Formats the value using the given formatter.

impl PartialEq for HookDef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HookDef