[−][src]Struct validators::json::JSON
Implementations
impl JSON
[src]
pub fn get_json_value(&self) -> &Value
[src]
pub fn get_full_json(&self) -> &str
[src]
pub fn into_value(self) -> Value
[src]
pub fn into_string(self) -> String
[src]
impl JSON
[src]
pub fn from_string(full_json: String) -> Result<Self, JSONError>
[src]
pub fn from_str(full_json: &str) -> Result<Self, JSONError>
[src]
Methods from Deref<Target = Value>
pub fn get<I>(&self, index: I) -> Option<&Value> where
I: Index,
[src]
I: Index,
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));
pub fn get_mut<I>(&mut self, index: I) -> Option<&mut Value> where
I: Index,
[src]
I: Index,
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");
pub fn is_object(&self) -> bool
[src]
Returns true if the Value
is an Object. Returns false otherwise.
For any Value on which is_object
returns true, as_object
and
as_object_mut
are guaranteed to return the map representation of the
object.
let obj = json!({ "a": { "nested": true }, "b": ["an", "array"] }); assert!(obj.is_object()); assert!(obj["a"].is_object()); // array, not an object assert!(!obj["b"].is_object());
pub fn as_object(&self) -> Option<&Map<String, Value>>
[src]
If the Value
is an Object, returns the associated Map. Returns None
otherwise.
let v = json!({ "a": { "nested": true }, "b": ["an", "array"] }); // The length of `{"nested": true}` is 1 entry. assert_eq!(v["a"].as_object().unwrap().len(), 1); // The array `["an", "array"]` is not an object. assert_eq!(v["b"].as_object(), None);
pub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>>
[src]
If the Value
is an Object, returns the associated mutable Map.
Returns None otherwise.
let mut v = json!({ "a": { "nested": true } }); v["a"].as_object_mut().unwrap().clear(); assert_eq!(v, json!({ "a": {} }));
pub fn is_array(&self) -> bool
[src]
Returns true if the Value
is an Array. Returns false otherwise.
For any Value on which is_array
returns true, as_array
and
as_array_mut
are guaranteed to return the vector representing the
array.
let obj = json!({ "a": ["an", "array"], "b": { "an": "object" } }); assert!(obj["a"].is_array()); // an object, not an array assert!(!obj["b"].is_array());
pub fn as_array(&self) -> Option<&Vec<Value>>
[src]
If the Value
is an Array, returns the associated vector. Returns None
otherwise.
let v = json!({ "a": ["an", "array"], "b": { "an": "object" } }); // The length of `["an", "array"]` is 2 elements. assert_eq!(v["a"].as_array().unwrap().len(), 2); // The object `{"an": "object"}` is not an array. assert_eq!(v["b"].as_array(), None);
pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>
[src]
If the Value
is an Array, returns the associated mutable vector.
Returns None otherwise.
let mut v = json!({ "a": ["an", "array"] }); v["a"].as_array_mut().unwrap().clear(); assert_eq!(v, json!({ "a": [] }));
pub fn is_string(&self) -> bool
[src]
Returns true if the Value
is a String. Returns false otherwise.
For any Value on which is_string
returns true, as_str
is guaranteed
to return the string slice.
let v = json!({ "a": "some string", "b": false }); assert!(v["a"].is_string()); // The boolean `false` is not a string. assert!(!v["b"].is_string());
pub fn as_str(&self) -> Option<&str>
[src]
If the Value
is a String, returns the associated str. Returns None
otherwise.
let v = json!({ "a": "some string", "b": false }); assert_eq!(v["a"].as_str(), Some("some string")); // The boolean `false` is not a string. assert_eq!(v["b"].as_str(), None); // JSON values are printed in JSON representation, so strings are in quotes. // // The value is: "some string" println!("The value is: {}", v["a"]); // Rust strings are printed without quotes. // // The value is: some string println!("The value is: {}", v["a"].as_str().unwrap());
pub fn is_number(&self) -> bool
[src]
Returns true if the Value
is a Number. Returns false otherwise.
let v = json!({ "a": 1, "b": "2" }); assert!(v["a"].is_number()); // The string `"2"` is a string, not a number. assert!(!v["b"].is_number());
pub fn is_i64(&self) -> bool
[src]
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.
let big = i64::max_value() as u64 + 10; let v = json!({ "a": 64, "b": big, "c": 256.0 }); assert!(v["a"].is_i64()); // Greater than i64::MAX. assert!(!v["b"].is_i64()); // Numbers with a decimal point are not considered integers. assert!(!v["c"].is_i64());
pub fn is_u64(&self) -> bool
[src]
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.
let v = json!({ "a": 64, "b": -64, "c": 256.0 }); assert!(v["a"].is_u64()); // Negative integer. assert!(!v["b"].is_u64()); // Numbers with a decimal point are not considered integers. assert!(!v["c"].is_u64());
pub fn is_f64(&self) -> bool
[src]
Returns true if the Value
is a number that can be represented by f64.
For any Value on which is_f64
returns true, as_f64
is guaranteed to
return the floating point value.
Currently this function returns true if and only if both is_i64
and
is_u64
return false but this is not a guarantee in the future.
let v = json!({ "a": 256.0, "b": 64, "c": -64 }); assert!(v["a"].is_f64()); // Integers. assert!(!v["b"].is_f64()); assert!(!v["c"].is_f64());
pub fn as_i64(&self) -> Option<i64>
[src]
If the Value
is an integer, represent it as i64 if possible. Returns
None otherwise.
let big = i64::max_value() as u64 + 10; let v = json!({ "a": 64, "b": big, "c": 256.0 }); assert_eq!(v["a"].as_i64(), Some(64)); assert_eq!(v["b"].as_i64(), None); assert_eq!(v["c"].as_i64(), None);
pub fn as_u64(&self) -> Option<u64>
[src]
If the Value
is an integer, represent it as u64 if possible. Returns
None otherwise.
let v = json!({ "a": 64, "b": -64, "c": 256.0 }); assert_eq!(v["a"].as_u64(), Some(64)); assert_eq!(v["b"].as_u64(), None); assert_eq!(v["c"].as_u64(), None);
pub fn as_f64(&self) -> Option<f64>
[src]
If the Value
is a number, represent it as f64 if possible. Returns
None otherwise.
let v = json!({ "a": 256.0, "b": 64, "c": -64 }); assert_eq!(v["a"].as_f64(), Some(256.0)); assert_eq!(v["b"].as_f64(), Some(64.0)); assert_eq!(v["c"].as_f64(), Some(-64.0));
pub fn is_boolean(&self) -> bool
[src]
Returns true if the Value
is a Boolean. Returns false otherwise.
For any Value on which is_boolean
returns true, as_bool
is
guaranteed to return the boolean value.
let v = json!({ "a": false, "b": "false" }); assert!(v["a"].is_boolean()); // The string `"false"` is a string, not a boolean. assert!(!v["b"].is_boolean());
pub fn as_bool(&self) -> Option<bool>
[src]
If the Value
is a Boolean, returns the associated bool. Returns None
otherwise.
let v = json!({ "a": false, "b": "false" }); assert_eq!(v["a"].as_bool(), Some(false)); // The string `"false"` is a string, not a boolean. assert_eq!(v["b"].as_bool(), None);
pub fn is_null(&self) -> bool
[src]
Returns true if the Value
is a Null. Returns false otherwise.
For any Value on which is_null
returns true, as_null
is guaranteed
to return Some(())
.
let v = json!({ "a": null, "b": false }); assert!(v["a"].is_null()); // The boolean `false` is not null. assert!(!v["b"].is_null());
pub fn as_null(&self) -> Option<()>
[src]
If the Value
is a Null, returns (). Returns None otherwise.
let v = json!({ "a": null, "b": false }); assert_eq!(v["a"].as_null(), Some(())); // The boolean `false` is not null. assert_eq!(v["b"].as_null(), None);
pub fn pointer(&self, pointer: &str) -> Option<&Value>
[src]
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);
pub fn pointer_mut(&mut self, pointer: &str) -> Option<&mut Value>
[src]
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
use serde_json::Value; 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())); // Or change the value only if it exists value.pointer_mut("/x").map(|v| *v = 1.5.into()); // "Steal" ownership of a value. Can replace with any valid Value. let old_x = value.pointer_mut("/x").map(Value::take).unwrap(); assert_eq!(old_x, 1.5); assert_eq!(value.pointer("/x").unwrap(), &Value::Null); }
pub fn take(&mut self) -> Value
[src]
Takes the value out of the Value
, leaving a Null
in its place.
let mut v = json!({ "x": "y" }); assert_eq!(v["x"].take(), json!("y")); assert_eq!(v, json!({ "x": null }));
Trait Implementations
impl Clone for JSON
[src]
impl Debug for JSON
[src]
impl Deref for JSON
[src]
impl DerefMut for JSON
[src]
impl<'de> Deserialize<'de> for JSON
[src]
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
impl Display for JSON
[src]
impl Eq for JSON
[src]
impl<'a> FromFormValue<'a> for JSON
[src]
type Error = JSONError
The associated error which can be returned from parsing. It is a good idea to have the return type be or contain an &'v str
so that the unparseable string can be examined after a bad parse. Read more
fn from_form_value(form_value: &'a RawStr) -> Result<Self, Self::Error>
[src]
fn default() -> Option<Self>
[src]
impl<'a> FromParam<'a> for JSON
[src]
type Error = JSONError
The associated error to be returned if parsing/validation fails.
fn from_param(param: &'a RawStr) -> Result<Self, Self::Error>
[src]
impl FromStr for JSON
[src]
type Err = JSONError
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Self, Self::Err>
[src]
impl Hash for JSON
[src]
fn hash<H: Hasher>(&self, state: &mut H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl PartialEq<JSON> for JSON
[src]
impl Serialize for JSON
[src]
impl Validated for JSON
[src]
impl ValidatedWrapper for JSON
[src]
Auto Trait Implementations
impl RefUnwindSafe for JSON
impl Send for JSON
impl Sync for JSON
impl Unpin for JSON
impl UnwindSafe for JSON
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T, I> AsResult<T, I> for T where
I: Input,
I: Input,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IntoCollection<T> for T
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
A: Array<Item = T>,
fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
A: Array<Item = U>,
F: FnMut(T) -> U,
A: Array<Item = U>,
F: FnMut(T) -> U,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Typeable for T where
T: Any,
T: Any,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,