Duckling.Time.Types

Documentation

data TimeObject

Constructors

TimeObject

Fields

• start :: UTCTime
• grain :: Grain
• end :: Maybe UTCTime

Instances

Eq TimeObject

Methods

(==) :: TimeObject -> TimeObject -> Bool

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

Show TimeObject

Methods

showsPrec :: Int -> TimeObject -> ShowS

show :: TimeObject -> String

showList :: [TimeObject] -> ShowS

data Form

Constructors

DayOfWeek

TimeOfDay

Fields

• hours :: Maybe Int
• is12H :: Bool

Month

Fields

• month :: Int

PartOfDay

Instances

Eq Form

Methods

(==) :: Form -> Form -> Bool

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

Ord Form

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

Methods

showsPrec :: Int -> Form -> ShowS

show :: Form -> String

showList :: [Form] -> ShowS

Generic Form

Associated Types

type Rep Form :: * -> *

Methods

from :: Form -> Rep Form x

to :: Rep Form x -> Form

NFData Form

Methods

rnf :: Form -> ()

Hashable Form

Methods

hashWithSalt :: Int -> Form -> Int

hash :: Form -> Int

type Rep Form

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

Constructors

Before

After

Instances

Eq IntervalDirection

Methods

(==) :: IntervalDirection -> IntervalDirection -> Bool

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

Ord IntervalDirection

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

Methods

showsPrec :: Int -> IntervalDirection -> ShowS

show :: IntervalDirection -> String

showList :: [IntervalDirection] -> ShowS

Generic IntervalDirection

Associated Types

type Rep IntervalDirection :: * -> *

Methods

from :: IntervalDirection -> Rep IntervalDirection x

to :: Rep IntervalDirection x -> IntervalDirection

NFData IntervalDirection

Methods

rnf :: IntervalDirection -> ()

Hashable IntervalDirection

Methods

hashWithSalt :: Int -> IntervalDirection -> Int

hash :: IntervalDirection -> Int

type Rep IntervalDirection

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

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

Methods

(==) :: TimeData -> TimeData -> Bool

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

Ord TimeData

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

Methods

showsPrec :: Int -> TimeData -> ShowS

show :: TimeData -> String

showList :: [TimeData] -> ShowS

NFData TimeData

Methods

rnf :: TimeData -> ()

Hashable TimeData

Methods

hashWithSalt :: Int -> TimeData -> Int

hash :: TimeData -> Int

Resolve TimeData

Associated Types

type ResolvedValue TimeData :: *

Methods

resolve :: Context -> Options -> TimeData -> Maybe (ResolvedValue TimeData, Bool)

type ResolvedValue TimeData

type ResolvedValue TimeData = TimeValue

timedata' :: TimeData

data TimeContext

Constructors

TimeContext

Fields

• refTime :: TimeObject
• tzSeries :: TimeZoneSeries
• maxTime :: TimeObject
• minTime :: TimeObject

data InstantValue

Constructors

InstantValue

Fields

• vValue :: ZonedTime
• vGrain :: Grain

Instances

Eq InstantValue

Methods

(==) :: InstantValue -> InstantValue -> Bool

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

Show InstantValue

Methods

showsPrec :: Int -> InstantValue -> ShowS

show :: InstantValue -> String

showList :: [InstantValue] -> ShowS

ToJSON InstantValue

Methods

toJSON :: InstantValue -> Value

toEncoding :: InstantValue -> Encoding

data SingleTimeValue

Constructors

SimpleValue InstantValue

IntervalValue (InstantValue, InstantValue)

OpenIntervalValue (InstantValue, IntervalDirection)

Instances

Eq SingleTimeValue

Methods

(==) :: SingleTimeValue -> SingleTimeValue -> Bool

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

Show SingleTimeValue

Methods

showsPrec :: Int -> SingleTimeValue -> ShowS

show :: SingleTimeValue -> String

showList :: [SingleTimeValue] -> ShowS

ToJSON SingleTimeValue

Methods

toJSON :: SingleTimeValue -> Value

toEncoding :: SingleTimeValue -> Encoding

data TimeValue

Constructors

TimeValue SingleTimeValue [SingleTimeValue] (Maybe Text)

Instances

Eq TimeValue

Methods

(==) :: TimeValue -> TimeValue -> Bool

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

Show TimeValue

Methods

showsPrec :: Int -> TimeValue -> ShowS

show :: TimeValue -> String

showList :: [TimeValue] -> ShowS

ToJSON TimeValue

Methods

toJSON :: TimeValue -> Value

toEncoding :: TimeValue -> Encoding

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

Return a tuple of (past, future) elements

data AMPM

Constructors

AM

PM

Instances

Eq AMPM

Methods

(==) :: AMPM -> AMPM -> Bool

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

Show AMPM

Methods

showsPrec :: Int -> AMPM -> ShowS

show :: AMPM -> String

showList :: [AMPM] -> ShowS

data SeasonName

Constructors

Spring

Summer

Fall

Winter

Instances

Enum SeasonName

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

Methods

(==) :: SeasonName -> SeasonName -> Bool

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

Ord SeasonName

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

Methods

showsPrec :: Int -> SeasonName -> ShowS

show :: SeasonName -> String

showList :: [SeasonName] -> ShowS

data Season

Regular seasons of the Northern Hemisphere.

Constructors

Season

Fields

• startYear :: Integer
• seasonName :: SeasonName

Instances

Eq Season

Methods

(==) :: Season -> Season -> Bool

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

Ord Season

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

Methods

showsPrec :: Int -> Season -> ShowS

show :: Season -> String

showList :: [Season] -> ShowS

newtype NoShow a

Constructors

NoShow a

Instances

Show (NoShow a)

Methods

showsPrec :: Int -> NoShow a -> ShowS

show :: NoShow a -> String

showList :: [NoShow a] -> ShowS

data Predicate

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

Methods

showsPrec :: Int -> Predicate -> ShowS

show :: Predicate -> String

showList :: [Predicate] -> ShowS

runPredicate :: Predicate -> SeriesPredicate

emptyTimeDatePredicate :: Predicate

mkEmptyPredicate :: Predicate

mkSeriesPredicate :: SeriesPredicate -> Predicate

mkSecondPredicate :: Int -> Predicate

mkMinutePredicate :: Int -> Predicate

mkHourPredicate :: Bool -> Int -> Predicate

mkAMPMPredicate :: AMPM -> Predicate

mkDayOfTheWeekPredicate :: Int -> Predicate

mkDayOfTheMonthPredicate :: Int -> Predicate

mkMonthPredicate :: Int -> Predicate

mkYearPredicate :: Int -> Predicate

mkIntersectPredicate :: Predicate -> Predicate -> Predicate

mkTimeIntervalsPredicate :: TimeIntervalType -> Predicate -> Predicate -> Predicate

containsTimeIntervalsPredicate :: Predicate -> Bool

diffStartTime :: TimeObject -> TimeObject -> NominalDiffTime

isEmptyPredicate :: Predicate -> Bool

seasonStart :: Season -> Day

seasonEnd :: Season -> Day

nextSeason :: Season -> Season

prevSeason :: Season -> Season

seasonOf :: Day -> Season

seasonPredicate :: Predicate

weekdayPredicate :: Predicate

toMidnight :: Day -> UTCTime

runSecondPredicate :: Int -> SeriesPredicate

runMinutePredicate :: Int -> SeriesPredicate

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

runAMPMPredicate :: AMPM -> SeriesPredicate

runDayOfTheWeekPredicate :: Int -> SeriesPredicate

runDayOfTheMonthPredicate :: Int -> SeriesPredicate

runMonthPredicate :: Int -> SeriesPredicate

runYearPredicate :: Int -> SeriesPredicate

Converts 2-digits to a year between 1950 and 2050

safeMax :: Int

runIntersectPredicate :: Predicate -> Predicate -> SeriesPredicate

runCompose :: SeriesPredicate -> SeriesPredicate -> SeriesPredicate

runTimeIntervalsPredicate :: TimeIntervalType -> Predicate -> Predicate -> SeriesPredicate

safeMaxInterval :: Int

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

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

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

pad :: Int -> Int -> Text

Zero-pad x to reach length n.

timezoneOffset :: TimeZone -> Text

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

toRFC3339 :: ZonedTime -> Text

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

timeValue :: TimeZoneSeries -> TimeObject -> SingleTimeValue

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

timeRound :: TimeObject -> Grain -> TimeObject

timePlus :: TimeObject -> Grain -> Integer -> TimeObject

timePlusEnd :: TimeObject -> Grain -> Integer -> TimeObject

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

timeEnd :: TimeObject -> UTCTime

timeStartingAtTheEndOf :: TimeObject -> TimeObject

data TimeIntervalType

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

Methods

(==) :: TimeIntervalType -> TimeIntervalType -> Bool

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

Show TimeIntervalType

Methods

showsPrec :: Int -> TimeIntervalType -> ShowS

show :: TimeIntervalType -> String

showList :: [TimeIntervalType] -> ShowS

timeInterval :: TimeIntervalType -> TimeObject -> TimeObject -> TimeObject

timeStartsBeforeTheEndOf :: TimeObject -> TimeObject -> Bool

timeBefore :: TimeObject -> TimeObject -> Bool

timeIntersect :: TimeObject -> TimeObject -> Maybe TimeObject

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