Struct tikv_util::buffer_vec::BufferVec

pub struct BufferVec {
    data: Vec<u8>,
    offsets: Vec<usize>,
}

A vector like container storing multiple buffers. Each buffer is a [u8] slice in arbitrary length.

Fields

data: Vec<u8>

offsets: Vec<usize>

Implementations

impl BufferVec

pub fn new() -> Self

Constructs a new, empty BufferVec.

The BufferVec will not allocate until buffers are pushed onto it.

pub fn with_capacity(elements_capacity: usize, data_capacity: usize) -> Self

Constructs a new, empty BufferVec with the specified element capacity and data capacity.

pub fn capacity(&self) -> usize

Returns the number of buffers this BufferVec can hold without reallocating the offsets array.

pub fn data_capacity(&self) -> usize

Returns the number of buffers this BufferVec can hold without reallocating the data array.

pub fn len(&self) -> usize

Returns the number of contained buffers.

pub fn is_empty(&self) -> bool

Returns true if there is no contained buffer.

pub fn total_len(&self) -> usize

Returns the total length of all contained buffers.

pub fn push(&mut self, buffer: impl AsRef<[u8]>)

Appends a buffer to the back.

pub fn concat_extend<T, I>(&mut self, buffer_parts: I) where
    T: AsRef<[u8]>,
    I: IntoIterator<Item = T>, 

Appends multiple buffer parts together as one buffer to the back.

pub fn begin_concat_extend(&mut self) -> WithConcatExtend<'_>

Returns a delegator that provides extend appends buffers together as one buffer to the back.

Note that this function always creates a new buffer even if you don’t call extend on the delegator later, which simply results in appending a new empty buffer.

pub fn pop(&mut self) -> Option<Vec<u8>>

Removes the last buffer if there is any.

pub fn last(&self) -> Option<&[u8]>

Get the last buffer if there is any.

pub fn shift(&mut self, n: usize)

Removes the first n buffers.

If n >= current length, all buffers will be removed.

pub fn truncate(&mut self, n: usize)

Shortens the BufferVec, keeping the first n buffers and dropping the rest.

If n >= current length, this has no effect.

pub fn clear(&mut self)

Removes all buffers.

pub fn copy_from(&mut self, other: &BufferVec)

Copies all buffers from other to self.

pub fn copy_n_from(&mut self, other: &BufferVec, n: usize)

Copies first n buffers from other to self.

If n > other.len(), only other.len() buffers will be copied.

pub fn retain_by_array(&mut self, retain_arr: &[bool])

Retains the elements according to a boolean array.

Panics

Panics if retain_arr is not long enough.

pub fn iter(&self) -> Iter<'_>

Returns an iterator over the BufferVec.

Trait Implementations

impl Clone for BufferVec

fn clone(&self) -> BufferVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BufferVec

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

Formats the value using the given formatter.

impl Default for BufferVec

fn default() -> BufferVec

Returns the “default value” for a type.

impl<'a> Extend<&'a u8> for BufferVec

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a u8>, 

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u8> for BufferVec

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = u8>, 

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Index<usize> for BufferVec

type Output = [u8]

The returned type after indexing.

fn index(&self, index: usize) -> &[u8]

Performs the indexing (container[index]) operation.