Struct VersionHistory

pub struct VersionHistory { /* private fields */ }

Available on crate feature api only.

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

impl VersionHistory

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

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.

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

Returns the first version this endpoint was added in.

Is None when this endpoint is unstable/unreleased.

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

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

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

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

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

Picks the last unstable path, if it exists.

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

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

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

Returns all unstable path variants in canon form.

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

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

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

impl Clone for VersionHistory

fn clone(&self) -> VersionHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VersionHistory

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

Formats the value using the given formatter.

impl PartialEq for VersionHistory

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for VersionHistory

impl StructuralPartialEq for VersionHistory