FaultLatch

Struct FaultLatch 

Source
pub struct FaultLatch { /* private fields */ }
Expand description

A one-shot, first-writer-wins fault flag.

Constructible in a test so the global is never a shared fixture — a latch is by design irreversible, which would make one global instance a cross-test dependency.

Implementations§

Source§

impl FaultLatch

Source

pub const fn new() -> Self

Source

pub fn latch(&self, reason: impl Into<String>) -> bool

Record a fatal fault. Returns true iff this call was the first — the caller uses that to log and to trigger shutdown exactly once.

Source

pub fn fault(&self) -> Option<&str>

The reason for the fault, or None if healthy.

Source

pub fn is_faulted(&self) -> bool

Cheap health check — one acquire load.

Trait Implementations§

Source§

impl Debug for FaultLatch

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FaultLatch

Source§

fn default() -> FaultLatch

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.