Struct ICECandidate

pub struct ICECandidate {
    pub candidate: String,
    pub sdp_mid: Option<String>,
    pub sdp_mline_index: Option<u16>,
    pub username_fragment: Option<String>,
}

ICECandidate is used to serialize ice candidates

https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate/RTCIceCandidate#candidateinfo

Fields

candidate: String

A string describing the properties of the candidate, taken directly from the SDP attribute “candidate”. The candidate string specifies the network connectivity information for the candidate. If the candidate is an empty string (“”), the end of the candidate list has been reached; this candidate is known as the “end-of-candidates” marker.SDP string describing the properties of the candidate

sdp_mid: Option<String>

An optional string containing the identification tag of the media stream with which the candidate is associated

sdp_mline_index: Option<u16>

A number property containing the zero-based index of the m-line with which the candidate is associated, within the SDP of the media description, or None if no such associated exists.

username_fragment: Option<String>

A string containing the username fragment (usually referred to in shorthand as “ufrag” or “ice-ufrag”). This fragment, along with the ICE password (“ice-pwd”), uniquely identifies a single ongoing ICE interaction (including for any communication with the STUN server).

The string is generated by WebRTC at the beginning of the session. It may be up to 256 characters long, and at least 24 bits must contain random data. It has no default value and is not present unless set explicitly.

Trait Implementations

impl Clone for ICECandidate

fn clone(&self) -> ICECandidate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ICECandidate

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

Formats the value using the given formatter.

impl Default for ICECandidate

fn default() -> ICECandidate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ICECandidate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ICECandidate> for RTCIceCandidateInit

fn from(value: ICECandidate) -> Self

Converts to this type from the input type.

impl From<RTCIceCandidateInit> for ICECandidate

fn from(value: RTCIceCandidateInit) -> Self

Converts to this type from the input type.

impl Hash for ICECandidate

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 ICECandidate

fn eq(&self, other: &ICECandidate) -> 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 ICECandidate

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 ICECandidate

impl StructuralPartialEq for ICECandidate