Skip to main content

Evaluator

Struct Evaluator 

Source
pub struct Evaluator<'a> { /* private fields */ }
Expand description

Stateful evaluator that tracks recursion depth and circular references.

Unqualified references resolve against the evaluator’s current sheet. That is the provider’s sheet for the top-level formula and the owning sheet of any referenced formula cell while that cell’s formula is being evaluated.

Implementations§

Source§

impl<'a> Evaluator<'a>

Source

pub fn new(provider: &'a dyn CellDataProvider) -> Self

Create a new evaluator backed by the given data provider.

Source

pub fn with_budget( provider: &'a dyn CellDataProvider, budget: FormulaBudget, ) -> Self

Create an evaluator that shares an existing calculation budget.

Source

pub fn set_position(&mut self, col: u32, row: u32)

Set the 1-based (column, row) coordinate of the formula being evaluated.

Source

pub fn position(&self) -> (u32, u32)

Return the 1-based (column, row) coordinate of the formula being evaluated.

Source

pub fn eval_expr(&mut self, expr: &Expr) -> Result<CellValue>

Evaluate an AST expression node.

Source

pub fn eval_arg(&mut self, args: &[Expr], index: usize) -> Result<CellValue>

Evaluate a single argument expression at index, returning an error if the index is out of bounds.

Source

pub fn collect_numbers(&mut self, args: &[Expr]) -> Result<Vec<f64>>

Collect numeric values for aggregate functions such as SUM or AVERAGE.

Reference arguments (ranges and single-cell references) contribute only numeric cells (see reference_number); empty, boolean, and text cells are skipped, and an error cell aborts with that error. Other arguments are direct values and use coerce_to_number, so TRUE counts as 1 and numeric text is parsed.

Source

pub fn flatten_args_to_values( &mut self, args: &[Expr], ) -> Result<Vec<CellValue>>

Flatten all arguments into a Vec of CellValues, expanding ranges.

Source

pub fn expand_range( &mut self, start: &CellReference, end: &CellReference, ) -> Result<Vec<CellValue>>

Expand a rectangular cell range into individual CellValues (row-major).

Source

pub fn current_sheet(&self) -> &str

Return the sheet that unqualified references currently resolve against.

Source

pub fn charge_match_work(&self, amount: u64) -> Result<()>

Charge wildcard or criteria matching work before performing it.

Source

pub fn charge_evaluation_work(&self, amount: u64) -> Result<()>

Charge analytically known loop or helper work before executing it.

Source

pub fn check_output_bytes(&self, amount: u64) -> Result<()>

Check analytically known string output before reserving it.

Auto Trait Implementations§

§

impl<'a> !Freeze for Evaluator<'a>

§

impl<'a> !RefUnwindSafe for Evaluator<'a>

§

impl<'a> !Send for Evaluator<'a>

§

impl<'a> !Sync for Evaluator<'a>

§

impl<'a> !UnwindSafe for Evaluator<'a>

§

impl<'a> Unpin for Evaluator<'a>

§

impl<'a> UnsafeUnpin for Evaluator<'a>

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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