Struct Capabilities

#[non_exhaustive]
pub struct Capabilities {
    pub change_password: ChangePasswordCapability,
    pub room_versions: RoomVersionsCapability,
    pub set_displayname: SetDisplayNameCapability,
    pub set_avatar_url: SetAvatarUrlCapability,
    pub thirdparty_id_changes: ThirdPartyIdChangesCapability,
    pub get_login_token: GetLoginTokenCapability,
    /* private fields */
}

Available on crate features client or server only.

Contains information about all the capabilities that the server supports.

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.

change_password: ChangePasswordCapability

Capability to indicate if the user can change their password.

room_versions: RoomVersionsCapability

The room versions the server supports.

set_displayname: SetDisplayNameCapability

Capability to indicate if the user can change their display name.

set_avatar_url: SetAvatarUrlCapability

Capability to indicate if the user can change their avatar.

thirdparty_id_changes: ThirdPartyIdChangesCapability

Capability to indicate if the user can change the third-party identifiers associated with their account.

get_login_token: GetLoginTokenCapability

Capability to indicate if the user can generate tokens to log further clients into their account.

Implementations

impl Capabilities

pub fn new() -> Self

Creates empty Capabilities.

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

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: JsonValue) -> Result<()>

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

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

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

Formats the value using the given formatter.

impl Default for Capabilities

fn default() -> Capabilities

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Capabilities> for Response

fn from(capabilities: Capabilities) -> Self

Converts to this type from the input type.

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for Capabilities

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

where __S: Serializer,

Serialize this value into the given Serde serializer.