Skip to main content

AdminAuth

Struct AdminAuth 

Source
pub struct AdminAuth { /* private fields */ }
Available on server only.
Expand description

Authentication and authorization checker for admin panel.

This struct extracts authentication state from the HTTP request and provides methods to check authentication and permissions.

Implementations§

Source§

impl AdminAuth

Source

pub fn from_request(request: &ServerFnRequest) -> Self

Creates a new AdminAuth from a ServerFnRequest.

§Arguments
  • request - The server function request wrapper
§Returns

A new AdminAuth instance

Source

pub fn from_arc_request(request: &Arc<Request>) -> Self

Creates a new AdminAuth from an Arc<Request>.

§Arguments
  • request - The HTTP request
§Returns

A new AdminAuth instance

Source

pub fn auth_state(&self) -> Option<&AuthState>

Returns the AuthState if available.

Source

pub fn is_authenticated(&self) -> bool

Checks if the user is authenticated.

§Returns

true if the user is authenticated, false otherwise

Source

pub fn is_staff(&self) -> bool

Checks if the user is a staff member (admin access).

§Returns

true if the user is staff/admin, false otherwise

Source

pub fn is_active(&self) -> bool

Checks if the user is active.

§Returns

true if the user is active, false otherwise

Source

pub fn user_id(&self) -> Option<&str>

Returns the user ID if authenticated.

Source

pub fn require_authenticated(&self) -> Result<(), ServerFnError>

Requires authentication, returning an error if not authenticated.

§Errors

Returns ServerFnError with status 401 if not authenticated

Source

pub fn require_staff(&self) -> Result<(), ServerFnError>

Requires staff (admin) status, returning an error if not staff.

§Errors

Returns ServerFnError with status 403 if not staff

Source

pub async fn require_model_permission( &self, model_admin: &dyn ModelAdmin, user: &dyn AdminUser, permission: ModelPermission, ) -> Result<(), ServerFnError>

Checks model-level permission using ModelAdmin, returning an error if denied.

This method first verifies staff status, then delegates to the ModelAdmin’s permission method for the specified permission type.

The caller is responsible for providing the authenticated user object extracted from the DI context via AdminAuthenticatedUser. The user is passed as a &dyn AdminUser trait object, which is produced by the type-erased user loader registered during admin route setup.

§Arguments
  • model_admin - The model admin to check permissions against
  • user - The authenticated user object as a trait object
  • permission - The type of permission to check
§Errors

Returns ServerFnError with status 401 if not authenticated, 403 if not staff or if model-level permission is denied

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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