Enum ruma::RoomVersionId

pub enum RoomVersionId {
    Version1,
    Version2,
    Version3,
    Version4,
    Version5,
    Version6,
    // some variants omitted
}

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");

Any string consisting of at minimum 1, at maximum 32 unicode codepoints is a room version ID. Custom room versions or ones that were introduced into the specification after this code was written are represented by a hidden enum variant. You can still construct them the same, and check for them using one of RoomVersionIds PartialEq implementations or through .as_str().

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.

Implementations

impl RoomVersionId

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.

Trait Implementations

impl AsRef<str> for RoomVersionId

pub fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for RoomVersionId

pub fn clone(&self) -> RoomVersionId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomVersionId

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for RoomVersionId

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

Formats the value using the given formatter.

impl Eq for RoomVersionId

impl From<RoomVersionId> for String

pub fn from(id: RoomVersionId) -> String

Performs the conversion.

impl FromStr for RoomVersionId

type Err = Error

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<RoomVersionId, Error>

Parses a string s to return a value of this type.

impl Hash for RoomVersionId

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

Feeds this value into the given Hasher.

pub 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

pub fn cmp(&self, other: &RoomVersionId) -> 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]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

impl PartialEq<RoomVersionId> for RoomVersionId

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

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

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

This method tests for !=.

impl PartialEq<String> for RoomVersionId

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

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

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

This method tests for !=.

impl PartialOrd<RoomVersionId> for RoomVersionId

pub 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]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::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.

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

Performs the conversion.

impl TryFrom<String> for RoomVersionId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.