Struct RouteService

pub struct RouteService<STATE = ()> { /* private fields */ }

A service that facilitates manipulation of the browser’s URL bar and responding to browser events when users press ‘forward’ or ‘back’.

The T determines what route state can be stored in the route service.

Implementations

impl<T> RouteService<T>

pub fn new() -> RouteService<T>

Creates the route service.

pub fn get_path(&self) -> String

Gets the path name of the current url.

pub fn get_query(&self) -> String

Gets the query string of the current url.

pub fn get_fragment(&self) -> String

Gets the fragment of the current url.

impl<STATE> RouteService<STATE>

where STATE: RouteState,

pub fn register_callback(&mut self, callback: Callback<Route<STATE>>)

Registers a callback to the route service. Callbacks will be called when the History API experiences a change such as popping a state off of its stack when the forward or back buttons are pressed.

pub fn set_route(&mut self, route: &str, state: STATE)

Sets the browser’s url bar to contain the provided route, and creates a history entry that can be navigated via the forward and back buttons.

The route should be a relative path that starts with a /.

pub fn replace_route(&mut self, route: &str, state: STATE)

Replaces the route with another one removing the most recent history event and creating another history event in its place.

pub fn get_route(&self) -> Route<STATE>

Gets the concatenated path, query, and fragment.

Trait Implementations

impl<STATE: Debug> Debug for RouteService<STATE>

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

Formats the value using the given formatter.

impl<STATE> Default for RouteService<STATE>

where STATE: RouteState,

fn default() -> Self

Returns the “default value” for a type.