Struct Candidate 

pub struct Candidate { /* private fields */ }

An ICE candidate.

Implementations

impl Candidate

pub fn builder( component_id: usize, ctype: CandidateType, ttype: TransportType, foundation: &str, address: Address, ) -> CandidateBuilder

Builds the candidate

Examples

let addr: Address = "127.0.0.1:2345".parse().unwrap();
let candidate = Candidate::builder(
    1,
    CandidateType::Host,
    TransportType::Udp,
    "foundation",
    addr,
)
.priority(1234)
.build();
assert_eq!(candidate.to_sdp_string(), "a=candidate:foundation 1 UDP 1234 127.0.0.1 2345 typ host")

pub fn to_owned(&self) -> CandidateOwned

Copy this candidate into a heap allocated CandidateOwned.

pub fn to_sdp_string(&self) -> String

Serialize this candidate to a string for use in SDP

Examples

let addr: Address = "127.0.0.1:2345".parse().unwrap();
let candidate = Candidate::builder(
    1,
    CandidateType::Host,
    TransportType::Udp,
    "foundation",
    addr,
)
.priority(1234)
.build();
assert_eq!(candidate.to_sdp_string(), "a=candidate:foundation 1 UDP 1234 127.0.0.1 2345 typ host")

pub fn from_sdp_string(s: &str) -> Result<Candidate, ParseCandidateError>

Parse an SDP candidate string into a candidate.

Trait Implementations

impl CandidateApi for Candidate

fn component_id(&self) -> usize

The component

fn candidate_type(&self) -> CandidateType

The type of the Candidate

fn transport(&self) -> TransportType

The network transport

fn foundation(&self) -> String

The (unique) foundation

fn priority(&self) -> u32

The priority

fn address(&self) -> Address

The address to send to

fn base_address(&self) -> Address

The address to send from

fn related_address(&self) -> Option<Address>

Any related address that generated this candidate, e.g. STUN/TURN server

fn tcp_type(&self) -> TcpType

The type of TCP candidate

impl Clone for Candidate

fn clone(&self) -> Self

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

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Candidate> for CandidateOwned

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 PartialEq<CandidateOwned> for Candidate

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

impl Sync for Candidate