Struct ScriptStruct 

pub struct ScriptStruct {
    pub name: String,
    pub fields: Vec<ScriptField>,
}

A struct parameter: a name, and fields in declaration order, each with the value it starts with.

A script sets the fields it cares about and the rest take their defaults. candela writes it as a struct literal (ns::Name { field: v, ..Default::default() }); Rhai and Lua pass a map and leave out the keys they do not set. Either way the body reads one map with every field present, so it never handles a missing key.

use lumen_script::{ScriptStruct, ScriptTy, ScriptValue};

let opts = ScriptStruct::new("Options")
    .field_default("dir", ScriptTy::Str, "out")
    .field("verbose", ScriptTy::Bool);
let ScriptValue::Map(full) = opts.default_value() else { unreachable!() };
assert_eq!(full["dir"], ScriptValue::Str("out".into()));
assert_eq!(full["verbose"], ScriptValue::Bool(false));

Fields

name: String

The type name. candela declares it in the function’s namespace, so a script names it ns::Name.

fields: Vec<ScriptField>

The fields, in the order they are declared.

Implementations

impl ScriptStruct

pub fn new(name: impl Into<String>) -> Self

A struct with no fields yet.

pub fn field(self, name: impl Into<String>, ty: ScriptTy) -> Self

Add a field that starts as its type’s empty value.

pub fn field_default( self, name: impl Into<String>, ty: ScriptTy, default: impl Into<ScriptValue>, ) -> Self

Add a field that starts as default.

pub fn default_value(&self) -> ScriptValue

The value with every field at its default.

pub fn complete(&self, value: &ScriptValue) -> ScriptValue

value with every field it leaves out set to its default, nested structs included. A value that is not a map comes back unchanged; an empty list is read as an empty map, since an empty Lua table cannot say which of the two it is.

Trait Implementations

impl Clone for ScriptStruct

fn clone(&self) -> ScriptStruct

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptStruct

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScriptStruct

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScriptStruct

fn eq(&self, other: &ScriptStruct) -> 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 ScriptStruct

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScriptStruct