Struct PathBuilder

pub struct PathBuilder<const MCL: usize, const MCC: usize, const MPL: usize> { /* private fields */ }

A helper struct for creating a Path with exactly one memory allocation. Requires total length and component count to be known in advance.

Enforces that each component has a length of at most MCL (max_component_length), that each path has at most MCC (max_component_ccount) components, and that the total size in bytes of all components is at most MPL (max_path_length).

Implementations

impl<const MCL: usize, const MCC: usize, const MPL: usize> PathBuilder<MCL, MCC, MPL>

pub fn new( total_length: usize, component_count: usize, ) -> Result<Self, InvalidPathError>

Creates a builder for a path of known total length and component count. The component data must be filled in before building.

pub fn new_from_prefix( target_total_length: usize, target_component_count: usize, reference: &Path<MCL, MCC, MPL>, prefix_component_count: usize, ) -> Result<Self, InvalidPathError>

Creates a builder for a path of known total length and component count, efficiently prefilled with the first prefix_component_count components of a given reference path. Panics if there are not enough components in the reference. The missing component data must be filled in before building.

pub async fn append_component_from_bulk_producer<P>( &mut self, component_length: usize, p: &mut P, ) -> Result<(), DecodeError<P::Final, P::Error, Blame>>

where P: BulkProducer<Item = u8>,

Appends data for a component of known length by reading data from a BulkProducer of bytes. Panics if component_length > MCL.

pub fn append_component(&mut self, component: Component<'_, MCL>)

Appends the data for the next component.

pub fn build(self) -> Path<MCL, MCC, MPL>

Turn this builder into an immutable Path.

Panics if the number of components or the total length does not match what was claimed in PathBuilder::new.