Enum TrainingError 

#[non_exhaustive]
pub enum TrainingError<ScdcErr, PhyErr> {
    #[non_exhaustive]
    Scdc {
        error: ScdcErr,
        exit: TmdsExit<ScdcErr, PhyErr>,
    },
    #[non_exhaustive]
    Phy {
        error: PhyErr,
        exit: TmdsExit<ScdcErr, PhyErr>,
    },
    #[non_exhaustive]
    ExitFailed {
        reason: FallbackReason,
        error: ExitError<ScdcErr, PhyErr>,
    },
    #[non_exhaustive]
    InvalidRates {
        index: usize,
        rate: HdmiForumFrl,
    },
    NoRates,
}

Hard error that terminated a training attempt.

Distinct from TrainingOutcome::FallbackRequired: this means something failed — an SCDC or PHY operation, or a rate list the procedure cannot run (InvalidRates, NoRates) — not that the link simply did not train.

After an SCDC or PHY error, plumbob performs LTS:L, returning both ends to TMDS as after a fallback, unless TrainingConfig::exit_to_tmds_on_error is off or the sink had set FLT_no_timeout (the link is then held for the test equipment, as with TrainingOutcome::NoTimeoutHold). exit says what happened. When LTS:L itself fails after a fallback, the error is ExitFailed.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

Scdc

The ScdcClient returned an error.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

error: ScdcErr

The error.

exit: TmdsExit<ScdcErr, PhyErr>

LTS:L after the error.

#[non_exhaustive]

Phy

The PHY returned an error.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

error: PhyErr

The error.

exit: TmdsExit<ScdcErr, PhyErr>

LTS:L after the error.

#[non_exhaustive]

ExitFailed

The attempt fell back for reason, and LTS:L then failed.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

reason: FallbackReason

Why the attempt fell back.

error: ExitError<ScdcErr, PhyErr>

LTS:L’s errors.

#[non_exhaustive]

InvalidRates

The rate list cannot be trained over, so nothing was done: no SCDC or PHY operation was performed. Every rate must be an FRL rate (not NotSupported), and each must be strictly lower than the one before it, because LTS:4 steps down.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

index: usize

The position of the first offending rate in the list.

rate: HdmiForumFrl

That rate.

NoRates

The rate list is empty, so there is nothing to train at and nothing was done: no SCDC or PHY operation was performed, and the link is as it was. A caller with no FRL rate to try (a sink without FRL, for example) does not train; to take down an earlier FRL link it calls FrlTrainer::exit_to_tmds.

Trait Implementations

impl<ScdcErr, PhyErr> Clone for TrainingError<ScdcErr, PhyErr>

where ScdcErr: Clone, PhyErr: Clone,

fn clone(&self) -> TrainingError<ScdcErr, PhyErr>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ScdcErr, PhyErr> Copy for TrainingError<ScdcErr, PhyErr>

where ScdcErr: Copy, PhyErr: Copy,

impl<ScdcErr, PhyErr> Debug for TrainingError<ScdcErr, PhyErr>

where ScdcErr: Debug, PhyErr: Debug,

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

Formats the value using the given formatter.

impl<ScdcErr, PhyErr> Eq for TrainingError<ScdcErr, PhyErr>

where ScdcErr: Eq, PhyErr: Eq,

impl<ScdcErr, PhyErr> PartialEq for TrainingError<ScdcErr, PhyErr>

where ScdcErr: PartialEq, PhyErr: PartialEq,

fn eq(&self, other: &TrainingError<ScdcErr, PhyErr>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<ScdcErr, PhyErr> StructuralPartialEq for TrainingError<ScdcErr, PhyErr>

where ScdcErr: PartialEq, PhyErr: PartialEq,