Skip to main content

WireWriter

Struct WireWriter 

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

Build a typed binary blob with magic + version + sections.

Consumers create one writer, push sections in their declared order, then call into_bytes. Section order is the consumer’s contract; the envelope itself only enforces the framing.

Implementations§

Source§

impl WireWriter

Source

pub fn new(magic: &[u8; 4], version: u32) -> WireWriter

Start a writer with the given magic + version header. The header is emitted immediately so consumers can read offsets predictably.

Source

pub fn write_section(&mut self, bytes: &[u8]) -> Result<(), EnvelopeError>

Append a length-prefixed byte section. The length is encoded as a little-endian u32 (bound: 4 GiB per section).

§Errors

Returns EnvelopeError::SectionTooLarge when the byte count cannot fit in the envelope’s u32 length prefix.

Source

pub fn write_words(&mut self, words: &[u32]) -> Result<(), EnvelopeError>

Append a length-prefixed u32 word array. Each word is encoded little-endian; the prefix counts WORDS, not bytes.

§Errors

Returns EnvelopeError::SectionTooLarge when the word count cannot fit in the envelope’s u32 length prefix.

Source

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

Append a single little-endian u32. Useful for fixed-width header fields (state counts, capability flags, etc.) that don’t need a length prefix.

Source

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

Consume the writer and return the underlying bytes.

Trait Implementations§

Source§

impl Debug for WireWriter

Source§

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

Formats the value using the given formatter. 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more