cal

Documentation

Overview

Package cal provides simple date handling.

Index

• func DateAfter(date Date) validation.Rule
• func DateBefore(date Date) validation.Rule
• func DateNotZero() validation.Rule
• func DateTimeAfter(dt DateTime) validation.Rule
• func DateTimeBefore(dt DateTime) validation.Rule
• func DateTimeNotZero() validation.Rule
• type Date
  • func DateOf(t time.Time) Date
  • func MakeDate(year int, month time.Month, day int) Date
  • func NewDate(year int, month time.Month, day int) *Date
  • func Today() Date
  • func TodayIn(loc *time.Location) Date
  • func (d Date) Add(years, months, days int) Date
  • func (d *Date) Clone() *Date
  • func (Date) JSONSchema() *jsonschema.Schema
  • func (d Date) Time() time.Time
  • func (d Date) TimeIn(loc *time.Location) time.Time
  • func (d *Date) UnmarshalJSON(data []byte) error
  • func (d Date) Validate() error
• type DateTime
  • func DateTimeOf(t time.Time) DateTime
  • func MakeDateTime(year int, month time.Month, day, hour, minute, second int) DateTime
  • func NewDateTime(year int, month time.Month, day, hour, minute, second int) *DateTime
  • func ThisSecond() DateTime
  • func ThisSecondIn(loc *time.Location) DateTime
  • func (dt *DateTime) Clone() *DateTime
  • func (dt DateTime) In(loc *time.Location) time.Time
  • func (DateTime) JSONSchema() *jsonschema.Schema
  • func (dt DateTime) TimeZ() time.Time
  • func (dt *DateTime) UnmarshalJSON(data []byte) error
  • func (dt DateTime) Validate() error
• type Period
  • func (p *Period) Validate() error

Functions

func DateAfter

func DateAfter(date Date) validation.Rule

DateAfter returns a validation rule which checks to ensure the date is *after* the provided date.

func DateBefore

func DateBefore(date Date) validation.Rule

DateBefore is used during validation to ensure the date is before the value passed in.

func DateNotZero

func DateNotZero() validation.Rule

DateNotZero ensures the date is not a zero value.

func DateTimeAfter

func DateTimeAfter(dt DateTime) validation.Rule

DateTimeAfter returns a validation rule which checks to ensure the date is *after* the provided date.

func DateTimeBefore

func DateTimeBefore(dt DateTime) validation.Rule

DateTimeBefore is used during validation to ensure the date is before the value passed in.

func DateTimeNotZero

func DateTimeNotZero() validation.Rule

DateTimeNotZero ensures the date is not a zero value.

Types

type Date

type Date struct {
	civil.Date
}

Date represents a simple date without time used most frequently with business documents.

func DateOf

func DateOf(t time.Time) Date

DateOf returns the Date in which a time occurs in the time's location.

func MakeDate

func MakeDate(year int, month time.Month, day int) Date

MakeDate provides a new date instance.

func NewDate

func NewDate(year int, month time.Month, day int) *Date

NewDate provides a pointer to a new date instance.

func Today

func Today() Date

Today generates a new date instance for today.

func TodayIn

func TodayIn(loc *time.Location) Date

TodayIn generates a new date instance for today in the given location.

func (Date) Add

func (d Date) Add(years, months, days int) Date

Add returns a new date with the given number of years, months and days. This uses the time package to do the arithmetic.

func (*Date) Clone

func (d *Date) Clone() *Date

Clone returns a new pointer to a copy of the date.

func (Date) JSONSchema

func (Date) JSONSchema() *jsonschema.Schema

JSONSchema returns a custom json schema for the date.

func (Date) Time

func (d Date) Time() time.Time

Time returns a time object for the date.

func (Date) TimeIn

func (d Date) TimeIn(loc *time.Location) time.Time

TimeIn returns a time object for the date in the given location which may be important when considering timezones and arithmetic.

func (*Date) UnmarshalJSON

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

UnmarshalJSON is used to parse a date from json and ensures that we can handle invalid data reasonably.

func (Date) Validate

func (d Date) Validate() error

Validate ensures the the date object looks valid.

type DateTime

type DateTime struct {
	civil.DateTime
}

DateTime represents a combination of date and time without location specific information nor support for millisecond precision.

func DateTimeOf

func DateTimeOf(t time.Time) DateTime

DateTimeOf returns the DateTime from the provided time.

func MakeDateTime

func MakeDateTime(year int, month time.Month, day, hour, minute, second int) DateTime

MakeDateTime provides a new date time instance.

func NewDateTime

func NewDateTime(year int, month time.Month, day, hour, minute, second int) *DateTime

NewDateTime provides a pointer to a new date time instance.

func ThisSecond

func ThisSecond() DateTime

ThisSecond produces a new date time instance for the current UTC time to the nearest second.

func ThisSecondIn

func ThisSecondIn(loc *time.Location) DateTime

ThisSecondIn provides a new date time using the current time from the provided location as a reference.

func (*DateTime) Clone

func (dt *DateTime) Clone() *DateTime

Clone returns a new pointer to a copy of the date time.

func (DateTime) In

func (dt DateTime) In(loc *time.Location) time.Time

In returns a new time.Time instance with the provided location.

func (DateTime) JSONSchema

func (DateTime) JSONSchema() *jsonschema.Schema

JSONSchema returns a custom json schema for the date time.

func (DateTime) TimeZ

func (dt DateTime) TimeZ() time.Time

TimeZ returns a new time.Time instance with the UTC location.

func (*DateTime) UnmarshalJSON

func (dt *DateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON is used to parse a date from json and ensures that we can handle invalid data reasonably.

func (DateTime) Validate

func (dt DateTime) Validate() error

Validate ensures the date time object looks valid

type Period

type Period struct {
	// Label is a short description of the period.
	Label string `json:"label,omitempty" jsonschema:"title=Label"`
	// Start indicates when this period starts.
	Start Date `json:"start" jsonschema:"title=Start"`
	// End indicates when the period ends, and must be after the start date.
	End Date `json:"end" jsonschema:"title=End"`
}

Period represents two dates with a start and finish.

func (*Period) Validate

func (p *Period) Validate() error

Validate checks to ensure the period looks correct.