Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Types.Time

Description

Synopsis

class FormatTime t where
- formatCharacter ∷ Bool → Char → Maybe (FormatOptions → t → String)
class ParseTime t where
- substituteTimeSpecifier ∷ Proxy t → TimeLocale → Char → Maybe String
- parseTimeSpecifier ∷ Proxy t → TimeLocale → Maybe ParseNumericPadding → Char → ReadP String
- buildTime ∷ TimeLocale → [(Char, String)] → Maybe t
gyIso8601Show ∷ GYTime → String
gyIso8601ParseM ∷ MonadFail m ⇒ String → m GYTime
data GYTime
getCurrentGYTime ∷ IO GYTime
addSeconds ∷ GYTime → Rational → GYTime
timeFromPlutus ∷ POSIXTime → GYTime
timeToPlutus ∷ GYTime → POSIXTime
timeToPOSIX ∷ GYTime → POSIXTime
timeFromPOSIX ∷ POSIXTime → GYTime

Documentation

class FormatTime t where #

Methods

formatCharacter ∷ Bool → Char → Maybe (FormatOptions → t → String) #

Since: time-1.9.1

Instances

Instances details

FormatTime DotNetTime
Instance details Defined in Data.Aeson.Types.Internal Methods formatCharacter ∷ Bool → Char → Maybe (FormatOptions → DotNetTime → String) #
FormatTime GYTime #
Instance details Defined in GeniusYield.Types.Time Methods formatCharacter ∷ Bool → Char → Maybe (FormatOptions → GYTime → String) #

class ParseTime t where #

The class of types which can be parsed given a UNIX-style time format string.

Minimal complete definition

parseTimeSpecifier, buildTime

Methods

substituteTimeSpecifier ∷ Proxy t → TimeLocale → Char → Maybe String #

Since: time-1.9.1

parseTimeSpecifier ∷ Proxy t → TimeLocale → Maybe ParseNumericPadding → Char → ReadP String #

Get the string corresponding to the given format specifier.

Since: time-1.9.1

buildTime #

Arguments

∷ TimeLocale	The time locale.
→ [(Char, String)]	Pairs of format characters and the corresponding part of the input.
→ Maybe t

Builds a time value from a parsed input string. If the input does not include all the information needed to construct a complete value, any missing parts should be taken from 1970-01-01 00:00:00 +0000 (which was a Thursday). In the absence of %C or %Y, century is 1969 - 2068.

Since: time-1.9.1

Instances

Instances details

ParseTime GYTime #
Instance details Defined in GeniusYield.Types.Time Methods substituteTimeSpecifier ∷ Proxy GYTime → TimeLocale → Char → Maybe String # parseTimeSpecifier ∷ Proxy GYTime → TimeLocale → Maybe ParseNumericPadding → Char → ReadP String # buildTime ∷ TimeLocale → [(Char, String)] → Maybe GYTime #

gyIso8601Show ∷ GYTime → String #

>>> gyIso8601Show (timeFromPlutus 0)
"1970-01-01T00:00:00Z"

gyIso8601ParseM ∷ MonadFail m ⇒ String → m GYTime #

>>> gyIso8601ParseM @Maybe "1970-01-01T00:00:33.333Z"
Just (GYTime 33.333s)

>>> gyIso8601ParseM @Maybe "1970-01-01T00:00:33.333"
Nothing

data GYTime #

Instances

Instances details

FromJSON GYTime #	`>>>` `Aeson.eitherDecode @GYTime "\"1970-01-01T00:00:00Z\""`Right (GYTime 0s) `>>>` `Aeson.eitherDecode @GYTime "\"1970-01-01T00:00:00\""`Left "Error in $: can't parse '1970-01-01T00:00:00' as GYTime in ISO8601 format"
Instance details Defined in GeniusYield.Types.Time Methods parseJSON ∷ Value → Parser GYTime # parseJSONList ∷ Value → Parser [GYTime] # omittedField ∷ Maybe GYTime #
ToJSON GYTime #	`>>>` `LBS8.putStrLn $ Aeson.encode $ timeFromPlutus 0`"1970-01-01T00:00:00Z"
Instance details Defined in GeniusYield.Types.Time Methods toJSON ∷ GYTime → Value # toEncoding ∷ GYTime → Encoding # toJSONList ∷ [GYTime] → Value # toEncodingList ∷ [GYTime] → Encoding # omitField ∷ GYTime → Bool #
IsString GYTime #	`>>>` `"1970-01-01T00:00:00Z" :: GYTime`GYTime 0s `>>>` `"1970-01-01T00:00:00" :: GYTime`*** Exception: can't parse '1970-01-01T00:00:00' as GYTime in ISO8601 format ...
Instance details Defined in GeniusYield.Types.Time Methods fromString ∷ String → GYTime #
Read GYTime #
Instance details Defined in GeniusYield.Types.Time Methods readsPrec ∷ Int → ReadS GYTime # readList ∷ ReadS [GYTime] # readPrec ∷ ReadPrec GYTime # readListPrec ∷ ReadPrec [GYTime] #
Show GYTime #
Instance details Defined in GeniusYield.Types.Time Methods showsPrec ∷ Int → GYTime → ShowS # show ∷ GYTime → String # showList ∷ [GYTime] → ShowS #
PrintfArg GYTime #	`>>>` `printf "%s\n" $ timeFromPlutus 1000`1970-01-01T00:00:01Z
Instance details Defined in GeniusYield.Types.Time Methods formatArg ∷ GYTime → FieldFormatter # parseFormat ∷ GYTime → ModifierParser #
FromField GYTime #	`>>>` `Csv.runParser $ Csv.parseField @GYTime "1970-01-01T00:00:00Z"`Right (GYTime 0s) `>>>` `Csv.runParser $ Csv.parseField @GYTime "not a time"`Left "can't parse 'not a time' as GYTime in ISO8601 format"
Instance details Defined in GeniusYield.Types.Time Methods parseField ∷ Field → Parser GYTime #
ToField GYTime #	`>>>` `Csv.toField @GYTime "1970-01-01T00:00:00Z"`"1970-01-01T00:00:00Z"
Instance details Defined in GeniusYield.Types.Time Methods toField ∷ GYTime → Field #
Eq GYTime #
Instance details Defined in GeniusYield.Types.Time Methods (==) ∷ GYTime → GYTime → Bool # (/=) ∷ GYTime → GYTime → Bool #
Ord GYTime #
Instance details Defined in GeniusYield.Types.Time Methods compare ∷ GYTime → GYTime → Ordering # (<) ∷ GYTime → GYTime → Bool # (<=) ∷ GYTime → GYTime → Bool # (>) ∷ GYTime → GYTime → Bool # (>=) ∷ GYTime → GYTime → Bool # max ∷ GYTime → GYTime → GYTime # min ∷ GYTime → GYTime → GYTime #
FromHttpApiData GYTime #	`>>>` `Web.parseUrlPiece @GYTime "1970-01-01T00:00:00Z"`Right (GYTime 0s) `>>>` `Web.parseUrlPiece @GYTime "1970-01-01T00:00:00"`Left "can't parse '1970-01-01T00:00:00' as GYTime in ISO8601 format"
Instance details Defined in GeniusYield.Types.Time Methods parseUrlPiece ∷ Text → Either Text GYTime # parseHeader ∷ ByteString → Either Text GYTime # parseQueryParam ∷ Text → Either Text GYTime #
ToHttpApiData GYTime #	`>>>` `Web.toUrlPiece $ timeFromPlutus 0`"1970-01-01T00:00:00Z"
Instance details Defined in GeniusYield.Types.Time Methods toUrlPiece ∷ GYTime → Text # toEncodedUrlPiece ∷ GYTime → Builder # toHeader ∷ GYTime → ByteString # toQueryParam ∷ GYTime → Text # toEncodedQueryParam ∷ GYTime → Builder #
ToParamSchema GYTime #
Instance details Defined in GeniusYield.Types.Time Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYTime → ParamSchema t #
ToSchema GYTime #
Instance details Defined in GeniusYield.Types.Time Methods declareNamedSchema ∷ Proxy GYTime → Declare (Definitions Schema) NamedSchema #
FormatTime GYTime #
Instance details Defined in GeniusYield.Types.Time Methods formatCharacter ∷ Bool → Char → Maybe (FormatOptions → GYTime → String) #
ParseTime GYTime #
Instance details Defined in GeniusYield.Types.Time Methods substituteTimeSpecifier ∷ Proxy GYTime → TimeLocale → Char → Maybe String # parseTimeSpecifier ∷ Proxy GYTime → TimeLocale → Maybe ParseNumericPadding → Char → ReadP String # buildTime ∷ TimeLocale → [(Char, String)] → Maybe GYTime #

getCurrentGYTime ∷ IO GYTime #

addSeconds ∷ GYTime → Rational → GYTime #

timeFromPlutus ∷ POSIXTime → GYTime #

>>> timeFromPlutus 12345
GYTime 12.345s

timeToPlutus ∷ GYTime → POSIXTime #

>>> timeToPlutus $ timeFromPlutus 31415
POSIXTime {getPOSIXTime = 31415}

timeToPOSIX ∷ GYTime → POSIXTime #

>>> timeToPOSIX (timeFromPOSIX 12346)
12346s

timeFromPOSIX ∷ POSIXTime → GYTime #

>>> timeFromPOSIX 12346
GYTime 12346s