desaturate 0.0.2

This package aims to makes it easier to maintain a single code base for both regular and async functions.
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
122
123
124
125
126

//! ### Recursion
#![cfg_attr(
    all(
        feature = "generate-async",
        feature = "generate-blocking",
        feature = "macros"
    ),
    doc = r#"
This code may look innocent, but it will fail to compile with error [`E0720`]:
```compile_fail
# use desaturate::desaturate;
#[desaturate]
async fn recursive(arg: i32) -> i32 {
    if arg <= 1 {
        1
    } else {
        arg * recurse(arg - 1).await
    }
}
```
The [`impl Desaturated<_>`] patterns removes the ability to perform recursive calls. To perform
recursion, we must use `Box<dyn _>`. Unfortunately, as this uses dynamic dispatch, this comes with
a small runtime performance cost.
```
# use desaturate::{Blocking, desaturate, IntoDesaturatedWith, Desaturated, boxed::{BoxedDesaturated, BoxedDesaturatedWith}};
# use core::{pin::Pin, future::Future};

#[desaturate]
async fn recursive(arg: i32) -> i32 {
    if arg <= 1 {
        1
    } else {
        let dyn_recursive =
            recursive
                .boxed_future_with()
                .desaturate_with(arg - 1,
                                 recursive.boxed_blocking_with());
        arg * dyn_recursive.await
    }
}

# #[tokio::main]
async fn main() {
    assert_eq!(recursive(5).await, recursive(5).call())
}
```
[`impl Desaturated<_>`]: Desaturated
[`E0720`]: https://doc.rust-lang.org/error_codes/E0720.html
"#
)]
use crate::{macros::features, Desaturated};
use core::{future::Future, pin::Pin};

/// A trait to enable dynamic dispatching for [`desaturate()`].
///
/// [`desaturate()`]: crate::IntoDesaturated::desaturate
pub trait BoxedDesaturated<'a, Out> {
    type BoxedFuture: Future<Output = Out>;
    type BoxedBlocking: FnOnce() -> Out;
    fn boxed_future(self) -> Self::BoxedFuture;
    fn boxed_blocking(self) -> Self::BoxedBlocking;
}
impl<'a, Out, D: Desaturated<Out> + 'a> BoxedDesaturated<'a, Out> for D {
    type BoxedFuture = Pin<Box<dyn Future<Output = Out> + 'a>>;
    #[inline(always)]
    fn boxed_future(self) -> Self::BoxedFuture {
        features! {async:
            Box::pin(self.into_future())
        }
        features! {!async:
            use core::future::IntoFuture;
            Box::pin(async {panic!(r#"Called a the blocking function of a Desaturated without the "generate-blocking" feature flag"#) }.into_future())
        }
    }
    type BoxedBlocking = Box<dyn FnOnce() -> Out + 'a>;
    #[inline(always)]
    fn boxed_blocking(self) -> Self::BoxedBlocking {
        features! {fn:
            Box::new(move || {
                self.call()
            })
        }
        features! {!fn:
            Box::new(|| panic!(r#"Called a the blocking function of a Desaturated without the "generate-blocking" feature flag"#))
        }
    }
}
/// A trait to enable dynamic dispatching for [`desaturate_with()`].
///
/// [`desaturate_with()`]: crate::IntoDesaturated::desaturate
pub trait BoxedDesaturatedWith<'a, Args, Out> {
    type BoxedFuture: FnOnce(Args) -> Pin<Box<dyn Future<Output = Out> + 'a>>;
    features! {fn:
        type BoxedBlocking: FnOnce(Args) -> Out;
    }
    features! {!fn:
        type BoxedBlocking;
    }
    fn boxed_future_with(self) -> Self::BoxedFuture;
    fn boxed_blocking_with(self) -> Self::BoxedBlocking;
}
impl<'a, Out, Args: 'a, D: Desaturated<Out> + 'a, F: FnOnce(Args) -> D + 'a>
    BoxedDesaturatedWith<'a, Args, Out> for F
{
    type BoxedFuture = Box<dyn FnOnce(Args) -> Pin<Box<dyn Future<Output = Out> + 'a>> + 'a>;
    type BoxedBlocking = Box<dyn FnOnce(Args) -> Out + 'a>;
    #[inline(always)]
    fn boxed_future_with(self) -> Self::BoxedFuture {
        features! {async:
            Box::new(move |args| Box::pin(self(args).into_future()))
        }
        features! {!async:
            use core::future::IntoFuture;
            Box::new(|_| Box::pin(async { panic!(r#"Called a the async function of a DesaturatedWith without the "generate-async" feature flag"#) }.into_future()))
        }
    }
    #[inline(always)]
    fn boxed_blocking_with(self) -> Self::BoxedBlocking {
        features! {fn:
            Box::new(move |args| self(args).call())
        }
        features! {!fn:
            Box::new(|_| panic!(r#"Called a the blocking function of a BoxedDesaturatedWith without the "generate-blocking" feature flag"#))
        }
    }
}