Struct ValueBuilder

pub struct ValueBuilder<F> {
    pub size: usize,
    pub f: F,
}

A value builder for the wal, which requires the value size for accurate allocation and a closure to build the value.

Fields

size: usize

The required size of the builder.

f: F

The builder closure.

Implementations

impl<F> ValueBuilder<F>

pub const fn new(size: usize, f: F) -> Self

Creates a new ValueBuilder with the given size and builder closure.

pub const fn size(&self) -> usize

Returns the required ValueBuilder size.

pub const fn builder(&self) -> &F

Returns the ValueBuilder builder closure.

pub fn into_components(self) -> (usize, F)

Deconstructs the value builder into the size and the builder closure.

impl<F> ValueBuilder<F>

pub const fn once<E>(size: usize, f: F) -> Self

where F: for<'a> FnOnce(&mut VacantBuffer<'a>) -> Result<usize, E>,

Creates a new ValueBuilder with the given size and builder closure which requires FnOnce.

Trait Implementations

impl<W, E> BufWriter for ValueBuilder<W>

where W: Fn(&mut VacantBuffer<'_>) -> Result<usize, E>,

type Error = E

The error type.

fn encoded_len(&self) -> usize

The length of the encoded bytes.

fn write(&self, buf: &mut VacantBuffer<'_>) -> Result<usize, Self::Error>

Encode self to bytes and write to the VacantBuffer.

impl<W, E> BufWriterOnce for ValueBuilder<W>

where W: FnOnce(&mut VacantBuffer<'_>) -> Result<usize, E>,

type Error = E

The error type.

fn encoded_len(&self) -> usize

The length of the encoded bytes.

fn write_once(self, buf: &mut VacantBuffer<'_>) -> Result<usize, Self::Error>

Encode self to bytes and write to the VacantBuffer.

impl<F: Clone> Clone for ValueBuilder<F>

fn clone(&self) -> ValueBuilder<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for ValueBuilder<F>

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

Formats the value using the given formatter.

impl<F> From<(usize, F)> for ValueBuilder<F>

fn from((size, f): (usize, F)) -> Self

Converts to this type from the input type.

impl<F> From<ValueBuilder<F>> for (usize, F)

fn from(builder: ValueBuilder<F>) -> Self

Converts to this type from the input type.

impl<F: Copy> Copy for ValueBuilder<F>