Struct AggregateState 

pub struct AggregateState {
    pub alias: String,
    pub accumulator: AggregateAccumulator,
    pub override_value: Option<i64>,
}

Runtime state for an aggregate computation.

Fields

alias: String

accumulator: AggregateAccumulator

override_value: Option<i64>

Implementations

impl AggregateState

pub fn new( alias: String, accumulator: AggregateAccumulator, override_value: Option<i64>, ) -> Self

Creates a new aggregate state with the given components.

Arguments

• alias: Output column name for the aggregate result
• accumulator: The aggregator instance performing the computation
• override_value: Optional fixed value to replace the computed result

pub fn update(&mut self, batch: &RecordBatch) -> AggregateResult<()>

Updates the state with values from a new batch.

Arguments

• batch: RecordBatch containing the column data to aggregate

Errors

Returns an error if the underlying accumulator update fails.

pub fn finalize(self) -> AggregateResult<(Field, ArrayRef)>

Finalizes the state and produces the resulting field and array.

Applies the alias and override value if present.

Returns

A tuple containing the output field schema and the computed aggregate value array.

Errors

Returns an error if the underlying accumulator finalization fails.