Struct ruma::events::call::candidates::CallCandidatesEventContent

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

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)§

This struct is marked as 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§

source§

impl CallCandidatesEventContent

source

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

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

source

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

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

source

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

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

Trait Implementations§

source§

impl Clone for CallCandidatesEventContent

source§

fn clone(&self) -> CallCandidatesEventContent

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CallCandidatesEventContent

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl EventContent for CallCandidatesEventContent

§

type EventType = MessageLikeEventType

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

fn event_type(&self) -> <CallCandidatesEventContent as EventContent>::EventType

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

impl From<CallCandidatesEventContent> for AnyMessageLikeEventContent

source§

fn from(c: CallCandidatesEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.
source§

impl RedactContent for CallCandidatesEventContent

§

type Redacted = RedactedCallCandidatesEventContent

The redacted form of the event’s content.
source§

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

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

impl Serialize for CallCandidatesEventContent

source§

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. Read more
source§

impl StaticEventContent for CallCandidatesEventContent

source§

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

The event type.
source§

impl MessageLikeEventContent for CallCandidatesEventContent

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> EventContentFromType for T

source§

fn from_parts(_event_type: &str, content: &RawValue) -> Result<T, Error>

Constructs this event content from the given event type and JSON.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,