Struct ruma::api::client::r0::capabilities::Capabilities

pub struct Capabilities {
    pub change_password: ChangePasswordCapability,
    pub room_versions: RoomVersionsCapability,
    // some fields omitted
}

This is supported on crate feature api and (crate features client-api or client-api-c or client-api-s) only.

Contains information about all the capabilities that the server supports.

Fields

change_password: ChangePasswordCapability

Capability to indicate if the user can change their password.

room_versions: RoomVersionsCapability

The room versions the server supports.

Implementations

impl Capabilities

pub fn new() -> Capabilities

Creates empty Capabilities.

pub fn get(&self, capability: &str) -> Option<Cow<'_, Value>>

Returns the value of the given capability.

Prefer to use the public fields of Capabilities where possible; this method is meant to be used for unsupported capabilities only.

pub fn set(&mut self, capability: &str, value: Value) -> Result<(), Error>

Sets a capability to the given value.

Prefer to use the public fields of Capabilities where possible; this method is meant to be used for unsupported capabilities only and does not allow setting arbitrary data for supported ones.

pub fn iter(&self) -> CapabilitiesIter<'_>

Returns an iterator over the capabilities.

Trait Implementations

impl Clone for Capabilities

pub fn clone(&self) -> Capabilities

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Default for Capabilities

pub fn default() -> Capabilities

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Capabilities

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

Deserialize this value from the given Serde deserializer.

impl From<Capabilities> for Response

pub fn from(capabilities: Capabilities) -> Response

Performs the conversion.

impl<'a> IntoIterator for &'a Capabilities

type Item = CapabilityRef<'a>

The type of the elements being iterated over.

type IntoIter = CapabilitiesIter<'a>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <&'a Capabilities as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Serialize for Capabilities

pub 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.