Enum raui_core::PrefabValue[][src]

pub enum PrefabValue {
    Null,
    Bool(bool),
    Number(Number),
    String(String),
    Sequence(Vec<Value, Global>),
    Mapping(Mapping),
}
Expand description

Represents any valid YAML value.

Variants

Null

Represents a YAML null value.

Bool(bool)

Represents a YAML boolean.

Number(Number)

Represents a YAML numerical value, whether integer or floating point.

String(String)

Represents a YAML string.

Sequence(Vec<Value, Global>)

Represents a YAML sequence in which the elements are serde_yaml::Value.

Mapping(Mapping)

Represents a YAML mapping in which the keys and values are both serde_yaml::Value.

Implementations

impl Value[src]

pub fn get<I>(&self, index: I) -> Option<&Value> where
    I: Index
[src]

Index into a YAML sequence or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an sequence.

Returns None if the type of self does not match the type of the index, for example if the index is a string and self is a sequence or a number. Also returns None if the given key does not exist in the map or the given index is not within the bounds of the sequence.

let object: Value = yaml(r#"{ A: 65, B: 66, C: 67 }"#);
let x = object.get("A").unwrap();
assert_eq!(x, 65);

let sequence: Value = yaml(r#"[ "A", "B", "C" ]"#);
let x = sequence.get(2).unwrap();
assert_eq!(x, &Value::String("C".into()));

assert_eq!(sequence.get("A"), None);

Square brackets can also be used to index into a value in a more concise way. This returns Value::Null in cases where get would have returned None.

let object = yaml(r#"
---
A: [a, á, à]
B: [b, b́]
C: [c, ć, ć̣, ḉ]
42: true
"#);
assert_eq!(object["B"][0], Value::String("b".into()));

assert_eq!(object[Value::String("D".into())], Value::Null);
assert_eq!(object["D"], Value::Null);
assert_eq!(object[0]["x"]["y"]["z"], Value::Null);

assert_eq!(object[42], Value::Bool(true));

pub fn get_mut<I>(&mut self, index: I) -> Option<&mut Value> where
    I: Index
[src]

Index into a YAML sequence or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an sequence.

Returns None if the type of self does not match the type of the index, for example if the index is a string and self is a sequence or a number. Also returns None if the given key does not exist in the map or the given index is not within the bounds of the sequence.

pub fn is_null(&self) -> bool[src]

Returns true if the Value is a Null. Returns false otherwise.

For any Value on which is_null returns true, as_null is guaranteed to return Some(()).

let v: Value = serde_yaml::from_str("null").unwrap();
assert!(v.is_null());
let v: Value = serde_yaml::from_str("false").unwrap();
assert!(!v.is_null());

pub fn as_null(&self) -> Option<()>[src]

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

let v: Value = serde_yaml::from_str("null").unwrap();
assert_eq!(v.as_null(), Some(()));
let v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_null(), None);

pub fn is_bool(&self) -> bool[src]

Returns true if the Value is a Boolean. Returns false otherwise.

For any Value on which is_boolean returns true, as_bool is guaranteed to return the boolean value.

let v: Value = serde_yaml::from_str("true").unwrap();
assert!(v.is_bool());
let v: Value = serde_yaml::from_str("42").unwrap();
assert!(!v.is_bool());

pub fn as_bool(&self) -> Option<bool>[src]

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

let v: Value = serde_yaml::from_str("true").unwrap();
assert_eq!(v.as_bool(), Some(true));
let v: Value = serde_yaml::from_str("42").unwrap();
assert_eq!(v.as_bool(), None);

pub fn is_number(&self) -> bool[src]

Returns true if the Value is a Number. Returns false otherwise.

let v: Value = serde_yaml::from_str("5").unwrap();
assert!(v.is_number());
let v: Value = serde_yaml::from_str("true").unwrap();
assert!(!v.is_number());

pub fn is_i64(&self) -> bool[src]

Returns true if the Value is an integer between i64::MIN and i64::MAX.

For any Value on which is_i64 returns true, as_i64 is guaranteed to return the integer value.

let v: Value = serde_yaml::from_str("1337").unwrap();
assert!(v.is_i64());
let v: Value = serde_yaml::from_str("null").unwrap();
assert!(!v.is_i64());

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

If the Value is an integer, represent it as i64 if possible. Returns None otherwise.

let v: Value = serde_yaml::from_str("1337").unwrap();
assert_eq!(v.as_i64(), Some(1337));
let v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_i64(), None);

pub fn is_u64(&self) -> bool[src]

Returns true if the Value is an integer between u64::MIN and u64::MAX.

For any Value on which is_u64 returns true, as_u64 is guaranteed to return the integer value.

let v: Value = serde_yaml::from_str("1337").unwrap();
assert!(v.is_u64());
let v: Value = serde_yaml::from_str("null").unwrap();
assert!(!v.is_u64());

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

If the Value is an integer, represent it as u64 if possible. Returns None otherwise.

let v: Value = serde_yaml::from_str("1337").unwrap();
assert_eq!(v.as_u64(), Some(1337));
let v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_u64(), None);

pub fn is_f64(&self) -> bool[src]

Returns true if the Value is a number that can be represented by f64.

For any Value on which is_f64 returns true, as_f64 is guaranteed to return the floating point value.

Currently this function returns true if and only if both is_i64 and is_u64 return false but this is not a guarantee in the future.

let v: Value = serde_yaml::from_str("256.01").unwrap();
assert!(v.is_f64());
let v: Value = serde_yaml::from_str("true").unwrap();
assert!(!v.is_f64());

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

If the Value is a number, represent it as f64 if possible. Returns None otherwise.

let v: Value = serde_yaml::from_str("13.37").unwrap();
assert_eq!(v.as_f64(), Some(13.37));
let v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_f64(), None);

pub fn is_string(&self) -> bool[src]

Returns true if the Value is a String. Returns false otherwise.

For any Value on which is_string returns true, as_str is guaranteed to return the string slice.

let v: Value = serde_yaml::from_str("'lorem ipsum'").unwrap();
assert!(v.is_string());
let v: Value = serde_yaml::from_str("42").unwrap();
assert!(!v.is_string());

pub fn as_str(&self) -> Option<&str>[src]

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

let v: Value = serde_yaml::from_str("'lorem ipsum'").unwrap();
assert_eq!(v.as_str(), Some("lorem ipsum"));
let v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_str(), None);

pub fn is_sequence(&self) -> bool[src]

Returns true if the Value is a sequence. Returns false otherwise.

let v: Value = serde_yaml::from_str("[1, 2, 3]").unwrap();
assert!(v.is_sequence());
let v: Value = serde_yaml::from_str("true").unwrap();
assert!(!v.is_sequence());

pub fn as_sequence(&self) -> Option<&Vec<Value, Global>>[src]

If the Value is a sequence, return a reference to it if possible. Returns None otherwise.

let v: Value = serde_yaml::from_str("[1, 2]").unwrap();
assert_eq!(v.as_sequence(), Some(&vec![Value::Number(Number::from(1)), Value::Number(Number::from(2))]));
let v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_sequence(), None);

pub fn as_sequence_mut(&mut self) -> Option<&mut Vec<Value, Global>>[src]

If the Value is a sequence, return a mutable reference to it if possible. Returns None otherwise.

let mut v: Value = serde_yaml::from_str("[1]").unwrap();
let s = v.as_sequence_mut().unwrap();
s.push(Value::Number(Number::from(2)));
assert_eq!(s, &vec![Value::Number(Number::from(1)), Value::Number(Number::from(2))]);
let mut v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_sequence_mut(), None);

pub fn is_mapping(&self) -> bool[src]

Returns true if the Value is a mapping. Returns false otherwise.

let v: Value = serde_yaml::from_str("a: 42").unwrap();
assert!(v.is_mapping());
let v: Value = serde_yaml::from_str("true").unwrap();
assert!(!v.is_mapping());

pub fn as_mapping(&self) -> Option<&Mapping>[src]

If the Value is a mapping, return a reference to it if possible. Returns None otherwise.

let v: Value = serde_yaml::from_str("a: 42").unwrap();

let mut expected = Mapping::new();
expected.insert(Value::String("a".into()),Value::Number(Number::from(42)));

assert_eq!(v.as_mapping(), Some(&expected));
let v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_mapping(), None);

pub fn as_mapping_mut(&mut self) -> Option<&mut Mapping>[src]

If the Value is a mapping, return a reference to it if possible. Returns None otherwise.

let mut v: Value = serde_yaml::from_str("a: 42").unwrap();
let m = v.as_mapping_mut().unwrap();
m.insert(Value::String("b".into()), Value::Number(Number::from(21)));

let mut expected = Mapping::new();
expected.insert(Value::String("a".into()), Value::Number(Number::from(42)));
expected.insert(Value::String("b".into()), Value::Number(Number::from(21)));

assert_eq!(m, &expected);
let mut v: Value = serde_yaml::from_str("false").unwrap();
assert_eq!(v.as_mapping_mut(), None);

Trait Implementations

impl Clone for Value[src]

pub fn clone(&self) -> Value[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Value[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

impl Default for Value[src]

The default value is Value::Null.

This is useful for handling omitted Value fields when deserializing.

Examples

use serde::Deserialize;
use serde_yaml::Value;

#[derive(Deserialize)]
struct Settings {
    level: i32,
    #[serde(default)]
    extras: Value,
}

let data = r#" { "level": 42 } "#;
let s: Settings = serde_yaml::from_str(data)?;

assert_eq!(s.level, 42);
assert_eq!(s.extras, Value::Null);

pub fn default() -> Value[src]

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Value[src]

pub fn deserialize<D>(
    deserializer: D
) -> Result<Value, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 
[src]

Deserialize this value from the given Serde deserializer. Read more

impl<'de> Deserializer<'de> for Value[src]

type Error = Error

The error type that can be returned if some error occurs during deserialization. Read more

pub fn deserialize_any<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input. Read more

pub fn deserialize_bool<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a bool value.

pub fn deserialize_i8<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting an i8 value.

pub fn deserialize_i16<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting an i16 value.

pub fn deserialize_i32<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting an i32 value.

pub fn deserialize_i64<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting an i64 value.

pub fn deserialize_i128<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting an i128 value. Read more

pub fn deserialize_u8<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a u8 value.

pub fn deserialize_u16<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a u16 value.

pub fn deserialize_u32<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a u32 value.

pub fn deserialize_u64<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a u64 value.

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

Hint that the Deserialize type is expecting an u128 value. Read more

pub fn deserialize_f32<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a f32 value.

pub fn deserialize_f64<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a f64 value.

pub fn deserialize_char<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a char value.

pub fn deserialize_str<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer. Read more

pub fn deserialize_string<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer. Read more

pub fn deserialize_bytes<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer. Read more

pub fn deserialize_byte_buf<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer. Read more

pub fn deserialize_option<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting an optional value. Read more

pub fn deserialize_unit<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a unit value.

pub fn deserialize_unit_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a unit struct with a particular name. Read more

pub fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a newtype struct with a particular name. Read more

pub fn deserialize_seq<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a sequence of values.

pub fn deserialize_tuple<V>(
    self,
    _len: usize,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data. Read more

pub fn deserialize_tuple_struct<V>(
    self,
    _name: &'static str,
    _len: usize,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields. Read more

pub fn deserialize_map<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a map of key-value pairs.

pub fn deserialize_struct<V>(
    self,
    _name: &'static str,
    _fields: &'static [&'static str],
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting a struct with a particular name and fields. Read more

pub fn deserialize_enum<V>(
    self,
    _name: &str,
    _variants: &'static [&'static str],
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants. Read more

pub fn deserialize_identifier<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant. Read more

pub fn deserialize_ignored_any<V>(
    self,
    visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
    V: Visitor<'de>, 
[src]

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored. Read more

fn is_human_readable(&self) -> bool[src]

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

impl<'a, T> From<&'a [T]> for Value where
    T: Clone + Into<Value>, 
[src]

pub fn from(f: &'a [T]) -> Value[src]

Convert a slice to Value

Examples

use serde_yaml::Value;

let v: &[&str] = &["lorem", "ipsum", "dolor"];
let x: Value = v.into();

impl<'a> From<&'a str> for Value[src]

pub fn from(f: &str) -> Value[src]

Convert string slice to Value

Examples

use serde_yaml::Value;

let s: &str = "lorem";
let x: Value = s.into();

impl<'a> From<Cow<'a, str>> for Value[src]

pub fn from(f: Cow<'a, str>) -> Value[src]

Convert copy-on-write string to Value

Examples

use serde_yaml::Value;
use std::borrow::Cow;

let s: Cow<str> = Cow::Borrowed("lorem");
let x: Value = s.into();
use serde_yaml::Value;
use std::borrow::Cow;

let s: Cow<str> = Cow::Owned("lorem".to_string());
let x: Value = s.into();

impl From<Mapping> for Value[src]

pub fn from(f: Mapping) -> Value[src]

Convert map (with string keys) to Value

Examples

use serde_yaml::{Mapping, Value};

let mut m = Mapping::new();
m.insert("Lorem".into(), "ipsum".into());
let x: Value = m.into();

impl From<String> for Value[src]

pub fn from(f: String) -> Value[src]

Convert String to Value

Examples

use serde_yaml::Value;

let s: String = "lorem".to_string();
let x: Value = s.into();

impl<T> From<Vec<T, Global>> for Value where
    T: Into<Value>, 
[src]

pub fn from(f: Vec<T, Global>) -> Value[src]

Convert a Vec to Value

Examples

use serde_yaml::Value;

let v = vec!["lorem", "ipsum", "dolor"];
let x: Value = v.into();

impl From<bool> for Value[src]

pub fn from(f: bool) -> Value[src]

Convert boolean to Value

Examples

use serde_yaml::Value;

let b = false;
let x: Value = b.into();

impl From<f32> for Value[src]

pub fn from(n: f32) -> Value[src]

Performs the conversion.

impl From<f64> for Value[src]

pub fn from(n: f64) -> Value[src]

Performs the conversion.

impl From<i16> for Value[src]

pub fn from(n: i16) -> Value[src]

Performs the conversion.

impl From<i32> for Value[src]

pub fn from(n: i32) -> Value[src]

Performs the conversion.

impl From<i64> for Value[src]

pub fn from(n: i64) -> Value[src]

Performs the conversion.

impl From<i8> for Value[src]

pub fn from(n: i8) -> Value[src]

Performs the conversion.

impl From<isize> for Value[src]

pub fn from(n: isize) -> Value[src]

Performs the conversion.

impl From<u16> for Value[src]

pub fn from(n: u16) -> Value[src]

Performs the conversion.

impl From<u32> for Value[src]

pub fn from(n: u32) -> Value[src]

Performs the conversion.

impl From<u64> for Value[src]

pub fn from(n: u64) -> Value[src]

Performs the conversion.

impl From<u8> for Value[src]

pub fn from(n: u8) -> Value[src]

Performs the conversion.

impl From<usize> for Value[src]

pub fn from(n: usize) -> Value[src]

Performs the conversion.

impl<T> FromIterator<T> for Value where
    T: Into<Value>, 
[src]

pub fn from_iter<I>(iter: I) -> Value where
    I: IntoIterator<Item = T>, 
[src]

Convert an iteratable type to a YAML sequence

Examples

use serde_yaml::Value;

let v = std::iter::repeat(42).take(5);
let x: Value = v.collect();
use serde_yaml::Value;

let v: Vec<_> = vec!["lorem", "ipsum", "dolor"];
let x: Value = v.into_iter().collect();
use std::iter::FromIterator;
use serde_yaml::Value;

let x: Value = Value::from_iter(vec!["lorem", "ipsum", "dolor"]);

impl Hash for Value[src]

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher
[src]

Feeds this value into the given Hasher. Read more

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

Feeds a slice of this type into the given Hasher. Read more

impl Index for Value[src]

pub fn index_into(&self, v: &'v Value) -> Option<&'v Value>[src]

pub fn index_into_mut(&self, v: &'v mut Value) -> Option<&'v mut Value>[src]

pub fn index_or_insert(&self, v: &'v mut Value) -> &'v mut Value[src]

impl<I> Index<I> for Value where
    I: Index
[src]

pub fn index(&self, index: I) -> &Value[src]

Index into a serde_yaml::Value using the syntax value[0] or value["k"].

Returns Value::Null if the type of self does not match the type of the index, for example if the index is a string and self is a sequence or a number. Also returns Value::Null if the given key does not exist in the map or the given index is not within the bounds of the sequence.

For retrieving deeply nested values, you should have a look at the Value::pointer method.

Examples

let data = yaml(r#"{ x: { y: [z, zz] } }"#);

assert_eq!(data["x"]["y"], yaml(r#"["z", "zz"]"#));
assert_eq!(data["x"]["y"][0], yaml(r#""z""#));

assert_eq!(data["a"], yaml(r#"null"#)); // returns null for undefined values
assert_eq!(data["a"]["b"], yaml(r#"null"#)); // does not panic

type Output = Value

The returned type after indexing.

impl<I> IndexMut<I> for Value where
    I: Index
[src]

pub fn index_mut(&mut self, index: I) -> &mut Value[src]

Write into a serde_yaml::Value using the syntax value[0] = ... or value["k"] = ....

If the index is a number, the value must be a sequence of length bigger than the index. Indexing into a value that is not a sequence or a sequence that is too small will panic.

If the index is a string, the value must be an object or null which is treated like an empty object. If the key is not already present in the object, it will be inserted with a value of null. Indexing into a value that is neither an object nor null will panic.

Examples

let mut data = yaml(r#"{x: 0}"#);

// replace an existing key
data["x"] = yaml(r#"1"#);

// insert a new key
data["y"] = yaml(r#"[false, false, false]"#);

// replace a value in a sequence
data["y"][0] = yaml(r#"true"#);

// inserted a deeply nested key
data["a"]["b"]["c"]["d"] = yaml(r#"true"#);

println!("{:?}", data);

impl<'de> IntoDeserializer<'de, Error> for Value[src]

type Deserializer = Value

The type of the deserializer being converted into.

pub fn into_deserializer(
    self
) -> <Value as IntoDeserializer<'de, Error>>::Deserializer
[src]

Convert this value into a deserializer.

impl<'a> PartialEq<&'a str> for Value[src]

pub fn eq(&self, other: &&str) -> bool[src]

Compare &str with YAML value

Examples

assert!(Value::String("lorem".into()) == "lorem");

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<String> for Value[src]

pub fn eq(&self, other: &String) -> bool[src]

Compare YAML value with String

Examples

assert!(Value::String("lorem".into()) == "lorem".to_string());

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<Value> for &'a str[src]

pub fn eq(&self, other: &Value) -> bool[src]

Compare &str with YAML value

Examples

assert!("lorem" == Value::String("lorem".into()));

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<Value> for Value[src]

pub fn eq(&self, other: &Value) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<Value> for str[src]

pub fn eq(&self, other: &Value) -> bool[src]

Compare YAML value with str

Examples

assert!(*"lorem" == Value::String("lorem".into()));

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<bool> for Value[src]

pub fn eq(&self, other: &bool) -> bool[src]

Compare YAML value with bool

Examples

assert!(Value::Bool(true) == true);

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<f32> for Value[src]

pub fn eq(&self, other: &f32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<f32> for &'a mut Value[src]

pub fn eq(&self, other: &f32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<f32> for &'a Value[src]

pub fn eq(&self, other: &f32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<f64> for &'a mut Value[src]

pub fn eq(&self, other: &f64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<f64> for Value[src]

pub fn eq(&self, other: &f64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<f64> for &'a Value[src]

pub fn eq(&self, other: &f64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i16> for &'a Value[src]

pub fn eq(&self, other: &i16) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<i16> for Value[src]

pub fn eq(&self, other: &i16) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i16> for &'a mut Value[src]

pub fn eq(&self, other: &i16) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i32> for &'a Value[src]

pub fn eq(&self, other: &i32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i32> for &'a mut Value[src]

pub fn eq(&self, other: &i32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<i32> for Value[src]

pub fn eq(&self, other: &i32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i64> for &'a Value[src]

pub fn eq(&self, other: &i64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<i64> for Value[src]

pub fn eq(&self, other: &i64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i64> for &'a mut Value[src]

pub fn eq(&self, other: &i64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i8> for &'a mut Value[src]

pub fn eq(&self, other: &i8) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<i8> for &'a Value[src]

pub fn eq(&self, other: &i8) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<i8> for Value[src]

pub fn eq(&self, other: &i8) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<isize> for Value[src]

pub fn eq(&self, other: &isize) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<isize> for &'a mut Value[src]

pub fn eq(&self, other: &isize) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<isize> for &'a Value[src]

pub fn eq(&self, other: &isize) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<str> for Value[src]

pub fn eq(&self, other: &str) -> bool[src]

Compare str with YAML value

Examples

assert!(Value::String("lorem".into()) == *"lorem");

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<u16> for Value[src]

pub fn eq(&self, other: &u16) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u16> for &'a Value[src]

pub fn eq(&self, other: &u16) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u16> for &'a mut Value[src]

pub fn eq(&self, other: &u16) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u32> for &'a Value[src]

pub fn eq(&self, other: &u32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u32> for &'a mut Value[src]

pub fn eq(&self, other: &u32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<u32> for Value[src]

pub fn eq(&self, other: &u32) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u64> for &'a Value[src]

pub fn eq(&self, other: &u64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<u64> for Value[src]

pub fn eq(&self, other: &u64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u64> for &'a mut Value[src]

pub fn eq(&self, other: &u64) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<u8> for Value[src]

pub fn eq(&self, other: &u8) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u8> for &'a Value[src]

pub fn eq(&self, other: &u8) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<u8> for &'a mut Value[src]

pub fn eq(&self, other: &u8) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<usize> for &'a Value[src]

pub fn eq(&self, other: &usize) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialEq<usize> for Value[src]

pub fn eq(&self, other: &usize) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<'a> PartialEq<usize> for &'a mut Value[src]

pub fn eq(&self, other: &usize) -> bool[src]

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl PartialOrd<Value> for Value[src]

pub fn partial_cmp(&self, other: &Value) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl Prefab for PrefabValue[src]

impl PropsData for PrefabValue where
    Self: Clone
[src]

fn clone_props(&self) -> Box<dyn PropsData>[src]

fn as_any(&self) -> &dyn Any[src]

impl Serialize for Value[src]

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer
[src]

Serialize this value into the given Serde serializer. Read more

impl Eq for Value[src]

Auto Trait Implementations

impl RefUnwindSafe for Value

impl Send for Value

impl Sync for Value

impl Unpin for Value

impl UnwindSafe for Value

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]