CallHangupEventContent

matrix_sdk::ruma::events::call::hangup

Struct CallHangupEventContent

#[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

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

impl CallHangupEventContent

pub fn new( call_id: OwnedVoipId, version: VoipVersionId, ) -> CallHangupEventContent

Creates a new CallHangupEventContent with the given call ID and VoIP version.

pub fn version_0(call_id: OwnedVoipId) -> CallHangupEventContent

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

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§

impl Clone for CallHangupEventContent

fn clone(&self) -> CallHangupEventContent

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for CallHangupEventContent

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for CallHangupEventContent

fn deserialize<D>( deserializer: D, ) -> Result<CallHangupEventContent, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<CallHangupEventContent> for AnyMessageLikeEventContent

fn from(c: CallHangupEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl MessageLikeEventContent for CallHangupEventContent

fn event_type(&self) -> MessageLikeEventType

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

impl RedactContent for CallHangupEventContent

type Redacted = RedactedCallHangupEventContent

The redacted form of the event’s content.

fn redact(self, _rules: &RedactionRules) -> RedactedCallHangupEventContent

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

impl Serialize for CallHangupEventContent

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

impl StaticEventContent for CallHangupEventContent

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

The statically-known part of the event type. Read more

type IsPrefix = False

Whether the statically-known part of the event type is the prefix. Read more

impl JsonCastable<AnyMessageLikeEventContent> for CallHangupEventContent

impl JsonCastable<Map<String, Value>> for CallHangupEventContent

impl JsonCastable<RedactedCallHangupEventContent> 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§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> DeserialiseFromJs for T
where T: DeserializeOwned,

fn deserialise_from_js(js: JsValue) -> Result<T, Error>

Deserialise a value from JS, most likely using serde_wasm_bindgen.

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSend for T
where T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<T> EventContentFromType for T
where T: StaticEventContent + DeserializeOwned,

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more

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

const WITNESS: W = W::MAKE

A constant of the type witness

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

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.

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

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SerialiseToJs for T
where T: Serialize,

fn serialise_to_js(&self) -> Result<JsValue, Error>

Convert the type to a JsValue, most likely using serde_wasm_bindgen.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Any for T
where T: Any,

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

impl<T> CloneAny for T
where T: Any + Clone,

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

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

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> Fruit for T
where T: Send + Downcast,

impl<T> JsonCastable<BTreeMap<String, CanonicalJsonValue>> for T
where T: JsonCastable<Map<String, Value>>,

impl<T> JsonCastable<CanonicalJsonValue> for T

impl<T> JsonCastable<Value> for T

impl<T> MaybeSendSync for T

impl<T> SendOutsideWasm for T
where T: Send,

impl<T> SyncOutsideWasm for T
where T: Sync,