std.datetime.date.Date.roll - multiple declarations
Function Date.roll
Adds the given number of years or months to this Date, mutating
it. A negative number will subtract.
ref Date roll(string units)
(
long value,
AllowDayOverflow allowOverflow = AllowDayOverflow
) pure nothrow @nogc @safe
if (units == "years");
The difference between rolling and adding is that rolling does not
affect larger units. Rolling a Date 12 months gets
the exact same Date. However, the days can still be affected due
to the differing number of days in each month.
Because there are no units larger than years, there is no difference between adding and rolling years.
Parameters
| Name | Description |
|---|---|
| units | The type of units to add ("years" or "months"). |
| value | The number of months or years to add to this
Date. |
| allowOverflow | Whether the day should be allowed to overflow, causing the month to increment. |
Returns
A reference to the Date (this).
Example
auto d1 = Date(2010, 1, 1);
d1Function Date.roll
Adds the given number of units to this Date, mutating it. A
negative number will subtract.
The difference between rolling and adding is that rolling does not
affect larger units. For instance, rolling a Date one
year's worth of days gets the exact same Date.
The only accepted units are "days".
Parameters
| Name | Description |
|---|---|
| units | The units to add. Must be "days". |
| days | The number of days to add to this Date. |
Returns
A reference to the Date (this).
Example
auto d = Date(2010, 1, 1);
d