Struct Candidate 

pub struct Candidate {
    pub component: u8,
    pub foundation: String,
    pub generation: u8,
    pub id: String,
    pub ip: IpAddr,
    pub port: u16,
    pub priority: u32,
    pub protocol: String,
    pub rel_addr: Option<IpAddr>,
    pub rel_port: Option<u16>,
    pub network: Option<u8>,
    pub type_: Type,
}

A candidate for an ICE-UDP session.

Fields

component: u8

A Component ID as defined in ICE-CORE.

foundation: String

A Foundation as defined in ICE-CORE.

generation: u8

An index, starting at 0, that enables the parties to keep track of updates to the candidate throughout the life of the session.

id: String

A unique identifier for the candidate.

ip: IpAddr

The Internet Protocol (IP) address for the candidate transport mechanism; this can be either an IPv4 address or an IPv6 address.

port: u16

The port at the candidate IP address.

priority: u32

A Priority as defined in ICE-CORE.

protocol: String

The protocol to be used. The only value defined by this specification is “udp”.

rel_addr: Option<IpAddr>

A related address as defined in ICE-CORE.

rel_port: Option<u16>

A related port as defined in ICE-CORE.

network: Option<u8>

An index, starting at 0, referencing which network this candidate is on for a given peer.

type_: Type

A Candidate Type as defined in ICE-CORE.

Trait Implementations

impl AsXml for Candidate

type ItemIter<'xso_proc_as_xml_iter_lifetime> = CandidateAsXmlIterator<'xso_proc_as_xml_iter_lifetime>

The iterator type.

fn as_xml_iter(&self) -> Result<Self::ItemIter<'_>, Error>

Return an iterator which emits the contents of the struct or enum as serialisable Item items.

fn as_xml_dyn_iter<'x>( &'x self, ) -> Result<Box<dyn Iterator<Item = Result<Item<'x>, Error>> + 'x>, Error>

Return the same iterator as as_xml_iter, but boxed to erase the concrete iterator type.

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 From<&Candidate> for Element

fn from(other: &Candidate) -> Self

Converts to this type from the input type.

impl From<Candidate> for Element

fn from(other: Candidate) -> Self

Converts to this type from the input type.

impl FromXml for Candidate

type Builder = CandidateFromXmlBuilder

A builder type used to construct the element.

fn from_events( name: QName, attrs: AttrMap, ctx: &Context<'_>, ) -> Result<Self::Builder, FromEventsError>

Attempt to initiate the streamed construction of this struct from XML.

fn xml_name_matcher() -> XmlNameMatcher<'static>

Return a predicate which determines if Self may be parsed from a given XML element.

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 TryFrom<Element> for Candidate

type Error = FromElementError

The type returned in the event of a conversion error.

fn try_from(other: Element) -> Result<Self, FromElementError>

Performs the conversion.

impl StructuralPartialEq for Candidate