Struct oxide_auth_actix::OAuthRequest

pub struct OAuthRequest { /* private fields */ }

Type implementing WebRequest as well as FromRequest for use in route handlers

This type consumes the body of the HttpRequest upon extraction, so be careful not to use it in places you also expect an application payload

Implementations

impl OAuthRequest

pub async fn new(req: HttpRequest, payload: Payload) -> Result<Self, WebError>

Create a new OAuthRequest from an HttpRequest and Payload

pub fn authorization_header(&self) -> Option<&str>

Fetch the authorization header from the request

pub fn query(&self) -> Option<&NormalizedParameter>

Fetch the query for this request

pub fn query_mut(&mut self) -> Option<&mut NormalizedParameter>

Fetch the query mutably

pub fn body(&self) -> Option<&NormalizedParameter>

Fetch the body of the request

Trait Implementations

impl Clone for OAuthRequest

fn clone(&self) -> OAuthRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthRequest

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

Formats the value using the given formatter.

impl From<OAuthResource> for OAuthRequest

fn from(o: OAuthResource) -> Self

Performs the conversion.

impl FromRequest for OAuthRequest

type Error = WebError

The associated error which can be returned.

type Future = LocalBoxFuture<'static, Result<Self, Self::Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

impl WebRequest for OAuthRequest

type Error = WebError

The error generated from access of malformed or invalid requests.

type Response = OAuthResponse

The corresponding type of Responses returned from this module.

fn query(
    &mut self
) -> Result<Cow<'_, dyn QueryParameter + 'static>, Self::Error>

Retrieve a parsed version of the url query.

fn urlbody(
    &mut self
) -> Result<Cow<'_, dyn QueryParameter + 'static>, Self::Error>

Retrieve the parsed application/x-form-urlencoded body of the request.

fn authheader(&mut self) -> Result<Option<Cow<'_, str>>, Self::Error>

Contents of the authorization header or none if none exists. An Err value indicates a malformed header or request.