Enum RoomVersion 

pub enum RoomVersion {
    V1,
    V2,
    V3,
    V4,
    V5,
    V6,
    V7,
    V8,
    V9,
    V10,
    V11,
    V12,
    MSC2870,
    // 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_str(), "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().

The PartialOrd and Ord implementations of this type sort the variants by comparing their string representations, which have no special meaning. To check the compatibility between room versions, one should use the RoomVersionRules instead.

Variants

V1

A version 1 room.

V2

A version 2 room.

V3

A version 3 room.

V4

A version 4 room.

V5

A version 5 room.

V6

A version 6 room.

V7

A version 7 room.

V8

A version 8 room.

V9

A version 9 room.

V10

A version 10 room.

V11

A version 11 room.

V12

A version 12 room.

MSC2870

org.matrix.msc2870 (MSC2870).

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.

pub fn rules(&self) -> Option<RoomVersionRules>

Get the RoomVersionRules for this RoomVersionId, if it matches a supported room version.

All known variants are guaranteed to return Some(_).

Trait Implementations

impl AsRef<[u8]> for RoomVersionId

fn as_ref(&self) -> &[u8]

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

impl AsRef<str> for RoomVersionId

fn as_ref(&self) -> &str

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

impl Clone for RoomVersionId

fn clone(&self) -> RoomVersionId

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

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

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

Formats the value using the given formatter.

impl From<RoomVersionId> for String

fn from(id: RoomVersionId) -> String

Converts to this type from the input type.

impl FromStr for RoomVersionId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<RoomVersionId, <RoomVersionId as FromStr>::Err>

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

impl Hash for RoomVersionId

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RoomVersionId

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&str> for RoomVersionId

fn eq(&self, other: &&str) -> 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 PartialEq<RoomVersionId> for &str

fn eq(&self, other: &RoomVersionId) -> 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 PartialEq<RoomVersionId> for String

fn eq(&self, other: &RoomVersionId) -> 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 PartialEq<String> for RoomVersionId

fn eq(&self, other: &String) -> 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 PartialEq for RoomVersionId

fn eq(&self, other: &RoomVersionId) -> 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 PartialOrd 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.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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 as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for RoomVersionId

type Error = Error

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<RoomVersionId, <RoomVersionId as TryFrom<&str>>::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<RoomVersionId, <RoomVersionId as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for RoomVersionId

impl StructuralPartialEq for RoomVersionId