View source code
Display the source code in std/datetime.d from which this page was generated on
github.
Improve this page
Quickly fork, edit online, and submit a pull request for this page.
Requires a signed-in GitHub account. This works well for small changes.
If you'd like to make larger changes you may want to consider using
local clone.
Page wiki
View or edit the community-maintained wiki page associated with this page.
Struct std.datetime.Date
Represents a date in the Proleptic Gregorian Calendar ranging from 32,768 B.C. to 32,767 A.D. Positive years are A.D. Non-positive years are B.C.
Year, month, and day are kept separately internally so that Date
Dateyear calculations for its entire length. As per
ISO 8601, it treats 1 B.C. as
year 0, i.e. 1 B.C. is 0, 2 B.C. is -1, etc. Use yearBC to use B.C. as
a positive integer with 1 B.C. being the year prior to 1 A.D.
Year 0 is a leap year.
Constructors
| Name | Description |
|---|---|
this
|
|
this
|
Properties
| Name | Type | Description |
|---|---|---|
day
[get]
|
ubyte |
Day of a Gregorian Month.
|
day
[set]
|
int |
Day of a Gregorian Month.
|
dayOfGregorianCal
[set]
|
int |
The Xth day of the Gregorian Calendar that this Date is on.
|
dayOfGregorianCal
[get]
|
int |
The Xth day of the Gregorian Calendar that this Date is on.
|
dayOfWeek
[get]
|
DayOfWeek |
Day of the week this Date is on.
|
dayOfYear
[set]
|
int |
Day of the year.
|
dayOfYear
[get]
|
ushort |
Day of the year this Date is on.
|
daysInMonth
[get]
|
ubyte |
The last day in the month that this Date is in.
|
endOfMonth
[get]
|
Date |
Date for the last day in the month that this Date is in.
|
isAD
[get]
|
bool |
Whether the current year is a date in A.D.
|
isLeapYear
[get]
|
bool |
Whether this Date is in a leap year.
|
isoWeek
[get]
|
ubyte |
The ISO 8601 week of the year that this Date is in.
|
julianDay
[get]
|
long |
The Julian day for this Date at noon (since the Julian day changes
at noon).
|
max
[get]
|
Date |
Returns the Date farthest in the future which is representable by
Date.
|
min
[get]
|
Date |
Returns the Date farthest in the past which is representable by
Date.
|
modJulianDay
[get]
|
long |
The modified Julian day for any time on this date (since, the modified
Julian day changes at midnight).
|
month
[set]
|
Month |
Month of a Gregorian Year.
|
month
[get]
|
Month |
Month of a Gregorian Year.
|
year
[set]
|
int |
Year of the Gregorian Calendar. Positive numbers are A.D. Non-positive are B.C. |
year
[get]
|
short |
Year of the Gregorian Calendar. Positive numbers are A.D. Non-positive are B.C. |
yearBC
[set]
|
int |
Year B.C. of the Gregorian Calendar counting year 0 as 1 B.C.
|
yearBC
[get]
|
ushort |
Year B.C. of the Gregorian Calendar counting year 0 as 1 B.C.
|
Methods
| Name | Description |
|---|---|
add
|
Adds the given number of years or months to this Date. A negative
number will subtract.
|
diffMonths
|
Returns the difference between the two Dates in months. |
fromISOExtString
|
Creates a Date from a string with the format YYYY-MM-DD. Whitespace
is stripped from the given string.
|
fromISOString
|
Creates a Date from a string with the format YYYYMMDD. Whitespace
is stripped from the given string.
|
fromSimpleString
|
Creates a Date from a string with the format YYYY-Mon-DD.
Whitespace is stripped from the given string.
|
opBinary
|
Gives the result of adding or subtracting a duration from this
Date.
|
opBinary
|
Gives the difference between two Dates. |
opCmp
|
Compares this Date with the given Date.
|
opOpAssign
|
Gives the result of adding or subtracting a duration from this
Date, as well as assigning the result to this Date.
|
roll
|
Adds the given number of units to this Date. A negative number will
subtract.
|
roll
|
Adds the given number of years or months to this Date. A negative
number will subtract.
|
toISOExtString
|
Converts this Date to a string with the format YYYY-MM-DD.
|
toISOString
|
Converts this Date to a string with the format YYYYMMDD.
|
toSimpleString
|
Converts this Date to a string with the format YYYY-Mon-DD.
|
toString
|
Converts this Date to a string.
|
Authors
Jonathan M Davis and Kato Shoichi