Enum Value 

pub enum Value {
    None,
    Bool(bool),
    Int(i64),
    Float(f32),
    Object(Arc<Object>),
    Ref(Arc<RwLock<MutObject>>),
    Weak(Weak<RwLock<MutObject>>),
}

A value enumeration.

The value enumeration represents a value of the Unlab scripting language.

Variants

None

A none value.

Bool(bool)

A boolean value.

Int(i64)

An integer number.

Float(f32)

Floating-point number.

Object(Arc<Object>)

An immutablke object.

Ref(Arc<RwLock<MutObject>>)

A strong reference to a mutable object.

Weak(Weak<RwLock<MutObject>>)

A weak reference to a mutable object.

Implementations

impl Value

pub fn to_bool(&self) -> bool

Converts any value to a boolean value.

pub fn to_i64(&self) -> i64

Converts any value to an integer number.

pub fn to_f32(&self) -> f32

Converts any value to a floating-point number.

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

Converts the value to a boolean value if the value is a boolean type, otherwise this method returns None.

pub fn to_opt_i64(&self) -> Option<i64>

Converts the value to an integer number if the value is an integer type or floating-point type, otherwise this method returns None.

pub fn to_opt_f32(&self) -> Option<f32>

Converts the value to a floating-point number if the value is an integer type or floating-point type, otherwise this method returns None.

pub fn to_opt_string(&self) -> Option<String>

Converts the value to a string if the value is a string type, otherwise this method returns None.

pub fn is_fun(&self) -> bool

Returns true if the value is a function or a built-in function, otherwise false.

pub fn eq_with_types(&self, value: &Value) -> Result<bool>

Returns true if two values are equal with types, otherwise false.

This method also compares types of two values for integer numbers and floating-point numbers. If two values are weak references, this method compares their pointers instead values. If two values are matrices, this method doesn’t compare two values and returns false.

pub fn eq_without_types(&self, value: &Value) -> Result<bool>

Returns true if two values are equal without types, otherwise false.

This method doesn’t compare types of two values for integer numbers and floating-point numbers. If two values are weak references, this method compares their pointers instead values. If two values are matrices, this method doesn’t compare two values and returns false.

pub fn nearly_eq_with_types(&self, value: &Value, eps: f32) -> Result<bool>

Returns true if two values are nearly equal with types, otherwise false.

If absolute difference between two numbers is less than or equal to the epsilon, two numbers are nearly equal for floating-point numbers, matrix arrays, and matrix row slices. Other values are compered as for eq_with_types.

pub fn nearly_eq_without_types(&self, value: &Value, eps: f32) -> Result<bool>

Returns true if two values are nearly equal without types, otherwise false.

If absolute difference between two numbers is less than or equal to the epsilon, two numbers are nearly equal for numbers, matrix arrays, and matrix row slices. Other values are compered as for eq_without_types.

pub fn dot1<F>(&self, err_msg: &str, f: F) -> Result<Value>

where F: FnMut(&Value) -> Result<Value>,

Applies the function with one argument for a dot operation.

If one element of one value or one field of one value is a floating-point number or a matrix, this method applies the function to one argument for this element or this field. If this element or this field is an array or a structure, this method recursively invokes itself for this element or this field. This method ignores this element or this field otherwise. This method returns an error with the error message if one value isn’t an array or an structure.

pub fn dot2<F>(&self, value: &Value, err_msg: &str, f: F) -> Result<Value>

where F: FnMut(&Value, &Value) -> Result<Value>,

Applies the function with two arguments for a dot operation.

If two elements of two values or two fields of two values are floating-point numbers or matrices, this method applies the function to two arguments for these elements or these fields. If these elements or these fields are arrays or structures, this method recursively invokes itself for these elements or these fields. This method compares these elements or these fields otherwise. If these elements or these fields aren’t equal, this method returns an error. This method returns an error with the error message if two values aren’t arrays or structures.

pub fn apply( &self, interp: &mut Interp, env: &mut Env, arg_values: &[Value], ) -> Result<Value>

Applies the function to the arguments.

See Interp::apply_fun.

pub fn elem(&self, idx_value: &Value) -> Result<Value>

Returns the element or the field if the value has the element or the field, otherwise None or an error.

If the value isn’t a string, a matrix array, a matrix row slice, or a mutable object, this method returns an error.

pub fn set_elem(&self, idx_value: &Value, value: Value) -> Result<()>

Sets the element or the field for the value.

If the value isn’t a mutable object, this method returns an error.

pub fn field(&self, ident: &String) -> Result<Value>

Returns the field if the value has the field, otherwise None or an error.

If the value isn’t a structure, this method returns an error.

pub fn set_field(&self, ident: String, value: Value) -> Result<()>

Sets the field for the value.

If the value isn’t a structure, this method returns an error.

pub fn unary_op(&self, op: UnaryOp) -> Result<Value>

Performs an operation on one value for the unary operator.

pub fn bin_op(&self, op: BinOp, value: &Value) -> Result<Value>

Performs an operation on two values for the binary operator.

pub fn iter(&self) -> Result<Option<Iter<'_>>>

Returns an interator if the value is iterable, otherwise None.

pub fn to_matrix_array(&self) -> Result<Value>

Converts the value to a matrix array.

If the value isn’t a matrix or a matrix array, this method returns an error.

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 Add<&Value> for Value

type Output = Value

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&Value> for &Value

type Output = Value

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Value> for &Value

type Output = Value

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Value

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<&Value> for Value

fn add_assign(&mut self, rhs: &Self)

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<'de> Deserialize<'de> for Value

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl Div for Value

type Output = Value

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&Value> for Value

type Output = Value

The resulting type after applying the / operator.

fn div(self, rhs: &Value) -> Self::Output

Performs the / operation.

impl Div<&Value> for &Value

type Output = Value

The resulting type after applying the / operator.

fn div(self, rhs: &Value) -> Self::Output

Performs the / operation.

impl Div<Value> for &Value

type Output = Value

The resulting type after applying the / operator.

fn div(self, rhs: Value) -> Self::Output

Performs the / operation.

impl DivAssign for Value

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl DivAssign<&Value> for Value

fn div_assign(&mut self, rhs: &Self)

Performs the /= operation.

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 Mul<&Value> for Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Value> for &Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Value> for &Value

type Output = Value

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Value

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl MulAssign<&Value> for Value

fn mul_assign(&mut self, rhs: &Self)

Performs the *= operation.

impl Neg for Value

type Output = Value

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for &Value

type Output = Value

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - 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 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

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: &Self) -> 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 Serialize for Value

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Value> for Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Value> for &Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Value> for &Value

type Output = Value

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Value

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl SubAssign<&Value> for Value

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.