Enum b3_rs::ItemValue

pub enum ItemValue {
    Null,
    CompositeList(Vec<Item>),
    CompositeDict(Vec<Item>),
    Bytes(Vec<u8>),
    UTF8(String),
    Boolean(bool),
    Int64(i64),
    UVarInt(u64),
    SVarInt(i64),
    Float64(f64),
    Stamp64(i64),
    UnknownType(u64, Vec<u8>),
}

The value of an item.

Variants

Null

A null value.

CompositeList(Vec<Item>)

A list containing multiple Items.

CompositeDict(Vec<Item>)

A list containing multiple Items, where the presence of an ItemKey on the objects contained within is guaranteed.

Bytes(Vec<u8>)

A byte array.

UTF8(String)

A UTF-8 string.

Boolean(bool)

A boolean.

Int64(i64)

A signed 64-bit integer.

UVarInt(u64)

An unsigned variable-length integer, represented as a u64.

SVarInt(i64)

A signed variable-length integer, represented as an i64.

Float64(f64)

A 64-bit floating point number.

Stamp64(i64)

A signed UNIX timestamp, represented as an i64.

UnknownType(u64, Vec<u8>)

Arbitrary data of an unknown type.

This type's first value is the type number sent on the wire, and the second value is a byte array of the raw data sent in the message.

Implementations

impl ItemValue

pub fn data_type(&self) -> DataType

Returns the DataType of this value.

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

Encodes this value into it's byte representation.

If encoding was successful, returns the data type of the encoded value, and a Vec<u8> of the bytes representing the value.

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

Decode the given data using the type and data length from the given ItemHeader.

If decoding succeeds, returns the decoded ItemValue, and the number of bytes consumed by this decode operation.

pub fn get_entries(&self) -> Option<Vec<Item>>

Return the entries contained in this ItemValue, if this value is a CompositeList or a CompositeDict.

pub fn get_bytes(&self) -> Option<Vec<u8>>

Get the bytes conatined in this ItemValue, if this value is a Bytes.

pub fn get_utf8(&self) -> Option<String>

Get the UTF-8 string contained in this ItemValue, if this value is a UTF8.

pub fn get_bool(&self) -> Option<bool>

Get the boolean contained in this ItemValue, if this value is a Boolean.

pub fn get_i64(&self) -> Option<i64>

Get the i64 contained in this ItemValue, if this value is a Int64, a SVarInt, or a Stamp64.

pub fn get_u64(&self) -> Option<u64>

Get the u64 contained in this ItemValue, if this value is a UVarInt.

pub fn get_f64(&self) -> Option<f64>

Get the f64 contained in this ItemValue, if this value is a Float64.

Trait Implementations

impl Clone for ItemValue

fn clone(&self) -> ItemValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemValue

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

Formats the value using the given formatter.

impl PartialEq<ItemValue> for ItemValue

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

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

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

This method tests for !=.

impl StructuralPartialEq for ItemValue