Struct Candidate 

pub struct Candidate { /* private fields */ }

One ICE candidate: a transport address this agent can be reached at, or can reach a peer at, together with its type, priority and liveness bookkeeping.

Implementations

impl Candidate

pub fn foundation(&self) -> String

The candidate’s foundation, computed from its type, base address and transport.

pub fn id(&self) -> &str

Returns Candidate ID.

pub fn component(&self) -> u16

Returns candidate component.

pub fn set_component(&mut self, component: u16)

Sets candidate component.

pub fn last_received(&self) -> Instant

Returns a time indicating the last time this candidate was received.

pub fn last_sent(&self) -> Instant

Returns a time indicating the last time this candidate was sent.

pub fn network_type(&self) -> NetworkType

Returns candidate NetworkType.

pub fn address(&self) -> &str

Returns Candidate Address.

pub fn port(&self) -> u16

Returns Candidate Port.

pub fn priority(&self) -> u32

Computes the priority for this ICE Candidate.

pub fn related_address(&self) -> Option<CandidateRelatedAddress>

Returns Option<CandidateRelatedAddress>.

pub fn candidate_type(&self) -> CandidateType

Returns candidate type.

pub fn tcp_type(&self) -> TcpType

The TCP role for ICE-TCP candidates; Unspecified for UDP.

pub fn url(&self) -> Option<&str>

The STUN or TURN server this candidate was gathered from, if any.

pub fn marshal(&self) -> String

Returns the string representation of the ICECandidate.

pub fn addr(&self) -> SocketAddr

The candidate’s socket address.

pub fn base_addr(&self) -> SocketAddr

Returns the candidate’s base address: the local transport address the candidate was derived from, i.e. the address packets for this candidate must be sent from (RFC 8445 §5.1.1).

For server-reflexive and peer-reflexive candidates this is the related (host) address; for host and relay candidates the base is the candidate address itself.

pub fn seen(&mut self, outbound: bool)

Records traffic on this candidate, updating its last-sent or last-received time.

Feeds consent freshness — a pair that stops seeing traffic is eventually abandoned.

pub fn equal(&self, other: &Candidate) -> bool

Used to compare two candidateBases.

pub fn set_ip(&mut self, ip: &IpAddr) -> Result<()>

Sets the resolved IP, deriving the network type from it.

Errors

Fails if ip’s family does not match this candidate’s network type.

impl Candidate

pub fn set_last_received(&mut self, now: Instant)

Records that traffic was received on this candidate at now.

pub fn set_last_sent(&mut self, now: Instant)

Records that traffic was sent on this candidate at now.

pub fn local_preference(&self) -> u16

Returns the local preference for this candidate.

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 Default for Candidate

fn default() -> Self

Returns the “default value” for a type.

impl Display for Candidate

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

Formats the value using the given formatter.