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

GeniusYield.Types.Natural

Description

Synopsis

Documentation

data GYNatural #

Cardano allows token mint amount to be as large as 9_223_372_036_854_775_807 which may not be represented correct in Javascript's number type, consequently, such large integers are to be better given as text in JSON. This wrapper type around Natural gives modified FromJSON and ToJSON instances so to work with Text instead.

Instances

Instances details

FromJSON GYNatural #	`>>>` `Aeson.decode @GYNatural "\"123\""`Just (GYNatural 123) `>>>` `Aeson.eitherDecode @GYNatural "\"-123\""`Left "Error in $: underflow: -123 (should be a non-negative integer)" `>>>` `Aeson.eitherDecode @GYNatural "\"+123\""`Right (GYNatural 123) `>>>` `Aeson.eitherDecode @GYNatural "\"9223372036854775807\""`Right (GYNatural 9223372036854775807) `>>>` `Aeson.eitherDecode @GYNatural "\"123456789123456789123456789123456789123456789\""`Right (GYNatural 123456789123456789123456789123456789123456789) `>>>` `Aeson.eitherDecode @GYNatural "\"0011\""`Right (GYNatural 11) `>>>` `Aeson.eitherDecode @GYNatural "\"0f11\""`Left "Error in $: could not parse: `0f11'" `>>>` `Aeson.eitherDecode @GYNatural "\"-123456789123456789123456789123456789123456789\""`Left "Error in $: underflow: -123456789123456789123456789123456789123456789 (should be a non-negative integer)"
Instance details Defined in GeniusYield.Types.Natural Methods parseJSON ∷ Value → Parser GYNatural Source # parseJSONList ∷ Value → Parser [GYNatural] Source #
ToJSON GYNatural #	`>>>` `LBS8.putStrLn $ Aeson.encode (1234 :: GYNatural)`"1234" `>>>` `LBS8.putStrLn $ Aeson.encode (123456789123456789123456789123456789123456789 :: GYNatural)`"123456789123456789123456789123456789123456789"
Instance details Defined in GeniusYield.Types.Natural Methods toJSON ∷ GYNatural → Value Source # toEncoding ∷ GYNatural → Encoding Source # toJSONList ∷ [GYNatural] → Value Source # toEncodingList ∷ [GYNatural] → Encoding Source #
Enum GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods succ ∷ GYNatural → GYNatural Source # pred ∷ GYNatural → GYNatural Source # toEnum ∷ Int → GYNatural Source # fromEnum ∷ GYNatural → Int Source # enumFrom ∷ GYNatural → [GYNatural] Source # enumFromThen ∷ GYNatural → GYNatural → [GYNatural] Source # enumFromTo ∷ GYNatural → GYNatural → [GYNatural] Source # enumFromThenTo ∷ GYNatural → GYNatural → GYNatural → [GYNatural] Source #
Generic GYNatural #
Instance details Defined in GeniusYield.Types.Natural Associated Types type Rep GYNatural ∷ Type → Type Source # Methods from ∷ GYNatural → Rep GYNatural x Source # to ∷ Rep GYNatural x → GYNatural Source #
Num GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods (+) ∷ GYNatural → GYNatural → GYNatural Source # (-) ∷ GYNatural → GYNatural → GYNatural Source # (*) ∷ GYNatural → GYNatural → GYNatural Source # negate ∷ GYNatural → GYNatural Source # abs ∷ GYNatural → GYNatural Source # signum ∷ GYNatural → GYNatural Source # fromInteger ∷ Integer → GYNatural Source #
Read GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods readsPrec ∷ Int → ReadS GYNatural Source # readList ∷ ReadS [GYNatural] Source # readPrec ∷ ReadPrec GYNatural Source # readListPrec ∷ ReadPrec [GYNatural] Source #
Integral GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods quot ∷ GYNatural → GYNatural → GYNatural Source # rem ∷ GYNatural → GYNatural → GYNatural Source # div ∷ GYNatural → GYNatural → GYNatural Source # mod ∷ GYNatural → GYNatural → GYNatural Source # quotRem ∷ GYNatural → GYNatural → (GYNatural, GYNatural) Source # divMod ∷ GYNatural → GYNatural → (GYNatural, GYNatural) Source # toInteger ∷ GYNatural → Integer Source #
Real GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods toRational ∷ GYNatural → Rational Source #
Show GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods showsPrec ∷ Int → GYNatural → ShowS Source # show ∷ GYNatural → String Source # showList ∷ [GYNatural] → ShowS Source #
PrintfArg GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods formatArg ∷ GYNatural → FieldFormatter Source # parseFormat ∷ GYNatural → ModifierParser Source #
Eq GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods (==) ∷ GYNatural → GYNatural → Bool Source # (/=) ∷ GYNatural → GYNatural → Bool Source #
Ord GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods compare ∷ GYNatural → GYNatural → Ordering Source # (<) ∷ GYNatural → GYNatural → Bool Source # (<=) ∷ GYNatural → GYNatural → Bool Source # (>) ∷ GYNatural → GYNatural → Bool Source # (>=) ∷ GYNatural → GYNatural → Bool Source # max ∷ GYNatural → GYNatural → GYNatural Source # min ∷ GYNatural → GYNatural → GYNatural Source #
FromHttpApiData GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods parseUrlPiece ∷ Text → Either Text GYNatural Source # parseHeader ∷ ByteString → Either Text GYNatural Source # parseQueryParam ∷ Text → Either Text GYNatural Source #
ToHttpApiData GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods toUrlPiece ∷ GYNatural → Text Source # toEncodedUrlPiece ∷ GYNatural → Builder Source # toHeader ∷ GYNatural → ByteString Source # toQueryParam ∷ GYNatural → Text Source #
ToParamSchema GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYNatural → ParamSchema t Source #
ToSchema GYNatural #	`>>>` `Aeson.encode (Swagger.toSchema (Proxy :: Proxy GYNatural))`"{\"description\":\"A natural number which is a non-negative integer. Minimum value is 0.\",\"example\":\"123456789123456789123456789123456789123456789\",\"type\":\"string\"}"
Instance details Defined in GeniusYield.Types.Natural Methods declareNamedSchema ∷ Proxy GYNatural → Declare (Definitions Schema) NamedSchema Source #
type Rep GYNatural #
Instance details Defined in GeniusYield.Types.Natural type Rep GYNatural = D1 ('MetaData "GYNatural" "GeniusYield.Types.Natural" "atlas-cardano-0.4.0-inplace" 'True) (C1 ('MetaCons "GYNatural" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

naturalFromGHC ∷ Natural → GYNatural #

naturalToGHC ∷ GYNatural → Natural #