Struct ruma::api::VersionHistory

source ·
pub struct VersionHistory { /* private fields */ }
Available on crate feature api only.
Expand description

The complete history of this endpoint as far as Ruma knows, together with all variants on versions stable and unstable.

The amount and positioning of path variables are the same over all path variants.

Implementations§

source§

impl VersionHistory

source

pub const fn new( unstable_paths: &'static [&'static str], stable_paths: &'static [(MatrixVersion, &'static str)], deprecated: Option<MatrixVersion>, removed: Option<MatrixVersion> ) -> VersionHistory

Constructs an instance of VersionHistory, erroring on compilation if it does not pass invariants.

Specifically, this checks the following invariants:

  • Path Arguments are equal (in order, amount, and argument name) in all path strings
  • In stable_paths:
    • matrix versions are in ascending order
    • no matrix version is referenced twice
  • deprecated’s version comes after the latest version mentioned in stable_paths, except for version 1.0, and only if any stable path is defined
  • removed comes after deprecated, or after the latest referenced stable_paths, like deprecated
source

pub fn versioning_decision_for( &self, versions: &[MatrixVersion] ) -> VersioningDecision

Will decide how a particular set of Matrix versions sees an endpoint.

It will only return Deprecated or Removed if all versions denote it.

In other words, if in any version it tells it supports the endpoint in a stable fashion, this will return Stable, even if some versions in this set will denote deprecation or removal.

If resulting VersioningDecision is Stable, it will also detail if any version denoted deprecation or removal.

source

pub fn added_in(&self) -> Option<MatrixVersion>

Returns the first version this endpoint was added in.

Is None when this endpoint is unstable/unreleased.

source

pub fn deprecated_in(&self) -> Option<MatrixVersion>

Returns the Matrix version that deprecated this endpoint, if any.

source

pub fn removed_in(&self) -> Option<MatrixVersion>

Returns the Matrix version that removed this endpoint, if any.

source

pub fn unstable(&self) -> Option<&'static str>

Picks the last unstable path, if it exists.

source

pub fn all_paths(&self) -> impl Iterator<Item = &'static str>

Returns all path variants in canon form, for use in server routers.

source

pub fn unstable_paths(&self) -> impl Iterator<Item = &'static str>

Returns all unstable path variants in canon form.

source

pub fn stable_paths( &self ) -> impl Iterator<Item = (MatrixVersion, &'static str)>

Returns all stable path variants in canon form, with corresponding Matrix version.

source

pub fn stable_endpoint_for( &self, versions: &[MatrixVersion] ) -> Option<&'static str>

The path that should be used to query the endpoint, given a series of versions.

This will pick the latest path that the version accepts.

This will return an endpoint in the following format;

  • /_matrix/client/versions
  • /_matrix/client/hello/:world (:world is a path replacement parameter)

Note: This will not keep in mind endpoint removals, check with versioning_decision_for to see if this endpoint is still available.

Trait Implementations§

source§

impl Clone for VersionHistory

source§

fn clone(&self) -> VersionHistory

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
source§

impl Debug for VersionHistory

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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
source§

impl<T> Instrument for T

source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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