ruwuma/src/call/hangup.rs
Jake Waksbaum d84de004c8
Replace impl_enum with strum::{EnumString,Display}
Replace the impl_enum! macro, which automatically derives instances of
std::fmt::Display and std::string::FromStr, with derive macros from the
strum crate (Display and EnumString resp.).

Closes #90.
2020-05-29 10:59:33 -04:00

43 lines
1.4 KiB
Rust

//! Types for the *m.call.hangup* event.
use js_int::UInt;
use ruma_events_macros::ruma_event;
use serde::{Deserialize, Serialize};
use strum::{Display, EnumString};
ruma_event! {
/// Sent by either party to signal their termination of the call. This can be sent either once
/// the call has has been established or before to abort the call.
HangupEvent {
kind: RoomEvent,
event_type: "m.call.hangup",
content: {
/// The ID of the call this event relates to.
pub call_id: String,
/// The version of the VoIP specification this messages adheres to.
pub version: UInt,
/// Optional error reason for the hangup.
#[serde(skip_serializing_if = "Option::is_none")]
pub reason: Option<Reason>,
},
}
}
/// A reason for a hangup.
///
/// This 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.
#[derive(Clone, Copy, Debug, Display, EnumString, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum Reason {
/// ICE negotiation failure.
IceFailed,
/// Party did not answer in time.
InviteTimeout,
}