Struct matrix_sdk_base::ruma::events::call::candidates::Candidate

#[non_exhaustive]
pub struct Candidate {
    pub candidate: String,
    pub sdp_mid: Option<String>,
    pub sdp_m_line_index: Option<UInt>,
}

An ICE (Interactive Connectivity Establishment) candidate.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

candidate: String

The SDP “a” line of the candidate.

sdp_mid: Option<String>

The SDP media type this candidate is intended for.

At least one of sdp_mid or sdp_m_line_index is required, unless candidate is empty.

sdp_m_line_index: Option<UInt>

The index of the SDP “m” line this candidate is intended for.

At least one of sdp_mid or sdp_m_line_index is required, unless candidate is empty.

Implementations

impl Candidate

pub fn new(candidate: String) -> Candidate

Creates a new Candidate with the given “a” line.

pub fn version_0( candidate: String, sdp_mid: String, sdp_m_line_index: UInt, ) -> Candidate

Creates a new Candidate with all the required fields in VoIP version 0.

Trait Implementations

impl Clone for Candidate

fn clone(&self) -> Candidate

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Candidate

fn deserialize<__D>( __deserializer: __D, ) -> Result<Candidate, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Candidate

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.