@chickenjdk/byteutils
    Preparing search index...

    Class BytesFIFO

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    isAsync read readArrayBackwardsEndian readArrayEndian readBackwards readBackwardsEndian readEndian readUint8ArrayBackwardsEndian readUint8ArrayEndian

    Accessors

    chunkDataLeft isLe size

    Methods

    consumeChunk drop getChunk push readArray readArrayBackwards readDouble readFloat readReadableBuffer readSignedInteger readSignedIntegerBigint readSignedIntegerByte readSignedIntegerByteArray readSignedOnesComplement readSignedOnesComplementBigint readSignedOnesComplementByte readSignedOnesComplementByteArray readString readTwosComplement readTwosComplementBigint readTwosComplementByte readTwosComplementByteArray readUint8Array readUint8ArrayBackwards readUnsignedInt readUnsignedIntBigint resize shift write

    Constructors

    Properties

    isAsync: false
    read:
        | ((...args: [bytes: number]) => number[] | Promise<number[]>)
        | (
            (
                ...args: [bytes: number],
            ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
        ) = ...

    Read a array OR Uint8Array from the start of the buffer

    How many bytes to read

    readArrayBackwardsEndian:
        | ((...args: [bytes: number]) => number[] | Promise<number[]>)
        | ((...args: [bytes: number]) => number[] | Promise<number[]>) = ...

    Read a number array (0-255) from the start of the buffer backwards (endian-dependent)

    How many bytes to read

    readArrayEndian:
        | ((...args: [bytes: number]) => number[] | Promise<number[]>)
        | ((...args: [bytes: number]) => number[] | Promise<number[]>) = ...

    Read a number array (0-255) from the start of the buffer (endian-dependent)

    How many bytes to read

    readBackwards:
        | ((...args: [bytes: number]) => number[] | Promise<number[]>)
        | (
            (
                ...args: [bytes: number],
            ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
        ) = ...

    Read a array OR Uint8Array from the start of the buffer backwards

    How many bytes to read

    readBackwardsEndian:
        | cloneFunc<
            | ((...args: [bytes: number]) => number[] | Promise<number[]>)
            | (
                (
                    ...args: [bytes: number],
                ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
            ),
        >
        | cloneFunc<
            | ((...args: [bytes: number]) => number[] | Promise<number[]>)
            | (
                (
                    ...args: [bytes: number],
                ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
            ),
        > = ...

    Read a array-like (May be a array or uint8array but don't count on it) from the start of the buffer backwards (endian-dependent)

    readEndian:
        | cloneFunc<
            | ((...args: [bytes: number]) => number[] | Promise<number[]>)
            | (
                (
                    ...args: [bytes: number],
                ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
            ),
        >
        | cloneFunc<
            | ((...args: [bytes: number]) => number[] | Promise<number[]>)
            | (
                (
                    ...args: [bytes: number],
                ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
            ),
        > = ...

    Read a array-like (May be a array or uint8array but don't count on it) from the start of the buffer (endian-dependent)

    The data to write

    readUint8ArrayBackwardsEndian:
        | (
            (
                ...args: [bytes: number],
            ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
        )
        | (
            (
                ...args: [bytes: number],
            ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
        ) = ...

    Read a Uint8Array from the start of the buffer backwards (endian-dependent)

    readUint8ArrayEndian:
        | (
            (
                ...args: [bytes: number],
            ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
        )
        | (
            (
                ...args: [bytes: number],
            ) => Uint8Array<ArrayBufferLike> | Promise<Uint8Array<ArrayBufferLike>>
        ) = ...

    Read a Uint8Array from the start of the buffer (endian-dependent)

    Accessors

    • get chunkDataLeft(): number

      Returns number

    • get isLe(): boolean

      If the buffer is little endian

      Returns boolean

    • set isLe(isLe: boolean): void

      If the buffer is little endian

      Parameters

      • isLe: boolean

      Returns void

    • get size(): number

      Get the number of bytes in the FIFO

      Returns number

    Methods

    • Consume and output a chunk, if one is present. If one is not present, and the guarantee option is true, it will consume a chunk from the source and output that.

      Parameters

      • guarantee: boolean = false

        If this method should get a chunk from the source if one is not present. False by default.

      • idealChunkSize: number = 2000

        The ideal chunk size, N/A if guarantee is false.

      Returns Uint8Array<ArrayBufferLike>

      The chunk. Will be an empty Uint8Array if no chunk is present.

    • Drop any spare chunks not in use down to leaving only toBytes total bytes allocated in them left

      Parameters

      • toBytes: number

      Returns void

    • Parameters

      • ...args: [byte: number]

      Returns void

    • Read a number array (0-255) from the start of the buffer

      Parameters

      • bytes: number

        How many bytes to read

      Returns number[]

    • Read a number array (0-255) from the start of the buffer backwards

      Parameters

      • bytes: number

        How many bytes to read

      Returns number[]

    • Parse a signed integer

      Parameters

      • bytes: number

        How many bytes long the signed integer is

      Returns number | Promise<number>

      The parsed signed integer

    • Parse a signed integer as a bigint

      Parameters

      • bytes: number

        How many bytes long the signed integer is

      Returns bigint | Promise<bigint>

      The parsed signed integer (as a bigint)

    • Parse a signed one's complement

      Parameters

      • bytes: number

        How long the signed one's complement is

      Returns number | Promise<number>

      The parsed signed ones compement

    • Parse a signed one's complement as a bigint

      Parameters

      • bytes: number

        How long the signed one's complement is

      Returns bigint | Promise<bigint>

      The parsed signed ones compement (as a bigint)

    • Parse signed one's complements (one byte each) from bytes

      Parameters

      • bytes: number

        How many one's complements to read

      Returns number[] | Promise<number[]>

      The parsed signed one's complements

    • Parse a string

      Parameters

      • bytes: number

        How many bytes long the string is

      • Optionalmutf8: boolean = false

        If the string is mutf8

      Returns string | Promise<string>

      The parsed string

    • Parse a two's complement

      Parameters

      • bytes: number

        How many bytes it is

      Returns number | Promise<number>

      The parsed twos complement

    • Parse a two's complement as a bigint

      Parameters

      • bytes: number

        How many bytes it is

      Returns bigint | Promise<bigint>

      The parsed twos complement (as a bigint)

    • Parse a two's complements from single bytes

      Parameters

      • bytes: number

        How many two's complements to parse

      Returns number[] | Promise<number[]>

      The parsed twos complements

    • Read a Uint8Array from the start of the buffer

      Parameters

      • bytes: number

        How many bytes to read

      Returns Uint8Array<ArrayBufferLike>

    • Read a Uint8Array from the start of the buffer backwards

      Parameters

      • bytes: number

        How many bytes to read

      Returns Uint8Array<ArrayBufferLike>

    • Read a unsigned integer

      Parameters

      • bytes: number

        How many bytes the data is

      Returns number | Promise<number>

      The parsed unsigned integer

    • Read a unsigned integer as a bigint

      Parameters

      • bytes: number

        How many bytes the data is

      Returns bigint | Promise<bigint>

      The parsed unsigned integer (as a bigint)

    • Change the internal chunk size for newly allocated chunks of this FIFO

      Parameters

      • size: number

      Returns void

    • Parameters

      • ...args: [data: number[] | Uint8Array<ArrayBufferLike>]

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods