Enum ruma_api::SendAccessToken[−][src]

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

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

Variants

IfRequired(&'a str)
Expand description

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

Always(&'a str)
Expand description

Always add the access token

None
Expand description

Don’t add an access token. This will lead to an error if the request endpoint requires authentication

Implementations

impl<'a> SendAccessToken<'a>[src]

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

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>[src]

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

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

Trait Implementations

impl<'a> Clone for SendAccessToken<'a>[src]

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

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'a> Debug for SendAccessToken<'a>[src]

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

Formats the value using the given formatter. Read more

impl<'a> Copy for SendAccessToken<'a>[src]

Auto Trait Implementations

impl<'a> RefUnwindSafe for SendAccessToken<'a>

impl<'a> Send for SendAccessToken<'a>

impl<'a> Sync for SendAccessToken<'a>

impl<'a> Unpin for SendAccessToken<'a>

impl<'a> UnwindSafe for SendAccessToken<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.