Struct rpc_router::RouterBuilder

pub struct RouterBuilder { /* private fields */ }

Implementations

impl RouterBuilder

pub fn append_dyn( self, name: &'static str, dyn_handler: Box<dyn RpcHandlerWrapperTrait> ) -> Self

Add a dyn_handler to the router builder.

RouterBuilder::default().add_dyn("method_name", my_handler_fn.into_dyn());

Note: This is the preferred way to add handlers to the router, as it avoids monomorphization of the add function. The RouterInner also has a .add() as a convenience function to just pass the function. See RouterInner::add for more details.

pub fn append<F, T, P, R>(self, name: &'static str, handler: F) -> Self

where F: Handler<T, P, R> + Clone + Send + Sync + 'static, T: Send + Sync + 'static, P: Send + Sync + 'static, R: Send + Sync + 'static,

Add a route (name, handler function) to the builder

RouterBuilder::default().add("method_name", my_handler_fn);

Note: This is a convenient add function variant with generics, and there will be monomorphed versions of this function for each type passed. Use RouterInner::add_dyn to avoid this.

pub fn extend(self, other_builder: RouterBuilder) -> Self

Extends this builder by consuming another builder.

pub fn append_resource<T>(self, val: T) -> Self

where T: FromResources + Clone + Send + Sync + 'static,

pub fn extend_resources( self, resources_builder: Option<ResourcesBuilder> ) -> Self

If Some, will extends the current Base Resources with the content of this resources_builder. If None, just do nothing.

pub fn set_resources(self, resources_builder: ResourcesBuilder) -> Self

Resets the router’s resources with the contents of this ResourcesBuilder.

Ensure to call append_resource and/or .extend_resources afterwards if they operation needs to be included.

Note: .extend_resources(Option<ResourcesBuilder>) is the additive function typically used.

pub fn build(self) -> Router

Builds the RpcRouter from this builder. This is the typical usage, with the RpcRouter being encapsulated in an Arc, indicating it is designed for cloning and sharing across tasks/threads.

Trait Implementations

impl Debug for RouterBuilder

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

Formats the value using the given formatter.

impl Default for RouterBuilder

fn default() -> RouterBuilder

Returns the “default value” for a type.