function u8
u8(endianness?: Endianness): Coder<number>

Creates a coder for 8-bit unsigned integers.

This function creates a coder that can encode/decode 8-bit unsigned integers (range 0-255). The endianness parameter determines the byte order used.

Examples

Example 1

import { assertEquals } from "@std/assert";
import { u8 } from "@hertzg/binstruct/numeric";

// Create big-endian and little-endian coders
const u8be = u8("be");
const u8le = u8("le");

// Test data
const testValue = 255;

// Encode and decode with big-endian
const bufferBE = new Uint8Array(1);
const bytesWrittenBE = u8be.encode(testValue, bufferBE);
const [decodedBE, bytesReadBE] = u8be.decode(bufferBE);

assertEquals(decodedBE, testValue);
assertEquals(bytesWrittenBE, 1);
assertEquals(bytesReadBE, 1);

// Encode and decode with little-endian
const bufferLE = new Uint8Array(1);
const bytesWrittenLE = u8le.encode(testValue, bufferLE);
const [decodedLE, bytesReadLE] = u8le.decode(bufferLE);

assertEquals(decodedLE, testValue);
assertEquals(bytesWrittenLE, 1);
assertEquals(bytesReadLE, 1);

Parameters

optional
endianness: Endianness = be

The byte order to use ("be" for big-endian, "le" for little-endian), defaults to "be"

Return Type

Coder<number>

A Coder<number> for 8-bit unsigned integers

Usage

import { u8 } from "numeric/numeric.ts";