Struct Router

pub struct Router { /* private fields */ }

Used for merging nested trait implementations. This is used when you have multiple trait implementations, instead of taurpc::create_ipc_handler(). Use .merge() to add trait implementations to the router. The trait must be have the #[taurpc::procedures] and the nested routes should have #[taurpc::procedures(path = "path")].

Examples

#[taurpc::procedures]
trait Api { }

#[derive(Clone)]
struct ApiImpl;

#[taurpc::resolveres]
impl Api for ApiImpl { }

#[taurpc::procedures(path = "events")]
trait Events { }

#[derive(Clone)]
struct EventsImpl;

#[taurpc::resolveres]
impl Events for EventsImpl { }

#[tokio::main]
async fn main() {
  let router = Router::new()
    .merge(ApiImpl.into_handler())
    .merge(EventsImpl.into_handler());

  tauri::Builder::default()
    .invoke_handler(router.into_handler())
    .run(tauri::generate_context!())
    .expect("error while running tauri application");
}

Implementations

impl Router

pub fn new() -> Self

pub fn export_config(self, config: Typescript) -> Self

Overwrite specta default TypeScript export options, look at the docs for specta_typescript::Typescript for all the configuration options.

Example:

   let router = Router::new()
       .export_config(
           specta_typescript::Typescript::default()
               .remove_default_header()
               .header("// My header\n")
               .bigint(specta_typescript::BigIntExportBehavior::String),
       )
       .merge(...);

pub fn merge<H: TauRpcHandler<Wry>>(self, handler: H) -> Self

Add routes to the router, accepts a struct for which a #[taurpc::procedures] trait is implemented

   let router = Router::new()
     .merge(ApiImpl.into_handler())
     .merge(EventsImpl.into_handler());

pub fn into_handler(self) -> impl Fn(Invoke<Wry>) -> bool

Create a handler out of the router that allows your IPCs to be called from the frontend, and generate the corresponding types. Use this inside .invoke_handler() on the tauri::Builder.

   tauri::Builder::default()
     .invoke_handler(router.into_handler())
     .run(tauri::generate_context!())
     .expect("error while running tauri application");

Trait Implementations

impl Default for Router

fn default() -> Router

Returns the “default value” for a type.