Struct ByteBlockWriter

pub struct ByteBlockWriter { /* private fields */ }

The byte block writer.

All writes (write_type and write) will be buffered in the internal buffer of the ByteBlockWriter using the specified encoding.

To finalize all the writes, invoke finish to obtain the encoded byte block.

Implementations

impl ByteBlockWriter

pub fn new(encoding: AccountBlockFormat) -> Self

Create a ByteBlockWriter from the specified AccountBlockFormat.

pub fn raw_len(&self) -> usize

Return the length of the raw data (i.e. after decoding).

pub fn write_pod<T: NoUninit>(&mut self, value: &T) -> IoResult<usize>

Write plain ol’ data to the internal buffer of the ByteBlockWriter instance

Prefer this over write_type(), as it prevents some undefined behavior.

pub unsafe fn write_type<T>(&mut self, value: &T) -> IoResult<usize>

Write the specified typed instance to the internal buffer of the ByteBlockWriter instance.

Prefer write_pod() when possible, because write_type() may cause undefined behavior if value contains uninitialized bytes.

Safety

Caller must ensure casting T to bytes is safe. Refer to the Safety sections in std::slice::from_raw_parts() and bytemuck’s Pod and NoUninit for more information.

pub fn write_optional_fields( &mut self, opt_fields: &AccountMetaOptionalFields, ) -> IoResult<usize>

Write all the Some fields of the specified AccountMetaOptionalFields.

Note that the existence of each optional field is stored separately in AccountMetaFlags.

pub fn write(&mut self, buf: &[u8]) -> IoResult<()>

Write the specified typed bytes to the internal buffer of the ByteBlockWriter instance.

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

Flush the internal byte buffer that collects all the previous writes into an encoded byte array.

Trait Implementations

impl Debug for ByteBlockWriter

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

Formats the value using the given formatter.