/encoding/binary.ts | std@0.170.0

import * as mod from "https://deno.land/std@0.170.0/encoding/binary.ts";

Functions for encoding binary data in array buffers.

Functions

f getNBytes	Reads exactly `n` bytes from `r`.
f putVarbig	Encodes bigint `x` into `b`. Returns the number of bytes used, or `0` if `b` is shorter than `sizeof(o.dataType)`.
f putVarnum	Encodes number `x` into `b`. Returns the number of bytes used, or `0` if `b` is shorter than `sizeof(o.dataType)`.
f readExact	Reads the exact number of bytes from `r` required to fill `b`.
f readVarbig	Decodes a bigint from `r`, consuming `sizeof(o.dataType)` bytes. If less than `sizeof(o.dataType)` bytes were read, throws `Deno.errors.unexpectedEof`.
f readVarnum	Decodes a number from `r`, consuming `sizeof(o.dataType)` bytes. If less than `sizeof(o.dataType)` bytes were read, throws `Deno.errors.unexpectedEof`.
f sizeof	Number of bytes required to store `dataType`.
f varbig	Decodes a bigint from `b`. If `o.bytes` is shorter than `sizeof(o.dataType)`, returns `null`.
f varbigBytes	Encodes `x` into a new `Uint8Array`.
f varnum	Decodes a number from `b`. If `o.bytes` is shorter than `sizeof(o.dataType)`, returns `null`.
f varnumBytes	Encodes `x` into a new `Uint8Array`.
f writeVarbig	Encodes and writes `x` to `w`. Resolves to the number of bytes written.
f writeVarnum	Encodes and writes `x` to `w`. Resolves to the number of bytes written.

I VarbigOptions	Options for working with the `bigint` type.
I VarnumOptions	Options for working with the `number` type.

T DataType
T Endianness	How encoded binary data is ordered.