Enum serde_json::Value [] [src]

pub enum Value {
    Null,
    Bool(bool),
    Number(Number),
    String(String),
    Array(Vec<Value>),
    Object(Map<String, Value>),
}

Represents any valid JSON value.

Variants

Represents a JSON null value.

Represents a JSON boolean.

Represents a JSON number, whether integer or floating point.

Represents a JSON string.

Represents a JSON array.

Represents a JSON object.

Methods

impl Value
[src]

Index into a JSON array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.

Returns None 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 None if the given key does not exist in the map or the given index is not within the bounds of the array.

let object = json!({ "A": 65, "B": 66, "C": 67 });
assert_eq!(*object.get("A").unwrap(), json!(65));

let array = json!([ "A", "B", "C" ]);
assert_eq!(*array.get(2).unwrap(), json!("C"));

assert_eq!(array.get("A"), None);

Square brackets can also be used to index into a value in a more concise way. This returns Value::Null in cases where get would have returned None.

let object = json!({
    "A": ["a", "á", "à"],
    "B": ["b", "b́"],
    "C": ["c", "ć", "ć̣", "ḉ"],
});
assert_eq!(object["B"][0], json!("b"));

assert_eq!(object["D"], json!(null));
assert_eq!(object[0]["x"]["y"]["z"], json!(null));

Mutably index into a JSON array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.

Returns None 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 None if the given key does not exist in the map or the given index is not within the bounds of the array.

let mut object = json!({ "A": 65, "B": 66, "C": 67 });
*object.get_mut("A").unwrap() = json!(69);

let mut array = json!([ "A", "B", "C" ]);
*array.get_mut(2).unwrap() = json!("D");

Returns true if the Value is an Object. Returns false otherwise.

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

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

Returns true if the Value is an Array. Returns false otherwise.

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

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

Returns true if the Value is a String. Returns false otherwise.

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

Returns true if the Value is a Number. Returns false otherwise.

Returns true if the Value is a number that can be represented by i64.

Returns true if the Value is a number that can be represented by u64.

Returns true if the Value is a number that can be represented by f64.

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

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

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

Returns true if the Value is a Boolean. Returns false otherwise.

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

Returns true if the Value is a Null. Returns false otherwise.

If the Value is a Null, returns (). Returns None otherwise.

Looks up a value by a JSON Pointer.

JSON Pointer defines a string syntax for identifying a specific value within a JavaScript Object Notation (JSON) document.

A Pointer is a Unicode string with the reference tokens separated by /. Inside tokens / is replaced by ~1 and ~ is replaced by ~0. The addressed value is returned and if there is no such value None is returned.

For more information read RFC6901.

Examples

let data = json!({
    "x": {
        "y": ["z", "zz"]
    }
});

assert_eq!(data.pointer("/x/y/1").unwrap(), &json!("zz"));
assert_eq!(data.pointer("/a/b/c"), None);

Looks up a value by a JSON Pointer and returns a mutable reference to that value.

JSON Pointer defines a string syntax for identifying a specific value within a JavaScript Object Notation (JSON) document.

A Pointer is a Unicode string with the reference tokens separated by /. Inside tokens / is replaced by ~1 and ~ is replaced by ~0. The addressed value is returned and if there is no such value None is returned.

For more information read RFC6901.

Example of Use

extern crate serde_json;

use serde_json::Value;
use std::mem;

fn main() {
    let s = r#"{"x": 1.0, "y": 2.0}"#;
    let mut value: Value = serde_json::from_str(s).unwrap();

    // Check value using read-only pointer
    assert_eq!(value.pointer("/x"), Some(&1.0.into()));
    // Change value with direct assignment
    *value.pointer_mut("/x").unwrap() = 1.5.into();
    // Check that new value was written
    assert_eq!(value.pointer("/x"), Some(&1.5.into()));

    // "Steal" ownership of a value. Can replace with any valid Value.
    let old_x = value.pointer_mut("/x").map(|x| mem::replace(x, Value::Null)).unwrap();
    assert_eq!(old_x, 1.5);
    assert_eq!(value.pointer("/x").unwrap(), &Value::Null);
}

Trait Implementations

impl Debug for Value
[src]

Formats the value using the given formatter.

impl Clone for Value
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl PartialEq for Value
[src]

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

This method tests for !=.

impl Default for Value
[src]

The default value is Value::Null.

This is useful for handling omitted Value fields when deserializing.

Examples

use serde_json::Value;

#[derive(Deserialize)]
struct Settings {
    level: i32,
    #[serde(default)]
    extras: Value,
}

let data = r#" { "level": 42 } "#;
let s: Settings = serde_json::from_str(data)?;

assert_eq!(s.level, 42);
assert_eq!(s.extras, Value::Null);

Returns the "default value" for a type. Read more

impl<I> Index<I> for Value where I: Index
[src]

The returned type after indexing

Index into a serde_json::Value using the syntax value[0] or value["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.

For retrieving deeply nested values, you should have a look at the Value::pointer method.

Examples

let data = json!({
    "x": {
        "y": ["z", "zz"]
    }
});

assert_eq!(data["x"]["y"], json!(["z", "zz"]));
assert_eq!(data["x"]["y"][0], json!("z"));

assert_eq!(data["a"], json!(null)); // returns null for undefined values
assert_eq!(data["a"]["b"], json!(null)); // does not panic

impl<I> IndexMut<I> for Value where I: Index
[src]

Write into a serde_json::Value using the syntax value[0] = ... or value["k"] = ....

If the index is a number, the value must be an array of length bigger than the index. Indexing into a value that is not an array or an array that is too small will panic.

If the index is a string, the value must be an object or null which is treated like an empty object. If the key is not already present in the object, it will be inserted with a value of null. Indexing into a value that is neither an object nor null will panic.

Examples

let mut data = json!({ "x": 0 });

// replace an existing key
data["x"] = json!(1);

// insert a new key
data["y"] = json!([false, false, false]);

// replace an array value
data["y"][0] = json!(true);

// inserted a deeply nested key
data["a"]["b"]["c"]["d"] = json!(true);

println!("{}", data);

impl PartialEq<str> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<&'a str> for Value
[src]

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

This method tests for !=.

impl PartialEq<String> for Value
[src]

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

This method tests for !=.

impl PartialEq<i8> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i8> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i8> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<i16> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i16> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i16> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<i32> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i32> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i32> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<i64> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i64> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<i64> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<isize> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<isize> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<isize> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<u8> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u8> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u8> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<u16> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u16> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u16> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<u32> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u32> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u32> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<u64> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u64> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<u64> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<usize> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<usize> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<usize> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<f32> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<f32> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<f32> for &'a mut Value
[src]

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

This method tests for !=.

impl PartialEq<f64> for Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<f64> for &'a Value
[src]

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

This method tests for !=.

impl<'a> PartialEq<f64> for &'a mut Value
[src]

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

This method tests for !=.

impl From<i8> for Value
[src]

Performs the conversion.

impl From<i16> for Value
[src]

Performs the conversion.

impl From<i32> for Value
[src]

Performs the conversion.

impl From<i64> for Value
[src]

Performs the conversion.

impl From<isize> for Value
[src]

Performs the conversion.

impl From<u8> for Value
[src]

Performs the conversion.

impl From<u16> for Value
[src]

Performs the conversion.

impl From<u32> for Value
[src]

Performs the conversion.

impl From<u64> for Value
[src]

Performs the conversion.

impl From<usize> for Value
[src]

Performs the conversion.

impl From<f32> for Value
[src]

Convert 32-bit floating point number to Value

Examples

use serde_json::Value;

let f: f32 = 13.37;
let x: Value = f.into();

impl From<f64> for Value
[src]

Convert 64-bit floating point number to Value

Examples

use serde_json::Value;

let f: f64 = 13.37;
let x: Value = f.into();

impl From<bool> for Value
[src]

Convert boolean to Value

Examples

use serde_json::Value;

let b = false;
let x: Value = b.into();

impl From<String> for Value
[src]

Convert String to Value

Examples

use serde_json::Value;

let s: String = "lorem".to_string();
let x: Value = s.into();

impl<'a> From<&'a str> for Value
[src]

Convert string slice to Value

Examples

use serde_json::Value;

let s: &str = "lorem";
let x: Value = s.into();

impl<'a> From<Cow<'a, str>> for Value
[src]

Convert copy-on-write string to Value

Examples

use serde_json::Value;
use std::borrow::Cow;

let s: Cow<str> = Cow::Borrowed("lorem");
let x: Value = s.into();
use serde_json::Value;
use std::borrow::Cow;

let s: Cow<str> = Cow::Owned("lorem".to_string());
let x: Value = s.into();

impl From<Map<String, Value>> for Value
[src]

Convert map (with string keys) to Value

Examples

use serde_json::{Map, Value};

let mut m = Map::new();
m.insert("Lorem".to_string(), "ipsum".into());
let x: Value = m.into();

impl<T: Into<Value>> From<Vec<T>> for Value
[src]

Convert a Vec to Value

Examples

use serde_json::Value;

let v = vec!["lorem", "ipsum", "dolor"];
let x: Value = v.into();

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

Convert a slice to Value

Examples

use serde_json::Value;

let v: &[&str] = &["lorem", "ipsum", "dolor"];
let x: Value = v.into();

impl<T: Into<Value>> FromIterator<T> for Value
[src]

Convert an iteratable type to a Value

Examples

use serde_json::Value;

let v = std::iter::repeat(42).take(5);
let x: Value = v.collect();
use serde_json::Value;

let v: Vec<_> = vec!["lorem", "ipsum", "dolor"];
let x: Value = v.into_iter().collect();
use std::iter::FromIterator;
use serde_json::Value;

let x: Value = Value::from_iter(vec!["lorem", "ipsum", "dolor"]);

impl Serialize for Value
[src]

Serialize this value into the given Serde serializer. Read more

impl Deserialize for Value
[src]

Deserialize this value from the given Serde deserializer. Read more

impl Display for Value
[src]

Serializes a json value into a string

impl FromStr for Value
[src]

The associated error which can be returned from parsing.

Parses a string s to return a value of this type. Read more

impl Deserializer for Value
[src]

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

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

Hint that the Deserialize type is expecting an optional value. Read more

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

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

Hint that the Deserialize type is expecting a bool value.

Hint that the Deserialize type is expecting a u8 value.

Hint that the Deserialize type is expecting a u16 value.

Hint that the Deserialize type is expecting a u32 value.

Hint that the Deserialize type is expecting a u64 value.

Hint that the Deserialize type is expecting an i8 value.

Hint that the Deserialize type is expecting an i16 value.

Hint that the Deserialize type is expecting an i32 value.

Hint that the Deserialize type is expecting an i64 value.

Hint that the Deserialize type is expecting a f32 value.

Hint that the Deserialize type is expecting a f64 value.

Hint that the Deserialize type is expecting a char value.

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

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

Hint that the Deserialize type is expecting a unit value.

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

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

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

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

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

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

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

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

Hint that the Deserialize type is expecting the name of a struct field. Read more

Hint that the Deserialize type is expecting a tuple value with a particular number of elements. Read more

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

impl<'a> Deserializer for &'a Value
[src]

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

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

Hint that the Deserialize type is expecting an optional value. Read more

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

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

Hint that the Deserialize type is expecting a bool value.

Hint that the Deserialize type is expecting a u8 value.

Hint that the Deserialize type is expecting a u16 value.

Hint that the Deserialize type is expecting a u32 value.

Hint that the Deserialize type is expecting a u64 value.

Hint that the Deserialize type is expecting an i8 value.

Hint that the Deserialize type is expecting an i16 value.

Hint that the Deserialize type is expecting an i32 value.

Hint that the Deserialize type is expecting an i64 value.

Hint that the Deserialize type is expecting a f32 value.

Hint that the Deserialize type is expecting a f64 value.

Hint that the Deserialize type is expecting a char value.

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

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

Hint that the Deserialize type is expecting a unit value.

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

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

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

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

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

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

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

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

Hint that the Deserialize type is expecting the name of a struct field. Read more

Hint that the Deserialize type is expecting a tuple value with a particular number of elements. Read more

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