Data.EBird.API.Util.Time

Utilities for parsing and printing dates and times that the eBird API provides.

Date and time types

newtype EBirdDate

An EBirdDate is simply a Day.

Constructors

EBirdDate

Fields

• eBirdDate :: Day

Instances

IsString EBirdDate

Use this instance carefully! It throws runtime exceptions if the string is malformatted.

Defined in Data.EBird.API.Util.Time

Methods

fromString :: String -> EBirdDate

Enum EBirdDate

Defined in Data.EBird.API.Util.Time

Methods

succ :: EBirdDate -> EBirdDate

pred :: EBirdDate -> EBirdDate

toEnum :: Int -> EBirdDate

fromEnum :: EBirdDate -> Int

enumFrom :: EBirdDate -> [EBirdDate]

enumFromThen :: EBirdDate -> EBirdDate -> [EBirdDate]

enumFromTo :: EBirdDate -> EBirdDate -> [EBirdDate]

enumFromThenTo :: EBirdDate -> EBirdDate -> EBirdDate -> [EBirdDate]

Read EBirdDate

Defined in Data.EBird.API.Util.Time

Methods

readsPrec :: Int -> ReadS EBirdDate

readList :: ReadS [EBirdDate]

readPrec :: ReadPrec EBirdDate

readListPrec :: ReadPrec [EBirdDate]

Show EBirdDate

Defined in Data.EBird.API.Util.Time

Methods

showsPrec :: Int -> EBirdDate -> ShowS

show :: EBirdDate -> String

showList :: [EBirdDate] -> ShowS

EBirdString EBirdDate

eBird dates are formatted as YYYY-MM-DD, with 0 padding where necessary.

Defined in Data.EBird.API.Util.Time

Methods

toEBirdString :: EBirdDate -> Text

fromEBirdString :: Text -> Either Text EBirdDate

Eq EBirdDate

Defined in Data.EBird.API.Util.Time

Methods

(==) :: EBirdDate -> EBirdDate -> Bool

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

Ord EBirdDate

Defined in Data.EBird.API.Util.Time

Methods

compare :: EBirdDate -> EBirdDate -> Ordering

(<) :: EBirdDate -> EBirdDate -> Bool

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

(>) :: EBirdDate -> EBirdDate -> Bool

(>=) :: EBirdDate -> EBirdDate -> Bool

max :: EBirdDate -> EBirdDate -> EBirdDate

min :: EBirdDate -> EBirdDate -> EBirdDate

FromJSON EBirdDate

Defined in Data.EBird.API.Util.Time

Methods

parseJSON :: Value -> Parser EBirdDate

parseJSONList :: Value -> Parser [EBirdDate]

ToJSON EBirdDate

Defined in Data.EBird.API.Util.Time

Methods

toJSON :: EBirdDate -> Value

toEncoding :: EBirdDate -> Encoding

toJSONList :: [EBirdDate] -> Value

toEncodingList :: [EBirdDate] -> Encoding

newtype EBirdTime

Since times that come from the eBird API are not provided with a time zone, an EBirdTime is simply a TimeOfDay. Since eBird times are only provided up to the minute, the todSec value will always be 0.

Constructors

EBirdTime

Fields

• eBirdTime :: TimeOfDay

Instances

IsString EBirdTime

Use this instance carefully! It throws runtime exceptions if the string is malformatted.

Defined in Data.EBird.API.Util.Time

Methods

fromString :: String -> EBirdTime

Read EBirdTime

Defined in Data.EBird.API.Util.Time

Methods

readsPrec :: Int -> ReadS EBirdTime

readList :: ReadS [EBirdTime]

readPrec :: ReadPrec EBirdTime

readListPrec :: ReadPrec [EBirdTime]

Show EBirdTime

Defined in Data.EBird.API.Util.Time

Methods

showsPrec :: Int -> EBirdTime -> ShowS

show :: EBirdTime -> String

showList :: [EBirdTime] -> ShowS

EBirdString EBirdTime

eBird times are formatted as HH:MM, with 0 padding where necessary.

Defined in Data.EBird.API.Util.Time

Methods

toEBirdString :: EBirdTime -> Text

fromEBirdString :: Text -> Either Text EBirdTime

Eq EBirdTime

Defined in Data.EBird.API.Util.Time

Methods

(==) :: EBirdTime -> EBirdTime -> Bool

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

Ord EBirdTime

Defined in Data.EBird.API.Util.Time

Methods

compare :: EBirdTime -> EBirdTime -> Ordering

(<) :: EBirdTime -> EBirdTime -> Bool

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

(>) :: EBirdTime -> EBirdTime -> Bool

(>=) :: EBirdTime -> EBirdTime -> Bool

max :: EBirdTime -> EBirdTime -> EBirdTime

min :: EBirdTime -> EBirdTime -> EBirdTime

FromJSON EBirdTime

Defined in Data.EBird.API.Util.Time

Methods

parseJSON :: Value -> Parser EBirdTime

parseJSONList :: Value -> Parser [EBirdTime]

ToJSON EBirdTime

Defined in Data.EBird.API.Util.Time

Methods

toJSON :: EBirdTime -> Value

toEncoding :: EBirdTime -> Encoding

toJSONList :: [EBirdTime] -> Value

toEncodingList :: [EBirdTime] -> Encoding

newtype EBirdDateTime

Dates and times that come from the eBird API are not provided with a time zone. All we can do is track the Day and TimeOfDay with a LocalTime. Comparison of, for example, Observations that happened in different time zones must therefore be done carefully.

Constructors

EBirdDateTime

Fields

• eBirdDateTime :: LocalTime

Instances

IsString EBirdDateTime

Use this instance carefully! It throws runtime exceptions if the string is malformatted.

Defined in Data.EBird.API.Util.Time

Methods

fromString :: String -> EBirdDateTime

Read EBirdDateTime

Defined in Data.EBird.API.Util.Time

Methods

readsPrec :: Int -> ReadS EBirdDateTime

readList :: ReadS [EBirdDateTime]

readPrec :: ReadPrec EBirdDateTime

readListPrec :: ReadPrec [EBirdDateTime]

Show EBirdDateTime

Defined in Data.EBird.API.Util.Time

Methods

showsPrec :: Int -> EBirdDateTime -> ShowS

show :: EBirdDateTime -> String

showList :: [EBirdDateTime] -> ShowS

EBirdString EBirdDateTime

eBird datetimes are formatted as YYYY-MM-DD HH:MM, with 0 padding where necessary.

Defined in Data.EBird.API.Util.Time

Methods

toEBirdString :: EBirdDateTime -> Text

fromEBirdString :: Text -> Either Text EBirdDateTime

Eq EBirdDateTime

Defined in Data.EBird.API.Util.Time

Methods

(==) :: EBirdDateTime -> EBirdDateTime -> Bool

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

Ord EBirdDateTime

Defined in Data.EBird.API.Util.Time

Methods

compare :: EBirdDateTime -> EBirdDateTime -> Ordering

(<) :: EBirdDateTime -> EBirdDateTime -> Bool

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

(>) :: EBirdDateTime -> EBirdDateTime -> Bool

(>=) :: EBirdDateTime -> EBirdDateTime -> Bool

max :: EBirdDateTime -> EBirdDateTime -> EBirdDateTime

min :: EBirdDateTime -> EBirdDateTime -> EBirdDateTime

FromJSON EBirdDateTime

Defined in Data.EBird.API.Util.Time

Methods

parseJSON :: Value -> Parser EBirdDateTime

parseJSONList :: Value -> Parser [EBirdDateTime]

ToJSON EBirdDateTime

Defined in Data.EBird.API.Util.Time

Methods

toJSON :: EBirdDateTime -> Value

toEncoding :: EBirdDateTime -> Encoding

toJSONList :: [EBirdDateTime] -> Value

toEncodingList :: [EBirdDateTime] -> Encoding

Conversions

eBirdDateToGregorian :: EBirdDate -> (Integer, Integer, Integer)

Convert an EBirdDate to a gregorian representation. The first element is the year, the second is the month in the year (1 - 12), and the third is the day in the month.

attoparsec parsers

parseEBirdDate :: Parser EBirdDate

Parse an eBird date. Most eBird dates are formatted as YYYY-MM-DD, but the ChecklistFeedAPI gives dates in a format like "19 Jul 2023". So, we try parsing the first format using day, and then use a custom parseTimeM format for the latter format if that fails.

parseEBirdTime :: Parser EBirdTime

Parse an eBird time (just uses timeOfDay).

parseEBirdDateTime :: Parser EBirdDateTime

Parse an eBird datetime (just uses localTime).