Struct oxide_auth::frontends::rocket::OAuthRequest

pub struct OAuthRequest<'r> { /* fields omitted */ }

Request guard that also buffers OAuth data internally.

WebRequest etc. is implemented for the basic rocket::Request<'r> as well. Both have the same error and result types but of course we can not simply implement the former as a request guard with special semantics. Therefore, we wrap in here and at the same time buffer all the computed state such as parameter checking and normalization.

Methods

impl<'r> OAuthRequest<'r>

pub fn new<'a>(request: &'a Request<'r>) -> Self

Create the request data from request headers.

Some oauth methods need additionally the body data which you can attach later.

pub fn add_body(&mut self, data: Data)

Provide the body of the request.

Some, but not all operations, require reading their data from a urlencoded POST body. To simplify the implementation of primitives and handlers, this type is the central request type for both these use cases. When you forget to provide the body to a request, the oauth system will return an error the moment the request is used.

Trait Implementations

impl<'r> WebRequest for OAuthRequest<'r>

type Error = WebError

The error generated from access of malformed or invalid requests.

type Response = Response<'r>

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.

impl<'a, 'r> FromRequest<'a, 'r> for OAuthRequest<'r>

type Error = NoError

The associated error to be returned if derivation fails.

fn from_request(
    request: &'a Request<'r>
) -> Outcome<Self, (Status, Self::Error), ()>

Derives an instance of Self from the incoming request metadata.