Enum GuardResult 

pub enum GuardResult {
    Allow,
    Deny {
        reason: String,
    },
    Redirect {
        to: String,
        reason: Option<String>,
    },
}

Available on crate feature guard only.

Result of a guard check

Variants

Allow

Allow navigation to proceed

Deny

Deny navigation with a reason

Fields

reason: String

Reason for denying navigation

Redirect

Redirect to a different path

Fields

to: String

Path to redirect to

reason: Option<String>

Reason for redirect (optional)

Implementations

impl GuardResult

pub fn allow() -> Self

Create an allow result

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

Create a deny result with reason

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

Create a redirect result

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

Create a redirect result with reason

pub fn is_allow(&self) -> bool

Check if result is allow

pub fn is_deny(&self) -> bool

Check if result is deny

pub fn is_redirect(&self) -> bool

Check if result is redirect

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

Get redirect path if this is a redirect

Trait Implementations

impl Clone for GuardResult

fn clone(&self) -> GuardResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuardResult

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

Formats the value using the given formatter.

impl PartialEq for GuardResult

fn eq(&self, other: &GuardResult) -> 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 GuardResult