Enum ruma_common::api::AuthScheme

pub enum AuthScheme {
    None,
    AccessToken,
    AccessTokenOptional,
    AppserviceToken,
    ServerSignatures,
}

Available on crate feature api only.

Authentication scheme used by the endpoint.

Variants

None

No authentication is performed.

AccessToken

Authentication is performed by including an access token in the Authentication http header, or an access_token query parameter.

It is recommended to use the header over the query parameter.

AccessTokenOptional

Authentication is optional, and it is performed by including an access token in the Authentication http header, or an access_token query parameter.

It is recommended to use the header over the query parameter.

AppserviceToken

Authentication is only performed for appservices, by including an access token in the Authentication http header, or an access_token query parameter.

It is recommended to use the header over the query parameter.

ServerSignatures

Authentication is performed by including X-Matrix signatures in the request headers, as defined in the federation API.

Trait Implementations

impl Clone for AuthScheme

fn clone(&self) -> AuthScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthScheme

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

Formats the value using the given formatter.

impl PartialEq for AuthScheme

fn eq(&self, other: &AuthScheme) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for AuthScheme

impl Eq for AuthScheme

impl StructuralPartialEq for AuthScheme