Enum NavigationAction 

#[non_exhaustive]
pub enum NavigationAction {
    Continue,
    Deny {
        reason: String,
    },
    Redirect {
        to: String,
        reason: Option<String>,
    },
}

Result of a navigation check (guard, lifecycle, or middleware).

Used by guards to allow/deny navigation, by lifecycle hooks to continue/abort, and as a general “what should the router do?” answer.

Example

use gpui_navigator::NavigationAction;

let action = NavigationAction::deny("Not authorized");
assert!(action.is_deny());

let action = NavigationAction::redirect("/login");
assert_eq!(action.redirect_path(), Some("/login"));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Continue

Allow navigation to proceed.

Deny

Deny navigation with a reason.

Fields

reason: String

Human-readable reason for denying navigation.

Redirect

Redirect to a different path.

Fields

to: String

Path to redirect to.

reason: Option<String>

Optional human-readable reason for redirecting.

Implementations

impl NavigationAction

pub const fn allow() -> Self

Create a result that allows navigation to proceed (alias for Continue).

pub fn deny(reason: impl Into<String>) -> Self

Create a result that blocks navigation with a human-readable reason.

pub fn redirect(to: impl Into<String>) -> Self

Create a result that redirects navigation to a different path.

pub fn redirect_with_reason( to: impl Into<String>, reason: impl Into<String>, ) -> Self

Create a redirect result with a human-readable reason.

pub const fn is_continue(&self) -> bool

Check if this action allows navigation to continue.

pub const fn is_deny(&self) -> bool

Check if this action denies navigation.

pub const fn is_redirect(&self) -> bool

Check if this action redirects navigation.

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

Get the redirect path, if this is a redirect action.

Trait Implementations

impl Clone for NavigationAction

fn clone(&self) -> NavigationAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavigationAction

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

Formats the value using the given formatter.

impl PartialEq for NavigationAction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for NavigationAction