variable-len-reader 3.0.0

A library for reading/writing variable length data. Support AsyncRead/AsyncWrite 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# Variable Len Reader

[![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)

**Read this in other languages: [English](README.md), [简体中文](README_zh.md).**

# Description

A Rust crate to read variable length data based on varint format.


# Features

* Reading and writing.
* Both synchronous and asynchronous implementations.
* Support [bytes](https://crates.io/crates/bytes) and [tokio](https://crates.io/crates/tokio) crates.
* Long chunk version for varint implementations. (But not recommended to use because it's stupid.)
* Support signed and unsigned value. (Using zigzag encoding.)
* Support usize/isize directly or convert from/to u128/i128. (with the `ap` suffix.)
* Support extra type of `f32`, `f64`, `vec<u8>` and `string`.
* Built-in implementation of `std::io::Read`, `std::io::Write` and `tokio::io::AsyncRead`, `tokio::io::AsyncWrite`.
* Chaining `bytes::Buf` support.
* no-std support.


# Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
variable-len-reader = "^3.0"
```


# Example

Directly use in tcp stream:

```rust
use std::net::{TcpListener, TcpStream};
use anyhow::Result;
use variable_len_reader::synchronous::reader::VariableReader;
use variable_len_reader::synchronous::writer::VariableWriter;

fn main() -> Result<()> {
    let server = TcpListener::bind("localhost:0")?;
    let mut client = TcpStream::connect(server.local_addr()?)?;
    let mut server = server.incoming().next().unwrap()?;

    // Write
    client.write_string(&"Hello world!")?;

    // Read
    let message = server.read_string()?;
    assert_eq!("Hello world!", message);
    
    Ok(())
}
```

Use with [bytes](https://crates.io/crates/bytes) crate:

```rust
use bytes::{Buf, BufMut, BytesMut};
use variable_len_reader::synchronous::reader::VariableReader;
use variable_len_reader::synchronous::writer::VariableWriter;

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

    // Write
    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();

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

Async mode with [tokio](https://crates.io/crates/tokio) crate:
(Require 'async_default' feature)

```rust
use anyhow::Result;
use tokio::net::{TcpListener, TcpStream};
use variable_len_reader::asynchronous::reader::AsyncVariableReader;
use variable_len_reader::asynchronous::writer::AsyncVariableWriter;

#[tokio::main]
async fn main() -> Result<()> {
    let server = TcpListener::bind("localhost:0").await?;
    let mut client = TcpStream::connect(server.local_addr()?).await?;
    let (mut server, _) = server.accept().await?;

    // Write
    client.write_string_boxed(&"Hello tokio!").await?;

    // Read
    let message = server.read_string_boxed().await?;
    assert_eq!("Hello tokio!", message);
    
    Ok(())
}
```