dope-net 0.20.0

Owned network transports for dope
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

use dope_core::driver::{receive::credit, route::Identity};

use crate::wire::{self, failure};

/// Exact open error selected by the wire's failure class.
#[repr(transparent)]
pub struct Error<'d, W: wire::Spec + 'd>(
    <W::OpenFailure as failure::Class<W, failure::Open>>::Error<'d>,
);

impl<'d, W: wire::Spec + 'd> Error<'d, W> {
    pub const fn from_cause(
        cause: <W::OpenFailure as failure::Class<W, failure::Open>>::Error<'d>,
    ) -> Self {
        Self(cause)
    }

    pub const fn cause(&self) -> &<W::OpenFailure as failure::Class<W, failure::Open>>::Error<'d> {
        &self.0
    }

    pub fn into_cause(self) -> <W::OpenFailure as failure::Class<W, failure::Open>>::Error<'d> {
        self.0
    }
}

impl<'d, W> Error<'d, W>
where
    W: wire::Spec<OpenFailure = failure::Never> + 'd,
{
    /// Eliminates the uninhabited failure selected by `Never`.
    pub fn eliminate<T>(self) -> T {
        match self.0 {}
    }
}

/// Consumer-selected ownership result for one prepared wire open.
pub enum Disposition<T, W, S> {
    Commit(T),
    Retry { output: T, wire: W, send: S },
}

impl<T, W, S> Disposition<T, W, S> {
    pub fn retry(output: T, wire: W, send: S) -> Self {
        Self::Retry { output, wire, send }
    }

    pub fn into_output(self, retry: impl FnOnce(W, S)) -> T {
        match self {
            Self::Commit(output) => output,
            Self::Retry { output, wire, send } => {
                retry(wire, send);
                output
            }
        }
    }
}

/// Exact ownership result of attempting to acquire one prepared wire open.
pub enum Outcome<C, T, E> {
    Unavailable(C),
    Failed { context: C, cause: E },
    Opened(T),
}

/// State that opens one connection for its exact wire route.
pub trait Runtime<'w, 'd: 'w, W: wire::Spec + 'w, ID: Identity + 'w> {
    /// Reports a resource transition that can resume a parked receive.
    fn is_ready(&self) -> bool {
        false
    }

    /// Takes one parked receive credit whose resource is ready.
    fn take_ready(&mut self) -> Option<credit::Held<'d, ID>> {
        None
    }

    fn open<C, T>(
        &mut self,
        context: C,
        consume: impl FnOnce(
            C,
            W::Connection<'w, ID>,
            W::SendStorage<'w>,
        ) -> Disposition<T, W::Connection<'w, ID>, W::SendStorage<'w>>,
    ) -> Outcome<C, T, Error<'w, W>>;
}