Struct FlexBuf

pub struct FlexBuf { /* private fields */ }

FlexBuf is a buffer that support frozen bytes and reuse existing allocated memory.

It’s useful when we want to freeze the buffer and reuse the memory for the next buffer.

Implementations

impl FlexBuf

pub fn new(cap: usize) -> Self

Initializes a new FlexBuf with the given capacity.

pub fn put(&mut self, bs: &[u8]) -> usize

Put slice into flex buf.

Return 0 means the buffer is frozen.

pub fn freeze(&mut self)

Freeze the buffer no matter it’s full or not.

It’s a no-op if the buffer has already been frozen.

pub fn get(&mut self) -> Option<Bytes>

Get the frozen buffer.

Return None if the buffer is not frozen.

Notes

This operation did nothing to the buffer. We use &mut self just for make the API consistent with other APIs.

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

Panics

Panic if the buffer is not frozen.

pub fn clean(&mut self)

Cleanup the buffer, reset to the initial state.