Struct ServerInfo

pub struct ServerInfo {
    pub versions: Vec<String>,
    pub unstable_features: BTreeMap<String, bool>,
    pub well_known: Option<WellKnownResponse>,
    /* private fields */
}

Useful server info such as data returned by the /client/versions and .well-known/client/matrix endpoints.

Fields

versions: Vec<String>

Versions supported by the remote server.

unstable_features: BTreeMap<String, bool>

List of unstable features and their enablement status.

well_known: Option<WellKnownResponse>

Information about the server found in the client well-known file.

Implementations

impl ServerInfo

pub const STALE_THRESHOLD: f64 = 6.048E+8f64

The number of milliseconds after which the data is considered stale.

pub fn new( versions: Vec<String>, unstable_features: BTreeMap<String, bool>, well_known: Option<WellKnownResponse>, ) -> ServerInfo

Encode server info into this serializable struct.

pub fn maybe_decode(&self) -> Option<ServerInfo>

Decode server info from this serializable struct.

May return None if the data is considered stale, after Self::STALE_THRESHOLD milliseconds since the last time we stored it.

pub fn supported_versions(&self) -> SupportedVersions

Extracts known Matrix versions and features from the un-typed lists of strings.

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

Trait Implementations

impl Clone for ServerInfo

fn clone(&self) -> ServerInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerInfo

fn deserialize<__D>( __deserializer: __D, ) -> Result<ServerInfo, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServerInfo

fn eq(&self, other: &ServerInfo) -> 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 Serialize for ServerInfo

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServerInfo