cal

Documentation

Overview

Package cal provides extensions to the time package for handling holidays and work days (business days).

Work days are defined as Monday through Friday on dates that are not holidays or the alternate observation dates for holidays.

As in the time package, all calculations assume a Gregorian calendar.

(c) 2014 Rick Arnold. Licensed under the BSD license (see LICENSE).

Index

• func AddDanishTraditions(c *Calendar)
• func AddECBHolidays(c *Calendar)
• func AddNorwegianHalfDays(c *Calendar)
• func IsWeekdayN(date time.Time, day time.Weekday, n int) bool
• func IsWeekend(date time.Time) bool
• type Calendar
  • func NewCalendar() *Calendar
  • func NewLocalCalendar(code string) (*Calendar, error)
  • func (c *Calendar) AddHoliday(h ...Holiday)
  • func (c *Calendar) AddSkipNonWorkdays(start time.Time, d time.Duration) time.Time
  • func (c *Calendar) CountHolidayHoursWithOffset(start time.Time, offsetHour int) int
  • func (c *Calendar) CountWorkdays(start, end time.Time) int64
  • func (c *Calendar) GetHoliday(date time.Time) (time.Time, string, bool)
  • func (c Calendar) GetHolidays(start, end time.Time) []struct{ ... }
  • func (c *Calendar) IsHoliday(date time.Time) bool
  • func (c *Calendar) IsWorkday(date time.Time) bool
  • func (c *Calendar) SetWorkday(day time.Weekday, workday bool)
  • func (c *Calendar) SubSkipNonWorkdays(start time.Time, d time.Duration) time.Time
  • func (c *Calendar) WorkdayN(year int, month time.Month, n int) int
  • func (c *Calendar) Workdays(year int, month time.Month) int
  • func (c *Calendar) WorkdaysFrom(start time.Time, offset int) time.Time
  • func (c *Calendar) WorkdaysRemain(date time.Time) int
• type Holiday
  • func NewHoliday(month time.Month, day int) Holiday
  • func NewHolidayExact(month time.Month, day int, year int) Holiday
  • func NewHolidayFactory(fn HolidayFactory) Holiday
  • func NewHolidayFloat(month time.Month, weekday time.Weekday, offset int) Holiday
  • func NewHolidayFunc(fn HolidayFn) Holiday
  • func (h *Holiday) Matches(date time.Time) bool
  • func (h Holiday) SetLabel(label string) Holiday
• type HolidayFactory
• type HolidayFn
• type ObservedRule
• type WorkdayFn

Functions

func AddDanishTraditions

func AddDanishTraditions(c *Calendar)

AddDanishTraditions adds Grundlovsdag (Constitution Day), Christmas Eve, and New Years Eve which are not official holidays.

func AddECBHolidays

func AddECBHolidays(c *Calendar)

AddECBHolidays adds all ECB Target2 holidays to the calendar

func AddNorwegianHalfDays

func AddNorwegianHalfDays(c *Calendar)

AddNorwegianHalfDays are note holidays, but often practiced as a half-business day.

func IsWeekdayN

func IsWeekdayN(date time.Time, day time.Weekday, n int) bool

IsWeekdayN reports whether the given date is the nth occurrence of the day in the month.

The value of n affects the direction of counting:

n > 0: counting begins at the first day of the month.
n == 0: the result is always false.
n < 0: counting begins at the end of the month.

func IsWeekend

func IsWeekend(date time.Time) bool

IsWeekend reports whether the given date falls on a weekend.

Types

type Calendar

type Calendar struct {
	WorkdayFunc WorkdayFn // optional function to override workday flags
	Observed    ObservedRule
	// contains filtered or unexported fields
}

Calendar represents a yearly calendar with a list of holidays.

func NewCalendar

func NewCalendar() *Calendar

NewCalendar creates a new Calendar with no holidays defined and work days of Monday through Friday.

func NewLocalCalendar

func NewLocalCalendar(code string) (*Calendar, error)

NewLocalCalendar creates a Calendar from an ISO-3166-1 Alpha 2 or ISO-3166-2. To obtain a valid but empty calendar you can use the "ZZ" country code.

func (*Calendar) AddHoliday

func (c *Calendar) AddHoliday(h ...Holiday)

AddHoliday adds a Holiday to the calendar's list.

func (*Calendar) AddSkipNonWorkdays

func (c *Calendar) AddSkipNonWorkdays(start time.Time, d time.Duration) time.Time

AddSkipNonWorkdays returns start time plus d working duration

func (*Calendar) CountHolidayHoursWithOffset

func (c *Calendar) CountHolidayHoursWithOffset(start time.Time, offsetHour int) int

CountHolidayHoursWithOffset returns the number of working hours in a range starting from the consumed start date to the end date set by the offset

func (*Calendar) CountWorkdays

func (c *Calendar) CountWorkdays(start, end time.Time) int64

CountWorkdays return amount of workdays between start and end dates

func (*Calendar) GetHoliday

func (c *Calendar) GetHoliday(date time.Time) (time.Time, string, bool)

func (Calendar) GetHolidays

func (c Calendar) GetHolidays(start, end time.Time) []struct {
	Date  time.Time
	Label string
}

GetHolidays returns the list of all holidays defined in the calendar between start and end

func (*Calendar) IsHoliday

func (c *Calendar) IsHoliday(date time.Time) bool

IsHoliday reports whether a given date is a Holiday. It does not account for the observation of holidays on alternate days.

func (*Calendar) IsWorkday

func (c *Calendar) IsWorkday(date time.Time) bool

IsWorkday reports whether a given date is a work day (business day).

func (*Calendar) SetWorkday

func (c *Calendar) SetWorkday(day time.Weekday, workday bool)

SetWorkday changes the given day's status as a standard working day

func (*Calendar) SubSkipNonWorkdays

func (c *Calendar) SubSkipNonWorkdays(start time.Time, d time.Duration) time.Time

SubSkipNonWorkdays returns start time minus d working duration

func (*Calendar) WorkdayN

func (c *Calendar) WorkdayN(year int, month time.Month, n int) int

WorkdayN reports the day of the month that corresponds to the nth workday for the given year and month.

The value of n affects the direction of counting:

n > 0: counting begins at the first day of the month.
n == 0: the result is always 0.
n < 0: counting begins at the end of the month.

func (*Calendar) Workdays

func (c *Calendar) Workdays(year int, month time.Month) int

Workdays reports the total number of workdays for the given year and month.

func (*Calendar) WorkdaysFrom

func (c *Calendar) WorkdaysFrom(start time.Time, offset int) time.Time

WorkdaysFrom reports the date of a workday that is offset days away from start.

If n > 0, then the date returned is start + offset workdays. If n == 0, then the date is returned unchanged. If n < 0, then the date returned is start - offset workdays.

func (*Calendar) WorkdaysRemain

func (c *Calendar) WorkdaysRemain(date time.Time) int

WorkdaysRemain reports the total number of remaining workdays in the month for the given date.

type Holiday

type Holiday struct {
	Month   time.Month
	Weekday time.Weekday
	Day     int
	Offset  int
	Year    int
	Fn      HolidayFn
	Factory HolidayFactory
	Label   string
	// contains filtered or unexported fields
}

Holiday holds information about the yearly occurrence of a Holiday.

A valid Holiday consists of one of the following:

• Month and Day (such as March 14 for Pi Day)
• Month, Weekday, and Offset (such as the second Monday of October for Columbus Day)
• Offset (such as the 183rd day of the year for the start of the second half)
• Month, Day, and Year (in case you want to specify holidays exactly for each year)
• Func (to calculate the Holiday)

func NewHoliday

func NewHoliday(month time.Month, day int) Holiday

newHoliday creates a new Holiday instance for an exact day of a month.

func NewHolidayExact

func NewHolidayExact(month time.Month, day int, year int) Holiday

newHolidayExact creates a new Holiday instance for an exact day of a month and year.

func NewHolidayFactory

func NewHolidayFactory(fn HolidayFactory) Holiday

newHolidayFactory creates a new Holiday instance that uses a function to create the Holiday for a given year.

func NewHolidayFloat

func NewHolidayFloat(month time.Month, weekday time.Weekday, offset int) Holiday

newHolidayFloat creates a new Holiday instance for an offset-based day of a month.

func NewHolidayFunc

func NewHolidayFunc(fn HolidayFn) Holiday

newHolidayFunc creates a new Holiday instance that uses a function to calculate the day and month.

func (*Holiday) Matches

func (h *Holiday) Matches(date time.Time) bool

matches determines whether the given date is the one referred to by the Holiday.

func (Holiday) SetLabel

func (h Holiday) SetLabel(label string) Holiday

type HolidayFactory

type HolidayFactory func(year int, loc *time.Location) Holiday

HolidayFactory creates a Holiday for the given year letting you use the regular Holiday/Cal facilities to define holidays that had yearly variations.

type HolidayFn

type HolidayFn func(year int, loc *time.Location) (month time.Month, day int)

HolidayFn calculates the occurrence of a Holiday for the given year. This is useful for holidays like Easter that depend on complex rules.

type ObservedRule

type ObservedRule int

ObservedRule represents a rule for observing a Holiday that falls on a weekend.

const (
	ObservedExact   ObservedRule = iota // the exact day only, default value
	ObservedNearest                     // nearest weekday (Friday or Monday)
	ObservedMonday                      // Monday always

	// As above, but also accounts for Christmas Day being on a weekend (which
	// pushes Boxing Day to Tuesday)
	ObservedMondayTuesday
)

ObservedRule are the specific ObservedRules

type WorkdayFn

type WorkdayFn func(date time.Time) bool

WorkdayFn reports whether the given date is a workday. This is useful for situations where work days change throughout the year.

If your workdays are fixed (Mon-Fri for example) then a WorkdayFn is not necessary and you can use cal.SetWorkday() instead.