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>),
}
Represents any valid MessagePack value.
Boolean represents true or false.
Integer represents an integer.
A value of an Integer
object is limited from -(2^63)
upto (2^64)-1
.
use rmpv::Value;
assert_eq!(42, Value::from(42).as_i64().unwrap());
A 32-bit floating point number.
A 64-bit floating point number.
String extending Raw type represents a UTF-8 string.
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 extending Raw type represents a byte array.
Array represents a sequence of objects.
Map represents key-value pairs of objects.
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.
Returns true if the Value
is a Null. Returns false otherwise.
use rmpv::Value;
assert!(Value::Nil.is_nil());
Returns true if the Value
is a Boolean. Returns false otherwise.
use rmpv::Value;
assert!(Value::Boolean(true).is_bool());
assert!(!Value::Nil.is_bool());
Returns true if the Value
is convertible to an i64. Returns false otherwise.
use rmpv::Value;
assert!(Value::from(42).is_i64());
assert!(!Value::from(42.0).is_i64());
Returns true if the Value
is convertible to an u64. Returns false otherwise.
use rmpv::Value;
assert!(Value::from(42).is_u64());
assert!(!Value::F32(42.0).is_u64());
assert!(!Value::F64(42.0).is_u64());
Returns true if (and only if) the Value
is a f32. Returns false otherwise.
use rmpv::Value;
assert!(Value::F32(42.0).is_f32());
assert!(!Value::from(42).is_f32());
assert!(!Value::F64(42.0).is_f32());
Returns true if (and only if) the Value
is a f64. Returns false otherwise.
use rmpv::Value;
assert!(Value::F64(42.0).is_f64());
assert!(!Value::from(42).is_f64());
assert!(!Value::F32(42.0).is_f64());
Returns true if the Value
is a Number. Returns false otherwise.
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());
Returns true if the Value
is a String. Returns false otherwise.
use rmpv::Value;
assert!(Value::String("value".into()).is_str());
assert!(!Value::Nil.is_str());
Returns true if the Value
is a Binary. Returns false otherwise.
Returns true if the Value
is an Array. Returns false otherwise.
Returns true if the Value
is a Map. Returns false otherwise.
Returns true if the Value
is an Ext. Returns false otherwise.
If the Value
is a Boolean, returns the associated bool.
Returns None otherwise.
use rmpv::Value;
assert_eq!(Some(true), Value::Boolean(true).as_bool());
assert_eq!(None, Value::Nil.as_bool());
If the Value
is an integer, return or cast it to a i64.
Returns None otherwise.
use rmpv::Value;
assert_eq!(Some(42i64), Value::from(42).as_i64());
assert_eq!(None, Value::F64(42.0).as_i64());
If the Value
is an integer, return or cast it to a u64.
Returns None otherwise.
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());
If the Value
is a number, return or cast it to a f64.
Returns None otherwise.
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_value() as i64).as_f64());
assert_eq!(None, Value::Nil.as_f64());
If the Value
is a String, returns the associated str.
Returns None otherwise.
use rmpv::Value;
assert_eq!(Some("le message"), Value::String("le message".into()).as_str());
assert_eq!(None, Value::Boolean(true).as_str());
If the Value
is a Binary or a String, returns the associated slice.
Returns None otherwise.
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());
If the Value
is an Array, returns the associated vector.
Returns None otherwise.
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());
If the Value
is a Map, returns the associated vector of key-value tuples.
Returns None otherwise.
MessagePack represents map as a vector of key-value tuples.
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());
If the Value
is an Ext, returns the associated tuple with a ty and slice.
Returns None otherwise.
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());
The error type that can be returned if some error occurs during deserialization. Read more
Require the Deserializer
to figure out how to drive the visitor based on what data type is in the input. Read more
Hint that the Deserialize
type is expecting an optional value. Read more
Hint that the Deserialize
type is expecting an enum value with a particular name and possible variants. Read more
Hint that the Deserialize
type is expecting a newtype struct with a particular name. Read more
Hint that the Deserialize
type is expecting a unit struct with a particular name. Read more
Hint that the Deserialize
type is expecting a bool
value.
Hint that the Deserialize
type is expecting a u8
value.
Hint that the Deserialize
type is expecting a u16
value.
Hint that the Deserialize
type is expecting a u32
value.
Hint that the Deserialize
type is expecting a u64
value.
Hint that the Deserialize
type is expecting an i8
value.
Hint that the Deserialize
type is expecting an i16
value.
Hint that the Deserialize
type is expecting an i32
value.
Hint that the Deserialize
type is expecting an i64
value.
Hint that the Deserialize
type is expecting a f32
value.
Hint that the Deserialize
type is expecting a f64
value.
Hint that the Deserialize
type is expecting a char
value.
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
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
Hint that the Deserialize
type is expecting a unit value.
Hint that the Deserialize
type is expecting a sequence of values.
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
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
Hint that the Deserialize
type is expecting a map of key-value pairs.
Hint that the Deserialize
type is expecting a tuple struct with a particular name and number of fields. Read more
Hint that the Deserialize
type is expecting a struct with a particular name and fields. Read more
Hint that the Deserialize
type is expecting the name of a struct field or the discriminant of an enum variant. Read more
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
Hint that the Deserialize
type needs to deserialize a value whose type doesn't matter because it is ignored. Read more
Hint that the Deserialize
type is expecting an i128
value. Read more
Hint that the Deserialize
type is expecting an u128
value. Read more
Determine whether Deserialize
implementations should expect to deserialize their human-readable form. Read more
Performs copy-assignment from source
. Read more
Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more
The returned type after indexing.
Performs the indexing (container[index]
) operation.
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
Deserialize this value from the given Serde deserializer. Read more
Serialize this value into the given Serde serializer. Read more
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String
. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static