Skip to main content

AuthInitContext

Struct AuthInitContext 

Source
pub struct AuthInitContext<S: AuthSchema> {
    pub extensions: RuntimeExtensions,
    pub email_verification_policy: EmailVerificationRuntimePolicy,
    pub config: Arc<AuthConfig>,
    pub database: Arc<dyn AuthStore<S>>,
    pub email_provider: Option<Arc<dyn EmailProvider>>,
    pub secondary_storage: Option<Arc<dyn SecondaryStorage>>,
    pub password_policy: PasswordRuntimePolicy,
    pub metadata: MetadataMap,
    /* private fields */
}
Expand description

Initialization context passed to plugin setup.

Fields§

§extensions: RuntimeExtensions§email_verification_policy: EmailVerificationRuntimePolicy§config: Arc<AuthConfig>§database: Arc<dyn AuthStore<S>>§email_provider: Option<Arc<dyn EmailProvider>>§secondary_storage: Option<Arc<dyn SecondaryStorage>>§password_policy: PasswordRuntimePolicy§metadata: MetadataMap

Implementations§

Source§

impl<S: AuthSchema> AuthInitContext<S>

Source

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

Source

pub async fn initialize_request_context(&mut self) -> AuthResult<()>

Resolve initial URL and trust options before plugin initialization.

Source

pub fn register_user_fields(&mut self, fields: UserConfig)

Register user schema fields in plugin registration order.

Source

pub fn register_model_fields( &mut self, role: EntityRole, fields: UserConfig, ) -> AuthResult<()>

Register adapter fields for core models, Organization, Team, or supported plugin display fields. Other plugin roles and fields return a configuration error.

Source

pub fn register_custom_model( &mut self, name: impl Into<String>, model_name: Option<&str>, fields: UserConfig, ) -> AuthResult<()>

Declare a custom model for runtime reference resolution and adapter schema metadata. Repeated declarations merge field policies and replace the physical model name. Omitted or empty physical names use the logical name. Native logical names are reserved. The application’s storage adapter must provide custom model operations and migrations.

Source

pub fn register_database_hook(&mut self, hook: Arc<dyn DatabaseHooks<S>>)

Register a database hook before application-owned adapter hooks.

Source

pub fn runtime(&self) -> PluginRuntime<S>

Obtain a weak handle that resolves after all store facades are installed.

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 into_parts(self) -> AuthInitParts<S>

Auto Trait Implementations§

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