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

GeniusYield.Types.Slot

Description

Synopsis

data GYSlot
slotToApi :: GYSlot -> SlotNo
slotFromApi :: SlotNo -> GYSlot
advanceSlot :: GYSlot -> Natural -> Maybe GYSlot
unsafeAdvanceSlot :: GYSlot -> Natural -> GYSlot
slotToInteger :: GYSlot -> Integer
slotFromInteger :: Integer -> Maybe GYSlot
slotToWord64 :: GYSlot -> Word64
slotFromWord64 :: Word64 -> GYSlot
unsafeSlotFromInteger :: Integer -> GYSlot

Documentation

data GYSlot #

Instances

Instances details

FromJSON GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods parseJSON :: Value -> Parser GYSlot # parseJSONList :: Value -> Parser [GYSlot] # omittedField :: Maybe GYSlot #
ToJSON GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods toJSON :: GYSlot -> Value # toEncoding :: GYSlot -> Encoding # toJSONList :: [GYSlot] -> Value # toEncodingList :: [GYSlot] -> Encoding # omitField :: GYSlot -> Bool #
PrintfArg GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods formatArg :: GYSlot -> FieldFormatter # parseFormat :: GYSlot -> ModifierParser #
Read GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods readsPrec :: Int -> ReadS GYSlot # readList :: ReadS [GYSlot] # readPrec :: ReadPrec GYSlot # readListPrec :: ReadPrec [GYSlot] #
Show GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods showsPrec :: Int -> GYSlot -> ShowS # show :: GYSlot -> String # showList :: [GYSlot] -> ShowS #
Eq GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods (==) :: GYSlot -> GYSlot -> Bool # (/=) :: GYSlot -> GYSlot -> Bool #
Ord GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods compare :: GYSlot -> GYSlot -> Ordering # (<) :: GYSlot -> GYSlot -> Bool # (<=) :: GYSlot -> GYSlot -> Bool # (>) :: GYSlot -> GYSlot -> Bool # (>=) :: GYSlot -> GYSlot -> Bool # max :: GYSlot -> GYSlot -> GYSlot # min :: GYSlot -> GYSlot -> GYSlot #
FromHttpApiData GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods parseUrlPiece :: Text -> Either Text GYSlot # parseHeader :: ByteString -> Either Text GYSlot # parseQueryParam :: Text -> Either Text GYSlot #
ToHttpApiData GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods toUrlPiece :: GYSlot -> Text # toEncodedUrlPiece :: GYSlot -> Builder # toHeader :: GYSlot -> ByteString # toQueryParam :: GYSlot -> Text # toEncodedQueryParam :: GYSlot -> Builder #
ToParamSchema GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy GYSlot -> ParamSchema t #
ToSchema GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods declareNamedSchema :: Proxy GYSlot -> Declare (Definitions Schema) NamedSchema #

slotToApi :: GYSlot -> SlotNo #

slotFromApi :: SlotNo -> GYSlot #

advanceSlot :: GYSlot -> Natural -> Maybe GYSlot #

Advance GYSlot forward. If slot value overflows, return Nothing.

unsafeAdvanceSlot :: GYSlot -> Natural -> GYSlot #

Unsafe advance GYSlot. Doesn't check for the overflow.

slotToInteger :: GYSlot -> Integer #

slotFromInteger :: Integer -> Maybe GYSlot #

slotToWord64 :: GYSlot -> Word64 #

slotFromWord64 :: Word64 -> GYSlot #

unsafeSlotFromInteger :: Integer -> GYSlot #

Convert from regular integer, which might under or overflow.