pub enum Value {
Nil,
Boolean(bool),
Integer(Integer),
F32(f32),
F64(f64),
String(Utf8String),
Binary(Vec<u8>),
Array(Vec<Value>),
Map(Vec<(Value, Value)>),
Ext(i8, Vec<u8>),
}
Expand description
Represents any valid MessagePack value.
Variants§
Nil
Nil represents nil.
Boolean(bool)
Boolean represents true or false.
Integer(Integer)
Integer represents an integer.
A value of an Integer
object is limited from -(2^63)
upto (2^64)-1
.
§Examples
use rmpv::Value;
assert_eq!(42, Value::from(42).as_i64().unwrap());
F32(f32)
A 32-bit floating point number.
F64(f64)
A 64-bit floating point number.
String(Utf8String)
String extending Raw type represents a UTF-8 string.
§Note
String objects may contain invalid byte sequence and the behavior of a deserializer depends on the actual implementation when it received invalid byte sequence. Deserializers should provide functionality to get the original byte array so that applications can decide how to handle the object
Binary(Vec<u8>)
Binary extending Raw type represents a byte array.
Array(Vec<Value>)
Array represents a sequence of objects.
Map(Vec<(Value, Value)>)
Map represents key-value pairs of objects.
Ext(i8, Vec<u8>)
Extended implements Extension interface: represents a tuple of type information and a byte array where type information is an integer whose meaning is defined by applications.
Implementations§
source§impl Value
impl Value
sourcepub fn as_ref(&self) -> ValueRef<'_>
pub fn as_ref(&self) -> ValueRef<'_>
Converts the current owned Value to a ValueRef
.
§Panics
Panics in unable to allocate memory to keep all internal structures and buffers.
§Examples
use rmpv::{Value, ValueRef};
let val = Value::Array(vec![
Value::Nil,
Value::from(42),
Value::Array(vec![
Value::String("le message".into())
])
]);
let expected = ValueRef::Array(vec![
ValueRef::Nil,
ValueRef::from(42),
ValueRef::Array(vec![
ValueRef::from("le message"),
])
]);
assert_eq!(expected, val.as_ref());
sourcepub fn is_nil(&self) -> bool
pub fn is_nil(&self) -> bool
Returns true if the Value
is a Null. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::Nil.is_nil());
sourcepub fn is_bool(&self) -> bool
pub fn is_bool(&self) -> bool
Returns true if the Value
is a Boolean. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::Boolean(true).is_bool());
assert!(!Value::Nil.is_bool());
sourcepub fn is_i64(&self) -> bool
pub fn is_i64(&self) -> bool
Returns true if the Value
is convertible to an i64. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::from(42).is_i64());
assert!(!Value::from(42.0).is_i64());
sourcepub fn is_u64(&self) -> bool
pub fn is_u64(&self) -> bool
Returns true if the Value
is convertible to an u64. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::from(42).is_u64());
assert!(!Value::F32(42.0).is_u64());
assert!(!Value::F64(42.0).is_u64());
sourcepub fn is_f32(&self) -> bool
pub fn is_f32(&self) -> bool
Returns true if (and only if) the Value
is a f32. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::F32(42.0).is_f32());
assert!(!Value::from(42).is_f32());
assert!(!Value::F64(42.0).is_f32());
sourcepub fn is_f64(&self) -> bool
pub fn is_f64(&self) -> bool
Returns true if (and only if) the Value
is a f64. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::F64(42.0).is_f64());
assert!(!Value::from(42).is_f64());
assert!(!Value::F32(42.0).is_f64());
sourcepub fn is_number(&self) -> bool
pub fn is_number(&self) -> bool
Returns true if the Value
is a Number. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::from(42).is_number());
assert!(Value::F32(42.0).is_number());
assert!(Value::F64(42.0).is_number());
assert!(!Value::Nil.is_number());
sourcepub fn is_str(&self) -> bool
pub fn is_str(&self) -> bool
Returns true if the Value
is a String. Returns false otherwise.
§Examples
use rmpv::Value;
assert!(Value::String("value".into()).is_str());
assert!(!Value::Nil.is_str());
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.
§Examples
use rmpv::Value;
assert_eq!(Some(true), Value::Boolean(true).as_bool());
assert_eq!(None, Value::Nil.as_bool());
sourcepub fn as_i64(&self) -> Option<i64>
pub fn as_i64(&self) -> Option<i64>
If the Value
is an integer, return or cast it to a i64.
Returns None otherwise.
§Examples
use rmpv::Value;
assert_eq!(Some(42i64), Value::from(42).as_i64());
assert_eq!(None, Value::F64(42.0).as_i64());
sourcepub fn as_u64(&self) -> Option<u64>
pub fn as_u64(&self) -> Option<u64>
If the Value
is an integer, return or cast it to a u64.
Returns None otherwise.
§Examples
use rmpv::Value;
assert_eq!(Some(42u64), Value::from(42).as_u64());
assert_eq!(None, Value::from(-42).as_u64());
assert_eq!(None, Value::F64(42.0).as_u64());
sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
If the Value
is a number, return or cast it to a f64.
Returns None otherwise.
§Examples
use rmpv::Value;
assert_eq!(Some(42.0), Value::from(42).as_f64());
assert_eq!(Some(42.0), Value::F32(42.0f32).as_f64());
assert_eq!(Some(42.0), Value::F64(42.0f64).as_f64());
assert_eq!(Some(2147483647.0), Value::from(i32::MAX as i64).as_f64());
assert_eq!(None, Value::Nil.as_f64());
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.
§Examples
use rmpv::Value;
assert_eq!(Some("le message"), Value::String("le message".into()).as_str());
assert_eq!(None, Value::Boolean(true).as_str());
sourcepub fn as_slice(&self) -> Option<&[u8]>
pub fn as_slice(&self) -> Option<&[u8]>
If the Value
is a Binary or a String, returns the associated slice.
Returns None otherwise.
§Examples
use rmpv::Value;
assert_eq!(Some(&[1, 2, 3, 4, 5][..]), Value::Binary(vec![1, 2, 3, 4, 5]).as_slice());
assert_eq!(None, Value::Boolean(true).as_slice());
sourcepub fn as_array(&self) -> Option<&Vec<Value>>
pub fn as_array(&self) -> Option<&Vec<Value>>
If the Value
is an Array, returns the associated vector.
Returns None otherwise.
§Examples
use rmpv::Value;
let val = Value::Array(vec![Value::Nil, Value::Boolean(true)]);
assert_eq!(Some(&vec![Value::Nil, Value::Boolean(true)]), val.as_array());
assert_eq!(None, Value::Nil.as_array());
sourcepub fn as_map(&self) -> Option<&Vec<(Value, Value)>>
pub fn as_map(&self) -> Option<&Vec<(Value, Value)>>
If the Value
is a Map, returns the associated vector of key-value tuples.
Returns None otherwise.
§Note
MessagePack represents map as a vector of key-value tuples.
§Examples
use rmpv::Value;
let val = Value::Map(vec![(Value::Nil, Value::Boolean(true))]);
assert_eq!(Some(&vec![(Value::Nil, Value::Boolean(true))]), val.as_map());
assert_eq!(None, Value::Nil.as_map());
sourcepub fn as_ext(&self) -> Option<(i8, &[u8])>
pub fn as_ext(&self) -> Option<(i8, &[u8])>
If the Value
is an Ext, returns the associated tuple with a ty and slice.
Returns None otherwise.
§Examples
use rmpv::Value;
assert_eq!(Some((42, &[1, 2, 3, 4, 5][..])), Value::Ext(42, vec![1, 2, 3, 4, 5]).as_ext());
assert_eq!(None, Value::Boolean(true).as_ext());