Enum Value

pub enum Value<'ctx> {
    Null,
    Bool(bool),
    Number(Number),
    Str(Cow<'ctx, str>),
    Array(Vec<Value<'ctx>>),
    Object(ObjectAsVec<'ctx>),
}

Represents any valid JSON value.

Example

use std::io;
use serde_json_borrow::Value;
fn main() -> io::Result<()> {
    let data = r#"{"bool": true, "key": "123"}"#;
    let value: Value = serde_json::from_str(&data)?;
    assert_eq!(value.get("bool"), &Value::Bool(true));
    assert_eq!(value.get("key"), &Value::Str("123".into()));
    Ok(())
}

Variants

Null

Represents a JSON null value.

let v = Value::Null;

Bool(bool)

Represents a JSON boolean.

let v = Value::Bool(true);

Number(Number)

Represents a JSON number, whether integer or floating point.

let v = Value::Number(12.5.into());

Str(Cow<'ctx, str>)

Represents a JSON string.

let v = Value::Str("ref".into());

Array(Vec<Value<'ctx>>)

Represents a JSON array.

Object(ObjectAsVec<'ctx>)

Represents a JSON object.

By default the map is backed by a Vec. Allows very fast deserialization. Ideal when wanting to iterate over the values, in contrast to look up by key.

let v = Value::Object([("key".into(), Value::Str("value".into()))].into_iter().collect::<Vec<_>>().into());

Implementations

impl<'ctx> Value<'ctx>

pub fn get<I: Index<'ctx>>(&'ctx self, index: I) -> &'ctx Value<'ctx>

Index into a serde_json_borrow::Value using the syntax value.get(0) or value.get("k").

Returns Value::Null if the type of self does not match the type of the index, for example if the index is a string and self is an array or a number. Also returns Value::Null if the given key does not exist in the map or the given index is not within the bounds of the array.

Examples

let json_obj = r#"
{
    "x": {
        "y": ["z", "zz"]
    }
}
"#;

let data: Value = serde_json::from_str(json_obj).unwrap();

assert_eq!(data.get("x").get("y").get(0), &Value::Str("z".into()));
assert_eq!(data.get("x").get("y").get(1), &Value::Str("zz".into()));
assert_eq!(data.get("x").get("y").get(2), &Value::Null);

assert_eq!(data.get("a"), &Value::Null);
assert_eq!(data.get("a").get("b"), &Value::Null);

pub fn is_null(&self) -> bool

Returns true if Value is Value::Null.

pub fn is_array(&self) -> bool

Returns true if Value is Value::Array.

pub fn is_object(&self) -> bool

Returns true if Value is Value::Object.

pub fn is_bool(&self) -> bool

Returns true if Value is Value::Bool.

pub fn is_number(&self) -> bool

Returns true if Value is Value::Number.

pub fn is_string(&self) -> bool

Returns true if Value is Value::Str.

pub fn is_i64(&self) -> bool

Returns true if the Value is an integer between i64::MIN and i64::MAX. For any Value on which is_i64 returns true, as_i64 is guaranteed to return the integer value.

pub fn is_u64(&self) -> bool

Returns true if the Value is an integer between zero and u64::MAX. For any Value on which is_u64 returns true, as_u64 is guaranteed to return the integer value.

pub fn is_f64(&self) -> bool

Returns true if the Value is a f64 number.

pub fn iter_array(&self) -> Option<impl Iterator<Item = &Value<'_>>>

If the Value is an Array, returns an iterator over the elements in the array.

pub fn iter_object(&self) -> Option<impl Iterator<Item = (&str, &Value<'_>)>>

If the Value is an Object, returns an iterator over the elements in the object.

pub fn as_array(&self) -> Option<&[Value<'ctx>]>

If the Value is an Array, returns the associated Array. Returns None otherwise.

pub fn as_object(&self) -> Option<&ObjectAsVec<'ctx>>

If the Value is an Object, returns the associated Object. Returns None otherwise.

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

If the Value is a Boolean, returns the associated bool. Returns None otherwise.

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

If the Value is a String, returns the associated str. Returns None otherwise.

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

If the Value is an integer, represent it as i64 if possible. Returns None otherwise.

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

If the Value is an integer, represent it as u64 if possible. Returns None otherwise.

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

If the Value is a number, represent it as f64 if possible. Returns None otherwise.

Trait Implementations

impl<'ctx> Clone for Value<'ctx>

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

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, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'ctx> Default for Value<'ctx>

fn default() -> Value<'ctx>

Returns the “default value” for a type.

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

fn deserialize<D>(deserializer: D) -> Result<Value<'de>, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for &'de Value<'_>

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_newtype_struct<V>( self, _name: &'static str, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_tuple<V>( self, _len: usize, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V>( self, _name: &'static str, _len: usize, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_enum<V>( self, _name: &'static str, _variants: &'static [&'static str], _visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn deserialize_unit_struct<V>( self, _name: &'static str, visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_struct<V>( self, _name: &'static str, _fields: &'static [&'static str], visitor: V, ) -> Result<V::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_i128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl Display for Value<'_>

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

Formats the value using the given formatter.

impl<'a, T: Clone + Into<Value<'a>>> From<&[T]> for Value<'a>

fn from(val: &[T]) -> Self

Converts to this type from the input type.

impl From<&Value<'_>> for Value

fn from(val: &Value<'_>) -> Self

Converts to this type from the input type.

impl<'ctx> From<&'ctx Value> for Value<'ctx>

fn from(value: &'ctx Value) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Value<'a>

fn from(val: &'a str) -> 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(val: Value<'_>) -> Self

Converts to this type from the input type.

impl<'a, T: Into<Value<'a>>> From<Vec<T>> for Value<'a>

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 From<u64> for Value<'_>

fn from(val: u64) -> Self

Converts to this type from the input type.

impl<'ctx> Hash for Value<'ctx>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'de> IntoDeserializer<'de> for &'de Value<'_>

type Deserializer = &'de Value<'_>

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<'ctx> PartialEq for Value<'ctx>

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

impl<'ctx> StructuralPartialEq for Value<'ctx>