Struct V2ipDecoderState 

pub struct V2ipDecoderState(/* private fields */);

The health state of a V2IP decoder.

Implementations

impl V2ipDecoderState

pub const UNKNOWN: Self

The sink has not reported a state.

pub const HEALTHY: Self

Decoding normally.

pub const BAD: Self

Failed to decode.

pub const STARTING: Self

Still coming up, which any sink subscribed to during a route change reports.

pub const fn from_wire(value: u8) -> Self

Wraps a raw wire value, including one this library has no name for.

pub const fn to_wire(self) -> u8

Returns the raw wire value.

pub const fn is_settled(self) -> bool

Reports whether the decoder has reached a verdict.

Only healthy and bad are verdicts. Testing for failure as “not healthy” reads a receiver that is merely coming up as one that failed to decode, which is what a sink reports for a moment after every route change.

Trait Implementations

impl Clone for V2ipDecoderState

fn clone(&self) -> V2ipDecoderState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for V2ipDecoderState

impl Debug for V2ipDecoderState

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

Formats the value using the given formatter.

impl Default for V2ipDecoderState

fn default() -> V2ipDecoderState

Returns the “default value” for a type.

impl Display for V2ipDecoderState

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

Formats the value using the given formatter.

impl Eq for V2ipDecoderState

impl Hash for V2ipDecoderState

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 Ord for V2ipDecoderState

fn cmp(&self, other: &V2ipDecoderState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for V2ipDecoderState

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for V2ipDecoderState

fn partial_cmp(&self, other: &V2ipDecoderState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for V2ipDecoderState