schedule

Documentation

Index

• type Frequency
  • func (f Frequency) String() string
• type MultiSchedule
  • func ParseMultiSchedule(s string) (mc MultiSchedule, err error)
  • func (mc MultiSchedule) NextAfter(t time.Time) time.Time
  • func (mc MultiSchedule) String() (s string)
• type Schedule
  • func ParseSchedule(s string) (c Schedule, err error)
  • func (c Schedule) NextAfter(t time.Time) time.Time
  • func (c Schedule) String() string
• type TimeUnit
  • func (tu TimeUnit) String() string

Types

type Frequency

type Frequency struct {
	Unit  TimeUnit
	Count uint
}

func (Frequency) String

func (f Frequency) String() string

type MultiSchedule

type MultiSchedule []Schedule

func ParseMultiSchedule

func ParseMultiSchedule(s string) (mc MultiSchedule, err error)

func (MultiSchedule) NextAfter

func (mc MultiSchedule) NextAfter(t time.Time) time.Time

func (MultiSchedule) String

func (mc MultiSchedule) String() (s string)

type Schedule

type Schedule struct {
	Start, End time.Time
	Freq       Frequency
}

Schedule describes a time schedule. It has a start and optional end point and an optional frequency.

func ParseSchedule

func ParseSchedule(s string) (c Schedule, err error)

func (Schedule) NextAfter

func (c Schedule) NextAfter(t time.Time) time.Time

NextAfter calculates the next time in the schedule after t. If no such time exists, nil is returned (test with Time.IsZero()).

func (Schedule) String

func (c Schedule) String() string

type TimeUnit

type TimeUnit int

const (
	Minute TimeUnit = iota
	Hour
	Day
	Week
	Month
	Year
)

func (TimeUnit) String

func (tu TimeUnit) String() string