Struct Value

pub struct Value {
    pub kind: Option<Kind>,
}

Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of those variants, absence of any variant indicates an error.

The JSON representation for Value is a JSON value.

Fields

kind: Option<Kind>

The kind of value.

Implementations

impl Value

pub fn is_null(&self) -> bool

check if this value is a NullValue

pub fn is_bool(&self) -> bool

check if this value is a BoolValue

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

extract the contents if this value is a BoolValue

pub fn is_integer(&self) -> bool

check if this value is a IntegerValue

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

extract the contents if this value is a IntegerValue

pub fn is_double(&self) -> bool

check if this value is a DoubleValue

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

extract the contents if this value is a DoubleValue

pub fn is_str(&self) -> bool

check if this value is a StringValue

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

extract the contents if this value is a StringValue

pub fn is_list(&self) -> bool

check if this value is a ListValue

pub fn as_list(&self) -> Option<&[Value]>

extract the contents if this value is a ListValue

pub fn is_struct(&self) -> bool

check if this value is a StructValue

pub fn as_struct(&self) -> Option<&Struct>

extract the contents if this value is a StructValue

pub fn into_json(self) -> Value

convert this into a serde_json::Value

Examples:

use serde_json::json;
use arc_vector_rust::prelude::*;
use arc_vector_rust::arc_vector::{value::Kind::*, Struct};
let value = Value { kind: Some(StructValue(Struct {
    fields: [
        ("text".into(), Value { kind: Some(StringValue("Hi ArcVector!".into())) }),
        ("int".into(), Value { kind: Some(IntegerValue(42))}),
    ].into()
}))};
assert_eq!(value.into_json(), json!({
   "text": "Hi ArcVector!",
   "int": 42
}));

impl Value

pub fn iter_list(&self) -> Result<impl Iterator<Item = &Value>, NotA<ListValue>>

try to get an iterator over the items of the contained list value, if any

pub fn get_struct(&self, key: &str) -> Result<&Value, NotA<Struct>>

try to get a field from the struct if this value contains one

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Value

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl From<&str> for Value

fn from(val: &str) -> Self

Converts to this type from the input type.

impl From<Payload> for Value

fn from(val: Payload) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(val: String) -> Self

Converts to this type from the input type.

impl From<Value> for Value

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Value> for Value

fn from(value: Value) -> Self

Converts to this type from the input type.

impl<T> From<Vec<(&str, T)>> for Value

where T: Into<Value>,

fn from(val: Vec<(&str, T)>) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for Value

where T: Into<Value>,

fn from(val: Vec<T>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(val: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(val: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(val: i64) -> Self

Converts to this type from the input type.

impl Message for Value

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Value

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Value> for String

type Error = NotA<String>

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, NotA<String>>

Performs the conversion.

impl TryFrom<Value> for bool

type Error = NotA<bool>

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, NotA<bool>>

Performs the conversion.

impl TryFrom<Value> for f64

type Error = NotA<f64>

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, NotA<f64>>

Performs the conversion.

impl TryFrom<Value> for i64

type Error = NotA<i64>

The type returned in the event of a conversion error.

fn try_from(v: Value) -> Result<Self, NotA<i64>>

Performs the conversion.

impl StructuralPartialEq for Value