Struct RouteNavigator 

pub struct RouteNavigator { /* private fields */ }

The declarative router vocabulary (a go_router-subset layer), flat-re-exported from frust-widgets so app code never names that crate directly: Router resolves a location against a Route table (built via RouteBuilder) into Resolution/ResolvedPages driving a NavigatorController, with :param/query parsing (Location/PathPattern/RouteParams), per-route/top-level Redirects (loop-guarded at DEFAULT_REDIRECT_LIMIT), and an ErrorBuilder fallback for an unmatched location.

A page builder receives the location’s query merged under its path captures, so /terminal?session=abc reads its own parameter.

RouteNavigator is the seam a screen navigates through: a Send + Sync queue of NavRequest data (paths and names, never closures) that rides provide_context — the Router itself cannot, since it holds Rc page builders. RouterDeepLinks::track drains it every rebuild, so a request queued in an event handler (on any thread — the queue never panics off-thread) applies on the next frame.

shell_route is the nested-navigator binding: its children resolve onto a second NavigatorController the app owns and its own page — the chrome wrapping that inner navigator — stays retained while they do, so navigating between siblings inside the shell never rebuilds the chrome. See its docs for the keep rule and the per-verb table. The context-reachable navigation handle: Send + Sync + 'static, cheap to clone (one Arc), and safe to hold in app state, in a callback, or under provide_context. See the module docs for why it carries data instead of a router reference.

Obtain one from Router::route_navigator; the router it came from applies whatever is queued on its next pump.

Implementations

impl RouteNavigator

pub fn new() -> RouteNavigator

A fresh, empty navigator with no waker installed. Apps get one from Router::route_navigator rather than constructing it directly.

pub fn request(&self, request: NavRequest)

Queue request and fire the waker. The single append path every convenience method below routes through.

pub fn go(&self, location: impl Into<String>)

Queue a NavRequest::Go — reset the stack to location’s chain.

pub fn push(&self, location: impl Into<String>)

Queue a NavRequest::Push — stack location’s leaf page.

pub fn replace(&self, location: impl Into<String>)

Queue a NavRequest::Replace — swap the top page for location’s leaf.

pub fn pop(&self)

Queue a NavRequest::Pop.

pub fn go_named( &self, name: impl Into<String>, params: BTreeMap<String, String>, )

Queue a NavRequest::GoNamed.

pub fn push_named( &self, name: impl Into<String>, params: BTreeMap<String, String>, )

Queue a NavRequest::PushNamed.

pub fn location(&self) -> Option<Location>

The last Location the router resolved (post-redirect), including the one an unmatched location fell back to the error page with. None before the first navigation.

Not updated by pop: the router keeps no history stack, so after a pop this still reports the location that pushed the popped page.

pub fn set_waker(&self, waker: Arc<dyn Fn() + Sync + Send>)

Install the “wake the shell” callback fired after every append. The facade installs ReactiveRuntime::wake when it wires the router; a navigator with no waker still queues correctly, it just relies on something else to schedule the next frame.

pub fn drain(&self) -> Vec<NavRequest>

Take every queued request in append order, leaving the queue empty. Router::pump is the only caller in normal use.

Trait Implementations

impl Clone for RouteNavigator

fn clone(&self) -> RouteNavigator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteNavigator

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

Formats the value using the given formatter.

impl Default for RouteNavigator

fn default() -> RouteNavigator

Returns the “default value” for a type.