//! Helper module which defines the [`Any`] trait to to allow dynamic value handling. use crate::fn_native::SendSync; use crate::r#unsafe::{unsafe_cast_box, unsafe_try_cast}; use crate::{FnPtr, ImmutableString, INT}; #[cfg(feature = "no_std")] use std::prelude::v1::*; use std::{ any::{type_name, Any, TypeId}, fmt, hash::{Hash, Hasher}, ops::{Deref, DerefMut}, }; #[cfg(not(feature = "no_float"))] use crate::{ast::FloatWrapper, FLOAT}; #[cfg(feature = "decimal")] use rust_decimal::Decimal; #[cfg(not(feature = "no_index"))] use crate::Array; #[cfg(not(feature = "no_object"))] use crate::Map; #[cfg(not(feature = "no_std"))] #[cfg(not(any(target_arch = "wasm32", target_arch = "wasm64")))] use std::time::Instant; use fmt::Debug; #[cfg(not(feature = "no_std"))] #[cfg(any(target_arch = "wasm32", target_arch = "wasm64"))] use instant::Instant; /// The message: never fails because the type was checked const CHECKED: &str = "never fails because the type was checked"; mod private { use crate::fn_native::SendSync; use std::any::Any; /// A sealed trait that prevents other crates from implementing [`Variant`]. pub trait Sealed {} impl Sealed for T {} } /// _(INTERNALS)_ Trait to represent any type. /// Exported under the `internals` feature only. /// /// This trait is sealed and cannot be implemented. /// /// Currently, [`Variant`] is not [`Send`] nor [`Sync`], so it can practically be any type. /// Turn on the `sync` feature to restrict it to only types that implement [`Send`] `+` [`Sync`]. #[cfg(not(feature = "sync"))] pub trait Variant: Any + private::Sealed { /// Convert this [`Variant`] trait object to [`&dyn Any`][Any]. #[must_use] fn as_any(&self) -> &dyn Any; /// Convert this [`Variant`] trait object to [`&mut dyn Any`][Any]. #[must_use] fn as_mut_any(&mut self) -> &mut dyn Any; /// Convert this [`Variant`] trait object to an [`Any`] trait object. #[must_use] fn as_box_any(self: Box) -> Box; /// Get the name of this type. #[must_use] fn type_name(&self) -> &'static str; /// Convert into [`Dynamic`]. #[must_use] fn into_dynamic(self) -> Dynamic; /// Clone into [`Dynamic`]. #[must_use] fn clone_into_dynamic(&self) -> Dynamic; } /// _(INTERNALS)_ Trait to represent any type. /// Exported under the `internals` feature only. /// /// This trait is sealed and cannot be implemented. #[cfg(feature = "sync")] pub trait Variant: Any + Send + Sync + private::Sealed { /// Convert this [`Variant`] trait object to [`&dyn Any`][Any]. #[must_use] fn as_any(&self) -> &dyn Any; /// Convert this [`Variant`] trait object to [`&mut dyn Any`][Any]. #[must_use] fn as_mut_any(&mut self) -> &mut dyn Any; /// Convert this [`Variant`] trait object to an [`Any`] trait object. #[must_use] fn as_box_any(self: Box) -> Box; /// Get the name of this type. #[must_use] fn type_name(&self) -> &'static str; /// Convert into [`Dynamic`]. #[must_use] fn into_dynamic(self) -> Dynamic; /// Clone into [`Dynamic`]. #[must_use] fn clone_into_dynamic(&self) -> Dynamic; } impl Variant for T { #[inline(always)] fn as_any(&self) -> &dyn Any { self } #[inline(always)] fn as_mut_any(&mut self) -> &mut dyn Any { self } #[inline(always)] fn as_box_any(self: Box) -> Box { self } #[inline(always)] fn type_name(&self) -> &'static str { type_name::() } #[inline(always)] fn into_dynamic(self) -> Dynamic { Dynamic::from(self) } #[inline(always)] fn clone_into_dynamic(&self) -> Dynamic { Dynamic::from(self.clone()) } } impl dyn Variant { /// Is this [`Variant`] a specific type? #[inline(always)] #[must_use] pub fn is(&self) -> bool { TypeId::of::() == self.type_id() } } /// Modes of access. #[derive(Debug, Eq, PartialEq, Hash, Copy, Clone)] pub enum AccessMode { /// Mutable. ReadWrite, /// Immutable. ReadOnly, } /// Arbitrary data attached to a [`Dynamic`] value. #[cfg(target_pointer_width = "64")] pub type Tag = i32; /// Arbitrary data attached to a [`Dynamic`] value. #[cfg(target_pointer_width = "32")] pub type Tag = i16; /// Default tag value for [`Dynamic`]. const DEFAULT_TAG_VALUE: Tag = 0; /// Dynamic type containing any value. pub struct Dynamic(pub(crate) Union); /// Internal [`Dynamic`] representation. /// /// Most variants are boxed to reduce the size. pub enum Union { /// The Unit value - (). Unit((), Tag, AccessMode), /// A boolean value. Bool(bool, Tag, AccessMode), /// An [`ImmutableString`] value. Str(ImmutableString, Tag, AccessMode), /// A character value. Char(char, Tag, AccessMode), /// An integer value. Int(INT, Tag, AccessMode), /// A floating-point value. /// /// Not available under `no_float`. #[cfg(not(feature = "no_float"))] Float(FloatWrapper, Tag, AccessMode), /// _(DECIMAL)_ A fixed-precision decimal value. /// Exported under the `decimal` feature only. #[cfg(feature = "decimal")] Decimal(Box, Tag, AccessMode), /// An array value. /// /// Not available under `no_index`. #[cfg(not(feature = "no_index"))] Array(Box, Tag, AccessMode), /// An object map value. /// /// Not available under `no_object`. #[cfg(not(feature = "no_object"))] Map(Box, Tag, AccessMode), /// A function pointer. FnPtr(Box, Tag, AccessMode), /// A timestamp value. /// /// Not available under `no-std`. #[cfg(not(feature = "no_std"))] TimeStamp(Box, Tag, AccessMode), /// Any type as a trait object. #[allow(clippy::redundant_allocation)] Variant(Box>, Tag, AccessMode), /// A _shared_ value of any type. /// /// Not available under `no_closure`. #[cfg(not(feature = "no_closure"))] Shared(crate::Shared>, Tag, AccessMode), } /// _(INTERNALS)_ Lock guard for reading a [`Dynamic`]. /// Exported under the `internals` feature only. /// /// This type provides transparent interoperability between normal [`Dynamic`] and shared /// [`Dynamic`] values. /// /// # Volatile Data Structure /// /// This type is volatile and may change. #[derive(Debug)] pub struct DynamicReadLock<'d, T: Clone>(DynamicReadLockInner<'d, T>); /// Different types of read guards for [`DynamicReadLock`]. #[derive(Debug)] enum DynamicReadLockInner<'d, T: Clone> { /// A simple reference to a non-shared value. Reference(&'d T), /// A read guard to a shared [`RefCell`][std::cell::RefCell]. #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Guard(std::cell::Ref<'d, Dynamic>), /// A read guard to a shared [`RwLock`][std::sync::RwLock]. #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Guard(std::sync::RwLockReadGuard<'d, Dynamic>), } impl<'d, T: Any + Clone> Deref for DynamicReadLock<'d, T> { type Target = T; #[inline(always)] fn deref(&self) -> &Self::Target { match self.0 { DynamicReadLockInner::Reference(ref reference) => *reference, #[cfg(not(feature = "no_closure"))] DynamicReadLockInner::Guard(ref guard) => guard.downcast_ref().expect( "never fails because the read guard was created after checking the data type", ), } } } /// _(INTERNALS)_ Lock guard for writing a [`Dynamic`]. /// Exported under the `internals` feature only. /// /// This type provides transparent interoperability between normal [`Dynamic`] and shared /// [`Dynamic`] values. /// /// # Volatile Data Structure /// /// This type is volatile and may change. #[derive(Debug)] pub struct DynamicWriteLock<'d, T: Clone>(DynamicWriteLockInner<'d, T>); /// Different types of write guards for [`DynamicReadLock`]. #[derive(Debug)] enum DynamicWriteLockInner<'d, T: Clone> { /// A simple mutable reference to a non-shared value. Reference(&'d mut T), /// A write guard to a shared [`RefCell`][std::cell::RefCell]. #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Guard(std::cell::RefMut<'d, Dynamic>), /// A write guard to a shared [`RwLock`][std::sync::RwLock]. #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Guard(std::sync::RwLockWriteGuard<'d, Dynamic>), } impl<'d, T: Any + Clone> Deref for DynamicWriteLock<'d, T> { type Target = T; #[inline(always)] fn deref(&self) -> &Self::Target { match self.0 { DynamicWriteLockInner::Reference(ref reference) => *reference, #[cfg(not(feature = "no_closure"))] DynamicWriteLockInner::Guard(ref guard) => guard.downcast_ref().expect( "never fails because the write guard was created after checking the data type", ), } } } impl<'d, T: Any + Clone> DerefMut for DynamicWriteLock<'d, T> { #[inline(always)] fn deref_mut(&mut self) -> &mut Self::Target { match self.0 { DynamicWriteLockInner::Reference(ref mut reference) => *reference, #[cfg(not(feature = "no_closure"))] DynamicWriteLockInner::Guard(ref mut guard) => guard.downcast_mut().expect( "never fails because the write guard was created after checking the data type", ), } } } impl Dynamic { /// Get the arbitrary data attached to this [`Dynamic`]. #[must_use] pub const fn tag(&self) -> Tag { match self.0 { Union::Unit(_, tag, _) | Union::Bool(_, tag, _) | Union::Str(_, tag, _) | Union::Char(_, tag, _) | Union::Int(_, tag, _) | Union::FnPtr(_, tag, _) | Union::Variant(_, tag, _) => tag, #[cfg(not(feature = "no_float"))] Union::Float(_, tag, _) => tag, #[cfg(feature = "decimal")] Union::Decimal(_, tag, _) => tag, #[cfg(not(feature = "no_index"))] Union::Array(_, tag, _) => tag, #[cfg(not(feature = "no_object"))] Union::Map(_, tag, _) => tag, #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, tag, _) => tag, #[cfg(not(feature = "no_closure"))] Union::Shared(_, tag, _) => tag, } } /// Attach arbitrary data to this [`Dynamic`]. pub fn set_tag(&mut self, value: Tag) -> &mut Self { match self.0 { Union::Unit(_, ref mut tag, _) | Union::Bool(_, ref mut tag, _) | Union::Str(_, ref mut tag, _) | Union::Char(_, ref mut tag, _) | Union::Int(_, ref mut tag, _) | Union::FnPtr(_, ref mut tag, _) | Union::Variant(_, ref mut tag, _) => *tag = value, #[cfg(not(feature = "no_float"))] Union::Float(_, ref mut tag, _) => *tag = value, #[cfg(feature = "decimal")] Union::Decimal(_, ref mut tag, _) => *tag = value, #[cfg(not(feature = "no_index"))] Union::Array(_, ref mut tag, _) => *tag = value, #[cfg(not(feature = "no_object"))] Union::Map(_, ref mut tag, _) => *tag = value, #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, ref mut tag, _) => *tag = value, #[cfg(not(feature = "no_closure"))] Union::Shared(_, ref mut tag, _) => *tag = value, } self } /// Does this [`Dynamic`] hold a variant data type /// instead of one of the supported system primitive types? #[inline(always)] #[must_use] pub const fn is_variant(&self) -> bool { matches!(self.0, Union::Variant(_, _, _)) } /// Is the value held by this [`Dynamic`] shared? /// /// Not available under `no_closure`. #[cfg(not(feature = "no_closure"))] #[inline(always)] #[must_use] pub const fn is_shared(&self) -> bool { match self.0 { #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => true, _ => false, } } /// Is the value held by this [`Dynamic`] a particular type? /// /// If the [`Dynamic`] is a shared variant checking is performed on /// top of its internal value. #[inline(always)] #[must_use] pub fn is(&self) -> bool { if TypeId::of::() == TypeId::of::() { self.type_id() == TypeId::of::() } else { self.type_id() == TypeId::of::() } } /// Get the [`TypeId`] of the value held by this [`Dynamic`]. /// /// # Panics or Deadlocks When Value is Shared /// /// Under the `sync` feature, this call may deadlock, or [panic](https://doc.rust-lang.org/std/sync/struct.RwLock.html#panics-1). /// Otherwise, this call panics if the data is currently borrowed for write. #[must_use] pub fn type_id(&self) -> TypeId { match self.0 { Union::Unit(_, _, _) => TypeId::of::<()>(), Union::Bool(_, _, _) => TypeId::of::(), Union::Str(_, _, _) => TypeId::of::(), Union::Char(_, _, _) => TypeId::of::(), Union::Int(_, _, _) => TypeId::of::(), #[cfg(not(feature = "no_float"))] Union::Float(_, _, _) => TypeId::of::(), #[cfg(feature = "decimal")] Union::Decimal(_, _, _) => TypeId::of::(), #[cfg(not(feature = "no_index"))] Union::Array(_, _, _) => TypeId::of::(), #[cfg(not(feature = "no_object"))] Union::Map(_, _, _) => TypeId::of::(), Union::FnPtr(_, _, _) => TypeId::of::(), #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, _, _) => TypeId::of::(), Union::Variant(ref value, _, _) => (***value).type_id(), #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => (*cell.borrow()).type_id(), #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => (*cell.read().unwrap()).type_id(), } } /// Get the name of the type of the value held by this [`Dynamic`]. /// /// # Panics or Deadlocks When Value is Shared /// /// Under the `sync` feature, this call may deadlock, or [panic](https://doc.rust-lang.org/std/sync/struct.RwLock.html#panics-1). /// Otherwise, this call panics if the data is currently borrowed for write. #[must_use] pub fn type_name(&self) -> &'static str { match self.0 { Union::Unit(_, _, _) => "()", Union::Bool(_, _, _) => "bool", Union::Str(_, _, _) => "string", Union::Char(_, _, _) => "char", Union::Int(_, _, _) => type_name::(), #[cfg(not(feature = "no_float"))] Union::Float(_, _, _) => type_name::(), #[cfg(feature = "decimal")] Union::Decimal(_, _, _) => "decimal", #[cfg(not(feature = "no_index"))] Union::Array(_, _, _) => "array", #[cfg(not(feature = "no_object"))] Union::Map(_, _, _) => "map", Union::FnPtr(_, _, _) => "Fn", #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, _, _) => "timestamp", Union::Variant(ref value, _, _) => (***value).type_name(), #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => cell .try_borrow() .map(|v| (*v).type_name()) .unwrap_or(""), #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => (*cell.read().unwrap()).type_name(), } } } impl Hash for Dynamic { /// Hash the [`Dynamic`] value. /// /// # Panics /// /// Panics if the [`Dynamic`] value contains an unrecognized trait object. fn hash(&self, state: &mut H) { std::mem::discriminant(&self.0).hash(state); match self.0 { Union::Unit(_, _, _) => ().hash(state), Union::Bool(ref b, _, _) => b.hash(state), Union::Str(ref s, _, _) => s.hash(state), Union::Char(ref c, _, _) => c.hash(state), Union::Int(ref i, _, _) => i.hash(state), #[cfg(not(feature = "no_float"))] Union::Float(ref f, _, _) => f.hash(state), #[cfg(feature = "decimal")] Union::Decimal(ref d, _, _) => d.hash(state), #[cfg(not(feature = "no_index"))] Union::Array(ref a, _, _) => a.as_ref().hash(state), #[cfg(not(feature = "no_object"))] Union::Map(ref m, _, _) => m.as_ref().hash(state), Union::FnPtr(ref f, _, _) => f.hash(state), #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => (*cell.borrow()).hash(state), #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => (*cell.read().unwrap()).hash(state), Union::Variant(ref _value, _, _) => { #[cfg(not(feature = "only_i32"))] #[cfg(not(feature = "only_i64"))] { let value_any = (***_value).as_any(); let type_id = value_any.type_id(); if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } #[cfg(not(any(target_arch = "wasm32", target_arch = "wasm64")))] if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } else if type_id == TypeId::of::() { TypeId::of::().hash(state); value_any.downcast_ref::().expect(CHECKED).hash(state); } } unimplemented!("a custom type cannot be hashed") } #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, _, _) => unimplemented!("{} cannot be hashed", self.type_name()), } } } /// Map the name of a standard type into a friendly form. #[inline] #[must_use] pub(crate) fn map_std_type_name(name: &str) -> &str { if name == type_name::() { return "string"; } if name == type_name::() { return "string"; } if name == type_name::<&str>() { return "string"; } if name == type_name::() { return "Fn"; } #[cfg(feature = "decimal")] if name == type_name::() { return "decimal"; } #[cfg(not(feature = "no_index"))] if name == type_name::() { return "array"; } #[cfg(not(feature = "no_object"))] if name == type_name::() { return "map"; } #[cfg(not(feature = "no_std"))] if name == type_name::() { return "timestamp"; } name } impl fmt::Display for Dynamic { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self.0 { Union::Unit(_, _, _) => write!(f, ""), Union::Bool(ref value, _, _) => fmt::Display::fmt(value, f), Union::Str(ref value, _, _) => fmt::Display::fmt(value, f), Union::Char(ref value, _, _) => fmt::Display::fmt(value, f), Union::Int(ref value, _, _) => fmt::Display::fmt(value, f), #[cfg(not(feature = "no_float"))] Union::Float(ref value, _, _) => fmt::Display::fmt(value, f), #[cfg(feature = "decimal")] Union::Decimal(ref value, _, _) => fmt::Display::fmt(value, f), #[cfg(not(feature = "no_index"))] Union::Array(ref value, _, _) => fmt::Debug::fmt(value, f), #[cfg(not(feature = "no_object"))] Union::Map(ref value, _, _) => { f.write_str("#")?; fmt::Debug::fmt(value, f) } Union::FnPtr(ref value, _, _) => fmt::Display::fmt(value, f), #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, _, _) => f.write_str(""), Union::Variant(ref value, _, _) => { let _value_any = (***value).as_any(); let _type_id = _value_any.type_id(); #[cfg(not(feature = "only_i32"))] #[cfg(not(feature = "only_i64"))] if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } #[cfg(not(feature = "no_float"))] if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } #[cfg(not(any(target_arch = "wasm32", target_arch = "wasm64")))] if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Display::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } f.write_str((***value).type_name()) } #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => { if let Ok(v) = cell.try_borrow() { fmt::Display::fmt(&*v, f) } else { f.write_str("") } } #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => fmt::Display::fmt(&*cell.read().unwrap(), f), } } } impl fmt::Debug for Dynamic { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self.0 { Union::Unit(ref value, _, _) => fmt::Debug::fmt(value, f), Union::Bool(ref value, _, _) => fmt::Debug::fmt(value, f), Union::Str(ref value, _, _) => fmt::Debug::fmt(value, f), Union::Char(ref value, _, _) => fmt::Debug::fmt(value, f), Union::Int(ref value, _, _) => fmt::Debug::fmt(value, f), #[cfg(not(feature = "no_float"))] Union::Float(ref value, _, _) => fmt::Debug::fmt(value, f), #[cfg(feature = "decimal")] Union::Decimal(ref value, _, _) => fmt::Debug::fmt(value, f), #[cfg(not(feature = "no_index"))] Union::Array(ref value, _, _) => fmt::Debug::fmt(value, f), #[cfg(not(feature = "no_object"))] Union::Map(ref value, _, _) => { f.write_str("#")?; fmt::Debug::fmt(value, f) } Union::FnPtr(ref value, _, _) => fmt::Debug::fmt(value, f), #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, _, _) => write!(f, ""), Union::Variant(ref value, _, _) => { let _value_any = (***value).as_any(); let _type_id = _value_any.type_id(); #[cfg(not(feature = "only_i32"))] #[cfg(not(feature = "only_i64"))] if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } #[cfg(not(feature = "no_float"))] if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } #[cfg(not(any(target_arch = "wasm32", target_arch = "wasm64")))] if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } else if _type_id == TypeId::of::() { return fmt::Debug::fmt(_value_any.downcast_ref::().expect(CHECKED), f); } f.write_str((***value).type_name()) } #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => { if let Ok(v) = cell.try_borrow() { write!(f, "{:?} (shared)", *v) } else { f.write_str("") } } #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => fmt::Debug::fmt(&*cell.read().unwrap(), f), } } } use AccessMode::*; impl Clone for Dynamic { /// Clone the [`Dynamic`] value. /// /// # WARNING /// /// The cloned copy is marked read-write even if the original is read-only. fn clone(&self) -> Self { match self.0 { Union::Unit(value, tag, _) => Self(Union::Unit(value, tag, ReadWrite)), Union::Bool(value, tag, _) => Self(Union::Bool(value, tag, ReadWrite)), Union::Str(ref value, tag, _) => Self(Union::Str(value.clone(), tag, ReadWrite)), Union::Char(value, tag, _) => Self(Union::Char(value, tag, ReadWrite)), Union::Int(value, tag, _) => Self(Union::Int(value, tag, ReadWrite)), #[cfg(not(feature = "no_float"))] Union::Float(value, tag, _) => Self(Union::Float(value, tag, ReadWrite)), #[cfg(feature = "decimal")] Union::Decimal(ref value, tag, _) => { Self(Union::Decimal(value.clone(), tag, ReadWrite)) } #[cfg(not(feature = "no_index"))] Union::Array(ref value, tag, _) => Self(Union::Array(value.clone(), tag, ReadWrite)), #[cfg(not(feature = "no_object"))] Union::Map(ref value, tag, _) => Self(Union::Map(value.clone(), tag, ReadWrite)), Union::FnPtr(ref value, tag, _) => Self(Union::FnPtr(value.clone(), tag, ReadWrite)), #[cfg(not(feature = "no_std"))] Union::TimeStamp(ref value, tag, _) => { Self(Union::TimeStamp(value.clone(), tag, ReadWrite)) } Union::Variant(ref value, tag, _) => { let mut x = value.as_ref().as_ref().clone_into_dynamic(); x.set_tag(tag); x } #[cfg(not(feature = "no_closure"))] Union::Shared(ref cell, tag, _) => Self(Union::Shared(cell.clone(), tag, ReadWrite)), } } } impl Default for Dynamic { #[inline(always)] #[must_use] fn default() -> Self { Self::UNIT } } impl Dynamic { /// A [`Dynamic`] containing a `()`. pub const UNIT: Dynamic = Self(Union::Unit((), DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing a `true`. pub const TRUE: Dynamic = Self(Union::Bool(true, DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing a [`false`]. pub const FALSE: Dynamic = Self(Union::Bool(false, DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing the integer zero. pub const ZERO: Dynamic = Self(Union::Int(0, DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing the integer one. pub const ONE: Dynamic = Self(Union::Int(1, DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing the integer two. pub const TWO: Dynamic = Self(Union::Int(2, DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing the integer ten. pub const TEN: Dynamic = Self(Union::Int(10, DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing the integer negative one. pub const NEGATIVE_ONE: Dynamic = Self(Union::Int(-1, DEFAULT_TAG_VALUE, ReadWrite)); /// A [`Dynamic`] containing `0.0`. /// /// Not available under `no_float`. #[cfg(not(feature = "no_float"))] pub const FLOAT_ZERO: Dynamic = Self(Union::Float( FloatWrapper::new_const(0.0), DEFAULT_TAG_VALUE, ReadWrite, )); /// A [`Dynamic`] containing `1.0`. /// /// Not available under `no_float`. #[cfg(not(feature = "no_float"))] pub const FLOAT_ONE: Dynamic = Self(Union::Float( FloatWrapper::new_const(1.0), DEFAULT_TAG_VALUE, ReadWrite, )); /// A [`Dynamic`] containing `2.0`. /// /// Not available under `no_float`. #[cfg(not(feature = "no_float"))] pub const FLOAT_TWO: Dynamic = Self(Union::Float( FloatWrapper::new_const(2.0), DEFAULT_TAG_VALUE, ReadWrite, )); /// A [`Dynamic`] containing `10.0`. /// /// Not available under `no_float`. #[cfg(not(feature = "no_float"))] pub const FLOAT_TEN: Dynamic = Self(Union::Float( FloatWrapper::new_const(10.0), DEFAULT_TAG_VALUE, ReadWrite, )); /// A [`Dynamic`] containing the `-1.0`. /// /// Not available under `no_float`. #[cfg(not(feature = "no_float"))] pub const FLOAT_NEGATIVE_ONE: Dynamic = Self(Union::Float( FloatWrapper::new_const(-1.0), DEFAULT_TAG_VALUE, ReadWrite, )); /// Get the [`AccessMode`] for this [`Dynamic`]. #[must_use] pub(crate) const fn access_mode(&self) -> AccessMode { match self.0 { Union::Unit(_, _, access) | Union::Bool(_, _, access) | Union::Str(_, _, access) | Union::Char(_, _, access) | Union::Int(_, _, access) | Union::FnPtr(_, _, access) | Union::Variant(_, _, access) => access, #[cfg(not(feature = "no_float"))] Union::Float(_, _, access) => access, #[cfg(feature = "decimal")] Union::Decimal(_, _, access) => access, #[cfg(not(feature = "no_index"))] Union::Array(_, _, access) => access, #[cfg(not(feature = "no_object"))] Union::Map(_, _, access) => access, #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, _, access) => access, #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, access) => access, } } /// Set the [`AccessMode`] for this [`Dynamic`]. pub(crate) fn set_access_mode(&mut self, typ: AccessMode) -> &mut Self { match self.0 { Union::Unit(_, _, ref mut access) | Union::Bool(_, _, ref mut access) | Union::Str(_, _, ref mut access) | Union::Char(_, _, ref mut access) | Union::Int(_, _, ref mut access) | Union::FnPtr(_, _, ref mut access) | Union::Variant(_, _, ref mut access) => *access = typ, #[cfg(not(feature = "no_float"))] Union::Float(_, _, ref mut access) => *access = typ, #[cfg(feature = "decimal")] Union::Decimal(_, _, ref mut access) => *access = typ, #[cfg(not(feature = "no_index"))] Union::Array(ref mut a, _, ref mut access) => { *access = typ; a.iter_mut().for_each(|v| { v.set_access_mode(typ); }); } #[cfg(not(feature = "no_object"))] Union::Map(ref mut m, _, ref mut access) => { *access = typ; m.values_mut().for_each(|v| { v.set_access_mode(typ); }); } #[cfg(not(feature = "no_std"))] Union::TimeStamp(_, _, ref mut access) => *access = typ, #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, ref mut access) => *access = typ, } self } /// Is this [`Dynamic`] read-only? /// /// Constant [`Dynamic`] values are read-only. If a [`&mut Dynamic`][Dynamic] to such a constant /// is passed to a Rust function, the function can use this information to return an error of /// [`ErrorAssignmentToConstant`][crate::EvalAltResult::ErrorAssignmentToConstant] /// if its value is going to be modified. This safe-guards constant values from being modified /// from within Rust functions. #[must_use] pub fn is_read_only(&self) -> bool { #[cfg(not(feature = "no_closure"))] match self.0 { Union::Shared(_, _, ReadOnly) => return true, #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => { return match cell.borrow().access_mode() { ReadWrite => false, ReadOnly => true, } } #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => { return match cell.read().unwrap().access_mode() { ReadWrite => false, ReadOnly => true, } } _ => (), } match self.access_mode() { ReadWrite => false, ReadOnly => true, } } /// Can this [`Dynamic`] be hashed? #[must_use] pub(crate) fn is_hashable(&self) -> bool { match self.0 { Union::Unit(_, _, _) | Union::Bool(_, _, _) | Union::Str(_, _, _) | Union::Char(_, _, _) | Union::Int(_, _, _) => true, #[cfg(not(feature = "no_float"))] Union::Float(_, _, _) => true, #[cfg(not(feature = "no_index"))] Union::Array(_, _, _) => true, #[cfg(not(feature = "no_object"))] Union::Map(_, _, _) => true, #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => cell.borrow().is_hashable(), #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => cell.read().unwrap().is_hashable(), _ => false, } } /// Create a [`Dynamic`] from any type. A [`Dynamic`] value is simply returned as is. /// /// # Safety /// /// This type uses some unsafe code, mainly for type casting. /// /// # Notes /// /// Beware that you need to pass in an [`Array`] type for it to be recognized as an [`Array`]. /// A [`Vec`][Vec] does not get automatically converted to an [`Array`], but will be a generic /// restricted trait object instead, because [`Vec`][Vec] is not a supported standard type. /// /// Similarly, passing in a [`HashMap`][std::collections::HashMap] or /// [`BTreeMap`][std::collections::BTreeMap] will not get a [`Map`] but a trait object. /// /// # Examples /// /// ``` /// use rhai::Dynamic; /// /// let result = Dynamic::from(42_i64); /// assert_eq!(result.type_name(), "i64"); /// assert_eq!(result.to_string(), "42"); /// /// let result = Dynamic::from("hello"); /// assert_eq!(result.type_name(), "string"); /// assert_eq!(result.to_string(), "hello"); /// /// let new_result = Dynamic::from(result); /// assert_eq!(new_result.type_name(), "string"); /// assert_eq!(new_result.to_string(), "hello"); /// ``` #[inline(always)] #[must_use] pub fn from(mut value: T) -> Self { // Coded this way in order to maximally leverage potentials for dead-code removal. if TypeId::of::() == TypeId::of::() { return unsafe_try_cast::<_, Dynamic>(value).ok().expect(CHECKED); } let val = value.as_any(); if TypeId::of::() == TypeId::of::() { return (*val.downcast_ref::().expect(CHECKED)).into(); } #[cfg(not(feature = "no_float"))] if TypeId::of::() == TypeId::of::() { return (*val.downcast_ref::().expect(CHECKED)).into(); } #[cfg(feature = "decimal")] if TypeId::of::() == TypeId::of::() { return (*val.downcast_ref::().expect(CHECKED)).into(); } if TypeId::of::() == TypeId::of::() { return (*val.downcast_ref::().expect(CHECKED)).into(); } if TypeId::of::() == TypeId::of::() { return (*val.downcast_ref::().expect(CHECKED)).into(); } if TypeId::of::() == TypeId::of::() { return val .downcast_ref::() .expect(CHECKED) .clone() .into(); } if TypeId::of::() == TypeId::of::<&str>() { return val.downcast_ref::<&str>().expect(CHECKED).deref().into(); } if TypeId::of::() == TypeId::of::<()>() { return ().into(); } value = match unsafe_try_cast::<_, String>(value) { Ok(s) => return s.into(), Err(value) => value, }; #[cfg(not(feature = "no_index"))] { value = match unsafe_try_cast::<_, Array>(value) { Ok(array) => return array.into(), Err(value) => value, }; } #[cfg(not(feature = "no_object"))] { value = match unsafe_try_cast::<_, Map>(value) { Ok(map) => return map.into(), Err(value) => value, }; } value = match unsafe_try_cast::<_, FnPtr>(value) { Ok(fn_ptr) => return fn_ptr.into(), Err(value) => value, }; #[cfg(not(feature = "no_std"))] { value = match unsafe_try_cast::<_, Instant>(value) { Ok(timestamp) => return timestamp.into(), Err(value) => value, }; } #[cfg(not(feature = "no_closure"))] { value = match unsafe_try_cast::<_, crate::Shared>>(value) { Ok(value) => return value.into(), Err(value) => value, }; } Self(Union::Variant( Box::new(Box::new(value)), DEFAULT_TAG_VALUE, ReadWrite, )) } /// Turn the [`Dynamic`] value into a shared [`Dynamic`] value backed by an /// [`Rc`][std::rc::Rc]`<`[`RefCell`][std::cell::RefCell]`<`[`Dynamic`]`>>` or /// [`Arc`][std::sync::Arc]`<`[`RwLock`][std::sync::RwLock]`<`[`Dynamic`]`>>` /// depending on the `sync` feature. /// /// Not available under `no_closure`. /// /// Shared [`Dynamic`] values are relatively cheap to clone as they simply increment the /// reference counts. /// /// Shared [`Dynamic`] values can be converted seamlessly to and from ordinary [`Dynamic`] /// values. /// /// If the [`Dynamic`] value is already shared, this method returns itself. #[cfg(not(feature = "no_closure"))] #[inline(always)] #[must_use] pub fn into_shared(self) -> Self { let _access = self.access_mode(); match self.0 { Union::Shared(_, _, _) => self, _ => Self(Union::Shared( crate::Locked::new(self).into(), DEFAULT_TAG_VALUE, _access, )), } } /// Convert the [`Dynamic`] value into specific type. /// /// Casting to a [`Dynamic`] just returns as is, but if it contains a shared value, /// it is cloned into a [`Dynamic`] with a normal value. /// /// Returns [`None`] if types mismatched. /// /// # Panics or Deadlocks /// /// Under the `sync` feature, this call may deadlock, or [panic](https://doc.rust-lang.org/std/sync/struct.RwLock.html#panics-1). /// Otherwise, this call panics if the data is currently borrowed for write. /// /// These normally shouldn't occur since most operations in Rhai is single-threaded. /// /// # Example /// /// ``` /// use rhai::Dynamic; /// /// let x = Dynamic::from(42_u32); /// /// assert_eq!(x.try_cast::().unwrap(), 42); /// ``` #[inline(always)] #[must_use] pub fn try_cast(self) -> Option { // Coded this way in order to maximally leverage potentials for dead-code removal. #[cfg(not(feature = "no_closure"))] if let Union::Shared(_, _, _) = self.0 { return self.flatten().try_cast::(); } if TypeId::of::() == TypeId::of::() { return unsafe_try_cast::<_, T>(self).ok(); } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Int(value, _, _) => unsafe_try_cast(value).ok(), _ => None, }; } #[cfg(not(feature = "no_float"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Float(value, _, _) => unsafe_try_cast(*value).ok(), _ => None, }; } #[cfg(feature = "decimal")] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Decimal(value, _, _) => unsafe_try_cast(*value).ok(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Bool(value, _, _) => unsafe_try_cast(value).ok(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Str(value, _, _) => unsafe_try_cast(value).ok(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Str(value, _, _) => unsafe_try_cast(value.into_owned()).ok(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Char(value, _, _) => unsafe_try_cast(value).ok(), _ => None, }; } #[cfg(not(feature = "no_index"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Array(value, _, _) => unsafe_cast_box::<_, T>(value).ok().map(|v| *v), _ => None, }; } #[cfg(not(feature = "no_object"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Map(value, _, _) => unsafe_cast_box::<_, T>(value).ok().map(|v| *v), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::FnPtr(value, _, _) => unsafe_cast_box::<_, T>(value).ok().map(|v| *v), _ => None, }; } #[cfg(not(feature = "no_std"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::TimeStamp(value, _, _) => unsafe_cast_box::<_, T>(value).ok().map(|v| *v), _ => None, }; } if TypeId::of::() == TypeId::of::<()>() { return match self.0 { Union::Unit(value, _, _) => unsafe_try_cast(value).ok(), _ => None, }; } match self.0 { Union::Variant(value, _, _) => (*value).as_box_any().downcast().map(|x| *x).ok(), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => unreachable!("Union::Shared case should be already handled"), _ => None, } } /// Convert the [`Dynamic`] value into a specific type. /// /// Casting to a [`Dynamic`] just returns as is, but if it contains a shared value, /// it is cloned into a [`Dynamic`] with a normal value. /// /// Returns [`None`] if types mismatched. /// /// # Panics or Deadlocks /// /// Panics if the cast fails (e.g. the type of the actual value is not the /// same as the specified type). /// /// Under the `sync` feature, this call may deadlock, or [panic](https://doc.rust-lang.org/std/sync/struct.RwLock.html#panics-1). /// Otherwise, this call panics if the data is currently borrowed for write. /// /// These normally shouldn't occur since most operations in Rhai is single-threaded. /// /// # Example /// /// ``` /// use rhai::Dynamic; /// /// let x = Dynamic::from(42_u32); /// /// assert_eq!(x.cast::(), 42); /// ``` #[inline] #[must_use] pub fn cast(self) -> T { #[cfg(not(feature = "no_closure"))] let self_type_name = if self.is_shared() { // Avoid panics/deadlocks with shared values "" } else { self.type_name() }; #[cfg(feature = "no_closure")] let self_type_name = self.type_name(); self.try_cast::().unwrap_or_else(|| { panic!( "cannot cast {} value and to {}", self_type_name, type_name::() ) }) } /// Clone the [`Dynamic`] value and convert it into a specific type. /// /// Casting to a [`Dynamic`] just returns as is, but if it contains a shared value, /// it is cloned into a [`Dynamic`] with a normal value. /// /// Returns [`None`] if types mismatched. /// /// # Panics or Deadlocks /// /// Panics if the cast fails (e.g. the type of the actual value is not the /// same as the specified type). /// /// Under the `sync` feature, this call may deadlock, or [panic](https://doc.rust-lang.org/std/sync/struct.RwLock.html#panics-1). /// Otherwise, this call panics if the data is currently borrowed for write. /// /// These normally shouldn't occur since most operations in Rhai is single-threaded. /// /// # Example /// /// ``` /// use rhai::Dynamic; /// /// let x = Dynamic::from(42_u32); /// let y = &x; /// /// assert_eq!(y.clone_cast::(), 42); /// ``` #[inline(always)] #[must_use] pub fn clone_cast(&self) -> T { self.flatten_clone().cast::() } /// Flatten the [`Dynamic`] and clone it. /// /// If the [`Dynamic`] is not a shared value, it returns a cloned copy. /// /// If the [`Dynamic`] is a shared value, it returns a cloned copy of the shared value. #[inline(always)] #[must_use] pub fn flatten_clone(&self) -> Self { match self.0 { #[cfg(not(feature = "no_closure"))] #[cfg(not(feature = "sync"))] Union::Shared(ref cell, _, _) => cell.borrow().clone(), #[cfg(not(feature = "no_closure"))] #[cfg(feature = "sync")] Union::Shared(ref cell, _, _) => cell.read().unwrap().clone(), _ => self.clone(), } } /// Flatten the [`Dynamic`]. /// /// If the [`Dynamic`] is not a shared value, it returns itself. /// /// If the [`Dynamic`] is a shared value, it returns the shared value if there are no /// outstanding references, or a cloned copy. #[inline(always)] #[must_use] pub fn flatten(self) -> Self { match self.0 { #[cfg(not(feature = "no_closure"))] Union::Shared(cell, _, _) => crate::fn_native::shared_try_take(cell).map_or_else( #[cfg(not(feature = "sync"))] |cell| cell.borrow().clone(), #[cfg(feature = "sync")] |cell| cell.read().unwrap().clone(), #[cfg(not(feature = "sync"))] |value| value.into_inner(), #[cfg(feature = "sync")] |value| value.into_inner().unwrap(), ), _ => self, } } /// Flatten the [`Dynamic`] in place. /// /// If the [`Dynamic`] is not a shared value, it does nothing. /// /// If the [`Dynamic`] is a shared value, it is set to the shared value if there are no /// outstanding references, or a cloned copy otherwise. #[inline(always)] pub(crate) fn flatten_in_place(&mut self) -> &mut Self { match self.0 { #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => match std::mem::take(self).0 { Union::Shared(cell, _, _) => { *self = crate::fn_native::shared_try_take(cell).map_or_else( #[cfg(not(feature = "sync"))] |cell| cell.borrow().clone(), #[cfg(feature = "sync")] |cell| cell.read().unwrap().clone(), #[cfg(not(feature = "sync"))] |value| value.into_inner(), #[cfg(feature = "sync")] |value| value.into_inner().unwrap(), ); } _ => unreachable!(), }, _ => (), } self } /// Is the [`Dynamic`] a shared value that is locked? /// /// Not available under `no_closure`. /// /// ## Note /// /// Under the `sync` feature, shared values use [`RwLock`][std::sync::RwLock] and they are never locked. /// Access just waits until the [`RwLock`][std::sync::RwLock] is released. /// So this method always returns [`false`] under [`Sync`]. #[cfg(not(feature = "no_closure"))] #[inline(always)] #[must_use] pub fn is_locked(&self) -> bool { #[cfg(not(feature = "no_closure"))] match self.0 { Union::Shared(ref _cell, _, _) => { #[cfg(not(feature = "sync"))] return _cell.try_borrow().is_err(); #[cfg(feature = "sync")] return false; } _ => (), } false } /// Get a reference of a specific type to the [`Dynamic`]. /// Casting to [`Dynamic`] just returns a reference to it. /// /// Returns [`None`] if the cast fails. /// /// # Panics or Deadlocks When Value is Shared /// /// Under the `sync` feature, this call may deadlock, or [panic](https://doc.rust-lang.org/std/sync/struct.RwLock.html#panics-1). /// Otherwise, this call panics if the data is currently borrowed for write. #[inline] #[must_use] pub fn read_lock(&self) -> Option> { match self.0 { #[cfg(not(feature = "no_closure"))] Union::Shared(ref cell, _, _) => { #[cfg(not(feature = "sync"))] let value = cell.borrow(); #[cfg(feature = "sync")] let value = cell.read().unwrap(); if (*value).type_id() != TypeId::of::() && TypeId::of::() != TypeId::of::() { return None; } else { return Some(DynamicReadLock(DynamicReadLockInner::Guard(value))); } } _ => (), } self.downcast_ref() .map(|r| DynamicReadLock(DynamicReadLockInner::Reference(r))) } /// Get a mutable reference of a specific type to the [`Dynamic`]. /// Casting to [`Dynamic`] just returns a mutable reference to it. /// /// Returns [`None`] if the cast fails. /// /// # Panics or Deadlocks When Value is Shared /// /// Under the `sync` feature, this call may deadlock, or [panic](https://doc.rust-lang.org/std/sync/struct.RwLock.html#panics-1). /// Otherwise, this call panics if the data is currently borrowed for write. #[inline] #[must_use] pub fn write_lock(&mut self) -> Option> { match self.0 { #[cfg(not(feature = "no_closure"))] Union::Shared(ref cell, _, _) => { #[cfg(not(feature = "sync"))] let value = cell.borrow_mut(); #[cfg(feature = "sync")] let value = cell.write().unwrap(); if (*value).type_id() != TypeId::of::() && TypeId::of::() != TypeId::of::() { return None; } else { return Some(DynamicWriteLock(DynamicWriteLockInner::Guard(value))); } } _ => (), } self.downcast_mut() .map(|r| DynamicWriteLock(DynamicWriteLockInner::Reference(r))) } /// Get a reference of a specific type to the [`Dynamic`]. /// Casting to [`Dynamic`] just returns a reference to it. /// /// Returns [`None`] if the cast fails, or if the value is shared. #[inline(always)] #[must_use] pub(crate) fn downcast_ref(&self) -> Option<&T> { // Coded this way in order to maximally leverage potentials for dead-code removal. if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Int(ref value, _, _) => value.as_any().downcast_ref::(), _ => None, }; } #[cfg(not(feature = "no_float"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Float(ref value, _, _) => value.as_ref().as_any().downcast_ref::(), _ => None, }; } #[cfg(feature = "decimal")] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Decimal(ref value, _, _) => value.as_ref().as_any().downcast_ref::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Bool(ref value, _, _) => value.as_any().downcast_ref::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Str(ref value, _, _) => value.as_any().downcast_ref::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Char(ref value, _, _) => value.as_any().downcast_ref::(), _ => None, }; } #[cfg(not(feature = "no_index"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Array(ref value, _, _) => value.as_ref().as_any().downcast_ref::(), _ => None, }; } #[cfg(not(feature = "no_object"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Map(ref value, _, _) => value.as_ref().as_any().downcast_ref::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::FnPtr(ref value, _, _) => value.as_ref().as_any().downcast_ref::(), _ => None, }; } #[cfg(not(feature = "no_std"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::TimeStamp(ref value, _, _) => value.as_ref().as_any().downcast_ref::(), _ => None, }; } if TypeId::of::() == TypeId::of::<()>() { return match self.0 { Union::Unit(ref value, _, _) => value.as_any().downcast_ref::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return self.as_any().downcast_ref::(); } match self.0 { Union::Variant(ref value, _, _) => (***value).as_any().downcast_ref::(), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => None, _ => None, } } /// Get a mutable reference of a specific type to the [`Dynamic`]. /// Casting to [`Dynamic`] just returns a mutable reference to it. /// /// Returns [`None`] if the cast fails, or if the value is shared. #[inline(always)] #[must_use] pub(crate) fn downcast_mut(&mut self) -> Option<&mut T> { // Coded this way in order to maximally leverage potentials for dead-code removal. if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Int(ref mut value, _, _) => value.as_mut_any().downcast_mut::(), _ => None, }; } #[cfg(not(feature = "no_float"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Float(ref mut value, _, _) => { value.as_mut().as_mut_any().downcast_mut::() } _ => None, }; } #[cfg(feature = "decimal")] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Decimal(ref mut value, _, _) => { value.as_mut().as_mut_any().downcast_mut::() } _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Bool(ref mut value, _, _) => value.as_mut_any().downcast_mut::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Str(ref mut value, _, _) => value.as_mut_any().downcast_mut::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Char(ref mut value, _, _) => value.as_mut_any().downcast_mut::(), _ => None, }; } #[cfg(not(feature = "no_index"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Array(ref mut value, _, _) => { value.as_mut().as_mut_any().downcast_mut::() } _ => None, }; } #[cfg(not(feature = "no_object"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::Map(ref mut value, _, _) => value.as_mut().as_mut_any().downcast_mut::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return match self.0 { Union::FnPtr(ref mut value, _, _) => { value.as_mut().as_mut_any().downcast_mut::() } _ => None, }; } #[cfg(not(feature = "no_std"))] if TypeId::of::() == TypeId::of::() { return match self.0 { Union::TimeStamp(ref mut value, _, _) => { value.as_mut().as_mut_any().downcast_mut::() } _ => None, }; } if TypeId::of::() == TypeId::of::<()>() { return match self.0 { Union::Unit(ref mut value, _, _) => value.as_mut_any().downcast_mut::(), _ => None, }; } if TypeId::of::() == TypeId::of::() { return self.as_mut_any().downcast_mut::(); } match self.0 { Union::Variant(ref mut value, _, _) => (***value).as_mut_any().downcast_mut::(), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => None, _ => None, } } /// Cast the [`Dynamic`] as a unit `()` and return it. /// Returns the name of the actual type if the cast fails. #[inline(always)] pub fn as_unit(&self) -> Result<(), &'static str> { match self.0 { Union::Unit(value, _, _) => Ok(value), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => self.read_lock().map(|v| *v).ok_or_else(|| self.type_name()), _ => Err(self.type_name()), } } /// Cast the [`Dynamic`] as the system integer type [`INT`] and return it. /// Returns the name of the actual type if the cast fails. #[inline(always)] pub fn as_int(&self) -> Result { match self.0 { Union::Int(n, _, _) => Ok(n), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => self.read_lock().map(|v| *v).ok_or_else(|| self.type_name()), _ => Err(self.type_name()), } } /// Cast the [`Dynamic`] as the system floating-point type [`FLOAT`] and return it. /// Returns the name of the actual type if the cast fails. /// /// Not available under `no_float`. #[cfg(not(feature = "no_float"))] #[inline(always)] pub fn as_float(&self) -> Result { match self.0 { Union::Float(n, _, _) => Ok(*n), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => self.read_lock().map(|v| *v).ok_or_else(|| self.type_name()), _ => Err(self.type_name()), } } /// _(DECIMAL)_ Cast the [`Dynamic`] as a [`Decimal`] and return it. /// Returns the name of the actual type if the cast fails. /// /// Exported under the `decimal` feature only. #[cfg(feature = "decimal")] #[inline(always)] pub fn as_decimal(&self) -> Result { match self.0 { Union::Decimal(ref n, _, _) => Ok(**n), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => self.read_lock().map(|v| *v).ok_or_else(|| self.type_name()), _ => Err(self.type_name()), } } /// Cast the [`Dynamic`] as a [`bool`] and return it. /// Returns the name of the actual type if the cast fails. #[inline(always)] pub fn as_bool(&self) -> Result { match self.0 { Union::Bool(b, _, _) => Ok(b), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => self.read_lock().map(|v| *v).ok_or_else(|| self.type_name()), _ => Err(self.type_name()), } } /// Cast the [`Dynamic`] as a [`char`] and return it. /// Returns the name of the actual type if the cast fails. #[inline(always)] pub fn as_char(&self) -> Result { match self.0 { Union::Char(n, _, _) => Ok(n), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => self.read_lock().map(|v| *v).ok_or_else(|| self.type_name()), _ => Err(self.type_name()), } } /// Cast the [`Dynamic`] as an [`ImmutableString`] and return it. /// Returns the name of the actual type if the cast fails. /// /// # Panics /// /// Panics if the value is shared. #[inline(always)] pub(crate) fn as_str_ref(&self) -> Result<&str, &'static str> { match self.0 { Union::Str(ref s, _, _) => Ok(s), #[cfg(not(feature = "no_closure"))] Union::Shared(_, _, _) => panic!("as_str() cannot be called on shared values"), _ => Err(self.type_name()), } } /// Convert the [`Dynamic`] into a [`String`] and return it. /// If there are other references to the same string, a cloned copy is returned. /// Returns the name of the actual type if the cast fails. #[inline(always)] pub fn as_string(self) -> Result { self.as_immutable_string().map(ImmutableString::into_owned) } /// Convert the [`Dynamic`] into an [`ImmutableString`] and return it. /// Returns the name of the actual type if the cast fails. #[inline] pub fn as_immutable_string(self) -> Result { match self.0 { Union::Str(s, _, _) => Ok(s), #[cfg(not(feature = "no_closure"))] Union::Shared(cell, _, _) => { #[cfg(not(feature = "sync"))] let value = cell.borrow(); #[cfg(feature = "sync")] let value = cell.read().unwrap(); match value.0 { Union::Str(ref s, _, _) => Ok(s.clone()), _ => Err((*value).type_name()), } } _ => Err(self.type_name()), } } } impl From<()> for Dynamic { #[inline(always)] fn from(value: ()) -> Self { Self(Union::Unit(value, DEFAULT_TAG_VALUE, ReadWrite)) } } impl From for Dynamic { #[inline(always)] fn from(value: bool) -> Self { Self(Union::Bool(value, DEFAULT_TAG_VALUE, ReadWrite)) } } impl From for Dynamic { #[inline(always)] fn from(value: INT) -> Self { Self(Union::Int(value, DEFAULT_TAG_VALUE, ReadWrite)) } } #[cfg(not(feature = "no_float"))] impl From for Dynamic { #[inline(always)] fn from(value: FLOAT) -> Self { Self(Union::Float(value.into(), DEFAULT_TAG_VALUE, ReadWrite)) } } #[cfg(not(feature = "no_float"))] impl From> for Dynamic { #[inline(always)] fn from(value: FloatWrapper) -> Self { Self(Union::Float(value, DEFAULT_TAG_VALUE, ReadWrite)) } } #[cfg(feature = "decimal")] impl From for Dynamic { #[inline(always)] fn from(value: Decimal) -> Self { Self(Union::Decimal(value.into(), DEFAULT_TAG_VALUE, ReadWrite)) } } impl From for Dynamic { #[inline(always)] fn from(value: char) -> Self { Self(Union::Char(value, DEFAULT_TAG_VALUE, ReadWrite)) } } impl> From for Dynamic { #[inline(always)] fn from(value: S) -> Self { Self(Union::Str(value.into(), DEFAULT_TAG_VALUE, ReadWrite)) } } impl From<&ImmutableString> for Dynamic { #[inline(always)] fn from(value: &ImmutableString) -> Self { value.clone().into() } } #[cfg(not(feature = "no_index"))] impl Dynamic { /// Create a [`Dynamic`] from an [`Array`]. #[inline(always)] pub(crate) fn from_array(array: Array) -> Self { Self(Union::Array(array.into(), DEFAULT_TAG_VALUE, ReadWrite)) } } #[cfg(not(feature = "no_index"))] impl From> for Dynamic { #[inline(always)] fn from(value: Vec) -> Self { Self(Union::Array( Box::new(value.into_iter().map(Dynamic::from).collect()), DEFAULT_TAG_VALUE, ReadWrite, )) } } #[cfg(not(feature = "no_index"))] impl From<&[T]> for Dynamic { #[inline(always)] fn from(value: &[T]) -> Self { Self(Union::Array( Box::new(value.iter().cloned().map(Dynamic::from).collect()), DEFAULT_TAG_VALUE, ReadWrite, )) } } #[cfg(not(feature = "no_index"))] impl std::iter::FromIterator for Dynamic { #[inline(always)] fn from_iter>(iter: X) -> Self { Self(Union::Array( Box::new(iter.into_iter().map(Dynamic::from).collect()), DEFAULT_TAG_VALUE, ReadWrite, )) } } #[cfg(not(feature = "no_object"))] impl Dynamic { /// Create a [`Dynamic`] from a [`Map`]. #[inline(always)] pub(crate) fn from_map(map: Map) -> Self { Self(Union::Map(map.into(), DEFAULT_TAG_VALUE, ReadWrite)) } } #[cfg(not(feature = "no_object"))] #[cfg(not(feature = "no_std"))] impl, T: Variant + Clone> From> for Dynamic { #[inline(always)] fn from(value: std::collections::HashMap) -> Self { Self(Union::Map( Box::new( value .into_iter() .map(|(k, v)| (k.into(), Dynamic::from(v))) .collect(), ), DEFAULT_TAG_VALUE, ReadWrite, )) } } #[cfg(not(feature = "no_object"))] #[cfg(not(feature = "no_std"))] impl> From> for Dynamic { #[inline(always)] fn from(value: std::collections::HashSet) -> Self { Self(Union::Map( Box::new( value .into_iter() .map(|k| (k.into(), Dynamic::UNIT)) .collect(), ), DEFAULT_TAG_VALUE, ReadWrite, )) } } #[cfg(not(feature = "no_object"))] impl, T: Variant + Clone> From> for Dynamic { #[inline(always)] fn from(value: std::collections::BTreeMap) -> Self { Self(Union::Map( Box::new( value .into_iter() .map(|(k, v)| (k.into(), Dynamic::from(v))) .collect(), ), DEFAULT_TAG_VALUE, ReadWrite, )) } } #[cfg(not(feature = "no_object"))] impl> From> for Dynamic { #[inline(always)] fn from(value: std::collections::BTreeSet) -> Self { Self(Union::Map( Box::new( value .into_iter() .map(|k| (k.into(), Dynamic::UNIT)) .collect(), ), DEFAULT_TAG_VALUE, ReadWrite, )) } } impl From for Dynamic { #[inline(always)] fn from(value: FnPtr) -> Self { Self(Union::FnPtr(value.into(), DEFAULT_TAG_VALUE, ReadWrite)) } } impl From> for Dynamic { #[inline(always)] fn from(value: Box) -> Self { Self(Union::FnPtr(value, DEFAULT_TAG_VALUE, ReadWrite)) } } #[cfg(not(feature = "no_std"))] impl From for Dynamic { #[inline(always)] fn from(value: Instant) -> Self { Self(Union::TimeStamp(value.into(), DEFAULT_TAG_VALUE, ReadWrite)) } } #[cfg(not(feature = "no_closure"))] impl From>> for Dynamic { #[inline(always)] fn from(value: crate::Shared>) -> Self { Self(Union::Shared(value, DEFAULT_TAG_VALUE, ReadWrite)) } }