Class Region

Wrapper class for the Region data structure, which describes a region of WebAssembly's linear memory that has been allocated by the VM.

Note that this class is passed a pointer to the data structure, and the Region's members (offset: u32, capacity: u32, length: u32) are read from that pointer as they are laid out in the data structure.

Constructors

constructor

Properties

memory ptr region_info

Accessors

b64 capacity data json length offset slice str

Methods

read read_b64 read_json read_str write write_b64 write_json write_str

Constructors

constructor

  • new Region(memory, ptr): Region

  • Parameters

    • memory: Memory

      The WebAssembly.Memory object that this region is associated

    • ptr: number

      The offset of the region's data structure in memory

    Returns Region

Properties

memory

memory: Memory

ptr

ptr: number

region_info

region_info: Uint32Array

The region's data structure laid out in memory.

Accessors

b64

  • get b64(): string

  • Get a base64-encoded string of the region's data.

    Returns string

capacity

  • get capacity(): number

  • Returns number

  • set capacity(val): void

  • Parameters

    • val: number

    Returns void

data

  • get data(): Uint8Array

  • Get a byte-slice of the region's data.

    Returns Uint8Array

json

  • get json(): object

  • Parse the object of the region's data as JSON.

    Returns object

length

  • get length(): number

  • Returns number

  • set length(val): void

  • Parameters

    • val: number

    Returns void

offset

  • get offset(): number

  • Returns number

  • set offset(val): void

  • Parameters

    • val: number

    Returns void

slice

  • get slice(): Uint8Array

  • Get a byte-slice of the entire writable region.

    Returns Uint8Array

str

  • get str(): string

  • Get a string view of the region's data.

    Returns string

Methods

read

  • read(): Uint8Array

  • Reads the region's data as a Uint8Array.

    Returns Uint8Array

    The byte-slice of the region's data.

read_b64

  • read_b64(): string

  • Returns string

read_json

  • read_json(): object

  • Parse the region's data as JSON.

    Returns object

    The region's data as a JSON object.

read_str

  • read_str(): string

  • Reads the region's data as a String.

    Returns string

    The region's data as a string.

write

  • write(bytes): void

  • Write a byte-slice to the region.

    Parameters

    • bytes: Uint8Array

      The bytes to write to the region

    Returns void

write_b64

  • write_b64(b64): void

  • Write bytes encoded as base64 to the region.

    Parameters

    • b64: string

      bytes encoded as base64

    Returns void

write_json

  • write_json(obj): void

  • Write a JSON object to the region as a string.

    Parameters

    • obj: object

      The object to write to the region

    Returns void

write_str

  • write_str(str): void

  • Write a string to the region.

    Parameters

    • str: string

      The string to write to the region

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc