17 releases

0.5.1 May 19, 2024
0.5.0 May 19, 2024
0.4.0 Feb 3, 2023
0.3.5 Oct 15, 2022
0.1.0 Apr 23, 2022

#1241 in Network programming

Download history 28/week @ 2024-11-13 198/week @ 2024-11-20 8/week @ 2024-11-27 23/week @ 2024-12-04 55/week @ 2024-12-11 10/week @ 2024-12-18 19/week @ 2024-12-25 21/week @ 2025-01-08 16/week @ 2025-01-22 3/week @ 2025-01-29 10/week @ 2025-02-05 28/week @ 2025-02-12 9/week @ 2025-02-19 19/week @ 2025-02-26

66 downloads per month
Used in 2 crates

MIT license

41KB
939 lines

Realm IO

crates.io Released API docs

Realm's high performance IO collections.

Example

use tokio::net::TcpStream;
use realm_io::{bidi_copy, bidi_zero_copy, bidi_copy_buf};
use realm_io::{Pipe, CopyBuffer};

let mut left = TcpStream::connect("abc").await.unwrap();
let mut right = TcpStream::connect("def").await.unwrap();

// direct copy     
bidi_copy(&mut left, &mut right).await;

// zero copy
bidi_zero_copy(&mut left, &mut right).await;

// use custom buffer(vector)
let buf1 = CopyBuffer::new(vec![0; 0x2000]);
let buf2 = CopyBuffer::new(vec![0; 0x2000]);
bidi_copy_buf(&mut left, &mut right, buf1, buf2).await;

// use custom buffer(pipe)
let buf1 = CopyBuffer::new(Pipe::new().unwrap());
let buf2 = CopyBuffer::new(Pipe::new().unwrap());
bidi_copy_buf(&mut left, &mut right, buf1, buf2).await;

About Brutal Shutdown

By default, bidi_copy_buf and other IO functions perform a graceful shutdown.

With the feature brutal-shutdown enabled, these IO functions will decide to perform a brutal shutdown once a FIN packet reaches, which will forcefully close two connections on both sides without waiting for a reply packet.

This is helpful when handling connections from a poorly implemented client or server, which may never shutdown its write side nor close the underlying socket.

Dependencies

~2–10MB
~98K SLoC