@temporary-escape/mod-sdk / CborEncoder

Class: CborEncoder

Defined in: cbor.ts:59

Streaming CBOR encoder that writes into a growable in-guest buffer.

The buffer starts empty and grows to the next 4096-byte boundary whenever a write would exceed the current capacity (matching the 4096-byte rounding of C++ Cbor::BufferWriter), so documents of any size can be encoded without knowing the size up front. The encoders of integers/strings/tags pick the smallest representation, matching tinycbor.

Constructors

Constructor

new CborEncoder(): CborEncoder;

Returns

CborEncoder

Accessors

dataStart

Get Signature

get dataStart(): number;

Defined in: cbor.ts:61

Guest-memory offset of the encoded bytes (for the (ptr, len) ABI).

Returns

number

---

size

Get Signature

get size(): number;

Defined in: cbor.ts:66

Number of bytes written so far.

Returns

number

Methods

packArray()

packArray(count: number): void;

Defined in: cbor.ts:79

Parameters

Parameter	Type
count	number

Returns

void

---

packAssetBlock()

packAssetBlock(value: AssetBlock | null): void;

Defined in: cbor.ts:345

Parameters

Parameter	Type
value	AssetBlock | null

Returns

void

---

packAssetBlockCategory()

packAssetBlockCategory(value: AssetBlockCategory | null): void;

Defined in: cbor.ts:377

Parameters

Parameter	Type
value	AssetBlockCategory | null

Returns

void

---

packAssetFaction()

packAssetFaction(value: AssetFaction | null): void;

Defined in: cbor.ts:357

Parameters

Parameter	Type
value	AssetFaction | null

Returns

void

---

packAssetImage()

packAssetImage(value: AssetImage | null): void;

Defined in: cbor.ts:341

Parameters

Parameter	Type
value	AssetImage | null

Returns

void

---

packAssetModel()

packAssetModel(value: AssetModel | null): void;

Defined in: cbor.ts:349

Parameters

Parameter	Type
value	AssetModel | null

Returns

void

---

packAssetPlanet()

packAssetPlanet(value: AssetPlanet | null): void;

Defined in: cbor.ts:369

Parameters

Parameter	Type
value	AssetPlanet | null

Returns

void

---

packAssetSectorType()

packAssetSectorType(value: AssetSectorType | null): void;

Defined in: cbor.ts:365

Parameters

Parameter	Type
value	AssetSectorType | null

Returns

void

---

packAssetShader()

packAssetShader(value: AssetShader | null): void;

Defined in: cbor.ts:385

Parameters

Parameter	Type
value	AssetShader | null

Returns

void

---

packAssetShipDesign()

packAssetShipDesign(value: AssetShipDesign | null): void;

Defined in: cbor.ts:361

Parameters

Parameter	Type
value	AssetShipDesign | null

Returns

void

---

packAssetSkybox()

packAssetSkybox(value: AssetSkybox | null): void;

Defined in: cbor.ts:393

Parameters

Parameter	Type
value	AssetSkybox | null

Returns

void

---

packAssetSound()

packAssetSound(value: AssetSound | null): void;

Defined in: cbor.ts:381

Parameters

Parameter	Type
value	AssetSound | null

Returns

void

---

packAssetSystemType()

packAssetSystemType(value: AssetSystemType | null): void;

Defined in: cbor.ts:389

Parameters

Parameter	Type
value	AssetSystemType | null

Returns

void

---

packAssetTexture()

packAssetTexture(value: AssetTexture | null): void;

Defined in: cbor.ts:353

Parameters

Parameter	Type
value	AssetTexture | null

Returns

void

---

packAssetTurret()

packAssetTurret(value: AssetTurret | null): void;

Defined in: cbor.ts:373

Parameters

Parameter	Type
value	AssetTurret | null

Returns

void

---

packBool()

packBool(value: bool): void;

Defined in: cbor.ts:150

Parameters

Parameter	Type
value	bool

Returns

void

---

packBoolTypedArray()

packBoolTypedArray(values: StaticArray<number>): void;

Defined in: cbor.ts:210

Parameters

Parameter	Type
values	StaticArray<number>

Returns

void

---

packBytes()

packBytes(value: Uint8Array): void;

Defined in: cbor.ts:142

Parameters

Parameter	Type
value	Uint8Array

Returns

void

---

packDouble()

packDouble(value: number): void;

Defined in: cbor.ts:165

Parameters

Parameter	Type
value	number

Returns

void

---

packF32TypedArray()

packF32TypedArray(values: StaticArray<number>): void;

Defined in: cbor.ts:188

Parameters

Parameter	Type
values	StaticArray<number>

Returns

void

---

packF64TypedArray()

packF64TypedArray(values: StaticArray<number>): void;

Defined in: cbor.ts:201

Parameters

Parameter	Type
values	StaticArray<number>

Returns

void

---

packFloat()

packFloat(value: number): void;

Defined in: cbor.ts:158

Parameters

Parameter	Type
value	number

Returns

void

---

packI16()

packI16(value: number): void;

Defined in: cbor.ts:113

Parameters

Parameter	Type
value	number

Returns

void

---

packI32()

packI32(value: number): void;

Defined in: cbor.ts:117

Parameters

Parameter	Type
value	number

Returns

void

---

packI32TypedArray()

packI32TypedArray(values: StaticArray<number>): void;

Defined in: cbor.ts:192

Parameters

Parameter	Type
values	StaticArray<number>

Returns

void

---

packI64()

packI64(value: number): void;

Defined in: cbor.ts:121

Parameters

Parameter	Type
value	number

Returns

void

---

packI8()

packI8(value: number): void;

Defined in: cbor.ts:109

Parameters

Parameter	Type
value	number

Returns

void

---

packMap()

packMap(count: number): void;

Defined in: cbor.ts:75

Parameters

Parameter	Type
count	number

Returns

void

---

packMatrix3()

packMatrix3(value: Matrix3f): void;

Defined in: cbor.ts:324

Parameters

Parameter	Type
value	Matrix3f

Returns

void

---

packMatrix4()

packMatrix4(value: Matrix4f): void;

Defined in: cbor.ts:332

Parameters

Parameter	Type
value	Matrix4f

Returns

void

---

packNull()

packNull(): void;

Defined in: cbor.ts:154

Returns

void

---

packQuaternion()

packQuaternion(value: Quaternion): void;

Defined in: cbor.ts:315

Parameters

Parameter	Type
value	Quaternion

Returns

void

---

packString()

packString(value: string): void;

Defined in: cbor.ts:129

Parameters

Parameter	Type
value	string

Returns

void

---

packTag()

packTag(value: number): void;

Defined in: cbor.ts:184

Parameters

Parameter	Type
value	number

Returns

void

---

packTimePoint()

packTimePoint(value: TimePoint): void;

Defined in: cbor.ts:173

Writes the engine's extendedTime (tag 1001) representation.

Parameters

Parameter	Type
value	TimePoint

Returns

void

---

packU16()

packU16(value: number): void;

Defined in: cbor.ts:97

Parameters

Parameter	Type
value	number

Returns

void

---

packU32()

packU32(value: number): void;

Defined in: cbor.ts:101

Parameters

Parameter	Type
value	number

Returns

void

---

packU64()

packU64(value: number): void;

Defined in: cbor.ts:105

Parameters

Parameter	Type
value	number

Returns

void

---

packU8()

packU8(value: number): void;

Defined in: cbor.ts:84

Writes a CBOR simple value (matches CborVisitor.asU8).

Parameters

Parameter	Type
value	number

Returns

void

---

packVector2b()

packVector2b(value: Vector2b): void;

Defined in: cbor.ts:291

Parameters

Parameter	Type
value	Vector2b

Returns

void

---

packVector2d()

packVector2d(value: Vector2d): void;

Defined in: cbor.ts:267

Parameters

Parameter	Type
value	Vector2d

Returns

void

---

packVector2f()

packVector2f(value: Vector2f): void;

Defined in: cbor.ts:219

Parameters

Parameter	Type
value	Vector2f

Returns

void

---

packVector2i()

packVector2i(value: Vector2i): void;

Defined in: cbor.ts:243

Parameters

Parameter	Type
value	Vector2i

Returns

void

---

packVector3b()

packVector3b(value: Vector3b): void;

Defined in: cbor.ts:298

Parameters

Parameter	Type
value	Vector3b

Returns

void

---

packVector3d()

packVector3d(value: Vector3d): void;

Defined in: cbor.ts:274

Parameters

Parameter	Type
value	Vector3d

Returns

void

---

packVector3f()

packVector3f(value: Vector3f): void;

Defined in: cbor.ts:226

Parameters

Parameter	Type
value	Vector3f

Returns

void

---

packVector3i()

packVector3i(value: Vector3i): void;

Defined in: cbor.ts:250

Parameters

Parameter	Type
value	Vector3i

Returns

void

---

packVector4b()

packVector4b(value: Vector4b): void;

Defined in: cbor.ts:306

Parameters

Parameter	Type
value	Vector4b

Returns

void

---

packVector4d()

packVector4d(value: Vector4d): void;

Defined in: cbor.ts:282

Parameters

Parameter	Type
value	Vector4d

Returns

void

---

packVector4f()

packVector4f(value: Vector4f): void;

Defined in: cbor.ts:234

Parameters

Parameter	Type
value	Vector4f

Returns

void

---

packVector4i()

packVector4i(value: Vector4i): void;

Defined in: cbor.ts:258

Parameters

Parameter	Type
value	Vector4i

Returns

void

---

toBuffer()

toBuffer(): Uint8Array;

Defined in: cbor.ts:71

A copy of exactly the written bytes (capacity trimmed).

Returns

Uint8Array