Struct oxide_auth::frontends::simple::extensions::Extended

pub struct Extended<Inner, Extension> {
    pub inner: Inner,
    pub addons: Extension,
}

An inner endpoint with simple extensions.

If the inner endpoint had any extension, it will simply never be provided to any flow and overwritten. Therefore, this is mainly useful for other endpoints that did not implement extensions by themselves such as frontends::simple::endpoint::Generic.

Fields

inner: Inner

Endpoint being extended. This field is pub for oxide-auth-async be able to implement async version of some traits.

addons: Extension

Extensions of the endpoint. This field is pub for oxide-auth-async be able to implement async version of some traits.

Implementations

impl<Inner> Extended<Inner, AddonList>

pub fn new(inner: Inner) -> Self

Wrap an endpoint with a standard extension system.

impl<Inner, E> Extended<Inner, E>

pub fn extend_with(inner: Inner, extension: E) -> Self

Wrap an inner endpoint with a preconstructed extension instance.

pub fn extension(&self) -> &E

A reference to the extension.

pub fn extension_mut(&mut self) -> &mut E

A mutable reference to the extension.

Trait Implementations

impl<Request, Inner, Ext> Endpoint<Request> for Extended<Inner, Ext>where Request: WebRequest, Inner: Endpoint<Request>, Ext: Extension,

type Error = <Inner as Endpoint<Request>>::Error

The error typed used as the error representation of each flow.

fn registrar(&self) -> Option<&dyn Registrar>

A registrar if this endpoint can access one.

fn authorizer_mut(&mut self) -> Option<&mut dyn Authorizer>

An authorizer if this endpoint can access one.

fn issuer_mut(&mut self) -> Option<&mut dyn Issuer>

An issuer if this endpoint can access one.

fn owner_solicitor(&mut self) -> Option<&mut dyn OwnerSolicitor<Request>>

Return the system that checks owner consent.

fn scopes(&mut self) -> Option<&mut dyn Scopes<Request>>

Determine the required scopes for a request.

fn response( &mut self, request: &mut Request, kind: Template<'_> ) -> Result<Request::Response, Self::Error>

Generate a prototype response.

fn error(&mut self, err: OAuthError) -> Self::Error

Wrap an error.

fn web_error(&mut self, err: Request::Error) -> Self::Error

Wrap an error in the request/response types.

fn extension(&mut self) -> Option<&mut dyn Extension>

Get the central extension instance this endpoint.