cron

README

Adapted from https://github.com/robfig/cron

Documentation

Index

• type ParseOption
• type Parser
  • func (p Parser) Parse(spec string) (*Schedule, error)
• type Schedule
  • func ParseStandard(standardSpec string) (*Schedule, error)
  • func (s *Schedule) Matches(t time.Time) bool
  • func (s *Schedule) Source() string

Types

type ParseOption

type ParseOption int

Configuration options for creating a parser. Most options specify which fields should be included, while others enable features. If a field is not included the parser will assume a default value. These options do not change the order fields are parse in.

const (
	Second         ParseOption = 1 << iota // Seconds field, default 0
	SecondOptional                         // Optional seconds field, default 0
	Minute                                 // Minutes field, default 0
	Hour                                   // Hours field, default 0
	Dom                                    // Day of month field, default *
	Month                                  // Month field, default *
	Dow                                    // Day of week field, default *
	DowOptional                            // Optional day of week field, default *
	Descriptor                             // Allow descriptors such as @monthly, @weekly, etc.
)

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

A custom Parser that can be configured.

func (Parser) Parse

func (p Parser) Parse(spec string) (*Schedule, error)

Parse returns a new crontab schedule representing the given spec. It returns a descriptive error if the spec is not valid. It accepts crontab specs and features configured by NewParser.

type Schedule

type Schedule struct {
	Second, Minute, Hour, Dom, Month, Dow uint64
	// contains filtered or unexported fields
}

Schedule specifies a duty cycle (to the second granularity), based on a traditional crontab specification. It is computed initially and stored as bit sets.

func ParseStandard

func ParseStandard(standardSpec string) (*Schedule, error)

ParseStandard returns a new crontab schedule representing the given standardSpec (https://en.wikipedia.org/wiki/Cron). It requires 5 entries representing: minute, hour, day of month, month and day of week, in that order. It returns a descriptive error if the spec is not valid.

It accepts

• Standard crontab specs, e.g. "* * * * ?"

func (*Schedule) Matches

func (s *Schedule) Matches(t time.Time) bool

Matches describes whether the given time matches the cron spec

func (*Schedule) Source

func (s *Schedule) Source() string

Source returns the string from which the schedule was constructed