@temporary-escape/mod-sdk / CborEncoder

Class: CborEncoder

Defined in: cbor.ts:22

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:24

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

Returns

number

---

size

Get Signature

get size(): number;

Defined in: cbor.ts:29

Number of bytes written so far.

Returns

number

Methods

packArray()

packArray(count: number): void;

Defined in: cbor.ts:42

Parameters

Parameter	Type
count	number

Returns

void

---

packBool()

packBool(value: bool): void;

Defined in: cbor.ts:113

Parameters

Parameter	Type
value	bool

Returns

void

---

packBytes()

packBytes(value: Uint8Array): void;

Defined in: cbor.ts:105

Parameters

Parameter	Type
value	Uint8Array

Returns

void

---

packDouble()

packDouble(value: number): void;

Defined in: cbor.ts:128

Parameters

Parameter	Type
value	number

Returns

void

---

packFloat()

packFloat(value: number): void;

Defined in: cbor.ts:121

Parameters

Parameter	Type
value	number

Returns

void

---

packI16()

packI16(value: number): void;

Defined in: cbor.ts:76

Parameters

Parameter	Type
value	number

Returns

void

---

packI32()

packI32(value: number): void;

Defined in: cbor.ts:80

Parameters

Parameter	Type
value	number

Returns

void

---

packI64()

packI64(value: number): void;

Defined in: cbor.ts:84

Parameters

Parameter	Type
value	number

Returns

void

---

packI8()

packI8(value: number): void;

Defined in: cbor.ts:72

Parameters

Parameter	Type
value	number

Returns

void

---

packMap()

packMap(count: number): void;

Defined in: cbor.ts:38

Parameters

Parameter	Type
count	number

Returns

void

---

packNull()

packNull(): void;

Defined in: cbor.ts:117

Returns

void

---

packString()

packString(value: string): void;

Defined in: cbor.ts:92

Parameters

Parameter	Type
value	string

Returns

void

---

packTag()

packTag(value: number): void;

Defined in: cbor.ts:135

Parameters

Parameter	Type
value	number

Returns

void

---

packU16()

packU16(value: number): void;

Defined in: cbor.ts:60

Parameters

Parameter	Type
value	number

Returns

void

---

packU32()

packU32(value: number): void;

Defined in: cbor.ts:64

Parameters

Parameter	Type
value	number

Returns

void

---

packU64()

packU64(value: number): void;

Defined in: cbor.ts:68

Parameters

Parameter	Type
value	number

Returns

void

---

packU8()

packU8(value: number): void;

Defined in: cbor.ts:47

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

Parameters

Parameter	Type
value	number

Returns

void

---

toBuffer()

toBuffer(): Uint8Array;

Defined in: cbor.ts:34

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

Returns

Uint8Array