Struct Buffer 

pub struct Buffer { /* private fields */ }

Reusable reverse-growing word buffer used by ProtoCache encoders.

Encoders prepend data, so existing segment positions remain stable as the allocation grows. Call Self::clear to reuse allocated capacity.

Implementations

impl Buffer

pub fn new() -> Self

Creates an empty buffer without an allocation.

Examples found in repository

examples/basic.rs (line 4)

fn main() {
    let mut buffer = Buffer::new();
    let name = serialize_str("Ada", &mut buffer).expect("name is encodable");
    let mut fields = [serialize_scalar(42_i32), name];
    serialize_message(&mut fields, &mut buffer).expect("message is encodable");

    let view = MessageView::new(buffer.view()).expect("valid ProtoCache message");
    let id = view.scalar::<i32>(0).expect("id field");
    let name = view
        .string(1)
        .and_then(|value| value.as_str())
        .expect("UTF-8 name field");

    println!("id={id}, name={name}");
}

pub fn with_capacity_words(words: usize) -> Self

Creates an empty buffer with capacity for at least words words.

pub fn clear(&mut self)

Removes active data while retaining allocated capacity.

pub fn allocated_words(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn view(&self) -> &[u32]

Returns the active encoded words.

Examples found in repository

examples/basic.rs (line 9)

fn main() {
    let mut buffer = Buffer::new();
    let name = serialize_str("Ada", &mut buffer).expect("name is encodable");
    let mut fields = [serialize_scalar(42_i32), name];
    serialize_message(&mut fields, &mut buffer).expect("message is encodable");

    let view = MessageView::new(buffer.view()).expect("valid ProtoCache message");
    let id = view.scalar::<i32>(0).expect("id field");
    let name = view
        .string(1)
        .and_then(|value| value.as_str())
        .expect("UTF-8 name field");

    println!("id={id}, name={name}");
}

pub fn head(&self) -> &[u32]

pub fn head_mut(&mut self) -> &mut [u32]

pub fn at_from_end(&self, words: usize) -> Option<&[u32]>

pub fn at_from_end_mut(&mut self, words: usize) -> Option<&mut [u32]>

pub fn reserve_words(&mut self, words: usize)

pub fn expand(&mut self, delta: usize) -> &mut [u32]

Prepends delta zero-initialized words and returns them for writing.

pub fn shrink(&mut self, delta: usize)

Discards delta words from the front of the active view.

Panics

Panics when delta is greater than Self::len.

pub fn put(&mut self, value: u32)

pub fn put_words(&mut self, words: &[u32])

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Buffer

Returns the “default value” for a type.