Struct SubstituteFn 

pub struct SubstituteFn;

Trait Implementations

impl Debug for SubstituteFn

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

Formats the value using the given formatter.

impl Function for SubstituteFn

Replaces matching text within a string.

SUBSTITUTE can replace all occurrences or only a specific instance.

Remarks

• Matching is case-sensitive.
• If old_text is empty, the original text is returned unchanged.
• With instance_num, only that 1-based occurrence is replaced.
• Non-positive instance_num returns #VALUE!.

Examples

title: "Replace all matches"
formula: '=SUBSTITUTE("a-b-a", "a", "x")'
expected: "x-b-x"

title: "Replace only second match"
formula: '=SUBSTITUTE("2024-01-2024", "2024", "FY24", 2)'
expected: "2024-01-FY24"

related:
  - REPLACE
  - TEXTBEFORE
  - TEXTAFTER
faq:
  - q: "Is SUBSTITUTE case-sensitive?"
    a: "Yes. It matches old_text with exact case and replaces either all or the requested instance."

[formualizer-docgen:schema:start] Name: SUBSTITUTE Type: SubstituteFn Min args: 3 Max args: variadic Variadic: true Signature: SUBSTITUTE(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.