Struct spacetimedb_bindings_sys::raw::Buffer

pub struct Buffer { /* private fields */ }

A handle into a buffer of bytes in the host environment.

Used for transporting bytes host <-> WASM linear memory.

Implementations

impl Buffer

pub const fn handle(&self) -> ManuallyDrop<Self>

Returns a “handle” that can be passed across the FFI boundary as if it was the Buffer itself, but without consuming it.

pub const INVALID: Self = _

An invalid buffer handle.

Could happen if too many buffers exist, making the key overflow a u32. INVALID is also used for parts of the protocol that are “morally” sending a Nones in Option<Box<[u8]>>s.

pub const fn is_invalid(&self) -> bool

Is the buffer handle invalid?

impl Buffer

pub fn data_len(&self) -> usize

Returns the number of bytes of the data stored in the buffer.

pub fn read_into(self, buf: &mut Vec<u8>)

Read the contents of the buffer into the provided Vec. The Vec is cleared in the process.

pub fn read(self) -> Box<[u8]>

Read the contents of the buffer into a new boxed byte slice.

pub fn read_array<const N: usize>(self) -> [u8; N]

Read the contents of the buffer into an array of fixed size N.

If the length is wrong, the module will crash.

pub fn read_uninit(self, buf: &mut [MaybeUninit<u8>])

Reads the buffer into an uninitialized byte string buf.

The module will crash if buf’s length doesn’t match the buffer.

pub fn alloc(data: &[u8]) -> Self

Allocates a buffer with the contents of data.