Struct Router 

pub struct Router<State> { /* private fields */ }

A router for actions that can be invoked as services.

Implementations

impl<State> Router<State>

where State: Clone + Send + Sync + 'static,

pub fn new() -> Self

Create a new action router.

pub fn capture<T>(&self, path: impl AsRef<str>) -> Result<T, PathError>

where T: DeserializeOwned,

Given a path, attempt to deserialize the path fragments into a given type.

pub fn handle_frame_with_state(&self, frame: Frame, state: State) -> FrameFuture

Call an action with a given state.

pub fn insert<ActionHandler, Args>( &mut self, route: impl Into<String>, given_action: ActionHandler, ) -> Result<()>

where ActionHandler: Handler<Args, State> + Clone + Send + Sync + 'static, Args: Clone + Send + Sync + 'static,

Insert a new action into the router, turning it into an [ActionEndpoint].

pub fn routes(&self) -> Vec<String>

Get the routes that have been mounted so far.

pub fn endpoints(&self) -> Vec<Endpoint<State>>

where State: Clone + Send + 'static,

Get the actions that have been mounted so far, wrapped in layers that prevent their invocation whenever called by the wrong route.

pub fn scope( &mut self, route: impl Into<String>, other: Router<State>, ) -> Result<()>

where State: Clone + Send + 'static,

Merge another system context into this one.

Trait Implementations

impl<State: Clone> Clone for Router<State>

fn clone(&self) -> Router<State>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<State> Debug for Router<State>

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

Formats the value using the given formatter.

impl<State: Default> Default for Router<State>

fn default() -> Router<State>

Returns the “default value” for a type.

impl<State> From<Router<State>> for SystemContext<State>

fn from(router: Router<State>) -> Self

Converts to this type from the input type.