Enum ruma::api::SendAccessToken

pub enum SendAccessToken<'a> {
    IfRequired(&'a str),
    Always(&'a str),
    Appservice(&'a str),
    None,
}

Available on crate feature api only.

An enum to control whether an access token should be added to outgoing requests

Variants

IfRequired(&'a str)

Add the given access token to the request only if the METADATA on the request requires it.

Always(&'a str)

Always add the access token.

Appservice(&'a str)

Add the given appservice token to the request only if the METADATA on the request requires it.

None

Don’t add an access token.

This will lead to an error if the request endpoint requires authentication

Implementations

impl<'a> SendAccessToken<'a>

pub fn get_required_for_endpoint(self) -> Option<&'a str>

Get the access token for an endpoint that requires one.

Returns Some(_) if self contains an access token.

pub fn get_not_required_for_endpoint(self) -> Option<&'a str>

Get the access token for an endpoint that should not require one.

Returns Some(_) only if self is SendAccessToken::Always(_).

pub fn get_required_for_appservice(self) -> Option<&'a str>

Gets the access token for an endpoint that requires one for appservices.

Returns Some(_) if self is either SendAccessToken::Appservice(_) or SendAccessToken::Always(_)

Trait Implementations

impl<'a> Clone for SendAccessToken<'a>

fn clone(&self) -> SendAccessToken<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SendAccessToken<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for SendAccessToken<'a>