libsync 0.3.0

A channels library
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

//!
//! Call io_channels to get IOClient and IOServer objects in circumstances where you need both input and output channels e.g. with actors.
//! 

use super::{Sender, Receiver, channel};

use std::fmt::Debug;

///
/// For use on the “client side” of the actor.
/// 
pub struct IOClient<IM, OM>          
{

    input_sender: Sender<IM>,
    output_receiver: Receiver<OM>,

}

impl<IM, OM> IOClient<IM, OM>
{

    pub fn new(input_sender: Sender<IM>, output_receiver: Receiver<OM>) -> Self
    {

        Self
        {

            input_sender,
            output_receiver

        }

    }

    pub fn input_sender_ref(&self) -> &Sender<IM>
    {

        &self.input_sender

    }

    pub fn output_receiver_ref(&self) -> &Receiver<OM>
    {

        &self.output_receiver

    }

    pub fn split(self) -> (Sender<IM>, Receiver<OM>)
    {

        (self.input_sender, self.output_receiver)

    }

}

impl<IM, OM> Clone for IOClient<IM, OM>
{

    fn clone(&self) -> Self
    {

        Self
        {
            
            input_sender: self.input_sender.clone(),
            output_receiver: self.output_receiver.clone()
            
        }

    }

}

impl<IM, OM> Debug for IOClient<IM, OM>
    where IM: Debug,
          OM: Debug
{

    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("IOClient").field("input_sender", &self.input_sender).field("output_receiver", &self.output_receiver).finish()
    }

}

///
/// For use on the “server side” of the actor.
/// 
pub struct IOServer<IM, OM>
{

    input_receiver: Receiver<IM>,
    output_sender: Sender<OM>,

}

impl<IM, OM> IOServer<IM, OM>
{

    pub fn new(input_receiver: Receiver<IM>, output_sender: Sender<OM>) -> Self
    {

        Self
        {

            input_receiver,
            output_sender

        }

    }

    pub fn input_receiver_ref(&self) -> &Receiver<IM>
    {

        &self.input_receiver

    }

    pub fn output_sender_ref(&self) -> &Sender<OM>
    {

        &self.output_sender

    }

    pub fn split(self) -> (Receiver<IM>, Sender<OM>)
    {

        (self.input_receiver, self.output_sender)

    }

}

impl<IM, OM> Clone for IOServer<IM, OM>
{

    fn clone(&self) -> Self
    {

        Self
        {
            
            input_receiver: self.input_receiver.clone(),
            output_sender: self.output_sender.clone()
            
        }

    }

}

impl<IM, OM> Debug for IOServer<IM, OM>
    where IM: Debug,
          OM: Debug
{

    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("IOServer").field("input_receiver", &self.input_receiver).field("output_sender", &self.output_sender).finish()
    }
    
}

///
/// Initialises bounded input and output channels.
/// 
pub fn io_channels<IM, OM>(input_buffer_size: usize, output_buffer_size: usize) -> (IOClient<IM, OM>, IOServer<IM, OM>)
{

    let (input_sender, input_receiver) = channel(input_buffer_size);

    let (output_sender, output_receiver) = channel(output_buffer_size);

    (IOClient::new(input_sender, output_receiver), IOServer::new(input_receiver, output_sender))

}

///
/// Initialises unbounded input and output channels, both with the same buffer sizes.
/// 
pub fn io_channel_both<IM, OM>(buffer_size: usize) -> (IOClient<IM, OM>, IOServer<IM, OM>)
{

    io_channels(buffer_size, buffer_size)

}