Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Storage.Serialisation

4 types
8 classes
9 values

Packageouroboros-consensus-4.2.1.0
Exports21
LicenceApache-2.0

valueaddPrefixLen :: Word8 -> PrefixLen -> PrefixLen

valuetakePrefix :: PrefixLen -> ByteString -> ShortByteString

valuecastSerialisedHeader

:: forall a. NestedCtxt_ blk Header a -> NestedCtxt_ blk' Header a
-> SerialisedHeader blk
-> SerialisedHeader blk'

valuedecodeDepPair

:: DecodeDiskDep f blk
=> CodecConfig blk
-> GenDepPair Serialised (f blk)
-> Decoder s (DepPair (f blk))

value

decodeTrivialSerialisedHeader :: TrivialDependency (NestedCtxt_ blk Header) => forall s. Decoder s (SerialisedHeader blk)

valueencodeDepPair

:: EncodeDiskDep f blk
=> CodecConfig blk
-> DepPair (f blk)
-> GenDepPair Serialised (f blk)

valueencodeTrivialSerialisedHeader

:: TrivialDependency (NestedCtxt_ blk Header)
=> SerialisedHeader blk
-> Encoding

valueserialisedHeaderFromPair

:: (SomeSecond (NestedCtxt Header) blk, ByteString)
-> SerialisedHeader blk

valueserialisedHeaderToPair

:: SerialisedHeader blk
-> (SomeSecond (NestedCtxt Header) blk, ByteString)

datadata BinaryBlockInfo

Constructors

BinaryBlockInfo
- headerOffset :: !Word16
- headerSize :: !Word16

Instances4Eq, Show, Generic, Rep

Eq BinaryBlockInfoDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
Show BinaryBlockInfoDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
Generic BinaryBlockInfoDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
type Rep BinaryBlockInfo = D1 ('MetaData "BinaryBlockInfo" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "BinaryBlockInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerOffset") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word16) :*: S1 ('MetaSel ('Just "headerSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word16)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common

newtypenewtype PrefixLen

Constructors

PrefixLen
- getPrefixLen :: Word8

Instances6Eq, Ord, Show, Generic, NoThunks, Rep

Eq PrefixLenDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
Ord PrefixLenDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
Show PrefixLenDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
Generic PrefixLenDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
NoThunks PrefixLenDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common
type Rep PrefixLen = D1 ('MetaData "PrefixLen" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "PrefixLen" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPrefixLen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Common

classclass DecodeDisk blk a where

Methods

decodeDisk :: CodecConfig blk -> forall s. Decoder s a

Instances10DecodeDisk, …

DecodeDisk blk (ChainDepState (BlockProtocol blk)) => DecodeDisk blk (WrapChainDepState blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
DecodeDisk blk blk => DecodeDisk blk (I blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
DecodeDiskDepIx (NestedCtxt Header) blk => DecodeDisk blk (SerialisedHeader blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
(DecodeDiskDepIx f blk, DecodeDiskDep f blk) => DecodeDisk blk (DepPair (f blk))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
DecodeDiskDepIx f blk => DecodeDisk blk (GenDepPair Serialised (f blk))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
DecodeDisk blk (a -> f blk) => DecodeDisk blk ((:.:) ((->) a) f blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
SerialiseHFC xs => DecodeDisk (HardForkBlock xs) (HardForkChainDepState xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
SerialiseHFC xs => DecodeDisk (HardForkBlock xs) (AnnTip (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
SerialiseHFC xs => DecodeDisk (HardForkBlock xs) (ByteString -> Either DecoderError (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
SerialiseHFC xs => DecodeDisk (HardForkBlock xs) (LedgerState (HardForkBlock xs) EmptyMK)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan

classclass DecodeDiskDep (f :: Type -> Type -> Type) blk where

Methods

decodeDiskDep :: CodecConfig blk -> f blk a -> forall s. Decoder s (ByteString -> a)

Instances1DecodeDiskDep

SerialiseHFC xs => DecodeDiskDep (NestedCtxt Header) (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan

classclass DecodeDiskDepIx (f :: Type -> Type -> Type) blk where

Methods

decodeDiskDepIx :: CodecConfig blk -> Decoder s (SomeSecond f blk)

Instances1DecodeDiskDepIx

SerialiseHFC xs => DecodeDiskDepIx (NestedCtxt Header) (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan

classclass EncodeDisk blk a where

Methods

encodeDisk :: CodecConfig blk -> a -> Encoding

Instances9EncodeDisk, …

EncodeDisk blk (ChainDepState (BlockProtocol blk)) => EncodeDisk blk (WrapChainDepState blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
EncodeDisk blk blk => EncodeDisk blk (I blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
EncodeDiskDepIx (NestedCtxt Header) blk => EncodeDisk blk (SerialisedHeader blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
(EncodeDiskDepIx f blk, EncodeDiskDep f blk) => EncodeDisk blk (DepPair (f blk))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
EncodeDiskDepIx f blk => EncodeDisk blk (GenDepPair Serialised (f blk))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
SerialiseHFC xs => EncodeDisk (HardForkBlock xs) (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
SerialiseHFC xs => EncodeDisk (HardForkBlock xs) (HardForkChainDepState xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
SerialiseHFC xs => EncodeDisk (HardForkBlock xs) (AnnTip (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
SerialiseHFC xs => EncodeDisk (HardForkBlock xs) (LedgerState (HardForkBlock xs) EmptyMK)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan

classclass EncodeDiskDep (f :: Type -> Type -> Type) blk where

Methods

encodeDiskDep :: CodecConfig blk -> f blk a -> a -> Encoding

Instances2EncodeDiskDep

SerialiseHFC xs => EncodeDiskDep (NestedCtxt Header) (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
EncodeDiskDep (NestedCtxt Header) m => EncodeDiskDep (NestedCtxt Header) (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

classclass EncodeDiskDepIx (f :: Type -> Type -> Type) blk where

Methods

encodeDiskDepIx :: CodecConfig blk -> SomeSecond f blk -> Encoding

Instances2EncodeDiskDepIx

SerialiseHFC xs => EncodeDiskDepIx (NestedCtxt Header) (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
EncodeDiskDepIx (NestedCtxt Header) m => EncodeDiskDepIx (NestedCtxt Header) (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

classclass HasBinaryBlockInfo blk where

Methods

getBinaryBlockInfo :: blk -> BinaryBlockInfo

Instances2HasBinaryBlockInfo

SerialiseHFC xs => HasBinaryBlockInfo (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
HasBinaryBlockInfo m => HasBinaryBlockInfo (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

classclass HasNestedContent f blk => ReconstructNestedCtxt (f :: Type -> Type) blk where

Methods

reconstructPrefixLen :: proxy (f blk) -> PrefixLen
reconstructNestedCtxt :: proxy (f blk) -> ShortByteString -> SizeInBytes -> SomeSecond (NestedCtxt f) blk

Instances2ReconstructNestedCtxt

SerialiseHFC xs => ReconstructNestedCtxt Header (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
ReconstructNestedCtxt Header m => ReconstructNestedCtxt Header (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

newtypenewtype SerialisedHeader blk

Constructors

SerialisedHeaderFromDepPair
- serialisedHeaderToDepPair :: GenDepPair Serialised (NestedCtxt Header blk)

Instances9Inject, Isomorphic, StandardHash, ShowProxy, EncodeDisk, DecodeDisk, …

Inject SerialisedHeaderDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Embed.Nary
Isomorphic SerialisedHeaderDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Embed.Unary
StandardHash blk => StandardHash (SerialisedHeader blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
ShowProxy blk => ShowProxy (SerialisedHeader blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
EncodeDiskDepIx (NestedCtxt Header) blk => EncodeDisk blk (SerialisedHeader blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
DecodeDiskDepIx (NestedCtxt Header) blk => DecodeDisk blk (SerialisedHeader blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
HasNestedContent Header blk => Show (SerialisedHeader blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation
SerialiseHFC xs => SerialiseNodeToNode (HardForkBlock xs) (SerialisedHeader (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode · orphan
type HeaderHash (SerialisedHeader blk) = HeaderHash blkDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.Serialisation

newtypenewtype SizeInBytes