Struct TextJoinFn 

pub struct TextJoinFn;

Trait Implementations

impl Debug for TextJoinFn

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

Formats the value using the given formatter.

impl Function for TextJoinFn

Joins text values using a delimiter, with optional empty-value filtering.

TEXTJOIN(delimiter, ignore_empty, text1, ...) is useful for building labels and lists.

Remarks

• ignore_empty=TRUE skips empty strings and empty cells.
• ignore_empty=FALSE includes empty items, which can produce adjacent delimiters.
• Delimiter and values are coerced to text.
• Any error in inputs propagates immediately.

Examples

title: "Ignore empty entries"
formula: '=TEXTJOIN(",", TRUE, "a", "", "c")'
expected: "a,c"

title: "Keep empty entries"
formula: '=TEXTJOIN("-", FALSE, "a", "", "c")'
expected: "a--c"

related:
  - CONCAT
  - CONCATENATE
  - TEXTSPLIT
faq:
  - q: "What does ignore_empty change?"
    a: "TRUE skips empty values; FALSE keeps them, which can create adjacent delimiters."

[formualizer-docgen:schema:start] Name: TEXTJOIN Type: TextJoinFn Min args: 3 Max args: variadic Variadic: true Signature: TEXTJOIN(arg1…: any@scalar) Arg schema: arg1{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,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>], _: &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.