Trait AuthUser 

pub trait AuthUser:
    Clone
    + Send
    + Sync
    + Serialize
    + Debug
    + 'static {
    // Required methods
    fn id(&self) -> Cow<'_, str>;
    fn email(&self) -> Option<&str>;
    fn name(&self) -> Option<&str>;
    fn email_verified(&self) -> bool;
    fn image(&self) -> Option<&str>;
    fn created_at(&self) -> DateTime<Utc>;
    fn updated_at(&self) -> DateTime<Utc>;
    fn username(&self) -> Option<&str>;
    fn display_username(&self) -> Option<&str>;
    fn two_factor_enabled(&self) -> bool;
    fn role(&self) -> Option<&str>;
    fn banned(&self) -> bool;
    fn ban_reason(&self) -> Option<&str>;
    fn ban_expires(&self) -> Option<DateTime<Utc>>;
    fn metadata(&self) -> &Value;

    // Provided methods
    fn secondary_snapshot(&self) -> AuthResult<Value> { ... }
    fn from_secondary_snapshot(_snapshot: Value) -> AuthResult<Self> { ... }
    fn adapter_snapshot(&self) -> Option<&AdapterOutput> { ... }
    fn retained_user_view(&self) -> Option<&UserView> { ... }
    fn additional_fields(&self) -> FieldOutput { ... }
    fn two_factor_enabled_value(&self) -> Option<bool> { ... }
    fn banned_value(&self) -> Option<bool> { ... }
    fn is_anonymous(&self) -> Option<bool> { ... }
    fn phone_number(&self) -> Option<&str> { ... }
    fn phone_number_verified(&self) -> Option<bool> { ... }
    fn last_login_method(&self) -> Option<&str> { ... }
}

Trait representing a user entity.

The framework reads user fields through these getters. Custom types must provide all framework fields and may have additional fields.

Required Methods

fn id(&self) -> Cow<'_, str>

fn email(&self) -> Option<&str>

fn name(&self) -> Option<&str>

fn email_verified(&self) -> bool

fn image(&self) -> Option<&str>

fn created_at(&self) -> DateTime<Utc>

fn updated_at(&self) -> DateTime<Utc>

fn username(&self) -> Option<&str>

fn display_username(&self) -> Option<&str>

fn two_factor_enabled(&self) -> bool

fn role(&self) -> Option<&str>

fn banned(&self) -> bool

fn ban_reason(&self) -> Option<&str>

fn ban_expires(&self) -> Option<DateTime<Utc>>

fn metadata(&self) -> &Value

Provided Methods

fn secondary_snapshot(&self) -> AuthResult<Value>

Encode the complete typed model for a trusted secondary backend. Custom entities can opt in without adding a Deserialize bound to all schemas.

fn from_secondary_snapshot(_snapshot: Value) -> AuthResult<Self>

Restore a model from a trusted secondary backend, before public projection.

fn adapter_snapshot(&self) -> Option<&AdapterOutput>

A genuine retained adapter result, including declared undefined values.

fn retained_user_view(&self) -> Option<&UserView>

A chosen authenticated view is already projected and must remain exact.

fn additional_fields(&self) -> FieldOutput

Physical application/plugin values; public policy is applied separately.

fn two_factor_enabled_value(&self) -> Option<bool>

Persisted plugin state. None preserves an absent or unset field.

fn banned_value(&self) -> Option<bool>

Persisted plugin state. None preserves an absent or unset field.

fn is_anonymous(&self) -> Option<bool>

Anonymous-plugin state; None means the field is absent or unset.

fn phone_number(&self) -> Option<&str>

fn phone_number_verified(&self) -> Option<bool>

fn last_login_method(&self) -> Option<&str>

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl AuthUser for UserView

impl<M: AuthUser> AuthUser for AdapterRecord<M>

impl<S: AuthSchema> AuthUser for AuthenticatedUser<S>