Enum simd_json::value::borrowed::Value

pub enum Value<'value> {
    Static(StaticNode),
    String(Cow<'value, str>),
    Array(Vec<Value<'value>>),
    Object(Box<Object<'value>>),
}

Borrowed JSON-DOM Value, consider using the ValueTrait to access its content

Variants

Static(StaticNode)

Static values

String(Cow<'value, str>)

string type

Array(Vec<Value<'value>>)

array type

Object(Box<Object<'value>>)

object type

Implementations

impl<'value> Value<'value>

#[must_use]pub fn into_static(self) -> Value<'static>

Enforces static lifetime on a borrowed value, this will force all strings to become owned COW's, the same applies for Object keys.

#[must_use]pub fn clone_static(&self) -> Value<'static>

Clones the current value and enforces a static lifetime, it works the same as into_static but includes cloning logic

Trait Implementations

impl<'value> Builder<'value> for Value<'value>

#[must_use]fn null() -> Self

Returns anull value

#[must_use]fn array_with_capacity(capacity: usize) -> Self

Returns an empty array with a given capacity

#[must_use]fn object_with_capacity(capacity: usize) -> Self

Returns an empty object with a given capacity

#[must_use]pub fn array() -> Self

Returns an empty array

#[must_use]pub fn object() -> Self

Returns an empty object

impl<'value> Clone for Value<'value>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'value> Debug for Value<'value>

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

Formats the value using the given formatter.

impl<'value> Default for Value<'value>

#[must_use]fn default() -> Self

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 Value<'de>

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, 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_option<V>(self, visitor: V) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

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

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

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_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 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_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 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_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_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_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.

pub fn is_human_readable(&self) -> bool

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

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

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, 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_option<V>(self, visitor: V) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

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

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

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_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 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_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 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_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_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_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.

pub fn is_human_readable(&self) -> bool

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

impl<'value> Display for Value<'value>

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

Formats the value using the given formatter.

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

#[must_use]fn from(s: &'value str) -> Self

Performs the conversion.

impl<'value> From<()> for Value<'value>

#[must_use]fn from(_b: ()) -> Self

Performs the conversion.

impl<'value> From<Cow<'value, str>> for Value<'value>

#[must_use]fn from(c: Cow<'value, str>) -> Self

Performs the conversion.

impl<'value> From<HashMap<Cow<'value, str>, Value<'value>, RandomState>> for Value<'value>

#[must_use]fn from(v: Object<'value>) -> Self

Performs the conversion.

impl<'value, T> From<Option<T>> for Value<'value> where
    Value<'value>: From<T>, 

#[must_use]fn from(s: Option<T>) -> Self

Performs the conversion.

impl<'value> From<StaticNode> for Value<'value>

#[must_use]fn from(s: StaticNode) -> Self

Performs the conversion.

impl<'value> From<String> for Value<'value>

#[must_use]fn from(s: String) -> Self

Performs the conversion.

impl From<Value<'_>> for Value

#[must_use]fn from(b: BorrowedValue<'_>) -> Self

Performs the conversion.

impl<'value> From<Value> for Value<'value>

#[must_use]fn from(b: OwnedValue) -> Self

Performs the conversion.

impl<'value, S> From<Vec<S, Global>> for Value<'value> where
    Value<'value>: From<S>, 

#[must_use]fn from(v: Vec<S>) -> Self

Performs the conversion.

impl<'value> From<bool> for Value<'value>

#[must_use]fn from(b: bool) -> Self

Performs the conversion.

impl<'value> From<f32> for Value<'value>

#[must_use]fn from(f: f32) -> Self

Performs the conversion.

impl<'value> From<f64> for Value<'value>

#[must_use]fn from(f: f64) -> Self

Performs the conversion.

impl<'value> From<i16> for Value<'value>

#[must_use]fn from(i: i16) -> Self

Performs the conversion.

impl<'value> From<i32> for Value<'value>

#[must_use]fn from(i: i32) -> Self

Performs the conversion.

impl<'value> From<i64> for Value<'value>

#[must_use]fn from(i: i64) -> Self

Performs the conversion.

impl<'value> From<i8> for Value<'value>

#[must_use]fn from(i: i8) -> Self

Performs the conversion.

impl<'value> From<u16> for Value<'value>

#[must_use]fn from(i: u16) -> Self

Performs the conversion.

impl<'value> From<u32> for Value<'value>

#[must_use]fn from(i: u32) -> Self

Performs the conversion.

impl<'value> From<u64> for Value<'value>

#[must_use]fn from(i: u64) -> Self

Performs the conversion.

impl<'value> From<u8> for Value<'value>

#[must_use]fn from(i: u8) -> Self

Performs the conversion.

impl<'value> From<usize> for Value<'value>

#[must_use]fn from(i: usize) -> Self

Performs the conversion.

impl<'value, K: Into<Cow<'value, str>>, V: Into<Value<'value>>> FromIterator<(K, V)> for Value<'value>

#[must_use]fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'value, V: Into<Value<'value>>> FromIterator<V> for Value<'value>

#[must_use]fn from_iter<I: IntoIterator<Item = V>>(iter: I) -> Self

Creates a value from an iterator.

impl<'value> Index<&'_ str> for Value<'value>

type Output = Value<'value>

The returned type after indexing.

#[must_use]fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'value> Index<usize> for Value<'value>

type Output = Value<'value>

The returned type after indexing.

#[must_use]fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'value> IndexMut<&'_ str> for Value<'value>

#[must_use]fn index_mut(&mut self, index: &str) -> &mut Self::Output

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

impl<'value> IndexMut<usize> for Value<'value>

#[must_use]fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl<'value> Mutable for Value<'value>

#[must_use]fn as_array_mut(&mut self) -> Option<&mut Vec<Value<'value>>>

Tries to represent the value as an array and returns a mutable refference to it

#[must_use]fn as_object_mut(&mut self) -> Option<&mut HashMap<Self::Key, Self>>

Tries to represent the value as an object and returns a mutable refference to it

pub fn insert<K, V>(&mut self, k: K, v: V) -> Result<Option<Self>, AccessError> where
    V: Into<Self>,
    K: Into<Self::Key>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to insert into this Value as an Object. Will return an AccessError::NotAnObject if called on a Value that isn't an object - otherwise will behave the same as HashMap::insert

pub fn remove<Q>(&mut self, k: &Q) -> Result<Option<Self>, AccessError> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to remove from this Value as an Object. Will return an AccessError::NotAnObject if called on a Value that isn't an object - otherwise will behave the same as HashMap::remove

pub fn push<V>(&mut self, v: V) -> Result<(), AccessError> where
    V: Into<Self>, 

Tries to push to this Value as an Array. Will return an AccessError::NotAnArray if called on a Value that isn't an Array - otherwise will behave the same as Vec::push

pub fn pop(&mut self) -> Result<Option<Self>, AccessError>

Tries to pop from this Value as an Array. Will return an AccessError::NotAnArray if called on a Value that isn't an Array - otherwise will behave the same as Vec::pop

pub fn get_mut<Q>(&mut self, k: &Q) -> Option<&mut Self> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Same as get but returns a mutable ref instead

pub fn get_idx_mut(&mut self, i: usize) -> Option<&mut Self>

Same as get_idx but returns a mutable ref instead

impl<'v, T> PartialEq<&'_ [T]> for Value<'v> where
    Value<'v>: PartialEq<T>, 

#[must_use]fn eq(&self, other: &&[T]) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'value, T> PartialEq<&'_ T> for Value<'value> where
    Value<'value>: PartialEq<T>, 

#[must_use]fn eq(&self, other: &&T) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<&'_ str> for Value<'v>

#[must_use]fn eq(&self, other: &&str) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<()> for Value<'v>

#[must_use]fn eq(&self, _other: &()) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v, K, T, S> PartialEq<HashMap<K, T, S>> for Value<'v> where
    K: AsRef<str> + Hash + Eq,
    Value<'v>: PartialEq<T>,
    S: BuildHasher, 

#[must_use]fn eq(&self, other: &HashMap<K, T, S>) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<String> for Value<'v>

#[must_use]fn eq(&self, other: &String) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Value<'_>> for Value

#[must_use]fn eq(&self, other: &BorrowedValue<'_>) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'value> PartialEq<Value<'value>> for Value<'value>

#[must_use]fn eq(&self, other: &Self) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'value> PartialEq<Value> for Value<'value>

#[must_use]fn eq(&self, other: &OwnedValue) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<bool> for Value<'v>

#[must_use]fn eq(&self, other: &bool) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<f32> for Value<'v>

#[must_use]fn eq(&self, other: &f32) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<f64> for Value<'v>

#[must_use]fn eq(&self, other: &f64) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<i128> for Value<'v>

#[must_use]fn eq(&self, other: &i128) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<i16> for Value<'v>

#[must_use]fn eq(&self, other: &i16) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<i32> for Value<'v>

#[must_use]fn eq(&self, other: &i32) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<i64> for Value<'v>

#[must_use]fn eq(&self, other: &i64) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<i8> for Value<'v>

#[must_use]fn eq(&self, other: &i8) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<str> for Value<'v>

#[must_use]fn eq(&self, other: &str) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<u128> for Value<'v>

#[must_use]fn eq(&self, other: &u128) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<u16> for Value<'v>

#[must_use]fn eq(&self, other: &u16) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<u32> for Value<'v>

#[must_use]fn eq(&self, other: &u32) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<u64> for Value<'v>

#[must_use]fn eq(&self, other: &u64) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<u8> for Value<'v>

#[must_use]fn eq(&self, other: &u8) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'v> PartialEq<usize> for Value<'v>

#[must_use]fn eq(&self, other: &usize) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'value> Serialize for Value<'value>

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

Serialize this value into the given Serde serializer.

impl<'value> TryFrom<Value> for BorrowedValue<'value>

type Error = SerdeConversionError

The type returned in the event of a conversion error.

fn try_from(item: Value) -> Result<Self, SerdeConversionError>

Performs the conversion.

impl<'value> TryInto<Value> for BorrowedValue<'value>

type Error = SerdeConversionError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Value, SerdeConversionError>

Performs the conversion.

impl<'value> Value for Value<'value>

type Key = Cow<'value, str>

The type for Objects

type Array = Vec<Self>

The array structure

type Object = HashMap<Self::Key, Self>

The object structure

#[must_use]fn value_type(&self) -> ValueType

Returns the type of the current Valye

#[must_use]fn is_null(&self) -> bool

returns true if the current value is null

#[must_use]fn as_bool(&self) -> Option<bool>

Tries to represent the value as a bool

#[must_use]fn as_i64(&self) -> Option<i64>

Tries to represent the value as an i64

#[must_use]fn as_i128(&self) -> Option<i128>

Tries to represent the value as an i128

#[must_use]fn as_u64(&self) -> Option<u64>

Tries to represent the value as an u64

#[must_use]fn as_f64(&self) -> Option<f64>

Tries to represent the value as a f64

#[must_use]fn cast_f64(&self) -> Option<f64>

Casts the current value to a f64 if possible, this will turn integer values into floats.

#[must_use]fn as_str(&self) -> Option<&str>

Tries to represent the value as a &str

#[must_use]fn as_array(&self) -> Option<&Vec<Value<'value>>>

Tries to represent the value as an array and returns a refference to it

#[must_use]fn as_object(&self) -> Option<&HashMap<Self::Key, Self>>

Tries to represent the value as an object and returns a refference to it

#[must_use]pub fn get<Q>(&self, k: &Q) -> Option<&Self> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Gets a ref to a value based on a key, returns None if the current Value isn't an Object or doesn't contain the key it was asked for.

#[must_use]pub fn contains_key<Q>(&self, k: &Q) -> bool where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Checks if a Value contains a given key. This will return flase if Value isn't an object

#[must_use]pub fn get_idx(&self, i: usize) -> Option<&Self>

Gets a ref to a value based on n index, returns None if the current Value isn't an Array or doesn't contain the index it was asked for.

#[must_use]pub fn is_float(&self) -> bool

returns true if the current value a floatingpoint number

#[must_use]pub fn is_integer(&self) -> bool

returns true if the current value a integer number

#[must_use]pub fn is_number(&self) -> bool

returns true if the current value a number either float or integer

#[must_use]pub fn is_bool(&self) -> bool

returns true if the current value a bool

#[must_use]pub fn get_bool<Q>(&self, k: &Q) -> Option<bool> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a bool

#[must_use]pub fn get_i128<Q>(&self, k: &Q) -> Option<i128> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a i128

#[must_use]pub fn is_i128(&self) -> bool

returns true if the current value can be represented as a i128

#[must_use]pub fn is_i64(&self) -> bool

returns true if the current value can be represented as a i64

#[must_use]pub fn get_i64<Q>(&self, k: &Q) -> Option<i64> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a i64

#[must_use]pub fn as_i32(&self) -> Option<i32>

Tries to represent the value as an i32

#[must_use]pub fn is_i32(&self) -> bool

returns true if the current value can be represented as a i32

#[must_use]pub fn get_i32<Q>(&self, k: &Q) -> Option<i32> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a i32

#[must_use]pub fn as_i16(&self) -> Option<i16>

Tries to represent the value as an i16

#[must_use]pub fn is_i16(&self) -> bool

returns true if the current value can be represented as a i16

#[must_use]pub fn get_i16<Q>(&self, k: &Q) -> Option<i16> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a i16

#[must_use]pub fn as_i8(&self) -> Option<i8>

Tries to represent the value as an i8

#[must_use]pub fn is_i8(&self) -> bool

returns true if the current value can be represented as a i8

#[must_use]pub fn get_i8<Q>(&self, k: &Q) -> Option<i8> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a i8

#[must_use]pub fn as_u128(&self) -> Option<u128>

Tries to represent the value as an u128

#[must_use]pub fn is_u128(&self) -> bool

returns true if the current value can be represented as a u128

#[must_use]pub fn get_u128<Q>(&self, k: &Q) -> Option<u128> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a u128

#[must_use]pub fn is_u64(&self) -> bool

returns true if the current value can be represented as a u64

#[must_use]pub fn get_u64<Q>(&self, k: &Q) -> Option<u64> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a u64

#[must_use]pub fn as_usize(&self) -> Option<usize>

Tries to represent the value as an usize

#[must_use]pub fn is_usize(&self) -> bool

returns true if the current value can be represented as a usize

#[must_use]pub fn get_usize<Q>(&self, k: &Q) -> Option<usize> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a usize

#[must_use]pub fn as_u32(&self) -> Option<u32>

Tries to represent the value as an u32

#[must_use]pub fn is_u32(&self) -> bool

returns true if the current value can be represented as a u32

#[must_use]pub fn get_u32<Q>(&self, k: &Q) -> Option<u32> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a u32

#[must_use]pub fn as_u16(&self) -> Option<u16>

Tries to represent the value as an u16

#[must_use]pub fn is_u16(&self) -> bool

returns true if the current value can be represented as a u16

#[must_use]pub fn get_u16<Q>(&self, k: &Q) -> Option<u16> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a u16

#[must_use]pub fn as_u8(&self) -> Option<u8>

Tries to represent the value as an u8

#[must_use]pub fn is_u8(&self) -> bool

returns true if the current value can be represented as a u8

#[must_use]pub fn get_u8<Q>(&self, k: &Q) -> Option<u8> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a u8

#[must_use]pub fn is_f64(&self) -> bool

returns true if the current value can be represented as a f64

#[must_use]pub fn get_f64<Q>(&self, k: &Q) -> Option<f64> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a f64

#[must_use]pub fn is_f64_castable(&self) -> bool

returns true if the current value can be cast into a f64

#[must_use]pub fn as_f32(&self) -> Option<f32>

Tries to represent the value as a f32

#[must_use]pub fn is_f32(&self) -> bool

returns true if the current value can be represented as a f64

#[must_use]pub fn get_f32<Q>(&self, k: &Q) -> Option<f32> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a f32

#[must_use]pub fn is_str(&self) -> bool

returns true if the current value can be represented as a str

#[must_use]pub fn get_str<Q>(&self, k: &Q) -> Option<&str> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a str

#[must_use]pub fn is_array(&self) -> bool

returns true if the current value can be represented as an array

#[must_use]pub fn get_array<Q>(&self, k: &Q) -> Option<&Self::Array> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a array

#[must_use]pub fn is_object(&self) -> bool

returns true if the current value can be represented as an object

#[must_use]pub fn get_object<Q>(&self, k: &Q) -> Option<&Self::Object> where
    Q: Hash + Eq + Ord + ?Sized,
    Self::Key: Borrow<Q>,
    Self::Key: Hash,
    Self::Key: Eq, 

Tries to get an element of an object as a object

impl<'value> Writable for Value<'value>

fn encode(&self) -> String

Encodes the value into it's JSON representation as a string

fn encode_pp(&self) -> String

Encodes the value into it's JSON representation as a string (pretty printed)

fn write<'writer, W>(&self, w: &mut W) -> Result<()> where
    W: 'writer + Write, 

Encodes the value into it's JSON representation into a Writer

fn write_pp<'writer, W>(&self, w: &mut W) -> Result<()> where
    W: 'writer + Write, 

Encodes the value into it's JSON representation into a Writer, pretty printed