Struct ruma_identifiers::RoomVersionId

pub struct RoomVersionId(_);

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

Methods

impl RoomVersionId

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 custom(id: String) -> Self

Creates a custom room version ID from the given string slice.

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.

Trait Implementations

impl<'expr> AsExpression<Nullable<Text>> for &'expr RoomVersionId

type Expression = Bound<Nullable<Text>, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Nullable<Text>> for RoomVersionId

type Expression = Bound<Nullable<Text>, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<'expr> AsExpression<Text> for &'expr RoomVersionId

type Expression = Bound<Text, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Text> for RoomVersionId

type Expression = Bound<Text, Self>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

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<DB> FromSql<Text, DB> for RoomVersionId where
    String: FromSql<Text, DB>,
    DB: Backend, 

fn from_sql(
    value: Option<&<DB as Backend>::RawValue>
) -> DeserializeResult<Self>

See the trait documentation.

impl<__ST, __DB> FromSqlRow<__ST, __DB> for RoomVersionId where
    __DB: Backend,
    Self: FromSql<__ST, __DB>, 

fn build_from_row<R: Row<__DB>>(row: &mut R) -> Result<Self>

See the trait documentation.

const FIELDS_NEEDED: usize

The number of fields that this type will consume. Must be equal to the number of times you would call row.take() in build_from_row

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 NotNull for RoomVersionId

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 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 QueryId for RoomVersionId

type QueryId = RoomVersionId

A type which uniquely represents Self in a SQL query.

const HAS_STATIC_QUERY_ID: bool

Can the SQL generated by Self be uniquely identified by its type?

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.

impl<__ST, __DB> Queryable<__ST, __DB> for RoomVersionId where
    __DB: Backend,
    Self: FromSql<__ST, __DB>, 

type Row = Self

The Rust type you'd like to map from.

fn build(row: Self::Row) -> Self

Construct an instance of this type

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 SingleValue for RoomVersionId

impl StructuralEq for RoomVersionId

impl StructuralPartialEq for RoomVersionId

impl<__DB> ToSql<Nullable<Text>, __DB> for RoomVersionId where
    __DB: Backend,
    Self: ToSql<Text, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

See the trait documentation.

impl<DB> ToSql<Text, DB> for RoomVersionId where
    DB: Backend, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> SerializeResult

See the trait documentation.

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, Self::Error>

Performs the conversion.

impl<'_> TryFrom<Cow<'_, str>> for RoomVersionId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(room_version_id: Cow<str>) -> Result<Self, Error>

Attempts to create a new Matrix room version ID from a string representation.

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, Self::Error>

Performs the conversion.