Struct Router

pub struct Router { /* private fields */ }

A struct representing the router for navigation.

Implementations

impl Router

pub fn new( history: AnyHistory, basename: &'static str, route: &'static str, components: HashMap<&'static str, ComponentInfo>, fetching_routes: HashSet<String>, events: EventListener, error_component: Html, pathname: &'static str, query: Value, as_path: &'static str, subscriptions: Vec<Callback<ComponentInfo>>, component_load_cancel: Callback<()>, ) -> Self

Creates a new router instance.

Arguments

• history - The history instance for navigation.
• basename - The base URL for the router.
• route - The default route for the router.
• components - A mapping of route names to component information.
• fetching_routes - Set of routes currently being fetched.
• events - Event listener for handling router events.
• error_component - The component to display in case of navigation errors.
• pathname - The current pathname of the router.
• query - The current query parameters of the router.
• as_path - The current path as a string.
• subscriptions - List of callbacks for component information updates.
• component_load_cancel - Callback for cancelling component loading.

Returns

A new Router instance.

pub fn basename(&self) -> &'static str

Returns the basename of the current router.

pub fn back(&self)

Navigates back by one page.

pub fn forward(&self)

Navigates forward by one page.

pub fn go(&self, delta: isize)

Navigates to a specific page with a delta relative to the current page.

Arguments

• delta - The number of pages to navigate (positive for forward, negative for backward).

See: https://developer.mozilla.org/en-US/docs/Web/API/History/go

pub fn push(&mut self, route: &'static str)

Pushes a route onto the history stack.

Arguments

• route - The route to be pushed.

pub fn replace(&mut self, route: &'static str)

Replaces the current history entry with the provided route.

Arguments

• route - The route to replace the current history entry.

pub fn push_with_state(&mut self, route: &'static str, state: &'static str)

Pushes a route onto the history stack with state.

Arguments

• route - The route to be pushed.
• state - The state to be associated with the route.

pub fn replace_with_state(&mut self, route: &'static str, state: &'static str)

Replaces the current history entry with the provided route and state.

Arguments

• route - The route to replace the current history entry.
• state - The state to be associated with the route.

pub fn push_with_query( &mut self, route: &'static str, query: &Value, ) -> NavigationResult<()>

Pushes a route onto the history stack with query parameters.

Arguments

• route - The route to be pushed.
• query - The query parameters to be associated with the route.

Returns

A NavigationResult indicating the success of the operation.

pub fn push_with_query_and_state( &mut self, route: &'static str, query: &Value, state: &'static str, ) -> NavigationResult<()>

Pushes a route onto the history stack with query parameters and state.

Arguments

• route - The route to be pushed.
• query - The query parameters to be associated with the route.
• state - The state to be associated with the route.

Returns

A NavigationResult indicating the success of the operation.

pub fn replace_with_query_and_state( &mut self, route: &'static str, query: &Value, state: Value, ) -> NavigationResult<()>

Replaces the current history entry with the provided route, query parameters, and state.

Arguments

• route - The route to replace the current history entry.
• query - The query parameters to be associated with the route.
• state - The state to be associated with the route.

Returns

A NavigationResult indicating the success of the operation.

pub fn kind(&self) -> RouterKind

Returns the kind of the router.

Returns

A RouterKind enum representing the type of the router.

pub fn prefix_basename<'a>(&self, route_s: &'a str) -> Cow<'a, str>

Prefixes the basename to the route.

Arguments

• route_s - The route to prefix with the basename.

Returns

A Cow<'a, str> containing the combined route with the basename.

pub fn strip_basename<'a>(&self, path: Cow<'a, str>) -> Cow<'a, str>

Strips the basename from the path.

Arguments

• path - The path to strip the basename from.

Returns

A Cow<'a, str> containing the path with the basename stripped.

pub fn prefetch(&mut self, url: &'static str)

Prefetches the specified URL by fetching its route information.

Arguments

• url - The URL to prefetch.

Trait Implementations

impl Clone for Router

fn clone(&self) -> Router

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Router

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

Formats the value using the given formatter.

impl PartialEq for Router

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