Struct timely_container::CapacityContainerBuilder

pub struct CapacityContainerBuilder<C> { /* private fields */ }

A default container builder that uses length and preferred capacity to chunk data.

Maintains a single empty allocation between Self::push_into and Self::extract, but not across Self::finish to maintain a low memory footprint.

Maintains FIFO order.

Implementations

impl<C: Container> CapacityContainerBuilder<C>

pub fn push_container(&mut self, container: &mut C)

Push a pre-formed container at this builder. This exists to maintain API compatibility.

Trait Implementations

impl<C: Container> ContainerBuilder for CapacityContainerBuilder<C>

type Container = C

The container type we’re building.

fn extract(&mut self) -> Option<&mut C>

Extract assembled containers, potentially leaving unfinished data behind. Can be called repeatedly, for example while the caller can send data.

fn finish(&mut self) -> Option<&mut C>

Extract assembled containers and any unfinished data. Should be called repeatedly until it returns None.

impl<C: Debug> Debug for CapacityContainerBuilder<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for CapacityContainerBuilder<C>

fn default() -> CapacityContainerBuilder<C>

Returns the “default value” for a type.

impl<T, C: SizableContainer + PushInto<T>> PushInto<T> for CapacityContainerBuilder<C>

fn push_into(&mut self, item: T)

Push item into self.