Struct b3_rs::Item

pub struct Item {
    pub key: ItemKey,
    pub value: ItemValue,
}

A singular item.

Fields

key: ItemKey

value: ItemValue

Implementations

impl Item

pub fn new(key: ItemKey, value: ItemValue) -> Self

Create a new item with the given key and value.

pub fn with_key(self, key: ItemKey) -> Self

Add a key to the item, returning the item. Useful for chaining.

let item = Item::from("value").with_key(ItemKey::from("key"));

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

Encode this item into it's byte representation.

Internally this calls the encode() method on the ItemValue, constructs an ItemHeader based on the output from that, encodes that header, and stitches the two together.

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

Decodes an item from the given byte input.

If the item is a container type (CompositeList or CompositeDict), the item is decoded recursively.

If decoding was successful, returns the item, and the number of bytes consumed by this decode operation.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl<'_> From<&'_ [u8]> for Item

fn from(v: &[u8]) -> Item

Performs the conversion.

impl<'_> From<&'_ str> for Item

fn from(s: &str) -> Item

Performs the conversion.

impl From<String> for Item

fn from(s: String) -> Item

Performs the conversion.

impl From<Vec<u8>> for Item

fn from(v: Vec<u8>) -> Item

Performs the conversion.

impl From<bool> for Item

fn from(b: bool) -> Item

Performs the conversion.

impl From<f64> for Item

fn from(i: f64) -> Item

Performs the conversion.

impl From<i32> for Item

fn from(i: i32) -> Item

Performs the conversion.

impl From<i64> for Item

fn from(i: i64) -> Item

Performs the conversion.

impl From<u32> for Item

fn from(i: u32) -> Item

Performs the conversion.

impl From<u64> for Item

fn from(i: u64) -> Item

Performs the conversion.

impl PartialEq<Item> for Item

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

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

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

This method tests for !=.

impl StructuralPartialEq for Item