[−][src]Struct rhai::plugin::Dynamic
Dynamic type containing any value.
Implementations
impl Dynamic
[src]
pub fn is_variant(&self) -> bool
[src]
Does this Dynamic
hold a variant data type
instead of one of the support system primitive types?
pub fn is_shared(&self) -> bool
[src]
Does this Dynamic
hold a shared data type
instead of one of the supported system primitive types?
pub fn is<T: Variant + Clone>(&self) -> bool
[src]
Is the value held by this Dynamic
a particular type?
If the Dynamic
is a Shared variant checking is performed on
top of it's internal value.
pub fn type_id(&self) -> TypeId
[src]
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.
Otherwise, this call panics if the data is currently borrowed for write.
pub fn type_name(&self) -> &'static str
[src]
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.
Otherwise, this call panics if the data is currently borrowed for write.
impl Dynamic
[src]
pub fn from<T: Variant + Clone>(value: T) -> Self
[src]
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<T>
does not get automatically converted to an Array
, but will be a generic
restricted trait object instead, because Vec<T>
is not a supported standard type.
Similarly, passing in a HashMap<String, T>
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");
pub fn into_shared(self) -> Self
[src]
Turn the Dynamic
value into a shared Dynamic
value backed by an Rc<RefCell<Dynamic>>
or Arc<RwLock<Dynamic>>
depending on the sync
feature.
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.
Panics
Panics under the no_closure
feature.
pub fn try_cast<T: Variant>(self) -> Option<T>
[src]
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.
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::<u32>().unwrap(), 42);
pub fn cast<T: Variant + Clone>(self) -> T
[src]
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.
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::<u32>(), 42);
pub fn flatten_clone(&self) -> Self
[src]
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 a cloned copy of the shared value.
pub fn flatten(self) -> Self
[src]
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.
pub fn is_locked(&self) -> bool
[src]
Is the Dynamic
a shared value that is locked?
Note
Under the sync
feature, shared values use RwLock
and they are never locked.
Access just waits until the RwLock
is released.
So this method always returns false
under sync
.
pub fn read_lock<T: Variant + Clone>(&self) -> Option<DynamicReadLock<'_, T>>
[src]
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.
Otherwise, this call panics if the data is currently borrowed for write.
pub fn write_lock<T: Variant + Clone>(
&mut self
) -> Option<DynamicWriteLock<'_, T>>
[src]
&mut self
) -> Option<DynamicWriteLock<'_, T>>
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.
Otherwise, this call panics if the data is currently borrowed for write.
pub fn as_int(&self) -> Result<INT, &'static str>
[src]
Cast the Dynamic
as the system integer type INT
and return it.
Returns the name of the actual type if the cast fails.
pub fn as_float(&self) -> Result<FLOAT, &'static str>
[src]
Cast the Dynamic
as the system floating-point type FLOAT
and return it.
Returns the name of the actual type if the cast fails.
pub fn as_bool(&self) -> Result<bool, &'static str>
[src]
Cast the Dynamic
as a bool
and return it.
Returns the name of the actual type if the cast fails.
pub fn as_char(&self) -> Result<char, &'static str>
[src]
Cast the Dynamic
as a char
and return it.
Returns the name of the actual type if the cast fails.
pub fn as_str(&self) -> Result<&str, &'static str>
[src]
Cast the Dynamic
as a string and return the string slice.
Returns the name of the actual type if the cast fails.
Cast is failing if self
is Shared Dynamic
pub fn take_string(self) -> Result<String, &'static str>
[src]
Convert the Dynamic
into 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.
pub fn take_immutable_string(self) -> Result<ImmutableString, &'static str>
[src]
Convert the Dynamic
into ImmutableString
and return it.
Returns the name of the actual type if the cast fails.
Trait Implementations
impl Clone for Dynamic
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for Dynamic
[src]
impl Default for Dynamic
[src]
impl Display for Dynamic
[src]
impl<T: Variant + Clone, '_> From<&'_ [T]> for Dynamic
[src]
impl From<()> for Dynamic
[src]
impl From<Box<FnPtr, Global>> for Dynamic
[src]
impl From<FnPtr> for Dynamic
[src]
impl<K: Into<ImmutableString>, T: Variant + Clone> From<HashMap<K, T, RandomState>> for Dynamic
[src]
impl From<Instant> for Dynamic
[src]
impl<S: Into<ImmutableString>> From<S> for Dynamic
[src]
impl<T: Variant + Clone> From<Vec<T>> for Dynamic
[src]
impl From<bool> for Dynamic
[src]
impl From<char> for Dynamic
[src]
impl From<f64> for Dynamic
[src]
impl From<i64> for Dynamic
[src]
Auto Trait Implementations
impl !RefUnwindSafe for Dynamic
impl !Send for Dynamic
impl !Sync for Dynamic
impl Unpin for Dynamic
impl !UnwindSafe for Dynamic
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut W
impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Notable traits for &'_ mut W
impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut W
impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Notable traits for &'_ mut W
impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,