Struct validators::json_object::JSONObject

pub struct JSONObject { /* fields omitted */ }

Methods

impl JSONObject

pub fn get_json_value(&self) -> &Value

pub fn get_full_json_object(&self) -> &str

pub fn into_map(self) -> Map<String, Value>

pub fn into_value(self) -> Value

pub fn into_string(self) -> String

impl JSONObject

pub fn from_string(full_json_object: String) -> Result<Self, JSONObjectError>

pub fn from_str(full_json_object: &str) -> Result<Self, JSONObjectError>

Methods from Deref<Target = Map<String, Value>>

pub fn clear(&mut self)

Clears the map, removing all values.

pub fn get<Q>(&self, key: &Q) -> Option<&Value> where
    Q: Ord + Eq + Hash + ?Sized,
    String: Borrow<Q>, 

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn contains_key<Q>(&self, key: &Q) -> bool where
    Q: Ord + Eq + Hash + ?Sized,
    String: Borrow<Q>, 

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value> where
    Q: Ord + Eq + Hash + ?Sized,
    String: Borrow<Q>, 

Returns a mutable reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn insert(&mut self, k: String, v: Value) -> Option<Value>

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned.

pub fn remove<Q>(&mut self, key: &Q) -> Option<Value> where
    Q: Ord + Eq + Hash + ?Sized,
    String: Borrow<Q>, 

Removes a key from the map, returning the value at the key if the key was previously in the map.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn entry<S>(&mut self, key: S) -> Entry where
    S: Into<String>, 

Gets the given key's corresponding entry in the map for in-place manipulation.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn iter(&self) -> Iter

Gets an iterator over the entries of the map.

pub fn iter_mut(&mut self) -> IterMut

Gets a mutable iterator over the entries of the map.

pub fn keys(&self) -> Keys

Gets an iterator over the keys of the map.

pub fn values(&self) -> Values

Gets an iterator over the values of the map.

pub fn values_mut(&mut self) -> ValuesMut

Gets an iterator over mutable values of the map.

Trait Implementations

impl Validated for JSONObject

impl ValidatedWrapper for JSONObject

type Error = JSONObjectError

fn from_string(json_object: String) -> Result<Self, Self::Error>

fn from_str(json_object: &str) -> Result<Self, Self::Error>

impl Clone for JSONObject

fn clone(&self) -> JSONObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<JSONObject> for JSONObject

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: &Self) -> bool

This method tests for !=.

impl Eq for JSONObject

impl DerefMut for JSONObject

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for JSONObject

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

Formats the value using the given formatter.

impl Debug for JSONObject

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

Formats the value using the given formatter.

impl Deref for JSONObject

type Target = Map<String, Value>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for JSONObject

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<'a> FromFormValue<'a> for JSONObject

type Error = JSONObjectError

The associated error which can be returned from parsing. It is a good idea to have the return type be or contain an &'v str so that the unparseable string can be examined after a bad parse.

fn from_form_value(form_value: &'a RawStr) -> Result<Self, Self::Error>

Parses an instance of Self from an HTTP form field value or returns an Error if one cannot be parsed.

fn default() -> Option<Self>

Returns a default value to be used when the form field does not exist. If this returns None, then the field is required. Otherwise, this should return Some(default_value). The default implementation simply returns None.

impl<'a> FromParam<'a> for JSONObject

type Error = JSONObjectError

The associated error to be returned if parsing/validation fails.

fn from_param(param: &'a RawStr) -> Result<Self, Self::Error>

Parses and validates an instance of Self from a path parameter string or returns an Error if parsing or validation fails.

impl Serialize for JSONObject

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for JSONObject

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

Deserialize this value from the given Serde deserializer.