Skip to main content
Module

x/steam_trader/deps.ts>ByteBuf

https://deno.land/x/steam_trader
jd1378/deno-steam-trader
Latest
class ByteBuf
extends DataView
import { ByteBuf } from "https://deno.land/x/steam_trader@v0.4.0/deps.ts";

A byte buffer.

Supports the following data types:

  • Bool
  • Int (8, 16, 32, 64)
  • Uint (8, 16, 32, 64)
  • BigInt (64)
  • VarInt (unsigned, signed, and zigzag)
  • String (utf8, utf16, and delimited)
  • TypedArray

Properties

readonly
byteOffset: number

The byte offset.

readonly
bytesRemaining: number

Gets the number of remaining bytes.

Methods

getBigInt64(byteOffset: number, littleEndian?: boolean): bigint

Gets an signed long.

getBigUint64(byteOffset: number, littleEndian?: boolean): bigint

Gets an unsigned long.

getBool(byteOffset: number): boolean

Gets a boolean.

getFloat32(byteOffset: number, littleEndian?: boolean): number

Gets a float.

getFloat64(byteOffset: number, littleEndian?: boolean): number

Gets a double.

getInt16(byteOffset: number, littleEndian?: boolean): number

Gets an signed short.

getInt32(byteOffset: number, littleEndian?: boolean): number

Gets an signed integer.

getInt64(byteOffset: number, littleEndian?: boolean): number

Gets an signed long.

getInt8(byteOffset: number): number

Gets an signed byte.

getString(
byteOffset: number,
byteLength?: number,
byteEncoding?: string,
): string

Gets a string.

getUint16(byteOffset: number, littleEndian?: boolean): number

Gets an unsigned short.

getUint16Array(byteOffset: number, byteLength?: number): Uint16Array

Gets an array of unsigned shorts.

getUint32(byteOffset: number, littleEndian?: boolean): number

Gets an unsigned integer.

getUint64(byteOffset: number, littleEndian?: boolean): number

Gets an unsigned long.

getUint8(byteOffset: number): number

Gets an unsigned byte.

getUint8Array(byteOffset: number, byteLength?: number): Uint8Array

Gets an array of unsigned bytes.

getVarInt(byteOffset: number, maxByteLength?: number): IntResult

Gets a signed, variable-length integer.

getVarString(byteOffset: number, maxByteLength?: number): StringResult

Gets a String with a variable-length delimeter.

getVarUint(byteOffset: number, maxByteLength?: number): IntResult

Gets an unsigned, variable-length integer.

getVarZint(byteOffset: number, maxByteLength?: number): IntResult

Gets a signed, variable-length integer with zigzag encoding.

readBigInt64(littleEndian?: boolean): bigint

Reads the next signed long.

readBigUint64(littleEndian?: boolean): bigint

Reads the next unsigned long.

readBool(): boolean

Reads the next boolean.

readFloat32(littleEndian?: boolean): number

Reads the next float.

readFloat64(littleEndian?: boolean): number

Reads the next double.

readInt16(littleEndian?: boolean): number

Reads the next signed short.

readInt32(littleEndian?: boolean): number

Reads the next signed integer.

readInt64(littleEndian?: boolean): number

Reads the next signed long.

readInt8(): number

Reads the next signed byte.

readString(byteLength?: number, byteEncoding?: string): string

Reads the next string.

readUint16(littleEndian?: boolean): number

Reads the next unsigned short.

readUint16Array(byteLength?: number): Uint16Array

Reads the next array of unsigned shorts.

readUint32(littleEndian?: boolean): number

Reads the next unsigned integer.

readUint64(littleEndian?: boolean): number

Reads the next unsigned long.

readUint8(): number

Reads the next unsigned byte.

readUint8Array(byteLength?: number): Uint8Array

Reads the next array of unsigned bytes.

readVarInt(maxByteLength?: number): number

Reads the next signed, variable-length integer.

readVarString(maxByteLength?: number): string

Reads the next String with a variable-length delimeter.

readVarUint(maxByteLength?: number): number

Reads the next unsigned, variable-length integer.

readVarZint(maxByteLength?: number): number

Reads the next signed, variable-length integer with zigzag encoding.

reset(): void

Resets the byte offset.

setBigInt64(
byteOffset: number,
value: bigint,
littleEndian?: boolean,
): void

Sets a signed long.

setBigUint64(
byteOffset: number,
value: bigint,
littleEndian?: boolean,
): void

Sets an unsigned long.

setBool(byteOffset: number, value: boolean): void

Sets a boolean.

setFloat32(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets a float.

setFloat64(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets a double.

setInt16(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets a signed short.

setInt32(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets a signed integer.

setInt64(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets a signed long.

setInt8(byteOffset: number, value: number): void

Sets a signed byte.

setString(
byteOffset: number,
value: string,
byteEncoding?: string,
): number

Sets a string.

setUint16(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets an unsigned short.

setUint16Array(byteOffset: number, value: Uint16Array): void

Sets an array of unsigned bytes.

setUint32(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets an unsigned integer.

setUint64(
byteOffset: number,
value: number,
littleEndian?: boolean,
): void

Sets an unsigned long.

setUint8(byteOffset: number, value: number): void

Sets an unsigned byte.

setUint8Array(byteOffset: number, value: Uint8Array): void

Sets an array of unsigned bytes.

setVarInt(
byteOffset: number,
value: number,
maxByteLength?: number,
): number

Sets a signed, variable-length integer.

setVarString(byteOffset: number, value: string): number

Sets a String with a variable-length delimeter.

setVarUint(
byteOffset: number,
value: number,
maxByteLength?: number,
): number

Sets an unsigned, variable-length integer.

setVarZint(
byteOffset: number,
value: number,
maxByteLength?: number,
): number

Sets a signed, variable-length integer with zigzag encoding.

skip(byteLength: number): void

Skips the byte offset.

toString(format?: string): string

Formats to a string.

writeBigInt64(value: bigint, littleEndian?: boolean): void

Writes the next signed long.

writeBigUint64(value: bigint, littleEndian?: boolean): void

Writes the next unsigned long.

writeBool(value: boolean): void

Writes the next boolean.

writeFloat32(value: number, littleEndian?: boolean): void

Writes the next float.

writeFloat64(value: number, littleEndian?: boolean): void

Writes the next double.

writeInt16(value: number, littleEndian?: boolean): void

Writes the next signed short.

writeInt32(value: number, littleEndian?: boolean): void

Writes the next signed integer.

writeInt64(value: number, littleEndian?: boolean): void

Writes the next signed long.

writeInt8(value: number): void

Writes the next signed byte.

writeString(value: string, byteEncoding?: string): void

Writes the next a string.

writeUint16(value: number, littleEndian?: boolean): void

Writes the next signed short.

writeUint16Array(value: Uint16Array): void

Writes the next array of unsigned bytes.

writeUint32(value: number, littleEndian?: boolean): void

Writes the next signed integer.

writeUint64(value: number, littleEndian?: boolean): void

Writes the next signed long.

writeUint8(value: number): void

Writes the next signed byte.

writeUint8Array(value: Uint8Array): void

Writes the next array of unsigned bytes.

writeVarInt(value: number, maxByteLength?: number): void

Writes the next signed, variable-length integer.

writeVarString(value: string): number

Writes the next String with a variable-length delimeter.

writeVarUint(value: number, maxByteLength?: number): void

Writes the next unsigned, variable-length integer.

writeVarZint(value: number, maxByteLength?: number): void

Writes the next unsigned, variable-length integer with zigzag encoding.

Static Methods

from(
source: BufferSource,
byteOffset?: number,
byteLength?: number,
): ByteBuf

Creates a byte buffer.