Enum Value 

pub enum Value {
    None,
    Quantity(Quantity),
    Bool(bool),
    Integer(Integer),
    String(String),
    Array(Array),
    Tuple(Box<Tuple>),
    Matrix(Box<Matrix>),
    Model(Model),
    Return(Box<Value>),
}

A variant value with attached source code reference.

Variants

None

Invalid value (used for error handling).

Quantity(Quantity)

A quantity value.

Bool(bool)

A boolean value.

Integer(Integer)

An integer value.

String(String)

A string value.

Array(Array)

A list of values with a common type.

Tuple(Box<Tuple>)

A tuple of named items.

Matrix(Box<Matrix>)

A matrix.

Model(Model)

A model in the model tree.

Return(Box<Value>)

Return value

Implementations

impl Value

pub fn is_invalid(&self) -> bool

Check if the value is invalid.

pub fn pow(&self, rhs: &Value) -> Result<Value, ValueError>

Calculate the power of two values, if possible.

pub fn binary_op(lhs: Value, rhs: Value, op: &str) -> Result<Value, ValueError>

Binary operation

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

Unary operation.

pub fn try_bool(&self) -> Result<bool, ValueError>

Try to get boolean value.

A Value::None will return false.

pub fn try_string(&self) -> Result<String, ValueError>

Try to convert to String.

pub fn try_scalar(&self) -> Result<Scalar, ValueError>

Try to convert to Scalar.

Trait Implementations

impl Add<Value> for Array

• operator. Adds a value to an array, e.g.: [1,2] + 1 == [2,3].

type Output = Result<Value, ValueError>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Value

Rules for operator +.

type Output = Result<Value, ValueError>

The resulting type after applying the + operator.

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

Performs the + operation.

impl AttributesAccess for Value

fn get_attributes_by_id(&self, id: &Identifier) -> Vec<Attribute>

Get a value attribute by id.

fn get_single_attribute(&self, id: &Identifier) -> Option<Attribute>

Get a single attributes.

fn get_attribute_value(&self, id: &Identifier) -> Value

Get single attribute as value.

fn get_resolution(&self) -> Option<ResolutionAttribute>

Get resolution attribute.

fn get_color(&self) -> Option<Color>

Color (builtin attribute).

fn get_theme(&self) -> Option<Rc<Theme>>

Color theme (builtin attribute).

fn get_size(&self) -> Option<Size2>

Get size.

fn get_exports(&self) -> Vec<ExportCommand>

Get all export commands.

fn get_measures(&self) -> Vec<MeasureCommand>

Get all measure commands.

fn get_custom_attributes(&self, id: &Identifier) -> Vec<Tuple>

Get custom attributes.

impl BitAnd for Value

Rules for operator & (intersection).

type Output = Result<Value, ValueError>

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for Value

Rules for operator `|`` (union).

type Output = Result<Value, ValueError>

The resulting type after applying the | operator.

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

Performs the | operation.

impl CallMethod for Value

fn call_method( &self, id: &QualifiedName, args: &ArgumentValueList, context: &mut Context, ) -> EvalResult<Value>

Evaluate method call into a value (if possible)

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 Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl Display for Value

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

Formats the value using the given formatter.

impl Div<Value> for Array

/ operator. Divide an array by value, e.g.: [2,4] / 2 == [1,2].

type Output = Result<Value, ValueError>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Value> for Tuple

type Output = Result<Tuple, ValueError>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Value

Rules for operator /.

type Output = Result<Value, ValueError>

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<Attribute> for Value

This trait implementation is used to access values from an attribute.

fn from(value: Attribute) -> Self

Converts to this type from the input type.

impl From<BuiltinValueHelper> for Value

fn from(value: BuiltinValueHelper) -> Self

Converts to this type from the input type.

impl From<ExportCommand> for Value

fn from(export_attribute: ExportCommand) -> Self

Converts to this type from the input type.

impl From<Literal> for Value

fn from(literal: Literal) -> Self

Converts to this type from the input type.

impl From<MeasureCommand> for Value

fn from(command: MeasureCommand) -> Self

Converts to this type from the input type.

impl From<Model> for Value

fn from(model: Model) -> Self

Converts to this type from the input type.

impl From<NumberLiteral> for Value

fn from(literal: NumberLiteral) -> Self

Converts to this type from the input type.

impl From<Quantity> for Value

fn from(qty: Quantity) -> Self

Converts to this type from the input type.

impl From<Rc<Theme>> for Value

fn from(theme: Rc<Theme>) -> Self

Converts to this type from the input type.

impl From<ResolutionAttribute> for Value

fn from(resolution_attribute: ResolutionAttribute) -> Self

Converts to this type from the input type.

impl From<Size2> for Value

fn from(value: Size2) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Tuple> for Value

fn from(tuple: Tuple) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(f: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(scalar: Scalar) -> Self

Converts to this type from the input type.

impl FromIterator<Value> for Array

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for Value

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for ValueList

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl Mul<Unit> for Value

Multiply a Unit with a value. Used for unit bundling: [1,2,3]mm.

[1,2,3]mm is a shortcut for [1,2,3] * 1mm.

type Output = Result<Value, ValueError>

The resulting type after applying the * operator.

fn mul(self, unit: Unit) -> Self::Output

Performs the * operation.

impl Mul<Value> for Array

• operator. Multiply a value from an array, e.g.: [1,2] * 2 == [2,4].

type Output = Result<Value, ValueError>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Value> for Tuple

type Output = Result<Tuple, ValueError>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Value

Rules for operator *.

type Output = Result<Value, ValueError>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Value

type Output = Result<Value, ValueError>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Value

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

• operator. Subtracts a value from an array, e.g.: [1,2] - 1 == [0,1].

type Output = Result<Value, ValueError>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Value

Rules for operator -.

type Output = Result<Value, ValueError>

The resulting type after applying the - operator.

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

Performs the - operation.

impl TreeDisplay for Value

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

Write item into f and use {:depth$} syntax in front of your single line output to get proper indention.

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

Display as tree starting at depth 0.

fn write_tree(&self, f: &mut impl Write) -> Result<()>

Display as tree starting at depth 0.

impl<'a> TryFrom<&'a Value> for &'a Tuple

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: &'a Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Mat3

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Size2

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for String

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for bool

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for Scalar

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for i64

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Color> for Value

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(c: Color) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for ResolutionAttribute

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for String

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for bool

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for Scalar

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for i64

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Ty for Value

fn ty(&self) -> Type

Return type

impl StructuralPartialEq for Value