zigzag-rs 0.1.0

A dependency-free ZigZag encoding/decoding library
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

# zigzag-rs

[![crates.io](https://img.shields.io/crates/v/zigzag-rs.svg)](https://crates.io/crates/zigzag-rs)
A dependency-free (including no std) ZigZag encoding/decoding Rust library. ZigZag encoding is a method for mapping signed integers to unsigned integers, commonly used in variable-length encoding and data compression.

## Features


- Completely dependency-free, usable in `#![no_std]` environments
- Supports all Rust native signed integer types (i8, i16, i32, i64, i128)
- Simple and easy-to-use API
- Efficient implementation

## Usage


Add the dependency to your `Cargo.toml`:

```toml
[dependencies]
zigzag-rs = "0.1.0"
```

Example code:

```rust
use zigzag_rs::ZigZag;

fn main() {
    // Encoding
    let encoded = i32::zigzag_encode(-1);
    assert_eq!(encoded, 1u32);
    
    // Decoding
    let decoded = i32::zigzag_decode(1u32);
    assert_eq!(decoded, -1i32);
}
```

## ZigZag Encoding Principle


ZigZag encoding maps signed integers to unsigned integers as follows:
- 0 -> 0
- -1 -> 1
- 1 -> 2
- -2 -> 3
- 2 -> 4
...

This encoding method ensures that small absolute values (whether positive or negative) are mapped to small unsigned integers, which is ideal for subsequent variable-length encoding.

## License


MIT or Apache-2.0 (dual licensed)