Struct ruma_events::call::candidates::CallCandidatesEventContent

#[non_exhaustive]
pub struct CallCandidatesEventContent {
    pub call_id: OwnedVoipId,
    pub party_id: Option<OwnedVoipId>,
    pub candidates: Vec<Candidate>,
    pub version: VoipVersionId,
}

The content of an m.call.candidates event.

This event is sent by callers after sending an invite and by the callee after answering. Its purpose is to give the other party additional ICE candidates to try using to communicate.

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.

call_id: OwnedVoipId

A unique identifier for the call.

party_id: Option<OwnedVoipId>

Required in VoIP version 1. The unique ID for this session for the duration of the call.

Must be the same as the one sent by the previous invite or answer from this session.

candidates: Vec<Candidate>

A list of candidates.

In VoIP version 1, this list should end with a Candidate with an empty candidate field when no more candidates will be sent.

version: VoipVersionId

The version of the VoIP specification this messages adheres to.

Implementations

impl CallCandidatesEventContent

pub fn new( call_id: OwnedVoipId, candidates: Vec<Candidate>, version: VoipVersionId, ) -> Self

Creates a new CallCandidatesEventContent with the given call id, candidate list and VoIP version.

pub fn version_0(call_id: OwnedVoipId, candidates: Vec<Candidate>) -> Self

Convenience method to create a VoIP version 0 CallCandidatesEventContent with all the required fields.

pub fn version_1( call_id: OwnedVoipId, party_id: OwnedVoipId, candidates: Vec<Candidate>, ) -> Self

Convenience method to create a VoIP version 1 CallCandidatesEventContent with all the required fields.

Trait Implementations

impl Clone for CallCandidatesEventContent

fn clone(&self) -> CallCandidatesEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallCandidatesEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallCandidatesEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for CallCandidatesEventContent

type EventType = MessageLikeEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> Self::EventType

Get the event’s type, like m.room.message.

impl From<CallCandidatesEventContent> for AnyMessageLikeEventContent

fn from(c: CallCandidatesEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for CallCandidatesEventContent

type Redacted = RedactedCallCandidatesEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedCallCandidatesEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for CallCandidatesEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticEventContent for CallCandidatesEventContent

const TYPE: &'static str = "m.call.candidates"

The event type.

impl MessageLikeEventContent for CallCandidatesEventContent