Skip to main content

AuthInitContext

Struct AuthInitContext 

Source
pub struct AuthInitContext<S: AuthSchema> {
    pub config: Arc<AuthConfig>,
    pub database: Arc<dyn AuthStore<S>>,
    pub email_provider: Option<Arc<dyn EmailProvider>>,
    pub metadata: HashMap<String, Value>,
    pub extensions: ContextExtensions,
}
Expand description

Initialization context passed to plugin setup.

Fields§

§config: Arc<AuthConfig>§database: Arc<dyn AuthStore<S>>§email_provider: Option<Arc<dyn EmailProvider>>§metadata: HashMap<String, Value>§extensions: ContextExtensions

Implementations§

Source§

impl<S: AuthSchema> AuthInitContext<S>

Source

pub fn new(config: Arc<AuthConfig>, database: Arc<dyn AuthStore<S>>) -> Self

Source

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

Source

pub fn register_password_hash_hook(&mut self, hook: Arc<dyn PasswordHashHook>)

Decorate the instance’s actual password hashing boundary. Later registrations run first, matching initialized hash wrappers.

Source

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

Source

pub fn register_user_create_transform<F>(&mut self, transform: F)
where F: Fn(CreateUser) -> AuthResult<CreateUser> + Send + Sync + 'static,

Register a transform for user creation, including transactional creation.

Source

pub fn register_user_creation_adapter_default<F>(&mut self, default: F)
where F: Fn(CreateUser) -> AuthResult<CreateUser> + Send + Sync + 'static,

Register model defaults applied after creation hooks to an identity candidate admitted by the configured user validation policy.

Source

pub fn register_user_update_transform<F>(&mut self, transform: F)
where F: Fn(&str, UpdateUser) -> AuthResult<UpdateUser> + Send + Sync + 'static,

Register a transform applied to every user update through this auth instance.

Source

pub fn register_session_created_hook( &mut self, callback: Arc<dyn SessionCreatedHook<S>>, )

Register an adapter lifecycle callback for each committed session creation. Transactional creations defer callbacks until commit and discard them on rollback. A callback error propagates after persistence, as for other adapter after callbacks. Trusted server operations have no request context.

Source

pub fn register_adapter_after_hook( &mut self, callback: Arc<dyn AdapterAfterHook<S>>, )

Observe genuine retained adapter output after a write, with transaction callbacks deferred until commit. Existing typed physical hooks are separate.

Source

pub fn register_session_deletion_hook( &mut self, hook: Arc<dyn SessionDeletionHook<S>>, )

Register instance-local dependant work around successful session deletion.

Source

pub fn database_with_registered_transforms(&self) -> Arc<dyn AuthStore<S>> ⓘ

Finalize the instance’s store without mutating a shared underlying adapter.

Source

pub fn set_email_verification_override( &mut self, sender: Arc<dyn VerificationEmailOverride<S>>, )

Source

pub fn into_parts(self) -> AuthInitParts

Trait Implementations§

Source§

impl<S: AuthSchema> Debug for AuthInitContext<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for AuthInitContext<S>

§

impl<S> !UnwindSafe for AuthInitContext<S>

§

impl<S> Freeze for AuthInitContext<S>
where Arc<dyn AuthStore<S>>: Freeze,

§

impl<S> Send for AuthInitContext<S>
where Arc<dyn AuthStore<S>>: Send,

§

impl<S> Sync for AuthInitContext<S>
where Arc<dyn AuthStore<S>>: Sync,

§

impl<S> Unpin for AuthInitContext<S>
where Arc<dyn AuthStore<S>>: Unpin,

§

impl<S> UnsafeUnpin for AuthInitContext<S>
where Arc<dyn AuthStore<S>>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more