Enum Json

pub enum Json {
    Array(Box<[Json]>),
    Object(Map<Box<str>, Json>),
    String(Box<str>),
    Number(f64),
    True,
    False,
    Null,
}

Represents a JSON object

Variants

Array(Box<[Json]>)

Object(Map<Box<str>, Json>)

String(Box<str>)

Number(f64)

True

False

Null

Implementations

impl Json

pub fn deserialize(text: impl AsRef<str>) -> Result<Json, Error>

Deserializes the given string into a Json object

Configuration used

max_depth = u32::MAX

recover_from_errors = false

pub fn deserialize_with_config( text: impl AsRef<str>, conf: JsonConfig, ) -> Result<Json, Error>

Deserializes the given string into a Json object using the given JsonConfig

pub fn serialize(&self, out: &mut dyn Write) -> Result

Serializes the JSON object into a fmt::Write

pub fn get(&self, key: impl AsRef<str>) -> Option<&Json>

Attempts to get a value of the given json object. If the json enum is not an Object variant, or if it doesn’t contain the key, returns None

pub fn get_mut(&mut self, key: impl AsRef<str>) -> Option<&mut Json>

Same as get, but with a mutable reference

pub fn nth(&self, i: usize) -> Option<&Json>

Attempts to get a value of the given json array. If the json enum is not an Array variant, or if it doesn’t contain the key, returns None

pub fn nth_mut(&mut self, i: usize) -> Option<&mut Json>

Same as nth, but with a mutable reference

pub const fn number(&self) -> Option<f64>

Attempts to get the inner Number of the json object, if it is a Number variant

pub const fn expect_number(&self) -> f64

Expects the json object to be a Number variant

Panics

If the json object is not a Number variant

pub const fn number_mut(&mut self) -> Option<&mut f64>

Attempts to get a mutable reference to the inner Number of the json object, if it is a Number variant

pub const fn expect_number_mut(&mut self) -> &mut f64

Expects the json object to be a Number variant and gets a mutable reference to the inner number.

Panics

If the json object is not a Number variant

pub const fn string(&self) -> Option<&str>

Attempts to get the inner String of the json object, if it is a String variant

pub const fn expect_string(&self) -> &str

Expects the json object to be a String variant

Panics

If the json object is not a String variant

pub const fn string_mut(&mut self) -> Option<&mut str>

Attempts to get a mutable reference to the inner String of the json object, if it is a String variant

pub const fn expect_string_mut(&mut self) -> &mut str

Expects the json object to be a String variant and gets a reference to the inner string

Panics

If the json object is not a String variant

pub const fn object(&self) -> Option<&Map<Box<str>, Json>>

Attempts to get the inner Object of the json object, if it is an Object variant

pub const fn expect_object(&self) -> &Map<Box<str>, Json>

Expects the json object to be a Object variant and gets a reference to the inner object

Panics

If the json object is not a Object variant

pub const fn object_mut(&mut self) -> Option<&mut Map<Box<str>, Json>>

Attempts to get a mutable reference to the inner Object of the json element, if it is an Object variant

pub const fn expect_object_mut(&mut self) -> &mut Map<Box<str>, Json>

Expects the json object to be a Object variant and gets a mutable reference to the inner object

Panics

If the json object is not a Object variant

pub const fn array(&self) -> Option<&[Json]>

Attempts to get the inner Array of the json object, if it is an Array variant

pub const fn expect_array(&self) -> &[Json]

Expects the json object to be a Array variant

Panics

If the json object is not a Array variant

pub const fn array_mut(&mut self) -> Option<&mut [Json]>

Attempts to get the inner Array of the json object, if it is an Array variant

pub const fn expect_array_mut(&mut self) -> &mut [Json]

Expects the json object to be a Array variant

Panics

If the json object is not a Array variant

pub const fn boolean(&self) -> Option<bool>

Attempts to get the inner boolean value of the json object, if it is a True or False variant

pub const fn expect_boolean(&self) -> bool

Expects the json object to be a True or False variant

Panics

If the json object is not a True or False variant

pub const fn is_null(&self) -> bool

Returns true if the json is a Nil variant

Trait Implementations

impl Add<f32> for Json

type Output = Json

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> Self::Output

Performs the + operation.

impl Add<f64> for Json

type Output = Json

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> Self::Output

Performs the + operation.

impl Add<i16> for Json

type Output = Json

The resulting type after applying the + operator.

fn add(self, rhs: i16) -> Self::Output

Performs the + operation.

impl Add<i32> for Json

type Output = Json

The resulting type after applying the + operator.

fn add(self, rhs: i32) -> Self::Output

Performs the + operation.

impl Add<u16> for Json

type Output = Json

The resulting type after applying the + operator.

fn add(self, rhs: u16) -> Self::Output

Performs the + operation.

impl Add<u8> for Json

type Output = Json

The resulting type after applying the + operator.

fn add(self, rhs: u8) -> Self::Output

Performs the + operation.

impl AddAssign<f32> for Json

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl AddAssign<f64> for Json

fn add_assign(&mut self, rhs: f64)

Performs the += operation.

impl AddAssign<i16> for Json

fn add_assign(&mut self, rhs: i16)

Performs the += operation.

impl AddAssign<i32> for Json

fn add_assign(&mut self, rhs: i32)

Performs the += operation.

impl AddAssign<u16> for Json

fn add_assign(&mut self, rhs: u16)

Performs the += operation.

impl AddAssign<u8> for Json

fn add_assign(&mut self, rhs: u8)

Performs the += operation.

impl Debug for Json

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

Formats the value using the given formatter.

impl Display for Json

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

Formats the value using the given formatter.

impl Div<f32> for Json

type Output = Json

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl Div<f64> for Json

type Output = Json

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl Div<i16> for Json

type Output = Json

The resulting type after applying the / operator.

fn div(self, rhs: i16) -> Self::Output

Performs the / operation.

impl Div<i32> for Json

type Output = Json

The resulting type after applying the / operator.

fn div(self, rhs: i32) -> Self::Output

Performs the / operation.

impl Div<u16> for Json

type Output = Json

The resulting type after applying the / operator.

fn div(self, rhs: u16) -> Self::Output

Performs the / operation.

impl Div<u8> for Json

type Output = Json

The resulting type after applying the / operator.

fn div(self, rhs: u8) -> Self::Output

Performs the / operation.

impl DivAssign<f32> for Json

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign<f64> for Json

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl DivAssign<i16> for Json

fn div_assign(&mut self, rhs: i16)

Performs the /= operation.

impl DivAssign<i32> for Json

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl DivAssign<u16> for Json

fn div_assign(&mut self, rhs: u16)

Performs the /= operation.

impl DivAssign<u8> for Json

fn div_assign(&mut self, rhs: u8)

Performs the /= operation.

impl<'a> From<&'a str> for Json

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl From<Box<str>> for Json

fn from(value: Box<str>) -> Self

Converts to this type from the input type.

impl From<HashMap<Box<str>, Json>> for Json

fn from(value: Map<Box<str>, Json>) -> Self

Converts to this type from the input type.

impl From<String> for Json

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<Json>> for Json

fn from(value: Vec<Json>) -> Self

Converts to this type from the input type.

impl From<bool> for Json

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Json

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Json

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Json

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Json

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<u16> for Json

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u8> for Json

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Index<&str> for Json

type Output = Json

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Json

type Output = Json

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<&str> for Json

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

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

impl IndexMut<usize> for Json

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

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

impl Mul<f32> for Json

type Output = Json

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl Mul<f64> for Json

type Output = Json

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul<i16> for Json

type Output = Json

The resulting type after applying the * operator.

fn mul(self, rhs: i16) -> Self::Output

Performs the * operation.

impl Mul<i32> for Json

type Output = Json

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Self::Output

Performs the * operation.

impl Mul<u16> for Json

type Output = Json

The resulting type after applying the * operator.

fn mul(self, rhs: u16) -> Self::Output

Performs the * operation.

impl Mul<u8> for Json

type Output = Json

The resulting type after applying the * operator.

fn mul(self, rhs: u8) -> Self::Output

Performs the * operation.

impl MulAssign<f32> for Json

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign<f64> for Json

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl MulAssign<i16> for Json

fn mul_assign(&mut self, rhs: i16)

Performs the *= operation.

impl MulAssign<i32> for Json

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl MulAssign<u16> for Json

fn mul_assign(&mut self, rhs: u16)

Performs the *= operation.

impl MulAssign<u8> for Json

fn mul_assign(&mut self, rhs: u8)

Performs the *= operation.

impl PartialEq for Json

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<f32> for Json

type Output = Json

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Self::Output

Performs the - operation.

impl Sub<f64> for Json

type Output = Json

The resulting type after applying the - operator.

fn sub(self, rhs: f64) -> Self::Output

Performs the - operation.

impl Sub<i16> for Json

type Output = Json

The resulting type after applying the - operator.

fn sub(self, rhs: i16) -> Self::Output

Performs the - operation.

impl Sub<i32> for Json

type Output = Json

The resulting type after applying the - operator.

fn sub(self, rhs: i32) -> Self::Output

Performs the - operation.

impl Sub<u16> for Json

type Output = Json

The resulting type after applying the - operator.

fn sub(self, rhs: u16) -> Self::Output

Performs the - operation.

impl Sub<u8> for Json

type Output = Json

The resulting type after applying the - operator.

fn sub(self, rhs: u8) -> Self::Output

Performs the - operation.

impl SubAssign<f32> for Json

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl SubAssign<f64> for Json

fn sub_assign(&mut self, rhs: f64)

Performs the -= operation.

impl SubAssign<i16> for Json

fn sub_assign(&mut self, rhs: i16)

Performs the -= operation.

impl SubAssign<i32> for Json

fn sub_assign(&mut self, rhs: i32)

Performs the -= operation.

impl SubAssign<u16> for Json

fn sub_assign(&mut self, rhs: u16)

Performs the -= operation.

impl SubAssign<u8> for Json

fn sub_assign(&mut self, rhs: u8)

Performs the -= operation.

impl StructuralPartialEq for Json