Enum Value

pub enum Value {
    Boolean(bool),
    Float(f64),
    Integer(i128),
    String(String),
}

An algebraic data type that can be used to represent many types of values that can be present in a Stack.

Scriptful supports customization of value types through generics, yet this enum is provided in expectation that some users will prefer not to define their own type systems but rather use a stock solution.

Value has four variants that should cover most use cases, namely: Boolean, Float, Integer or String.

The point of Value is being used inside Scripts (wrapped in an Item) or to be pushed into a Stack.

Value does not implement any methods other than implementations of some traits from the core crate.

Variants

Boolean(bool)

A binary value: either true or false.

Float(f64)

A signed floating point value.

Integer(i128)

A signed integer value.

String(String)

A string of characters.

Trait Implementations

impl Add for Value

type Output = Value

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Mul for Value

type Output = Value

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Not for Value

type Output = Value

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for Value

Approximate comparison, so as to support comparison of floating point values.

A floating point values is considered equal to another float or an integer if the difference is less than 10^9.

fn eq(&self, other: &Self) -> 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 PartialOrd for Value

fn partial_cmp(&self, other: &Value) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Value

type Output = Value

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.