Struct oxide_auth::frontends::actix::request::OAuthResponse

pub struct OAuthResponse { /* fields omitted */ }

An http response replacement that can be sent as an actix message.

This is the generic answer to oauth authorization code and bearer token requests.

Methods

impl OAuthResponse

pub fn consent_form(grant: PreGrant) -> Self

Construct a response that represents a consent form.

Use this in an OwnerSolicitor implementation for OAuthRequest to construct the OwnerConsent::InProgress variant.

pub fn new(inner: Response) -> Self

Create the response with predetermined content.

pub fn unwrap(self) -> HttpResponse

Retrive the internal response, assuming that it does not require consent.

pub fn get_or_consent(self, consent: HttpResponse) -> HttpResponse

Convert the response into an http response.

When the response represents a required consent form, use the argument as the response to the user agent instead. This replacement response should generally display the wanting client and required scopes in a clear and click-jacking protected manner to the authenticated resource owner. When the resource owner is not currently authenticated (i.e. logged in), this is a good opportunity to redirect to such a login page.

pub fn get_or_consent_with<F>(self, f: F) -> HttpResponse where
    F: FnOnce(PreGrant) -> HttpResponse, 

Convert the response into an http response.

When the response represents a required consent form, use the provided function to construct the response to the user agent instead. This replacement response should generally display the wanting client and required scopes in a clear and click-jacking protected manner to the authenticated resource owner. When the resource owner is not currently authenticated (i.e. logged in), this is a good opportunity to redirect to such a login page.

Trait Implementations

impl WebResponse for OAuthResponse

type Error = OAuthError

The error generated when trying to construct an unhandled or invalid response.

fn ok(&mut self) -> Result<(), Self::Error>

Set the response status to 200.

fn redirect(&mut self, url: Url) -> Result<(), Self::Error>

A response which will redirect the user-agent to which the response is issued.

fn client_error(&mut self) -> Result<(), Self::Error>

Set the response status to 400.

fn unauthorized(&mut self, kind: &str) -> Result<(), Self::Error>

Set the response status to 401 and add a WWW-Authenticate header.

fn body_text(&mut self, text: &str) -> Result<(), Self::Error>

A pure text response with no special media type set.

fn body_json(&mut self, data: &str) -> Result<(), Self::Error>

Json repsonse data, with media type `aplication/json.

impl Default for OAuthResponse

fn default() -> OAuthResponse

Returns the "default value" for a type.

impl Clone for OAuthResponse

fn clone(&self) -> OAuthResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthResponse

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

Formats the value using the given formatter.