Class ReadWriteByteBuffer

ByteBuffer is a wrapper of DataView which also adds a read and write offset. Also in a write operation it resizes the buffer is being used if it needs.

  • Use read and write function to generate or consume data.
  • Use set and get only if you are sure that you're doing.

It always passes littleEndian param as true

Hierarchy

  • ReadWriteByteBuffer

Implements

Constructors

constructor

Properties

#private _buffer roffset view woffset

Methods

buffer bufferLength currentReadOffset currentWriteOffset getFloat32 getFloat64 getInt16 getInt32 getInt64 getInt8 getUint16 getUint32 getUint64 getUint8 incrementReadOffset incrementWriteOffset readBuffer readFloat32 readFloat64 readInt16 readInt32 readInt64 readInt8 readUint16 readUint32 readUint64 readUint8 readUtf8String remainingBytes resetBuffer setFloat32 setFloat64 setInt16 setInt32 setInt64 setInt8 setUint16 setUint32 setUint64 setUint8 toBinary toCopiedBinary writeBuffer writeFloat32 writeFloat64 writeInt16 writeInt32 writeInt64 writeInt8 writeUint16 writeUint32 writeUint64 writeUint8 writeUtf8String

Constructors

constructor

  • Parameters

    • Optional buffer: Uint8Array

      The initial buffer, provide a buffer if you need to set "initial capacity"

    • Optional readingOffset: number

      Set the cursor where begins to read. Default 0

    • Optional writingOffset: number

      Set the cursor to not start writing from the begin of it. Defaults to the buffer size

    Returns ReadWriteByteBuffer

Properties

Private #private

#private: any

_buffer

_buffer: Uint8Array

roffset

roffset: number

view

view: DataView

woffset

woffset: number

Methods

buffer

  • Returns

    The entire current Uint8Array.

    WARNING: if the buffer grows, the view had changed itself, and the reference will be a invalid one.

    Returns Uint8Array

bufferLength

  • Returns

    The capacity of the current buffer

    Returns number

currentReadOffset

  • Returns

    The current read offset

    Returns number

currentWriteOffset

  • Returns

    The current write offset

    Returns number

getFloat32

  • Parameters

    • offset: number

    Returns number

getFloat64

  • Parameters

    • offset: number

    Returns number

getInt16

  • Parameters

    • offset: number

    Returns number

getInt32

  • Parameters

    • offset: number

    Returns number

getInt64

  • Parameters

    • offset: number

    Returns bigint

getInt8

  • Parameters

    • offset: number

    Returns number

getUint16

  • Parameters

    • offset: number

    Returns number

getUint32

  • Parameters

    • offset: number

    Returns number

getUint64

  • Parameters

    • offset: number

    Returns bigint

getUint8

  • Parameters

    • offset: number

    Returns number

incrementReadOffset

  • Reading purpose Returns the previuos offsset size before incrementing

    Parameters

    • amount: number

    Returns number

incrementWriteOffset

  • Increment offset

    Returns

    The offset when this reserving starts.

    Parameters

    • amount: number

      how many bytes

    Returns number

readBuffer

  • Returns Uint8Array

readFloat32

  • Returns number

readFloat64

  • Returns number

readInt16

  • Returns number

readInt32

  • Returns number

readInt64

  • Returns bigint

readInt8

  • Returns number

readUint16

  • Returns number

readUint32

  • Returns number

readUint64

  • Returns bigint

readUint8

  • Returns number

readUtf8String

  • Returns string

remainingBytes

  • Returns

    How many bytes are available to read.

    Returns number

resetBuffer

  • Resets byteBuffer to avoid creating a new one

    Returns void

setFloat32

  • Parameters

    • offset: number
    • value: number

    Returns void

setFloat64

  • Parameters

    • offset: number
    • value: number

    Returns void

setInt16

  • Parameters

    • offset: number
    • value: number

    Returns void

setInt32

  • Parameters

    • offset: number
    • value: number

    Returns void

setInt64

  • Parameters

    • offset: number
    • value: bigint

    Returns void

setInt8

  • Parameters

    • offset: number
    • value: number

    Returns void

setUint16

  • Parameters

    • offset: number
    • value: number

    Returns void

setUint32

  • Parameters

    • offset: number
    • value: number

    Returns void

setUint64

  • Parameters

    • offset: number
    • value: bigint

    Returns void

setUint8

  • Parameters

    • offset: number
    • value: number

    Returns void

toBinary

  • Take care using this function, if you modify the data after, the returned subarray will change too. If you'll modify the content of the bytebuffer, maybe you want to use toCopiedBinary()

    Returns

    The subarray from 0 to offset as reference.

    Returns Uint8Array

toCopiedBinary

  • Safe copied buffer of the current data of ByteBuffer

    Returns

    The subarray from 0 to offset.

    Returns Uint8Array

writeBuffer

  • Parameters

    • value: Uint8Array
    • Optional writeLength: boolean

    Returns void

writeFloat32

  • Parameters

    • value: number

    Returns void

writeFloat64

  • Parameters

    • value: number

    Returns void

writeInt16

  • Parameters

    • value: number

    Returns void

writeInt32

  • Parameters

    • value: number

    Returns void

writeInt64

  • Parameters

    • value: bigint

    Returns void

writeInt8

  • Parameters

    • value: number

    Returns void

writeUint16

  • Parameters

    • value: number

    Returns void

writeUint32

  • Parameters

    • value: number

    Returns void

writeUint64

  • Parameters

    • value: bigint

    Returns void

writeUint8

  • Parameters

    • value: number

    Returns void

writeUtf8String

  • Parameters

    • value: string
    • Optional writeLength: boolean

    Returns void

Settings

Member Visibility

Theme