specta 2.0.0-rc.21

Easily export your Rust types to other languages
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

use std::future::Future;

use crate::{datatype::FunctionResultVariant, Type, TypeCollection};

/// Implemented by types that can be returned from a function annotated with
/// [`specta`](crate::specta).
pub trait FunctionResult<TMarker> {
    /// Gets the type of the result as a [`DataType`].
    fn to_datatype(type_map: &mut TypeCollection) -> FunctionResultVariant;
}

#[doc(hidden)]
pub enum FunctionValueMarker {}
impl<T: Type> FunctionResult<FunctionValueMarker> for T {
    fn to_datatype(type_map: &mut TypeCollection) -> FunctionResultVariant {
        FunctionResultVariant::Value(T::reference(type_map, &[]).inner)
    }
}

#[doc(hidden)]
pub enum FunctionResultMarker {}
impl<T: Type, E: Type> FunctionResult<FunctionResultMarker> for Result<T, E> {
    fn to_datatype(type_map: &mut TypeCollection) -> FunctionResultVariant {
        FunctionResultVariant::Result(
            T::reference(type_map, &[]).inner,
            E::reference(type_map, &[]).inner,
        )
    }
}

#[doc(hidden)]
pub enum FunctionFutureMarker {}
impl<F> FunctionResult<FunctionFutureMarker> for F
where
    F: Future,
    F::Output: Type,
{
    fn to_datatype(type_map: &mut TypeCollection) -> FunctionResultVariant {
        FunctionResultVariant::Value(F::Output::reference(type_map, &[]).inner)
    }
}

#[doc(hidden)]
pub enum FunctionResultFutureMarker {}
impl<F, T, E> FunctionResult<FunctionResultFutureMarker> for F
where
    F: Future<Output = Result<T, E>>,
    T: Type,
    E: Type,
{
    fn to_datatype(type_map: &mut TypeCollection) -> FunctionResultVariant {
        FunctionResultVariant::Result(
            T::reference(type_map, &[]).inner,
            E::reference(type_map, &[]).inner,
        )
    }
}