Enum TokenPurpose 

#[non_exhaustive]
pub enum TokenPurpose {
    PasswordReset,
    EmailVerification,
    EmailChange,
    EmailChangeCancel,
    TwoFactorChallenge,
    TwoFactorEmailCode,
}

What an AuthToken does when used. Stored as its snake_case name in a text column, so a purpose a later release adds needs no migration.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PasswordReset

A mailed link that sets a new password.

EmailVerification

A mailed link that proves the account reads the address it was mailed to.

EmailChange

A link mailed to a new address that makes it the account’s.

EmailChangeCancel

A link mailed to the old address that cancels a pending change.

TwoFactorChallenge

A sign-in whose password verified, waiting for its second factor.

TwoFactorEmailCode

A code mailed as a second factor, to sign in or to set the factor up.

Trait Implementations

impl Assign<TokenPurpose> for TokenPurpose

fn into_assignment(self) -> Assignment<TokenPurpose>

Convert into an Assignment<T> value.

fn assign(self, assignments: &mut Assignments, projection: Projection)

where Self: Sized,

Record one or more assignments into the given [Assignments] map at the specified projection.

impl Clone for TokenPurpose

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TokenPurpose

impl Debug for TokenPurpose

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

Formats the value using the given formatter.

impl Embed for TokenPurpose

fn id() -> ModelId

Unique identifier for this embedded type within the schema.

fn schema() -> Model

Returns the schema definition for this embedded type.

fn path_root() -> Path<Self, Self>

where Self: Sized,

An identity Path rooted at this embedded type.

fn path_field<U>(index: usize) -> Path<Self, U>

where Self: Sized,

A Path from this embedded type to the field at index.

impl Eq for TokenPurpose

impl Field for TokenPurpose

type ExprTarget = TokenPurpose

The expression-level type of this field.

type Path<__Origin> = TokenPurposeFields<__Origin>

The type returned when accessing this field from a Fields struct. For primitives, this is Path<Origin, Self>. For embedded types, this is {Type}Fields.

type ListPath<__Origin> = TokenPurposeListFields<__Origin>

The type returned when accessing this field from a list Fields struct. For primitives, this is Path<Origin, ListSelf::ExprTarget>. For embedded types, this is {Type}ListFields.

type Update<'a> = ()

The type of the update builder for this field. For embedded types, this is {Type}Update<’a>. For primitives, this will be {Type}Update<’a> once implemented.

type Inner = TokenPurpose

The unwrapped type used for foreign key filter expressions. Primitives map to themselves. Wrappers like Option<T>, Box<T>, Arc<T>, and Rc<T> map to T::Inner.

fn new_path<__Origin>(path: Path<__Origin, Self>) -> Self::Path<__Origin>

Build a field path from a raw path of the field’s Self::ExprTarget.

fn new_list_path<__Origin>( path: Path<__Origin, List<Self::ExprTarget>>, ) -> Self::ListPath<__Origin>

Build a list field path from a raw path. For primitives, returns the path as-is. For embedded types, wraps the path in a ListFields struct.

fn new_update<'a>( _assignments: &'a mut Assignments, _projection: Projection, ) -> Self::Update<'a>

Build an update builder from assignments and a projection. For primitives, this returns () (no builder). For embedded types, this is overridden to construct the {Type}Update builder.

fn field_ty(storage_ty: Option<Type>) -> FieldTy

Returns the app-level field type for this primitive. Default implementation returns a Primitive field type. Embedded types override this to return Embedded field type.

fn key_constraint<__Origin>( &self, target: Path<__Origin, Self::Inner>, ) -> Expr<bool>

Build a boolean filter expression comparing this field value against a target path. Used by generated belongs-to accessors to build FK lookups.

fn register(model_set: &mut ModelSet)

Register any models referenced by this field type into the given ModelSet.

const NULLABLE: bool = false

Whether or not the type is nullable

const DEFERRED: bool = false

Whether this field is omitted from default loads.

impl IndexableField for TokenPurpose

impl IntoExpr<TokenPurpose> for TokenPurpose

fn into_expr(self) -> Expr<TokenPurpose>

Consume self and produce an Expr<T>.

fn by_ref(&self) -> Expr<TokenPurpose>

Produce an Expr<T> from a reference without consuming self.

impl Load for TokenPurpose

type Output = TokenPurpose

The concrete type produced by load.

fn ty() -> Type

Returns the stmt::Type that describes values of this type.

fn load(value: Value) -> Result<Self>

Deserialize a database Value into Self::Output.

fn reload(target: &mut Self, value: Value) -> Result<()>

Reload the value in-place from a value returned by the database.

fn ty_relation() -> Type

Returns the stmt::Type used when this type appears as a relation target. The default delegates to ty().

fn load_relation(value: Value) -> Result<Self::Output, Error>

Deserialize a value that was loaded as a relation target.

impl PartialEq for TokenPurpose

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Scalar for TokenPurpose

impl StructuralPartialEq for TokenPurpose