Struct ArrayToTextFn 

pub struct ArrayToTextFn;

Trait Implementations

impl Debug for ArrayToTextFn

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

Formats the value using the given formatter.

impl Function for ArrayToTextFn

Converts an array or range into a text representation.

ARRAYTOTEXT(array, [format]) supports concise (0) and strict (1) output styles.

Remarks

• Strict mode returns brace-delimited array syntax with row/column separators.
• Concise mode flattens all values into a comma-space list.
• Cells are converted using the same scalar text rules used by VALUETOTEXT.
• Errors in scalar-only input propagate immediately.

Examples

title: "Concise flattened output"
formula: '=ARRAYTOTEXT({1,2,3})'
expected: "1, 2, 3"

title: "Strict 2D representation"
formula: '=ARRAYTOTEXT({1,2;3,4}, 1)'
expected: "{1,2;3,4}"

related:
  - VALUETOTEXT
  - TEXTJOIN
  - TEXTSPLIT
faq:
  - q: "What changes when format is 1?"
    a: "Format 1 returns brace-delimited array syntax; format 0 flattens values into a comma-space list."

[formualizer-docgen:schema:start] Name: ARRAYTOTEXT Type: ArrayToTextFn Min args: 1 Max args: 2 Variadic: false Signature: ARRAYTOTEXT(arg1: any|range@range, arg2?: number@scalar) Arg schema: arg1{kinds=any|range,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} 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 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 variadic(&self) -> bool

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.