variable-len-reader 1.0.0

A library for reading/writing variable length data. Support AsyncReadExt/AsyncWriteExt in tokio.
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

# 可变长数据读写器


[![Crate](https://img.shields.io/crates/v/variable-len-reader.svg)](https://crates.io/crates/variable-len-reader)
[![GitHub last commit](https://img.shields.io/github/last-commit/xuxiaocheng0201/variable-len-reader)](https://github.com/xuxiaocheng0201/variable-len-reader/commits/master)
[![GitHub issues](https://img.shields.io/github/issues-raw/xuxiaocheng0201/variable-len-reader)](https://github.com/xuxiaocheng0201/variable-len-reader/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/xuxiaocheng0201/variable-len-reader)](https://github.com/xuxiaocheng0201/variable-len-reader/pulls)
[![GitHub](https://img.shields.io/github/license/xuxiaocheng0201/variable-len-reader)](https://github.com/xuxiaocheng0201/variable-len-reader/blob/master/LICENSE)

**其他语言版本：[English](README.md)，[简体中文](README_zh.md)。**

# 描述


一个类似于 VarInt 的可变长数据读写器。


# 用法


将以下内容添加到你的`Cargo.toml`：

```toml
[dependencies]
variable-len-reader = "1"
```


# 示例


直接在tcp流中使用：

```rust
use std::net::{TcpListener, TcpStream};
use variable_len_reader::{VariableReadable, VariableWritable};

fn main() {
    let addr = "localhost:25564";
    let server = TcpListener::bind(addr).unwrap();
    let mut client = TcpStream::connect(addr).unwrap();
    let mut server = server.incoming().next().unwrap().unwrap();

    // 写
    client.write_string(&"Hello world!").unwrap();

    // 读
    let message = server.read_string().unwrap();
    assert_eq!("Hello world!", message);
}
```

和 [bytes](https://crates.io/crates/bytes) 库一起使用：

```rust
use bytes::{Buf, BufMut, BytesMut};
use variable_len_reader::{VariableReadable, VariableWritable};

fn main() {
    let message = "Hello world!";
    let mut writer = BytesMut::new().writer();

    // 写
    writer.write_string(message).unwrap();

    let bytes = writer.into_inner();
    assert_eq!(message.len() as u8, bytes[0]);
    assert_eq!(message.as_bytes(), &bytes[1..]);
    let mut reader = bytes.reader();

    // 读
    let string = reader.read_string().unwrap();
    assert_eq!(message, string);
}
```

基于 [tokio](https://crates.io/crates/tokio) 的异步模式:
(需要启用 'async_default' 功能)

```rust
use tokio::net::{TcpListener, TcpStream};
use variable_len_reader::asynchronous::{AsyncVariableReadable, AsyncVariableWritable};

#[tokio::main]

async fn main() {
    let addr = "localhost:25564";
    let server = TcpListener::bind(addr).await.unwrap();
    let mut client = TcpStream::connect(addr).await.unwrap();
    let (mut server, _) = server.accept().await.unwrap();

    // 写
    client.write_string(&"Hello tokio!").await.unwrap();

    // 读
    let message = server.read_string().await.unwrap();
    assert_eq!("Hello tokio!", message);
}
```