logo
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

//! Endpoints for room management.

pub mod aliases;
pub mod create_room;
pub mod get_room_event;
pub mod report_content;
pub mod upgrade_room;

use ruma_common::serde::StringEnum;

use crate::PrivOwnedStr;

/// Whether or not a newly created room will be listed in the room directory.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, Debug, PartialEq, Eq, StringEnum)]
#[ruma_enum(rename_all = "snake_case")]
#[non_exhaustive]
pub enum Visibility {
    /// Indicates that the room will be shown in the published room list.
    Public,

    /// Indicates that the room will not be shown in the published room list.
    Private,

    #[doc(hidden)]
    _Custom(PrivOwnedStr),
}

impl Visibility {
    /// Creates a string slice from this `Visibility`.
    pub fn as_str(&self) -> &str {
        self.as_ref()
    }
}

impl Default for Visibility {
    fn default() -> Self {
        Self::Private
    }
}