Enum ruma_common::events::room::history_visibility::HistoryVisibility

#[non_exhaustive]
pub enum HistoryVisibility {
    Invited,
    Joined,
    Shared,
    WorldReadable,
    // some variants omitted
}

Who can see a room’s history.

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.

Invited

Previous events are accessible to newly joined members from the point they were invited onwards.

Events stop being accessible when the member’s state changes to something other than invite or join.

Joined

Previous events are accessible to newly joined members from the point they joined the room onwards. Events stop being accessible when the member’s state changes to something other than join.

Shared

Previous events are always accessible to newly joined members.

All events in the room are accessible, even those sent when the member was not a part of the room.

WorldReadable

All events while this is the HistoryVisibility value may be shared by any participating homeserver with anyone, regardless of whether they have ever joined the room.

Implementations

impl HistoryVisibility

pub fn as_str(&self) -> &str

Creates a string slice from this HistoryVisibility.

Trait Implementations

impl AsRef<str> for HistoryVisibility

fn as_ref(&self) -> &str

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

impl Clone for HistoryVisibility

fn clone(&self) -> HistoryVisibility

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryVisibility

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HistoryVisibility

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

Deserialize this value from the given Serde deserializer.

impl Display for HistoryVisibility

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

Formats the value using the given formatter.

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

fn from(s: T) -> Self

Converts to this type from the input type.

impl PartialEq<HistoryVisibility> for HistoryVisibility

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

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

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

This method tests for !=.

impl Serialize for HistoryVisibility

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 HistoryVisibility

impl StructuralEq for HistoryVisibility

impl StructuralPartialEq for HistoryVisibility