RouterTask

Struct RouterTask 

Source
pub struct RouterTask<CTX: 'static, COMP: Component<CTX>> { /* private fields */ }
Expand description

TODO: A handle which helps to cancel the router. Uses removeEventListener

Implementations§

Source§

impl<'a, CTX: 'a, COMP: Component<CTX>> RouterTask<CTX, COMP>

Source

pub fn new( env: &mut Env<'a, CTX, COMP>, route_fn: &'static dyn Fn(RouteInfo) -> COMP::Message, ) -> Self

Start the Routing Task in the environment.

Ownership of this Task should typically be put in the Model.

Routing will stop if this Task is dropped.

Source

pub fn current_url(&self) -> Url

Retrieve the current url of the application.

Source

pub fn push_state(&self, state: Value, title: &str, url: Url) -> COMP::Message

Set the state of the history, including the url.

This will not trigger the router to change. If a state change is required it is the user’s job to propogate the Message.

Source

pub fn push_hash(&self, hash: Option<&str>) -> COMP::Message

Push a hash based on the current url.

Trait Implementations§

Source§

impl<CTX, COMP: Component<CTX>> Drop for RouterTask<CTX, COMP>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<CTX, COMP> Freeze for RouterTask<CTX, COMP>

§

impl<CTX, COMP> !RefUnwindSafe for RouterTask<CTX, COMP>

§

impl<CTX, COMP> !Send for RouterTask<CTX, COMP>

§

impl<CTX, COMP> !Sync for RouterTask<CTX, COMP>

§

impl<CTX, COMP> Unpin for RouterTask<CTX, COMP>

§

impl<CTX, COMP> !UnwindSafe for RouterTask<CTX, COMP>

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> 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, 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.
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.