https://github.com/dermesser/integer-encoding-rs

Integer encoding for primitive integer types: Supports varint/varint+zigzag and fixed-length integer encoding and decoding, and provides synchronous and asynchronous Write/Read types for easily writing/reading integers.
https://github.com/dermesser/integer-encoding-rs

encoding endian endianness rust varint

Last synced: about 1 month ago
JSON representation

Integer encoding for primitive integer types: Supports varint/varint+zigzag and fixed-length integer encoding and decoding, and provides synchronous and asynchronous Write/Read types for easily writing/reading integers.

• Host: GitHub
• URL: https://github.com/dermesser/integer-encoding-rs
• Owner: dermesser
• License: other
• Created: 2016-06-05T16:38:15.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-01T15:30:45.000Z (5 months ago)
• Last Synced: 2024-10-29T12:22:13.116Z (about 2 months ago)
• Topics: encoding, endian, endianness, rust, varint
• Language: Rust
• Homepage:
• Size: 698 KB
• Stars: 66
• Watchers: 3
• Forks: 16
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# integer-encoding-rs

[![crates.io](https://img.shields.io/crates/v/integer-encoding.svg)](https://crates.io/crates/integer-encoding)

[![Actions CI](https://github.com/dermesser/integer-encoding-rs/workflows/Actions%20CI/badge.svg)](https://github.com/dermesser/integer-encoding-rs/actions)

[full documentation](https://docs.rs/integer-encoding/)

This crate provides encoding and decoding of integers to and from bytestring

representations.

The format is described here: [Google's protobuf integer encoding technique](https://developers.google.com/protocol-buffers/docs/encoding).

Please feel free to use `cargo bench` to determine the rate at which your

machine can encode and decode varints and fixedints. Note that one iteration

comprises each eight rounds of encoding (or decoding) a signed and an unsigned

integer each -- divide the resulting benchmark time by 16 in order to have a

rough estimate of time per operation. The integers are very large, so the

results represent the worst case.

## Crate

If you use Tokio v0.2 and you use the asynchronous types in this crate (feature

`tokio_async`), you may be interested in the `v2.0` branch. It is still

maintained with the occasional fix for edge cases and depends on Tokio v0.2.

## FixedInt

`FixedInt` casts integers to bytes by either copying the underlying memory or

performing a transmutation. The encoded values use are little-endian.

However, a trait method is implemented for all integer types allowing convenient conversion between

little and big endian. That is, if you receive a big-endian on the wire and decode it, it will first

be interpreted as little-endian; converting will recover the correct value.

## VarInt

`VarInt` encodes integers in blocks of 7 bits; the MSB is set for every byte but

the last, in which it is cleared.

Signed values are first converted to an unsigned representation using zigzag

encoding (also described on the page linked above), and then encoded as every

other unsigned number.