Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataBufferSubset

A subset of a DataBuffer.

Hierarchy

  • DataBuffer
    • DataBufferSubset

Index

Constructors

constructor

  • new DataBufferSubset(buffer: DataBuffer, index: number, length: number): DataBufferSubset

Properties

Private _parent

_parent: DataBuffer
internal

Methods

and

  • and(value: number, offset: number): boolean
  • Performs a bitwise "and" operation on a value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

append

  • append(buffers: DataBuffer[]): DataBuffer
  • append(buffer: DataBuffer): DataBuffer
  • Appends some buffers.

    Parameters

    • buffers: DataBuffer[]

      The buffers.

    Returns DataBuffer

  • Appends a buffer.

    Parameters

    • buffer: DataBuffer

      The buffer.

    Returns DataBuffer

clone

  • clone(littleEndian: boolean): DataBuffer
  • clone(): DataBuffer
  • Clones this instance.

    Parameters

    • littleEndian: boolean

      Whether to clone into a little endian buffer.

    Returns DataBuffer

  • Clones this instance.

    Returns DataBuffer

free

  • free(): void
  • Decrements the retain count by one and returns the Buffer to the pool if zero.

    Returns void

getData

  • getData(): Uint8Array
  • Gets the data.

    Returns Uint8Array

getIndex

  • getIndex(): number
  • Gets the index.

    Returns number

Protected getInnerData

  • getInnerData(): Uint8Array
  • Gets backing data buffer.

    Returns Uint8Array

getIsPooled

  • getIsPooled(): boolean
  • Gets whether this DataBuffer is from a pool.

    Returns boolean

getIsSubset

  • getIsSubset(): boolean
  • Gets whether this DataBuffer is a subset.

    Returns boolean

getLength

  • getLength(): number
  • Gets the length.

    Returns number

getLittleEndian

  • getLittleEndian(): boolean
  • Gets whether fm.icelink.dataBuffer.data is little-endian.

    Returns boolean

getParent

  • getParent(): DataBuffer
  • Gets the Subset parent.

    Returns DataBuffer

getTypeString

  • getTypeString(): string

keep

  • keep(): DataBuffer
  • Increment the retain count by one.

    Returns DataBuffer

or

  • or(value: number, offset: number): boolean
  • Performs a bitwise "or" operation on a value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

prepend

  • prepend(buffer: DataBuffer): DataBuffer
  • prepend(buffers: DataBuffer[]): void
  • Prepends a buffer.

    Parameters

    • buffer: DataBuffer

      The buffer.

    Returns DataBuffer

  • Prepends some buffers.

    Parameters

    • buffers: DataBuffer[]

      The buffers.

    Returns void

read1

  • read1(offset: number, bitOffset: number): boolean
  • Reads a 1-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

read12

  • read12(offset: number, bitOffset: number): number
  • Reads a 12-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bitoffset.

    Returns number

read13

  • read13(offset: number, bitOffset: number): number
  • Reads a 13-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bitoffset.

    Returns number

read13Signed

  • read13Signed(offset: number, bitOffset: number): number
  • Reads a 13-bit signed value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read15

  • read15(offset: number, bitOffset: number): number
  • Reads a 15-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read16

  • read16(offset: number, offsetPlus: Holder<number>): number
  • read16(offset: number): number
  • Reads a 16-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 16-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

read16Signed

  • read16Signed(offset: number, offsetPlus: Holder<number>): number
  • read16Signed(offset: number): number
  • Reads a 16-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 16-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

read18

  • read18(offset: number, bitOffset: number): number
  • Reads an 18-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read2

  • read2(offset: number, bitOffset: number): number
  • Reads a 2-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read24

  • read24(offset: number, offsetPlus: Holder<number>): number
  • read24(offset: number): number
  • Reads a 24-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 24-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

read24Signed

  • read24Signed(offset: number, offsetPlus: Holder<number>): number
  • read24Signed(offset: number): number
  • Reads a 24-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 24-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

read2Signed

  • read2Signed(offset: number, bitOffset: number): number
  • Reads a 2-bit signed value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read3

  • read3(offset: number, bitOffset: number): number
  • Reads a 3-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read32

  • read32(offset: number): number
  • read32(offset: number, offsetPlus: Holder<number>): number
  • Reads a 32-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

  • Reads a 32-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

read32Signed

  • read32Signed(offset: number, offsetPlus: Holder<number>): number
  • read32Signed(offset: number): number
  • Reads a 32-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 32-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

read3Signed

  • read3Signed(offset: number, bitOffset: number): number
  • Reads a 3-bit signed value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read4

  • read4(offset: number, bitOffset: number): number
  • Reads a 4-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read40

  • read40(offset: number, offsetPlus: Holder<number>): number
  • read40(offset: number): number
  • Reads a 40-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 40-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

read40Signed

  • read40Signed(offset: number, offsetPlus: Holder<number>): number
  • read40Signed(offset: number): number
  • Reads a 40-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 40-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

read48

  • read48(offset: number, offsetPlus: Holder<number>): number
  • read48(offset: number): number
  • Reads a 48-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 48-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

read48Signed

  • read48Signed(offset: number): number
  • read48Signed(offset: number, offsetPlus: Holder<number>): number
  • Reads a 48-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

  • Reads a 48-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

read4Signed

  • read4Signed(offset: number, bitOffset: number): number
  • Reads a 4-bit signed value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read5

  • read5(offset: number, bitOffset: number): number
  • Reads a 5-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read56

  • read56(offset: number, offsetPlus: Holder<number>): number
  • read56(offset: number): number
  • Reads a 56-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads a 56-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

read56Signed

  • read56Signed(offset: number): number
  • read56Signed(offset: number, offsetPlus: Holder<number>): number
  • Reads a 56-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

  • Reads a 56-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

read5Signed

  • read5Signed(offset: number, bitOffset: number): number
  • Reads a 5-bit signed value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read6

  • read6(offset: number, bitOffset: number): number
  • Reads a 6-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read64

  • read64(offset: number): number
  • read64(offset: number, offsetPlus: Holder<number>): number
  • Reads a 64-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

  • Reads a 64-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

read64Signed

  • read64Signed(offset: number): number
  • read64Signed(offset: number, offsetPlus: Holder<number>): number
  • Reads a 64-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

  • Reads a 64-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

read6Signed

  • read6Signed(offset: number, bitOffset: number): number
  • Reads a 6-bit signed value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read7

  • read7(offset: number, bitOffset: number): number
  • Reads a 7-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read7Signed

  • read7Signed(offset: number, bitOffset: number): number
  • Reads a 7-bit signed value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns number

read8

  • read8(offset: number): number
  • read8(offset: number, offsetPlus: Holder<number>): number
  • Reads an 8-bit value.

    Parameters

    • offset: number

      The offset.

    Returns number

  • Reads an 8-bit value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

read8Signed

  • read8Signed(offset: number, offsetPlus: Holder<number>): number
  • read8Signed(offset: number): number
  • Reads an 8-bit signed value.

    Parameters

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns number

  • Reads an 8-bit signed value.

    Parameters

    • offset: number

      The offset.

    Returns number

readUtf8String

  • readUtf8String(offset: number, length: number): string
  • readUtf8String(offset: number): string
  • Reads a UTF-8 string.

    Parameters

    • offset: number

      The offset.

    • length: number

      The length.

    Returns string

  • Read a UTF-8 string.

    Parameters

    • offset: number

      The offset.

    Returns string

resize

  • resize(newLength: number): void
  • resize(newLength: number, offset: number, setZero: boolean): void
  • resize(newLength: number, offset: number): void
  • Resizes this buffer to a new length with new data being inserted at the end.

    Parameters

    • newLength: number

      The new length.

    Returns void

  • Resizes this buffer to a new length with new data being inserted at a given offset.

    Parameters

    • newLength: number

      The new length.

    • offset: number

      The offset.

    • setZero: boolean

      Sets empty space to zero.

    Returns void

  • Resizes this buffer to a new length with new data being inserted at a given offset.

    Parameters

    • newLength: number

      The new length.

    • offset: number

      The offset.

    Returns void

sequenceEquals

  • sequenceEquals(buffer: DataBuffer): boolean
  • Compares a data buffer for equality.

    Parameters

    • buffer: DataBuffer

      The data buffer.

    Returns boolean

    true if the sequences are equal; otherwise, false.

sequenceEqualsConstantTime

  • sequenceEqualsConstantTime(buffer: DataBuffer): boolean
  • Compares a data buffer for equality in constant time.

    Parameters

    • buffer: DataBuffer

      The buffer.

    Returns boolean

    true if the sequences are equal; otherwise, false.

set

  • set(value: number): void
  • set(value: number, offset: number): void
  • set(value: number, offset: number, length: number): void
  • Sets the data buffer to the specified value.

    Parameters

    • value: number

      The value.

    Returns void

  • Sets a subset of the data buffer to the specified value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns void

  • Sets a subset of the data buffer to the specified value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • length: number

      The length.

    Returns void

setIndex

  • setIndex(value: number): void
  • Sets the index.
    internal

    Parameters

    • value: number

    Returns void

Protected setInnerData

  • setInnerData(value: Uint8Array): void
  • Sets backing data buffer.

    Parameters

    • value: Uint8Array

    Returns void

setLength

  • setLength(value: number): void
  • Sets the length.
    internal

    Parameters

    • value: number

    Returns void

setLittleEndian

  • setLittleEndian(value: boolean): void
  • Sets whether fm.icelink.dataBuffer.data is little-endian.

    Parameters

    • value: boolean

    Returns void

Private setParent

  • setParent(value: DataBuffer): void
  • internal

    Parameters

    • value: DataBuffer

    Returns void

subset

  • subset(offset: number, length: number): DataBuffer
  • subset(offset: number): DataBuffer
  • Gets a subset of this instance.

    Parameters

    • offset: number

      The offset.

    • length: number

      The length.

    Returns DataBuffer

  • Gets a subset of this instance.

    Parameters

    • offset: number

      The offset.

    Returns DataBuffer

toArray

  • toArray(): Uint8Array
  • Converts this instance to an array of bytes.

    Returns Uint8Array

toHexString

  • toHexString(): string
  • Converts this instance to a hexadecimal string.

    Returns string

toJson

  • toJson(): string
  • Serializes this instance to JSON.

    Returns string

tryRead1

  • tryRead1(offset: number, bitOffset: number, value: Holder<boolean>): boolean
  • Tries to read a 1-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<boolean>

      if set to true [value].

    Returns boolean

tryRead13

  • tryRead13(offset: number, bitOffset: number, value: Holder<number>): boolean
  • Tries to read a 13-bit value;

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead16

  • tryRead16(offset: number, value: Holder<number>): boolean
  • Tries to read a 16-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead2

  • tryRead2(offset: number, bitOffset: number, value: Holder<number>): boolean
  • Tries to read a 2-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead24

  • tryRead24(offset: number, value: Holder<number>): boolean
  • Tries to read a 24-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead3

  • tryRead3(offset: number, bitOffset: number, value: Holder<number>): boolean
  • Tries to read a 3-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead32

  • tryRead32(offset: number, value: Holder<number>): boolean
  • Tries to read a 32-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead4

  • tryRead4(offset: number, bitOffset: number, value: Holder<number>): boolean
  • Tries to read a 4-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead40

  • tryRead40(offset: number, value: Holder<number>): boolean
  • Tries to read a 40-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead48

  • tryRead48(offset: number, value: Holder<number>): boolean
  • Tries to read a 48-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead5

  • tryRead5(offset: number, bitOffset: number, value: Holder<number>): boolean
  • Tries to read a 5-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead56

  • tryRead56(offset: number, value: Holder<number>): boolean
  • Tries to read a 56-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead6

  • tryRead6(offset: number, bitOffset: number, value: Holder<number>): boolean
  • Tries to read a 6-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead64

  • tryRead64(offset: number, value: Holder<number>): boolean
  • Tries to read a 64-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead7

  • tryRead7(offset: number, bitOffset: number, value: Holder<number>): boolean
  • Tries to read a 7-bit value.

    Parameters

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    • value: Holder<number>

      The value.

    Returns boolean

tryRead8

  • tryRead8(offset: number, value: Holder<number>): boolean
  • Tries to read an 8-bit value.

    Parameters

    • offset: number

      The offset.

    • value: Holder<number>

      The value.

    Returns boolean

write

  • write(buffer: DataBuffer): void
  • write(buffer: DataBuffer, offset: number): void
  • write(buffer: DataBuffer, offset: number, offsetPlus: Holder<number>): void
  • Writes a data buffer to this instance.

    Parameters

    • buffer: DataBuffer

      The buffer.

    Returns void

  • Writes a data buffer to this instance.

    Parameters

    • buffer: DataBuffer

      The buffer.

    • offset: number

      The offset.

    Returns void

  • Writes a data buffer to this instance.

    Parameters

    • buffer: DataBuffer

      The buffer.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the buffer length.

    Returns void

write1

  • write1(value: boolean, offset: number, bitOffset: number): boolean
  • Writes a 1-bit value.

    Parameters

    • value: boolean

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write13

  • write13(value: number, offset: number, bitOffset: number): boolean
  • Writes a 13-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write16

  • write16(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • write16(value: number, offset: number): boolean
  • Writes a 16-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

  • Writes a 16-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

write18

  • write18(value: number, offset: number, bitOffset: number): boolean
  • Writes an 18-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write2

  • write2(value: number, offset: number, bitOffset: number): boolean
  • Writes a 2-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write24

  • write24(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • write24(value: number, offset: number): boolean
  • Writes a 24-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

  • Writes a 24-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

write3

  • write3(value: number, offset: number, bitOffset: number): boolean
  • Writes a 3-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write32

  • write32(value: number, offset: number): boolean
  • write32(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • Writes a 32-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

  • Writes a 32-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

write4

  • write4(value: number, offset: number, bitOffset: number): boolean
  • Writes a 4-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write40

  • write40(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • write40(value: number, offset: number): boolean
  • Writes a 40-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

  • Writes a 40-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

write48

  • write48(value: number, offset: number): boolean
  • write48(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • Writes a 48-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

  • Writes a 48-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

write5

  • write5(value: number, offset: number, bitOffset: number): boolean
  • Writes a 5-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write56

  • write56(value: number, offset: number): boolean
  • write56(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • Writes a 56-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

  • Writes a 56-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

write6

  • write6(value: number, offset: number, bitOffset: number): boolean
  • Writes a 6-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write64

  • write64(value: number, offset: number): boolean
  • write64(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • Writes a 64-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

  • Writes a 64-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

write7

  • write7(value: number, offset: number, bitOffset: number): boolean
  • Writes a 7-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • bitOffset: number

      The bit offset.

    Returns boolean

write8

  • write8(value: number, offset: number): boolean
  • write8(value: number, offset: number, offsetPlus: Holder<number>): boolean
  • Writes an 8-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

  • Writes an 8-bit value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the value length.

    Returns boolean

writeBytes

  • writeBytes(bytes: Uint8Array): void
  • writeBytes(bytes: Uint8Array, offset: number): void
  • writeBytes(bytes: Uint8Array, bytesIndex: number, bytesLength: number, offset: number): void
  • writeBytes(bytes: Uint8Array, bytesIndex: number, bytesLength: number, offset: number, offsetPlus: Holder<number>): void
  • writeBytes(bytes: Uint8Array, bytesIndex: number, offset: number): void
  • Writes a byte array to this instance.

    Parameters

    • bytes: Uint8Array

      The bytes.

    Returns void

  • Writes a byte array to this instance.

    Parameters

    • bytes: Uint8Array

      The bytes.

    • offset: number

      The offset.

    Returns void

  • Writes a byte array to this instance.

    Parameters

    • bytes: Uint8Array

      The bytes.

    • bytesIndex: number

      The bytes index.

    • bytesLength: number

      The bytes length.

    • offset: number

      The offset.

    Returns void

  • Writes a byte array to this instance.

    Parameters

    • bytes: Uint8Array

      The bytes.

    • bytesIndex: number

      The bytes index.

    • bytesLength: number

      The bytes length.

    • offset: number

      The offset.

    • offsetPlus: Holder<number>

      The offset plus the buffer length.

    Returns void

  • Writes a byte array to this instance.

    Parameters

    • bytes: Uint8Array

      The bytes.

    • bytesIndex: number

      The bytes index.

    • offset: number

      The offset.

    Returns void

xor

  • xor(value: number, offset: number): boolean
  • Performs a bitwise "xor" operation on a value.

    Parameters

    • value: number

      The value.

    • offset: number

      The offset.

    Returns boolean

Static allocate

  • allocate(count: number, littleEndian: boolean, pooled: boolean): DataBuffer
  • allocate(count: number): DataBuffer
  • allocate(count: number, littleEndian: boolean): DataBuffer
  • Allocates a new data buffer with a given size (in bytes).

    Parameters

    • count: number

      Pre-allocated data buffer size (in bytes).

    • littleEndian: boolean

      Whether the data is little-endian.

    • pooled: boolean

      Is part of a data pool.

    Returns DataBuffer

  • Allocates a new data buffer with a given size (in bytes) in big-endian format.

    Parameters

    • count: number

      Pre-allocated data buffer size (in bytes).

    Returns DataBuffer

  • Allocates a new data buffer with a given size (in bytes).

    Parameters

    • count: number

      Pre-allocated data buffer size (in bytes).

    • littleEndian: boolean

      Whether the data is little-endian.

    Returns DataBuffer

Static areEqual

  • areEqual(buffer1: DataBuffer, buffer2: DataBuffer): boolean
  • Tests if the two buffers have equal contents.

    Parameters

    • buffer1: DataBuffer

      First buffer to test.

    • buffer2: DataBuffer

      Second buffer to test.

    Returns boolean

Static fromJson

  • fromJson(dataBufferJson: string): DataBuffer
  • Deserializes an instance from JSON.

    Parameters

    • dataBufferJson: string

      The data buffer JSON.

    Returns DataBuffer

Static fromJsonArray

  • fromJsonArray(dataBuffersJson: string): DataBuffer[]
  • Deserializes an array of instances from JSON.

    Parameters

    • dataBuffersJson: string

      The data buffers JSON.

    Returns DataBuffer[]

Static getEmpty

  • getEmpty(): DataBuffer
  • Gets an empty data buffer.

    Returns DataBuffer

Static toJson

  • toJson(dataBuffer: DataBuffer): string
  • Serializes an instance to JSON.

    Parameters

    • dataBuffer: DataBuffer

      The data buffer.

    Returns string

Static toJsonArray

  • toJsonArray(dataBuffers: DataBuffer[]): string
  • Serializes an array of instances to JSON.

    Parameters

    • dataBuffers: DataBuffer[]

      The data buffers.

    Returns string

Static wrap

  • wrap(data: Uint8Array, index: number): DataBuffer
  • wrap(data: Uint8Array, index: number, littleEndian: boolean): DataBuffer
  • wrap(data: Uint8Array, index: number, length: number): DataBuffer
  • wrap(data: Uint8Array, littleEndian: boolean): DataBuffer
  • wrap(data: Uint8Array, index: number, length: number, littleEndian: boolean): DataBuffer
  • wrap(data: Uint8Array): DataBuffer
  • Produces a new data buffer containing supplied data in big-endian format.

    Parameters

    • data: Uint8Array

      The data.

    • index: number

      The index.

    Returns DataBuffer

  • Produces a new data buffer containing supplied data.

    Parameters

    • data: Uint8Array

      The data.

    • index: number

      The index.

    • littleEndian: boolean

      Whether the data is little-endian.

    Returns DataBuffer

  • Produces a new data buffer containing supplied data in big-endian format.

    Parameters

    • data: Uint8Array

      The data.

    • index: number

      The index.

    • length: number

      The length.

    Returns DataBuffer

  • Produces a new data buffer containing supplied data.

    Parameters

    • data: Uint8Array

      The data.

    • littleEndian: boolean

      Whether the data is little-endian.

    Returns DataBuffer

  • Produces a new data buffer containing supplied data.

    Parameters

    • data: Uint8Array

      The data.

    • index: number

      The index.

    • length: number

      The length.

    • littleEndian: boolean

      Whether the data is little-endian.

    Returns DataBuffer

  • Produces a new data buffer containing supplied data in big-endian format.

    Parameters

    • data: Uint8Array

      The data.

    Returns DataBuffer