Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.Serialisation

Contents

Serialisation to/from disk storage
Support for dependent pairs
Serialised header
Reconstruct nested type
Binary block info
Re-exported for convenience
Exported for the benefit of tests

Description

Serialisation for on-disk storage.

We have separate classes for on-disk and on-the-wire serialisation, because the encoding formats of the same type may differ, depending on the context.

We separate the encoder from the decoder, because sometimes the encoded type will differ from the decoded one. For example, we encode a blk , but decode an ByteString -> blk (when reading something from disk, we have the precise bytestring that we can pass in as the annotation). If we coupled the encoder to the decoder, we wouldn't be able to cleanly model this use case. Moreover, sometimes we only need a single direction.

Synopsis

class DecodeDisk blk a where
- decodeDisk :: CodecConfig blk -> forall s. Decoder s a
class EncodeDisk blk a where
- encodeDisk :: CodecConfig blk -> a -> Encoding
class DecodeDiskDep f blk where
- decodeDiskDep :: CodecConfig blk -> f blk a -> forall s. Decoder s ( ByteString -> a)
class DecodeDiskDepIx f blk where
- decodeDiskDepIx :: CodecConfig blk -> Decoder s ( SomeSecond f blk)
class EncodeDiskDep f blk where
- encodeDiskDep :: CodecConfig blk -> f blk a -> a -> Encoding
class EncodeDiskDepIx f blk where
- encodeDiskDepIx :: CodecConfig blk -> SomeSecond f blk -> Encoding
newtype SerialisedHeader blk = SerialisedHeaderFromDepPair {
- serialisedHeaderToDepPair :: GenDepPair Serialised ( NestedCtxt Header blk)
}
castSerialisedHeader :: ( forall a. NestedCtxt_ blk Header a -> NestedCtxt_ blk' Header a) -> SerialisedHeader blk -> SerialisedHeader blk'
decodeTrivialSerialisedHeader :: forall blk. TrivialDependency ( NestedCtxt_ blk Header ) => forall s. Decoder s ( SerialisedHeader blk)
encodeTrivialSerialisedHeader :: forall blk. TrivialDependency ( NestedCtxt_ blk Header ) => SerialisedHeader blk -> Encoding
serialisedHeaderFromPair :: ( SomeSecond ( NestedCtxt Header ) blk, ByteString ) -> SerialisedHeader blk
serialisedHeaderToPair :: SerialisedHeader blk -> ( SomeSecond ( NestedCtxt Header ) blk, ByteString )
newtype PrefixLen = PrefixLen {
- getPrefixLen :: Word8
}
class HasNestedContent f blk => ReconstructNestedCtxt f blk where
- reconstructPrefixLen :: proxy (f blk) -> PrefixLen
- reconstructNestedCtxt :: proxy (f blk) -> ShortByteString -> SizeInBytes -> SomeSecond ( NestedCtxt f) blk
addPrefixLen :: Word8 -> PrefixLen -> PrefixLen
takePrefix :: PrefixLen -> ByteString -> ShortByteString
data BinaryBlockInfo = BinaryBlockInfo {
- headerOffset :: ! Word16
- headerSize :: ! Word16
}
class HasBinaryBlockInfo blk where
- getBinaryBlockInfo :: blk -> BinaryBlockInfo
type SizeInBytes = Word32
decodeDepPair :: DecodeDiskDep f blk => CodecConfig blk -> GenDepPair Serialised (f blk) -> Decoder s ( DepPair (f blk))
encodeDepPair :: EncodeDiskDep f blk => CodecConfig blk -> DepPair (f blk) -> GenDepPair Serialised (f blk)

Serialisation to/from disk storage

class DecodeDisk blk a where Source #

Decode a type a read from disk.

There is no version negotiation for on disk serialisation. However, instances can still decide to perform versioning internally to maintain compatibility.

Minimal complete definition

Nothing

Methods

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

default decodeDisk :: Serialise a => CodecConfig blk -> forall s. Decoder s a Source #

Instances

Instances details

DecodeDisk blk blk => DecodeDisk blk ( I blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s ( I blk) Source #
DecodeDisk blk ( ChainDepState ( BlockProtocol blk)) => DecodeDisk blk ( WrapChainDepState blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s ( WrapChainDepState blk) Source #
DecodeDiskDepIx ( NestedCtxt Header ) blk => DecodeDisk blk ( SerialisedHeader blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s ( SerialisedHeader blk) Source #
( DecodeDiskDepIx f blk, DecodeDiskDep f blk) => DecodeDisk blk ( DepPair (f blk)) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s ( DepPair (f blk)) Source #
DecodeDiskDepIx f blk => DecodeDisk blk ( GenDepPair Serialised (f blk)) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s ( GenDepPair Serialised (f blk)) Source #
DecodeDisk blk (a -> f blk) => DecodeDisk blk ((((->) a :: Type -> Type ) :.: f) blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s (((->) a :.: f) blk) Source #
SerialiseHFC xs => DecodeDisk ( HardForkBlock xs) ( LedgerState ( HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDisk :: CodecConfig ( HardForkBlock xs) -> forall s. Decoder s ( LedgerState ( HardForkBlock xs)) Source #
SerialiseHFC xs => DecodeDisk ( HardForkBlock xs) ( HardForkChainDepState xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDisk :: CodecConfig ( HardForkBlock xs) -> forall s. Decoder s ( HardForkChainDepState xs) Source #
SerialiseHFC xs => DecodeDisk ( HardForkBlock xs) ( AnnTip ( HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDisk :: CodecConfig ( HardForkBlock xs) -> forall s. Decoder s ( AnnTip ( HardForkBlock xs)) Source #
SerialiseHFC xs => DecodeDisk ( HardForkBlock xs) ( ByteString -> HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDisk :: CodecConfig ( HardForkBlock xs) -> forall s. Decoder s ( ByteString -> HardForkBlock xs) Source #

class EncodeDisk blk a where Source #

Encode a type a so that it can be stored on disk.

There is no version negotiation for on disk serialisation. However, instances can still decide to perform versioning internally to maintain compatibility.

Minimal complete definition

Nothing

Methods

encodeDisk :: CodecConfig blk -> a -> Encoding Source #

default encodeDisk :: Serialise a => CodecConfig blk -> a -> Encoding Source #

Instances

Instances details

EncodeDisk blk blk => EncodeDisk blk ( I blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> I blk -> Encoding Source #
EncodeDisk blk ( ChainDepState ( BlockProtocol blk)) => EncodeDisk blk ( WrapChainDepState blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> WrapChainDepState blk -> Encoding Source #
EncodeDiskDepIx ( NestedCtxt Header ) blk => EncodeDisk blk ( SerialisedHeader blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> SerialisedHeader blk -> Encoding Source #
( EncodeDiskDepIx f blk, EncodeDiskDep f blk) => EncodeDisk blk ( DepPair (f blk)) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> DepPair (f blk) -> Encoding Source #
EncodeDiskDepIx f blk => EncodeDisk blk ( GenDepPair Serialised (f blk)) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> GenDepPair Serialised (f blk) -> Encoding Source #
SerialiseHFC xs => EncodeDisk ( HardForkBlock xs) ( LedgerState ( HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods encodeDisk :: CodecConfig ( HardForkBlock xs) -> LedgerState ( HardForkBlock xs) -> Encoding Source #
SerialiseHFC xs => EncodeDisk ( HardForkBlock xs) ( HardForkChainDepState xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods encodeDisk :: CodecConfig ( HardForkBlock xs) -> HardForkChainDepState xs -> Encoding Source #
SerialiseHFC xs => EncodeDisk ( HardForkBlock xs) ( AnnTip ( HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods encodeDisk :: CodecConfig ( HardForkBlock xs) -> AnnTip ( HardForkBlock xs) -> Encoding Source #
SerialiseHFC xs => EncodeDisk ( HardForkBlock xs) ( HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods encodeDisk :: CodecConfig ( HardForkBlock xs) -> HardForkBlock xs -> Encoding Source #

Support for dependent pairs

class DecodeDiskDep f blk where Source #

Decode a dependent value

Typical usage: f = NestedCtxt Header .

Minimal complete definition

Nothing

Methods

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

default decodeDiskDep :: ( TrivialDependency (f blk), DecodeDisk blk ( ByteString -> TrivialIndex (f blk))) => CodecConfig blk -> f blk a -> forall s. Decoder s ( ByteString -> a) Source #

Instances

Instances details

SerialiseHFC xs => DecodeDiskDep ( NestedCtxt Header ) ( HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDiskDep :: CodecConfig ( HardForkBlock xs) -> NestedCtxt Header ( HardForkBlock xs) a -> forall s. Decoder s ( ByteString -> a) Source #

class DecodeDiskDepIx f blk where Source #

Decode dependent index

Minimal complete definition

Nothing

Methods

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

default decodeDiskDepIx :: TrivialDependency (f blk) => CodecConfig blk -> Decoder s ( SomeSecond f blk) Source #

Instances

Instances details

SerialiseHFC xs => DecodeDiskDepIx ( NestedCtxt Header ) ( HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDiskDepIx :: CodecConfig ( HardForkBlock xs) -> Decoder s ( SomeSecond ( NestedCtxt Header ) ( HardForkBlock xs)) Source #

class EncodeDiskDep f blk where Source #

Encode a dependent value

Minimal complete definition

Nothing

Methods

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

default encodeDiskDep :: ( TrivialDependency (f blk), EncodeDisk blk ( TrivialIndex (f blk))) => CodecConfig blk -> f blk a -> a -> Encoding Source #

Instances

Instances details

SerialiseHFC xs => EncodeDiskDep ( NestedCtxt Header ) ( HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods encodeDiskDep :: CodecConfig ( HardForkBlock xs) -> NestedCtxt Header ( HardForkBlock xs) a -> a -> Encoding Source #
EncodeDiskDep ( NestedCtxt Header ) m => EncodeDiskDep ( NestedCtxt Header ) ( DualBlock m a) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods encodeDiskDep :: CodecConfig ( DualBlock m a) -> NestedCtxt Header ( DualBlock m a) a0 -> a0 -> Encoding Source #

class EncodeDiskDepIx f blk where Source #

Encode dependent index

Minimal complete definition

Nothing

Methods

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

default encodeDiskDepIx :: TrivialDependency (f blk) => CodecConfig blk -> SomeSecond f blk -> Encoding Source #

Instances

Instances details

SerialiseHFC xs => EncodeDiskDepIx ( NestedCtxt Header ) ( HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods encodeDiskDepIx :: CodecConfig ( HardForkBlock xs) -> SomeSecond ( NestedCtxt Header ) ( HardForkBlock xs) -> Encoding Source #
EncodeDiskDepIx ( NestedCtxt Header ) m => EncodeDiskDepIx ( NestedCtxt Header ) ( DualBlock m a) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods encodeDiskDepIx :: CodecConfig ( DualBlock m a) -> SomeSecond ( NestedCtxt Header ) ( DualBlock m a) -> Encoding Source #

Serialised header

newtype SerialisedHeader blk Source #

A Serialised header along with context identifying what kind of header it is.

The SerialiseNodeToNodeDep for Header will decide how to actually encode this.

Constructors

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

Instances

Instances details

Isomorphic SerialisedHeader Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary Methods project :: NoHardForks blk => SerialisedHeader ( HardForkBlock '[blk]) -> SerialisedHeader blk Source # inject :: NoHardForks blk => SerialisedHeader blk -> SerialisedHeader ( HardForkBlock '[blk]) Source #
Inject SerialisedHeader Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Nary Methods inject :: forall x (xs :: [ Type ]). CanHardFork xs => Exactly xs Bound -> Index xs x -> SerialisedHeader x -> SerialisedHeader ( HardForkBlock xs) Source #
DecodeDiskDepIx ( NestedCtxt Header ) blk => DecodeDisk blk ( SerialisedHeader blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods decodeDisk :: CodecConfig blk -> forall s. Decoder s ( SerialisedHeader blk) Source #
EncodeDiskDepIx ( NestedCtxt Header ) blk => EncodeDisk blk ( SerialisedHeader blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods encodeDisk :: CodecConfig blk -> SerialisedHeader blk -> Encoding Source #
HasNestedContent Header blk => Show ( SerialisedHeader blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods showsPrec :: Int -> SerialisedHeader blk -> ShowS Source # show :: SerialisedHeader blk -> String Source # showList :: [ SerialisedHeader blk] -> ShowS Source #
StandardHash blk => StandardHash ( SerialisedHeader blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation
ShowProxy blk => ShowProxy ( SerialisedHeader blk :: Type ) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation Methods showProxy :: Proxy ( SerialisedHeader blk) -> String Source #
SerialiseHFC xs => SerialiseNodeToNode ( HardForkBlock xs) ( SerialisedHeader ( HardForkBlock xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode Methods encodeNodeToNode :: CodecConfig ( HardForkBlock xs) -> BlockNodeToNodeVersion ( HardForkBlock xs) -> SerialisedHeader ( HardForkBlock xs) -> Encoding Source # decodeNodeToNode :: CodecConfig ( HardForkBlock xs) -> BlockNodeToNodeVersion ( HardForkBlock xs) -> forall s. Decoder s ( SerialisedHeader ( HardForkBlock xs)) Source #
type HeaderHash ( SerialisedHeader blk) Source #	Only needed for the `ChainSyncServer`
Instance details Defined in Ouroboros.Consensus.Storage.Serialisation type HeaderHash ( SerialisedHeader blk) = HeaderHash blk

castSerialisedHeader :: ( forall a. NestedCtxt_ blk Header a -> NestedCtxt_ blk' Header a) -> SerialisedHeader blk -> SerialisedHeader blk' Source #

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

Inverse to encodeTrivialSerialisedHeader

encodeTrivialSerialisedHeader :: forall blk. TrivialDependency ( NestedCtxt_ blk Header ) => SerialisedHeader blk -> Encoding Source #

Encode the header without the NestedCtxt

Uses CBOR-in-CBOR

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

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

Reconstruct nested type

newtype PrefixLen Source #

Number of bytes from the start of a block needed to reconstruct the nested context.

See reconstructPrefixLen .

Constructors

PrefixLen
Fields getPrefixLen :: Word8

Instances

Instances details

Eq PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods (==) :: PrefixLen -> PrefixLen -> Bool Source # (/=) :: PrefixLen -> PrefixLen -> Bool Source #
Ord PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods compare :: PrefixLen -> PrefixLen -> Ordering Source # (<) :: PrefixLen -> PrefixLen -> Bool Source # (<=) :: PrefixLen -> PrefixLen -> Bool Source # (>) :: PrefixLen -> PrefixLen -> Bool Source # (>=) :: PrefixLen -> PrefixLen -> Bool Source # max :: PrefixLen -> PrefixLen -> PrefixLen Source # min :: PrefixLen -> PrefixLen -> PrefixLen Source #
Show PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods showsPrec :: Int -> PrefixLen -> ShowS Source # show :: PrefixLen -> String Source # showList :: [ PrefixLen ] -> ShowS Source #
Generic PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Associated Types type Rep PrefixLen :: Type -> Type Source # Methods from :: PrefixLen -> Rep PrefixLen x Source # to :: Rep PrefixLen x -> PrefixLen Source #
NoThunks PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods noThunks :: Context -> PrefixLen -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PrefixLen -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy PrefixLen -> String Source #
type Rep PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common type Rep PrefixLen = D1 (' MetaData "PrefixLen" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' True ) ( C1 (' MetaCons "PrefixLen" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getPrefixLen") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word8 )))

class HasNestedContent f blk => ReconstructNestedCtxt f blk where Source #

Minimal complete definition

Nothing

Methods

reconstructPrefixLen :: proxy (f blk) -> PrefixLen Source #

Number of bytes required to reconstruct the nested context.

This will be the minimum length of the ShortByteString passed to reconstructNestedCtxt .

default reconstructPrefixLen :: TrivialDependency ( NestedCtxt_ blk f) => proxy (f blk) -> PrefixLen Source #

reconstructNestedCtxt Source #

Arguments

:: proxy (f blk)
-> ShortByteString	First bytes ( `reconstructPrefixLen` ) of the block
-> SizeInBytes	Block size
-> SomeSecond ( NestedCtxt f) blk

Reconstruct the type of nested contents

TODO: Allow to fail.

default reconstructNestedCtxt :: TrivialDependency ( NestedCtxt_ blk f) => proxy (f blk) -> ShortByteString -> SizeInBytes -> SomeSecond ( NestedCtxt f) blk Source #

Instances

Instances details

SerialiseHFC xs => ReconstructNestedCtxt Header ( HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods reconstructPrefixLen :: proxy ( Header ( HardForkBlock xs)) -> PrefixLen Source # reconstructNestedCtxt :: proxy ( Header ( HardForkBlock xs)) -> ShortByteString -> SizeInBytes -> SomeSecond ( NestedCtxt Header ) ( HardForkBlock xs) Source #
ReconstructNestedCtxt Header m => ReconstructNestedCtxt Header ( DualBlock m a) Source #
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods reconstructPrefixLen :: proxy ( Header ( DualBlock m a)) -> PrefixLen Source # reconstructNestedCtxt :: proxy ( Header ( DualBlock m a)) -> ShortByteString -> SizeInBytes -> SomeSecond ( NestedCtxt Header ) ( DualBlock m a) Source #

addPrefixLen :: Word8 -> PrefixLen -> PrefixLen Source #

takePrefix :: PrefixLen -> ByteString -> ShortByteString Source #

Binary block info

data BinaryBlockInfo Source #

Information about the serialised block.

Constructors

BinaryBlockInfo
Fields headerOffset :: ! Word16 The offset within the serialised block at which the header starts. headerSize :: ! Word16 How many bytes the header is long. Extracting the `headerSize` bytes from serialised block starting from `headerOffset` should yield the header. Before passing the extracted bytes to the decoder for headers, an envelope can be around using `nodeAddHeaderEnvelope` .

Instances

Instances details

Eq BinaryBlockInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods (==) :: BinaryBlockInfo -> BinaryBlockInfo -> Bool Source # (/=) :: BinaryBlockInfo -> BinaryBlockInfo -> Bool Source #
Show BinaryBlockInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods showsPrec :: Int -> BinaryBlockInfo -> ShowS Source # show :: BinaryBlockInfo -> String Source # showList :: [ BinaryBlockInfo ] -> ShowS Source #
Generic BinaryBlockInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Associated Types type Rep BinaryBlockInfo :: Type -> Type Source # Methods from :: BinaryBlockInfo -> Rep BinaryBlockInfo x Source # to :: Rep BinaryBlockInfo x -> BinaryBlockInfo Source #
type Rep BinaryBlockInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common type Rep BinaryBlockInfo = D1 (' MetaData "BinaryBlockInfo" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' False ) ( C1 (' MetaCons "BinaryBlockInfo" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "headerOffset") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word16 ) :*: S1 (' MetaSel (' Just "headerSize") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word16 )))

class HasBinaryBlockInfo blk where Source #

Methods

getBinaryBlockInfo :: blk -> BinaryBlockInfo Source #

Return information about the serialised block, i.e., how to extract the bytes corresponding to the header from the serialised block.

Instances

Instances details

SerialiseHFC xs => HasBinaryBlockInfo ( HardForkBlock xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods getBinaryBlockInfo :: HardForkBlock xs -> BinaryBlockInfo Source #
HasBinaryBlockInfo m => HasBinaryBlockInfo ( DualBlock m a) Source #	The binary info just refers to the main block This is sufficient, because we never need just the header of the auxiliary.
Instance details Defined in Ouroboros.Consensus.Ledger.Dual Methods getBinaryBlockInfo :: DualBlock m a -> BinaryBlockInfo Source #

Re-exported for convenience

type SizeInBytes = Word32 Source #

Exported for the benefit of tests

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

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