Struct QueueBuf

pub struct QueueBuf(/* private fields */);

QueueBuf is a queue of Buffer.

It’s designed to allow storing multiple buffers without copying underlying bytes and consume them in order.

QueueBuf mainly provides the following operations:

• push: Push a new buffer in the queue.
• collect: Collect all buffer in the queue as a new Buffer
• advance: Advance the queue by cnt bytes.

Implementations

impl QueueBuf

pub fn new() -> Self

Create a new buffer queue.

pub fn push(&mut self, buf: Buffer)

Push new Buffer into the queue.

pub fn len(&self) -> usize

Total bytes size inside the buffer queue.

pub fn is_empty(&self) -> bool

Is the buffer queue empty.

pub fn take(&mut self) -> QueueBuf

Take the entire buffer queue and leave self in empty states.

pub fn collect(self) -> Buffer

Build a new Buffer from the queue.

If the queue is empty, it will return an empty buffer. Otherwise, it will iterate over all buffers and collect them into a new buffer.

Notes

There are allocation overheads when collecting multiple buffers into a new buffer. But most of them should be acceptable since we can expect the item length of buffers are slower than 4k.

pub fn advance(&mut self, cnt: usize)

Advance the buffer queue by cnt bytes.

pub fn clear(&mut self)

Clear the buffer queue.

Trait Implementations

impl Clone for QueueBuf

fn clone(&self) -> QueueBuf

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for QueueBuf

fn default() -> QueueBuf

Returns the “default value” for a type.