Enum AuthEvent 

pub enum AuthEvent {
    BeforeRegister,
    AfterRegister,
    BeforeLogin,
    AfterLogin,
    BeforeApiKey,
    AfterApiKey,
}

One point in an auth endpoint’s lifecycle at which a function may run.

These are declared in the user model’s ordinary [hooks] section, next to its CRUD hooks, and are only meaningful there — the built-in endpoints are the user resource’s other door. They sit alongside the HookEvents rather than replacing them: registration is still a create on user, so before_create / after_create fire there too.

Variants

BeforeRegister

AfterRegister

BeforeLogin

AfterLogin

BeforeApiKey

AfterApiKey

Implementations

impl AuthEvent

pub const ALL: [AuthEvent; 6]

Every event, in lifecycle order.

pub fn as_str(self) -> &'static str

The TOML key / wire name, e.g. "before_login".

pub fn action(self) -> &'static str

The endpoint this event belongs to ("register", "login", "api_key").

pub fn phase(self) -> &'static str

"before" or "after".

pub fn is_before(self) -> bool

Whether this event fires ahead of the work the endpoint does.

Trait Implementations

impl Clone for AuthEvent

fn clone(&self) -> AuthEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AuthEvent

impl Debug for AuthEvent

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

Formats the value using the given formatter.

impl Eq for AuthEvent

impl Hash for AuthEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AuthEvent

fn cmp(&self, other: &AuthEvent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AuthEvent

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AuthEvent

fn partial_cmp(&self, other: &AuthEvent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for AuthEvent