Enum simd_json::value::borrowed::Value

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

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

Variants

Static(StaticNode)

Static values

String(Cow<'v, str>)

string type

Array(Vec<Value<'v>>)

array type

Object(Box<Object<'v>>)

object type

Methods

impl<'value> Value<'value>

pub fn encode(&self) -> String

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

pub fn encode_pp(&self) -> String

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

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

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

pub 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

impl<'v> Value<'v>

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.

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<'v> ValueBuilder for Value<'v>

fn null() -> Self

Returns anull value

fn array_with_capacity(capacity: usize) -> Self

Returns an empty array with a given capacity

fn object_with_capacity(capacity: usize) -> Self

Returns an empty object with a given capacity

fn array() -> Self

Returns an empty array

fn object() -> Self

Returns an empty object

impl<'v> MutableValue for Value<'v>

type Key = Cow<'v, str>

The type for Objects

fn as_array_mut(&mut self) -> Option<&mut Vec<Value<'v>>>

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

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

fn insert<K, V>(&mut self, k: K, v: V) -> Result<Option<Self>, AccessError> where
    K: Into<Self::Key>,
    V: Into<Self>,
    Self::Key: Hash + 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

fn remove<Q: ?Sized>(&mut self, k: &Q) -> Result<Option<Self>, AccessError> where
    Self::Key: Borrow<Q> + Hash + Eq,
    Q: Hash + 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

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::NotAnArrayif called on aValuethat isn't anArray- otherwise will behave the same asVec::push`

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

Tries to pop from this Value as an Array. Will return an AccessError::NotAnArrayif called on aValuethat isn't anArray- otherwise will behave the same asVec::pop`

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

Same as get but returns a mutable ref instead

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

Same as get_idx but returns a mutable ref instead

impl<'v> Value for Value<'v>

type Key = Cow<'v, str>

The type for Objects

fn value_type(&self) -> ValueType

Returns the type of the current Valye

fn is_null(&self) -> bool

returns true if the current value is null

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

Tries to represent the value as a bool

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

Tries to represent the value as an i64

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

Tries to represent the value as an u64

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

Tries to represent the value as a f64

fn cast_f64(&self) -> Option<f64>

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

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

Tries to represent the value as a &str

fn as_array(&self) -> Option<&Vec<Value<'v>>>

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

fn as_object(&self) -> Option<&HashMap<Self::Key, Self>>

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

fn get<Q: ?Sized>(&self, k: &Q) -> Option<&Self> where
    Self::Key: Borrow<Q> + Hash + Eq,
    Q: Hash + 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.

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.

fn is_bool(&self) -> bool

returns true if the current value a bool

fn as_i128(&self) -> Option<i128>

Tries to represent the value as an i128

fn is_i128(&self) -> bool

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

fn is_i64(&self) -> bool

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

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

Tries to represent the value as an i32

fn is_i32(&self) -> bool

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

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

Tries to represent the value as an i16

fn is_i16(&self) -> bool

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

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

Tries to represent the value as an i8

fn is_i8(&self) -> bool

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

fn as_u128(&self) -> Option<u128>

Tries to represent the value as an u128

fn is_u128(&self) -> bool

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

fn is_u64(&self) -> bool

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

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

Tries to represent the value as an usize

fn is_usize(&self) -> bool

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

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

Tries to represent the value as an u32

fn is_u32(&self) -> bool

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

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

Tries to represent the value as an u16

fn is_u16(&self) -> bool

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

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

Tries to represent the value as an u8

fn is_u8(&self) -> bool

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

fn is_f64(&self) -> bool

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

fn is_f64_castable(&self) -> bool

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

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

Tries to represent the value as a f32

fn is_f32(&self) -> bool

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

fn is_str(&self) -> bool

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

fn is_array(&self) -> bool

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

fn is_object(&self) -> bool

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

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

fn from(b: OwnedValue) -> Self

Performs the conversion.

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

fn from(s: StaticNode) -> Self

Performs the conversion.

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

fn from(s: &'v str) -> Self

Performs the conversion.

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

fn from(c: Cow<'v, str>) -> Self

Performs the conversion.

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

fn from(s: String) -> Self

Performs the conversion.

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

fn from(b: bool) -> Self

Performs the conversion.

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

fn from(_b: ()) -> Self

Performs the conversion.

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

fn from(i: i8) -> Self

Performs the conversion.

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

fn from(i: i16) -> Self

Performs the conversion.

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

fn from(i: i32) -> Self

Performs the conversion.

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

fn from(i: i64) -> Self

Performs the conversion.

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

fn from(i: u8) -> Self

Performs the conversion.

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

fn from(i: u16) -> Self

Performs the conversion.

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

fn from(i: u32) -> Self

Performs the conversion.

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

fn from(i: u64) -> Self

Performs the conversion.

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

fn from(i: usize) -> Self

Performs the conversion.

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

fn from(f: f32) -> Self

Performs the conversion.

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

fn from(f: f64) -> Self

Performs the conversion.

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

fn from(v: Vec<S>) -> Self

Performs the conversion.

impl<'v> From<HashMap<Cow<'v, str>, Value<'v>, ABuildHasher>> for Value<'v>

fn from(v: Object<'v>) -> Self

Performs the conversion.

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

fn from(b: BorrowedValue) -> Self

Performs the conversion.

impl<'v> Clone for Value<'v>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'v> Default for Value<'v>

fn default() -> Self

Returns the "default value" for a type.

impl<'a> PartialEq<Value<'a>> for Value<'a>

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

impl<'a> PartialEq<Value> for Value<'a>

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

impl<'_> PartialEq<Value<'_>> for Value

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

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

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

This method tests for !=.

impl<'v> Debug for Value<'v>

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

Formats the value using the given formatter.

impl<'v> Display for Value<'v>

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

Formats the value using the given formatter.

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<'v, '_> Index<&'_ str> for Value<'v>

type Output = Value<'v>

The returned type after indexing.

fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

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

type Output = Value<'v>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'v, '_> IndexMut<&'_ str> for Value<'v>

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

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

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

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

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

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

fn from_iter<I: IntoIterator<Item = V>>(iter: I) -> Self

Creates a value from an iterator.

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

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

Creates a value from an iterator.

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

Hint that the Deserialize type is expecting an optional value.

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

Hint that the Deserialize type is expecting a unit value.

fn deserialize_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_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

fn deserialize_enum<V>(
    self,
    name: &'static str,
    variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

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

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

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

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

fn is_human_readable(&self) -> bool

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

impl<'a> Serialize for Value<'a>

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

Serialize this value into the given Serde serializer.

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.