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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
//! Definitions for types used with [`NetStreamProvider`](crate::NetStreamProvider).
/// Options to use when initializing a listening socket.
///
/// This may include both options that affect the listening,
/// and options that will apply to any individual accepted connection streams.
///
/// It can include options set with `setsockopt`,
/// as well as options that influence higher layers (eg, the runtime).
///
/// For established streams that are accepted from a listener,
/// you can use [`StreamOps`](crate::StreamOps) to perform additional operations
/// or to configure additional options.
#[derive(Copy, Clone, Debug, PartialEq, Eq, derive_builder::Builder, amplify::Getters)]
#[non_exhaustive]
pub struct CommonListenOptions {
/// Value set for `SO_SNDBUF` on the listening socket.
#[builder(default)]
pub(crate) send_buffer_size: Option<usize>,
/// Value set for `SO_RCVBUF` on the listening socket.
#[builder(default)]
pub(crate) recv_buffer_size: Option<usize>,
}
impl CommonListenOptions {
/// Returns a builder for this [`CommonListenOptions`].
pub fn builder() -> CommonListenOptionsBuilder {
Default::default()
}
}
// We want to make sure that the defaults are set to the defaults that the builder uses.
#[allow(clippy::derivable_impls)]
impl Default for CommonListenOptions {
fn default() -> Self {
// This needs to match the result of `Self::builder().build().unwrap()`,
// which is tested by the `builder_defaults()` test below.
Self {
send_buffer_size: None,
recv_buffer_size: None,
}
}
}
/// Options to use when initializing a TCP listening socket.
///
/// See [`CommonListenOptions`] for more information.
#[derive(Copy, Clone, Debug, PartialEq, Eq, derive_builder::Builder, amplify::Getters)]
#[non_exhaustive]
pub struct TcpListenOptions {
/// Options that are common for all socket types.
#[builder(sub_builder)]
pub(crate) common: CommonListenOptions,
}
impl TcpListenOptions {
/// Returns a builder for this [`TcpListenOptions`].
pub fn builder() -> TcpListenOptionsBuilder {
Default::default()
}
}
// We want to make sure that the defaults are set to the defaults that the builder uses.
#[allow(clippy::derivable_impls)]
impl Default for TcpListenOptions {
fn default() -> Self {
// This needs to match the result of `Self::builder().build().unwrap()`,
// which is tested by the `builder_defaults()` test below.
Self {
common: CommonListenOptions::default(),
}
}
}
/// Options to use when initializing a unix stream listening socket.
// TODO: We should support at least the options in `CommonListenOptions`.
#[derive(Copy, Clone, Debug, PartialEq, Eq, derive_builder::Builder, amplify::Getters)]
#[non_exhaustive]
pub struct UnixListenOptions {}
impl UnixListenOptions {
/// Returns a builder for this [`UnixListenOptions`].
pub fn builder() -> UnixListenOptionsBuilder {
Default::default()
}
}
// We want to make sure that the defaults are set to the defaults that the builder uses.
#[allow(clippy::derivable_impls)]
impl Default for UnixListenOptions {
fn default() -> Self {
// This needs to match the result of `Self::builder().build().unwrap()`,
// which is tested by the `builder_defaults()` test below.
Self {}
}
}
/// Options to use when connecting a socket.
///
/// This may include both options that affect the connection attempt,
/// and options that will apply to the resulting connection stream.
///
/// It can include options set with `setsockopt`,
/// as well as options that influence higher layers (eg, the runtime).
///
/// For established streams,
/// you can use [`StreamOps`](crate::StreamOps) to perform additional operations
/// or to configure additional options.
#[derive(Copy, Clone, Debug, PartialEq, Eq, derive_builder::Builder, amplify::Getters)]
#[non_exhaustive]
pub struct CommonConnectOptions {
/// Value set for `SO_SNDBUF` on the socket.
#[builder(default)]
pub(crate) send_buffer_size: Option<usize>,
/// Value set for `SO_RCVBUF` on the socket.
#[builder(default)]
pub(crate) recv_buffer_size: Option<usize>,
}
impl CommonConnectOptions {
/// Returns a builder for this [`CommonConnectOptions`].
pub fn builder() -> CommonConnectOptionsBuilder {
Default::default()
}
}
// We want to make sure that the defaults are set to the defaults that the builder uses.
#[allow(clippy::derivable_impls)]
impl Default for CommonConnectOptions {
fn default() -> Self {
// This needs to match the result of `Self::builder().build().unwrap()`,
// which is tested by the `builder_defaults()` test below.
Self {
send_buffer_size: None,
recv_buffer_size: None,
}
}
}
/// Options to use when connecting a TCP socket.
///
/// See [`CommonConnectOptions`] for more information.
#[derive(Copy, Clone, Debug, PartialEq, Eq, derive_builder::Builder, amplify::Getters)]
#[non_exhaustive]
pub struct TcpConnectOptions {
/// Options that are common for all socket types.
#[builder(sub_builder)]
pub(crate) common: CommonConnectOptions,
}
impl TcpConnectOptions {
/// Returns a builder for this [`TcpConnectOptions`].
pub fn builder() -> TcpConnectOptionsBuilder {
Default::default()
}
}
// We want to make sure that the defaults are set to the defaults that the builder uses.
#[allow(clippy::derivable_impls)]
impl Default for TcpConnectOptions {
fn default() -> Self {
// This needs to match the result of `Self::builder().build().unwrap()`,
// which is tested by the `builder_defaults()` test below.
Self {
common: CommonConnectOptions::default(),
}
}
}
/// Options to use when connecting a unix stream socket.
// TODO: We should support at least the options in `CommonConnectOptions`.
#[derive(Copy, Clone, Debug, PartialEq, Eq, derive_builder::Builder, amplify::Getters)]
#[non_exhaustive]
pub struct UnixConnectOptions {}
impl UnixConnectOptions {
/// Returns a builder for this [`UnixConnectOptions`].
pub fn builder() -> UnixConnectOptionsBuilder {
Default::default()
}
}
// We want to make sure that the defaults are set to the defaults that the builder uses.
#[allow(clippy::derivable_impls)]
impl Default for UnixConnectOptions {
fn default() -> Self {
// This needs to match the result of `Self::builder().build().unwrap()`,
// which is tested by the `builder_defaults()` test below.
Self {}
}
}
#[cfg(test)]
mod test {
// @@ begin test lint list maintained by maint/add_warning @@
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::dbg_macro)]
#![allow(clippy::mixed_attributes_style)]
#![allow(clippy::print_stderr)]
#![allow(clippy::print_stdout)]
#![allow(clippy::single_char_pattern)]
#![allow(clippy::unwrap_used)]
#![allow(clippy::unchecked_time_subtraction)]
#![allow(clippy::useless_vec)]
#![allow(clippy::needless_pass_by_value)]
#![allow(clippy::string_slice)] // See arti#2571
//! <!-- @@ end test lint list maintained by maint/add_warning @@ -->
use super::*;
#[test]
fn builder_defaults() {
// Ensure that the builder default matches the type's default.
macro_rules! check {
($type:tt) => {
assert_eq!($type::builder().build().unwrap(), $type::default());
};
}
check!(CommonListenOptions);
check!(TcpListenOptions);
check!(UnixListenOptions);
check!(CommonConnectOptions);
check!(TcpConnectOptions);
check!(UnixConnectOptions);
}
}
|
