Struct ToColFn 

pub struct ToColFn;

Converts an array or range into a single column.

Flattens input values into one column, with options to ignore blanks/errors and to scan by row or by column.

Remarks

• ignore values are 0 keep all, 1 ignore blanks, 2 ignore errors, 3 ignore both.
• scan_by_column defaults to FALSE, so values are read row by row.

title: "Flatten row by row"
formula: "=TOCOL({1,2;3,4})"
expected: [[1],[2],[3],[4]]

title: "Scan by column"
formula: "=TOCOL({1,2;3,4},0,TRUE)"
expected: [[1],[3],[2],[4]]

related:
  - TOROW
  - HSTACK
  - VSTACK
faq:
  - q: "Can TOCOL filter blanks and errors?"
    a: "Yes. Use the ignore argument to drop blanks, errors, or both."

Trait Implementations

impl Debug for ToColFn

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

Formats the value using the given formatter.

impl Function for ToColFn

[formualizer-docgen:schema:start] Name: TOCOL Type: ToColFn Min args: 1 Max args: variadic Variadic: true Signature: TOCOL(arg1: range|any@range, arg2?: number@scalar, arg3?…: logical|number@scalar) Arg schema: arg1{kinds=range|any,required=true,shape=range,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg3{kinds=logical|number,required=false,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=true} 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 dependency_contract( &self, _arity: usize, ) -> Option<FunctionDependencyContract>

Optional dependency contract for passive planning/FormulaPlane analysis.

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.