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 # parseJSONList ∷ Value → Parser [GYNatural] # omittedField ∷ Maybe GYNatural #
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 # toEncoding ∷ GYNatural → Encoding # toJSONList ∷ [GYNatural] → Value # toEncodingList ∷ [GYNatural] → Encoding # omitField ∷ GYNatural → Bool #
Enum GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods succ ∷ GYNatural → GYNatural # pred ∷ GYNatural → GYNatural # toEnum ∷ Int → GYNatural # fromEnum ∷ GYNatural → Int # enumFrom ∷ GYNatural → [GYNatural] # enumFromThen ∷ GYNatural → GYNatural → [GYNatural] # enumFromTo ∷ GYNatural → GYNatural → [GYNatural] # enumFromThenTo ∷ GYNatural → GYNatural → GYNatural → [GYNatural] #
Generic GYNatural #
Instance details Defined in GeniusYield.Types.Natural Associated Types type Rep GYNatural ∷ Type → Type # Methods from ∷ GYNatural → Rep GYNatural x # to ∷ Rep GYNatural x → GYNatural #
Num GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods (+) ∷ GYNatural → GYNatural → GYNatural # (-) ∷ GYNatural → GYNatural → GYNatural # (*) ∷ GYNatural → GYNatural → GYNatural # negate ∷ GYNatural → GYNatural # abs ∷ GYNatural → GYNatural # signum ∷ GYNatural → GYNatural # fromInteger ∷ Integer → GYNatural #
Read GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods readsPrec ∷ Int → ReadS GYNatural # readList ∷ ReadS [GYNatural] # readPrec ∷ ReadPrec GYNatural # readListPrec ∷ ReadPrec [GYNatural] #
Integral GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods quot ∷ GYNatural → GYNatural → GYNatural # rem ∷ GYNatural → GYNatural → GYNatural # div ∷ GYNatural → GYNatural → GYNatural # mod ∷ GYNatural → GYNatural → GYNatural # quotRem ∷ GYNatural → GYNatural → (GYNatural, GYNatural) # divMod ∷ GYNatural → GYNatural → (GYNatural, GYNatural) # toInteger ∷ GYNatural → Integer #
Real GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods toRational ∷ GYNatural → Rational #
Show GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods showsPrec ∷ Int → GYNatural → ShowS # show ∷ GYNatural → String # showList ∷ [GYNatural] → ShowS #
PrintfArg GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods formatArg ∷ GYNatural → FieldFormatter # parseFormat ∷ GYNatural → ModifierParser #
Eq GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods (==) ∷ GYNatural → GYNatural → Bool # (/=) ∷ GYNatural → GYNatural → Bool #
Ord GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods compare ∷ GYNatural → GYNatural → Ordering # (<) ∷ GYNatural → GYNatural → Bool # (<=) ∷ GYNatural → GYNatural → Bool # (>) ∷ GYNatural → GYNatural → Bool # (>=) ∷ GYNatural → GYNatural → Bool # max ∷ GYNatural → GYNatural → GYNatural # min ∷ GYNatural → GYNatural → GYNatural #
FromHttpApiData GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods parseUrlPiece ∷ Text → Either Text GYNatural # parseHeader ∷ ByteString → Either Text GYNatural # parseQueryParam ∷ Text → Either Text GYNatural #
ToHttpApiData GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods toUrlPiece ∷ GYNatural → Text # toEncodedUrlPiece ∷ GYNatural → Builder # toHeader ∷ GYNatural → ByteString # toQueryParam ∷ GYNatural → Text # toEncodedQueryParam ∷ GYNatural → Builder #
ToParamSchema GYNatural #
Instance details Defined in GeniusYield.Types.Natural Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYNatural → ParamSchema t #
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 #
type Rep GYNatural #
Instance details Defined in GeniusYield.Types.Natural type Rep GYNatural = D1 ('MetaData "GYNatural" "GeniusYield.Types.Natural" "atlas-cardano-0.6.3-inplace" 'True) (C1 ('MetaCons "GYNatural" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

naturalFromGHC ∷ Natural → GYNatural #

naturalToGHC ∷ GYNatural → Natural #