Struct FoyerValue 

pub struct FoyerValue(pub Buffer);

Available on crate feature layers-foyer only.

FoyerValue is a wrapper around Buffer that implements the Code trait.

Tuple Fields

0: Buffer

Methods from Deref<Target = Buffer>

pub fn len(&self) -> usize

Get the length of the buffer.

pub fn is_empty(&self) -> bool

Check if buffer is empty.

pub fn count(&self) -> usize

Number of [Bytes] in Buffer.

For contiguous buffer, it’s always 1. For non-contiguous buffer, it’s number of bytes available for use.

pub fn current(&self) -> Bytes

Get current [Bytes].

pub fn slice(&self, range: impl RangeBounds<usize>) -> Buffer

Returns a slice of self for the provided range.

This will increment the reference count for the underlying memory and return a new Buffer handle set to the slice.

This operation is O(1).

pub fn to_bytes(&self) -> Bytes

Combine all bytes together into one single [Bytes].

This operation is zero copy if the underlying bytes are contiguous. Otherwise, it will copy all bytes into one single [Bytes]. Please use API from [Buf], Iterator or [Stream] whenever possible.

pub fn to_vec(&self) -> Vec<u8>

Combine all bytes together into one single Vec<u8>.

This operation is not zero copy, it will copy all bytes into one single Vec<u8>. Please use API from [Buf], Iterator or [Stream] whenever possible.

pub fn to_io_slice(&self) -> Vec<IoSlice<'_>>

Convert buffer into a slice of IoSlice for vectored write.

pub fn chunks(&self, chunk_size: usize) -> BufferChunks

Split the buffer into an iterator of chunks, each with at most chunk_size bytes.

The chunks share the same underlying storage with the original buffer. The last chunk will be shorter if self.len() is not a multiple of chunk_size.

Panics

Panics if chunk_size is zero.

Trait Implementations

impl Code for FoyerValue

fn encode(&self, writer: &mut impl Write) -> Result<(), CodeError>

Encode the object into a writer.

fn decode(reader: &mut impl Read) -> Result<FoyerValue, CodeError>

where FoyerValue: Sized,

Decode the object from a reader.

fn estimated_size(&self) -> usize

Estimated serialized size of the object.

impl Debug for FoyerValue

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

Formats the value using the given formatter.

impl Deref for FoyerValue

type Target = Buffer

The resulting type after dereferencing.

fn deref(&self) -> &<FoyerValue as Deref>::Target

Dereferences the value.