Struct Response

#[non_exhaustive]
pub struct Response {
    pub versions: Vec<String>,
    pub unstable_features: BTreeMap<String, bool>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Response type for the api_versions endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

versions: Vec<String>

A list of Matrix client API protocol versions supported by the homeserver.

unstable_features: BTreeMap<String, bool>

Experimental features supported by the server.

Servers can enable some unstable features only for some users, so this list might differ when an access token is provided.

Implementations

impl Response

pub fn new(versions: Vec<String>) -> Response

Creates a new Response with the given versions.

pub fn known_versions(&self) -> impl DoubleEndedIterator

Extracts known Matrix versions from this response.

Matrix versions that Ruma cannot parse, or does not know about, are discarded.

The versions returned will be sorted from oldest to latest. Use .find() or .rfind() to look for a minimum or maximum version to use given some constraint.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl IncomingResponse for Response

Available on crate feature client only.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

fn try_from_http_response<T>( response: Response<T>, ) -> Result<Response, FromHttpResponseError<Error>>

where T: AsRef<[u8]>,

Tries to convert the given http::Response into this response type.

impl OutgoingResponse for Response

Available on crate feature server only.

fn try_into_http_response<T>(self) -> Result<Response<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this response into an http::Response.