Enum ruma_api::MatrixVersion

#[non_exhaustive]
pub enum MatrixVersion {
    V1_0,
    V1_1,
    V1_2,
}

The Matrix versions Ruma currently understands to exist.

Matrix, since fall 2021, has a quarterly release schedule, using a global vX.Y versioning scheme.

Every new minor version denotes stable support for endpoints in a relatively backwards-compatible manner.

Matrix has a deprecation policy, read more about it here: https://spec.matrix.org/v1.2/#deprecation-policy.

Ruma keeps track of when endpoints are added, deprecated, and removed. It’ll automatically select the right endpoint stability variation to use depending on which Matrix versions you pass to try_into_http_request, see its respective documentation for more information.

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.

V1_0

Version 1.0 of the Matrix specification.

Retroactively defined as https://spec.matrix.org/v1.2/#legacy-versioning.

V1_1

Version 1.1 of the Matrix specification, released in Q4 2021.

See https://spec.matrix.org/v1.1/.

V1_2

Version 1.2 of the Matrix specification, released in Q1 2022.

See https://spec.matrix.org/v1.2/.

Implementations

impl MatrixVersion

pub fn is_superset_of(self, other: Self) -> bool

Checks whether a version is compatible with another.

A is compatible with B as long as B is equal or less, so long as A and B have the same major versions.

For example, v1.2 is compatible with v1.1, as it is likely only some additions of endpoints on top of v1.1, but v1.1 would not be compatible with v1.2, as v1.1 cannot represent all of v1.2, in a manner similar to set theory.

Warning: Matrix has a deprecation policy, and Matrix versioning is not as straight-forward as this function makes it out to be. This function only exists to prune major version differences, and versions too new for self.

This (considering if major versions are the same) is equivalent to a self >= other check.

pub fn into_parts(self) -> (u8, u8)

Decompose the Matrix version into its major and minor number.

pub fn from_parts(major: u8, minor: u8) -> Result<Self, UnknownVersionError>

Try to turn a pair of (major, minor) version components back into a MatrixVersion.

Trait Implementations

impl Clone for MatrixVersion

fn clone(&self) -> MatrixVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MatrixVersion

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

Formats the value using the given formatter.

impl Display for MatrixVersion

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

Formats the value using the given formatter.

impl FromStr for MatrixVersion

type Err = UnknownVersionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for MatrixVersion

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 PartialEq<MatrixVersion> for MatrixVersion

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

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

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

This method tests for !=.

impl TryFrom<&'_ str> for MatrixVersion

type Error = UnknownVersionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for MatrixVersion

impl Eq for MatrixVersion

impl StructuralEq for MatrixVersion

impl StructuralPartialEq for MatrixVersion