Struct HaltSignal 

pub struct HaltSignal { /* private fields */ }

A thread-safe halt signal the kernel registers with the writer.

The writer thread fires the callback once on the first unrecoverable condition; the kernel polls HaltSignal::is_halted and converts it into a typed kernel shutdown rather than letting the writer-thread error escape as a panic.

Implementations

impl HaltSignal

pub fn new() -> Self

Constructs a fresh, un-fired halt signal.

pub fn callback(&self) -> HaltCallback

Returns the HaltCallback the writer fires when an unrecoverable condition occurs.

The callback records the HaltReason (preserving only the first one when multiple submits race past the halt threshold) and then flips the halted flag, so a poller that observes is_halted() never reads back an empty reason.

pub fn is_halted(&self) -> bool

Returns whether the writer has signaled fail-stop.

pub fn reason(&self) -> Option<HaltReason>

Returns the HaltReason recorded on the first fail-stop, if any.

Calling this does not clear the signal; the kernel’s halted flag remains set so subsequent submits surface as fail-stopped.

Trait Implementations

impl Clone for HaltSignal

fn clone(&self) -> HaltSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HaltSignal

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

Formats the value using the given formatter.

impl Default for HaltSignal

fn default() -> Self

Returns the “default value” for a type.