Struct b3_rs::ItemHeader

pub struct ItemHeader {
    pub data_type: DataType,
    pub key: ItemKey,
    pub is_null: bool,
    pub data_len: u64,
}

A representation of an item's header.

Encoding and decoding

use b3_rs::ItemKey;
use b3_rs::datatypes::{DataType, KnownType};

let header = ItemHeader::new(
    DataType::from(KnownType::Bytes), // Create a byte array,
    ItemKey::NoKey,                   // with no key,
    true,                             // that is a null entry, and
    0,                                // has zero length.
);

// Encode the header to a `Vec<u8>`
let bytes = header.encode()?;
assert_eq!(bytes.len(), 1);

// And decode that header back into an object
let (decoded, _len) = ItemHeader::decode(&bytes)?;
assert_eq!(decoded, header);

Fields

data_type: DataType

key: ItemKey

is_null: bool

data_len: u64

Implementations

impl ItemHeader

pub fn new(
    data_type: DataType,
    key: ItemKey,
    is_null: bool,
    data_len: u64
) -> Self

Creates a new ItemHeader.

pub fn encode(&self) -> Result<Vec<u8>, Error>

Encode the header into it's byte representation.

pub fn decode(input: &[u8]) -> Result<(ItemHeader, usize), Error>

Takes a byte representation of an item and decodes it's header, returning the decoded header and the number of bytes consumed by the decode operation.

Trait Implementations

impl Clone for ItemHeader

fn clone(&self) -> ItemHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemHeader

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

Formats the value using the given formatter.

impl Default for ItemHeader

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<ItemHeader> for ItemHeader

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ItemHeader