#[non_exhaustive]pub struct CallHangupEventContent {
pub call_id: OwnedVoipId,
pub party_id: Option<OwnedVoipId>,
pub version: VoipVersionId,
pub reason: Reason,
}
Expand description
The content of an m.call.hangup
event.
Sent by either party to signal their termination of the call.
In VoIP version 0, this can be sent either once the call has been established or before to abort the call.
If the call is using VoIP version 1, this should only be sent by the caller after sending the
invite or by the callee after answering the invite. To reject an invite, send an
m.call.reject
event.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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. A 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.
version: VoipVersionId
The version of the VoIP specification this messages adheres to.
reason: Reason
Error reason for the hangup.
Defaults to Reason::UserHangup
.
Implementations§
Source§impl CallHangupEventContent
impl CallHangupEventContent
Sourcepub fn new(
call_id: OwnedVoipId,
version: VoipVersionId,
) -> CallHangupEventContent
pub fn new( call_id: OwnedVoipId, version: VoipVersionId, ) -> CallHangupEventContent
Creates a new CallHangupEventContent
with the given call ID and VoIP version.
Sourcepub fn version_0(call_id: OwnedVoipId) -> CallHangupEventContent
pub fn version_0(call_id: OwnedVoipId) -> CallHangupEventContent
Convenience method to create a VoIP version 0 CallHangupEventContent
with all the required
fields.
Sourcepub fn version_1(
call_id: OwnedVoipId,
party_id: OwnedVoipId,
reason: Reason,
) -> CallHangupEventContent
pub fn version_1( call_id: OwnedVoipId, party_id: OwnedVoipId, reason: Reason, ) -> CallHangupEventContent
Convenience method to create a VoIP version 1 CallHangupEventContent
with all the required
fields.
Trait Implementations§
Source§impl Clone for CallHangupEventContent
impl Clone for CallHangupEventContent
Source§fn clone(&self) -> CallHangupEventContent
fn clone(&self) -> CallHangupEventContent
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CallHangupEventContent
impl Debug for CallHangupEventContent
Source§impl<'de> Deserialize<'de> for CallHangupEventContent
impl<'de> Deserialize<'de> for CallHangupEventContent
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<CallHangupEventContent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<CallHangupEventContent, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Source§impl EventContent for CallHangupEventContent
impl EventContent for CallHangupEventContent
Source§type EventType = MessageLikeEventType
type EventType = MessageLikeEventType
Source§fn event_type(&self) -> <CallHangupEventContent as EventContent>::EventType
fn event_type(&self) -> <CallHangupEventContent as EventContent>::EventType
m.room.message
.Source§impl From<CallHangupEventContent> for AnyMessageLikeEventContent
impl From<CallHangupEventContent> for AnyMessageLikeEventContent
Source§fn from(c: CallHangupEventContent) -> AnyMessageLikeEventContent
fn from(c: CallHangupEventContent) -> AnyMessageLikeEventContent
Source§impl RedactContent for CallHangupEventContent
impl RedactContent for CallHangupEventContent
Source§type Redacted = RedactedCallHangupEventContent
type Redacted = RedactedCallHangupEventContent
Source§fn redact(self, version: &RoomVersionId) -> RedactedCallHangupEventContent
fn redact(self, version: &RoomVersionId) -> RedactedCallHangupEventContent
self
into a redacted form (removing most or all fields) according to the spec. Read moreSource§impl Serialize for CallHangupEventContent
impl Serialize for CallHangupEventContent
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl MessageLikeEventContent for CallHangupEventContent
Auto Trait Implementations§
impl Freeze for CallHangupEventContent
impl RefUnwindSafe for CallHangupEventContent
impl Send for CallHangupEventContent
impl Sync for CallHangupEventContent
impl Unpin for CallHangupEventContent
impl UnwindSafe for CallHangupEventContent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> EventContentFromType for Twhere
T: EventContent + DeserializeOwned,
impl<T> EventContentFromType for Twhere
T: EventContent + DeserializeOwned,
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more