round-based 0.4.1

Driver for MPC protocols
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

//! Async runtime abstraction
//!
//! Runtime abstraction allows the MPC protocol to stay runtime-agnostic while being
//! able to use features that are common to any runtime

/// Async runtime abstraction
///
/// Abstracts async runtime like [tokio]. Currently only exposes a [yield_now](Self::yield_now)
/// function.
pub trait AsyncRuntime {
    /// Future type returned by [yield_now](Self::yield_now)
    type YieldNowFuture: core::future::Future<Output = ()>;

    /// Yields the execution back to the runtime
    ///
    /// If the protocol performs a long computation, it might be better for performance
    /// to split it with yield points, so the signle computation does not starve other
    /// tasks.
    fn yield_now(&self) -> Self::YieldNowFuture;
}

/// [Tokio](tokio)-specific async runtime
#[cfg(feature = "runtime-tokio")]
#[derive(Debug, Default)]
pub struct TokioRuntime;

#[cfg(feature = "runtime-tokio")]
impl AsyncRuntime for TokioRuntime {
    type YieldNowFuture =
        core::pin::Pin<alloc::boxed::Box<dyn core::future::Future<Output = ()> + Send>>;

    fn yield_now(&self) -> Self::YieldNowFuture {
        alloc::boxed::Box::pin(tokio::task::yield_now())
    }
}

#[doc(inline)]
pub use unknown_runtime::UnknownRuntime;

/// Default runtime
#[cfg(feature = "runtime-tokio")]
#[cfg_attr(docsrs, doc(cfg(all())))]
pub type DefaultRuntime = TokioRuntime;
/// Default runtime
#[cfg(not(feature = "runtime-tokio"))]
#[cfg_attr(docsrs, doc(cfg(all())))]
pub type DefaultRuntime = UnknownRuntime;

/// Unknown async runtime
pub mod unknown_runtime {
    /// Unknown async runtime
    ///
    /// Tries to implement runtime features using generic futures code. It's better to use
    /// runtime-specific implementation.
    #[derive(Debug, Default)]
    pub struct UnknownRuntime;

    impl super::AsyncRuntime for UnknownRuntime {
        type YieldNowFuture = YieldNow;

        fn yield_now(&self) -> Self::YieldNowFuture {
            YieldNow(false)
        }
    }

    /// Future for the `yield_now` function.
    pub struct YieldNow(bool);

    impl core::future::Future for YieldNow {
        type Output = ();

        fn poll(
            mut self: core::pin::Pin<&mut Self>,
            cx: &mut core::task::Context<'_>,
        ) -> core::task::Poll<Self::Output> {
            if !self.0 {
                self.0 = true;
                cx.waker().wake_by_ref();
                core::task::Poll::Pending
            } else {
                core::task::Poll::Ready(())
            }
        }
    }
}