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
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

use std::fmt::{self, Debug};

use crate::{
    capability::Operation,
    core::resolve::{RequestHandle, Resolvable, ResolveError},
};

/// Request represents an effect request from the core to the shell.
///
/// The `operation` is the input needed to process the effect, and will be one
/// of the capabilities' [`Operation`] types.
///
/// The request can be resolved by passing it to `Core::resolve` along with the
/// corresponding result of type `Operation::Output`.
pub struct Request<Op>
where
    Op: Operation,
{
    pub operation: Op,
    pub handle: RequestHandle<Op::Output>,
}

impl<Op> Request<Op>
where
    Op: Operation,
{
    /// Resolve the request with the given output.
    /// # Errors
    /// Returns an error if the request does not expect to be resolved.
    pub fn resolve(&mut self, output: Op::Output) -> Result<(), ResolveError> {
        self.handle.resolve(output)
    }

    pub fn split(self) -> (Op, RequestHandle<Op::Output>) {
        (self.operation, self.handle)
    }

    pub(crate) fn resolves_never(operation: Op) -> Self {
        Self {
            operation,
            handle: RequestHandle::Never,
        }
    }

    pub(crate) fn resolves_once<F>(operation: Op, resolve: F) -> Self
    where
        F: FnOnce(Op::Output) + Send + 'static,
    {
        Self {
            operation,
            handle: RequestHandle::Once(Box::new(resolve)),
        }
    }

    pub(crate) fn resolves_many_times<F>(operation: Op, resolve: F) -> Self
    where
        F: Fn(Op::Output) -> Result<(), ()> + Send + 'static,
    {
        Self {
            operation,
            handle: RequestHandle::Many(Box::new(resolve)),
        }
    }
}

impl<Op> Resolvable<Op::Output> for Request<Op>
where
    Op: Operation,
{
    /// Resolve the request with the given output.
    ///
    /// Note: This method should only be used in tests that work directly with
    /// [`Command`](crate::command::Command).
    /// If you are using [`AppTester`](crate::testing::AppTester) to test your app,
    /// you should use [`AppTester::resolve`](crate::testing::AppTester::resolve) instead.
    ///
    /// # Errors
    ///
    /// Errors if the request cannot (or should not) be resolved.
    fn resolve(&mut self, output: Op::Output) -> Result<(), ResolveError> {
        self.resolve(output)
    }
}

impl<Op> fmt::Debug for Request<Op>
where
    Op: Operation + Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("Request").field(&self.operation).finish()
    }
}