nquic_varint (nquic v1.0.0)

Variable-length integer encoding per RFC 9000 Section 16.

QUIC uses a variable-length encoding for integers up to 2^62 - 1. The two most significant bits indicate the encoding length: 1, 2, 4, or 8 bytes.

Summary

t()

decode/1

Decode a variable-length integer from the head of a binary.

encode/1

Encode an integer as a QUIC variable-length integer.

safe_encode/1

Encode with overflow checking. Returns {error, overflow} for values >= 2^62.

size/1

Return the encoded byte size of a variable-length integer (1, 2, 4, or 8).

-type t() :: 0..4611686018427387903.

-spec decode(binary()) -> {ok, t(), binary()} | {error, incomplete_binary}.

Decode a variable-length integer from the head of a binary.

-spec encode(t()) -> binary().

Encode an integer as a QUIC variable-length integer.

-spec safe_encode(integer()) -> {ok, binary()} | {error, overflow}.

Encode with overflow checking. Returns {error, overflow} for values >= 2^62.

-spec size(t()) -> 1 | 2 | 4 | 8.

Return the encoded byte size of a variable-length integer (1, 2, 4, or 8).