Enum HookControl 

#[non_exhaustive]
pub enum HookControl {
    Proceed,
    Break {
        reason: StopReason,
    },
    Continue,
    Skip,
}

A hook’s instruction for control flow (axis two). Data injection (axis one) goes through the step’s &mut fields, not here.

Which variants are meaningful depends on the hook point: Break is available at any step; Continue only at BeforeTurnEnd; Skip only at before Compact. The engine downgrades out-of-place variants with a warning (see the validation in apply_verdict).

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.

Proceed

No intervention in control flow — the step proceeds normally with any data changes already made on ctx. Corresponds to envelope control: null.

Break

End the current turn with a final stop reason. Usable from any step.

Fields

reason: StopReason

Continue

Does not end the turn; instead, loops back to the top of the cycle for another round. Only meaningful in BeforeTurnEnd (and must be injected beforehand).

Skip

Skip the actual call for this step. Only meaningful for before Compact (veto compaction).

Trait Implementations

impl Clone for HookControl

fn clone(&self) -> HookControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookControl

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

Formats the value using the given formatter.

impl Default for HookControl

fn default() -> HookControl

Returns the “default value” for a type.

impl Eq for HookControl

impl PartialEq for HookControl

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