Struct ConvertFn 

pub struct ConvertFn;

Converts a numeric value from one supported unit to another.

Supports a focused set of length, mass, and temperature units.

Remarks

• number is numerically coerced; unit arguments must be text.
• Returns #N/A for unknown units or incompatible unit categories.
• Temperature conversions support C/cel, F/fah, and K/kel.

Examples

title: "Length conversion"
formula: "=CONVERT(1,\"km\",\"m\")"
expected: 1000

title: "Temperature conversion"
formula: "=CONVERT(32,\"F\",\"C\")"
expected: 0

related:
  - DEC2BIN
  - DEC2HEX
  - DEC2OCT
faq:
  - q: "When does `CONVERT` return `#N/A`?"
    a: "Unknown unit tokens, non-text unit arguments, or mixing incompatible categories (for example length to mass) return `#N/A`."

Trait Implementations

impl Debug for ConvertFn

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

Formats the value using the given formatter.

impl Function for ConvertFn

[formualizer-docgen:schema:start] Name: CONVERT Type: ConvertFn Min args: 3 Max args: 3 Variadic: false Signature: CONVERT(arg1: any@scalar, arg2: any@scalar, arg3: any@scalar) Arg schema: arg1{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg3{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.