thesis/byte-order

The library adds methods for reading bytes in any byte order to Reader and Writer.

0.2.0 2025-01-17 03:50 UTC

Requires

• php: ^8.3
• thesis/byte-reader: ^0.3.1
• thesis/byte-writer: ^0.2.1
• thesis/endian: ^0.1.0

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.8.2
• ergebnis/composer-normalize: ^2.45.0

MIT

• Valentin Udaltsov
• kafkiansky
• Thesis Team

README

Installation

composer require thesis/byte-order

Basic usage

<?php

declare(strict_types=1);

use Thesis\ByteOrder\ReadFrom;
use Thesis\ByteOrder\WriteTo;

final class Frame
{
    /**
     * @param non-empty-string $id
     * @param non-negative-int $attempts
     */
    public function __construct(
        public readonly string $id,
        public readonly int $attempts,
    ) {}
}

function readFrame(ReadFrom $reader): Frame
{
    return new Frame(
        $reader->read($reader->readUint16()),
        $reader->readUint32(),
    );
} 

function writeFrame(WriteTo $writer, Frame $frame): void
{
    $writer->writeUint16(\strlen($frame->id));
    $writer->write($frame->id);
    $writer->writeUint32($frame->attempts);
}