medea-jason 0.5.0

Client library for Medea media server.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! Reason of a [`Room`] closing.
//!
//! [`Room`]: room::Room

use derive_more::From;
use wasm_bindgen::prelude::*;

use crate::room;

/// Reason of why a [`Room`] is closed.
///
/// This struct is passed to a [`RoomHandle::on_close`] JS side callback.
///
/// [`Room`]: room::Room
/// [`RoomHandle::on_close`]: crate::api::RoomHandle::on_close
#[wasm_bindgen]
#[derive(Debug, From)]
pub struct RoomCloseReason(room::RoomCloseReason);

#[allow(clippy::missing_const_for_fn)] // required by `wasm_bindgen`
#[wasm_bindgen]
impl RoomCloseReason {
    /// Returns the [`Room`]'s close reason.
    ///
    /// [`Room`]: room::Room
    #[must_use]
    pub fn reason(&self) -> String {
        self.0.reason()
    }

    /// Indicates whether the [`Room`] was closed by server.
    ///
    /// [`Room`]: room::Room
    #[must_use]
    pub fn is_closed_by_server(&self) -> bool {
        self.0.is_closed_by_server()
    }

    /// Indicates whether the [`Room`] close reason is considered as an error.
    ///
    /// [`Room`]: room::Room
    #[must_use]
    pub fn is_err(&self) -> bool {
        self.0.is_err()
    }
}