Enum ruma_identifiers::RoomVersionId

#[non_exhaustive]pub enum RoomVersionId {
    Version1,
    Version2,
    Version3,
    Version4,
    Version5,
    Version6,
    Custom(CustomRoomVersion),
}

A Matrix room version ID.

A RoomVersionId can be or converted or deserialized from a string slice, and can be converted or serialized back into a string as needed.

assert_eq!(RoomVersionId::try_from("1").unwrap().as_ref(), "1");

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.

Version1

A version 1 room.

Version2

A version 2 room.

Version3

A version 3 room.

Version4

A version 4 room.

Version5

A version 5 room.

Version6

A version 6 room.

Custom(CustomRoomVersion)

A custom room version.

Implementations

impl RoomVersionId

pub fn version_1() -> Self

👎 Deprecated:

use RoomVersionId::Version1 instead

Creates a version 1 room ID.

pub fn version_2() -> Self

👎 Deprecated:

use RoomVersionId::Version2 instead

Creates a version 2 room ID.

pub fn version_3() -> Self

👎 Deprecated:

use RoomVersionId::Version3 instead

Creates a version 3 room ID.

pub fn version_4() -> Self

👎 Deprecated:

use RoomVersionId::Version4 instead

Creates a version 4 room ID.

pub fn version_5() -> Self

👎 Deprecated:

use RoomVersionId::Version5 instead

Creates a version 5 room ID.

pub fn version_6() -> Self

👎 Deprecated:

use RoomVersionId::Version6 instead

Creates a version 6 room ID.

pub fn as_str(&self) -> &str

Creates a string slice from this RoomVersionId.

pub fn as_bytes(&self) -> &[u8]

Creates a byte slice from this RoomVersionId.

pub fn is_official(&self) -> bool

Whether or not this room version is an official one specified by the Matrix protocol.

pub fn is_custom(&self) -> bool

Whether or not this is a custom room version.

pub fn is_version_1(&self) -> bool

👎 Deprecated:

compare to RoomVersionId::Version1 instead

Whether or not this is a version 1 room.

pub fn is_version_2(&self) -> bool

👎 Deprecated:

compare to RoomVersionId::Version2 instead

Whether or not this is a version 2 room.

pub fn is_version_3(&self) -> bool

👎 Deprecated:

compare to RoomVersionId::Version3 instead

Whether or not this is a version 3 room.

pub fn is_version_4(&self) -> bool

👎 Deprecated:

compare to RoomVersionId::Version4 instead

Whether or not this is a version 4 room.

pub fn is_version_5(&self) -> bool

👎 Deprecated:

compare to RoomVersionId::Version5 instead

Whether or not this is a version 5 room.

pub fn is_version_6(&self) -> bool

👎 Deprecated:

compare to RoomVersionId::Version6 instead

Whether or not this is a version 6 room.

Trait Implementations

impl AsRef<str> for RoomVersionId

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for RoomVersionId

fn clone(&self) -> RoomVersionId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomVersionId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomVersionId

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

Deserialize this value from the given Serde deserializer.

impl Display for RoomVersionId

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

Formats the value using the given formatter.

impl Eq for RoomVersionId

impl From<RoomVersionId> for String

fn from(id: RoomVersionId) -> Self

Performs the conversion.

impl Hash for RoomVersionId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for RoomVersionId

fn cmp(&self, other: &Self) -> Ordering

Compare the two given room version IDs by comparing their string representations.

Please be aware that room version IDs don't have a defined ordering in the Matrix specification. This implementation only exists to be able to use RoomVersionIds or types containing RoomVersionIds as BTreeMap keys.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'_> PartialEq<&'_ str> for RoomVersionId

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<RoomVersionId> for RoomVersionId

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

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

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

This method tests for !=.

impl<'_> PartialEq<RoomVersionId> for &'_ str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<RoomVersionId> for String

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<String> for RoomVersionId

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<RoomVersionId> for RoomVersionId

fn partial_cmp(&self, other: &RoomVersionId) -> Option<Ordering>

Compare the two given room version IDs by comparing their string representations.

Please be aware that room version IDs don't have a defined ordering in the Matrix specification. This implementation only exists to be able to use RoomVersionIds or types containing RoomVersionIds as BTreeMap keys.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RoomVersionId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for RoomVersionId

impl StructuralPartialEq for RoomVersionId

impl<'_> TryFrom<&'_ str> for RoomVersionId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<String> for RoomVersionId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Error>

Performs the conversion.