Enum neovim_lib::Value

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.

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.

Methods

impl Value

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());

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());

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());

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());

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());

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());

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());

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());

pub fn is_bin(&self) -> bool

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

pub fn is_array(&self) -> bool

Returns true if the Value is an Array. Returns false otherwise.

pub fn is_map(&self) -> bool

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

pub fn is_ext(&self) -> bool

Returns true if the Value is an Ext. Returns false otherwise.

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());

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());

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());

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_value() as i64).as_f64());

assert_eq!(None, Value::Nil.as_f64());

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());

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());

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());

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());

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());

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserializer<'de> for Value

type Error = Error

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

fn deserialize_any<V>(     self,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

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

Hint that the Deserialize type is expecting an optional value.

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

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

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

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

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

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

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

Hint that the Deserialize type is expecting a bool value.

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

Hint that the Deserialize type is expecting a u8 value.

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

Hint that the Deserialize type is expecting a u16 value.

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

Hint that the Deserialize type is expecting a u32 value.

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

Hint that the Deserialize type is expecting a u64 value.

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

Hint that the Deserialize type is expecting an i8 value.

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

Hint that the Deserialize type is expecting an i16 value.

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

Hint that the Deserialize type is expecting an i32 value.

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

Hint that the Deserialize type is expecting an i64 value.

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

Hint that the Deserialize type is expecting a f32 value.

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

Hint that the Deserialize type is expecting a f64 value.

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

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(     self,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

fn deserialize_string<V>(     self,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

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

Hint that the Deserialize type is expecting a unit value.

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

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

fn deserialize_bytes<V>(     self,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

fn deserialize_byte_buf<V>(     self,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

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

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

fn deserialize_tuple_struct<V>(     self,     name: &'static str,     len: usize,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where     V: Visitor<'de>,

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

fn deserialize_struct<V>(     self,     name: &'static str,     fields: &'static [&'static str],     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::Error> where     V: Visitor<'de>,

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

fn deserialize_identifier<V>(     self,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

fn deserialize_tuple<V>(     self,     len: usize,     visitor: V ) -> Result<<V as Visitor<'de>>::Value, <Value as Deserializer<'de>>::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.

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

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

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

Hint that the Deserialize type is expecting an i128 value.

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

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

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

impl From<f32> for Value

fn from(v: f32) -> Value

Performs the conversion.

impl From<f64> for Value

fn from(v: f64) -> Value

Performs the conversion.

impl From<i32> for Value

fn from(v: i32) -> Value

Performs the conversion.

impl From<Vec<(Value, Value)>> for Value

fn from(v: Vec<(Value, Value)>) -> Value

Performs the conversion.

impl From<u8> for Value

fn from(v: u8) -> Value

Performs the conversion.

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

fn from(v: Cow<'a, [u8]>) -> Value

Performs the conversion.

impl From<i64> for Value

fn from(v: i64) -> Value

Performs the conversion.

impl From<bool> for Value

fn from(v: bool) -> Value

Performs the conversion.

impl<'a> From<&'a str> for Value

fn from(v: &str) -> Value

Performs the conversion.

impl From<usize> for Value

fn from(v: usize) -> Value

Performs the conversion.

impl From<Vec<u8>> for Value

fn from(v: Vec<u8>) -> Value

Performs the conversion.

impl From<u32> for Value

fn from(v: u32) -> Value

Performs the conversion.

impl<'a> From<&'a [u8]> for Value

fn from(v: &[u8]) -> Value

Performs the conversion.

impl From<u16> for Value

fn from(v: u16) -> Value

Performs the conversion.

impl<'a> From<Cow<'a, str>> for Value

fn from(v: Cow<'a, str>) -> Value

Performs the conversion.

impl From<isize> for Value

fn from(v: isize) -> Value

Performs the conversion.

impl From<i8> for Value

fn from(v: i8) -> Value

Performs the conversion.

impl From<String> for Value

fn from(v: String) -> Value

Performs the conversion.

impl From<u64> for Value

fn from(v: u64) -> Value

Performs the conversion.

impl From<Vec<Value>> for Value

fn from(v: Vec<Value>) -> Value

Performs the conversion.

impl From<i16> for Value

fn from(v: i16) -> Value

Performs the conversion.

impl Index<usize> for Value

type Output = Value

The returned type after indexing.

fn index(&self, index: usize) -> &Value

Performs the indexing (container[index]) operation.

impl<'de> Deserialize<'de> for Value

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Value

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

Serialize this value into the given Serde serializer.

impl Display for Value

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

Formats the value using the given formatter.

impl PartialEq<Value> for Value

fn eq(&self, other: &Value) -> bool

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

fn ne(&self, other: &Value) -> bool

This method tests for !=.