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 [(Option<&'static str>, &'static str)], stable_paths: &'static [(StablePathSelector, &'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

Arguments

• unstable_paths - List of unstable paths for the endpoint, mapped to optional unstable features.
• stable_paths - List of stable paths for the endpoint, mapped to selectors.
• deprecated - The Matrix version that deprecated the endpoint, if any.
• removed - The Matrix version that removed the endpoint, if any.

pub fn is_supported(&self, considering: &SupportedVersions) -> bool

Whether the homeserver advertises support for a path in this VersionHistory.

Returns true if any version or feature in the given SupportedVersions matches a path in this history, unless the endpoint was removed.

Note that this is likely to return false negatives, since some endpoints don’t specify a stable or unstable feature, and homeservers should not advertise support for a Matrix version unless they support all of its features.

pub fn versioning_decision_for( &self, versions: &BTreeSet<MatrixVersion>, ) -> VersioningDecision

Decide which kind of endpoint to use given the supported versions of a homeserver.

Returns:

• Removed if the endpoint is removed in all supported versions.
• Version if the endpoint is stable or deprecated in at least one supported version.
• Feature in all other cases, to look if a feature path is supported, or use the last unstable path as a fallback.

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 = (Option<&'static str>, &'static str)>

Returns all unstable path variants in canon form, with optional corresponding feature.

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

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

pub fn version_path( &self, versions: &BTreeSet<MatrixVersion>, ) -> Option<&'static str>

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

Picks the latest path that the versions accept.

Returns an endpoint in the following format;

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

Note: This doesn’t handle endpoint removals, check with versioning_decision_for to see if this endpoint is still available.

pub fn feature_path( &self, supported_features: &BTreeSet<FeatureFlag>, ) -> Option<&'static str>

The path that should be used to query the endpoint, given a list of supported features.

Trait Implementations

impl Clone for VersionHistory

fn clone(&self) -> VersionHistory

Returns a duplicate 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