Struct Json 

#[repr(C)]
pub struct Json {
    pub value_type: JsonType,
    pub internal: JsonInternal,
}

A generic JSON value that can hold any JSON type

Fields

value_type: JsonType

The type of this JSON value

internal: JsonInternal

Internal storage - interpretation depends on value_type For objects/arrays, this contains serialized data

Implementations

impl Json

pub fn null() -> Self

Create a null JSON value

pub fn bool(value: bool) -> Self

Create a boolean JSON value

pub fn number(value: f64) -> Self

Create a number JSON value (floating-point)

pub fn integer(value: i64) -> Self

Create an integer JSON value.

Note: the value is stored as f64 internally, so i64 values with magnitude greater than 2^53 will lose precision silently.

pub fn string(value: impl Into<String>) -> Self

Create a string JSON value

pub fn is_null(&self) -> bool

Check if this is null

pub fn is_bool(&self) -> bool

Check if this is a boolean

pub fn is_number(&self) -> bool

Check if this is a number

pub fn is_string(&self) -> bool

Check if this is a string

pub fn is_array(&self) -> bool

Check if this is an array

pub fn is_object(&self) -> bool

Check if this is an object

pub fn as_bool(&self) -> OptionBool

Get as boolean (returns None if not a bool)

pub fn as_number(&self) -> OptionF64

Get as number (returns None if not a number)

pub fn as_i64(&self) -> OptionI64

Get as integer (returns None if not a number or not an integer)

pub fn as_string(&self) -> OptionString

Get as string (returns None if not a string)

pub fn raw_string(&self) -> &str

Get the raw internal string value (for arrays/objects this is the serialized JSON)

impl Json

pub fn parse(s: &str) -> Result<Self, JsonParseError>

Parse JSON from a string.

Errors

Returns JsonParseError (message plus line/column) if s is not well-formed JSON.

pub fn parse_bytes(bytes: &[u8]) -> Result<Self, JsonParseError>

Parse JSON from bytes (UTF-8).

Errors

Returns JsonParseError (message plus line/column) if bytes is not well-formed UTF-8 JSON.

pub fn from_serde_value(value: Value) -> Self

Convert from serde_json::Value

pub fn to_serde_value(&self) -> Value

Convert this Json to a serde_json::Value

pub fn array(values: JsonVec) -> Self

Create a JSON array from a vector of JSON values

pub fn object(entries: JsonKeyValueVec) -> Self

Create a JSON object from key-value pairs

pub fn len(&self) -> usize

Get the number of elements (for arrays) or keys (for objects)

pub fn is_empty(&self) -> bool

Check if empty (for arrays/objects)

pub fn get_index(&self, index: usize) -> Option<Self>

Get array element by index

pub fn get_key(&self, key: &str) -> Option<Self>

Get object value by key

pub fn keys(&self) -> Vec<AzString>

Get all keys of an object

pub fn to_array(&self) -> Option<JsonVec>

Convert array to Vec

pub fn to_object(&self) -> Option<JsonKeyValueVec>

Convert object to Vec

pub fn to_json_string(&self) -> AzString

Serialize to JSON string (returns AzString)

pub fn to_string_pretty(&self) -> AzString

Serialize to pretty-printed JSON string

pub fn jq(&self, path: &str) -> Self

Access a nested value using a JSON Pointer (RFC 6901).

pub fn jq_all(&self, path: &str) -> JsonVec

Access nested values using a JSON Pointer with wildcard support.

Trait Implementations

impl Clone for Json

fn clone(&self) -> Json

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Json

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

Formats the value using the given formatter.

impl Default for Json

Json::null(). A default that is JSON null, rather than an empty string masquerading as a value.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Json

Available on crate feature serde-json only.

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

Deserialize this value from the given Serde deserializer.

impl Display for Json

Note: the Display output is meant for human-readable / debug display. String values are quoted but not JSON-escaped (no backslash escaping of embedded quotes, newlines, etc.). Use to_json_string() (requires the serde-json feature) when valid JSON output is needed.

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

Formats the value using the given formatter.

impl Extend<Json> for JsonVec

fn extend<T: IntoIterator<Item = Json>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Json> for JsonVec

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = Json>,

Creates a value from an iterator.

impl PartialEq for Json

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Json

Available on crate feature serde-json only.

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

Serialize as the JSON value this represents, not as its repr(C) fields.

Without this, a struct holding a Json field cannot derive Serialize at all — and the obvious workaround, storing the payload as a String of JSON, produces escaped JSON-inside-JSON that every consumer has to parse twice and nothing validates.

impl StructuralPartialEq for Json