Struct Candidate 

pub struct Candidate {
    pub foundation: Foundation,
    pub component: ComponentId,
    pub transport: Transport,
    pub priority: Priority,
    pub address: IpAddr,
    pub port: u16,
    pub kind: CandidateType,
    pub related: Option<RelatedAddress>,
    pub extensions: Vec<(String, String)>,
}

One a=candidate line (RFC 8839 §5.1). Media-level.

Fields

foundation: Foundation

The foundation.

component: ComponentId

Which component of the stream this candidate is for.

transport: Transport

The transport. Always Transport::Udp; see the type.

priority: Priority

The priority, range-checked on parse.

address: IpAddr

The transport address.

port: u16

The port.

kind: CandidateType

How the candidate was obtained.

related: Option<RelatedAddress>

The raddr/rport pair.

RFC 8839 §5.1 requires it for srflx, prflx and relay and forbids it for host, and a candidate sipx generates must obey that. It is not enforced when reading: §5.1 gives the field to “diagnostics”, nothing in RFC 8445’s checks consults it, and dropping a peer’s only working candidate over a diagnostic field would trade a call for a nicety. A privacy-preserving agent writes 0.0.0.0/:: and port 9 here, which is ordinary.

extensions: Vec<(String, String)>

cand-extension name/value pairs sipx does not model, in the order they arrived.

Kept rather than dropped, the same discipline crate::session applies to unknown SDP lines one level up: §5.1 says unknown extensions MUST be ignored, and ignoring an extension is not the same as deleting it from a description that is about to be relayed.

Implementations

impl Candidate

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

Read an a=candidate value.

None means ignore this line and keep the description — RFC 8839 §5.1’s rule for a candidate carrying an FQDN or an address family the agent does not support, and by the same argument for a transport or candidate type sipx cannot check over. It also covers a line that is simply malformed, because the outcome the peer needs is identical.

pub fn to_value(&self) -> String

Render as an a=candidate value.

Trait Implementations

impl Clone for Candidate

fn clone(&self) -> Candidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Candidate

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

Formats the value using the given formatter.

impl PartialEq for Candidate

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

impl StructuralPartialEq for Candidate