Struct GoRouterState 

pub struct GoRouterState { /* private fields */ }

Where a page is: what location it was reached at, which route it is, and what the location said — the values of the path’s :parameters, and the query.

Implementations

impl GoRouterState

pub fn entering(&self) -> f32

How far into view this page is: 1.0 once it has settled, and while a transition brings it in or takes it out, the number that transition is driven by — 0.0 not yet arrived. A page that wants to move its own contents as it arrives reads it, and one that does not ignores it.

pub fn location(&self) -> &str

The whole location, query included: /users/42?tab=posts.

pub fn path(&self) -> &str

The pattern of the route that answered: /users/:id. Empty when no route did.

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

The route’s name, if it has one.

pub fn param(&self, name: &str) -> Option<&str>

The value of the path parameter name — 42 for :id in /users/42.

pub fn params(&self) -> &HashMap<String, String>

Every path parameter of the location.

pub fn query(&self, name: &str) -> Option<&str>

The value of the query parameter name — posts for tab in ?tab=posts. When it is given more than once, the last one.

pub fn query_params(&self) -> &HashMap<String, String>

Every query parameter of the location.

pub fn extra<T>(&self) -> Option<Rc<T>>

where T: 'static,

The object that came along with the navigation (GoRouter::go_with_extra), if it is a T.

Trait Implementations

impl Clone for GoRouterState

fn clone(&self) -> GoRouterState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoRouterState

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

Formats the value using the given formatter.