//! Implement deserialization support of [`Dynamic`][crate::Dynamic] for [`serde`]. use crate::types::dynamic::Union; use crate::{Dynamic, ImmutableString, LexError, Position, RhaiError, RhaiResultOf, ERR}; use serde::de::{Error, IntoDeserializer, Visitor}; use serde::{Deserialize, Deserializer}; #[cfg(feature = "no_std")] use std::prelude::v1::*; use std::{any::type_name, fmt}; /// Deserializer for [`Dynamic`][crate::Dynamic] which is kept as a reference. /// /// The reference is necessary because the deserialized type may hold references /// (especially `&str`) to the source [`Dynamic`][crate::Dynamic]. struct DynamicDeserializer<'a> { value: &'a Dynamic, } impl<'de> DynamicDeserializer<'de> { /// Create a [`DynamicDeserializer`] from a reference to a [`Dynamic`][crate::Dynamic] value. /// /// The reference is necessary because the deserialized type may hold references /// (especially `&str`) to the source [`Dynamic`][crate::Dynamic]. #[must_use] pub const fn from_dynamic(value: &'de Dynamic) -> Self { Self { value } } /// Shortcut for a type conversion error. fn type_error(&self) -> RhaiResultOf { self.type_error_str(type_name::()) } /// Shortcut for a type conversion error. fn type_error_str(&self, error: &str) -> RhaiResultOf { Err(ERR::ErrorMismatchOutputType( error.into(), self.value.type_name().into(), Position::NONE, ) .into()) } fn deserialize_int>( &mut self, v: crate::INT, visitor: V, ) -> RhaiResultOf { #[cfg(not(feature = "only_i32"))] return visitor.visit_i64(v); #[cfg(feature = "only_i32")] return visitor.visit_i32(v); } } /// Deserialize a [`Dynamic`][crate::Dynamic] value into a Rust type that implements [`serde::Deserialize`]. /// /// # Example /// /// ``` /// # fn main() -> Result<(), Box> { /// # #[cfg(not(feature = "no_index"))] /// # #[cfg(not(feature = "no_object"))] /// # { /// use rhai::{Dynamic, Array, Map, INT}; /// use rhai::serde::from_dynamic; /// use serde::Deserialize; /// /// #[derive(Debug, Deserialize, PartialEq)] /// struct Hello { /// a: INT, /// b: bool, /// } /// /// #[derive(Debug, Deserialize, PartialEq)] /// struct Test { /// int: u32, /// seq: Vec, /// obj: Hello, /// } /// /// let mut map = Map::new(); /// map.insert("int".into(), Dynamic::from(42_u32)); /// /// let mut map2 = Map::new(); /// map2.insert("a".into(), (123 as INT).into()); /// map2.insert("b".into(), true.into()); /// /// map.insert("obj".into(), map2.into()); /// /// let arr: Array = vec!["foo".into(), "bar".into(), "baz".into()]; /// map.insert("seq".into(), arr.into()); /// /// let value: Test = from_dynamic(&map.into())?; /// /// let expected = Test { /// int: 42, /// seq: vec!["foo".into(), "bar".into(), "baz".into()], /// obj: Hello { a: 123, b: true }, /// }; /// /// assert_eq!(value, expected); /// # } /// # Ok(()) /// # } /// ``` pub fn from_dynamic<'de, T: Deserialize<'de>>(value: &'de Dynamic) -> RhaiResultOf { T::deserialize(&mut DynamicDeserializer::from_dynamic(value)) } impl Error for RhaiError { fn custom(err: T) -> Self { LexError::ImproperSymbol(String::new(), err.to_string()) .into_err(Position::NONE) .into() } } impl<'de> Deserializer<'de> for &mut DynamicDeserializer<'de> { type Error = RhaiError; fn deserialize_any>(self, visitor: V) -> RhaiResultOf { match self.value.0 { Union::Unit(..) => self.deserialize_unit(visitor), Union::Bool(..) => self.deserialize_bool(visitor), Union::Str(..) => self.deserialize_str(visitor), Union::Char(..) => self.deserialize_char(visitor), #[cfg(not(feature = "only_i32"))] Union::Int(..) => self.deserialize_i64(visitor), #[cfg(feature = "only_i32")] Union::Int(..) => self.deserialize_i32(visitor), #[cfg(not(feature = "no_float"))] #[cfg(not(feature = "f32_float"))] Union::Float(..) => self.deserialize_f64(visitor), #[cfg(not(feature = "no_float"))] #[cfg(feature = "f32_float")] Union::Float(..) => self.deserialize_f32(visitor), #[cfg(feature = "decimal")] #[cfg(not(feature = "f32_float"))] Union::Decimal(..) => self.deserialize_f64(visitor), #[cfg(feature = "decimal")] #[cfg(feature = "f32_float")] Union::Decimal(..) => self.deserialize_f32(visitor), #[cfg(not(feature = "no_index"))] Union::Array(..) => self.deserialize_seq(visitor), #[cfg(not(feature = "no_index"))] Union::Blob(..) => self.deserialize_bytes(visitor), #[cfg(not(feature = "no_object"))] Union::Map(..) => self.deserialize_map(visitor), Union::FnPtr(..) => self.type_error(), #[cfg(not(feature = "no_std"))] Union::TimeStamp(..) => self.type_error(), Union::Variant(ref value, ..) if value.is::() => self.deserialize_i8(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_i16(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_i32(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_i64(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_i128(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_u8(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_u16(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_u32(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_u64(visitor), Union::Variant(ref value, ..) if value.is::() => self.deserialize_u128(visitor), Union::Variant(..) => self.type_error(), #[cfg(not(feature = "no_closure"))] Union::Shared(..) => self.type_error(), } } fn deserialize_bool>(self, visitor: V) -> RhaiResultOf { visitor.visit_bool(self.value.as_bool().or_else(|_| self.type_error())?) } fn deserialize_i8>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_i8(x)) } } fn deserialize_i16>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_i16(x)) } } fn deserialize_i32>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else if cfg!(feature = "only_i32") { self.type_error() } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_i32(x)) } } fn deserialize_i64>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else if cfg!(not(feature = "only_i32")) { self.type_error() } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_i64(x)) } } fn deserialize_i128>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else if cfg!(not(feature = "only_i32")) { self.type_error() } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_i128(x)) } } fn deserialize_u8>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_u8(x)) } } fn deserialize_u16>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_u16(x)) } } fn deserialize_u32>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_u32(x)) } } fn deserialize_u64>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_u64(x)) } } fn deserialize_u128>(self, visitor: V) -> RhaiResultOf { if let Ok(v) = self.value.as_int() { self.deserialize_int(v, visitor) } else { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_u128(x)) } } fn deserialize_f32>(self, _visitor: V) -> RhaiResultOf { #[cfg(not(feature = "no_float"))] return self .value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| _visitor.visit_f32(x)); #[cfg(feature = "no_float")] #[cfg(feature = "decimal")] { use rust_decimal::prelude::ToPrimitive; return self .value .downcast_ref::() .and_then(|&x| x.to_f32()) .map_or_else(|| self.type_error(), |v| _visitor.visit_f32(v)); } #[cfg(feature = "no_float")] #[cfg(not(feature = "decimal"))] return self.type_error_str("f32"); } fn deserialize_f64>(self, _visitor: V) -> RhaiResultOf { #[cfg(not(feature = "no_float"))] return self .value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| _visitor.visit_f64(x)); #[cfg(feature = "no_float")] #[cfg(feature = "decimal")] { use rust_decimal::prelude::ToPrimitive; return self .value .downcast_ref::() .and_then(|&x| x.to_f64()) .map_or_else(|| self.type_error(), |v| _visitor.visit_f64(v)); } #[cfg(feature = "no_float")] #[cfg(not(feature = "decimal"))] return self.type_error_str("f64"); } fn deserialize_char>(self, visitor: V) -> RhaiResultOf { self.value .downcast_ref::() .map_or_else(|| self.type_error(), |&x| visitor.visit_char(x)) } fn deserialize_str>(self, visitor: V) -> RhaiResultOf { self.value.downcast_ref::().map_or_else( || self.type_error(), |x| visitor.visit_borrowed_str(x.as_str()), ) } fn deserialize_string>(self, visitor: V) -> RhaiResultOf { self.deserialize_str(visitor) } fn deserialize_bytes>(self, _visitor: V) -> RhaiResultOf { #[cfg(not(feature = "no_index"))] return self .value .downcast_ref::() .map_or_else(|| self.type_error(), |x| _visitor.visit_bytes(x)); #[cfg(feature = "no_index")] return self.type_error(); } fn deserialize_byte_buf>(self, visitor: V) -> RhaiResultOf { self.deserialize_bytes(visitor) } fn deserialize_option>(self, visitor: V) -> RhaiResultOf { if self.value.is::<()>() { visitor.visit_none() } else { visitor.visit_some(self) } } fn deserialize_unit>(self, visitor: V) -> RhaiResultOf { self.value .downcast_ref::<()>() .map_or_else(|| self.type_error(), |_| visitor.visit_unit()) } fn deserialize_unit_struct>( self, _name: &'static str, visitor: V, ) -> RhaiResultOf { self.deserialize_unit(visitor) } fn deserialize_newtype_struct>( self, _name: &'static str, visitor: V, ) -> RhaiResultOf { visitor.visit_newtype_struct(self) } fn deserialize_seq>(self, _visitor: V) -> RhaiResultOf { #[cfg(not(feature = "no_index"))] return self.value.downcast_ref::().map_or_else( || self.type_error(), |arr| _visitor.visit_seq(IterateDynamicArray::new(arr.iter())), ); #[cfg(feature = "no_index")] return self.type_error(); } fn deserialize_tuple>(self, _len: usize, visitor: V) -> RhaiResultOf { self.deserialize_seq(visitor) } fn deserialize_tuple_struct>( self, _name: &'static str, _len: usize, visitor: V, ) -> RhaiResultOf { self.deserialize_seq(visitor) } fn deserialize_map>(self, _visitor: V) -> RhaiResultOf { #[cfg(not(feature = "no_object"))] return self.value.downcast_ref::().map_or_else( || self.type_error(), |map| { _visitor.visit_map(IterateMap::new( map.keys().map(crate::SmartString::as_str), map.values(), )) }, ); #[cfg(feature = "no_object")] return self.type_error(); } fn deserialize_struct>( self, _name: &'static str, _fields: &'static [&'static str], visitor: V, ) -> RhaiResultOf { self.deserialize_map(visitor) } fn deserialize_enum>( self, _name: &'static str, _variants: &'static [&'static str], visitor: V, ) -> RhaiResultOf { if let Some(s) = self.value.read_lock::() { visitor.visit_enum(s.as_str().into_deserializer()) } else { #[cfg(not(feature = "no_object"))] return self.value.downcast_ref::().map_or_else( || self.type_error(), |map| { let mut iter = map.iter(); let first = iter.next(); let second = iter.next(); if let (Some((key, value)), None) = (first, second) { visitor.visit_enum(EnumDeserializer { tag: key, content: DynamicDeserializer::from_dynamic(value), }) } else { self.type_error() } }, ); #[cfg(feature = "no_object")] return self.type_error(); } } fn deserialize_identifier>(self, visitor: V) -> RhaiResultOf { self.deserialize_str(visitor) } fn deserialize_ignored_any>(self, visitor: V) -> RhaiResultOf { self.deserialize_any(visitor) } } /// `SeqAccess` implementation for arrays. #[cfg(not(feature = "no_index"))] struct IterateDynamicArray<'a, ITER: Iterator> { /// Iterator for a stream of [`Dynamic`][crate::Dynamic] values. iter: ITER, } #[cfg(not(feature = "no_index"))] impl<'a, ITER: Iterator> IterateDynamicArray<'a, ITER> { #[must_use] pub const fn new(iter: ITER) -> Self { Self { iter } } } #[cfg(not(feature = "no_index"))] impl<'a: 'de, 'de, ITER: Iterator> serde::de::SeqAccess<'de> for IterateDynamicArray<'a, ITER> { type Error = RhaiError; fn next_element_seed>( &mut self, seed: T, ) -> RhaiResultOf> { // Deserialize each item coming out of the iterator. match self.iter.next() { None => Ok(None), Some(item) => seed .deserialize(&mut DynamicDeserializer::from_dynamic(item)) .map(Some), } } } /// `MapAccess` implementation for maps. #[cfg(not(feature = "no_object"))] struct IterateMap<'a, K: Iterator, V: Iterator> { // Iterator for a stream of [`Dynamic`][crate::Dynamic] keys. keys: K, // Iterator for a stream of [`Dynamic`][crate::Dynamic] values. values: V, } #[cfg(not(feature = "no_object"))] impl<'a, K: Iterator, V: Iterator> IterateMap<'a, K, V> { #[must_use] pub const fn new(keys: K, values: V) -> Self { Self { keys, values } } } #[cfg(not(feature = "no_object"))] impl<'a: 'de, 'de, K: Iterator, V: Iterator> serde::de::MapAccess<'de> for IterateMap<'a, K, V> { type Error = RhaiError; fn next_key_seed>( &mut self, seed: S, ) -> RhaiResultOf> { // Deserialize each `Identifier` key coming out of the keys iterator. match self.keys.next() { None => Ok(None), Some(item) => seed .deserialize(&mut super::str::StringSliceDeserializer::from_str(item)) .map(Some), } } fn next_value_seed>( &mut self, seed: S, ) -> RhaiResultOf { // Deserialize each value item coming out of the iterator. seed.deserialize(&mut DynamicDeserializer::from_dynamic( self.values.next().unwrap(), )) } } #[cfg(not(feature = "no_object"))] struct EnumDeserializer<'t, 'de: 't> { tag: &'t str, content: DynamicDeserializer<'de>, } #[cfg(not(feature = "no_object"))] impl<'t, 'de> serde::de::EnumAccess<'de> for EnumDeserializer<'t, 'de> { type Error = RhaiError; type Variant = Self; fn variant_seed>( self, seed: V, ) -> RhaiResultOf<(V::Value, Self::Variant)> { seed.deserialize(self.tag.into_deserializer()) .map(|v| (v, self)) } } #[cfg(not(feature = "no_object"))] impl<'t, 'de> serde::de::VariantAccess<'de> for EnumDeserializer<'t, 'de> { type Error = RhaiError; fn unit_variant(mut self) -> RhaiResultOf<()> { Deserialize::deserialize(&mut self.content) } fn newtype_variant_seed>( mut self, seed: T, ) -> RhaiResultOf { seed.deserialize(&mut self.content) } fn tuple_variant>(mut self, len: usize, visitor: V) -> RhaiResultOf { self.content.deserialize_tuple(len, visitor) } fn struct_variant>( mut self, fields: &'static [&'static str], visitor: V, ) -> RhaiResultOf { self.content.deserialize_struct("", fields, visitor) } }