Enum AlarmCause 

pub enum AlarmCause {
    SampleRed,
    WindowMissed,
    LoopDead,
    UnconfirmedUnknown,
}

Cause carried on the ONE alarm path (design brief R4.2).

From the invariant’s view a missed window and a failed sample are the same event — the invariant is not confirmed held — so cause is a FIELD on the alarm, never a separate alarm channel. The set is closed and additive: trigger selectors (Leg 3) arm on named causes as ALLOWLISTS (R5.2a), so an unforeseen cause fails safe by not firing anything.

Variants

SampleRed

The loop ran and produced unconfirmed/red samples past tolerance.

WindowMissed

The loop missed its declared cadence window(s) past tolerance — the engine-side dead-man switch (R4.3), which also covers the hung iteration (R3.3a): an iteration that produces no terminal by its next window is a missed window, never waited on.

LoopDead

The engine positively knows the loop cannot run: its run is terminal without a declared retirement, or its history is gone. Triggers must never arm remediation on this cause (R5.3) — it means watching stopped.

UnconfirmedUnknown

Duration-form tolerance expired with no evidence either way: no sample arrived and no window exists to miss (a signal-armed loop gone silent — the R2.4a silent-death family). Named per the brief’s own read-time vocabulary (“unconfirmed-unknown”, R2.5a).

Trait Implementations

impl Clone for AlarmCause

fn clone(&self) -> AlarmCause

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AlarmCause

impl Debug for AlarmCause

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AlarmCause

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AlarmCause

impl Hash for AlarmCause

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 PartialEq for AlarmCause

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AlarmCause

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AlarmCause

impl TS for AlarmCause

type WithoutGenerics = AlarmCause

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = AlarmCause

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.