Enum json_toolkit::json::Value

pub enum Value {
    Null,
    Short(Short),
    String(String),
    Number(Number),
    Boolean(bool),
    Object(Object),
    Array(Vec<JsonValue, Global>),
}

Represents any valid JSON value.

Variants

Null

Short(Short)

String(String)

Number(Number)

Boolean(bool)

Object(Object)

Array(Vec<JsonValue, Global>)

Implementations

impl JsonValue

Represents any valid JSON value.

pub fn new_object() -> JsonValue

Create an empty JsonValue::Object instance. When creating an object with data, consider using the object! macro.

pub fn new_array() -> JsonValue

Create an empty JsonValue::Array instance. When creating array with data, consider using the array! macro.

pub fn dump(&self) -> String

Prints out the value as JSON string.

pub fn pretty(&self, spaces: u16) -> String

Pretty prints out the value as JSON string. Takes an argument that’s number of spaces to indent new blocks with.

pub fn to_writer<W>(&self, writer: &mut W) where
    W: Write, 

👎Deprecated since 0.10.2:

use JsonValue::write instead

Writes the JSON as byte stream into an implementor of std::io::Write.

This method is deprecated as it will panic on io errors, use write instead.

pub fn write<W>(&self, writer: &mut W) -> Result<(), Error> where
    W: Write, 

Writes the JSON as byte stream into an implementor of std::io::Write.

pub fn write_pretty<W>(&self, writer: &mut W, spaces: u16) -> Result<(), Error> where
    W: Write, 

Writes the JSON as byte stream into an implementor of std::io::Write.

pub fn is_string(&self) -> bool

pub fn is_number(&self) -> bool

pub fn is_boolean(&self) -> bool

pub fn is_null(&self) -> bool

pub fn is_object(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_empty(&self) -> bool

Checks whether the value is empty. Returns true for:

• empty string ("")
• number 0
• boolean false
• null
• empty array (array![])
• empty object (object!{})

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

pub fn as_number(&self) -> Option<Number>

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

pub fn as_f32(&self) -> Option<f32>

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

pub fn as_u32(&self) -> Option<u32>

pub fn as_u16(&self) -> Option<u16>

pub fn as_u8(&self) -> Option<u8>

pub fn as_usize(&self) -> Option<usize>

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

pub fn as_i32(&self) -> Option<i32>

pub fn as_i16(&self) -> Option<i16>

pub fn as_i8(&self) -> Option<i8>

pub fn as_isize(&self) -> Option<isize>

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

pub fn as_fixed_point_u64(&self, point: u16) -> Option<u64>

Obtain an integer at a fixed decimal point. This is useful for converting monetary values and doing arithmetic on them without rounding errors introduced by floating point operations.

Will return None if Number called on a value that’s not a number, or if the number is negative or a NaN.

let price_a = JsonValue::from(5.99);
let price_b = JsonValue::from(7);
let price_c = JsonValue::from(10.2);

assert_eq!(price_a.as_fixed_point_u64(2), Some(599));
assert_eq!(price_b.as_fixed_point_u64(2), Some(700));
assert_eq!(price_c.as_fixed_point_u64(2), Some(1020));

pub fn as_fixed_point_i64(&self, point: u16) -> Option<i64>

Analog to as_fixed_point_u64, except returning a signed i64, properly handling negative numbers.

let balance_a = JsonValue::from(-1.49);
let balance_b = JsonValue::from(42);

assert_eq!(balance_a.as_fixed_point_i64(2), Some(-149));
assert_eq!(balance_b.as_fixed_point_i64(2), Some(4200));

pub fn take(&mut self) -> JsonValue

Take over the ownership of the value, leaving Null in it’s place.

Example

let mut data = array!["Foo", 42];

let first = data[0].take();
let second = data[1].take();

assert!(first == "Foo");
assert!(second == 42);

assert!(data[0].is_null());
assert!(data[1].is_null());

pub fn take_string(&mut self) -> Option<String>

Checks that self is a string, returns an owned Rust String, leaving Null in it’s place.

• If the contained string is already a heap allocated String, then the ownership is moved without any heap allocation.

• If the contained string is a Short, this will perform a heap allocation to convert the types for you.

Example

let mut data = array!["Hello", "World"];

let owned = data[0].take_string().expect("Should be a string");

assert_eq!(owned, "Hello");
assert!(data[0].is_null());

pub fn push<T>(&mut self, value: T) -> Result<(), Error> where
    T: Into<JsonValue>, 

Works on JsonValue::Array - pushes a new value to the array.

pub fn pop(&mut self) -> JsonValue

Works on JsonValue::Array - remove and return last element from an array. On failure returns a null.

pub fn contains<T>(&self, item: T) -> bool where
    T: PartialEq<JsonValue>, 

Works on JsonValue::Array - checks if the array contains a value

pub fn has_key(&self, key: &str) -> bool

Works on JsonValue::Object - checks if the object has a key

pub fn len(&self) -> usize

Returns length of array or object (number of keys), defaults to 0 for other types.

pub fn members(&self) -> Iter<'_, JsonValue>

Works on JsonValue::Array - returns an iterator over members. Will return an empty iterator if called on non-array types.

pub fn members_mut(&mut self) -> IterMut<'_, JsonValue>

Works on JsonValue::Array - returns a mutable iterator over members. Will return an empty iterator if called on non-array types.

pub fn entries(&self) -> Iter<'_>

Works on JsonValue::Object - returns an iterator over key value pairs. Will return an empty iterator if called on non-object types.

pub fn entries_mut(&mut self) -> IterMut<'_>

Works on JsonValue::Object - returns a mutable iterator over key value pairs. Will return an empty iterator if called on non-object types.

pub fn insert<T>(&mut self, key: &str, value: T) -> Result<(), Error> where
    T: Into<JsonValue>, 

Works on JsonValue::Object - inserts a new entry, or override an existing one into the object. Note that key has to be a &str slice and not an owned String. The internals of Object will handle the heap allocation of the key if needed for better performance.

pub fn remove(&mut self, key: &str) -> JsonValue

Works on JsonValue::Object - remove a key and return the value it held. If the key was not present, the method is called on anything but an object, it will return a null.

pub fn array_remove(&mut self, index: usize) -> JsonValue

Works on JsonValue::Array - remove an entry and return the value it held. If the method is called on anything but an object or if the index is out of bounds, it will return JsonValue::Null.

pub fn clear(&mut self)

When called on an array or an object, will wipe them clean. When called on a string will clear the string. Numbers and booleans become null.

Trait Implementations

impl Clone for JsonValue

fn clone(&self) -> JsonValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonValue

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

Formats the value using the given formatter.

impl Display for JsonValue

Implements formatting

let data = json::parse(r#"{"url":"https://github.com/"}"#).unwrap();
println!("{}", data);
println!("{:#}", data);

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

Formats the value using the given formatter.

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

fn from(val: &'a [T]) -> JsonValue

Converts to this type from the input type.

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

fn from(val: &'a str) -> JsonValue

Converts to this type from the input type.

impl<K, V> From<BTreeMap<K, V, Global>> for JsonValue where
    K: AsRef<str>,
    V: Into<JsonValue>, 

fn from(val: BTreeMap<K, V, Global>) -> JsonValue

Converts to this type from the input type.

impl<K, V> From<HashMap<K, V, RandomState>> for JsonValue where
    K: AsRef<str>,
    V: Into<JsonValue>, 

fn from(val: HashMap<K, V, RandomState>) -> JsonValue

Converts to this type from the input type.

impl From<Number> for JsonValue

fn from(val: Number) -> JsonValue

Converts to this type from the input type.

impl From<Object> for JsonValue

fn from(val: Object) -> JsonValue

Converts to this type from the input type.

impl<T> From<Option<T>> for JsonValue where
    T: Into<JsonValue>, 

fn from(val: Option<T>) -> JsonValue

Converts to this type from the input type.

impl From<String> for JsonValue

fn from(val: String) -> JsonValue

Converts to this type from the input type.

impl<T> From<Vec<T, Global>> for JsonValue where
    T: Into<JsonValue>, 

fn from(val: Vec<T, Global>) -> JsonValue

Converts to this type from the input type.

impl From<bool> for JsonValue

fn from(val: bool) -> JsonValue

Converts to this type from the input type.

impl From<f32> for JsonValue

fn from(val: f32) -> JsonValue

Converts to this type from the input type.

impl From<f64> for JsonValue

fn from(val: f64) -> JsonValue

Converts to this type from the input type.

impl From<i16> for JsonValue

fn from(val: i16) -> JsonValue

Converts to this type from the input type.

impl From<i32> for JsonValue

fn from(val: i32) -> JsonValue

Converts to this type from the input type.

impl From<i64> for JsonValue

fn from(val: i64) -> JsonValue

Converts to this type from the input type.

impl From<i8> for JsonValue

fn from(val: i8) -> JsonValue

Converts to this type from the input type.

impl From<isize> for JsonValue

fn from(val: isize) -> JsonValue

Converts to this type from the input type.

impl From<u16> for JsonValue

fn from(val: u16) -> JsonValue

Converts to this type from the input type.

impl From<u32> for JsonValue

fn from(val: u32) -> JsonValue

Converts to this type from the input type.

impl From<u64> for JsonValue

fn from(val: u64) -> JsonValue

Converts to this type from the input type.

impl From<u8> for JsonValue

fn from(val: u8) -> JsonValue

Converts to this type from the input type.

impl From<usize> for JsonValue

fn from(val: usize) -> JsonValue

Converts to this type from the input type.

impl<'a> Index<&'a String> for JsonValue

type Output = JsonValue

The returned type after indexing.

fn index(&self, index: &String) -> &JsonValue

Performs the indexing (container[index]) operation.

impl<'a> Index<&'a str> for JsonValue

Implements indexing by &str to easily access object members:

Example

let object = object!{
    foo: "bar"
};

assert!(object["foo"] == "bar");

type Output = JsonValue

The returned type after indexing.

fn index(&self, index: &str) -> &JsonValue

Performs the indexing (container[index]) operation.

impl Index<String> for JsonValue

type Output = JsonValue

The returned type after indexing.

fn index(&self, index: String) -> &JsonValue

Performs the indexing (container[index]) operation.

impl Index<usize> for JsonValue

Implements indexing by usize to easily access array members:

Example

let mut array = JsonValue::new_array();

array.push("foo");

assert!(array[0] == "foo");

type Output = JsonValue

The returned type after indexing.

fn index(&self, index: usize) -> &JsonValue

Performs the indexing (container[index]) operation.

impl<'a> IndexMut<&'a String> for JsonValue

fn index_mut(&mut self, index: &String) -> &mut JsonValue

Performs the mutable indexing (container[index]) operation.

impl<'a> IndexMut<&'a str> for JsonValue

Implements mutable indexing by &str to easily modify object members:

Example

let mut object = object!{};

object["foo"] = 42.into();

assert!(object["foo"] == 42);

fn index_mut(&mut self, index: &str) -> &mut JsonValue

Performs the mutable indexing (container[index]) operation.

impl IndexMut<String> for JsonValue

fn index_mut(&mut self, index: String) -> &mut JsonValue

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for JsonValue

Implements mutable indexing by usize to easily modify array members:

Example

let mut array = array!["foo", 3.14];

array[1] = "bar".into();

assert!(array[1] == "bar");

fn index_mut(&mut self, index: usize) -> &mut JsonValue

Performs the mutable indexing (container[index]) operation.

impl<'a> PartialEq<&'a str> for JsonValue

fn eq(&self, other: &&str) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<JsonValue> for &'a str

fn eq(&self, other: &JsonValue) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<JsonValue> for JsonValue

fn eq(&self, other: &JsonValue) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<JsonValue> for str

fn eq(&self, other: &JsonValue) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<Number> for &'a JsonValue

fn eq(&self, other: &Number) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Number> for JsonValue

fn eq(&self, other: &Number) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<Object> for &'a JsonValue

fn eq(&self, other: &Object) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Object> for JsonValue

fn eq(&self, other: &Object) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<String> for &'a JsonValue

fn eq(&self, other: &String) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for JsonValue

fn eq(&self, other: &String) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<bool> for &'a JsonValue

fn eq(&self, other: &bool) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<bool> for JsonValue

fn eq(&self, other: &bool) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<f32> for &'a JsonValue

fn eq(&self, other: &f32) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<f32> for JsonValue

fn eq(&self, other: &f32) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<f64> for &'a JsonValue

fn eq(&self, other: &f64) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<f64> for JsonValue

fn eq(&self, other: &f64) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<i16> for &'a JsonValue

fn eq(&self, other: &i16) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i16> for JsonValue

fn eq(&self, other: &i16) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<i32> for &'a JsonValue

fn eq(&self, other: &i32) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i32> for JsonValue

fn eq(&self, other: &i32) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<i64> for &'a JsonValue

fn eq(&self, other: &i64) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i64> for JsonValue

fn eq(&self, other: &i64) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<i8> for &'a JsonValue

fn eq(&self, other: &i8) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i8> for JsonValue

fn eq(&self, other: &i8) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<isize> for &'a JsonValue

fn eq(&self, other: &isize) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<isize> for JsonValue

fn eq(&self, other: &isize) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for JsonValue

fn eq(&self, other: &str) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<u16> for &'a JsonValue

fn eq(&self, other: &u16) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u16> for JsonValue

fn eq(&self, other: &u16) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<u32> for &'a JsonValue

fn eq(&self, other: &u32) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u32> for JsonValue

fn eq(&self, other: &u32) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<u64> for &'a JsonValue

fn eq(&self, other: &u64) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u64> for JsonValue

fn eq(&self, other: &u64) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<u8> for &'a JsonValue

fn eq(&self, other: &u8) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u8> for JsonValue

fn eq(&self, other: &u8) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<usize> for &'a JsonValue

fn eq(&self, other: &usize) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<usize> for JsonValue

fn eq(&self, other: &usize) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ValueExt for Value

fn pointer(&self, pointer: &Pointer<'_>) -> Option<&Self>

Looks up a value by a JSON pointer.

fn pointer_mut(&mut self, pointer: &Pointer<'_>) -> Option<&mut Self>

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

fn insert(
    &mut self,
    key: String,
    value: impl Into<Self>
) -> Result<Option<Self>, Error>

Insert any data in the current JSON value.

fn insert_at(
    &mut self,
    pointer: &Pointer<'_>,
    value: impl Into<Self>
) -> Result<Option<Self>, Error>

Inserts any data at the given pointee JSON value.

impl Eq for JsonValue