Struct BatchBuffer 

pub struct BatchBuffer { /* private fields */ }

Accumulates encoded bytes and flushes them to a BatchSink in one write.

Append with push_str / push_bytes, or via write! (it implements core::fmt::Write); then flush_to writes the accumulation in a single BatchSink::write_batch and clears for reuse.

Implementations

impl BatchBuffer

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

Preallocate capacity bytes — size it to a batch’s typical total so the accumulation does not grow mid-batch.

pub fn push_str(&mut self, text: &str)

Append a UTF-8 string — the common case (a formatted log/metric line).

pub fn push_bytes(&mut self, bytes: &[u8])

Append raw bytes — for binary wire formats.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn capacity(&self) -> usize

Bytes reserved in the backing allocation (>= the with_capacity request). A batch that stays under this never reallocates mid-accumulation.

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

pub fn clear(&mut self)

Drop the accumulation without flushing (retains the backing allocation).

pub fn flush_to<S: BatchSink>(&mut self, sink: &mut S) -> Result<(), S::Error>

Flush the whole accumulation to sink in ONE BatchSink::write_batch, then clear for reuse. No-op (and no terminal write) when empty.

Trait Implementations

impl Debug for BatchBuffer

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

Formats the value using the given formatter.

impl Default for BatchBuffer

fn default() -> Self

Returns the “default value” for a type.

impl Write for BatchBuffer

fn write_str(&mut self, text: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.