Struct KeyValue 

pub struct KeyValue {
    pub id: Uuid,
    pub fields: HashMap<String, KeyValueField>,
}

A collection of named KeyValueFields identified by a UUID.

Construction

Use the provided From implementations. Supported conversions:

• Vec<KeyValueField> -> KeyValue
• [KeyValueField; N] (array) -> KeyValue
• KeyValueSet -> KeyValue
• (Uuid, Vec<KeyValueField>), (Uuid, [KeyValueField; N]), (Uuid, KeyValueSet) and (Uuid, HashMap<String, KeyValueField>) -> KeyValue with explicit id
• Any KeyValue -> Value via into()

use arora_types::keyvalue::{KeyValue, KeyValueField, KeyValueItems};
use arora_types::value::Value;
use arora_types::gen_bb_uuid;

// From a Vec
let kv: KeyValue = vec![
  KeyValueField::new("health", Value::I32(100)),
  KeyValueField::new("mana", Value::I32(50)),
].into();

// From an array
let position: KeyValue = [
  KeyValueField::new("x", Value::F32(1.0)),
  KeyValueField::new("y", Value::F32(2.0)),
].into();

// Explicit id with a Vec
let id = gen_bb_uuid();
let kv_with_id: KeyValue = (id, vec![
  KeyValueField::new("level", Value::I32(5)),
  KeyValueField::new("xp", Value::I64(9000)),
]).into();

// Nested structure via helper
let stats_set = KeyValueItems::from(vec![
  KeyValueField::new("strength", Value::I32(50)),
  KeyValueField::new("agility", Value::I32(75)),
]);
let player: KeyValue = vec![
  KeyValueField::new("health", Value::I32(100)),
  KeyValueField::new_nested_kv("stats", &stats_set),
].into();

// Convert to Value only when needed
let value: Value = player.clone().into();
assert!(matches!(value, Value::KeyValue(_)));

Fields

id: Uuid

fields: HashMap<String, KeyValueField>

Implementations

impl KeyValue

pub fn new() -> Self

pub fn new_with_id(id: Uuid) -> Self

pub fn set_field(&mut self, field: KeyValueField)

pub fn set_field_value(&mut self, key: &str, value: Value)

pub fn get_fields(&self) -> &HashMap<String, KeyValueField>

pub fn get_field_keys(&self) -> Vec<String>

pub fn get_field(&self, key: &str) -> Option<&KeyValueField>

pub fn as_value(self) -> Value

Trait Implementations

impl Clone for KeyValue

fn clone(&self) -> KeyValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyValue

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

Formats the value using the given formatter.

impl Default for KeyValue

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KeyValue

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

Formats the value using the given formatter.

impl From<&[KeyValueField]> for KeyValue

fn from(fields: &[KeyValueField]) -> Self

Converts to this type from the input type.

impl From<(Uuid, &[KeyValueField])> for KeyValue

fn from((id, fields): (Uuid, &[KeyValueField])) -> Self

Converts to this type from the input type.

impl From<(Uuid, HashMap<String, KeyValueField>)> for KeyValue

fn from((id, map): (Uuid, HashMap<String, KeyValueField>)) -> Self

Converts to this type from the input type.

impl From<(Uuid, KeyValueItems)> for KeyValue

fn from((id, set): (Uuid, KeyValueItems)) -> Self

Converts to this type from the input type.

impl From<(Uuid, Vec<KeyValueField>)> for KeyValue

fn from((id, fields): (Uuid, Vec<KeyValueField>)) -> Self

Converts to this type from the input type.

impl<const N: usize> From<(Uuid, [KeyValueField; N])> for KeyValue

fn from((id, arr): (Uuid, [KeyValueField; N])) -> Self

Converts to this type from the input type.

impl From<HashMap<String, KeyValueField>> for KeyValue

fn from(map: HashMap<String, KeyValueField>) -> Self

Converts to this type from the input type.

impl From<KeyValue> for Value

fn from(kv: KeyValue) -> Self

Converts to this type from the input type.

impl From<KeyValueItems> for KeyValue

fn from(set: KeyValueItems) -> Self

Converts to this type from the input type.

impl From<Vec<KeyValueField>> for KeyValue

fn from(fields: Vec<KeyValueField>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[KeyValueField; N]> for KeyValue

fn from(arr: [KeyValueField; N]) -> Self

Converts to this type from the input type.

impl PartialEq for KeyValue

fn eq(&self, other: &KeyValue) -> 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 Serialize for KeyValue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyValue