Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
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
unsafeSlotFromInteger ∷ Integer → GYSlot

Documentation

data GYSlot #

Instances

Instances details

ToJSON GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods toJSON ∷ GYSlot → Value Source # toEncoding ∷ GYSlot → Encoding Source # toJSONList ∷ [GYSlot] → Value Source # toEncodingList ∷ [GYSlot] → Encoding Source #
Read GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods readsPrec ∷ Int → ReadS GYSlot Source # readList ∷ ReadS [GYSlot] Source # readPrec ∷ ReadPrec GYSlot Source # readListPrec ∷ ReadPrec [GYSlot] Source #
Show GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods showsPrec ∷ Int → GYSlot → ShowS Source # show ∷ GYSlot → String Source # showList ∷ [GYSlot] → ShowS Source #
PrintfArg GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods formatArg ∷ GYSlot → FieldFormatter Source # parseFormat ∷ GYSlot → ModifierParser Source #
Eq GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods (==) ∷ GYSlot → GYSlot → Bool Source # (/=) ∷ GYSlot → GYSlot → Bool Source #
Ord GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods compare ∷ GYSlot → GYSlot → Ordering Source # (<) ∷ GYSlot → GYSlot → Bool Source # (<=) ∷ GYSlot → GYSlot → Bool Source # (>) ∷ GYSlot → GYSlot → Bool Source # (>=) ∷ GYSlot → GYSlot → Bool Source # max ∷ GYSlot → GYSlot → GYSlot Source # min ∷ GYSlot → GYSlot → GYSlot Source #
ToParamSchema GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYSlot → ParamSchema t Source #
ToSchema GYSlot #
Instance details Defined in GeniusYield.Types.Slot Methods declareNamedSchema ∷ Proxy GYSlot → Declare (Definitions Schema) NamedSchema Source #

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 #

unsafeSlotFromInteger ∷ Integer → GYSlot #

Convert from regular integer, which might under or overflow.