Struct TextFn 

pub struct TextFn;

Trait Implementations

impl Debug for TextFn

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

Formats the value using the given formatter.

impl Function for TextFn

Formats a value as text using a format pattern.

This implementation supports common numeric, percent, grouping, and basic date tokens.

Remarks

• Requires exactly two arguments: value and format text.
• Numeric text is parsed before formatting; invalid numeric text returns #VALUE!.
• Error inputs are propagated unchanged.
• Supported patterns are intentionally limited compared with full Excel formatting.

Examples

title: "Fixed decimal formatting"
formula: '=TEXT(12.3, "0.00")'
expected: "12.30"

title: "Percent formatting"
formula: '=TEXT(0.256, "0%")'
expected: "26%"

related:
  - VALUE
  - FIXED
  - DOLLAR
faq:
  - q: "How complete is format_text support?"
    a: "Only a limited subset of Excel-style numeric/date tokens is supported in this implementation."

[formualizer-docgen:schema:start] Name: TEXT Type: TextFn Min args: 2 Max args: 1 Variadic: false Signature: TEXT(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 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.