Struct yew_router::agent::RouteAgent

pub struct RouteAgent<STATE = ()> where
    STATE: RouteState,  { /* fields omitted */ }

The RouteAgent holds on to the RouteService singleton and mediates access to it.

It serves as a means to propagate messages to components interested in the state of the current route.

Warning

All routing-related components/agents/services should use the same type parameter across your application.

If you use multiple agents with different types, then the Agents won’t be able to communicate to each other and associated components may not work as intended.

Trait Implementations

impl<STATE> Agent for RouteAgent<STATE> where
    STATE: RouteState, 

type Input = RouteRequest<STATE>

Incoming message type.

type Message = Msg<STATE>

Type of an input message.

type Output = Route<STATE>

Outgoing message type.

type Reach = Context<Self>

Reach capability of the agent.

fn create(link: AgentLink<RouteAgent<STATE>>) -> Self

Creates an instance of an agent.

fn update(&mut self, msg: Self::Message)

This method called on every update message.

fn connected(&mut self, id: HandlerId)

This method called on when a new bridge created.

fn handle_input(&mut self, msg: Self::Input, who: HandlerId)

This method called on every incoming message.

fn disconnected(&mut self, id: HandlerId)

This method called on when a new bridge destroyed.

fn destroy(&mut self)

This method called when the agent is destroyed.

fn name_of_resource() -> &'static str

Represents the name of loading resorce for remote workers which have to live in a separate files.

fn is_module() -> bool

Signifies if resource is a module. This has pending browser support.

impl<STATE: RouteState> Debug for RouteAgent<STATE>

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

Formats the value using the given formatter.