Struct Candidate 

pub struct Candidate {
    pub foundation: String,
    pub component_id: u32,
    pub transport: String,
    pub priority: u64,
    pub address: CandidateAddress,
    pub port: u16,
    pub typ: CandidateType,
    pub rel_addr: Option<IpAddr>,
    pub rel_port: Option<u16>,
    pub extensions: Vec<(String, String)>,
}

ICE Candidate attribute of the media

See RFC 8839 Section 5.1

Fields

foundation: String

Arbitrary string used in the freezing algorithm to group similar candidates See RFC 8445 Section 5.1.1.3

component_id: u32

Identifies the specific component of the data stream 1 for RTP and 2 for RTCP

transport: String

Transport protocol of the candidate

priority: u64

Candidate’s priority

address: CandidateAddress

IP address of the candidate IPv4, IPv6 addresses and FQDN allowed

port: u16

Port of the candidate

typ: CandidateType

Type of the candidate

rel_addr: Option<IpAddr>

Address related to the candidate Required for srflx, prflx and relay type candidates

rel_port: Option<u16>

Port related to the candidate Required for srflx, prflx and relay type candidates

extensions: Vec<(String, String)>

Extensions

Implementations

impl Candidate

pub fn new( foundation: impl ToString, component_id: u32, transport: impl ToString, priority: u64, address: CandidateAddress, port: u16, typ: CandidateType, ) -> Self

pub fn with_rel_addr( foundation: impl ToString, component_id: u32, transport: impl ToString, priority: u64, address: CandidateAddress, port: u16, typ: CandidateType, rel_addr: impl Into<IpAddr>, ) -> Self

pub fn with_rel_addr_and_port( foundation: impl ToString, component_id: u32, transport: impl ToString, priority: u64, address: CandidateAddress, port: u16, typ: CandidateType, rel_addr: impl Into<IpAddr>, rel_port: u16, ) -> Self

pub fn set_rel_addr(&mut self, rel_addr: impl Into<IpAddr>)

pub fn set_rel_port(&mut self, rel_port: u16)

pub fn add_extension(&mut self, name: impl ToString, value: impl ToString)

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

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

Formats the value using the given formatter.

impl Eq for Candidate

impl FromStr for Candidate

type Err = AttributeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Candidate

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Candidate

impl TypedAttribute for Candidate

const NAME: &'static str = "candidate"