Struct EdateFn 

pub struct EdateFn;

Returns the serial date offset by a whole number of months from a start date.

Remarks

• months is truncated to an integer before calculation.
• If the target month has fewer days, the day is clamped to that month’s last valid day.
• Serials are interpreted and emitted with Excel 1900 date mapping (not workbook-specific 1904 mode).

Examples

title: "Add months to first-of-month date"
formula: "=EDATE(44927, 3)"
expected: 45017

title: "Clamp month-end overflow"
formula: "=EDATE(45322, 1)"
expected: 45351

related:
  - EOMONTH
  - DATE
  - YEARFRAC
faq:
  - q: "What happens when the start day does not exist in the target month?"
    a: "EDATE clamps to the last valid day of the target month (for example Jan 31 + 1 month becomes Feb month-end)."

Trait Implementations

impl Debug for EdateFn

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

Formats the value using the given formatter.

impl Function for EdateFn

[formualizer-docgen:schema:start] Name: EDATE Type: EdateFn Min args: 2 Max args: 2 Variadic: false Signature: EDATE(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 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.