Struct CleanFn 

pub struct CleanFn;

Trait Implementations

impl Debug for CleanFn

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

Formats the value using the given formatter.

impl Function for CleanFn

Removes non-printable ASCII control characters from text.

Remarks

• Characters with codes 0..31 are removed.
• Printable whitespace like regular spaces is preserved.
• Non-text inputs are coerced to text before cleaning.
• Errors are propagated unchanged.

Examples

title: "Strip control characters"
formula: '=CLEAN("A"&CHAR(10)&"B")'
expected: "AB"

title: "Printable spaces remain"
formula: '=CLEAN("A B")'
expected: "A B"

related:
  - TRIM
  - CHAR
  - SUBSTITUTE
faq:
  - q: "Does CLEAN remove normal spaces or only control characters?"
    a: "It removes only ASCII control characters (0-31); regular printable spaces remain."

[formualizer-docgen:schema:start] Name: CLEAN Type: CleanFn Min args: 1 Max args: 1 Variadic: false Signature: CLEAN(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>], _: &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.