Struct moon_script::engine::context::InputVariable

pub struct InputVariable { /* private fields */ }

Holds information about a variable that can be given to a crate::ContextBuilder as a means of inputs.

Implementations

impl InputVariable

pub fn new<Name: ToString>(name: Name) -> Self

Creates a new variable as a place-holder with a name, if it’s value is indicated with Self::value, it will turn into a constant variable, where it’s value can be inlined when compiling an AST, the value can also be given with Self::lazy_value as part of a context, but if the value isn’t given in none of these ways and its used in the script, you should give this value to the AST’s executor thorough crate::ASTExecutor::push_variable or crate::OptimizedASTExecutor::push_variable.

pub fn value<Value: Into<MoonValue>>(self, value: Value) -> Self

Specifies the value of this variable, this means it turns into a constant variable, and therefore it can be inlined when parsing an AST.

pub fn lazy_value<Dummy, ReturnT: Into<MoonValue>, Function, AbstractFunction: ToAbstractFunction<(), ReturnT, Function, Dummy> + Clone>( self, function: AbstractFunction, ) -> Self

Specifies a function that gives the value of this variable, the difference between this and given it’s value to the AST’s executor is just performance, as crate::ASTExecutor::push_variable it’s slower due to the need of checking a HashMap.

pub fn associated_type<'input, Name: Into<MoonValueKind<'input>>>( self, name: Name, ) -> Self

Specifies what kind type is associated to this variable, see the Properties section of the book for more information about properties.

pub fn associated_type_of<T>(self) -> Self

Specifies what kind type is associated to this variable, but instead of receiving a name or a crate::MoonValueKind, it receives the value’s type, this is preferred over Self::associated_type but it doesn’t allow you to create pseudo-types, requiring the use of real types.

see the Properties section of the book for more information about properties.

Trait Implementations

impl Clone for InputVariable

fn clone(&self) -> InputVariable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputVariable

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

Formats the value using the given formatter.