Struct XMatchFn 

pub struct XMatchFn;

Trait Implementations

impl Debug for XMatchFn

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

Formats the value using the given formatter.

impl Function for XMatchFn

Returns the 1-based position of a value in a one-dimensional lookup array.

XMATCH extends MATCH with explicit search direction and wildcard mode.

Remarks

• Defaults: match_mode=0 (exact), search_mode=1 (first-to-last).
• match_mode: 0 exact, -1 exact-or-next-smaller, 1 exact-or-next-larger, 2 wildcard.
• search_mode: 1 forward, -1 reverse, 2 ascending binary intent, -2 descending binary intent.
• lookup_array must be a single row or single column, otherwise returns #VALUE!.
• Not found returns #N/A.

Examples

title: "Exact match position"
grid:
  A1: "alpha"
  A2: "beta"
  A3: "gamma"
formula: '=XMATCH("beta",A1:A3)'
expected: 2

title: "Reverse search finds last duplicate"
grid:
  A1: 7
  A2: 9
  A3: 7
formula: '=XMATCH(7,A1:A3,0,-1)'
expected: 3

related:
  - XLOOKUP
  - MATCH
  - INDEX
faq:
  - q: "How do search_mode values affect duplicate matches?"
    a: "search_mode=1 returns the first qualifying match, while search_mode=-1 scans from the end and returns the last qualifying match."
  - q: "When do binary-intent search modes (2 or -2) return #N/A?"
    a: "For approximate modes they require sorted data in the expected direction; unsorted arrays are treated as no valid match and return #N/A."

[formualizer-docgen:schema:start] Name: XMATCH Type: XMatchFn Min args: 2 Max args: variadic Variadic: true Signature: XMATCH(arg1: any@scalar, arg2: range@range, arg3?: number@scalar, arg4?…: number@scalar) Arg schema: arg1{kinds=any,required=true,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=range,required=true,shape=range,by_ref=true,coercion=None,max=None,repeating=None,default=false}; arg3{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg4{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true} Caps: PURE, LOOKUP [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>], _ctx: &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.