Struct SortFn 

pub struct SortFn;

Trait Implementations

impl Debug for SortFn

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

Formats the value using the given formatter.

impl Function for SortFn

Sorts an array by a selected row or column and returns a spilled result.

SORT can order rows (default) or columns.

Remarks

• Defaults: sort_index=1, sort_order=1 (ascending), by_col=FALSE.
• sort_index is 1-based in the active sort axis.
• sort_order < 0 sorts descending; otherwise ascending.
• Invalid sort indexes return #VALUE!.
• Empty input returns an empty spill.

Examples

title: "Sort rows by second column"
grid:
  A1: "C"
  B1: 30
  A2: "A"
  B2: 10
  A3: "B"
  B3: 20
formula: '=SORT(A1:B3,2,1,FALSE)'
expected: [["A",10],["B",20],["C",30]]

title: "Sort columns by first row descending"
grid:
  A1: 1
  B1: 3
  C1: 2
  A2: "A"
  B2: "C"
  C2: "B"
formula: '=SORT(A1:C2,1,-1,TRUE)'
expected: [[3,2,1],["C","B","A"]]

related:
  - SORTBY
  - TAKE
  - DROP
faq:
  - q: "What changes when by_col is TRUE?"
    a: "SORT reorders columns instead of rows, and sort_index is interpreted as a row index used as the sort key."
  - q: "What causes #VALUE! in SORT?"
    a: "If sort_index is outside the active axis (row or column axis based on by_col), SORT returns #VALUE!."

[formualizer-docgen:schema:start] Name: SORT Type: SortFn Min args: 1 Max args: variadic Variadic: true Signature: SORT(arg1: range@range, arg2?: number@scalar, arg3?: number@scalar, arg4?…: logical@scalar) Arg schema: arg1{kinds=range,required=true,shape=range,by_ref=true,coercion=None,max=None,repeating=None,default=false}; arg2{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg3{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberLenientText,max=None,repeating=None,default=true}; arg4{kinds=logical,required=false,shape=scalar,by_ref=false,coercion=Logical,max=None,repeating=None,default=true} 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>], _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.