Struct HomeserverToken 

pub struct HomeserverToken;

Available on crate feature api and (crate features appservice-api-c or appservice-api-s) and (crate features client or server) only.

Authentication is required, and can only be performed by a homeserver sending a request to an appservice, by including a homeserver 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 HomeserverToken

type Output = String

The homeserver token.

type Input<'a> = &'a str

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: <HomeserverToken as AuthScheme>::Input<'_>, ) -> Result<(), <HomeserverToken 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<<HomeserverToken as AuthScheme>::Output, <HomeserverToken as AuthScheme>::ExtractAuthenticationError>

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

impl Clone for HomeserverToken

fn clone(&self) -> HomeserverToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HomeserverToken

impl Debug for HomeserverToken

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

Formats the value using the given formatter.

impl Default for HomeserverToken

fn default() -> HomeserverToken

Returns the “default value” for a type.