Struct RoleGuard 

pub struct RoleGuard { /* private fields */ }

Available on crate feature guard only.

Role-based authorization guard.

Checks if user has required role for accessing a route. You must provide a function that extracts the user’s role from your application state.

Example

use gpui_navigator::*;
use gpui::App;

// Define how to get user's role
fn get_user_role(cx: &App) -> Option<String> {
    cx.try_global::<CurrentUser>()
        .map(|user| user.role.clone())
}

// Use the guard
Route::new("/admin", admin_page)
    .guard(RoleGuard::new(get_user_role, "admin", Some("/forbidden")))

Implementations

impl RoleGuard

pub fn new<F>( role_extractor: F, required_role: impl Into<String>, redirect_path: Option<impl Into<String>>, ) -> Self

where F: Fn(&App) -> Option<String> + Send + Sync + 'static,

Create a new role guard with a role extractor function.

Arguments

• role_extractor - Function that returns the user’s current role (if any)
• required_role - The role required to access the route
• redirect_path - Optional path to redirect to if authorization fails

Example

use gpui_navigator::*;

let guard = RoleGuard::new(
    |cx| cx.try_global::<UserRole>().map(|r| r.0.clone()),
    "admin",
    Some("/forbidden")
);

Trait Implementations

impl RouteGuard for RoleGuard

type Future = Pin<Box<dyn Future<Output = GuardResult> + Send>>

The future returned by check

fn check(&self, cx: &App, _request: &NavigationRequest) -> Self::Future

Check if navigation should be allowed

fn name(&self) -> &str

Get guard name (for debugging and error messages)

fn priority(&self) -> i32

Optional priority for guard execution order