rawdate

Documentation

Overview

Package rawdate provides a simple date handling utility without time. It uses zero-based values for year, month, and day to maintain consistency with time.Time, where an uninitialized instance defaults to the year 0001-01-01.

Index

• Constants
• Variables
• func Compare(a, b RawDate) int
• type RawDate
  • func FromTime(t time.Time) RawDate
  • func MustNew(y int, m time.Month, d int) RawDate
  • func New(y int, m time.Month, d int) (RawDate, error)
  • func Parse(layout, s string) (RawDate, error)
  • func Today() RawDate
  • func (r RawDate) AddDate(years, months, days int) RawDate
  • func (a RawDate) After(b RawDate) bool
  • func (a RawDate) Before(b RawDate) bool
  • func (r RawDate) Compare(a RawDate) int
  • func (r RawDate) Day() int
  • func (a RawDate) Equal(b RawDate) bool
  • func (r RawDate) Format(format string) string
  • func (d RawDate) GoString() string
  • func (r RawDate) IsValid() bool
  • func (r RawDate) IsZero() bool
  • func (d RawDate) MarshalJSON() ([]byte, error)
  • func (d RawDate) MarshalText() ([]byte, error)
  • func (r RawDate) Month() time.Month
  • func (r RawDate) MonthEnd() RawDate
  • func (r RawDate) MonthStart() RawDate
  • func (r RawDate) NextWeekday(weekday time.Weekday, orToday bool) RawDate
  • func (r RawDate) PreviousWeekday(weekday time.Weekday, orToday bool) RawDate
  • func (d *RawDate) Scan(src any) error
  • func (r RawDate) String() string
  • func (r RawDate) Time(location *time.Location) time.Time
  • func (d *RawDate) UnmarshalJSON(data []byte) error
  • func (d *RawDate) UnmarshalText(data []byte) error
  • func (d RawDate) Value() (driver.Value, error)
  • func (d RawDate) ValueTime() (driver.Value, error)
  • func (r RawDate) Weekday() time.Weekday
  • func (r RawDate) Year() int

Constants

const ISODate = time.DateOnly

ISODate represents the format for a date-only value in ISO standard.

const MSSQLDateFmt = "20060102"

const MSSQLZeroDate = "19000101"

Variables

var SQLDateFormat = "2006-01-02" // This is the format for the DB when Parse uses a string (default)

var SQLTimeZone = time.UTC // This is the timezone that gets used for the time.Time value

var SQLValueTime = false // Setting this to true uses a time.Time when unmarshalling for SQL

var SQLZeroValue = "0000-01-01" // This is what is used as Zero value in the DB (only with Parse using string)

var Zero = RawDate{0, 0, 0}

Zero represents a zero value for RawDate corresponding to the date 0001-01-01.

Functions

func Compare

func Compare(a, b RawDate) int

Compare compares two RawDates. Returns 1 if a > b, -1 if a < b, and 0 if a == b.

Types

type RawDate

type RawDate struct {
	Year0  int
	Month0 int8
	Day0   int8
}

RawDate represents a date without time information. Year0, Month0, and Day0 are zero-based values for year, month, and day respectively. These fields are exported for marshaling purposes and should be used with the understanding that they are zero-based.

func FromTime

func FromTime(t time.Time) RawDate

FromTime creates a RawDate from a time.Time value, ignoring the time portion.

func MustNew

func MustNew(y int, m time.Month, d int) RawDate

MustNew creates a new RawDate given the year, month, and day. Panics if the provided values do not form a valid date.

func New

func New(y int, m time.Month, d int) (RawDate, error)

New creates a new RawDate given the year, month, and day. Returns an error if the provided values do not form a valid date.

func Parse

func Parse(layout, s string) (RawDate, error)

Parse parses a string representing a date and returns the corresponding RawDate. An error is returned if the string does not represent a valid date.

func Today

func Today() RawDate

Today creates a new RawDate with the current date (in local time)

func (RawDate) AddDate

func (r RawDate) AddDate(years, months, days int) RawDate

AddDate adds the specified number of years, months, and days to the RawDate. Returns a new RawDate with the updated values.

func (RawDate) After

func (a RawDate) After(b RawDate) bool

After reports whether the RawDate a is after RawDate b.

func (RawDate) Before

func (a RawDate) Before(b RawDate) bool

Before reports whether the RawDate a is before RawDate b.

func (RawDate) Compare

func (r RawDate) Compare(a RawDate) int

Compare compares the RawDate with another RawDate. Returns 1 if r > a, -1 if r < a, and 0 if r == a.

func (RawDate) Day

func (r RawDate) Day() int

Day returns the day of the month for the RawDate.

func (RawDate) Equal

func (a RawDate) Equal(b RawDate) bool

Equal reports whether the RawDate a is equal RawDate b.

func (RawDate) Format

func (r RawDate) Format(format string) string

Format formats the RawDate according to the provided layout string.

func (RawDate) GoString

func (d RawDate) GoString() string

GoString implements `fmt.GoStringer`.

func (RawDate) IsValid

func (r RawDate) IsValid() bool

IsValid checks whether the RawDate represents a valid date.

func (RawDate) IsZero

func (r RawDate) IsZero() bool

IsZero checks if the RawDate is a zero date.

func (RawDate) MarshalJSON

func (d RawDate) MarshalJSON() ([]byte, error)

MarshalJSON implements `json.Marshaler` using YYYY-MM-DD

func (RawDate) MarshalText

func (d RawDate) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler

func (RawDate) Month

func (r RawDate) Month() time.Month

Month returns the month of the year for the RawDate.

func (RawDate) MonthEnd

func (r RawDate) MonthEnd() RawDate

MonthEnd returns a new RawDate that represents the last day of the month for the given RawDate.

func (RawDate) MonthStart

func (r RawDate) MonthStart() RawDate

MonthStart returns a new RawDate that represents the first day of the month for the given RawDate.

func (RawDate) NextWeekday

func (r RawDate) NextWeekday(weekday time.Weekday, orToday bool) RawDate

NextWeekday returns the next date that falls on the given weekday. If orToday is true and the given weekday is today, it returns the current date.

func (RawDate) PreviousWeekday

func (r RawDate) PreviousWeekday(weekday time.Weekday, orToday bool) RawDate

PreviousWeekday returns the previous date that falls on the given weekday. If orToday is true and the given weekday is today, it returns the current date.

func (*RawDate) Scan

func (d *RawDate) Scan(src any) error

Scan implements `sql.Scanner` by unmarshalling from `time.Time`

func (RawDate) String

func (r RawDate) String() string

String returns a string representation of the RawDate in YYYY-MM-DD format.

func (RawDate) Time

func (r RawDate) Time(location *time.Location) time.Time

Time converts the RawDate to a time.Time value, with the provided location and zero time.

func (*RawDate) UnmarshalJSON

func (d *RawDate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements `json.Unmarshaler`; parses the date as time.DateOnly (YYYY-MM-DD).

func (*RawDate) UnmarshalText

func (d *RawDate) UnmarshalText(data []byte) error

UnmarshalText implements the encoding.TextUnmarshaler for YYYY-MM-DD

func (RawDate) Value

func (d RawDate) Value() (driver.Value, error)

Value implements `driver.Valuer`; marshals to a string

func (RawDate) ValueTime

func (d RawDate) ValueTime() (driver.Value, error)

This implementation will use the time.Time serialisation With test fields as destination this creates something like "2024-03-20 00:00:00+01:00"

func (RawDate) Weekday

func (r RawDate) Weekday() time.Weekday

Weekday calculates and returns the day of the week for the RawDate.

func (RawDate) Year

func (r RawDate) Year() int

Year returns the year for the RawDate.