Struct VarDataHeader 

#[repr(C, packed(1))]
pub struct VarDataHeader {
    pub length: u16,
}

Variable-length data header.

The var data header precedes variable-length data fields and contains the length of the data that follows.

Wire Format

+0: length (u16, 2 bytes) - for standard varDataEncoding

Note: Some schemas may use u8 or u32 for the length field.

Fields

length: u16

Length of the variable data in bytes.

Implementations

impl VarDataHeader

pub const ENCODED_LENGTH: usize = 2

Encoded length of the var data header in bytes (u16 length).

pub const fn new(length: u16) -> Self

Creates a new var data header with the specified length.

Arguments

• length - Length of the variable data in bytes

pub fn wrap<B: ReadBuffer + ?Sized>(buffer: &B, offset: usize) -> Self

Wraps a buffer and decodes the var data header at the given offset.

Arguments

• buffer - Buffer to read from
• offset - Byte offset to start reading

Panics

Panics if the buffer is too short.

pub fn encode<B: WriteBuffer + ?Sized>(&self, buffer: &mut B, offset: usize)

Encodes the var data header to the buffer at the given offset.

Arguments

• buffer - Buffer to write to
• offset - Byte offset to start writing

pub const fn total_size(&self) -> usize

Returns the total size (header + data).

pub const fn is_empty(&self) -> bool

Returns true if the data is empty.

Trait Implementations

impl Clone for VarDataHeader

fn clone(&self) -> VarDataHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VarDataHeader

impl Debug for VarDataHeader

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

Formats the value using the given formatter.

impl Default for VarDataHeader

fn default() -> VarDataHeader

Returns the “default value” for a type.

impl Eq for VarDataHeader

impl PartialEq for VarDataHeader

fn eq(&self, other: &VarDataHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VarDataHeader