Skip to main content

Router

Struct Router 

Source
pub struct Router<Msg> { /* private fields */ }
Expand description

A reactive router that owns the current location and re-resolves the route table on navigation.

Router is cheap to clone (internally Rc-backed) and integrates with the existing reactive Signal so effects subscribed to Router::signal re-run on every navigation — that is how a backend rebuilds the UI tree.

Implementations§

Source§

impl<Msg> Router<Msg>

Source

pub fn new(table: RouteTable<Msg>, initial_path: &str) -> Self

Builds a router from a RouteTable, starting at initial_path.

Source

pub fn current_path(&self) -> String

The current path.

Source

pub fn navigate(&self, path: &str)

Navigates to path, updating the location signal (which re-triggers any subscribed effects). A backend typically also syncs the browser URL.

Source

pub fn signal(&self) -> Signal<String>

Returns the location signal so effects can subscribe to navigation.

Source

pub fn current_view(&self) -> UITree<Msg>

Resolves the current path to a view.

Trait Implementations§

Source§

impl<Msg> Clone for Router<Msg>

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

Auto Trait Implementations§

§

impl<Msg> !RefUnwindSafe for Router<Msg>

§

impl<Msg> !Send for Router<Msg>

§

impl<Msg> !Sync for Router<Msg>

§

impl<Msg> !UnwindSafe for Router<Msg>

§

impl<Msg> Freeze for Router<Msg>

§

impl<Msg> Unpin for Router<Msg>

§

impl<Msg> UnsafeUnpin for Router<Msg>

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.