README
¶
go-tinydate
A tiny date object in Go. Tinydate uses 4 bytes of memory vs the 24 bytes of a standard time.Time{}
A tinydate only has day precision. It has no knowledge of hours, minutes, seconds, or timezones.
⚙️ Installation
go get github.com/lane-c-wagner/go-tinydate
🚀 Quick Start
package main
import (
tinydate "github.com/lane-c-wagner/go-tinydate"
)
func main(){
td, err := tinydate.New(2020, 04, 3)
if err != nil {
fmt.Println(err.Error())
}
td = td.Add(time.Hour * 48)
fmt.Println(td)
// prints 2020-04-05
}
Need Second Precision? Go-TinyTime
I've had people ask why go-tinydate doesn't use unix time as the underlying data, rather than day-month-year. Day-month-year supports dates from year
0 to year 65535. Unix timestamps only supports dates from 1970 to 2106. If you need more precision, take a look at go-tinytime which
uses unix time underneath and supports second precision.
Why?
If you don't have resource constraints, then don't use tinydate! Use the standard time pacakge.
go-tinydate works well in the following situations:
- You are working in embedded systems where memory is a luxury
- You are storing many dates and smaller memory footprint is desired
- You are 101% sure you don't need more than date precision
Example:
I needed to store many thousands of dates in memory in order to keep track of which IDs I had seen in the last X number of days. As such, I had a giant map[int]time.Time. Switching from map[int]time.Time to map[int]tinydate.TinyDate reduced my program's memory from an average ~1GB to ~200MB.
💬 Contact
Submit an issue (above in the issues tab)
API
Godoc: https://godoc.org/github.com/lane-c-wagner/go-tinydate
Tinydate mirrors the time.Time API for the most part. The only methods that are not included are the ones that makes no sense with only day precision, or without timezones apart from UTC.
Formatting
All formatting is done via the time.Time package's formatting capabilites, but anything besides date data will be zeroed out for obvious reasons.
Transient Dependencies
None! And it will stay that way, except of course for the standard library.
Note: Currently the testify package is used only for testing, but that dependency will be removed in coming updates.
👏 Contributing
I love help! Contribute by forking the repo and opening pull requests. Please ensure that your code passes the existing tests and linting, and write tests to test your changes if applicable.
All pull requests should be submitted to the "master" branch.
go test
go fmt
Documentation
¶
Index ¶
- type TinyDate
- func (td TinyDate) Add(d time.Duration) TinyDate
- func (td TinyDate) AddDate(years int, months int, days int) TinyDate
- func (td TinyDate) After(tu TinyDate) bool
- func (td TinyDate) AppendFormat(b []byte, layout string) []byte
- func (td TinyDate) Before(tu TinyDate) bool
- func (td TinyDate) Date() (year int, month time.Month, day int)
- func (td TinyDate) Day() int
- func (td TinyDate) Equal(tu TinyDate) bool
- func (td TinyDate) Format(layout string) string
- func (td *TinyDate) GobDecode(data []byte) error
- func (td TinyDate) GobEncode() ([]byte, error)
- func (td TinyDate) ISOWeek() (year, week int)
- func (td TinyDate) IsZero() bool
- func (td TinyDate) MarshalBinary() ([]byte, error)
- func (td TinyDate) MarshalJSON() ([]byte, error)
- func (td TinyDate) MarshalText() ([]byte, error)
- func (td TinyDate) Month() time.Month
- func (td TinyDate) String() string
- func (td TinyDate) Sub(tu TinyDate) time.Duration
- func (td TinyDate) ToTime() time.Time
- func (td TinyDate) Unix() int64
- func (td TinyDate) UnixNano() int64
- func (td *TinyDate) UnmarshalBinary(data []byte) error
- func (td *TinyDate) UnmarshalJSON(data []byte) error
- func (td *TinyDate) UnmarshalText(data []byte) error
- func (td TinyDate) Weekday() time.Weekday
- func (td TinyDate) Year() int
- func (td TinyDate) YearDay() int
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TinyDate ¶
type TinyDate struct {
// contains filtered or unexported fields
}
TinyDate -
func FromTime ¶
FromTime converts a time.Time into a TinyDate all tinyTinyDate.TinyDates are UTC timezone, so that conversion will be made here
func New ¶
New creates a new TinyDate, similar to the time.Time package, months are specifed from 1-12, and days are specified 1-31, depending on the month
func ParseInLocation ¶
ParseInLocation parses a layout into a TinyDate including a location. The input is converted into UTC
func Unix ¶
Unix creates a tinydate from seconds and nanoseconds. As usual, this is truncated to the nearest day
func (TinyDate) Add ¶
Add a duration to a TinyDate. Will only have an effect if more than 1 day is added
func (TinyDate) AddDate ¶
AddDate returns the time corresponding to adding the given number of years, months, and days to t. For example, AddDate(-1, 2, 3) applied to January 1, 2011 returns March 4, 2010.
func (TinyDate) AppendFormat ¶
AppendFormat is like Format but appends the textual representation to b and returns the extended buffer
func (TinyDate) Format ¶
Format returns a formatted date, as specified by the standard time library https://golang.org/src/time/format.go?s=16029:16071#L485
func (TinyDate) ISOWeek ¶
ISOWeek returns the ISO 8601 year and week number in which t occurs. Week ranges from 1 to 53. Jan 01 to Jan 03 of year n might belong to week 52 or 53 of year n-1, and Dec 29 to Dec 31 might belong to week 1 of year n+1.
func (TinyDate) MarshalBinary ¶
MarshalBinary implements the encoding.BinaryMarshaler interface
func (TinyDate) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (TinyDate) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface. The time is formatted in RFC 3339 format, with sub-second precision added if present.
func (TinyDate) Unix ¶
Unix returns the date as a Unix timestamp where the precision is only to the day. Hours, minutes, and seconds are just padded zeros
func (TinyDate) UnixNano ¶
UnixNano returns the date as a Unix timestamp in nanoseconds where the precision is only to the day. Hours, minutes, seconds and nanoseconds are just padded zeros
func (*TinyDate) UnmarshalBinary ¶
UnmarshalBinary implements the encoding.BinaryUnmarshaler interface
func (*TinyDate) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface.
func (*TinyDate) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface. The time is expected to be in RFC 3339 format.
Source Files
Directories