Struct CandidatePair 

pub struct CandidatePair {
    pub id: PairId,
    pub local: LocalId,
    pub remote: RemoteId,
    pub component: ComponentId,
    pub foundation: PairFoundation,
    pub priority: u64,
    pub state: PairState,
    pub nominated: bool,
}

One entry in a checklist (§6.1.2.2, figure 5).

Fields

id: PairId

Its identity.

local: LocalId

The local candidate, by index into the agent’s table.

remote: RemoteId

The remote candidate, by index into the agent’s table.

component: ComponentId

The component both candidates are for.

foundation: PairFoundation

The combination of the two candidates’ foundations.

priority: u64

§6.1.2.3’s pair priority. Recomputed on every role change, because G and D swap.

state: PairState

Its state.

nominated: bool

Whether a check on this pair carried USE-CANDIDATE and succeeded (§7.2.5.3.4).

Implementations

impl CandidatePair

pub const fn is_discardable(&self) -> bool

Whether §6.1.2.5 may discard this pair.

A pair with a check in flight or a check that succeeded is holding state outside the checklist — a transaction, or an entry in the valid list — and removing it silently would lose that rather than bound anything.

Trait Implementations

impl Clone for CandidatePair

fn clone(&self) -> CandidatePair

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandidatePair

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

Formats the value using the given formatter.

impl PartialEq for CandidatePair

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CandidatePair

impl StructuralPartialEq for CandidatePair