Skip to main content

FrameWriter

Struct FrameWriter 

Source
pub struct FrameWriter { /* private fields */ }
Expand description

Writes length-prefixed frames to a byte stream.

Each frame is: [LEB128 length][payload bytes] This enables streaming — you can send frames one at a time over a TCP connection, WebSocket, etc.

§Example

use vexil_runtime::{BitWriter, FrameWriter};

let mut fw = FrameWriter::new();

// Encode first message
let mut w = BitWriter::new();
w.write_u32(42);
let bytes = w.finish();
fw.write_frame(&bytes);

// Encode second message
let mut w = BitWriter::new();
w.write_string("hello");
let bytes = w.finish();
fw.write_frame(&bytes);

let stream = fw.finish();
// stream = [1, 42, 0, 0, 0, 6, h, e, l, l, o]
//           ^len=1  ^payload    ^len=6  ^payload

Implementations§

Source§

impl FrameWriter

Source

pub fn new() -> Self

Create a new empty frame writer.

Source

pub fn write_frame(&mut self, payload: &[u8])

Write a single frame. The payload is typically the output of BitWriter::finish().

Source

pub fn as_bytes(&self) -> &[u8]

Get a reference to the accumulated bytes without consuming.

Source

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

Finish and return the complete byte stream.

Source

pub fn reset(&mut self)

Reset for reuse, keeping the allocation.

Trait Implementations§

Source§

impl Default for FrameWriter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.