Enum darklua_core::process::LuaValue

pub enum LuaValue {
    False,
    Function,
    Nil,
    Number(f64),
    String(String),
    Table,
    True,
    Unknown,
}

Represents an evaluated Expression result.

Variants

False

Function

Nil

Number(f64)

Tuple Fields of Number

0: f64

String(String)

Tuple Fields of String

0: String

Table

True

Unknown

Implementations

impl LuaValue

pub fn is_truthy(&self) -> Option<bool>

As defined in Lua, all values are considered true, except for false and nil. An option is returned as the LuaValue may be unknown, so it would return none.

// the values considered false
assert!(!LuaValue::False.is_truthy().unwrap());
assert!(!LuaValue::Nil.is_truthy().unwrap());

// all the others are true
assert!(LuaValue::True.is_truthy().unwrap());
assert!(LuaValue::Table.is_truthy().unwrap());
assert!(LuaValue::Number(0.0).is_truthy().unwrap());
assert!(LuaValue::String("hello".to_owned()).is_truthy().unwrap());

// unknown case
assert!(LuaValue::Unknown.is_truthy().is_none());

pub fn map_if_truthy<F>(self, map: F) -> Self where
    F: Fn(Self) -> Self, 

If the value is unknown, this will also return unknown value. In the other case, if the value is considered truthy (see is_truthy function), it will call the given function to get the mapped value.

pub fn map_if_truthy_else<F, G>(self, map: F, default: G) -> Self where
    F: Fn(Self) -> Self,
    G: Fn() -> Self, 

Like the map_if_truthy method, except that instead of returning the same value when the it is falsy, it calls the default callback to obtain another value.

pub fn to_expression(self) -> Option<Expression>

Attempt to convert the Lua value into an expression node.

pub fn number_coercion(self) -> Self

Attempt to convert the Lua value into a number value. This will convert strings when possible and return the same value otherwise.

pub fn string_coercion(self) -> Self

Attempt to convert the Lua value into a string value. This will convert numbers when possible and return the same value otherwise.

Trait Implementations

impl Clone for LuaValue

fn clone(&self) -> LuaValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LuaValue

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

Formats the value using the given formatter.

impl Default for LuaValue

fn default() -> Self

Returns the “default value” for a type.

impl From<&'_ str> for LuaValue

fn from(value: &str) -> Self

Performs the conversion.

impl From<String> for LuaValue

fn from(value: String) -> Self

Performs the conversion.

impl From<bool> for LuaValue

fn from(value: bool) -> Self

Performs the conversion.

impl From<f64> for LuaValue

fn from(value: f64) -> Self

Performs the conversion.

impl PartialEq<LuaValue> for LuaValue

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for LuaValue