Struct AccessTokenOptional 

pub struct AccessTokenOptional;

Available on crate feature api only.

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

Using the query parameter is deprecated since Matrix 1.11.

Trait Implementations

impl AuthScheme for AccessTokenOptional

type Output = Option<String>

The access token, if any.

type Input<'a> = SendAccessToken<'a>

The input necessary to generate the authentication.

type AddAuthenticationError = InvalidHeaderValue

The error type returned from add_authentication().

type ExtractAuthenticationError = ExtractTokenError

The error type returned from extract_authentication().

fn add_authentication<T>( request: &mut Request<T>, access_token: SendAccessToken<'_>, ) -> Result<(), <AccessTokenOptional as AuthScheme>::AddAuthenticationError>

where T: AsRef<[u8]>,

Add this authentication scheme to the given outgoing request, if necessary.

fn extract_authentication<T>( request: &Request<T>, ) -> Result<Option<String>, <AccessTokenOptional as AuthScheme>::ExtractAuthenticationError>

where T: AsRef<[u8]>,

Extract the data of this authentication scheme from the given incoming request.

impl Clone for AccessTokenOptional

fn clone(&self) -> AccessTokenOptional

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccessTokenOptional

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

Formats the value using the given formatter.

impl Default for AccessTokenOptional

fn default() -> AccessTokenOptional

Returns the “default value” for a type.

impl Copy for AccessTokenOptional