Struct RouterState 

pub struct RouterState {
    pub location: Location,
    pub path_match: Option<PathMatch>,
    pub params: HashMap<SharedString, SharedString>,
}

The global state of the router, including the current location, path match, and parameters. This state is stored globally within the GPUI application context.

Fields

location: Location

The current location in the router.

path_match: Option<PathMatch>

The path match information for the current location.

params: HashMap<SharedString, SharedString>

The dynamic parameters for the current location.

Implementations

impl RouterState

pub fn init(cx: &mut App)

Initializes the RouterState within the GPUI application context. This function sets up the initial state of the router.

pub fn with_path(&mut self, pathname: SharedString) -> &mut Self

Sets the current pathname in the router state.

pub fn global(cx: &App) -> &Self

Retrieves an immutable reference to the global RouterState from the GPUI application context.

pub fn global_mut(cx: &mut App) -> &mut Self

Retrieves a mutable reference to the global RouterState from the GPUI application context.

Trait Implementations

impl Clone for RouterState

fn clone(&self) -> RouterState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for RouterState

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

impl StructuralPartialEq for RouterState