pw_varint

The pw_varint module provides functions for encoding and decoding variable length integers, or varints. For smaller values, varints require less memory than a fixed-size encoding. For example, a 32-bit (4-byte) integer requires 1–5 bytes when varint-encoded.

Protocol Buffers use a variable-length encoding for integers.

Compatibility

API

size_t EncodedSize(uint64_t integer)

Returns the size of an integer when encoded as a varint. Works on both signed and unsigned integers.

size_t ZigZagEncodedSize(int64_t integer)

Returns the size of a signed integer when ZigZag encoded as a varint.

uint64_t MaxValueInBytes(size_t bytes)

Returns the maximum integer value that can be encoded as a varint into the specified number of bytes.

Dependencies

  • pw_span