Enum ruma_client_api::room::Visibility

#[non_exhaustive]
pub enum Visibility {
    Public,
    Private,
}

Available on crate features client or server only.

Whether or not a newly created room will be listed in the room directory.

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

Public

Indicates that the room will be shown in the published room list.

Private

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

Implementations

impl Visibility

pub fn as_str(&self) -> &str

Creates a string slice from this Visibility.

Trait Implementations

impl AsRef<str> for Visibility

fn as_ref(&self) -> &str

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

impl Clone for Visibility

fn clone(&self) -> Visibility

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Visibility

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

Formats the value using the given formatter.

impl Default for Visibility

fn default() -> Visibility

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Visibility

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Visibility

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

Formats the value using the given formatter.

impl<T> From<T> for Visibility

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> Self

Converts to this type from the input type.

impl PartialEq for Visibility

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Visibility

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 Visibility

impl StructuralPartialEq for Visibility