Skip to main content

SuperAdminToken

Struct SuperAdminToken 

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

An opaque token that authorizes RLS bypass.

Create via one of the named constructors:

External code cannot fabricate this token — it has a private field and no public field constructor.

§Usage

let token = SuperAdminToken::for_system_process("cron::cleanup");
let ctx = RlsContext::super_admin(token);
assert!(ctx.bypasses_rls());

Implementations§

Source§

impl SuperAdminToken

Source

pub fn for_system_process(_reason: &str) -> Self

Issue a token for a system/background process.

Use for cron jobs, startup introspection, and internal cross-tenant maintenance paths. For shared/public reference data, prefer RlsContext::global() instead of bypass.

The _reason parameter documents intent at the call site (e.g. "cron::check_expired_holds"). Drivers like qail-pg may log it via tracing.

Source

pub fn for_webhook(_source: &str) -> Self

Issue a token for an inbound webhook or gateway trigger.

Use for Meta WhatsApp callbacks, Xendit payment callbacks, and gateway event triggers that are authenticated via shared secret (X-Trigger-Secret) rather than JWT.

Source

pub fn for_auth(_operation: &str) -> Self

Issue a token for an authentication operation.

Use for login, register, token refresh, and admin-claims resolution — operations that necessarily run before (or outside) a tenant scope is known.

Trait Implementations§

Source§

impl Clone for SuperAdminToken

Source§

fn clone(&self) -> SuperAdminToken

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SuperAdminToken

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SuperAdminToken

Source§

impl PartialEq for SuperAdminToken

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SuperAdminToken

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ColumnValue<Value> for T

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.