Enum Negotiation 

pub enum Negotiation {
    Absent,
    Ice {
        credentials: Credentials,
        candidates: Vec<Candidate>,
        lite: bool,
    },
    Mismatch,
}

What a peer’s description says about ICE for one stream.

Variants

Absent

No usable a=candidate: the peer is not doing ICE (spec §13.3).

Nothing is offered back, no check is sent, no timer runs, and the stream is carried by symmetric RTP exactly as it is today. This is the common case and must stay the common case — a stack that requires ICE to place a call has regressed.

Ice

ICE is on for this stream, with these parameters.

Fields

credentials: Credentials

The peer’s a=ice-ufrag and a=ice-pwd, media level winning over session level (RFC 8839 §5.4).

candidates: Vec<Candidate>

Its a=candidate lines, in the order they appeared.

lite: bool

Whether the session carried a=ice-lite (§5.3). A full agent facing a lite one controls unconditionally (RFC 8445 §6.1.1).

Mismatch

RFC 8839 §5.3: the offer’s default destination for a component matched none of its candidates for that component.

The answer carries ICE_MISMATCH for the stream and ICE MUST NOT be used for it; the stream falls back to RFC 3264 — which is to say to Negotiation::Absent’s behaviour, arrived at by a different route and reported differently, because the offerer needs to know that something between the two of us rewrote the address it advertised.

Implementations

impl Negotiation

pub const fn runs_ice(&self) -> bool

Whether an agent should be driven for this stream.

pub fn answer_attributes(&self) -> Vec<Attribute>

The attributes this decision adds to the answer’s media section.

Only §5.3’s flag today: the ICE attributes an answer carries for a stream that is doing ICE are the local description’s (super::LocalDescription::attributes), not the remote’s, so they come from the other side of the exchange.

Trait Implementations

impl Clone for Negotiation

fn clone(&self) -> Negotiation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Negotiation

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

Formats the value using the given formatter.

impl PartialEq for Negotiation

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

impl StructuralPartialEq for Negotiation