Struct AdminCapability 

#[non_exhaustive]
pub struct AdminCapability {
    pub allowed_scopes: BTreeSet<OAuthClientScope>,
}

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

Information about the m.admin capability. (MSC4540)

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.

allowed_scopes: BTreeSet<OAuthClientScope>

The scopes the device may request to access administrative functionality.

Implementations

impl AdminCapability

pub fn new(allowed_scopes: BTreeSet<OAuthClientScope>) -> AdminCapability

Create a new AdminCapability.

pub fn is_admin(&self) -> bool

Returns whether the capability indicates that the authenticated user is able to access some administrative functionality.

pub fn is_scope_allowed(&self, scope: &OAuthClientScope) -> bool

Returns whether the admin functionality gated by a particular scope is available to the authenticated user.

Trait Implementations

impl Clone for AdminCapability

fn clone(&self) -> AdminCapability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdminCapability

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

Formats the value using the given formatter.

impl Default for AdminCapability

fn default() -> AdminCapability

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AdminCapability

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AdminCapability

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.