Skip to main content

MagicCodeStore

Struct MagicCodeStore 

Source
pub struct MagicCodeStore { /* private fields */ }
Expand description

A magic-code store. Wraps a MagicCodeBackend (in-memory by default) and applies the verify/cooldown semantics. Hydrates the in-memory cache from the backend on construction so durable backends survive restart without losing in-flight codes.

Implementations§

Source§

impl MagicCodeStore

Source

pub fn new() -> Self

Source

pub fn with_backend(backend: Box<dyn MagicCodeBackend>) -> Self

Build a magic-code store backed by a persistent backend. Existing live codes are hydrated into the in-memory cache on construction so a server restart between “send” and “verify” doesn’t kill the user’s pending login.

Source

pub fn create(&self, email: &str) -> String

Generate a 6-digit code for an email and return it. Subject to a per-email cooldown — returns the error-shape via try_create.

Source

pub fn try_create(&self, email: &str) -> Result<String, MagicCodeError>

Create a magic code, enforcing per-email cooldown. Returns the code or an error describing why one couldn’t be issued.

Source

pub fn verify(&self, email: &str, code: &str) -> bool

Verify a code for an email. Returns true if valid and not expired. Uses constant-time comparison to prevent timing attacks. Back-compat wrapper around [try_verify].

Source

pub fn list_all_unfiltered(&self) -> Vec<MagicCode>

Verify a code. Returns a typed error so callers can surface specific messages. On the MAX_ATTEMPTS-th failure, the code is burned — even correct subsequent attempts return TooManyAttempts. Every magic code currently in the cache. Powers the Studio “Auth tables” view; not for app use. Includes expired codes — the cache only drops them on next verify attempt for that email.

Source

pub fn try_verify(&self, email: &str, code: &str) -> Result<(), MagicCodeError>

Trait Implementations§

Source§

impl Default for MagicCodeStore

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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