| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Ouroboros.Consensus.Storage.Serialisation
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
Synopsis
- class DecodeDisk blk a where
- decodeDisk ∷ CodecConfig blk → ∀ 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 → ∀ 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 {}
- castSerialisedHeader ∷ (∀ a. NestedCtxt_ blk Header a → NestedCtxt_ blk' Header a) → SerialisedHeader blk → SerialisedHeader blk'
- decodeTrivialSerialisedHeader ∷ ∀ blk. TrivialDependency (NestedCtxt_ blk Header) ⇒ ∀ s. Decoder s (SerialisedHeader blk)
- encodeTrivialSerialisedHeader ∷ ∀ 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 {}
- 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 {}
- class HasBinaryBlockInfo blk where
- getBinaryBlockInfo ∷ blk → BinaryBlockInfo
- data SizeInBytes
- 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 → ∀ s. Decoder s a Source #
default decodeDisk ∷ Serialise a ⇒ CodecConfig blk → ∀ s. Decoder s a Source #
Instances
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
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 → ∀ s. Decoder s (ByteString → a) Source #
default decodeDiskDep ∷ (TrivialDependency (f blk), DecodeDisk blk (ByteString → TrivialIndex (f blk))) ⇒ CodecConfig blk → f blk a → ∀ s. Decoder s (ByteString → a) Source #
Instances
| SerialiseHFC xs ⇒ DecodeDiskDep (NestedCtxt Header) (HardForkBlock xs) Source # | |
Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDiskDep ∷ CodecConfig (HardForkBlock xs) → NestedCtxt Header (HardForkBlock xs) a → ∀ 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
| SerialiseHFC xs ⇒ DecodeDiskDepIx (NestedCtxt Header) (HardForkBlock xs) Source # | |
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
| SerialiseHFC xs ⇒ EncodeDiskDep (NestedCtxt Header) (HardForkBlock xs) Source # | |
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 # | |
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
| SerialiseHFC xs ⇒ EncodeDiskDepIx (NestedCtxt Header) (HardForkBlock xs) Source # | |
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 # | |
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 | |
Instances
castSerialisedHeader ∷ (∀ a. NestedCtxt_ blk Header a → NestedCtxt_ blk' Header a) → SerialisedHeader blk → SerialisedHeader blk' Source #
decodeTrivialSerialisedHeader ∷ ∀ blk. TrivialDependency (NestedCtxt_ blk Header) ⇒ ∀ s. Decoder s (SerialisedHeader blk) Source #
Inverse to encodeTrivialSerialisedHeader
encodeTrivialSerialisedHeader ∷ ∀ 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
Number of bytes from the start of a block needed to reconstruct the nested context.
See reconstructPrefixLen.
Constructors
| PrefixLen | |
Fields | |
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 ( |
| → 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
| SerialiseHFC xs ⇒ ReconstructNestedCtxt Header (HardForkBlock xs) Source # | |
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 # | |
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 # | |
Binary block info
data BinaryBlockInfo Source #
Information about the serialised block.
Constructors
| BinaryBlockInfo | |
Fields
| |
Instances
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
| SerialiseHFC xs ⇒ HasBinaryBlockInfo (HardForkBlock xs) Source # | |
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. |
Defined in Ouroboros.Consensus.Ledger.Dual Methods getBinaryBlockInfo ∷ DualBlock m a → BinaryBlockInfo Source # | |
Re-exported for convenience
data SizeInBytes Source #
Instances
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 #