Enum kiwi_schema::Value

pub enum Value<'a> {
    Bool(bool),
    Byte(u8),
    Int(i32),
    UInt(u32),
    Float(f32),
    String(String),
    Array(Vec<Value<'a>>),
    Enum(&'a str, &'a str),
    Object(&'a str, HashMap<&'a str, Value<'a>>),
}

This type holds dynamic Kiwi data.

Values can represent anything in a Kiwi schema and can be converted to and from byte arrays using the corresponding Schema. Enums and field names are stored using string slices from their Schema for efficiency. This means that a Value can outlive the buffer it was parsed from but can't outlive the schema.

Variants

Bool(bool)

Byte(u8)

Int(i32)

UInt(u32)

Float(f32)

String(String)

Array(Vec<Value<'a>>)

Enum(&'a str, &'a str)

Object(&'a str, HashMap<&'a str, Value<'a>>)

Implementations

impl<'a> Value<'a>

pub fn as_bool(&self) -> bool

A convenience method to extract the value out of a Bool. Returns false for other value kinds.

pub fn as_byte(&self) -> u8

A convenience method to extract the value out of a Byte. Returns 0 for other value kinds.

pub fn as_int(&self) -> i32

A convenience method to extract the value out of an Int. Returns 0 for other value kinds.

pub fn as_uint(&self) -> u32

A convenience method to extract the value out of a UInt. Returns 0 for other value kinds.

pub fn as_float(&self) -> f32

A convenience method to extract the value out of a Float. Returns 0.0 for other value kinds.

pub fn as_string(&self) -> &str

A convenience method to extract the value out of a String. Returns "" for other value kinds.

pub fn len(&self) -> usize

A convenience method to extract the length out of an Array. Returns 0 for other value kinds.

pub fn push(&mut self, value: Value<'a>)

A convenience method to append to an Array. Does nothing for other value kinds.

pub fn get(&self, name: &str) -> Option<&Value<'a>>

A convenience method to extract a field out of an Object. Returns None for other value kinds or if the field isn't present.

pub fn set(&mut self, name: &'a str, value: Value<'a>)

A convenience method to update a field on an Object. Does nothing for other value kinds.

pub fn remove(&mut self, name: &'a str)

A convenience method to remove a field on an Object. Does nothing for other value kinds.

pub fn decode(
    schema: &'a Schema,
    type_id: i32,
    bytes: &[u8]
) -> Result<Value<'a>, ()>

Decodes the type specified by type_id and schema from bytes.

pub fn encode(&self, schema: &Schema) -> Vec<u8>

Encodes this value into an array of bytes using the provided schema.

pub fn decode_bb(
    schema: &'a Schema,
    type_id: i32,
    bb: &mut ByteBuffer
) -> Result<Value<'a>, ()>

Decodes the type specified by type_id and schema from bb starting at the current index. After this function returns, the current index will be advanced by the amount of data that was successfully parsed. This is mainly useful as a helper routine for decode, which you probably want to use instead.

pub fn decode_field_bb(
    schema: &'a Schema,
    field: &Field,
    bb: &mut ByteBuffer
) -> Result<Value<'a>, ()>

Decodes the field specified by field and schema from bb starting at the current index. This is used by decode_bb but may also be useful by itself.

pub fn encode_bb(&self, schema: &Schema, bb: &mut ByteBufferMut)

Encodes the current value to the end of bb using the provided schema. This is mainly useful as a helper routine for encode, which you probably want to use instead.

Trait Implementations

impl<'a> Clone for Value<'a>

fn clone(&self) -> Value<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Value<'a>

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

Formats the value using the given formatter.

impl<'a> Index<usize> for Value<'a>

type Output = Value<'a>

The returned type after indexing.

fn index(&self, index: usize) -> &Value<'a>

A convenience method that adds support for self[index] expressions. It will panic if this value isn't an Array or if the provided index is out of bounds.

impl<'a> PartialEq<Value<'a>> for Value<'a>

fn eq(&self, other: &Value<'a>) -> bool

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

fn ne(&self, other: &Value<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Value<'a>