Struct V2ipDecoderReason 

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

Why a decoder reports the state it does.

The primary cause only. Several causes can be true at once, and which of them lands here is a fixed priority order in the firmware that the numbering does not express: these values are identities, not ranks, and comparing or ordering them says nothing. Ask V2ipDecoderReport::has_cause whether a particular cause applies - a test against this field answers “is this the one that won” instead, which is a different question.

Firmware adds causes, so the wire value is carried as it arrived: folding an unrecognised one onto a named cause would report a fault this library invented. Appending one cannot reorder the existing priorities.

Implementations

impl V2ipDecoderReason

pub const OK: Self

Decoding normally.

pub const NO_PACKETS: Self

No packets are arriving.

pub const PACKETS_DEGRADED: Self

Packets are arriving, degraded.

pub const NO_FORMAT: Self

No format could be recovered from the codestream.

pub const FORMAT_MISMATCH: Self

The recovered format is not the one the sink is configured for.

pub const FORMAT_REJECTED: Self

The configured output format was refused.

pub const DECODER_BLOCKED: Self

The converter watchdog is holding the stream back.

pub const SWITCH_PENDING: Self

A source switch is in progress: a step in an operation someone asked for, rather than a fault.

pub const PTP_UNLOCKED: Self

PTP is unlocked. That costs audio alone; the picture is unaffected.

pub const TX_BRIDGE_UNLOCKED: Self

The pipeline is rebuilding after the HDMI transmitter stayed unlocked.

The picture is down, and has been for five seconds before this can appear: the sender debounces the unlocked reading for that long, so this never reports a transient. Unlike Self::SWITCH_PENDING nobody asked for it.

The debounce restarts each time it elapses, so this holding across reports is a restart loop rather than one event, and that is what to escalate on.

It sits near the bottom of the priority order, below every input-side cause, so a rebuilding pipeline names one of those in V2ipDecoderReport::reason and carries this in V2ipDecoderReport::flags alone - always, rather than briefly.

It is evaluated only while no format change is in progress. Across a switch it holds its previous value and clears on the first reading after the change settles, which V2ipDecoderReport::updates cannot distinguish: a value carried forward is still a stored reading.

pub const IDLE: Self

The sink is configured but switched off, so no stream is expected.

This outranks every other cause: whenever it applies it is what V2ipDecoderReport::reason carries.

The causes beneath it stay set in V2ipDecoderReport::flags. A sink switched off while it was running keeps the bits the decoder genuinely observed on the way down - no packets, no format - so a classifier that tests a fault mask over the whole word calls a deliberately disabled sink broken. Ask for this cause first and stop there; the bits below it describe what was seen, not a fault to report.

This says nothing about geometry, in either direction. The decoder reports what it currently detects whatever the cause, so a switched-off sink still detecting a codestream carries a real geometry, and a zero one means the decoder has nothing rather than that the sink is off.

Older senders never report this and give Self::NO_PACKETS for a disabled sink instead, indistinguishable from one whose source has died. So an absent Self::IDLE is not evidence a sink is enabled, and nothing in this block answers enablement: it carries no such field, and the answer comes from V2IP_DEVICE_CFG or the device’s HTTP status.

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.

Trait Implementations

impl Clone for V2ipDecoderReason

fn clone(&self) -> V2ipDecoderReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for V2ipDecoderReason

impl Debug for V2ipDecoderReason

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

Formats the value using the given formatter.

impl Default for V2ipDecoderReason

fn default() -> V2ipDecoderReason

Returns the “default value” for a type.

impl Display for V2ipDecoderReason

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

Formats the value using the given formatter.

impl Eq for V2ipDecoderReason

impl Hash for V2ipDecoderReason

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 V2ipDecoderReason

fn cmp(&self, other: &V2ipDecoderReason) -> 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 V2ipDecoderReason

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for V2ipDecoderReason

fn partial_cmp(&self, other: &V2ipDecoderReason) -> 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 V2ipDecoderReason