ouroboros-consensus-0.27.0.0: Consensus layer for the Ouroboros blockchain protocol
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.BlockchainTime.WallClock.Types

Synopsis

System time

newtype SystemStart Source #

System start

Slots are counted from the system start.

Constructors

SystemStart 

Fields

Instances

Instances details
FromJSON SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

parseJSON ∷ Value → Parser SystemStart Source #

parseJSONList ∷ Value → Parser [SystemStart] Source #

omittedField ∷ Maybe SystemStart Source #

ToJSON SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

toJSON ∷ SystemStart → Value Source #

toEncoding ∷ SystemStart → Encoding Source #

toJSONList ∷ [SystemStart] → Value Source #

toEncodingList ∷ [SystemStart] → Encoding Source #

omitField ∷ SystemStart → Bool Source #

FromCBOR SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

fromCBOR ∷ Decoder s SystemStart Source #

label ∷ Proxy SystemStart → Text Source #

ToCBOR SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

toCBOR ∷ SystemStart → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SystemStart → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SystemStart] → Size Source #

EncCBOR SystemStart 
Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR ∷ SystemStart → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy SystemStart → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [SystemStart] → Size Source #

Generic SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Associated Types

type Rep SystemStart 
Instance details

Defined in Cardano.Slotting.Time

type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Methods

from ∷ SystemStart → Rep SystemStart x #

to ∷ Rep SystemStart x → SystemStart #

Show SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

showsPrec ∷ Int → SystemStart → ShowS #

show ∷ SystemStart → String #

showList ∷ [SystemStart] → ShowS #

Eq SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

(==) ∷ SystemStart → SystemStart → Bool #

(/=) ∷ SystemStart → SystemStart → Bool #

NoThunks SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

noThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy SystemStart → String Source #

Serialise SystemStart 
Instance details

Defined in Cardano.Slotting.Time

Methods

encode ∷ SystemStart → Encoding Source #

decode ∷ Decoder s SystemStart Source #

encodeList ∷ [SystemStart] → Encoding Source #

decodeList ∷ Decoder s [SystemStart] Source #

type Rep SystemStart 
Instance details

Defined in Cardano.Slotting.Time

type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Relative time

newtype RelativeTime Source #

RelativeTime is time relative to the SystemStart

Precision is in picoseconds

Constructors

RelativeTime 

Fields

Instances

Instances details
FromJSON RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

parseJSON ∷ Value → Parser RelativeTime Source #

parseJSONList ∷ Value → Parser [RelativeTime] Source #

omittedField ∷ Maybe RelativeTime Source #

ToJSON RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

toJSON ∷ RelativeTime → Value Source #

toEncoding ∷ RelativeTime → Encoding Source #

toJSONList ∷ [RelativeTime] → Value Source #

toEncodingList ∷ [RelativeTime] → Encoding Source #

omitField ∷ RelativeTime → Bool Source #

FromCBOR RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

fromCBOR ∷ Decoder s RelativeTime Source #

label ∷ Proxy RelativeTime → Text Source #

ToCBOR RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

toCBOR ∷ RelativeTime → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy RelativeTime → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [RelativeTime] → Size Source #

Generic RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Associated Types

type Rep RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

type Rep RelativeTime = D1 ('MetaData "RelativeTime" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "RelativeTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRelativeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

Methods

from ∷ RelativeTime → Rep RelativeTime x #

to ∷ Rep RelativeTime x → RelativeTime #

Show RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

showsPrec ∷ Int → RelativeTime → ShowS #

show ∷ RelativeTime → String #

showList ∷ [RelativeTime] → ShowS #

Eq RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

(==) ∷ RelativeTime → RelativeTime → Bool #

(/=) ∷ RelativeTime → RelativeTime → Bool #

Ord RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

compare ∷ RelativeTime → RelativeTime → Ordering #

(<) ∷ RelativeTime → RelativeTime → Bool #

(<=) ∷ RelativeTime → RelativeTime → Bool #

(>) ∷ RelativeTime → RelativeTime → Bool #

(>=) ∷ RelativeTime → RelativeTime → Bool #

max ∷ RelativeTime → RelativeTime → RelativeTime #

min ∷ RelativeTime → RelativeTime → RelativeTime #

NoThunks RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

noThunks ∷ Context → RelativeTime → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → RelativeTime → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy RelativeTime → String Source #

Serialise RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

Methods

encode ∷ RelativeTime → Encoding Source #

decode ∷ Decoder s RelativeTime Source #

encodeList ∷ [RelativeTime] → Encoding Source #

decodeList ∷ Decoder s [RelativeTime] Source #

type Rep RelativeTime 
Instance details

Defined in Cardano.Slotting.Time

type Rep RelativeTime = D1 ('MetaData "RelativeTime" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "RelativeTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRelativeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

addRelTime ∷ NominalDiffTime → RelativeTime → RelativeTime Source #

diffRelTime ∷ RelativeTime → RelativeTime → NominalDiffTime Source #

fromRelativeTime ∷ SystemStart → RelativeTime → UTCTime Source #

toRelativeTime ∷ SystemStart → UTCTime → RelativeTime Source #

Get current time (as RelativeTime)

data SystemTime (m ∷ Type → Type) Source #

System time

Slots are counted from the system start.

Constructors

SystemTime 

Fields

Instances

Instances details
NoThunks (SystemTime m) Source # 
Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

Methods

noThunks ∷ Context → SystemTime m → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → SystemTime m → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (SystemTime m) → String Source #

Slot length

getSlotLength ∷ SlotLength → NominalDiffTime Source #

mkSlotLength ∷ NominalDiffTime → SlotLength Source #

Constructor for SlotLength

Conversions

slotLengthFromMillisec ∷ Integer → SlotLength Source #

slotLengthFromSec ∷ Integer → SlotLength Source #

slotLengthToMillisec ∷ SlotLength → Integer Source #

slotLengthToSec ∷ SlotLength → Integer Source #

opaque

data SlotLength Source #

Slot length

Precision is in milliseconds

Instances

Instances details
FromCBOR SlotLength 
Instance details

Defined in Cardano.Slotting.Time

Methods

fromCBOR ∷ Decoder s SlotLength Source #

label ∷ Proxy SlotLength → Text Source #

ToCBOR SlotLength 
Instance details

Defined in Cardano.Slotting.Time

Methods

toCBOR ∷ SlotLength → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SlotLength → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SlotLength] → Size Source #

Generic SlotLength 
Instance details

Defined in Cardano.Slotting.Time

Associated Types

type Rep SlotLength 
Instance details

Defined in Cardano.Slotting.Time

type Rep SlotLength = D1 ('MetaData "SlotLength" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "SlotLength" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSlotLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

Methods

from ∷ SlotLength → Rep SlotLength x #

to ∷ Rep SlotLength x → SlotLength #

Show SlotLength 
Instance details

Defined in Cardano.Slotting.Time

Methods

showsPrec ∷ Int → SlotLength → ShowS #

show ∷ SlotLength → String #

showList ∷ [SlotLength] → ShowS #

Eq SlotLength 
Instance details

Defined in Cardano.Slotting.Time

Methods

(==) ∷ SlotLength → SlotLength → Bool #

(/=) ∷ SlotLength → SlotLength → Bool #

NoThunks SlotLength 
Instance details

Defined in Cardano.Slotting.Time

Methods

noThunks ∷ Context → SlotLength → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → SlotLength → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy SlotLength → String Source #

Serialise SlotLength 
Instance details

Defined in Cardano.Slotting.Time

Methods

encode ∷ SlotLength → Encoding Source #

decode ∷ Decoder s SlotLength Source #

encodeList ∷ [SlotLength] → Encoding Source #

decodeList ∷ Decoder s [SlotLength] Source #

type Rep SlotLength 
Instance details

Defined in Cardano.Slotting.Time

type Rep SlotLength = D1 ('MetaData "SlotLength" "Cardano.Slotting.Time" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "SlotLength" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSlotLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))