Safe Haskell	None
Language	Haskell2010

Duckling.Time.Types

Synopsis

Documentation

data TimeObject Source #

Constructors

TimeObject
Fields start :: UTCTime grain :: Grain end :: Maybe UTCTime

Instances

Eq TimeObject Source #
Methods (==) :: TimeObject -> TimeObject -> Bool # (/=) :: TimeObject -> TimeObject -> Bool #
Show TimeObject Source #
Methods showsPrec :: Int -> TimeObject -> ShowS # show :: TimeObject -> String # showList :: [TimeObject] -> ShowS #

data Form Source #

Constructors

DayOfWeek
TimeOfDay
Fields hours :: Maybe Int is12H :: Bool
Month
Fields month :: Int
PartOfDay

Instances

Eq Form Source #
Methods (==) :: Form -> Form -> Bool # (/=) :: Form -> Form -> Bool #
Ord Form Source #
Methods compare :: Form -> Form -> Ordering # (<) :: Form -> Form -> Bool # (<=) :: Form -> Form -> Bool # (>) :: Form -> Form -> Bool # (>=) :: Form -> Form -> Bool # max :: Form -> Form -> Form # min :: Form -> Form -> Form #
Show Form Source #
Methods showsPrec :: Int -> Form -> ShowS # show :: Form -> String # showList :: [Form] -> ShowS #
Generic Form Source #
Associated Types type Rep Form :: * -> * # Methods from :: Form -> Rep Form x # to :: Rep Form x -> Form #
NFData Form Source #
Methods rnf :: Form -> () #
Hashable Form Source #
Methods hashWithSalt :: Int -> Form -> Int # hash :: Form -> Int #
type Rep Form Source #
type Rep Form = D1 * (MetaData "Form" "Duckling.Time.Types" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) ((:+:) * ((:+:) * (C1 * (MetaCons "DayOfWeek" PrefixI False) (U1 )) (C1 (MetaCons "TimeOfDay" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "hours") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "is12H") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool))))) ((:+:) * (C1 * (MetaCons "Month" PrefixI True) (S1 * (MetaSel (Just Symbol "month") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))) (C1 * (MetaCons "PartOfDay" PrefixI False) (U1 *))))

data IntervalDirection Source #

Constructors

Before
After

Instances

Eq IntervalDirection Source #
Methods (==) :: IntervalDirection -> IntervalDirection -> Bool # (/=) :: IntervalDirection -> IntervalDirection -> Bool #
Ord IntervalDirection Source #
Methods compare :: IntervalDirection -> IntervalDirection -> Ordering # (<) :: IntervalDirection -> IntervalDirection -> Bool # (<=) :: IntervalDirection -> IntervalDirection -> Bool # (>) :: IntervalDirection -> IntervalDirection -> Bool # (>=) :: IntervalDirection -> IntervalDirection -> Bool # max :: IntervalDirection -> IntervalDirection -> IntervalDirection # min :: IntervalDirection -> IntervalDirection -> IntervalDirection #
Show IntervalDirection Source #
Methods showsPrec :: Int -> IntervalDirection -> ShowS # show :: IntervalDirection -> String # showList :: [IntervalDirection] -> ShowS #
Generic IntervalDirection Source #
Associated Types type Rep IntervalDirection :: * -> * # Methods from :: IntervalDirection -> Rep IntervalDirection x # to :: Rep IntervalDirection x -> IntervalDirection #
NFData IntervalDirection Source #
Methods rnf :: IntervalDirection -> () #
Hashable IntervalDirection Source #
Methods hashWithSalt :: Int -> IntervalDirection -> Int # hash :: IntervalDirection -> Int #
type Rep IntervalDirection Source #
type Rep IntervalDirection = D1 * (MetaData "IntervalDirection" "Duckling.Time.Types" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) ((:+:) * (C1 * (MetaCons "Before" PrefixI False) (U1 )) (C1 (MetaCons "After" PrefixI False) (U1 *)))

data TimeData Source #

Constructors

TimeData
Fields timePred :: Predicate latent :: Bool timeGrain :: Grain notImmediate :: Bool form :: Maybe Form direction :: Maybe IntervalDirection okForThisNext :: Bool holiday :: Maybe Text

Instances

Eq TimeData Source #
Methods (==) :: TimeData -> TimeData -> Bool # (/=) :: TimeData -> TimeData -> Bool #
Ord TimeData Source #
Methods compare :: TimeData -> TimeData -> Ordering # (<) :: TimeData -> TimeData -> Bool # (<=) :: TimeData -> TimeData -> Bool # (>) :: TimeData -> TimeData -> Bool # (>=) :: TimeData -> TimeData -> Bool # max :: TimeData -> TimeData -> TimeData # min :: TimeData -> TimeData -> TimeData #
Show TimeData Source #
Methods showsPrec :: Int -> TimeData -> ShowS # show :: TimeData -> String # showList :: [TimeData] -> ShowS #
NFData TimeData Source #
Methods rnf :: TimeData -> () #
Hashable TimeData Source #
Methods hashWithSalt :: Int -> TimeData -> Int # hash :: TimeData -> Int #
Resolve TimeData Source #
Associated Types type ResolvedValue TimeData :: * Source # Methods resolve :: Context -> Options -> TimeData -> Maybe (ResolvedValue TimeData, Bool) Source #
type ResolvedValue TimeData Source #
type ResolvedValue TimeData = TimeValue

timedata' :: TimeData Source #

data TimeContext Source #

Constructors

TimeContext
Fields refTime :: TimeObject tzSeries :: TimeZoneSeries maxTime :: TimeObject minTime :: TimeObject

data InstantValue Source #

Constructors

InstantValue
Fields vValue :: ZonedTime vGrain :: Grain

Instances

Eq InstantValue Source #
Methods (==) :: InstantValue -> InstantValue -> Bool # (/=) :: InstantValue -> InstantValue -> Bool #
Show InstantValue Source #
Methods showsPrec :: Int -> InstantValue -> ShowS # show :: InstantValue -> String # showList :: [InstantValue] -> ShowS #
ToJSON InstantValue Source #
Methods toJSON :: InstantValue -> Value # toEncoding :: InstantValue -> Encoding #

data SingleTimeValue Source #

Constructors

SimpleValue InstantValue
IntervalValue (InstantValue, InstantValue)
OpenIntervalValue (InstantValue, IntervalDirection)

Instances

Eq SingleTimeValue Source #
Methods (==) :: SingleTimeValue -> SingleTimeValue -> Bool # (/=) :: SingleTimeValue -> SingleTimeValue -> Bool #
Show SingleTimeValue Source #
Methods showsPrec :: Int -> SingleTimeValue -> ShowS # show :: SingleTimeValue -> String # showList :: [SingleTimeValue] -> ShowS #
ToJSON SingleTimeValue Source #
Methods toJSON :: SingleTimeValue -> Value # toEncoding :: SingleTimeValue -> Encoding #

data TimeValue Source #

Constructors

TimeValue SingleTimeValue [SingleTimeValue] (Maybe Text)

Instances

Eq TimeValue Source #
Methods (==) :: TimeValue -> TimeValue -> Bool # (/=) :: TimeValue -> TimeValue -> Bool #
Show TimeValue Source #
Methods showsPrec :: Int -> TimeValue -> ShowS # show :: TimeValue -> String # showList :: [TimeValue] -> ShowS #
ToJSON TimeValue Source #
Methods toJSON :: TimeValue -> Value # toEncoding :: TimeValue -> Encoding #

type SeriesPredicate = TimeObject -> TimeContext -> ([TimeObject], [TimeObject]) Source #

Return a tuple of (past, future) elements

data AMPM Source #

Constructors

AM
PM

Instances

Eq AMPM Source #
Methods (==) :: AMPM -> AMPM -> Bool # (/=) :: AMPM -> AMPM -> Bool #
Show AMPM Source #
Methods showsPrec :: Int -> AMPM -> ShowS # show :: AMPM -> String # showList :: [AMPM] -> ShowS #

data SeasonName Source #

Constructors

Spring
Summer
Fall
Winter

Instances

Enum SeasonName Source #
Methods succ :: SeasonName -> SeasonName # pred :: SeasonName -> SeasonName # toEnum :: Int -> SeasonName # fromEnum :: SeasonName -> Int # enumFrom :: SeasonName -> [SeasonName] # enumFromThen :: SeasonName -> SeasonName -> [SeasonName] # enumFromTo :: SeasonName -> SeasonName -> [SeasonName] # enumFromThenTo :: SeasonName -> SeasonName -> SeasonName -> [SeasonName] #
Eq SeasonName Source #
Methods (==) :: SeasonName -> SeasonName -> Bool # (/=) :: SeasonName -> SeasonName -> Bool #
Ord SeasonName Source #
Methods compare :: SeasonName -> SeasonName -> Ordering # (<) :: SeasonName -> SeasonName -> Bool # (<=) :: SeasonName -> SeasonName -> Bool # (>) :: SeasonName -> SeasonName -> Bool # (>=) :: SeasonName -> SeasonName -> Bool # max :: SeasonName -> SeasonName -> SeasonName # min :: SeasonName -> SeasonName -> SeasonName #
Show SeasonName Source #
Methods showsPrec :: Int -> SeasonName -> ShowS # show :: SeasonName -> String # showList :: [SeasonName] -> ShowS #

data Season Source #

Regular seasons of the Northern Hemisphere.

Constructors

Season
Fields startYear :: Integer seasonName :: SeasonName

Instances

Eq Season Source #
Methods (==) :: Season -> Season -> Bool # (/=) :: Season -> Season -> Bool #
Ord Season Source #
Methods compare :: Season -> Season -> Ordering # (<) :: Season -> Season -> Bool # (<=) :: Season -> Season -> Bool # (>) :: Season -> Season -> Bool # (>=) :: Season -> Season -> Bool # max :: Season -> Season -> Season # min :: Season -> Season -> Season #
Show Season Source #
Methods showsPrec :: Int -> Season -> ShowS # show :: Season -> String # showList :: [Season] -> ShowS #

newtype NoShow a Source #

Constructors

NoShow a

Instances

Show (NoShow a) Source #
Methods showsPrec :: Int -> NoShow a -> ShowS # show :: NoShow a -> String # showList :: [NoShow a] -> ShowS #

data Predicate Source #

Constructors

SeriesPredicate (NoShow SeriesPredicate)
EmptyPredicate
TimeDatePredicate
Fields tdSecond :: Maybe Int tdMinute :: Maybe Int tdHour :: Maybe (Bool, Int) tdAMPM :: Maybe AMPM tdDayOfTheWeek :: Maybe Int tdDayOfTheMonth :: Maybe Int tdMonth :: Maybe Int tdYear :: Maybe Int
IntersectPredicate Predicate Predicate
TimeIntervalsPredicate TimeIntervalType Predicate Predicate

Instances

Show Predicate Source #
Methods showsPrec :: Int -> Predicate -> ShowS # show :: Predicate -> String # showList :: [Predicate] -> ShowS #

runPredicate :: Predicate -> SeriesPredicate Source #

emptyTimeDatePredicate :: Predicate Source #

mkEmptyPredicate :: Predicate Source #

mkSeriesPredicate :: SeriesPredicate -> Predicate Source #

mkSecondPredicate :: Int -> Predicate Source #

mkMinutePredicate :: Int -> Predicate Source #

mkHourPredicate :: Bool -> Int -> Predicate Source #

mkAMPMPredicate :: AMPM -> Predicate Source #

mkDayOfTheWeekPredicate :: Int -> Predicate Source #

mkDayOfTheMonthPredicate :: Int -> Predicate Source #

mkMonthPredicate :: Int -> Predicate Source #

mkYearPredicate :: Int -> Predicate Source #

mkIntersectPredicate :: Predicate -> Predicate -> Predicate Source #

mkTimeIntervalsPredicate :: TimeIntervalType -> Predicate -> Predicate -> Predicate Source #

containsTimeIntervalsPredicate :: Predicate -> Bool Source #

diffStartTime :: TimeObject -> TimeObject -> NominalDiffTime Source #

isEmptyPredicate :: Predicate -> Bool Source #

seasonStart :: Season -> Day Source #

seasonEnd :: Season -> Day Source #

nextSeason :: Season -> Season Source #

prevSeason :: Season -> Season Source #

seasonOf :: Day -> Season Source #

seasonPredicate :: Predicate Source #

weekdayPredicate :: Predicate Source #

toMidnight :: Day -> UTCTime Source #

runSecondPredicate :: Int -> SeriesPredicate Source #

runMinutePredicate :: Int -> SeriesPredicate Source #

runHourPredicate :: Maybe AMPM -> Bool -> Int -> SeriesPredicate Source #

runAMPMPredicate :: AMPM -> SeriesPredicate Source #

runDayOfTheWeekPredicate :: Int -> SeriesPredicate Source #

runDayOfTheMonthPredicate :: Int -> SeriesPredicate Source #

runMonthPredicate :: Int -> SeriesPredicate Source #

runYearPredicate :: Int -> SeriesPredicate Source #

Converts 2-digits to a year between 1950 and 2050

safeMax :: Int Source #

runIntersectPredicate :: Predicate -> Predicate -> SeriesPredicate Source #

runCompose :: SeriesPredicate -> SeriesPredicate -> SeriesPredicate Source #

runTimeIntervalsPredicate :: TimeIntervalType -> Predicate -> Predicate -> SeriesPredicate Source #

safeMaxInterval :: Int Source #

timeSeqMap :: Bool -> (TimeObject -> TimeContext -> Maybe TimeObject) -> Predicate -> SeriesPredicate Source #

Applies f to each interval yielded by g. | Intervals including "now" are in the future.

timeSequence :: Grain -> Int -> TimeObject -> ([TimeObject], [TimeObject]) Source #

pad :: Int -> Int -> Text Source #

Zero-pad x to reach length n.

timezoneOffset :: TimeZone -> Text Source #

Return the timezone offset portion of the RFC3339 format, e.g. "-02:00".

toRFC3339 :: ZonedTime -> Text Source #

Return a RFC3339 formatted time, e.g. "2013-02-12T04:30:00.000-02:00". | Backward-compatible with Duckling: fraction of second is milli and padded.

instantValue :: TimeZoneSeries -> UTCTime -> Grain -> InstantValue Source #

timeValue :: TimeZoneSeries -> TimeObject -> SingleTimeValue Source #

openInterval :: TimeZoneSeries -> IntervalDirection -> TimeObject -> SingleTimeValue Source #

timeRound :: TimeObject -> Grain -> TimeObject Source #

timePlus :: TimeObject -> Grain -> Integer -> TimeObject Source #

timePlusEnd :: TimeObject -> Grain -> Integer -> TimeObject Source #

Shifts the whole interval by n units of theGrain Returned interval has the same length as the input one

timeEnd :: TimeObject -> UTCTime Source #

timeStartingAtTheEndOf :: TimeObject -> TimeObject Source #

data TimeIntervalType Source #

Closed if the interval between A and B should include B Open if the interval should end right before B

Constructors

Open
Closed

Instances

Eq TimeIntervalType Source #
Methods (==) :: TimeIntervalType -> TimeIntervalType -> Bool # (/=) :: TimeIntervalType -> TimeIntervalType -> Bool #
Show TimeIntervalType Source #
Methods showsPrec :: Int -> TimeIntervalType -> ShowS # show :: TimeIntervalType -> String # showList :: [TimeIntervalType] -> ShowS #

timeInterval :: TimeIntervalType -> TimeObject -> TimeObject -> TimeObject Source #

timeStartsBeforeTheEndOf :: TimeObject -> TimeObject -> Bool Source #

timeBefore :: TimeObject -> TimeObject -> Bool Source #

timeIntersect :: TimeObject -> TimeObject -> Maybe TimeObject Source #

Intersection between two TimeObject. The resulting grain and end fields are the smallest. Prefers intervals when the range is equal.