Enum endbasic_core::ast::Value

pub enum Value {
    Boolean(bool),
    Double(f64),
    Integer(i32),
    Text(String),
}

Represents an evaluated value.

Variants

Boolean(bool)

A boolean value.

Double(f64)

A double-precision floating point value.

Integer(i32)

An integer value.

Text(String)

A string value.

Implementations

impl Value

pub fn as_vartype(&self) -> VarType

Returns the type of the value as a VarType.

pub fn to_text(self) -> String

Consumes the value and converts it to a string value. This is slightly different from the Display implementation because strings aren’t double-quoted.

The output of this function is used anything a value is converted to a string, say as the output of PRINT.

This is not named to_string to prevent confusion with the behavior of a traditional method named like that, and to avoid conflicts with the Display implementation.

impl Value

pub fn parse_as<T: Into<String>>(vtype: VarType, s: T) -> Result<Value, Error>

Parses a string s and constructs a Value that matches a given VarType.

pub fn as_i32(&self) -> Result<i32, Error>

Reinterprets this value as an i32 and fails if the conversion is not possible.

pub fn as_f64(&self) -> Result<f64, Error>

Reinterprets this value as an f64 and fails if the conversion is not possible.

pub fn maybe_cast(self, target: VarType) -> Result<Value, Error>

Given a target variable type, tries to convert the value to that type if they are compatible or otherwise returns self.

Can return an error when the conversion is feasible but it is not possible, such as trying to cast a NaN to an integer.

pub fn and(&self, other: &Self) -> Result<Self, Error>

Performs a logical or bitwise “and” operation.

pub fn or(&self, other: &Self) -> Result<Self, Error>

Performs a logical or bitwise “or” operation.

pub fn xor(&self, other: &Self) -> Result<Self, Error>

Performs a logical or bitwise “xor” operation.

pub fn not(&self) -> Result<Self, Error>

Performs a logical or bitwise “not” operation.

pub fn shl(&self, other: &Self) -> Result<Self, Error>

Performs a left shift.

pub fn shr(&self, other: &Self) -> Result<Self, Error>

Performs a right shift.

pub fn eq(&self, other: &Self) -> Result<Self, Error>

Performs an equality check.

pub fn ne(&self, other: &Self) -> Result<Self, Error>

Performs an inequality check.

pub fn lt(&self, other: &Self) -> Result<Self, Error>

Performs a less-than check.

pub fn le(&self, other: &Self) -> Result<Self, Error>

Performs a less-than or equal-to check.

pub fn gt(&self, other: &Self) -> Result<Self, Error>

Performs a greater-than check.

pub fn ge(&self, other: &Self) -> Result<Self, Error>

Performs a greater-than or equal to check.

pub fn add(&self, other: &Self) -> Result<Self, Error>

Performs an arithmetic addition.

pub fn sub(&self, other: &Self) -> Result<Self, Error>

Performs an arithmetic subtraction.

pub fn mul(&self, other: &Self) -> Result<Self, Error>

Performs a multiplication.

pub fn div(&self, other: &Self) -> Result<Self, Error>

Performs an arithmetic division.

pub fn modulo(&self, other: &Self) -> Result<Self, Error>

Performs a modulo operation.

pub fn pow(&self, other: &Self) -> Result<Self, Error>

Performs a power operation.

pub fn neg(&self) -> Result<Self, Error>

Performs an arithmetic negation.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy 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 Display for Value

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

Formats the value using the given formatter.

impl From<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(d: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(i: i32) -> Self

Converts to this type from the input type.

impl PartialEq<Value> for Value

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

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

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

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

impl StructuralPartialEq for Value