Skip to main content

RouteObserver

Struct RouteObserver 

Source
pub struct RouteObserver { /* private fields */ }
Expand description

The reactive route-state observable: RouteObserver is the signal face over frust_widgets’ signal-free RouteStack/NavChange — the counterpart to RouteNavigator (intent, queued requests) that reads fact (the last-published stack) instead. Construct once (typically in Component::init) and attach with observe(navigator(...)); RouterDeepLinks::routes hands out the one it wired for a router-driven navigator. See route_state’s module docs for why this bridge lives in the facade rather than frust-widgets. Reactive face of one navigator’s route stack: Copy + Send + Sync (five RwSignals and nothing else), so it rides provide_context — the navigator’s own NavigatorController/ Router never can (see frust_widgets::nav::route’s module docs for why).

Implementations§

Source§

impl RouteObserver

Source

pub fn new() -> Self

A fresh observer at rest (NavChange::Initial, depth 0, generation 0, no current route) — construct once, typically in Component::init, and keep the result in State.

Source

pub fn observe<State: 'static>( self, view: NavigatorView<State>, ) -> NavigatorView<State>

Attach: installs NavigatorView::on_route_change, writing these signals from inside the navigator’s own rebuild whenever the published RouteStack actually changes. Chainable and cheap to call again (RouteObserver is Copy), so a second navigator elsewhere in the app gets its own observer the same way: state.routes.observe(navigator(&controller, initial)).

§Wake correctness

The write happens inside the navigator’s rebuild, after apply_ops: a navigation requested in frame N is published in N, read by the app’s build in N+1, and the write itself schedules N+1 — the same tracked-write-wakes-the-shell bridge every other signal in the framework rides (docs/CODE_STANDARDS.md’s tracked-scope rule), not a manual ReactiveRuntime::wake() call. One frame behind is possible; silently behind is not (a page transition runs ~300ms; 16ms of bar lag is below the perceptual floor).

Source

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

The topmost page that has a route — skips a route-less (overlay/dialog) page on top, the read chrome (an app bar title, e.g.) wants. Tracked read; see RouteStack::current_route’s doc for the full contract.

Source

pub fn path(&self) -> String

current’s path, or an empty string before the first publish (or if no page in the stack carries a route at all).

Source

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

A query parameter off current’s location. None if there is no current routed page, or the key is absent.

Source

pub fn stack(&self) -> Vec<Option<Location>>

The full stack, bottom→top; None at a route-less (overlay/dialog) page — the tracked-read mirror of RouteStack::entries.

Source

pub fn depth(&self) -> usize

The stack depth as of the last publish.

Source

pub fn change(&self) -> NavChange

The diff label for the most recent publish — see NavChange.

Source

pub fn is_back(&self) -> bool

Whether the most recent change was a NavChange::Pop — the direction chrome resolves a title-transition from, e.g. .title_direction(if routes.is_back() { Back } else { Forward }).

Trait Implementations§

Source§

impl Clone for RouteObserver

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RouteObserver

Source§

impl Default for RouteObserver

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more