Date.add

Adds the given number of years or months to this Date, mutating it. A negative number will subtract.

Note that if day overflow is allowed, and the date with the adjusted year/month overflows the number of days in the new month, then the month will be incremented by one, and the day set to the number of days overflowed. (e.g. if the day were 31 and the new month were June, then the month would be incremented to July, and the new day would be 1). If day overflow is not allowed, then the day will be set to the last valid day in the month (e.g. June 31st would become June 30th).

struct Date
@safe pure nothrow @nogc ref
add
(
string units
)
if (
units == "years"
)

Parameters

units

The type of units to add ("years" or "months").

value long

The number of months or years to add to this Date.

allowOverflow AllowDayOverflow

Whether the day should be allowed to overflow, causing the month to increment.

Return Value

Type: Date

A reference to the Date (this).

Examples

auto d1 = Date(2010, 1, 1);
d1.add!"months"(11);
assert(d1 == Date(2010, 12, 1));

auto d2 = Date(2010, 1, 1);
d2.add!"months"(-11);
assert(d2 == Date(2009, 2, 1));

auto d3 = Date(2000, 2, 29);
d3.add!"years"(1);
assert(d3 == Date(2001, 3, 1));

auto d4 = Date(2000, 2, 29);
d4.add!"years"(1, AllowDayOverflow.no);
assert(d4 == Date(2001, 2, 28));

Meta