Struct Candidate 

pub struct Candidate { /* private fields */ }

ICE candidates are network addresses used to connect to a peer.

There are different kinds of ICE candidates. The simplest kind is a host candidate which is a socket address on a local (host) network interface.

Implementations

impl Candidate

pub fn builder() -> CandidateBuilder<NoProtocol, NoRoute>

Starts the typesafe builder.

Example

let addr: SocketAddr = "192.168.1.1:12345".parse().unwrap();

// A standard UDP host candidate
let udp_host = Candidate::builder()
    .udp()
    .host(addr)
    .build()?;

// A TCP host candidate with a passive role
let tcp_host = Candidate::builder()
    .tcp()
    .host(addr)
    .tcptype(TcpType::Passive)
    .build()?;

pub fn host( addr: SocketAddr, proto: impl TryInto<Protocol>, ) -> Result<Self, IceError>

Creates a host ICE candidate.

Host candidates are local sockets directly on the host.

pub fn server_reflexive( addr: SocketAddr, base: SocketAddr, proto: impl TryInto<Protocol>, ) -> Result<Self, IceError>

Creates a server reflexive ICE candidate.

Server reflexive candidates are local sockets mapped to external ip discovered via a STUN binding request. The base is the local interface that this address corresponds to.

pub fn relayed( addr: SocketAddr, local: SocketAddr, proto: impl TryInto<Protocol>, ) -> Result<Self, IceError>

Creates a relayed ICE candidate.

Relayed candidates are server sockets relaying traffic to a local socket. Allocate a TURN addr to use as a local candidate.

• addr - The TURN server’s allocated address that will be used for relaying traffic. This is the address that will be used for communication with the peer.
• local - The local interface address that corresponds to this candidate. This is the address from which the TURN allocation request was sent.
• proto - The transport protocol to use (UDP, TCP, etc.).

pub fn from_sdp_string(s: &str) -> Result<Self, IceError>

Creates a new ICE candidate from a string.

pub fn prio(&self) -> u32

Returns the priority value for the specified ICE candidate.

The priority is a positive integer between 1 and 2^31 - 1 (inclusive), calculated according to the ICE specification defined in RFC 8445, Section 5.1.2.

pub fn addr(&self) -> SocketAddr

Returns the address for the specified ICE candidate.

pub fn proto(&self) -> Protocol

Returns a reference to the String containing the transport protocol of the ICE candidate. For example tcp/udp/..

pub fn tcptype(&self) -> Option<TcpType>

Returns the candidate’s TCP role. Refer to TcpType for more details.

pub fn kind(&self) -> CandidateKind

Returns the kind of this candidate.

pub fn to_sdp_string(&self) -> String

Generates a candidate attribute string.

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<'de> Deserialize<'de> for Candidate

Deserialize Candidate from a candidate info.

Similar to Candidate::serialize, we drop sdpMid and sdpMLineIndex when parsing.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Candidate

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

Formats the value using the given formatter.

impl Hash for Candidate

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

Serialize Candidate into candidate info.

Always set sdpMid to null and sdpMLineIndex to 0, as we only support one media line.

e.g. serde_json would produce:

{
 "candidate": "candidate:12044049749558888150 1 udp 2130706175 1.2.3.4 1234 typ host",
 "sdpMid": null,
 "sdpMLineIndex": 0
 "usernameFragment": "ufrag"
}

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Candidate

impl StructuralPartialEq for Candidate