phobos ~master (2024-10-03T07:50:27Z)

NegInfInterval.shift

std datetime interval NegInfInterval

Shifts the end of this interval forward or backwards in time by the given number of years and/or months (a positive number of years and months shifts the interval forward; a negative number shifts it backward). It adds the years the given years and months to end. It effectively calls add!"years"() and then add!"months"() on end with the given number of years and months.

  1. void shift(D duration)
  2. void shift(T years, T months, AllowDayOverflow allowOverflow)
    struct NegInfInterval(TP)
    static if(__traits(compiles, end.add!"months"(1)) && __traits(compiles, end.add!"years"(1)))
    void
    shift
    (
    T
    )
    (
    T years
    ,
    T months = 0
    ,
    AllowDayOverflow allowOverflow = AllowDayOverflow.yes
    )
    if (
    isIntegral!T
    )

Parameters

years T

The number of years to shift the interval by.

months T

The number of months to shift the interval by.

allowOverflow AllowDayOverflow

Whether the days should be allowed to overflow on end, causing its month to increment.

Throws

std.datetime.date.DateTimeException if empty is true or if the resulting interval would be invalid.

Examples

auto interval1 = NegInfInterval!Date(Date(2012, 3, 1));
auto interval2 = NegInfInterval!Date(Date(2012, 3, 1));

interval1.shift(2);
assert(interval1 == NegInfInterval!Date(Date(2014, 3, 1)));

interval2.shift(-2);
assert(interval2 == NegInfInterval!Date(Date(2010, 3, 1)));

Meta

Source

See Implementation

std datetime interval NegInfInterval constructorsfunctionspropertiesvariables

Page generated by adrdox