lio 0.4.1

A platform-independent async I/O library with native support for io_uring (Linux), IOCP (Windows), and kqueue (macOS)
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
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use std::{
  io,
  net::{SocketAddr, ToSocketAddrs},
};

use crate::{
  api::{
    self,
    io::Io,
    ops::{self, Recv, Shutdown},
    resource::{AsResource, FromResource, IntoResource, Resource},
  },
  net::ops::TcpAccept,
};

use super::socket::Socket;

/// A TCP socket server, listening for connections.
///
/// `TcpListener` provides a high-level interface for creating TCP servers. After being
/// created by binding to a socket address, it listens for and accepts incoming TCP
/// connections.
///
/// # Examples
///
/// ## Basic server
///
/// ```rust,no_run
/// use lio::net::TcpListener;
///
/// async fn example() -> std::io::Result<()> {
///     // Bind to an address and start listening
///     let listener = TcpListener::bind_async("127.0.0.1:8080").await?;
///
///     // Accept incoming connections
///     loop {
///         let (socket, addr) = listener.accept().await?;
///         println!("New connection from: {}", addr);
///
///         // Handle the connection...
///     }
/// }
/// ```
///
/// ## Synchronous binding
///
/// ```rust,no_run
/// use lio::net::TcpListener;
///
/// fn example() -> std::io::Result<()> {
///     // Bind synchronously (blocks until ready)
///     let listener = TcpListener::bind_sync("127.0.0.1:8080")?;
///
///     // Accept connections asynchronously
///     Ok(())
/// }
/// ```
pub struct TcpListener(Socket);

impl IntoResource for TcpListener {
  fn into_resource(self) -> Resource {
    self.0.into_resource()
  }
}

impl FromResource for TcpListener {
  fn from_resource(resource: Resource) -> Self {
    Self(Socket::from_resource(resource))
  }
}

impl TcpListener {
  /// Creates a new `TcpListener` which will be bound to the specified address asynchronously.
  ///
  /// The returned listener is ready for accepting connections. This method creates a TCP
  /// socket, binds it to the provided address, and starts listening for incoming connections.
  ///
  /// Binding with a port number of 0 will request that the OS assign a port to this listener.
  /// The port allocated can be queried via the underlying socket's methods.
  ///
  /// The address type can be any implementor of [`ToSocketAddrs`], including string slices
  /// and tuples of IP address and port.
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use lio::net::TcpListener;
  ///
  /// async fn example() -> std::io::Result<()> {
  ///     // Bind using a string
  ///     let listener = TcpListener::bind_async("127.0.0.1:8080").await?;
  ///
  ///     // Bind to any available address
  ///     let listener = TcpListener::bind_async("0.0.0.0:0").await?;
  ///
  ///     Ok(())
  /// }
  /// ```
  // TODO: AsyncToSocketAddrs
  pub async fn bind_async(addr: impl ToSocketAddrs) -> io::Result<Self> {
    let mut addrs = addr.to_socket_addrs()?;

    let socket = Socket::new(libc::AF_INET, libc::SOCK_STREAM, 0).await?;
    let addr = addrs.next().unwrap();
    socket.bind(addr).await?;
    socket.listen().await?;
    Ok(TcpListener(socket))
  }

  /// Creates a new `TcpListener` which will be bound to the specified address synchronously.
  ///
  /// This is the blocking version of [`bind_async`](Self::bind_async). It will block the
  /// current thread until the socket is created, bound, and listening.
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use lio::net::TcpListener;
  ///
  /// fn example() -> std::io::Result<()> {
  ///     // This will block until the listener is ready
  ///     let listener = TcpListener::bind_sync("127.0.0.1:8080")?;
  ///
  ///     Ok(())
  /// }
  /// ```
  #[allow(deprecated)]
  pub fn bind_sync(addr: impl ToSocketAddrs) -> io::Result<Self> {
    let mut addrs = addr.to_socket_addrs()?;

    let socket = Socket::new(libc::AF_INET, libc::SOCK_STREAM, 0).wait()?;
    let addr = addrs.next().unwrap();
    socket.bind(addr).wait()?;
    socket.listen().wait()?;
    Ok(TcpListener(socket))
  }

  /// Accepts a new incoming connection from this listener.
  ///
  /// This function will await until a new TCP connection is established. When a connection
  /// is established, the corresponding [`TcpSocket`] and the remote peer's address will be
  /// returned.
  ///
  /// # Returns
  ///
  /// A tuple containing:
  /// - A [`TcpSocket`] representing the accepted client connection
  /// - The [`SocketAddr`] of the connected client
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use lio::net::TcpListener;
  ///
  /// async fn example() -> std::io::Result<()> {
  ///     let listener = TcpListener::bind_async("127.0.0.1:8080").await?;
  ///
  ///     loop {
  ///         let (socket, addr) = listener.accept().await?;
  ///         println!("Accepted connection from: {}", addr);
  ///
  ///         // Handle the socket...
  ///     }
  /// }
  /// ```
  pub fn accept(&self) -> Io<TcpAccept> {
    let socket_accept_op = TcpAccept::new(self.0.as_resource().clone());
    Io::from_op(socket_accept_op)
  }

  /// Returns the local address this listener is bound to.
  pub fn local_addr(&self) -> io::Result<SocketAddr> {
    self.0.local_addr()
  }
}

/// A TCP socket connection.
///
/// `TcpSocket` represents an established TCP connection between a local and a remote socket.
/// It can be created by connecting to a remote address or by accepting a connection from a
/// [`TcpListener`].
///
/// `TcpSocket` provides methods for reading and writing data over the connection, as well
/// as shutting down the connection gracefully.
///
/// # Examples
///
/// ## Creating a client connection
///
/// ```rust,no_run
/// use std::net::SocketAddr;
/// use lio::net::TcpSocket;
///
/// async fn example() -> std::io::Result<()> {
///     // Connect to a server
///     let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap();
///     let socket = TcpSocket::connect_async(addr).await?;
///
///     // Send data
///     let data = b"Hello, server!".to_vec();
///     let (result, data) = socket.send(data).await;
///     let bytes_sent = result? as usize;
///
///     // Receive response
///     let buffer = vec![0u8; 1024];
///     let (result, buffer) = socket.recv(buffer).await;
///     let bytes_read = result? as usize;
///
///     Ok(())
/// }
/// ```
///
/// ## Handling an accepted connection
///
/// ```rust,no_run
/// use lio::net::TcpListener;
///
/// async fn example() -> std::io::Result<()> {
///     let listener = TcpListener::bind_async("127.0.0.1:8080").await?;
///
///     let (socket, addr) = listener.accept().await?;
///     println!("Connection from: {}", addr);
///
///     // Use the socket...
///     let buffer = vec![0u8; 1024];
///     let (result, buffer) = socket.recv(buffer).await;
///     let bytes_read = result? as usize;
///
///     Ok(())
/// }
/// ```
pub struct TcpSocket(Socket);

impl IntoResource for TcpSocket {
  fn into_resource(self) -> Resource {
    self.0.into_resource()
  }
}

impl AsResource for TcpSocket {
  fn as_resource(&self) -> &Resource {
    self.0.as_resource()
  }
}

impl FromResource for TcpSocket {
  fn from_resource(resource: Resource) -> Self {
    Self(Socket::from_resource(resource))
  }
}

impl TcpSocket {
  /// Opens a TCP connection to a remote host asynchronously.
  ///
  /// This method creates a new TCP socket and connects it to the specified remote address.
  /// The connection is established asynchronously, and the method returns once the
  /// connection is ready to use.
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use std::net::SocketAddr;
  /// use lio::net::TcpSocket;
  ///
  /// async fn example() -> std::io::Result<()> {
  ///     let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap();
  ///     let socket = TcpSocket::connect_async(addr).await?;
  ///
  ///     println!("Connected to server");
  ///
  ///     Ok(())
  /// }
  /// ```
  pub async fn connect_async(addr: SocketAddr) -> io::Result<Self> {
    let socket = Socket::new(libc::AF_INET, libc::SOCK_STREAM, 0).await?;
    api::connect(&socket, addr).await?;
    Ok(TcpSocket(socket))
  }

  /// Opens a TCP connection to a remote host synchronously.
  ///
  /// This is the blocking version of [`connect_async`](Self::connect_async). It will block
  /// the current thread until the connection is established.
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use std::net::SocketAddr;
  /// use lio::net::TcpSocket;
  ///
  /// fn example() -> std::io::Result<()> {
  ///     let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap();
  ///     // This will block until connected
  ///     let socket = TcpSocket::connect_sync(addr)?;
  ///
  ///     Ok(())
  /// }
  /// ```
  #[allow(deprecated)]
  pub fn connect_sync(addr: SocketAddr) -> io::Result<Self> {
    let socket = Socket::new(libc::AF_INET, libc::SOCK_STREAM, 0).wait()?;
    api::connect(&socket, addr).wait()?;
    Ok(TcpSocket(socket))
  }

  /// Receives data from the socket into the provided buffer.
  ///
  /// This operation reads data from the socket and returns both the buffer and the
  /// number of bytes read. The buffer is passed by value and returned, allowing for
  /// efficient async buffer management.
  ///
  /// # Returns
  ///
  /// A tuple containing:
  /// - The buffer (returned for reuse)
  /// - The number of bytes read
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use lio::net::TcpSocket;
  /// use std::net::SocketAddr;
  ///
  /// async fn example() -> std::io::Result<()> {
  ///     let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap();
  ///     let socket = TcpSocket::connect_async(addr).await?;
  ///
  ///     let buffer = vec![0u8; 1024];
  ///     let (result, buffer) = socket.recv(buffer).await;
  ///     let bytes_read = result? as usize;
  ///
  ///     println!("Received {} bytes", bytes_read);
  ///     println!("Data: {:?}", &buffer[..bytes_read]);
  ///
  ///     Ok(())
  /// }
  /// ```
  pub fn recv(&self, vec: Vec<u8>) -> Io<Recv<Vec<u8>>> {
    self.0.recv(vec)
  }

  /// Sends data through the socket.
  ///
  /// This operation writes data to the socket and returns both the buffer and the
  /// number of bytes sent. The buffer is passed by value and returned, allowing for
  /// efficient async buffer management.
  ///
  /// # Returns
  ///
  /// A tuple containing:
  /// - The buffer (returned for reuse)
  /// - The number of bytes sent
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use lio::net::TcpSocket;
  /// use std::net::SocketAddr;
  ///
  /// async fn example() -> std::io::Result<()> {
  ///     let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap();
  ///     let socket = TcpSocket::connect_async(addr).await?;
  ///
  ///     let data = b"Hello, server!".to_vec();
  ///     let (result, data) = socket.send(data).await;
  ///     let bytes_sent = result? as usize;
  ///
  ///     println!("Sent {} bytes", bytes_sent);
  ///
  ///     Ok(())
  /// }
  /// ```
  pub fn send(&self, vec: Vec<u8>) -> Io<ops::Send<Vec<u8>>> {
    self.0.send(vec)
  }

  /// Shuts down the read, write, or both halves of this connection.
  ///
  /// This operation disables further send and/or receive operations on the socket.
  /// This is useful for implementing graceful shutdowns where you want to signal
  /// to the peer that no more data will be sent while still being able to receive data.
  ///
  /// # Parameters
  ///
  /// - `how`: Specifies which operations to shut down:
  ///   - `SHUT_RD` (0): Further receives are disallowed
  ///   - `SHUT_WR` (1): Further sends are disallowed
  ///   - `SHUT_RDWR` (2): Further sends and receives are disallowed
  ///
  /// # Examples
  ///
  /// ```rust,no_run
  /// use lio::net::TcpSocket;
  /// use std::net::SocketAddr;
  ///
  /// async fn example() -> std::io::Result<()> {
  ///     let addr: SocketAddr = "127.0.0.1:8080".parse().unwrap();
  ///     let socket = TcpSocket::connect_async(addr).await?;
  ///
  ///     // Send request
  ///     let data = b"GET / HTTP/1.1\r\n\r\n".to_vec();
  ///     let (result, _) = socket.send(data).await;
  ///     result?;
  ///
  ///     // Shutdown write side to signal end of request
  ///     socket.shutdown(libc::SHUT_WR).await?;
  ///
  ///     // Can still receive the response
  ///     let buffer = vec![0u8; 4096];
  ///     let (result, buffer) = socket.recv(buffer).await;
  ///     let bytes_read = result? as usize;
  ///
  ///     Ok(())
  /// }
  /// ```
  pub fn shutdown(&self, how: i32) -> Io<Shutdown> {
    self.0.shutdown(how)
  }
}