Struct AddressFn 

pub struct AddressFn;

Trait Implementations

impl Debug for AddressFn

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

Formats the value using the given formatter.

impl Function for AddressFn

Returns a cell reference as text from row and column numbers.

ADDRESS can emit either A1 or R1C1 notation and optionally prefix the address with a sheet name.

Remarks

• abs_num defaults to 1 ($A$1) and supports values 1..4.
• a1 defaults to TRUE; FALSE returns R1C1-style text.
• Valid row range is 1..1048576; valid column range is 1..16384.
• Out-of-range row/column values or invalid abs_num return #VALUE!.
• If sheet_text contains spaces or special characters, it is quoted.

Examples

title: "Absolute A1 reference"
formula: '=ADDRESS(2,3)'
expected: "$C$2"

title: "Relative R1C1 reference with sheet"
formula: '=ADDRESS(5,3,4,FALSE,"Data Sheet")'
expected: "'Data Sheet'!R[5]C[3]"

related:
  - INDEX
  - OFFSET
  - INDIRECT
faq:
  - q: "What happens when abs_num is outside 1..4?"
    a: "ADDRESS returns #VALUE!; only 1 (absolute), 2 (absolute row), 3 (absolute column), and 4 (relative) are valid."
  - q: "Why does sheet_text sometimes add single quotes?"
    a: "Sheet names containing spaces or special characters are quoted and internal apostrophes are escaped to keep a valid reference string."

[formualizer-docgen:schema:start] Name: ADDRESS Type: AddressFn Min args: 2 Max args: 5 Variadic: false Signature: ADDRESS(arg1: number@scalar, arg2: number@scalar, arg3?: number@scalar, arg4?: logical@scalar, arg5?: text@scalar) Arg schema: arg1{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberStrict,max=None,repeating=None,default=false}; arg2{kinds=number,required=true,shape=scalar,by_ref=false,coercion=NumberStrict,max=None,repeating=None,default=false}; arg3{kinds=number,required=false,shape=scalar,by_ref=false,coercion=NumberStrict,max=None,repeating=None,default=true}; arg4{kinds=logical,required=false,shape=scalar,by_ref=false,coercion=Logical,max=None,repeating=None,default=true}; arg5{kinds=text,required=false,shape=scalar,by_ref=false,coercion=None,max=None,repeating=None,default=false} Caps: PURE [formualizer-docgen:schema:end]

fn name(&self) -> &'static str

fn min_args(&self) -> usize

fn caps(&self) -> FnCaps

Capability flags for this function

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.