Skip to main content

Variable: read

const read: object

Direct memory reads from a pointer at a given byte offset. Faster than creating an intermediate buffer for one-off reads.

Note: u64/i64 return a JavaScript number, which cannot represent every 64-bit value. Magnitudes above Number.MAX_SAFE_INTEGER (2**53 - 1) lose precision, and u64 values with the high bit set read back as a negative number (the bytes are interpreted as a signed int64). Use the low 53 bits only, or read the raw bytes via toUint8Array if you need the exact value.

Type Declaration

f32()

f32(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number

f64()

f64(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number

i16()

i16(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number

i32()

i32(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number

i64()

i64(ptr, offset?): number

Lossy above 2**53 - 1.

Parameters

ptr

NativePointer

offset?

number

Returns

number

i8()

i8(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number

ptr()

ptr(ptr, offset?): NativePointer | null

Parameters

ptr

NativePointer

offset?

number

Returns

NativePointer | null

u16()

u16(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number

u32()

u32(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number

u64()

u64(ptr, offset?): number

Lossy above 2**53 - 1; high-bit-set values read back negative.

Parameters

ptr

NativePointer

offset?

number

Returns

number

u8()

u8(ptr, offset?): number

Parameters

ptr

NativePointer

offset?

number

Returns

number