result-transformer-flow 0.0.1

Traits, macros and utilities for transforming Result values.
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

//! Flow utilities for transforming only the `Ok` variant asynchronously.
//!
//! These helpers are built using `async fn` and are lightweight. When possible,
//! implement an `AsyncOkTransformer` yourself instead of composing flows.

use std::marker::PhantomData;

/// A transformation that operates on the success value of an asynchronous computation.
pub trait AsyncOkFlow<InputOk> {
    /// Resulting success type after the flow is applied.
    type OutputOk;

    /// Apply the transformation to the provided value.
    fn apply_ok_async<'a>(
        &'a self,
        input: InputOk,
    ) -> impl Future<Output = Self::OutputOk> + Send + 'a;

    /// Chain another [`AsyncOkFlow`] to be executed after this one.
    fn then_async_ok<Next>(self, next: Next) -> AsyncOkFlowChain<Self, Next, InputOk>
    where
        Self: Sized,
        Next: AsyncOkFlow<Self::OutputOk>,
    {
        AsyncOkFlowChain {
            head: self,
            next,
            _phantom: PhantomData,
        }
    }
}

/// Composition of two [`AsyncOkFlow`] implementations.
pub struct AsyncOkFlowChain<Head, Next, InputOk>
where
    Head: AsyncOkFlow<InputOk>,
    Next: AsyncOkFlow<Head::OutputOk>,
{
    head: Head,
    next: Next,
    _phantom: PhantomData<InputOk>,
}

impl<Head, Next, InputOk> AsyncOkFlow<InputOk> for AsyncOkFlowChain<Head, Next, InputOk>
where
    Head: AsyncOkFlow<InputOk> + Send + Sync,
    Next: AsyncOkFlow<Head::OutputOk> + Send + Sync,
    InputOk: Send + Sync,
{
    type OutputOk = Next::OutputOk;

    fn apply_ok_async<'a>(
        &'a self,
        input_ok: InputOk,
    ) -> impl Future<Output = Self::OutputOk> + Send + 'a {
        async {
            let intermediate = self.head.apply_ok_async(input_ok).await;
            self.next.apply_ok_async(intermediate).await
        }
    }
}

// `Clone` implementation when both flows are cloneable
impl<Head, Next, InputOk> Clone for AsyncOkFlowChain<Head, Next, InputOk>
where
    Head: AsyncOkFlow<InputOk> + Clone,
    Next: AsyncOkFlow<Head::OutputOk> + Clone,
{
    fn clone(&self) -> Self {
        Self {
            head: self.head.clone(),
            next: self.next.clone(),
            _phantom: PhantomData,
        }
    }
}

// Optional `Copy` implementation when both flows are copyable
impl<Head, Next, InputOk> Copy for AsyncOkFlowChain<Head, Next, InputOk>
where
    Head: AsyncOkFlow<InputOk> + Copy,
    Next: AsyncOkFlow<Head::OutputOk> + Copy,
{
}