Data.Time.RRule

Documentation

fromText :: Text -> Maybe RRule

Parses RFC 5545 recurrence rule text into an RRule

toText :: RRule -> Text

Formats RRule as RFC 5545 recurrence rule text

defaultRRule :: RRule

description :: RRule -> Text

Describes what an RRule means, in English

data RRule

Constructors

RRule

Fields

• prefix :: Bool

  whether this rule has the "RRULE:" prefix

• weekStart :: Maybe Day

  starting day of the week

• frequency :: Maybe Frequency

  how often to recur

• count :: Maybe Int

  how many times to recur

• until :: Maybe UTCTime

  what UTCTime to stop recurring after

• interval :: Maybe Int

  number of units to wait before recurring

• bySecond :: Maybe (NonEmpty Int)

  which second(s) to recur on

• byMinute :: Maybe (NonEmpty Int)

  which minute(s) to recur on

• byHour :: Maybe (NonEmpty Int)

  which hour(s) to recur on

• byDay :: Maybe (NonEmpty (Int, Day))

  which days(s) to recur on

• byWeekNo :: Maybe (NonEmpty Int)

  which week number(s) to recur on

• byMonth :: Maybe (NonEmpty Int)

  which month(s) to recur on

• byMonthDay :: Maybe (NonEmpty Int)

  which day(s) of the month to recur on

• byYearDay :: Maybe (NonEmpty Int)

  which day(s) of the year to recur on

• bySetPos :: Maybe (NonEmpty Int)

  which occurrence of the rule inside the frequency period

Instances

Eq RRule

Defined in Data.Time.RRule.Types

Methods

(==) :: RRule -> RRule -> Bool

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

Show RRule

Defined in Data.Time.RRule.Types

Methods

showsPrec :: Int -> RRule -> ShowS

show :: RRule -> String

showList :: [RRule] -> ShowS

data Day

Constructors

Sunday

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

Instances

Eq Day

Defined in Data.Time.RRule.Types

Methods

(==) :: Day -> Day -> Bool

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

Show Day

Defined in Data.Time.RRule.Types

Methods

showsPrec :: Int -> Day -> ShowS

show :: Day -> String

showList :: [Day] -> ShowS

data Frequency

Constructors

Secondly

Minutely

Hourly

Daily

Weekly

Monthly

Yearly

Instances

Eq Frequency

Defined in Data.Time.RRule.Types

Methods

(==) :: Frequency -> Frequency -> Bool

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

Show Frequency

Defined in Data.Time.RRule.Types

Methods

showsPrec :: Int -> Frequency -> ShowS

show :: Frequency -> String

showList :: [Frequency] -> ShowS