rmpv/

lib.rs

//! Contains Value and `ValueRef` structs and its conversion traits.
#![forbid(unsafe_code)]
#![allow(clippy::doc_markdown)]
#![allow(clippy::match_same_arms)]
#![allow(clippy::bool_assert_comparison)]
#![allow(clippy::option_if_let_else)]
#![allow(clippy::derive_partial_eq_without_eq)]

use std::borrow::Cow;
use std::convert::TryFrom;
use std::fmt::{self, Debug, Display};
use std::iter::FromIterator;
use std::ops::Index;
use std::str::Utf8Error;

pub mod decode;
pub mod encode;

#[cfg(feature = "with-serde")]
pub mod ext;

#[derive(Copy, Clone, Debug, PartialEq)]
enum IntPriv {
    /// Always non-less than zero.
    PosInt(u64),
    /// Always less than zero.
    NegInt(i64),
}

/// Name of Serde newtype struct to Represent Msgpack's Ext
/// Msgpack Ext: Ext(tag, binary)
/// Serde data model: _ExtStruct((tag, binary))
/// Example Serde impl for custom type:
///
/// ```ignore
/// #[derive(Debug, PartialEq, Serialize, Deserialize)]
/// #[serde(rename = "_ExtStruct")]
/// struct ExtStruct((i8, serde_bytes::ByteBuf));
///
/// test_round(ExtStruct((2, serde_bytes::ByteBuf::from(vec![5]))),
///            Value::Ext(2, vec![5]));
/// ```
pub const MSGPACK_EXT_STRUCT_NAME: &str = "_ExtStruct";

/// Represents a MessagePack integer, whether signed or unsigned.
///
/// A `Value` or `ValueRef` that contains integer can be constructed using `From` trait.
#[derive(Copy, Clone, PartialEq)]
pub struct Integer {
    n: IntPriv,
}

impl Integer {
    /// Returns `true` if the integer can be represented as `i64`.
    #[inline]
    #[must_use]
    pub const fn is_i64(&self) -> bool {
        match self.n {
            IntPriv::PosInt(n) => n <= i64::MAX as u64,
            IntPriv::NegInt(..) => true,
        }
    }

    /// Returns `true` if the integer can be represented as `u64`.
    #[inline]
    #[must_use]
    pub const fn is_u64(&self) -> bool {
        match self.n {
            IntPriv::PosInt(..) => true,
            IntPriv::NegInt(..) => false,
        }
    }

    /// Returns the integer represented as `i64` if possible, or else `None`.
    #[inline]
    #[must_use]
    pub fn as_i64(&self) -> Option<i64> {
        match self.n {
            IntPriv::PosInt(n) => n.try_into().ok(),
            IntPriv::NegInt(n) => Some(n),
        }
    }

    /// Returns the integer represented as `u64` if possible, or else `None`.
    #[inline]
    #[must_use]
    pub fn as_u64(&self) -> Option<u64> {
        match self.n {
            IntPriv::PosInt(n) => Some(n),
            IntPriv::NegInt(n) => n.try_into().ok(),
        }
    }

    /// Returns the integer represented as `f64` if possible, or else `None`.
    #[inline]
    #[must_use]
    pub fn as_f64(&self) -> Option<f64> {
        match self.n {
            IntPriv::PosInt(n) => Some(n as _),
            IntPriv::NegInt(n) => Some(n as _),
        }
    }
}

impl Debug for Integer {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        Debug::fmt(&self.n, fmt)
    }
}

impl Display for Integer {
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        match self.n {
            IntPriv::PosInt(v) => Display::fmt(&v, fmt),
            IntPriv::NegInt(v) => Display::fmt(&v, fmt),
        }
    }
}

impl From<u8> for Integer {
    #[inline]
    fn from(n: u8) -> Self {
        Self { n: IntPriv::PosInt(u64::from(n)) }
    }
}

impl From<u16> for Integer {
    #[inline]
    fn from(n: u16) -> Self {
        Self { n: IntPriv::PosInt(u64::from(n)) }
    }
}

impl From<u32> for Integer {
    #[inline]
    fn from(n: u32) -> Self {
        Self { n: IntPriv::PosInt(u64::from(n)) }
    }
}

impl From<u64> for Integer {
    #[inline]
    fn from(n: u64) -> Self {
        Self { n: IntPriv::PosInt(n) }
    }
}

impl From<usize> for Integer {
    #[inline]
    fn from(n: usize) -> Self {
        Self { n: IntPriv::PosInt(n as u64) }
    }
}

impl From<i8> for Integer {
    #[inline]
    fn from(n: i8) -> Self {
        if n < 0 {
            Self { n: IntPriv::NegInt(i64::from(n)) }
        } else {
            Self { n: IntPriv::PosInt(n as u64) }
        }
    }
}

impl From<i16> for Integer {
    #[inline]
    fn from(n: i16) -> Self {
        if n < 0 {
            Self { n: IntPriv::NegInt(i64::from(n)) }
        } else {
            Self { n: IntPriv::PosInt(n as u64) }
        }
    }
}

impl From<i32> for Integer {
    #[inline]
    fn from(n: i32) -> Self {
        if n < 0 {
            Self { n: IntPriv::NegInt(i64::from(n)) }
        } else {
            Self { n: IntPriv::PosInt(n as u64) }
        }
    }
}

impl From<i64> for Integer {
    #[inline]
    fn from(n: i64) -> Self {
        if n < 0 {
            Self { n: IntPriv::NegInt(n) }
        } else {
            Self { n: IntPriv::PosInt(n as u64) }
        }
    }
}

impl From<isize> for Integer {
    #[inline]
    fn from(n: isize) -> Self {
        if n < 0 {
            Self { n: IntPriv::NegInt(n as i64) }
        } else {
            Self { n: IntPriv::PosInt(n as u64) }
        }
    }
}

/// Represents an UTF-8 MessagePack string type.
///
/// According to the MessagePack spec, 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.
///
/// Summarizing, it's prohibited to instantiate a string type with invalid UTF-8 sequences, however
/// it is possible to obtain an underlying bytes that were attempted to convert to a `String`. This
/// may happen when trying to unpack strings that were decoded using older MessagePack spec with
/// raw types instead of string/binary.
#[derive(Clone, Debug, PartialEq)]
pub struct Utf8String {
    s: Result<String, (Vec<u8>, Utf8Error)>,
}

impl Utf8String {
    /// Returns `true` if the string is valid UTF-8.
    #[inline]
    #[must_use]
    pub fn is_str(&self) -> bool {
        self.s.is_ok()
    }

    /// Returns `true` if the string contains invalid UTF-8 sequence.
    #[inline]
    #[must_use]
    pub fn is_err(&self) -> bool {
        self.s.is_err()
    }

    /// Returns the string reference if the string is valid UTF-8, or else `None`.
    #[inline]
    #[must_use]
    pub fn as_str(&self) -> Option<&str> {
        match self.s {
            Ok(ref s) => Some(s.as_str()),
            Err(..) => None,
        }
    }

    /// Returns the underlying `Utf8Error` if the string contains invalud UTF-8 sequence, or
    /// else `None`.
    #[inline]
    #[must_use]
    pub fn as_err(&self) -> Option<&Utf8Error> {
        match self.s {
            Ok(..) => None,
            Err((_, ref err)) => Some(err),
        }
    }

    /// Returns a byte slice of this `Utf8String`'s contents.
    #[inline]
    #[must_use]
    pub fn as_bytes(&self) -> &[u8] {
        match self.s {
            Ok(ref s) => s.as_bytes(),
            Err(ref err) => &err.0[..],
        }
    }

    /// Consumes this object, yielding the string if the string is valid UTF-8, or else `None`.
    #[inline]
    #[must_use]
    pub fn into_str(self) -> Option<String> {
        self.s.ok()
    }

    /// Converts a `Utf8String` into a byte vector.
    #[inline]
    #[must_use]
    pub fn into_bytes(self) -> Vec<u8> {
        match self.s {
            Ok(s) => s.into_bytes(),
            Err(err) => err.0,
        }
    }

    #[inline]
    #[must_use]
    pub fn as_ref(&self) -> Utf8StringRef<'_> {
        match self.s {
            Ok(ref s) => Utf8StringRef { s: Ok(s.as_str()) },
            Err((ref buf, err)) => Utf8StringRef { s: Err((&buf[..], err)) },
        }
    }
}

impl Display for Utf8String {
    #[cold]
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        match self.s {
            Ok(ref s) => Debug::fmt(&s, fmt),
            Err(ref err) => Debug::fmt(&err.0, fmt),
        }
    }
}

impl<'a> From<String> for Utf8String {
    #[inline]
    fn from(val: String) -> Self {
        Self { s: Ok(val) }
    }
}

impl From<&str> for Utf8String {
    #[inline]
    fn from(val: &str) -> Self {
        Self { s: Ok(val.into()) }
    }
}

impl<'a> From<Cow<'a, str>> for Utf8String {
    #[inline]
    fn from(val: Cow<'a, str>) -> Self {
        Self {
            s: Ok(val.into_owned()),
        }
    }
}

/// A non-owning evil twin of `Utf8String`. Does exactly the same thing except ownership.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Utf8StringRef<'a> {
    s: Result<&'a str, (&'a [u8], Utf8Error)>,
}

impl<'a> Utf8StringRef<'a> {
    /// Returns `true` if the string is valid UTF-8.
    #[inline]
    #[must_use]
    pub fn is_str(&self) -> bool {
        self.s.is_ok()
    }

    /// Returns `true` if the string contains invalid UTF-8 sequence.
    #[inline]
    #[must_use]
    pub fn is_err(&self) -> bool {
        self.s.is_err()
    }

    /// Returns the string reference if the string is valid UTF-8, or else `None`.
    #[inline]
    #[must_use]
    pub fn as_str(&self) -> Option<&str> {
        self.s.ok()
    }

    /// Returns the underlying `Utf8Error` if the string contains invalud UTF-8 sequence, or
    /// else `None`.
    #[inline]
    #[must_use]
    pub fn as_err(&self) -> Option<&Utf8Error> {
        match self.s {
            Ok(..) => None,
            Err((_, ref err)) => Some(err),
        }
    }

    /// Returns a byte slice of this string contents no matter whether it's valid or not UTF-8.
    #[inline]
    #[must_use]
    pub const fn as_bytes(&self) -> &[u8] {
        match self.s {
            Ok(s) => s.as_bytes(),
            Err(ref err) => err.0,
        }
    }

    /// Consumes this object, yielding the string if the string is valid UTF-8, or else `None`.
    #[inline]
    #[must_use]
    pub fn into_string(self) -> Option<String> {
        self.s.ok().map(|s| s.into())
    }

    /// Consumes this object, yielding the string reference if the string is valid UTF-8, or else `None`.
    #[inline]
    #[must_use]
    pub fn into_str(self) -> Option<&'a str> {
        self.s.ok()
    }

    /// Converts a `Utf8StringRef` into a byte vector.
    #[inline]
    #[must_use]
    pub fn into_bytes(self) -> Vec<u8> {
        match self.s {
            Ok(s) => s.as_bytes().into(),
            Err(err) => err.0.into(),
        }
    }
}

impl Display for Utf8StringRef<'_> {
    #[cold]
    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        match self.s {
            Ok(s) => Debug::fmt(&&s, fmt),
            Err(ref err) => Debug::fmt(&err.0, fmt),
        }
    }
}

impl<'a> From<&'a str> for Utf8StringRef<'a> {
    #[inline]
    fn from(val: &'a str) -> Self {
        Utf8StringRef { s: Ok(val) }
    }
}

impl<'a> From<Utf8StringRef<'a>> for Utf8String {
    fn from(val: Utf8StringRef<'a>) -> Self {
        match val.s {
            Ok(s) => Self { s: Ok(s.into()) },
            Err((buf, err)) => Self {
                s: Err((buf.into(), err)),
            },
        }
    }
}

/// Represents any valid MessagePack value.
#[derive(Clone, Debug, PartialEq)]
pub enum Value {
    /// Nil represents nil.
    Nil,
    /// Boolean represents true or false.
    Boolean(bool),
    /// 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());
    /// ```
    Integer(Integer),
    /// A 32-bit floating point number.
    F32(f32),
    /// A 64-bit floating point number.
    F64(f64),
    /// 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
    String(Utf8String),
    /// Binary extending Raw type represents a byte array.
    Binary(Vec<u8>),
    /// Array represents a sequence of objects.
    Array(Vec<Self>),
    /// Map represents key-value pairs of objects.
    Map(Vec<(Self, Self)>),
    /// 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.
    Ext(i8, Vec<u8>),
}

impl Value {
    /// 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());
    /// ```
    #[must_use]
    pub fn as_ref(&self) -> ValueRef<'_> {
        match *self {
            Self::Nil => ValueRef::Nil,
            Self::Boolean(val) => ValueRef::Boolean(val),
            Self::Integer(val) => ValueRef::Integer(val),
            Self::F32(val) => ValueRef::F32(val),
            Self::F64(val) => ValueRef::F64(val),
            Self::String(ref val) => ValueRef::String(val.as_ref()),
            Self::Binary(ref val) => ValueRef::Binary(val.as_slice()),
            Self::Array(ref val) => {
                ValueRef::Array(val.iter().map(|v| v.as_ref()).collect())
            }
            Self::Map(ref val) => {
                ValueRef::Map(val.iter().map(|(k, v)| (k.as_ref(), v.as_ref())).collect())
            }
            Self::Ext(ty, ref buf) => ValueRef::Ext(ty, buf.as_slice()),
        }
    }

    /// Returns true if the `Value` is a Null. Returns false otherwise.
    ///
    /// # Examples
    ///
    /// ```
    /// use rmpv::Value;
    ///
    /// assert!(Value::Nil.is_nil());
    /// ```
    #[inline]
    #[must_use]
    pub const fn is_nil(&self) -> bool {
        if matches!(*self, Self::Nil) {
            true
        } else {
            false
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_bool(&self) -> bool {
        self.as_bool().is_some()
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_i64(&self) -> bool {
        if let Self::Integer(ref v) = *self {
            v.is_i64()
        } else {
            false
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_u64(&self) -> bool {
        if let Self::Integer(ref v) = *self {
            v.is_u64()
        } else {
            false
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_f32(&self) -> bool {
        matches!(*self, Self::F32(..))
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_f64(&self) -> bool {
        matches!(*self, Self::F64(..))
    }

    /// 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());
    /// ```
    #[must_use]
    pub fn is_number(&self) -> bool {
        matches!(*self, Self::Integer(..) | Self::F32(..) | Self::F64(..))
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn is_str(&self) -> bool {
        self.as_str().is_some()
    }

    /// Returns true if the `Value` is a Binary. Returns false otherwise.
    #[inline]
    #[must_use]
    pub fn is_bin(&self) -> bool {
        self.as_slice().is_some()
    }

    /// Returns true if the `Value` is an Array. Returns false otherwise.
    #[inline]
    #[must_use]
    pub fn is_array(&self) -> bool {
        self.as_array().is_some()
    }

    /// Returns true if the `Value` is a Map. Returns false otherwise.
    #[inline]
    #[must_use]
    pub fn is_map(&self) -> bool {
        self.as_map().is_some()
    }

    /// Returns true if the `Value` is an Ext. Returns false otherwise.
    #[inline]
    #[must_use]
    pub fn is_ext(&self) -> bool {
        self.as_ext().is_some()
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub const fn as_bool(&self) -> Option<bool> {
        if let Self::Boolean(val) = *self {
            Some(val)
        } else {
            None
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn as_i64(&self) -> Option<i64> {
        match *self {
            Self::Integer(ref n) => n.as_i64(),
            _ => None,
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn as_u64(&self) -> Option<u64> {
        match *self {
            Self::Integer(ref n) => n.as_u64(),
            _ => None,
        }
    }

    /// 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());
    /// ```
    #[must_use]
    pub fn as_f64(&self) -> Option<f64> {
        match *self {
            Self::Integer(ref n) => n.as_f64(),
            Self::F32(n) => Some(From::from(n)),
            Self::F64(n) => Some(n),
            _ => None,
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn as_str(&self) -> Option<&str> {
        if let Self::String(ref val) = *self {
            val.as_str()
        } else {
            None
        }
    }

    /// 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());
    /// ```
    #[must_use]
    pub fn as_slice(&self) -> Option<&[u8]> {
        if let Self::Binary(ref val) = *self {
            Some(val)
        } else if let Self::String(ref val) = *self {
            Some(val.as_bytes())
        } else {
            None
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn as_array(&self) -> Option<&Vec<Self>> {
        if let Self::Array(ref array) = *self {
            Some(array)
        } else {
            None
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn as_map(&self) -> Option<&Vec<(Self, Self)>> {
        if let Self::Map(ref map) = *self {
            Some(map)
        } else {
            None
        }
    }

    /// 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());
    /// ```
    #[inline]
    #[must_use]
    pub fn as_ext(&self) -> Option<(i8, &[u8])> {
        if let Self::Ext(ty, buf) = self {
            Some((*ty, buf))
        } else {
            None
        }
    }
}

static NIL: Value = Value::Nil;
static NIL_REF: ValueRef<'static> = ValueRef::Nil;

impl Index<usize> for Value {
    type Output = Self;

    fn index(&self, index: usize) -> &Self {
        self.as_array().and_then(|v| v.get(index)).unwrap_or(&NIL)
    }
}

impl Index<&str> for Value {
    type Output = Self;

    fn index(&self, index: &str) -> &Self {
        if let Self::Map(ref map) = *self {
            if let Some(found) = map.iter().find(|(key, _val)| {
                if let Self::String(ref strval) = *key {
                    if let Some(s) = strval.as_str() {
                        if s == index { return true; }
                    }
                }
                false
            }) {
                return &found.1;
            }
        }
        &NIL
    }
}

impl From<bool> for Value {
    #[inline]
    fn from(v: bool) -> Self {
        Self::Boolean(v)
    }
}

impl From<u8> for Value {
    #[inline]
    fn from(v: u8) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<u16> for Value {
    #[inline]
    fn from(v: u16) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<u32> for Value {
    #[inline]
    fn from(v: u32) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<u64> for Value {
    #[inline]
    fn from(v: u64) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<usize> for Value {
    #[inline]
    fn from(v: usize) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<i8> for Value {
    #[inline]
    fn from(v: i8) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<i16> for Value {
    #[inline]
    fn from(v: i16) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<i32> for Value {
    #[inline]
    fn from(v: i32) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<i64> for Value {
    #[inline]
    fn from(v: i64) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<isize> for Value {
    #[inline]
    fn from(v: isize) -> Self {
        Self::Integer(From::from(v))
    }
}

impl From<f32> for Value {
    #[inline]
    fn from(v: f32) -> Self {
        Self::F32(v)
    }
}

impl From<f64> for Value {
    #[inline]
    fn from(v: f64) -> Self {
        Self::F64(v)
    }
}

impl From<String> for Value {
    #[inline]
    fn from(v: String) -> Self {
        Self::String(Utf8String::from(v))
    }
}

impl From<&str> for Value {
    #[inline]
    fn from(v: &str) -> Self {
        Self::String(Utf8String::from(v))
    }
}

impl<'a> From<Cow<'a, str>> for Value {
    #[inline]
    fn from(v: Cow<'a, str>) -> Self {
        Self::String(Utf8String::from(v))
    }
}

impl From<Vec<u8>> for Value {
    #[inline]
    fn from(v: Vec<u8>) -> Self {
        Self::Binary(v)
    }
}

impl From<&[u8]> for Value {
    #[inline]
    fn from(v: &[u8]) -> Self {
        Self::Binary(v.into())
    }
}

impl<'a> From<Cow<'a, [u8]>> for Value {
    #[inline]
    fn from(v: Cow<'a, [u8]>) -> Self {
        Self::Binary(v.into_owned())
    }
}

impl From<Vec<Self>> for Value {
    #[inline]
    fn from(v: Vec<Self>) -> Self {
        Self::Array(v)
    }
}

impl From<Vec<(Self, Self)>> for Value {
    #[inline]
    fn from(v: Vec<(Self, Self)>) -> Self {
        Self::Map(v)
    }
}

/// Note that an `Iterator<Item = u8>` will be collected into an
/// [`Array`](crate::Value::Array), rather than a
/// [`Binary`](crate::Value::Binary)
impl<V> FromIterator<V> for Value
where
    V: Into<Self>,
{
    fn from_iter<I: IntoIterator<Item = V>>(iter: I) -> Self {
        let v: Vec<Value> = iter.into_iter().map(|v| v.into()).collect();
        Self::Array(v)
    }
}

impl TryFrom<Value> for u64 {
    type Error = Value;

    fn try_from(val: Value) -> Result<Self, Self::Error> {
        match val {
            Value::Integer(n) => match n.as_u64() {
                Some(i) => Ok(i),
                None => Err(val),
            },
            v => Err(v),
        }
    }
}

impl TryFrom<Value> for i64 {
    type Error = Value;

    fn try_from(val: Value) -> Result<Self, Self::Error> {
        match val {
            Value::Integer(n) => match n.as_i64() {
                Some(i) => Ok(i),
                None => Err(val),
            },
            v => Err(v),
        }
    }
}

impl TryFrom<Value> for f64 {
    type Error = Value;

    fn try_from(val: Value) -> Result<Self, Self::Error> {
        match val {
            Value::Integer(n) => match n.as_f64() {
                Some(i) => Ok(i),
                None => Err(val),
            },
            Value::F32(n) => Ok(From::from(n)),
            Value::F64(n) => Ok(n),
            v => Err(v),
        }
    }
}

impl TryFrom<Value> for String {
    type Error = Value;

    fn try_from(val: Value) -> Result<Self, Self::Error> {
        match val {
            Value::String(Utf8String { s: Ok(u) }) => Ok(u),
            _ => Err(val),
        }
    }
}
// The following impl was left out intentionally, see
// https://github.com/3Hren/msgpack-rust/pull/228#discussion_r359513925
/*
impl TryFrom<Value> for (i8, Vec<u8>) {
  type Error = Value;

  fn try_from(val: Value) -> Result<Self, Self::Error> {
      match val {
        Value::Ext(i, v) => Ok((i, v)),
        v => Err(v),
      }
  }
}
*/

macro_rules! impl_try_from {
    ($t: ty, $p: ident) => {
        impl TryFrom<Value> for $t {
            type Error = Value;

            fn try_from(val: Value) -> Result<$t, Self::Error> {
                match val {
                    Value::$p(v) => Ok(v),
                    v => Err(v),
                }
            }
        }
    };
}

impl_try_from!(bool, Boolean);
impl_try_from!(Vec<Value>, Array);
impl_try_from!(Vec<(Value, Value)>, Map);
impl_try_from!(Vec<u8>, Binary);
impl_try_from!(f32, F32);
impl_try_from!(Utf8String, String);

impl Display for Value {
    #[cold]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        match *self {
            Self::Nil => f.write_str("nil"),
            Self::Boolean(val) => Display::fmt(&val, f),
            Self::Integer(ref val) => Display::fmt(&val, f),
            Self::F32(val) => Display::fmt(&val, f),
            Self::F64(val) => Display::fmt(&val, f),
            Self::String(ref val) => Display::fmt(&val, f),
            Self::Binary(ref val) => Debug::fmt(&val, f),
            Self::Array(ref vec) => {
                // TODO: This can be slower than naive implementation. Need benchmarks for more
                // information.
                let res = vec.iter()
                    .map(|val| format!("{val}"))
                    .collect::<Vec<String>>()
                    .join(", ");

                write!(f, "[{res}]")
            },
            Self::Map(ref vec) => {
                write!(f, "{{")?;

                match vec.iter().take(1).next() {
                    Some((k, v)) => {
                        write!(f, "{k}: {v}")?;
                    },
                    None => {
                        write!(f, "")?;
                    },
                }

                for (k, v) in vec.iter().skip(1) {
                    write!(f, ", {k}: {v}")?;
                }

                write!(f, "}}")
            },
            Self::Ext(ty, ref data) => {
                write!(f, "[{ty}, {data:?}]")
            },
        }
    }
}

#[derive(Clone, Debug, PartialEq)]
pub enum ValueRef<'a> {
    /// Nil represents nil.
    Nil,
    /// Boolean represents true or false.
    Boolean(bool),
    /// Integer represents an integer.
    ///
    /// A value of an `Integer` object is limited from `-(2^63)` upto `(2^64)-1`.
    Integer(Integer),
    /// A 32-bit floating point number.
    F32(f32),
    /// A 64-bit floating point number.
    F64(f64),
    /// String extending Raw type represents a UTF-8 string.
    String(Utf8StringRef<'a>),
    /// Binary extending Raw type represents a byte array.
    Binary(&'a [u8]),
    /// Array represents a sequence of objects.
    Array(Vec<Self>),
    /// Map represents key-value pairs of objects.
    Map(Vec<(Self, Self)>),
    /// 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.
    Ext(i8, &'a [u8]),
}

impl ValueRef<'_> {
    /// Converts the current non-owning value to an owned Value.
    ///
    /// This is achieved by deep copying all underlying structures and borrowed buffers.
    ///
    /// # Panics
    ///
    /// Panics in unable to allocate memory to keep all internal structures and buffers.
    ///
    /// # Examples
    /// ```
    /// use rmpv::{Value, ValueRef};
    ///
    /// let val = ValueRef::Array(vec![
    ///     ValueRef::Nil,
    ///     ValueRef::from(42),
    ///     ValueRef::Array(vec![ValueRef::from("le message")]),
    /// ]);
    ///
    /// let expected = Value::Array(vec![
    ///     Value::Nil,
    ///     Value::from(42),
    ///     Value::Array(vec![Value::String("le message".into())]),
    /// ]);
    ///
    /// assert_eq!(expected, val.to_owned());
    /// ```
    #[must_use]
    pub fn to_owned(&self) -> Value {
        match *self {
            ValueRef::Nil => Value::Nil,
            ValueRef::Boolean(val) => Value::Boolean(val),
            ValueRef::Integer(val) => Value::Integer(val),
            ValueRef::F32(val) => Value::F32(val),
            ValueRef::F64(val) => Value::F64(val),
            ValueRef::String(val) => Value::String(val.into()),
            ValueRef::Binary(val) => Value::Binary(val.to_vec()),
            ValueRef::Array(ref val) => {
                Value::Array(val.iter().map(|v| v.to_owned()).collect())
            }
            ValueRef::Map(ref val) => {
                Value::Map(val.iter().map(|(k, v)| (k.to_owned(), v.to_owned())).collect())
            }
            ValueRef::Ext(ty, buf) => Value::Ext(ty, buf.to_vec()),
        }
    }

    #[must_use]
    pub fn index(&self, index: usize) -> &ValueRef<'_> {
        self.as_array().and_then(|v| v.get(index)).unwrap_or(&NIL_REF)
    }

    /// If the `ValueRef` is an integer, return or cast it to a u64.
    /// Returns None otherwise.
    ///
    /// # Examples
    ///
    /// ```
    /// use rmpv::ValueRef;
    ///
    /// assert_eq!(Some(42), ValueRef::from(42).as_u64());
    /// ```
    #[must_use]
    pub fn as_u64(&self) -> Option<u64> {
        match *self {
            ValueRef::Integer(ref n) => n.as_u64(),
            _ => None,
        }
    }

    /// If the `ValueRef` is an Array, returns the associated vector.
    /// Returns None otherwise.
    ///
    /// # Examples
    ///
    /// ```
    /// use rmpv::ValueRef;
    ///
    /// let val = ValueRef::Array(vec![ValueRef::Nil, ValueRef::Boolean(true)]);
    ///
    /// assert_eq!(Some(&vec![ValueRef::Nil, ValueRef::Boolean(true)]), val.as_array());
    /// assert_eq!(None, ValueRef::Nil.as_array());
    /// ```
    #[must_use]
    pub fn as_array(&self) -> Option<&Vec<ValueRef<'_>>> {
        if let ValueRef::Array(ref array) = *self {
            Some(array)
        } else {
            None
        }
    }

    #[inline]
    #[must_use]
    pub fn into_array(self) -> Option<Vec<Self>> {
        if let ValueRef::Array(array) = self {
            Some(array)
        } else {
            None
        }
    }
}

impl From<u8> for ValueRef<'_> {
    #[inline]
    fn from(v: u8) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<u16> for ValueRef<'_> {
    #[inline]
    fn from(v: u16) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<u32> for ValueRef<'_> {
    #[inline]
    fn from(v: u32) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<u64> for ValueRef<'_> {
    #[inline]
    fn from(v: u64) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<usize> for ValueRef<'_> {
    #[inline]
    fn from(v: usize) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<i8> for ValueRef<'_> {
    #[inline]
    fn from(v: i8) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<i16> for ValueRef<'_> {
    #[inline]
    fn from(v: i16) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<i32> for ValueRef<'_> {
    #[inline]
    fn from(v: i32) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<i64> for ValueRef<'_> {
    #[inline]
    fn from(v: i64) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<isize> for ValueRef<'_> {
    #[inline]
    fn from(v: isize) -> Self {
        ValueRef::Integer(From::from(v))
    }
}

impl From<f32> for ValueRef<'_> {
    #[inline]
    fn from(v: f32) -> Self {
        ValueRef::F32(v)
    }
}

impl From<f64> for ValueRef<'_> {
    #[inline]
    fn from(v: f64) -> Self {
        ValueRef::F64(v)
    }
}

impl<'a> From<&'a str> for ValueRef<'a> {
    #[inline]
    fn from(v: &'a str) -> Self {
        ValueRef::String(Utf8StringRef::from(v))
    }
}

impl<'a> From<&'a [u8]> for ValueRef<'a> {
    #[inline]
    fn from(v: &'a [u8]) -> Self {
        ValueRef::Binary(v)
    }
}

impl From<Vec<Self>> for ValueRef<'_> {
    #[inline]
    fn from(v: Vec<Self>) -> Self {
        ValueRef::Array(v)
    }
}

/// Note that an `Iterator<Item = u8>` will be collected into an
/// [`Array`](crate::Value::Array), rather than a
/// [`Binary`](crate::Value::Binary)
impl<'a, V> FromIterator<V> for ValueRef<'a>
where
    V: Into<Self>,
{
    fn from_iter<I: IntoIterator<Item = V>>(iter: I) -> Self {
        let v: Vec<ValueRef<'a>> = iter.into_iter().map(|v| v.into()).collect();
        ValueRef::Array(v)
    }
}

impl From<Vec<(Self, Self)>> for ValueRef<'_> {
    fn from(v: Vec<(Self, Self)>) -> Self {
        ValueRef::Map(v)
    }
}

impl<'a> TryFrom<ValueRef<'a>> for u64 {
    type Error = ValueRef<'a>;

    fn try_from(val: ValueRef<'a>) -> Result<Self, Self::Error> {
        match val {
            ValueRef::Integer(n) => match n.as_u64() {
                Some(i) => Ok(i),
                None => Err(val),
            },
            v => Err(v),
        }
    }
}

// The following impl was left out intentionally, see
// https://github.com/3Hren/msgpack-rust/pull/228#discussion_r359513925
/*
impl<'a> TryFrom<ValueRef<'a>> for (i8, &'a[u8]) {
  type Error = ValueRef<'a>;

  fn try_from(val: ValueRef<'a>) -> Result<Self, Self::Error> {
      match val {
        ValueRef::Ext(i, v) => Ok((i, v)),
        v => Err(v),
      }
  }
}
*/

macro_rules! impl_try_from_ref {
    ($t: ty, $p: ident) => {
        impl<'a> TryFrom<ValueRef<'a>> for $t {
            type Error = ValueRef<'a>;

            fn try_from(val: ValueRef<'a>) -> Result<$t, Self::Error> {
                match val {
                    ValueRef::$p(v) => Ok(v),
                    v => Err(v),
                }
            }
        }
    };
}

impl_try_from_ref!(bool, Boolean);
impl_try_from_ref!(Vec<ValueRef<'a>>, Array);
impl_try_from_ref!(Vec<(ValueRef<'a>, ValueRef<'a>)>, Map);
impl_try_from_ref!(&'a [u8], Binary);
impl_try_from_ref!(f32, F32);
impl_try_from_ref!(Utf8StringRef<'a>, String);

impl Display for ValueRef<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        match *self {
            ValueRef::Nil => write!(f, "nil"),
            ValueRef::Boolean(val) => Display::fmt(&val, f),
            ValueRef::Integer(ref val) => Display::fmt(&val, f),
            ValueRef::F32(val) => Display::fmt(&val, f),
            ValueRef::F64(val) => Display::fmt(&val, f),
            ValueRef::String(ref val) => Display::fmt(&val, f),
            ValueRef::Binary(val) => Debug::fmt(&&val, f),
            ValueRef::Array(ref vec) => {
                let res = vec.iter()
                    .map(|val| format!("{val}"))
                    .collect::<Vec<String>>()
                    .join(", ");

                write!(f, "[{res}]")
            },
            ValueRef::Map(ref vec) => {
                write!(f, "{{")?;

                match vec.iter().take(1).next() {
                    Some((k, v)) => {
                        write!(f, "{k}: {v}")?;
                    },
                    None => {
                        write!(f, "")?;
                    },
                }

                for (k, v) in vec.iter().skip(1) {
                    write!(f, ", {k}: {v}")?;
                }

                write!(f, "}}")
            },
            ValueRef::Ext(ty, data) => {
                write!(f, "[{ty}, {data:?}]")
            },
        }
    }
}