Enum matrix_sdk::ruma::api::MatrixVersion

#[non_exhaustive]pub enum MatrixVersion {
Show 13 variants    V1_0,
    V1_1,
    V1_2,
    V1_3,
    V1_4,
    V1_5,
    V1_6,
    V1_7,
    V1_8,
    V1_9,
    V1_10,
    V1_11,
    V1_12,
}

Available on crate feature api only.

Expand description

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/latest/#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)§

This enum is marked as 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/latest/#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/.

V1_3

Version 1.3 of the Matrix specification, released in Q2 2022.

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

V1_4

Version 1.4 of the Matrix specification, released in Q3 2022.

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

V1_5

Version 1.5 of the Matrix specification, released in Q4 2022.

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

V1_6

Version 1.6 of the Matrix specification, released in Q1 2023.

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

V1_7

Version 1.7 of the Matrix specification, released in Q2 2023.

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

V1_8

Version 1.8 of the Matrix specification, released in Q3 2023.

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

V1_9

Version 1.9 of the Matrix specification, released in Q4 2023.

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

V1_10

Version 1.10 of the Matrix specification, released in Q1 2024.

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

V1_11

Version 1.11 of the Matrix specification, released in Q2 2024.

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

V1_12

Version 1.12 of the Matrix specification, released in Q3 2024.

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

Implementations§

impl MatrixVersion

pub fn is_superset_of(self, other: MatrixVersion) -> 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 const fn into_parts(self) -> (u8, u8)

Decompose the Matrix version into its major and minor number.

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

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

pub fn default_room_version(&self) -> RoomVersionId

Get the default RoomVersionId for this MatrixVersion.

Trait Implementations§

impl Clone for MatrixVersion

fn clone(&self) -> MatrixVersion

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for MatrixVersion

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

Formats the value using the given formatter. Read more

impl Display for MatrixVersion

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

Formats the value using the given formatter. Read more

impl FromStr for MatrixVersion

type Err = UnknownVersionError

The associated error which can be returned from parsing.

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

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

impl Hash for MatrixVersion

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for MatrixVersion

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

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

1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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, <MatrixVersion as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for MatrixVersion

impl Eq for MatrixVersion

impl StructuralPartialEq for MatrixVersion

Auto Trait Implementations§

impl Freeze for MatrixVersion

impl RefUnwindSafe for MatrixVersion

impl Send for MatrixVersion

impl Sync for MatrixVersion

impl Unpin for MatrixVersion

impl UnwindSafe for MatrixVersion

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> CloneToUninit for T
where T: Copy,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

A constant of the type witness

impl<T> Identity for T
where T: ?Sized,

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> Any for T
where T: Any,

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

impl<T> CloneAny for T
where T: Any + Clone,

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

impl<T> SendOutsideWasm for T
where T: Send,

impl<T> SyncOutsideWasm for T
where T: Sync,