recurrence

Documentation

Index

• Constants
• type Period
  • func (p Period) Contains(t time.Time) bool
  • func (p Period) ContainsInclusive(t time.Time) bool
  • func (p Period) Duration() time.Duration
• type Recurrence
  • func FromISODuration(p *datex.Period, anchor time.Time) (Recurrence, error)
  • func (r Recurrence) GetPeriodAt(t time.Time) (Period, error)
  • func (r Recurrence) Next(t time.Time) (time.Time, error)
  • func (r Recurrence) NextAfter(t time.Time) (time.Time, error)
  • func (r Recurrence) Prev(t time.Time) (time.Time, error)
  • func (r Recurrence) PrevBefore(t time.Time) (time.Time, error)
• type RecurrenceInterval

Constants

const MAX_SAFE_ITERATIONS = 10000

Types

type Period

type Period struct {
	From time.Time `json:"from"`
	To   time.Time `json:"to"`
}

func (Period) Contains

func (p Period) Contains(t time.Time) bool

Inclusive at start, exclusive at end

func (Period) ContainsInclusive

func (p Period) ContainsInclusive(t time.Time) bool

Inclusive at both start and end

func (Period) Duration

func (p Period) Duration() time.Duration

type Recurrence

type Recurrence struct {
	Interval RecurrenceInterval `json:"period"`
	// Anchor can be an arbitrary anchor time for the recurrence.
	// It does not have to be the last or the next time.
	Anchor time.Time `json:"anchor"`
}

func FromISODuration

func FromISODuration(p *datex.Period, anchor time.Time) (Recurrence, error)

func (Recurrence) GetPeriodAt

func (r Recurrence) GetPeriodAt(t time.Time) (Period, error)

Returns a period where p.Contains(t) is true

func (Recurrence) Next

func (r Recurrence) Next(t time.Time) (time.Time, error)

func (Recurrence) NextAfter

func (r Recurrence) NextAfter(t time.Time) (time.Time, error)

NextAfter returns the next time after t that the recurrence should occur. If at t the recurrence should occur, it will return t.

func (Recurrence) Prev

func (r Recurrence) Prev(t time.Time) (time.Time, error)

func (Recurrence) PrevBefore

func (r Recurrence) PrevBefore(t time.Time) (time.Time, error)

PrevBefore returns the previous time before t that the recurrence should occur.

type RecurrenceInterval

type RecurrenceInterval struct {
	datex.Period
}

var (
	RecurrencePeriodDaily RecurrenceInterval = RecurrenceInterval{datex.NewPeriod(0, 0, 0, 1, 0, 0, 0)}
	RecurrencePeriodWeek  RecurrenceInterval = RecurrenceInterval{datex.NewPeriod(0, 0, 1, 0, 0, 0, 0)}
	RecurrencePeriodMonth RecurrenceInterval = RecurrenceInterval{datex.NewPeriod(0, 1, 0, 0, 0, 0, 0)}
	RecurrencePeriodYear  RecurrenceInterval = RecurrenceInterval{datex.NewPeriod(1, 0, 0, 0, 0, 0, 0)}
)