System.Cron.Types

Documentation

data CronSchedule

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

Methods

(==) :: CronSchedule -> CronSchedule -> Bool

(/=) :: CronSchedule -> CronSchedule -> Bool

Show CronSchedule

Methods

showsPrec :: Int -> CronSchedule -> ShowS

show :: CronSchedule -> String

showList :: [CronSchedule] -> ShowS

Generic CronSchedule

Associated Types

type Rep CronSchedule :: * -> *

Methods

from :: CronSchedule -> Rep CronSchedule x

to :: Rep CronSchedule x -> CronSchedule

type Rep CronSchedule

type Rep CronSchedule = D1 (MetaData "CronSchedule" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" False) (C1 (MetaCons "CronSchedule" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "minute") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MinuteSpec)) (S1 (MetaSel (Just Symbol "hour") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HourSpec))) ((:*:) (S1 (MetaSel (Just Symbol "dayOfMonth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DayOfMonthSpec)) ((:*:) (S1 (MetaSel (Just Symbol "month") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MonthSpec)) (S1 (MetaSel (Just Symbol "dayOfWeek") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DayOfWeekSpec))))))

newtype Crontab

Crontab file, omitting comments.

Constructors

Crontab

Fields

• crontabEntries :: [CrontabEntry]

Instances

Eq Crontab

Methods

(==) :: Crontab -> Crontab -> Bool

(/=) :: Crontab -> Crontab -> Bool

Show Crontab

Methods

showsPrec :: Int -> Crontab -> ShowS

show :: Crontab -> String

showList :: [Crontab] -> ShowS

Generic Crontab

Associated Types

type Rep Crontab :: * -> *

Methods

from :: Crontab -> Rep Crontab x

to :: Rep Crontab x -> Crontab

type Rep Crontab

type Rep Crontab = D1 (MetaData "Crontab" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "Crontab" PrefixI True) (S1 (MetaSel (Just Symbol "crontabEntries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [CrontabEntry])))

data CrontabEntry

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

Methods

(==) :: CrontabEntry -> CrontabEntry -> Bool

(/=) :: CrontabEntry -> CrontabEntry -> Bool

Show CrontabEntry

Methods

showsPrec :: Int -> CrontabEntry -> ShowS

show :: CrontabEntry -> String

showList :: [CrontabEntry] -> ShowS

Generic CrontabEntry

Associated Types

type Rep CrontabEntry :: * -> *

Methods

from :: CrontabEntry -> Rep CrontabEntry x

to :: Rep CrontabEntry x -> CrontabEntry

type Rep CrontabEntry

type Rep CrontabEntry = D1 (MetaData "CrontabEntry" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" False) ((:+:) (C1 (MetaCons "CommandEntry" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CronSchedule)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CronCommand)))) (C1 (MetaCons "EnvVariable" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

data MinuteSpec

Minutes field of a cron expression

Instances

Eq MinuteSpec

Methods

(==) :: MinuteSpec -> MinuteSpec -> Bool

(/=) :: MinuteSpec -> MinuteSpec -> Bool

Show MinuteSpec

Methods

showsPrec :: Int -> MinuteSpec -> ShowS

show :: MinuteSpec -> String

showList :: [MinuteSpec] -> ShowS

Generic MinuteSpec

Associated Types

type Rep MinuteSpec :: * -> *

Methods

from :: MinuteSpec -> Rep MinuteSpec x

to :: Rep MinuteSpec x -> MinuteSpec

type Rep MinuteSpec

type Rep MinuteSpec = D1 (MetaData "MinuteSpec" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "Minutes" PrefixI True) (S1 (MetaSel (Just Symbol "minuteSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CronField)))

newtype CronCommand

Constructors

CronCommand

Fields

• cronCommand :: Text

Instances

Eq CronCommand

Methods

(==) :: CronCommand -> CronCommand -> Bool

(/=) :: CronCommand -> CronCommand -> Bool

Ord CronCommand

Methods

compare :: CronCommand -> CronCommand -> Ordering

(<) :: CronCommand -> CronCommand -> Bool

(<=) :: CronCommand -> CronCommand -> Bool

(>) :: CronCommand -> CronCommand -> Bool

(>=) :: CronCommand -> CronCommand -> Bool

max :: CronCommand -> CronCommand -> CronCommand

min :: CronCommand -> CronCommand -> CronCommand

Show CronCommand

Methods

showsPrec :: Int -> CronCommand -> ShowS

show :: CronCommand -> String

showList :: [CronCommand] -> ShowS

Generic CronCommand

Associated Types

type Rep CronCommand :: * -> *

Methods

from :: CronCommand -> Rep CronCommand x

to :: Rep CronCommand x -> CronCommand

type Rep CronCommand

type Rep CronCommand = D1 (MetaData "CronCommand" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "CronCommand" PrefixI True) (S1 (MetaSel (Just Symbol "cronCommand") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

minuteSpec :: MinuteSpec -> CronField

mkMinuteSpec :: CronField -> Maybe MinuteSpec

data HourSpec

Hours field of a cron expression

Instances

Eq HourSpec

Methods

(==) :: HourSpec -> HourSpec -> Bool

(/=) :: HourSpec -> HourSpec -> Bool

Show HourSpec

Methods

showsPrec :: Int -> HourSpec -> ShowS

show :: HourSpec -> String

showList :: [HourSpec] -> ShowS

Generic HourSpec

Associated Types

type Rep HourSpec :: * -> *

Methods

from :: HourSpec -> Rep HourSpec x

to :: Rep HourSpec x -> HourSpec

type Rep HourSpec

type Rep HourSpec = D1 (MetaData "HourSpec" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "Hours" PrefixI True) (S1 (MetaSel (Just Symbol "hourSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CronField)))

hourSpec :: HourSpec -> CronField

mkHourSpec :: CronField -> Maybe HourSpec

data MonthSpec

Month field of a cron expression

Instances

Eq MonthSpec

Methods

(==) :: MonthSpec -> MonthSpec -> Bool

(/=) :: MonthSpec -> MonthSpec -> Bool

Show MonthSpec

Methods

showsPrec :: Int -> MonthSpec -> ShowS

show :: MonthSpec -> String

showList :: [MonthSpec] -> ShowS

Generic MonthSpec

Associated Types

type Rep MonthSpec :: * -> *

Methods

from :: MonthSpec -> Rep MonthSpec x

to :: Rep MonthSpec x -> MonthSpec

type Rep MonthSpec

type Rep MonthSpec = D1 (MetaData "MonthSpec" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "Months" PrefixI True) (S1 (MetaSel (Just Symbol "monthSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CronField)))

monthSpec :: MonthSpec -> CronField

mkMonthSpec :: CronField -> Maybe MonthSpec

data DayOfMonthSpec

Day of month field of a cron expression

Instances

Eq DayOfMonthSpec

Methods

(==) :: DayOfMonthSpec -> DayOfMonthSpec -> Bool

(/=) :: DayOfMonthSpec -> DayOfMonthSpec -> Bool

Show DayOfMonthSpec

Methods

showsPrec :: Int -> DayOfMonthSpec -> ShowS

show :: DayOfMonthSpec -> String

showList :: [DayOfMonthSpec] -> ShowS

Generic DayOfMonthSpec

Associated Types

type Rep DayOfMonthSpec :: * -> *

Methods

from :: DayOfMonthSpec -> Rep DayOfMonthSpec x

to :: Rep DayOfMonthSpec x -> DayOfMonthSpec

type Rep DayOfMonthSpec

type Rep DayOfMonthSpec = D1 (MetaData "DayOfMonthSpec" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "DaysOfMonth" PrefixI True) (S1 (MetaSel (Just Symbol "dayOfMonthSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CronField)))

dayOfMonthSpec :: DayOfMonthSpec -> CronField

mkDayOfMonthSpec :: CronField -> Maybe DayOfMonthSpec

data DayOfWeekSpec

Day of week field of a cron expression

Instances

Eq DayOfWeekSpec

Methods

(==) :: DayOfWeekSpec -> DayOfWeekSpec -> Bool

(/=) :: DayOfWeekSpec -> DayOfWeekSpec -> Bool

Show DayOfWeekSpec

Methods

showsPrec :: Int -> DayOfWeekSpec -> ShowS

show :: DayOfWeekSpec -> String

showList :: [DayOfWeekSpec] -> ShowS

Generic DayOfWeekSpec

Associated Types

type Rep DayOfWeekSpec :: * -> *

Methods

from :: DayOfWeekSpec -> Rep DayOfWeekSpec x

to :: Rep DayOfWeekSpec x -> DayOfWeekSpec

type Rep DayOfWeekSpec

type Rep DayOfWeekSpec = D1 (MetaData "DayOfWeekSpec" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "DaysOfWeek" PrefixI True) (S1 (MetaSel (Just Symbol "dayOfWeekSpec") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CronField)))

dayOfWeekSpec :: DayOfWeekSpec -> CronField

mkDayOfWeekSpec :: CronField -> Maybe DayOfWeekSpec

data BaseField

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

Methods

(==) :: BaseField -> BaseField -> Bool

(/=) :: BaseField -> BaseField -> Bool

Show BaseField

Methods

showsPrec :: Int -> BaseField -> ShowS

show :: BaseField -> String

showList :: [BaseField] -> ShowS

Generic BaseField

Associated Types

type Rep BaseField :: * -> *

Methods

from :: BaseField -> Rep BaseField x

to :: Rep BaseField x -> BaseField

type Rep BaseField

type Rep BaseField = D1 (MetaData "BaseField" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" False) ((:+:) (C1 (MetaCons "Star" PrefixI False) U1) ((:+:) (C1 (MetaCons "SpecificField'" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SpecificField))) (C1 (MetaCons "RangeField'" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RangeField)))))

data SpecificField

Instances

Eq SpecificField

Methods

(==) :: SpecificField -> SpecificField -> Bool

(/=) :: SpecificField -> SpecificField -> Bool

Show SpecificField

Methods

showsPrec :: Int -> SpecificField -> ShowS

show :: SpecificField -> String

showList :: [SpecificField] -> ShowS

Generic SpecificField

Associated Types

type Rep SpecificField :: * -> *

Methods

from :: SpecificField -> Rep SpecificField x

to :: Rep SpecificField x -> SpecificField

type Rep SpecificField

type Rep SpecificField = D1 (MetaData "SpecificField" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" True) (C1 (MetaCons "SpecificField" PrefixI True) (S1 (MetaSel (Just Symbol "specificField") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

specificField :: SpecificField -> Int

mkSpecificField :: Int -> Maybe SpecificField

data RangeField

Instances

Eq RangeField

Methods

(==) :: RangeField -> RangeField -> Bool

(/=) :: RangeField -> RangeField -> Bool

Show RangeField

Methods

showsPrec :: Int -> RangeField -> ShowS

show :: RangeField -> String

showList :: [RangeField] -> ShowS

Generic RangeField

Associated Types

type Rep RangeField :: * -> *

Methods

from :: RangeField -> Rep RangeField x

to :: Rep RangeField x -> RangeField

type Rep RangeField

type Rep RangeField = D1 (MetaData "RangeField" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" False) (C1 (MetaCons "RangeField" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "rfBegin") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Just Symbol "rfEnd") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))

rfBegin :: RangeField -> Int

rfEnd :: RangeField -> Int

mkRangeField :: Int -> Int -> Maybe RangeField

data CronField

Constructors

Field BaseField

ListField (NonEmpty BaseField)

Matches a list of expressions.

StepField' StepField

Matches a stepped expression, e.g. (*/2).

Instances

Eq CronField

Methods

(==) :: CronField -> CronField -> Bool

(/=) :: CronField -> CronField -> Bool

Show CronField

Methods

showsPrec :: Int -> CronField -> ShowS

show :: CronField -> String

showList :: [CronField] -> ShowS

Generic CronField

Associated Types

type Rep CronField :: * -> *

Methods

from :: CronField -> Rep CronField x

to :: Rep CronField x -> CronField

type Rep CronField

type Rep CronField = D1 (MetaData "CronField" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" False) ((:+:) (C1 (MetaCons "Field" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BaseField))) ((:+:) (C1 (MetaCons "ListField" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (NonEmpty BaseField)))) (C1 (MetaCons "StepField'" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 StepField)))))

data StepField

Instances

Eq StepField

Methods

(==) :: StepField -> StepField -> Bool

(/=) :: StepField -> StepField -> Bool

Show StepField

Methods

showsPrec :: Int -> StepField -> ShowS

show :: StepField -> String

showList :: [StepField] -> ShowS

Generic StepField

Associated Types

type Rep StepField :: * -> *

Methods

from :: StepField -> Rep StepField x

to :: Rep StepField x -> StepField

type Rep StepField

type Rep StepField = D1 (MetaData "StepField" "System.Cron.Types" "cron-0.6.0-E1PrDGArSaW2RwzYHZc34i" False) (C1 (MetaCons "StepField" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "sfField") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BaseField)) (S1 (MetaSel (Just Symbol "sfStepping") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))

sfField :: StepField -> BaseField

sfStepping :: StepField -> Int

mkStepField :: BaseField -> Int -> Maybe StepField

Commonly Used Schedules

yearly :: CronSchedule

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

monthly :: CronSchedule

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

daily :: CronSchedule

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

weekly :: CronSchedule

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

hourly :: CronSchedule

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

everyMinute :: CronSchedule

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

Rendering

serializeCronSchedule :: CronSchedule -> Text

serializeCrontab :: Crontab -> Text

Converting to human-readable string