Enum ruma_common::api::SendAccessToken
source · pub enum SendAccessToken<'a> {
IfRequired(&'a str),
Always(&'a str),
Appservice(&'a str),
None,
}
api
only.Expand description
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§
source§impl<'a> SendAccessToken<'a>
impl<'a> SendAccessToken<'a>
sourcepub fn get_required_for_endpoint(self) -> Option<&'a str>
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.
sourcepub fn get_not_required_for_endpoint(self) -> Option<&'a str>
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(_)
.
sourcepub fn get_required_for_appservice(self) -> Option<&'a str>
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§
source§impl<'a> Clone for SendAccessToken<'a>
impl<'a> Clone for SendAccessToken<'a>
source§fn clone(&self) -> SendAccessToken<'a>
fn clone(&self) -> SendAccessToken<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for SendAccessToken<'a>
impl<'a> Debug for SendAccessToken<'a>
impl<'a> Copy for SendAccessToken<'a>
Auto Trait Implementations§
impl<'a> Freeze for SendAccessToken<'a>
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)