Class HazelWriter

Hierarchy (View Summary)

HazelBuffer
- HazelWriter

Index

Properties

_buffer _cursor

Accessors

buffer cursor left size

Properties

`Protected`_buffer

_buffer: Buffer

`Protected`_cursor

_cursor: number

Accessors

buffer

get buffer(): Buffer<ArrayBufferLike>
The buffer that the writer or reader is targeting.

Returns Buffer<ArrayBufferLike>
Example
```
const writer = HazelWriter.alloc(6);

console.log(writer; // => <HazelBuffer [00] 00 00 00 00 00>
```
Inherited from HazelBuffer.buffer
- Defined in packages/util/lib/HazelBuffer.ts:45

cursor

get cursor(): number
The current position of the writer or reader.

Returns number
Example
```
const writer = HazelWriter.alloc(2);
writer.uint16(4);

console.log(writer.cursor); // => 2
```
Inherited from HazelBuffer.cursor
- Defined in packages/util/lib/HazelBuffer.ts:72

left

get left(): number
The number of bytes left in the writer or reader.

Returns number
Example
```
const writer = HazelWriter.alloc(6);
writer.uint16(4);

console.log(writer.left); // => 4
```
Inherited from HazelBuffer.left
- Defined in packages/util/lib/HazelBuffer.ts:86

size

get size(): number
The size of the buffer that the writer or reader is targeting.

Returns number
Example
```
const writer = HazelWriter.alloc(6);

console.log(writer.size); // => 6
```
Inherited from HazelBuffer.size
- Defined in packages/util/lib/HazelBuffer.ts:58

Methods

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Returns Generator<number, void, unknown>
Inherited from HazelBuffer.[iterator]
- Defined in packages/util/lib/HazelBuffer.ts:90

begin

begin(tag: number): HazelWriter
Begin writing a new length & tag message.
Parameters
- tag: number
  The tag of the message.
Returns HazelWriter
The writer.
```
const writer = HazelWriter.alloc(4);
writer.begin(5);
writer.uint8(0x45);
writer.end();
```
- Defined in packages/util/lib/HazelWriter.ts:557

bool

bool(val: boolean): HazelWriter
Write a true or false value.
Parameters
- val: boolean
  The value to write.
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(4);

writer.bool(true);
writer.bool(false);
```
- Defined in packages/util/lib/HazelWriter.ts:225

byte

byte(val: number): HazelWriter
Write a single unsigned byte.
Parameters
- val: number
  The value to write. (Between 0 and 255 inclusive.)
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(1);

writer.byte(69);
```
- Defined in packages/util/lib/HazelWriter.ts:174

bytes

bytes(bytes: string | number[] | HazelBuffer | Buffer<ArrayBufferLike>): this
Write non-length-prefixed bytes.
Parameters
- bytes: string | number[] | HazelBuffer | Buffer<ArrayBufferLike>
  The bytes to write to the buffer.
Returns this
The writer.
```
const writer = HazelWriter.alloc(5);
writer.bytes("Hello");
```
- Defined in packages/util/lib/HazelWriter.ts:530

char

char(val: string): void
Write a single utf8 char.
Parameters
- val: string
  The value to write.
Returns void
The writer.
Example
```
const writer = HazelWriter.alloc(4);

writer.char("A");
writer.char("6");
```
- Defined in packages/util/lib/HazelWriter.ts:205

clone

clone(): HazelWriter

Clone the message writer to a new writer with a separate buffer.

Returns HazelWriter

The new message writer.

Example

const writer = HazelWriter.alloc(2);
writer.uint8(32);
writer.uint8(12);

const cloned = writer.clone();
cloned.uint8(90);

console.log(writer); // => <HazelBuffer 20 0c [  ]>
console.log(cloned); // => <HazelBuffer 20 0c 5a [  ]>

compare

compare(other: HazelBuffer): boolean
Check whether two hazel buffers contain the same information.
Parameters
- other: HazelBuffer
  The other hazel writer to check.
Returns boolean
Whether or not the hazel writers are the same.
Example
```
const writer = HazelWriter.alloc(2);
writer.uint8(21);
writer.uint8(69);

const writer2 = HazelWriter.alloc(2);
writer.uint8(21);
writer.uint8(69);

console.log(writer.compare(writer2)); // => true

writer2.uint8(90);

console.log(writer.compare(writer2)); // => false
```
Inherited from HazelBuffer.compare
- Defined in packages/util/lib/HazelBuffer.ts:207

end

end(): HazelWriter
End writing an opened message.

Returns HazelWriter
The writer.
```
const writer = HazelWriter.alloc(4);
writer.begin(5);
writer.uint8(0x45);
writer.end();
```
- Defined in packages/util/lib/HazelWriter.ts:574

expand

expand(required: number): HazelWriter
Expand the writer by the number of bytes required to write a value. Won't reallocate if there are enough bytes remaining.
Parameters
- required: number
  The number of bytes required to write a value.
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(6);
writer.expand(2); // The cursor is at 0, since there is 2 bytes remaining, the size remains at 6.

console.log(writer.size); // => 6

writer.expand(8); // There is not 8 bytes remaining so the writer buffer is reallocated to 8.
console.log(writer.size); // => 8
```
- Defined in packages/util/lib/HazelWriter.ts:106

float

float(val: number, be?: boolean): HazelWriter
Write an IEEE 754 floating point number.
Parameters
- val: number
  The value to write.
- be: boolean = false
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(8);

writer.float(54.32);
writer.float(21.69420);
```
- Defined in packages/util/lib/HazelWriter.ts:441

goto

goto(pos: number): HazelWriter
Move the cursor to a position.
Parameters
- pos: number
  The position to move to.
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(12);
writer.goto(5);

console.log(writer.cursor); // => 5
```
Inherited from HazelBuffer.goto
- Defined in packages/util/lib/HazelBuffer.ts:158

int16

int16(val: number, be?: boolean): HazelWriter
Write a signed 16-bit integer value.
Parameters
- val: number
  The value to write. (Between -32767 and 32767 inclusive.)
- be: boolean = false
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(4);

writer.int16(-3452);
writer.int16(1933);
```
- Defined in packages/util/lib/HazelWriter.ts:313

int32

int32(val: number, be?: boolean): HazelWriter
Write a signed 32-bit integer value.
Parameters
- val: number
  The value to write. (Between -2147483647 and 2147483647 inclusive.)
- be: boolean = false
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(8);

writer.int32(-432423);
writer.int32(1212112);
```
- Defined in packages/util/lib/HazelWriter.ts:365

int64

int64(val: bigint, be?: boolean): HazelWriter
Write a signed 64-bit integer value.
Parameters
- val: bigint
  The value to write. (Between -2147483647 and 2147483647 inclusive.)
- be: boolean = false
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(8);

writer.int64(-432423);
```
- Defined in packages/util/lib/HazelWriter.ts:415

int8

int8(val: number): HazelWriter
Write a signed 8-bit integer value.
Parameters
- val: number
  The value to write. (Between -127 and 127 inclusive.)
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(4);

writer.int8(-120);
writer.int8(68);
```
- Defined in packages/util/lib/HazelWriter.ts:153

jump

jump(bytes: number): HazelWriter
Skip a speciied number of bytes.
Parameters
- bytes: number
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(12);
writer.skip(3);
writer.skip(2);
writer.skip(5);

console.log(writer.cursor); // => 10
```
Inherited from HazelBuffer.jump
- Defined in packages/util/lib/HazelBuffer.ts:179

list

list<T>(length: boolean, arr: T[], fn?: ListWriter<T>): HazelWriter
Write an object list from the buffer.
Type Parameters
- T
Parameters
- length: boolean
  The length of the list.
- arr: T[]
- Optionalfn: ListWriter<T>
  The function accepting a single reader to use for reading data.
Returns HazelWriter
The writer.
Example
```
const nums = [5, 6, 7, 8];
const reader = HazelReader.alloc(0);

const items = reader.list(nums, (item, writer) => writer.uint8(item));

console.log(items); // => [5, 6, 7, 8];
```
- Defined in packages/util/lib/HazelWriter.ts:609

lwrite

lwrite<K extends Serializable<any[]>>(
    length: boolean,
    serializable: K[],
    ...args: GetSerializeArgs<K>,
): HazelWriter
Write a list of serializable objects to the writer.
Type Parameters
- K extends Serializable<any[]>
Parameters
- length: boolean
- serializable: K[]
  The objects to write.
- ...args: GetSerializeArgs<K>
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(0);

writer.write(players.map(player => player.control));
```
- Defined in packages/util/lib/HazelWriter.ts:260

packed

packed(val: number): void
Write a signed variable-sized integer.
Parameters
- val: number
  The value to write.
Returns void
The writer.
Example
```
const writer = HazelWriter.alloc(0);

writer.packed(-420);
writer.packed(153);
```
- Defined in packages/util/lib/HazelWriter.ts:469

realloc

realloc(size: number): HazelWriter
Reallocate the the number of bytes in the writer.
Parameters
- size: number
  The size to reallocate to.
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(4);
writer.realloc(8);

console.log(writer.size); // => 8
```
- Defined in packages/util/lib/HazelWriter.ts:77

sbyte

sbyte(val: number): HazelWriter
Write a single signed byte.
Parameters
- val: number
  The value to write. (Between -127 and 127 inclusive.)
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(1);

writer.byte(-32);
```
- Defined in packages/util/lib/HazelWriter.ts:189

string

string(val: string): void
Write a packed int length-prefixed string.
Parameters
- val: string
  The string to write.
Returns void
The writer.
Example
```
const writer = HazelWriter.alloc(9);

writer.string("poopy");
writer.string("poop");
```
- Defined in packages/util/lib/HazelWriter.ts:515

toString

toString(encoding?: BufferEncoding): string
Parameters
- encoding: BufferEncoding = "hex"
Returns string
Inherited from HazelBuffer.toString
- Defined in packages/util/lib/HazelBuffer.ts:96

uint16

uint16(val: number, be?: boolean): HazelWriter
Write an unsigned 16-bit integer value.
Parameters
- val: number
  The value to write. (Between 0 and 65535 inclusive.)
- be: boolean = false
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(4);

writer.uint16(5342);
writer.uint16(256);
```
- Defined in packages/util/lib/HazelWriter.ts:287

uint32

uint32(val: number, be?: boolean): HazelWriter
Write an unsigned 32-bit integer value.
Parameters
- val: number
  The value to write. (Between 0 and 4294967295 inclusive.)
- be: boolean = false
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(8);

writer.uint32(6764774);
writer.uint32(12314352);
```
- Defined in packages/util/lib/HazelWriter.ts:339

uint64

uint64(val: bigint, be?: boolean): HazelWriter
Write an unsigned 64-bit integer value.
Parameters
- val: bigint
  The value to write. (Between 0 and 18446744073709552000 inclusive.)
- be: boolean = false
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(8);

writer.uint64(6764774);
```
- Defined in packages/util/lib/HazelWriter.ts:390

uint8

uint8(val: number): HazelWriter
Write an unsigned 8-bit integer value.
Parameters
- val: number
  The value to write. (Between 0 and 255 inclusive.)
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(1);

writer.uint8(54);
```
- Defined in packages/util/lib/HazelWriter.ts:131

upacked

upacked(val: number): void
Write an unsigned variable-size integer.
Parameters
- val: number
  The value to write.
Returns void
The writer.
Example
```
const writer = HazelWriter.alloc(0);

writer.packed(54325);
writer.packed(11293);
```
- Defined in packages/util/lib/HazelWriter.ts:487

vector

vector(position: Vector2): void
Write a vector position into 2 16 bit integers.
Parameters
- position: Vector2
  The position to write.
Returns void
The writer.
- Defined in packages/util/lib/HazelWriter.ts:627

write

write<K extends Serializable<any[]>>(
serializable: K,
...args: GetSerializeArgs<K>,
): HazelWriter
Write a serializable object to the writer.
Type Parameters
- K extends Serializable<any[]>
Parameters
- serializable: K
  The object to write.
- ...args: GetSerializeArgs<K>
Returns HazelWriter
The writer.
Example
```
const writer = HazelWriter.alloc(0);

writer.write(player.control);
```
- Defined in packages/util/lib/HazelWriter.ts:241

`Static`alloc

alloc(bytes: number): HazelWriter
Allocate a message writer with a buffer of the specified number of bytes.
Parameters
- bytes: number
  The number of bytes to allocate.
Returns HazelWriter
The message writer writing to the allocated bytes.
Example
```
const writer = HazelWriter.alloc(6);

console.log(writer.size); // => 6
```
- Defined in packages/util/lib/HazelWriter.ts:26

`Protected` `Static`checkInteger

checkInteger(val: number | bigint, bounds?: IntegerBoundary): void
Parameters
- val: number | bigint
- Optionalbounds: IntegerBoundary
Returns void
Inherited from HazelBuffer.checkInteger
- Defined in packages/util/lib/HazelBuffer.ts:10

Class HazelWriter

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Protected_buffer

Protected_cursor

Accessors

buffer

Returns Buffer<ArrayBufferLike>

Example

cursor

Returns number

Example

left

Returns number

Example

size

Returns number

Example

Methods

[iterator]

Returns Generator<number, void, unknown>

begin

Parameters

Returns HazelWriter

bool

Parameters

Returns HazelWriter

Example

byte

Parameters

Returns HazelWriter

Example

bytes

Parameters

Returns this

char

Parameters

Returns void

Example

clone

Returns HazelWriter

Example

compare

Parameters

Returns boolean

Example

end

Returns HazelWriter

expand

Parameters

Returns HazelWriter

Example

float

Parameters

Returns HazelWriter

Example

goto

Parameters

Returns HazelWriter

Example

int16

Parameters

Returns HazelWriter

Example

int32

Parameters

Returns HazelWriter

Example

int64

Parameters

Returns HazelWriter

Example

int8

Parameters

Returns HazelWriter

Example

`Protected`_buffer

`Protected`_cursor

`Static`alloc

`Protected` `Static`checkInteger