Enum NavError 

#[non_exhaustive]
pub enum NavError {
    RouteNotFound,
    InvalidRoute(String),
    NavigationCancelled,
}

Errors that can occur during navigation operations.

Returned by navigation hooks and helper functions when something goes wrong while resolving or activating a route.

Stability

This enum is #[non_exhaustive]: future minor releases may add new variants without bumping the major version. Consumers matching on NavError must include a wildcard arm (_ =>) so the match remains exhaustive across upgrades.

use yew_nav_link::NavError;

fn describe(err: &NavError) -> &'static str {
    match err {
        NavError::RouteNotFound => "missing route",
        NavError::InvalidRoute(_) => "bad route",
        NavError::NavigationCancelled => "cancelled",
        // Required because NavError is non_exhaustive.
        _ => "unknown navigation error"
    }
}

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.

RouteNotFound

The target route does not match any registered route.

InvalidRoute(String)

A route string could not be parsed. Contains a diagnostic message.

NavigationCancelled

Navigation was cancelled before completion.

Implementations

impl NavError

pub const fn route_not_found() -> Self

Creates a NavError::RouteNotFound error.

pub fn invalid_route<S: Into<String>>(msg: S) -> Self

Creates a NavError::InvalidRoute error with the given message.

pub const fn navigation_cancelled() -> Self

Creates a NavError::NavigationCancelled error.

Trait Implementations

impl Clone for NavError

fn clone(&self) -> NavError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavError

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

Formats the value using the given formatter.

impl Display for NavError

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

Formats the value using the given formatter.

impl Error for NavError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for NavError

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

impl StructuralPartialEq for NavError