Struct HookContext 

pub struct HookContext {
    pub kind: Option<BreakKind>,
    pub duration_secs: Option<u64>,
    pub outcome: Option<String>,
}

Per-call context populated by the scheduler. Fields show up as $ENTRACTE_KIND, $ENTRACTE_DURATION_SECS, $ENTRACTE_OUTCOME when the hook child runs; empty when not applicable to the event.

Fields

kind: Option<BreakKind>

duration_secs: Option<u64>

outcome: Option<String>

Implementations

impl HookContext

pub fn empty() -> Self

No kind / duration / outcome — used for pause events.

pub fn with_kind(kind: BreakKind) -> Self

Carry just the break kind. Used for break_skipped / break_postponed.

pub fn with_kind_duration(kind: BreakKind, duration_secs: u64) -> Self

Carry the break kind plus its scheduled duration. Used for break_start.

pub fn with_kind_outcome(kind: BreakKind, outcome: impl Into<String>) -> Self

Carry the break kind plus an outcome string ("completed" / "dismissed"). Used for break_end.

Trait Implementations

impl Clone for HookContext

fn clone(&self) -> HookContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookContext

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

Formats the value using the given formatter.

impl Default for HookContext

fn default() -> HookContext

Returns the “default value” for a type.