Struct VStackFn 

pub struct VStackFn;

Trait Implementations

impl Debug for VStackFn

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

Formats the value using the given formatter.

impl Function for VStackFn

Concatenates arrays vertically into a single spilled array.

VSTACK appends rows from each argument top-to-bottom.

Remarks

• All non-empty range arguments must have the same column count.
• Scalar arguments are treated as 1x1 values.
• Mismatched column counts return #VALUE!.
• Empty inputs are skipped; if all inputs are empty, result is an empty spill.

Examples

title: "Join two 1-row ranges vertically"
grid:
  A1: 1
  B1: 10
  A2: 2
  B2: 20
formula: '=VSTACK(A1:B1,A2:B2)'
expected: [[1,10],[2,20]]

title: "Stack scalar values"
formula: '=VSTACK(5,9)'
expected: [[5],[9]]

related:
  - HSTACK
  - CHOOSEROWS
  - DROP
faq:
  - q: "When does VSTACK return #VALUE!?"
    a: "VSTACK requires matching column counts across non-empty range arguments; differing widths return #VALUE!."
  - q: "What happens if all VSTACK inputs are empty ranges?"
    a: "Empty inputs are skipped, and if every argument is empty the function returns an empty spill."

[formualizer-docgen:schema:start] Name: VSTACK Type: VStackFn Min args: 1 Max args: variadic Variadic: true Signature: VSTACK(arg1…: range|any@range) Arg schema: arg1{kinds=range|any,required=true,shape=range,by_ref=false,coercion=None,max=None,repeating=Some(1),default=false} Caps: PURE [formualizer-docgen:schema:end]

fn caps(&self) -> FnCaps

Capability flags for this function

fn name(&self) -> &'static str

fn min_args(&self) -> usize

fn variadic(&self) -> bool

fn arg_schema(&self) -> &'static [ArgSchema]

fn eval<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

The unified evaluation path.

fn namespace(&self) -> &'static str

fn volatile(&self) -> bool

fn aliases(&self) -> &'static [&'static str]

Optional list of additional alias names (case-insensitive) that should resolve to this function. Default: empty slice. Implementors can override to expose legacy names. Returned slice must have ’static lifetime (typically a static array reference).

fn function_salt(&self) -> u64

fn eval_reference<'a, 'b, 'c>( &self, _args: &'c [ArgumentHandle<'a, 'b>], _ctx: &dyn FunctionContext<'b>, ) -> Option<Result<ReferenceType, ExcelError>>

Optional reference result path. Only called by the interpreter/engine when the callsite expects a reference (e.g., range combinators, by-ref argument positions, or spill sources).

fn dispatch<'a, 'b, 'c>( &self, args: &'c [ArgumentHandle<'a, 'b>], ctx: &dyn FunctionContext<'b>, ) -> Result<CalcValue<'b>, ExcelError>

Dispatch to the unified evaluation path with automatic argument validation.