Skip to main content

AuthContext

Struct AuthContext 

Source
pub struct AuthContext<DB: DatabaseAdapter> {
    pub config: Arc<AuthConfig>,
    pub database: Arc<DB>,
    pub email_provider: Option<Arc<dyn EmailProvider>>,
    pub metadata: HashMap<String, Value>,
}
Expand description

Context passed to plugin methods

Fields§

§config: Arc<AuthConfig>§database: Arc<DB>§email_provider: Option<Arc<dyn EmailProvider>>§metadata: HashMap<String, Value>

Implementations§

Source§

impl<DB: DatabaseAdapter> AuthContext<DB>

Source

pub fn new(config: Arc<AuthConfig>, database: Arc<DB>) -> Self

Source

pub fn set_metadata(&mut self, key: impl Into<String>, value: Value)

Source

pub fn get_metadata(&self, key: &str) -> Option<&Value>

Source

pub fn email_provider(&self) -> AuthResult<&dyn EmailProvider>

Get the email provider, returning an error if none is configured.

Source

pub async fn require_session( &self, req: &AuthRequest, ) -> AuthResult<(DB::User, DB::Session)>

Extract a session token from the request, validate the session, and return the authenticated (User, Session) pair.

This centralises the pattern previously duplicated across many plugins (get_authenticated_user, require_session, etc.).

Auto Trait Implementations§

§

impl<DB> Freeze for AuthContext<DB>

§

impl<DB> !RefUnwindSafe for AuthContext<DB>

§

impl<DB> Send for AuthContext<DB>

§

impl<DB> Sync for AuthContext<DB>

§

impl<DB> Unpin for AuthContext<DB>

§

impl<DB> UnsafeUnpin for AuthContext<DB>

§

impl<DB> !UnwindSafe for AuthContext<DB>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.