Enum ScriptValue 

pub enum ScriptValue {
    Unit,
    Bool(bool),
    I64(i64),
    F64(f64),
    Str(String),
    Array(Vec<ScriptValue>),
    Map(HashMap<String, ScriptValue>),
}

The script surface a plugin describes its functions in and answers calls with. Data types, from the engine’s own crate, so a value a plugin builds decodes into the one the script layer routes. Typed sum the script-host trait understands across the boundary.

Mirrors what a dynamic script value carries - scalars, arrays, maps - without leaking any host’s value type into the trait. Backends translate to / from their native value type.

Variants are append-only; see SCRIPT_WIRE_VERSION.

Variants

Unit

Absence of a value (Rhai ()).

Bool(bool)

Boolean payload.

I64(i64)

Signed 64-bit integer payload.

F64(f64)

64-bit float payload.

Str(String)

Owned string payload.

Array(Vec<ScriptValue>)

Heterogeneous list.

Map(HashMap<String, ScriptValue>)

Field map (insertion order is not preserved across the boundary).

Implementations

impl ScriptValue

pub fn stringify(&self) -> String

Stringify any variant. Strings stay verbatim; everything else uses the canonical Display form. UNIT becomes the empty string.

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptValue

fn deserialize<__D>( __deserializer: __D, ) -> Result<ScriptValue, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a str> for ScriptValue

fn from(v: &'a str) -> ScriptValue

Converts to this type from the input type.

impl From<String> for ScriptValue

fn from(v: String) -> ScriptValue

Converts to this type from the input type.

impl From<bool> for ScriptValue

fn from(v: bool) -> ScriptValue

Converts to this type from the input type.

impl From<f64> for ScriptValue

fn from(v: f64) -> ScriptValue

Converts to this type from the input type.

impl From<i64> for ScriptValue

fn from(v: i64) -> ScriptValue

Converts to this type from the input type.

impl PartialEq for ScriptValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ScriptValue

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScriptValue