Struct BufferWriter 

pub struct BufferWriter { /* private fields */ }

Serializes values into the WeaveFFI buffer format.

The #[weaveffi::module] expansion writes record fields, enum payloads, collection elements, and error payloads through one of these, then hands the finished bytes across the ABI (via lower_bytes for returns, or borrowed directly for callback arguments).

Implementations

impl BufferWriter

pub fn new() -> Self

Create an empty writer.

pub fn finish(self) -> Vec<u8>

Consume the writer and return the encoded bytes.

pub fn write_bool(&mut self, v: bool)

Write a bool as one byte (0 or 1).

pub fn write_i8(&mut self, v: i8)

Write an i8.

pub fn write_u8(&mut self, v: u8)

Write a u8.

pub fn write_i16(&mut self, v: i16)

Write an i16 little-endian.

pub fn write_u16(&mut self, v: u16)

Write a u16 little-endian.

pub fn write_i32(&mut self, v: i32)

Write an i32 little-endian. Also the encoding of C-style enum values and rich-enum tags.

pub fn write_u32(&mut self, v: u32)

Write a u32 little-endian.

pub fn write_i64(&mut self, v: i64)

Write an i64 little-endian.

pub fn write_u64(&mut self, v: u64)

Write a u64 little-endian. Also the encoding of handles.

pub fn write_f32(&mut self, v: f32)

Write an f32 as its IEEE 754 bits, little-endian.

pub fn write_f64(&mut self, v: f64)

Write an f64 as its IEEE 754 bits, little-endian.

pub fn write_len(&mut self, len: usize)

Write a length or element count as a u32.

Panics

Panics when len exceeds u32::MAX; truncating would corrupt the stream, and a value that large cannot round-trip through the format.

pub fn write_string(&mut self, v: &str)

Write a string as a u32 byte length followed by its UTF-8 bytes. Interior NUL bytes round-trip unchanged (the format is not NUL-terminated).

pub fn write_bytes(&mut self, v: &[u8])

Write a byte buffer as a u32 length followed by the raw bytes.

pub fn write_option_flag(&mut self, present: bool)

Write an optional’s presence flag: 0 for absent, 1 for present. When present, the caller writes the inner value next.

Trait Implementations

impl Debug for BufferWriter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BufferWriter

fn default() -> BufferWriter

Returns the “default value” for a type.