Router

Struct Router 

Source
pub struct Router<R: Runtime> { /* private fields */ }
Expand description

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 have the #[taurpc::procedures] macro 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§

Source§

impl<R: Runtime> Router<R>

Source

pub fn new() -> Self

Source

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

Overwrite specta’s 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()
               .header("// My header\n")
               .bigint(specta_typescript::BigIntExportBehavior::String),
       )
       .merge(...);
Source

pub fn merge<H: TauRpcHandler<R>>(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());
Source

pub fn into_handler(self) -> impl Fn(Invoke<R>) -> 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§

Source§

impl<R: Default + Runtime> Default for Router<R>

Source§

fn default() -> Router<R>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<R> Freeze for Router<R>

§

impl<R> !RefUnwindSafe for Router<R>

§

impl<R> Send for Router<R>

§

impl<R> Sync for Router<R>

§

impl<R> Unpin for Router<R>

§

impl<R> !UnwindSafe for Router<R>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> ErasedDestructor for T
where T: 'static,