crux_core 0.18.0

Cross-platform app development in 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

#[cfg(feature = "facet_typegen")]
use crate::type_generation::facet::TypeGenError;

/// Operation trait links together input and output of a side-effect.
///
/// You implement `Operation` on the payload sent by the capability to the shell using [`CapabilityContext::request_from_shell`].
///
/// For example (from `crux_http`):
///
/// ```rust,ignore
/// impl Operation for HttpRequest {
///     type Output = HttpResponse;
/// }
/// ```
pub trait Operation: Send + 'static {
    /// `Output` assigns the type this request results in.
    type Output: Send + Unpin + 'static;

    #[cfg(feature = "typegen")]
    #[allow(clippy::missing_errors_doc)]
    fn register_types(
        generator: &mut crate::type_generation::serde::TypeGen,
    ) -> crate::type_generation::serde::Result
    where
        Self: serde::Serialize + for<'de> serde::de::Deserialize<'de>,
        Self::Output: for<'de> serde::de::Deserialize<'de>,
    {
        generator.register_type::<Self>()?;
        generator.register_type::<Self::Output>()?;
        Ok(())
    }

    #[cfg(feature = "facet_typegen")]
    #[allow(clippy::missing_errors_doc)]
    fn register_types_facet<'a>(
        generator: &mut crate::type_generation::facet::TypeRegistry,
    ) -> Result<&mut crate::type_generation::facet::TypeRegistry, TypeGenError>
    where
        Self: facet::Facet<'a> + serde::Serialize + for<'de> serde::de::Deserialize<'de>,
        <Self as Operation>::Output: facet::Facet<'a> + for<'de> serde::de::Deserialize<'de>,
    {
        generator
            .register_type::<Self>()
            .map_err(|e| TypeGenError::Generation(e.to_string()))?
            .register_type::<Self::Output>()
            .map_err(|e| TypeGenError::Generation(e.to_string()))?;

        Ok(generator)
    }
}