Enum serialize::json::Json

pub enum Json {
    I64(i64),
    U64(u64),
    F64(f64),
    String(String),
    Boolean(bool),
    Array(Array),
    Object(Object),
    Null,
}

Represents a json value

Variants

I64(i64)U64(u64)F64(f64)String(String)Boolean(bool)Array(Array)Object(Object)Null

Methods

impl Json

pub fn pretty(&self) -> PrettyJson

Borrow this json object as a pretty object to generate a pretty representation for it via Display.

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

If the Json 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 Json>

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

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

If the Json 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 Json value is not an Object, returns None.

pub fn is_object(&self) -> bool

Returns true if the Json value is an Object. Returns false otherwise.

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

If the Json value is an Object, returns the associated BTreeMap. Returns None otherwise.

pub fn is_array(&self) -> bool

Returns true if the Json value is an Array. Returns false otherwise.

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

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

pub fn is_string(&self) -> bool

Returns true if the Json value is a String. Returns false otherwise.

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

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

pub fn is_number(&self) -> bool

Returns true if the Json value is a Number. Returns false otherwise.

pub fn is_i64(&self) -> bool

Returns true if the Json value is a i64. Returns false otherwise.

pub fn is_u64(&self) -> bool

Returns true if the Json value is a u64. Returns false otherwise.

pub fn is_f64(&self) -> bool

Returns true if the Json value is a f64. Returns false otherwise.

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

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

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

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

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

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

pub fn is_boolean(&self) -> bool

Returns true if the Json value is a Boolean. Returns false otherwise.

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

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

pub fn is_null(&self) -> bool

Returns true if the Json value is a Null. Returns false otherwise.

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

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

Trait Implementations

impl Clone for Json

fn clone(&self) -> Json

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Json

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

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

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

This method tests for !=.

impl PartialOrd for Json

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

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

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

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

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

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

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

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

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

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

impl Debug for Json

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

Formats the value using the given formatter.

impl Encodable for Json

fn encode<E: Encoder>(&self, e: &mut E) -> Result<(), E::Error>

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

type Output = Json

The returned type after indexing.

fn index(&self, idx: &'a str) -> &Json

Performs the indexing (container[index]) operation.

impl Index<usize> for Json

type Output = Json

The returned type after indexing.

fn index(&self, idx: usize) -> &Json

Performs the indexing (container[index]) operation.

impl ToJson for Json

fn to_json(&self) -> Json

Converts the value of self to an instance of JSON

impl Display for Json

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

Encodes a json value into a string

impl FromStr for Json

type Err = BuilderError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Json, BuilderError>

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