Enum CandidateType 

pub enum CandidateType {
    Host,
    ServerReflexive,
    PeerReflexive,
    Relayed,
}

How a candidate was obtained (RFC 8839 §5.1, RFC 8445 §5.1.1).

Variants

Host

A local interface address.

ServerReflexive

An address a STUN server reported.

PeerReflexive

An address learned from a peer’s connectivity check.

Relayed

An address on a TURN relay.

Implementations

impl CandidateType

pub fn as_str(self) -> &'static str

The token as it appears in SDP.

pub fn parse(token: &str) -> Option<Self>

The type a token names, if it is one sipx knows.

candidate-types ends in token, so the set is extensible and a peer may name one sipx has never heard of. None here makes Candidate::parse ignore the line, which is the conservative reading rather than the only legal one: RFC 8839 §5.1 requires a document defining a new candidate type to define how it is processed, so a type sipx does not know is a type whose processing rules sipx does not have. Checking it as though it were a host candidate would be guessing at those rules against a peer that published them.

Trait Implementations

impl Clone for CandidateType

fn clone(&self) -> CandidateType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandidateType

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

Formats the value using the given formatter.

impl Hash for CandidateType

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 PartialEq for CandidateType

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

impl Eq for CandidateType

impl StructuralPartialEq for CandidateType