Struct ruma_identifiers::room_version_id::RoomVersionId

pub struct RoomVersionId<T>(_);

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.

It is discouraged to use this type directly – instead use one of the aliases (RoomVersionId and RoomVersionIdRef) in the crate root.

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

Implementations

impl<T> RoomVersionId<T>

pub fn version_1() -> Self

Creates a version 1 room ID.

pub fn version_2() -> Self

Creates a version 2 room ID.

pub fn version_3() -> Self

Creates a version 3 room ID.

pub fn version_4() -> Self

Creates a version 4 room ID.

pub fn version_5() -> Self

Creates a version 5 room ID.

pub fn version_6() -> Self

Creates a version 6 room ID.

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

Whether or not this is a version 1 room.

pub fn is_version_2(&self) -> bool

Whether or not this is a version 2 room.

pub fn is_version_3(&self) -> bool

Whether or not this is a version 3 room.

pub fn is_version_4(&self) -> bool

Whether or not this is a version 4 room.

pub fn is_version_5(&self) -> bool

Whether or not this is a version 5 room.

pub fn is_version_6(&self) -> bool

Whether or not this is a version 6 room.

Trait Implementations

impl<T: AsRef<str>> AsRef<str> for RoomVersionId<T>

fn as_ref(&self) -> &str

Performs the conversion.

impl<T: Clone> Clone for RoomVersionId<T>

fn clone(&self) -> RoomVersionId<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for RoomVersionId<T>

impl<T: Debug> Debug for RoomVersionId<T>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<T: AsRef<str>> Display for RoomVersionId<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for RoomVersionId<T>

impl From<RoomVersionId<Box<str>>> for String

fn from(id: RoomVersionId<Box<str>>) -> Self

Performs the conversion.

impl<T: Hash> Hash for RoomVersionId<T>

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<T: Eq + AsRef<str>> Ord for RoomVersionId<T>

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

This method returns an [Ordering] between self and other.

#[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<'_, T: AsRef<str>> PartialEq<&'_ str> for RoomVersionId<T>

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<T: PartialEq> PartialEq<RoomVersionId<T>> for RoomVersionId<T>

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

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

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

This method tests for !=.

impl<'_, T: AsRef<str>> PartialEq<RoomVersionId<T>> for &'_ str

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

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

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<T: PartialEq + AsRef<str>> PartialOrd<RoomVersionId<T>> for RoomVersionId<T>

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

This method returns an ordering between self and other values if one exists.

#[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<T: AsRef<str>> Serialize for RoomVersionId<T>

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

Serialize this value into the given Serde serializer.

impl<T> StructuralEq for RoomVersionId<T>

impl<T> StructuralPartialEq for RoomVersionId<T>

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

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<'a> TryFrom<&'a str> for RoomVersionId<&'a str>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for RoomVersionId<Box<str>>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.