variable-len-reader 0.2.0

A library for reading variable length data.
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

# Variable Len Reader


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


# Description


A Rust crate to read variable length data. (VarInt)

Read and write compressed data. Of each such byte, only 7 bits will be used to describe the actual value
since its most significant bit indicates whether the next byte is part of the same int.
Micro-optimization for int values that are expected to have values below 128.


# Usage


Add this to your `Cargo.toml`:

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


# Example


```rust
use std::net::{TcpListener, TcpStream};
use crate::variable_len::{read_variable_u32, write_variable_u32};

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

    // Write
    write_variable_u32(&mut client, 4321).unwrap();

    // Read
    let message = read_variable_u32(&mut server).unwrap();
    assert_eq!(4321, message);
}
```