Class BinaryReader

packages/binary-utils/src/binary-reader.ts:10–255

 * type moves the offset by the size of the type read.
 */
export class BinaryReader {
  /**
   * The underlying `ArrayBuffer` instance that contains the binary data.
   */
  public readonly buffer: ArrayBuffer;

  /**
   * The `DataView` instance that provides methods to read data from the `ArrayBuffer`.
   */
  public readonly view: DataView;

  /**
   * The byte order used for reading binary data.
   */
  public readonly byteOrder: ByteOrder;

  /**
   * A boolean value indicating whether the byte order is little-endian.
   */
  public readonly isLittleEndian: boolean;

  private offset: number = 0;

  constructor(buffer: ArrayBuffer, byteOrder: ByteOrder) {
    this.buffer = buffer;
    this.view = new DataView(buffer);
    this.byteOrder = byteOrder;
    this.isLittleEndian = byteOrder === ByteOrder.LittleEndian;
  }

  /**
   * A boolean value indicating whether the reader has reached the end of the binary data.
   */
  get isEmpty(): boolean {
    return this.offset + 1 >= this.view.byteLength;
  }

  /**
   * The current offset in the binary data.
   */
  get currentOffset(): number {
    return this.offset;
  }

  /**
   * Moves the internal offset forward by the specified number.
   *
   * @param n - The number of positions to move the offset forward.
   * @return The new position of the internal offset after being moved.
   */
  skip(n: number) {
    this.offset += n;
  }

  /**
   * Skips the binary data until the specified byte value is found.
   */
  skipUntilByte(value: number) {