Enum ScriptValue 

pub enum ScriptValue {
    Unit,
    Bool(bool),
    Integer(i64),
    Float(f64),
    String(Cow<'static, str>),
    List(VecDeque<ScriptValue>),
    Tuple(VariadicTuple),
    Map(HashMap<String, ScriptValue>),
    Reference(ReflectReference),
    FunctionMut(DynamicScriptFunctionMut),
    Function(DynamicScriptFunction),
    Error(InteropError),
}

An abstraction of values that can be passed to and from scripts. This allows us to re-use logic between scripting languages.

Variants

Unit

Represents the absence of a value.

Bool(bool)

Represents a boolean value.

Integer(i64)

Represents an integer value with at most 64 bits.

Float(f64)

Represents a floating point value with at most 64 bits.

String(Cow<'static, str>)

Represents a string value.

List(VecDeque<ScriptValue>)

Represents a list of other things passed by value

Tuple(VariadicTuple)

Represents a tuple of values, which is best intepreted as multiple non-homogenous values. If returned by a function, scripting languages supporting multiple return values can use this type to represent those.

Map(HashMap<String, ScriptValue>)

Represents a map of other things passed by value

Reference(ReflectReference)

Represents a reference to a value.

FunctionMut(DynamicScriptFunctionMut)

A dynamic script function possibly storing state. Preffer using the ScriptValue::Function variant instead if possible.

Function(DynamicScriptFunction)

A stateless dynamic script function

Error(InteropError)

Represents any error, will be thrown when returned to a script.

Implementations

impl ScriptValue

pub fn as_string(self) -> Result<Cow<'static, str>, Self>

Returns the contained string if this is a string variant otherwise returns the original value.

pub fn type_name(&self) -> String

Returns the variant of the value as a string.

Trait Implementations

impl ArgMeta for ScriptValue

fn default_value() -> Option<ScriptValue>

The default value for the argument. Used when the argument is not provided.

fn variadic() -> bool

If returns true, will absorb all arguments following itself

impl Clone for ScriptValue

fn clone(&self) -> ScriptValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptValue

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

Formats the value using the given formatter.

impl DebugWithTypeInfo for ScriptValue

fn to_string_with_type_info( &self, f: &mut Formatter<'_>, type_info_provider: Option<&WorldAccessGuard<'_>>, ) -> Result

Format the value using the provided type info provider if available

impl Default for ScriptValue

fn default() -> ScriptValue

Returns the “default value” for a type.

impl DisplayWithTypeInfo for ScriptValue

fn display_with_type_info( &self, f: &mut Formatter<'_>, type_info_provider: Option<&WorldGuard<'_>>, ) -> Result

Format the value using the provided type info provider if available

impl From<&'static str> for ScriptValue

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl From<()> for ScriptValue

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Cow<'static, str>> for ScriptValue

fn from(value: Cow<'static, str>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, ScriptValue>> for ScriptValue

fn from(value: HashMap<String, ScriptValue>) -> Self

Converts to this type from the input type.

impl From<InteropError> for ScriptValue

fn from(value: InteropError) -> Self

Converts to this type from the input type.

impl<T: Into<ScriptValue>> From<Option<T>> for ScriptValue

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

impl From<ReflectReference> for ScriptValue

fn from(value: ReflectReference) -> Self

Converts to this type from the input type.

impl<T: Into<ScriptValue>, E: Into<InteropError>> From<Result<T, E>> for ScriptValue

fn from(value: Result<T, E>) -> Self

Converts to this type from the input type.

impl From<String> for ScriptValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<VecDeque<ScriptValue>> for ScriptValue

fn from(value: VecDeque<ScriptValue>) -> Self

Converts to this type from the input type.

impl From<bool> for ScriptValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for ScriptValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i64> for ScriptValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl FromReflect for ScriptValue

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl FromScript for ScriptValue

type This<'w> = ScriptValue

The type that is constructed from the script value.

fn from_script( value: ScriptValue, _world: WorldGuard<'_>, ) -> Result<Self, InteropError>

Construct a value of type T from a ScriptValue.

impl GetTypeDependencies for ScriptValue

type Underlying = ScriptValue

In the majority of the implementations, this will be Self However some types might be facades for other types, in which case this will be the underlying type

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers the type dependencies of the implementing type with the given TypeRegistry.

impl GetTypeRegistration for ScriptValue

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(_registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoScript for ScriptValue

fn into_script( self, _world: WorldGuard<'_>, ) -> Result<ScriptValue, InteropError>

Convert this value into a ScriptValue.

fn into_script_inline_error(self, world: WorldGuard<'_>) -> ScriptValue

where Self: Sized,

Convert this value into a ScriptValue, returning an error as a ScriptValue if an error occurs.

impl PartialEq for ScriptValue

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

Equality operator ==.

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

Inequality operator !=.

impl PartialReflect for ScriptValue

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq( &self, _value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, _value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ScriptValue

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl TypePath for ScriptValue

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ScriptValue

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl TypedThrough for ScriptValue

fn through_type_info() -> ThroughTypeInfo

Get the ThroughTypeInfo for the type.