postcard-rpc 0.12.1

A no_std + serde compatible RPC library for Rust
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

//! Implementations of various Server traits
//!
//! The implementations in this module typically require feature flags to be set.

#[cfg(feature = "embassy-usb-0_5-server")]
pub mod embassy_usb_v0_5;

#[cfg(feature = "embedded-io-async-0_6-server")]
pub mod embedded_io_async_v0_6;

#[cfg(all(target_os = "linux", feature = "usb-gadget"))]
pub mod usb_gadget;

#[cfg(feature = "test-utils")]
pub mod test_channels;

#[cfg(any(
    feature = "embassy-usb-0_5-server",
    feature = "embedded-io-async-0_6-server",
))]
pub(crate) mod embassy_shared {
    use crate::server::WireSpawn;
    use embassy_executor::{SpawnError, SpawnToken, Spawner};

    //////////////////////////////////////////////////////////////////////////////
    // SPAWN
    //////////////////////////////////////////////////////////////////////////////

    /// A [`WireSpawn`] impl using the embassy executor
    #[derive(Clone)]
    pub struct EmbassyWireSpawn {
        /// The embassy-executor spawner
        pub spawner: Spawner,
    }

    impl From<Spawner> for EmbassyWireSpawn {
        fn from(value: Spawner) -> Self {
            Self { spawner: value }
        }
    }

    impl WireSpawn for EmbassyWireSpawn {
        type Error = SpawnError;

        type Info = Spawner;

        fn info(&self) -> &Self::Info {
            &self.spawner
        }
    }

    /// Attempt to spawn the given token
    pub fn embassy_spawn<Sp, S: Sized>(sp: &Sp, tok: SpawnToken<S>) -> Result<(), Sp::Error>
    where
        Sp: WireSpawn<Error = SpawnError, Info = Spawner>,
    {
        let info = sp.info();
        info.spawn(tok)
    }
}

#[cfg(feature = "tokio")]
pub(crate) mod tokio_shared {
    use core::convert::Infallible;
    use tokio::runtime;

    use crate::server::WireSpawn;

    //////////////////////////////////////////////////////////////////////////////
    // SPAWN
    //////////////////////////////////////////////////////////////////////////////

    /// A [`WireSpawn`] impl using the embassy executor
    #[derive(Clone)]
    pub struct TokioWireSpawn {
        /// handle to the current tokio runtime
        pub rt: runtime::Handle,
    }

    impl From<runtime::Handle> for TokioWireSpawn {
        fn from(value: runtime::Handle) -> Self {
            Self { rt: value }
        }
    }

    impl WireSpawn for TokioWireSpawn {
        type Error = Infallible;

        type Info = runtime::Handle;

        fn info(&self) -> &Self::Info {
            &self.rt
        }
    }

    /// Attempt to spawn the given token
    pub fn tokio_spawn<Sp, F>(sp: &Sp, fut: F) -> Result<(), Sp::Error>
    where
        Sp: WireSpawn<Error = Infallible, Info = runtime::Handle>,
        F: std::future::Future<Output = ()> + Send + 'static,
    {
        let info = sp.info();
        info.spawn(fut); // TODO: store handle?

        Ok(())
    }
}