Safe Haskell	None
Language	Haskell2010

System.Cron.Types

Contents

Commonly Used Schedules
Rendering

Synopsis

Documentation

data CronSchedule Source

Specification for a cron expression

Constructors

CronSchedule

Fields

minute :: MinuteSpec: Which minutes to run. First field in a cron specification.
hour :: HourSpec: Which hours to run. Second field in a cron specification.
dayOfMonth :: DayOfMonthSpec: Which days of the month to run. Third field in a cron specification.
month :: MonthSpec: Which months to run. Fourth field in a cron specification.
dayOfWeek :: DayOfWeekSpec: Which days of the week to run. Fifth field in a cron specification.

Instances

Eq CronSchedule Source
Show CronSchedule Source
Generic CronSchedule Source
type Rep CronSchedule Source

newtype Crontab Source

Crontab file, omitting comments.

Constructors

Crontab
Fields crontabEntries :: [CrontabEntry]

Instances

Eq Crontab Source
Show Crontab Source
Generic Crontab Source
type Rep Crontab Source

data CrontabEntry Source

Essentially a line in a crontab file. It is either a schedule with a command after it or setting an environment variable (e.g. FOO=BAR)

Constructors

CommandEntry CronSchedule CronCommand
EnvVariable Text Text

Instances

Eq CrontabEntry Source
Show CrontabEntry Source
Generic CrontabEntry Source
type Rep CrontabEntry Source

data MinuteSpec Source

Minutes field of a cron expression

Instances

Eq MinuteSpec Source
Show MinuteSpec Source
Generic MinuteSpec Source
type Rep MinuteSpec Source

newtype CronCommand Source

Constructors

CronCommand
Fields cronCommand :: Text

Instances

Eq CronCommand Source
Ord CronCommand Source
Show CronCommand Source
Generic CronCommand Source
type Rep CronCommand Source

minuteSpec :: MinuteSpec -> CronField Source

mkMinuteSpec :: CronField -> Maybe MinuteSpec Source

data HourSpec Source

Hours field of a cron expression

Instances

Eq HourSpec Source
Show HourSpec Source
Generic HourSpec Source
type Rep HourSpec Source

hourSpec :: HourSpec -> CronField Source

mkHourSpec :: CronField -> Maybe HourSpec Source

data MonthSpec Source

Month field of a cron expression

Instances

Eq MonthSpec Source
Show MonthSpec Source
Generic MonthSpec Source
type Rep MonthSpec Source

monthSpec :: MonthSpec -> CronField Source

mkMonthSpec :: CronField -> Maybe MonthSpec Source

data DayOfMonthSpec Source

Day of month field of a cron expression

Instances

Eq DayOfMonthSpec Source
Show DayOfMonthSpec Source
Generic DayOfMonthSpec Source
type Rep DayOfMonthSpec Source

dayOfMonthSpec :: DayOfMonthSpec -> CronField Source

mkDayOfMonthSpec :: CronField -> Maybe DayOfMonthSpec Source

data DayOfWeekSpec Source

Day of week field of a cron expression

Instances

Eq DayOfWeekSpec Source
Show DayOfWeekSpec Source
Generic DayOfWeekSpec Source
type Rep DayOfWeekSpec Source

dayOfWeekSpec :: DayOfWeekSpec -> CronField Source

mkDayOfWeekSpec :: CronField -> Maybe DayOfWeekSpec Source

data BaseField Source

Individual field of a cron expression.

Constructors

Star	Matches anything
SpecificField' SpecificField	Matches a specific value (e.g. 1)
RangeField' RangeField	Matches a range of values (e.g. 1-3)

Instances

Eq BaseField Source
Show BaseField Source
Generic BaseField Source
type Rep BaseField Source

data SpecificField Source

Instances

Eq SpecificField Source
Show SpecificField Source
Generic SpecificField Source
type Rep SpecificField Source

specificField :: SpecificField -> Int Source

mkSpecificField :: Int -> Maybe SpecificField Source

data RangeField Source

Instances

Eq RangeField Source
Show RangeField Source
Generic RangeField Source
type Rep RangeField Source

rfBegin :: RangeField -> Int Source

rfEnd :: RangeField -> Int Source

mkRangeField :: Int -> Int -> Maybe RangeField Source

data CronField Source

Constructors

Field BaseField
ListField (NonEmpty BaseField)	Matches a list of expressions.
StepField' StepField	Matches a stepped expression, e.g. (*/2).

Instances

Eq CronField Source
Show CronField Source
Generic CronField Source
type Rep CronField Source

data StepField Source

Instances

Eq StepField Source
Show StepField Source
Generic StepField Source
type Rep StepField Source

sfField :: StepField -> BaseField Source

sfStepping :: StepField -> Int Source

mkStepField :: BaseField -> Int -> Maybe StepField Source

Commonly Used Schedules

yearly :: CronSchedule Source

Shorthand for every January 1st at midnight. Parsed with @yearly, 0 0 1 1 *

monthly :: CronSchedule Source

Shorthand for every 1st of the month at midnight. Parsed with @monthly, 0 0 1 * *

daily :: CronSchedule Source

Shorthand for every day at midnight. Parsed with @daily, 0 0 * * *

weekly :: CronSchedule Source

Shorthand for every sunday at midnight. Parsed with @weekly, 0 0 * * 0

hourly :: CronSchedule Source

Shorthand for every hour on the hour. Parsed with @hourly, 0 * * * *

everyMinute :: CronSchedule Source

Shorthand for an expression that always matches. Parsed with * * * * *

Rendering

serializeCronSchedule :: CronSchedule -> Text Source

serializeCrontab :: Crontab -> Text Source