Struct ruma_events::call::candidates::CandidatesEvent

pub struct CandidatesEvent {
    pub content: CandidatesEventContent,
    pub event_id: EventId,
    pub origin_server_ts: SystemTime,
    pub room_id: Option<RoomId>,
    pub sender: UserId,
    pub unsigned: UnsignedData,
}

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

content: CandidatesEventContent

The event's content.

event_id: EventId

The unique identifier for the event.

origin_server_ts: SystemTime

Time on originating homeserver when this event was sent.

room_id: Option<RoomId>

The unique identifier for the room associated with this event.

sender: UserId

The unique identifier for the user who sent this event.

unsigned: UnsignedData

Additional key-value pairs not signed by the homeserver.

Trait Implementations

impl Clone for CandidatesEvent

fn clone(&self) -> CandidatesEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CandidatesEvent

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

Formats the value using the given formatter.

impl Event for CandidatesEvent

type Content = CandidatesEventContent

The type of this event's content field.

fn content(&self) -> &Self::Content

The event's content.

fn event_type(&self) -> EventType

The type of the event.

impl From<CandidatesEvent> for Event

fn from(event: CandidatesEvent) -> Self

Performs the conversion.

impl From<CandidatesEvent> for RoomEvent

fn from(event: CandidatesEvent) -> Self

Performs the conversion.

impl From<CandidatesEvent> for RoomEvent

fn from(event: CandidatesEvent) -> Self

Performs the conversion.

impl FromRaw for CandidatesEvent

type Raw = CandidatesEvent

The raw type.

fn from_raw(raw: CandidatesEvent) -> Self

Converts the raw type to Self.

impl RoomEvent for CandidatesEvent

fn event_id(&self) -> &EventId

The unique identifier for the event.

fn origin_server_ts(&self) -> SystemTime

Time on originating homeserver when this event was sent.

fn room_id(&self) -> Option<&RoomId>

The unique identifier for the room associated with this event.

This can be None if the event came from a context where there is no ambiguity which room it belongs to, like a /sync response for example.

fn sender(&self) -> &UserId

The unique identifier for the user who sent this event.

fn unsigned(&self) -> &UnsignedData

Additional key-value pairs not signed by the homeserver.

impl Serialize for CandidatesEvent

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

Serialize this value into the given Serde serializer.