Enum kalgan_config::Value
source · [−]pub enum Value {
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
sourceimpl Value
impl Value
sourcepub fn get<I>(&self, index: I) -> Option<&Value> where
I: Index,
pub fn get<I>(&self, index: I) -> Option<&Value> where
I: Index,
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));
sourcepub fn get_mut<I>(&mut self, index: I) -> Option<&mut Value> where
I: Index,
pub fn get_mut<I>(&mut self, index: I) -> Option<&mut Value> where
I: Index,
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.
sourcepub fn is_null(&self) -> bool
pub fn is_null(&self) -> bool
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());
sourcepub fn as_null(&self) -> Option<()>
pub fn as_null(&self) -> Option<()>
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);
sourcepub fn is_bool(&self) -> bool
pub fn is_bool(&self) -> bool
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());
sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
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);
sourcepub fn is_number(&self) -> bool
pub fn is_number(&self) -> bool
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());
sourcepub fn is_i64(&self) -> bool
pub fn is_i64(&self) -> bool
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());
sourcepub fn as_i64(&self) -> Option<i64>
pub fn as_i64(&self) -> Option<i64>
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);
sourcepub fn is_u64(&self) -> bool
pub fn is_u64(&self) -> bool
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());
sourcepub fn as_u64(&self) -> Option<u64>
pub fn as_u64(&self) -> Option<u64>
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);
sourcepub fn is_f64(&self) -> bool
pub fn is_f64(&self) -> bool
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());
sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
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);
sourcepub fn is_string(&self) -> bool
pub fn is_string(&self) -> bool
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());
sourcepub fn as_str(&self) -> Option<&str>
pub fn as_str(&self) -> Option<&str>
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);
sourcepub fn is_sequence(&self) -> bool
pub fn is_sequence(&self) -> bool
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());
sourcepub fn as_sequence(&self) -> Option<&Vec<Value, Global>>
pub fn as_sequence(&self) -> Option<&Vec<Value, Global>>
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);
sourcepub fn as_sequence_mut(&mut self) -> Option<&mut Vec<Value, Global>>
pub fn as_sequence_mut(&mut self) -> Option<&mut Vec<Value, Global>>
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);
sourcepub fn is_mapping(&self) -> bool
pub fn is_mapping(&self) -> bool
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());
sourcepub fn as_mapping(&self) -> Option<&Mapping>
pub fn as_mapping(&self) -> Option<&Mapping>
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);
sourcepub fn as_mapping_mut(&mut self) -> Option<&mut Mapping>
pub fn as_mapping_mut(&mut self) -> Option<&mut Mapping>
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
sourceimpl Default for Value
impl Default for Value
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);
sourceimpl<'de> Deserialize<'de> for Value
impl<'de> Deserialize<'de> for Value
sourcepub fn deserialize<D>(
deserializer: D
) -> Result<Value, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
pub fn deserialize<D>(
deserializer: D
) -> Result<Value, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<'de> Deserializer<'de> for Value
impl<'de> Deserializer<'de> for Value
type Error = Error
type Error = Error
The error type that can be returned if some error occurs during deserialization. Read more
sourcepub fn deserialize_any<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_any<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Require the Deserializer
to figure out how to drive the visitor based
on what data type is in the input. Read more
sourcepub fn deserialize_bool<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_bool<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a bool
value.
sourcepub fn deserialize_i8<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_i8<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting an i8
value.
sourcepub fn deserialize_i16<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_i16<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting an i16
value.
sourcepub fn deserialize_i32<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_i32<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting an i32
value.
sourcepub fn deserialize_i64<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_i64<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting an i64
value.
sourcepub fn deserialize_i128<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_i128<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting an i128
value. Read more
sourcepub fn deserialize_u8<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_u8<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a u8
value.
sourcepub fn deserialize_u16<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_u16<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a u16
value.
sourcepub fn deserialize_u32<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_u32<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a u32
value.
sourcepub fn deserialize_u64<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_u64<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a u64
value.
sourcepub fn deserialize_u128<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_u128<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting an u128
value. Read more
sourcepub fn deserialize_f32<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_f32<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a f32
value.
sourcepub fn deserialize_f64<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_f64<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a f64
value.
sourcepub fn deserialize_char<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_char<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a char
value.
sourcepub fn deserialize_str<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_str<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
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
sourcepub fn deserialize_string<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_string<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
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
sourcepub fn deserialize_bytes<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_bytes<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
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
sourcepub fn deserialize_byte_buf<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_byte_buf<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
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
sourcepub fn deserialize_option<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_option<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting an optional value. Read more
sourcepub fn deserialize_unit<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_unit<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a unit value.
sourcepub fn deserialize_unit_struct<V>(
self,
_name: &'static str,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_unit_struct<V>(
self,
_name: &'static str,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a unit struct with a
particular name. Read more
sourcepub fn deserialize_newtype_struct<V>(
self,
_name: &'static str,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_newtype_struct<V>(
self,
_name: &'static str,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a newtype struct with a
particular name. Read more
sourcepub fn deserialize_seq<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_seq<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a sequence of values.
sourcepub fn deserialize_tuple<V>(
self,
_len: usize,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_tuple<V>(
self,
_len: usize,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
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
sourcepub fn deserialize_tuple_struct<V>(
self,
_name: &'static str,
_len: usize,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
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>,
Hint that the Deserialize
type is expecting a tuple struct with a
particular name and number of fields. Read more
sourcepub fn deserialize_map<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_map<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting a map of key-value pairs.
sourcepub 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>,
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>,
Hint that the Deserialize
type is expecting a struct with a particular
name and fields. Read more
sourcepub fn deserialize_enum<V>(
self,
_name: &str,
_variants: &'static [&'static str],
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
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>,
Hint that the Deserialize
type is expecting an enum value with a
particular name and possible variants. Read more
sourcepub fn deserialize_identifier<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_identifier<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type is expecting the name of a struct
field or the discriminant of an enum variant. Read more
sourcepub fn deserialize_ignored_any<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
pub fn deserialize_ignored_any<V>(
self,
visitor: V
) -> Result<<V as Visitor<'de>>::Value, Error> where
V: Visitor<'de>,
Hint that the Deserialize
type needs to deserialize a value whose type
doesn’t matter because it is ignored. Read more
sourcefn is_human_readable(&self) -> bool
fn is_human_readable(&self) -> bool
Determine whether Deserialize
implementations should expect to
deserialize their human-readable form. Read more
sourceimpl<'a> From<Cow<'a, str>> for Value
impl<'a> From<Cow<'a, str>> for Value
sourcepub fn from(f: Cow<'a, str>) -> Value
pub fn from(f: Cow<'a, str>) -> Value
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();
sourceimpl<T> FromIterator<T> for Value where
T: Into<Value>,
impl<T> FromIterator<T> for Value where
T: Into<Value>,
sourcepub fn from_iter<I>(iter: I) -> Value where
I: IntoIterator<Item = T>,
pub fn from_iter<I>(iter: I) -> Value where
I: IntoIterator<Item = T>,
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"]);
sourceimpl Index for Value
impl Index for Value
pub fn index_into(&self, v: &'v Value) -> Option<&'v Value>
pub fn index_into_mut(&self, v: &'v mut Value) -> Option<&'v mut Value>
pub fn index_or_insert(&self, v: &'v mut Value) -> &'v mut Value
sourceimpl<I> Index<I> for Value where
I: Index,
impl<I> Index<I> for Value where
I: Index,
sourcepub fn index(&self, index: I) -> &Value
pub fn index(&self, index: I) -> &Value
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
sourceimpl<I> IndexMut<I> for Value where
I: Index,
impl<I> IndexMut<I> for Value where
I: Index,
sourcepub fn index_mut(&mut self, index: I) -> &mut Value
pub fn index_mut(&mut self, index: I) -> &mut Value
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);
sourceimpl<'de> IntoDeserializer<'de, Error> for Value
impl<'de> IntoDeserializer<'de, Error> for Value
type Deserializer = Value
type Deserializer = Value
The type of the deserializer being converted into.
sourcepub fn into_deserializer(
self
) -> <Value as IntoDeserializer<'de, Error>>::Deserializer
pub fn into_deserializer(
self
) -> <Value as IntoDeserializer<'de, Error>>::Deserializer
Convert this value into a deserializer.
sourceimpl PartialOrd<Value> for Value
impl PartialOrd<Value> for Value
sourcepub fn partial_cmp(&self, other: &Value) -> Option<Ordering>
pub fn partial_cmp(&self, other: &Value) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Serialize for Value
impl Serialize for Value
sourcepub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl Eq for Value
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcepub fn equivalent(&self, key: &K) -> bool
pub fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more