rpc-rs 0.1.1

A blazingly fast, lightweight, and type-safe RPC/IPC framework for Rust and Web/Tauri-based applications, based on `specta`.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

//! The procedure module.

use std::{borrow::Cow, future::Future};

use async_trait::async_trait;
use serde::{de::DeserializeOwned, Serialize};
use serde_json::Error;
use specta::{function::FunctionDataType, Type, TypeMap};

use crate::util::TripleS;

/// A generic procedure. This is required to allow for any procedure
/// to be used in a [`rpc_rs::Module`].
#[async_trait]
pub trait GenericProcedure<Cx: Send + Sync> {
    /// Run this procedure with the context and a JSON-encoded string
    /// representing the data required.
    async fn run(&self, cx: Cx, data: String) -> Result<String, Error>;

    /// Get the [`FunctionDataType`] of this procedure.
    fn specta_type(&self, name: Cow<'static, str>, map: &mut TypeMap) -> FunctionDataType;
}

#[async_trait]
impl<
        Cx: TripleS + Clone,
        Output: Send + Sync + Serialize + Type,
        Arg: Send + Sync + 'static + DeserializeOwned + Type,
    > GenericProcedure<Cx> for WrappedProcedure<Cx, Output, Arg>
{
    async fn run(&self, cx: Cx, mut data: String) -> Result<String, Error> {
        if data.is_empty() {
            data = String::from("null");
        }

        serde_json::to_string(&self.0.exec(cx, serde_json::from_str(&data)?).await)
    }

    fn specta_type(&self, name: Cow<'static, str>, map: &mut TypeMap) -> FunctionDataType {
        self.0.specta_type(name, map)
    }
}

/// A generic-wrapped [`Procedure`].
///
/// This is necessary so the [`GenericProcedure`] trait can be
/// implemented in an object-safe manner.
pub struct WrappedProcedure<
    Cx: TripleS + Clone,
    Output: Send + Sync + Serialize + Type,
    Arg: Send + Sync + 'static + DeserializeOwned + Type,
>(Box<dyn Procedure<Cx, Output, Arg> + Send + Sync>);

/// A procedure.
#[async_trait]
pub trait Procedure<
    Cx: TripleS + Clone,
    Output: Send + Sync + Serialize + Type,
    Arg: Send + Sync + DeserializeOwned + Type,
>
{
    /// Run this procedure with its context and data.
    async fn exec(&self, cx: Cx, data: Arg) -> Output;
}

/// A typed extension to [`Procedure`].
pub trait TypedProcedure<
    Cx: TripleS + Clone,
    Output: Send + Sync + Serialize + Type,
    Arg: Send + Sync + DeserializeOwned + Type,
>: Procedure<Cx, Output, Arg>
{
    /// Get the [`FunctionDataType`] of this procedure.
    fn specta_type(&self, name: Cow<'static, str>, map: &mut TypeMap) -> FunctionDataType;
}

#[async_trait]
impl<
        Cx: TripleS + Clone,
        Output: Send + Sync + Serialize + Type,
        Fut: Future<Output = Output> + Send,
        Arg: Send + Sync + 'static + DeserializeOwned + Type,
        Func: (Fn(Cx, Arg) -> Fut) + Send + Sync + 'static,
    > Procedure<Cx, Output, Arg> for Func
{
    async fn exec(&self, cx: Cx, data: Arg) -> Output {
        self(cx, data).await
    }
}

impl<
        Cx: TripleS + Clone,
        Output: Send + Sync + Serialize + Type,
        Arg: Send + Sync + 'static + DeserializeOwned + Type,
        Proc: Procedure<Cx, Output, Arg> + ?Sized,
    > TypedProcedure<Cx, Output, Arg> for Proc
{
    fn specta_type(&self, name: Cow<'static, str>, map: &mut TypeMap) -> FunctionDataType {
        FunctionDataType {
            args: vec![("data".into(), Arg::reference(map, &[]).inner)],
            asyncness: true,
            deprecated: None,
            name,
            docs: "".into(),
            result: Some(Output::reference(map, &[]).inner),
        }
    }
}

/// Wrap any [`Procedure`], converting it to a [`WrappedProcedure`]
/// which implements the [`GenericProcedure`] trait.
pub fn wrap<
    Cx: TripleS + Clone,
    Output: Send + Sync + Serialize + Type,
    Arg: Send + Sync + 'static + DeserializeOwned + Type,
    Proc: Procedure<Cx, Output, Arg> + Send + Sync + 'static,
>(
    proc: Proc,
) -> WrappedProcedure<Cx, Output, Arg> {
    WrappedProcedure(Box::new(proc))
}