dope-net 0.15.0

The manifold runtime
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use std::ops;

use crate::{
    link::{
        self, egress, pool,
        slot::{self, reception, send},
    },
    wire,
};

pub(in crate::link) struct Stored<'d, const ID: u8, W: wire::Wire, S, const IOV: usize> {
    pub(in crate::link) connection: Connection<'d, ID, W, S>,
    pub(in crate::link) egress: egress::Lane<'d, IOV>,
}

pub struct Connection<'d, const ID: u8, W: wire::Wire, S> {
    pub(in crate::link) engine: link::Engine<'d>,
    pub(in crate::link) wire: W::Connection<'d, ID>,
    pub(in crate::link) send: W::StorageBackend<'d>,
    pub state: S,
    key: pool::Key<'d, ID>,
}

impl<'d, const ID: u8, W: wire::Wire, S> Connection<'d, ID, W, S> {
    pub(in crate::link) fn new(
        engine: link::Engine<'d>,
        wire: W::Connection<'d, ID>,
        send: W::StorageBackend<'d>,
        key: pool::Key<'d, ID>,
        state: S,
    ) -> Self {
        Self {
            engine,
            wire,
            send,
            state,
            key,
        }
    }

    pub fn key(&self) -> pool::Key<'d, ID> {
        self.key
    }

    pub fn send_status(&self) -> send::Status<'_, 'd, ID, W, S> {
        send::Status::new(self)
    }

    pub fn is_closing(&self) -> bool {
        self.engine.lifecycle.is_closing()
    }

    pub fn is_established(&self) -> bool {
        self.engine.establish.is_done()
    }

    pub fn begin_close(&mut self) {
        self.engine.lifecycle.begin_close();
    }

    pub fn should_close(&self, defer: bool) -> bool {
        self.engine
            .lifecycle
            .should_close(self.engine.sending.is_inflight(), defer)
    }

    pub fn abort(&mut self) {
        self.engine.lifecycle.abort();
    }

    pub fn is_aborted(&self) -> bool {
        self.engine.lifecycle.is_aborted()
    }

    pub fn set_close_after(&mut self) {
        self.engine.lifecycle.set_close_after();
    }

    pub fn close_after(&self) -> bool {
        self.engine.lifecycle.close_after()
    }

    pub fn begin_discard(&mut self, bytes: usize) -> bool {
        if bytes == 0
            || !W::RAW_RECV
            || self.engine.discard.remaining() > 0
            || self.engine.lifecycle.is_closing()
            || self.engine.lifecycle.close_after()
        {
            return false;
        }
        self.engine.discard.begin(bytes);
        true
    }

    pub fn io(&self) -> slot::Io<'_, 'd> {
        slot::Io::new(&self.engine)
    }

    pub fn sending(&mut self) -> send::Sending<'_, 'd, ID, W, S> {
        send::Sending::new(self)
    }

    #[doc(hidden)]
    pub fn split_direct_sending(&mut self) -> (&mut S, send::DirectSending<'_, 'd, ID, W>) {
        let target = self.key.target();
        let Self {
            engine,
            wire,
            send,
            state,
            ..
        } = self;
        (state, send::DirectSending::new(engine, wire, send, target))
    }

    pub(in crate::link) fn receiving(&mut self) -> reception::Reception<'_, 'd, ID, W, S> {
        reception::Reception::new(self)
    }
}

impl<'d, const ID: u8, W: wire::Wire, S, const IOV: usize> Stored<'d, ID, W, S, IOV> {
    pub(in crate::link) fn new(
        connection: Connection<'d, ID, W, S>,
        egress: egress::Lane<'d, IOV>,
    ) -> Self {
        Self { connection, egress }
    }

    pub(in crate::link) fn into_connection(self) -> Connection<'d, ID, W, S> {
        self.connection
    }
}

impl<'d, const ID: u8, W: wire::Wire, S, const IOV: usize> ops::Deref
    for Stored<'d, ID, W, S, IOV>
{
    type Target = Connection<'d, ID, W, S>;

    fn deref(&self) -> &Self::Target {
        &self.connection
    }
}

impl<const ID: u8, W: wire::Wire, S, const IOV: usize> ops::DerefMut for Stored<'_, ID, W, S, IOV> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.connection
    }
}