Enum nu_json::value::Value

pub enum Value {
    Null,
    Bool(bool),
    I64(i64),
    U64(u64),
    F64(f64),
    String(String),
    Array(Vec<Value>),
    Object(Map<String, Value>),
}

Represents a Hjson/JSON value

Variants

Null

Represents a JSON null value

Bool(bool)

Represents a JSON Boolean

I64(i64)

Represents a JSON signed integer

U64(u64)

Represents a JSON unsigned integer

F64(f64)

Represents a JSON floating point number

String(String)

Represents a JSON string

Array(Vec<Value>)

Represents a JSON array

Object(Map<String, Value>)

Represents a JSON object

Implementations

impl Value

pub fn find<'a>(&'a self, key: &str) -> Option<&'a Value>

If the Value is an Object, returns the value associated with the provided key. Otherwise, returns None.

pub fn find_path<'a>(&'a self, keys: &[&str]) -> Option<&'a Value>

Attempts to get a nested Value Object for each key in keys. If any key is found not to exist, find_path will return None. Otherwise, it will return the Value associated with the final key.

pub fn pointer<'a>(&'a self, pointer: &str) -> Option<&'a Value>

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.

pub fn search<'a>(&'a self, key: &str) -> Option<&'a Value>

If the Value is an Object, performs a depth-first search until a value associated with the provided key is found. If no value is found or the Value is not an Object, returns None.

pub fn is_object(&self) -> bool

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

pub fn as_object(&self) -> Option<&Map<String, Value>>

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

pub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>>

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

pub fn is_array(&self) -> bool

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

pub fn as_array(&self) -> Option<&[Value]>

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

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

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

pub fn is_string(&self) -> bool

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

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

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

pub fn is_number(&self) -> bool

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

pub fn is_i64(&self) -> bool

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

pub fn is_u64(&self) -> bool

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

pub fn is_f64(&self) -> bool

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

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

If the Value is a number, return or cast it to a i64. Returns None otherwise.

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

If the Value is a number, return or cast it to a u64. Returns None otherwise.

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

If the Value is a number, return or cast it to a f64. Returns None otherwise.

pub fn is_boolean(&self) -> bool

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

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

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

pub fn is_null(&self) -> bool

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

pub fn as_null(&self) -> Option<()>

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

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Serializes a Hjson value into a string

impl<'de> Deserialize<'de> for Value

fn deserialize<D>(deserializer: D) -> Result<Value, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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_enum<V>( self, _name: &str, _variants: &'static [&'static str], visitor: V ) -> Result<V::Value, Error>

where V: Visitor<'de>,

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

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_bool<V>( self, visitor: V ) -> Result<V::Value, <Self as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::Error>

where V: Visitor<'de>,

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

fn deserialize_seq<V>( self, visitor: V ) -> Result<V::Value, <Self as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::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 as Deserializer<'de>>::Error>

where V: Visitor<'de>,

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

fn deserialize_identifier<V>( self, visitor: V ) -> Result<V::Value, <Self as Deserializer<'de>>::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 as Deserializer<'de>>::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 Display for Value

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

Serializes a Hjson value into a string

impl FromStr for Value

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Value, Error>

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

impl PartialEq for Value

fn eq(&self, other: &Value) -> 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 Serialize for Value

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Value