Struct WeekdayFn 

pub struct WeekdayFn;

Returns the day-of-week index for a date serial with configurable numbering.

Remarks

• Default return_type is 1 (Sunday=1 through Saturday=7).
• Supported return_type values are 1, 2, 3, 11-17; unsupported values return #NUM!.
• Input serials are interpreted with Excel 1900 date mapping, including its historical leap-year quirk.

Examples

title: "Default numbering (Sunday-first)"
formula: "=WEEKDAY(45292)"
expected: 2

title: "Monday-first numbering"
formula: "=WEEKDAY(45292, 2)"
expected: 1

related:
  - WEEKNUM
  - ISOWEEKNUM
  - WORKDAY
faq:
  - q: "Why do I get #NUM! for some return_type values?"
    a: "WEEKDAY only accepts specific Excel return_type codes (1, 2, 3, 11-17); other codes return #NUM!."

Trait Implementations

impl Debug for WeekdayFn

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

Formats the value using the given formatter.

impl Function for WeekdayFn

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