kairos-core-0.1: A utility program for converting between timezones.

Safe Haskell	None
Language	Haskell2010

Kairos.Types.TimeReader

Description

Since: 0.1

Synopsis

data TimeReader = MkTimeReader {
- formats :: NonEmpty TimeFormat
- srcTZ :: Maybe TZInput
- date :: Maybe Date
- timeString :: Text
}
defaultTimeReader :: Text -> TimeReader

Documentation

data TimeReader Source #

Determines how to read a time string.

Since: 0.1

Constructors

Fields

formats :: NonEmpty TimeFormat
Format(s) used when parsing the time string. This should not include timezone formatting e.g. %Z. Use srcTZ instead. It should also not include date information. Use date instead.
The formats are tried in order.
Since: 0.1
srcTZ :: Maybe TZInput
Timezone in which to read the string. Nothing corresponds to local timezone.
Since: 0.1
date :: Maybe Date
Date corresponding to the timeString. If Nothing, uses the current date, determined by the source.
Since: 0.1
timeString :: Text
The time string to parse. This should not include a timezone e.g. EST. Use srcTZ instead.
Since: 0.1

Instances

Instances details

NFData TimeReader Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

Methods

rnf :: TimeReader -> () #

Generic TimeReader Source #

Instance details

Defined in Kairos.Types.TimeReader

Associated Types

type Rep TimeReader

Since: kairos-core-0.1

Instance details

Defined in Kairos.Types.TimeReader

type Rep TimeReader = D1 ('MetaData "TimeReader" "Kairos.Types.TimeReader" "kairos-core-0.1-inplace" 'False) (C1 ('MetaCons "MkTimeReader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "formats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty TimeFormat)) :*: S1 ('MetaSel ('Just "srcTZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TZInput))) :*: (S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Date)) :*: S1 ('MetaSel ('Just "timeString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

Methods

from :: TimeReader -> Rep TimeReader x #

to :: Rep TimeReader x -> TimeReader #

Show TimeReader Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

Methods

showsPrec :: Int -> TimeReader -> ShowS #

show :: TimeReader -> String #

showList :: [TimeReader] -> ShowS #

Eq TimeReader Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

Methods

(==) :: TimeReader -> TimeReader -> Bool #

(/=) :: TimeReader -> TimeReader -> Bool #

(k ~ A_Lens, a ~ Maybe Date, b ~ Maybe Date) => LabelOptic "date" k TimeReader TimeReader a b Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

Methods

labelOptic :: Optic k NoIx TimeReader TimeReader a b Source #

(k ~ A_Lens, a ~ NonEmpty TimeFormat, b ~ NonEmpty TimeFormat) => LabelOptic "formats" k TimeReader TimeReader a b Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

Methods

labelOptic :: Optic k NoIx TimeReader TimeReader a b Source #

(k ~ A_Lens, a ~ Maybe TZInput, b ~ Maybe TZInput) => LabelOptic "srcTZ" k TimeReader TimeReader a b Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

Methods

labelOptic :: Optic k NoIx TimeReader TimeReader a b Source #

(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "timeString" k TimeReader TimeReader a b Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

Methods

labelOptic :: Optic k NoIx TimeReader TimeReader a b Source #

type Rep TimeReader Source #

Since: 0.1

Instance details

Defined in Kairos.Types.TimeReader

type Rep TimeReader = D1 ('MetaData "TimeReader" "Kairos.Types.TimeReader" "kairos-core-0.1-inplace" 'False) (C1 ('MetaCons "MkTimeReader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "formats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty TimeFormat)) :*: S1 ('MetaSel ('Just "srcTZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TZInput))) :*: (S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Date)) :*: S1 ('MetaSel ('Just "timeString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

defaultTimeReader :: Text -> TimeReader Source #

Given a time string, returns a default time reader.

Since: 0.1