Enum ruma_common::events::call::hangup::Reason

#[non_exhaustive]
pub enum Reason {
    IceFailed,
    InviteTimeout,
    // some variants omitted
}

A reason for a hangup.

Should not be provided when the user naturally ends or rejects the call. When there was an error in the call negotiation, this should be ice_failed for when ICE negotiation fails or invite_timeout for when the other party did not answer in time.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for formats that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

IceFailed

ICE negotiation failure.

InviteTimeout

Party did not answer in time.

Implementations

impl Reason

pub fn as_str(&self) -> &str

Creates a string slice from this Reason.

Trait Implementations

impl AsRef<str> for Reason

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Reason

fn clone(&self) -> Reason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reason

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

Deserialize this value from the given Serde deserializer.

impl Display for Reason

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

Formats the value using the given formatter.

impl<T> From<T> for Reason where
    T: AsRef<str> + Into<Box<str>>, 

fn from(s: T) -> Self

Converts to this type from the input type.

impl PartialEq<Reason> for Reason

fn eq(&self, other: &Reason) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Reason) -> bool

This method tests for !=.

impl Serialize for Reason

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

Serialize this value into the given Serde serializer.

impl Eq for Reason

impl StructuralEq for Reason

impl StructuralPartialEq for Reason