Skip to main content

TokenStoreFn

Struct TokenStoreFn 

Source
pub struct TokenStoreFn<L, S> { /* private fields */ }
Expand description

TokenStore backed by user-supplied load and save async closures.

This is the persistence layer primitive — it plugs into an existing strategy (e.g. AccessKeyStrategy) so that strategy can share its service-token cache across processes. For wiring in a complete acquisition pipeline (e.g. a JS-defined strategy across an FFI boundary), use AuthStrategyFn instead.

Closures deal in JSON strings — the on-the-wire form of Token — not the Token type itself. This keeps the caller’s signatures free of stack-auth internals and matches the natural shape of common storage substrates: a cookie value, a KV blob, a Redis string.

The closure return types are generic so async blocks / async || closures / async fn adapters all compose without boxing.

Secret-material handling. The JSON string passed to the save closure contains the bearer token verbatim (via SecretToken’s #[serde(transparent)] impl). Once the value crosses into the user’s closure, stack-auth has no control over zeroize semantics — implementations should treat the input as secret material and clear any local copies promptly. load wraps the returned string in Zeroizing internally, so the buffer is wiped after deserialisation. End-to-end protection at rest (e.g. encrypting the value before it ever leaves the worker) is tracked as a future EncryptedTokenStore decorator.

Implementations§

Source§

impl<L, S> TokenStoreFn<L, S>

Source

pub fn new(load: L, save: S) -> Self

Build a token store from a load closure (returns the stored JSON, or None if nothing is cached) and a save closure (persists the JSON).

See the module-level documentation for an example.

Trait Implementations§

Source§

impl<L, LF, S, SF> TokenStore for TokenStoreFn<L, S>
where L: Fn() -> LF + Send + Sync, LF: Future<Output = Option<String>> + Send, S: Fn(String) -> SF + Send + Sync, SF: Future<Output = ()> + Send,

Available on non-WebAssembly only.
Source§

async fn load(&self) -> Option<Token>

Load the most recently saved token, or None if none has been stored (or the load failed). Errors are swallowed — the calling state machine falls back to fresh authentication when this returns None.
Source§

async fn save(&self, token: &Token)

Persist a token after a successful refresh or initial authentication. Best-effort — implementations should log on failure rather than returning an error.

Auto Trait Implementations§

§

impl<L, S> Freeze for TokenStoreFn<L, S>
where L: Freeze, S: Freeze,

§

impl<L, S> RefUnwindSafe for TokenStoreFn<L, S>

§

impl<L, S> Send for TokenStoreFn<L, S>
where L: Send, S: Send,

§

impl<L, S> Sync for TokenStoreFn<L, S>
where L: Sync, S: Sync,

§

impl<L, S> Unpin for TokenStoreFn<L, S>
where L: Unpin, S: Unpin,

§

impl<L, S> UnsafeUnpin for TokenStoreFn<L, S>
where L: UnsafeUnpin, S: UnsafeUnpin,

§

impl<L, S> UnwindSafe for TokenStoreFn<L, S>
where L: UnwindSafe, S: UnwindSafe,

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> AuthStrategyBounds for T
where T: Send + Sync + 'static,

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> Fake for T

Source§

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

Source§

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: Rng + ?Sized, Self: FakeBase<U>,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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

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