Struct ijson::IValue

#[repr(transparent)]
pub struct IValue { /* fields omitted */ }

Stores an arbitrary JSON value.

Compared to serde_json::Value this type is a struct rather than an enum, as this is necessary to achieve the important size reductions. This means that you cannot directly match on an IValue to determine its type.

Instead, an IValue offers several ways to get at the inner type:

• Destructuring using IValue::destructure[{_ref,_mut}]()

  These methods return wrapper enums which you can directly match on, so these methods are the most direct replacement for matching on a Value.

• Borrowing using IValue::as_{array,object,string,number}[_mut]()

  These methods return an Option of the corresponding reference if the type matches the one expected. These methods exist for the variants which are not Copy.

• Converting using IValue::into_{array,object,string,number}()

  These methods return a Result of the corresponding type (or the original IValue if the type is not the one expected). These methods also exist for the variants which are not Copy.

• Getting using IValue::to_{bool,{i,u,f}{32,64}}[_lossy]}()

  These methods return an Option of the corresponding type. These methods exist for types where the return value would be Copy.

You can also check the type of the inner value without specifically accessing it using one of these methods:

• Checking using IValue::is_{null,bool,number,string,array,object,true,false}()

  These methods exist for all types.

• Getting the type with IValue::type_

  This method returns the ValueType enum, which has a variant for each of the six JSON types.

Implementations

impl IValue

pub const NULL: Self

JSON null.

pub const FALSE: Self

JSON false.

pub const TRUE: Self

JSON true.

pub fn type_(&self) -> ValueType

Returns the type of this value.

pub fn destructure(self) -> Destructured

Destructures this value into an enum which can be matched on.

pub fn destructure_ref(&self) -> DestructuredRef<'_>

Destructures a reference to this value into an enum which can be matched on.

pub fn destructure_mut(&mut self) -> DestructuredMut<'_>

Destructures a mutable reference to this value into an enum which can be matched on.

pub fn get(&self, index: impl ValueIndex) -> Option<&IValue>

Indexes into this value with a number or string. Panics if the value is not an array or object. Panics if attempting to index an array with a string. Panics if attempting to index an object with a number. Returns None if the index type is correct, but there is no value at this index.

pub fn get_mut(&mut self, index: impl ValueIndex) -> Option<&mut IValue>

Mutably indexes into this value with a number or string. Panics if the value is not an array or object. Panics if attempting to index an array with a string. Panics if attempting to index an object with a number. Returns None if the index type is correct, but there is no value at this index.

pub fn remove(&mut self, index: impl ValueIndex) -> Option<IValue>

Removes a value at the specified numberic or string index. Panics if this is not an array or object. Panics if attempting to index an array with a string. Panics if attempting to index an object with a number. Returns None if the index type is correct, but there is no value at this index.

pub fn take(&mut self) -> IValue

Takes this value, replacing it with IValue::NULL.

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

Returns the length of this value if it is an array or object. Returns None for other types.

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

Returns whether this value is empty if it is an array or object. Returns None for other types.

pub fn is_null(&self) -> bool

Returns true if this is the null value.

pub fn is_bool(&self) -> bool

Returns true if this is a boolean.

pub fn is_true(&self) -> bool

Returns true if this is the true value.

pub fn is_false(&self) -> bool

Returns true if this is the false value.

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

Converts this value to a bool. Returns None if it’s not a boolean.

pub fn is_number(&self) -> bool

Returns true if this is a number.

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

Gets a reference to this value as an INumber. Returns None if it’s not a number.

pub fn as_number_mut(&mut self) -> Option<&mut INumber>

Gets a mutable reference to this value as an INumber. Returns None if it’s not a number.

pub fn into_number(self) -> Result<INumber, IValue>

Converts this value to an INumber. Returns Err(self) if it’s not a number.

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

Converts this value to an i64 if it is a number that can be represented exactly.

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

Converts this value to a u64 if it is a number that can be represented exactly.

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

Converts this value to an f64 if it is a number that can be represented exactly.

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

Converts this value to an f32 if it is a number that can be represented exactly.

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

Converts this value to an i32 if it is a number that can be represented exactly.

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

Converts this value to a u32 if it is a number that can be represented exactly.

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

Converts this value to an isize if it is a number that can be represented exactly.

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

Converts this value to a usize if it is a number that can be represented exactly.

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

Converts this value to an f64 if it is a number, potentially losing precision in the process.

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

Converts this value to an f32 if it is a number, potentially losing precision in the process.

pub fn is_string(&self) -> bool

Returns true if this is a string.

pub fn as_string(&self) -> Option<&IString>

Gets a reference to this value as an IString. Returns None if it’s not a string.

pub fn as_string_mut(&mut self) -> Option<&mut IString>

Gets a mutable reference to this value as an IString. Returns None if it’s not a string.

pub fn into_string(self) -> Result<IString, IValue>

Converts this value to an IString. Returns Err(self) if it’s not a string.

pub fn is_array(&self) -> bool

Returns true if this is an array.

pub fn as_array(&self) -> Option<&IArray>

Gets a reference to this value as an IArray. Returns None if it’s not an array.

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

Gets a mutable reference to this value as an IArray. Returns None if it’s not an array.

pub fn into_array(self) -> Result<IArray, IValue>

Converts this value to an IArray. Returns Err(self) if it’s not an array.

pub fn is_object(&self) -> bool

Returns true if this is an object.

pub fn as_object(&self) -> Option<&IObject>

Gets a reference to this value as an IObject. Returns None if it’s not an object.

pub fn as_object_mut(&mut self) -> Option<&mut IObject>

Gets a mutable reference to this value as an IObject. Returns None if it’s not an object.

pub fn into_object(self) -> Result<IObject, IValue>

Converts this value to an IObject. Returns Err(self) if it’s not an object.

Trait Implementations

impl AsMut<IValue> for IArray

fn as_mut(&mut self) -> &mut IValue

Performs the conversion.

impl AsMut<IValue> for INumber

fn as_mut(&mut self) -> &mut IValue

Performs the conversion.

impl AsMut<IValue> for IObject

fn as_mut(&mut self) -> &mut IValue

Performs the conversion.

impl AsMut<IValue> for IString

fn as_mut(&mut self) -> &mut IValue

Performs the conversion.

impl AsRef<IValue> for IArray

fn as_ref(&self) -> &IValue

Performs the conversion.

impl AsRef<IValue> for INumber

fn as_ref(&self) -> &IValue

Performs the conversion.

impl AsRef<IValue> for IObject

fn as_ref(&self) -> &IValue

Performs the conversion.

impl AsRef<IValue> for IString

fn as_ref(&self) -> &IValue

Performs the conversion.

impl Borrow<IValue> for IArray

fn borrow(&self) -> &IValue

Immutably borrows from an owned value.

impl Borrow<IValue> for INumber

fn borrow(&self) -> &IValue

Immutably borrows from an owned value.

impl Borrow<IValue> for IObject

fn borrow(&self) -> &IValue

Immutably borrows from an owned value.

impl Borrow<IValue> for IString

fn borrow(&self) -> &IValue

Immutably borrows from an owned value.

impl BorrowMut<IValue> for IArray

fn borrow_mut(&mut self) -> &mut IValue

Mutably borrows from an owned value.

impl BorrowMut<IValue> for INumber

fn borrow_mut(&mut self) -> &mut IValue

Mutably borrows from an owned value.

impl BorrowMut<IValue> for IObject

fn borrow_mut(&mut self) -> &mut IValue

Mutably borrows from an owned value.

impl BorrowMut<IValue> for IString

fn borrow_mut(&mut self) -> &mut IValue

Mutably borrows from an owned value.

impl Clone for IValue

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IValue

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

Formats the value using the given formatter.

impl Default for IValue

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

Hint that the Deserialize type is expecting an i64 value.

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

Hint that the Deserialize type is expecting a u64 value.

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

Hint that the Deserialize type is expecting a f64 value.

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: &'static 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, 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, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a bool value.

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

Hint that the Deserialize type is expecting an i128 value.

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

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

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

impl Drop for IValue

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Into<IValue> + Clone> From<&'_ [T]> for IValue

fn from(other: &[T]) -> Self

Performs the conversion.

impl From<&'_ String> for IValue

fn from(other: &String) -> Self

Performs the conversion.

impl From<&'_ mut String> for IValue

fn from(other: &mut String) -> Self

Performs the conversion.

impl From<&'_ mut str> for IValue

fn from(other: &mut str) -> Self

Performs the conversion.

impl From<&'_ str> for IValue

fn from(other: &str) -> Self

Performs the conversion.

impl<K: Into<IString>, V: Into<IValue>> From<BTreeMap<K, V>> for IValue

fn from(other: BTreeMap<K, V>) -> Self

Performs the conversion.

impl<K: Into<IString>, V: Into<IValue>> From<HashMap<K, V, RandomState>> for IValue

fn from(other: HashMap<K, V>) -> Self

Performs the conversion.

impl From<IArray> for IValue

fn from(other: IArray) -> Self

Performs the conversion.

impl From<INumber> for IValue

fn from(other: INumber) -> Self

Performs the conversion.

impl From<IObject> for IValue

fn from(other: IObject) -> Self

Performs the conversion.

impl From<IString> for IValue

fn from(other: IString) -> Self

Performs the conversion.

impl<T: Into<IValue>> From<Option<T>> for IValue

fn from(other: Option<T>) -> Self

Performs the conversion.

impl From<String> for IValue

fn from(other: String) -> Self

Performs the conversion.

impl<T: Into<IValue>> From<Vec<T, Global>> for IValue

fn from(other: Vec<T>) -> Self

Performs the conversion.

impl From<bool> for IValue

fn from(other: bool) -> Self

Performs the conversion.

impl From<f32> for IValue

fn from(v: f32) -> Self

Performs the conversion.

impl From<f64> for IValue

fn from(v: f64) -> Self

Performs the conversion.

impl From<i16> for IValue

fn from(other: i16) -> Self

Performs the conversion.

impl From<i32> for IValue

fn from(other: i32) -> Self

Performs the conversion.

impl From<i64> for IValue

fn from(other: i64) -> Self

Performs the conversion.

impl From<i8> for IValue

fn from(other: i8) -> Self

Performs the conversion.

impl From<isize> for IValue

fn from(other: isize) -> Self

Performs the conversion.

impl From<u16> for IValue

fn from(other: u16) -> Self

Performs the conversion.

impl From<u32> for IValue

fn from(other: u32) -> Self

Performs the conversion.

impl From<u64> for IValue

fn from(other: u64) -> Self

Performs the conversion.

impl From<u8> for IValue

fn from(other: u8) -> Self

Performs the conversion.

impl From<usize> for IValue

fn from(other: usize) -> Self

Performs the conversion.

impl Hash for IValue

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<I: ValueIndex> Index<I> for IValue

type Output = IValue

The returned type after indexing.

fn index(&self, index: I) -> &IValue

Performs the indexing (container[index]) operation.

impl<I: ValueIndex> IndexMut<I> for IValue

fn index_mut(&mut self, index: I) -> &mut IValue

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

impl PartialEq<IValue> for IValue

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<IValue> for IValue

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for IValue

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a IValue> for &'a IArray

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a IValue> for &'a INumber

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a IValue> for &'a IObject

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a IValue> for &'a IString

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a mut IValue> for &'a mut IArray

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a mut IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a mut IValue> for &'a mut INumber

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a mut IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a mut IValue> for &'a mut IObject

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a mut IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a mut IValue> for &'a mut IString

type Error = ()

The type returned in the event of a conversion error.

fn try_from(other: &'a mut IValue) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<IValue> for IArray

type Error = IValue

The type returned in the event of a conversion error.

fn try_from(other: IValue) -> Result<Self, IValue>

Performs the conversion.

impl TryFrom<IValue> for INumber

type Error = IValue

The type returned in the event of a conversion error.

fn try_from(other: IValue) -> Result<Self, IValue>

Performs the conversion.

impl TryFrom<IValue> for IObject

type Error = IValue

The type returned in the event of a conversion error.

fn try_from(other: IValue) -> Result<Self, IValue>

Performs the conversion.

impl TryFrom<IValue> for IString

type Error = IValue

The type returned in the event of a conversion error.

fn try_from(other: IValue) -> Result<Self, IValue>

Performs the conversion.

impl Eq for IValue

impl Send for IValue

impl Sync for IValue