Struct AuthGuard 

pub struct AuthGuard { /* private fields */ }

Available on crate feature guard only.

Authentication guard that checks if user is logged in.

Unlike placeholder guards, this guard is fully configurable with a custom authentication check function that you provide.

Example

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

// Define your authentication check
fn is_authenticated(cx: &App) -> bool {
    // Check your auth state here
    cx.try_global::<AuthState>()
        .map(|state| state.is_logged_in())
        .unwrap_or(false)
}

// Use the guard
Route::new("/dashboard", dashboard_page)
    .guard(AuthGuard::new(is_authenticated, "/login"))

Implementations

impl AuthGuard

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

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

Create a new auth guard with a custom check function and redirect path.

Arguments

• check_fn - Function that returns true if the user is authenticated
• redirect_path - Path to redirect to if authentication fails

Example

use gpui_navigator::*;

let guard = AuthGuard::new(
    |cx| cx.try_global::<IsLoggedIn>().is_some(),
    "/login"
);

pub fn allow_all() -> Self

Available on debug-assertions enabled only.

Create an auth guard that always allows access (for testing/development).

Warning: Do not use in production!

pub fn deny_all(redirect_path: impl Into<String>) -> Self

Available on debug-assertions enabled only.

Create an auth guard that always denies access (for testing/development).

Warning: Do not use in production!

Trait Implementations

impl RouteGuard for AuthGuard

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