Enum Relational

Source
pub enum Relational {
    Less(Additive, Additive),
    LessOrEqual(Additive, Additive),
    Greater(Additive, Additive),
    GreaterOrEqual(Additive, Additive),
    Primary(Box<Primary>),
}
Expand description

Represents a relational expression in the AIMX grammar.

Relational expressions perform comparisons between values using operators like less than, greater than, less than or equal, and greater than or equal. These expressions form part of the expression hierarchy and can be used in conditional statements and boolean logic.

The Relational enum uses AST flattening optimization, where it includes variants for lower-precedence expressions. This allows efficient evaluation without deep recursion.

§Variants

§Comparison Variants

  • Less - Less than comparison: left < right
  • LessOrEqual - Less than or equal comparison: left <= right
  • Greater - Greater than comparison: left > right
  • GreaterOrEqual - Greater than or equal comparison: left >= right

§AST Flattening Variants

  • Primary - Flattened primary expression (optimization)

§Examples

use aimx::expressions::relational::{Relational, parse_relational};
use aimx::{ExpressionLike, Context, Value};
 
// Parse and evaluate a relational expression
let (_, expr) = parse_relational("5 < 10").unwrap();
let mut context = Context::new();
let result = expr.evaluate(&mut context).unwrap();
assert_eq!(result.to_string(), "true");

Variants§

§

Less(Additive, Additive)

Less than comparison: left < right

§

LessOrEqual(Additive, Additive)

Less than or equal comparison: left <= right

§

Greater(Additive, Additive)

Greater than comparison: left > right

§

GreaterOrEqual(Additive, Additive)

Greater than or equal comparison: left >= right

§

Primary(Box<Primary>)

Primary flattened AST optimization

Trait Implementations§

Source§

impl Clone for Relational

Source§

fn clone(&self) -> Relational

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Relational

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Relational

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ExpressionLike for Relational

Source§

fn evaluate(&self, context: &mut dyn ContextLike) -> Result<Value>

Evaluates the relational expression within the given context.

This method performs type-safe comparisons between the left and right operands of the relational expression. It uses type promotion to ensure compatible comparisons and returns a boolean result.

§Type Promotion Rules

The evaluation uses evaluate_and_promote to ensure both operands are of comparable types. Supported type comparisons include:

  • Numbers: Standard numeric comparison
  • Booleans: false (0) < true (1)
  • Dates: Chronological order comparison
  • Text: Lexicographical comparison
  • Tasks: Status-based comparison (converted to numbers)
§Errors

Returns an error if:

  • The operands are not of comparable types
  • Type promotion fails
  • Evaluation of sub-expressions fails
§Examples
use aimx::expressions::relational::{Relational, parse_relational};
use aimx::{ExpressionLike, Context};
 
let (_, expr) = parse_relational("5 < 10").unwrap();
let mut context = Context::new();
let result = expr.evaluate(&mut context).unwrap();
assert_eq!(result.to_string(), "true");
Source§

fn write(&self, writer: &mut Writer)

Write this expression to the provided writer. Read more
Source§

fn to_sanitized(&self) -> String

Convert this expression to a sanitized string representation. Read more
Source§

fn to_formula(&self) -> String

Convert this expression to a formula string representation. Read more
Source§

impl PartialEq for Relational

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Relational

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,