Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.Common

Contents

Indexing
PrefixLen
BinaryBlockInfo
Iterator bounds
BlockComponent
Re-exports

Synopsis

tipIsGenesis :: WithOrigin r -> Bool
newtype PrefixLen = PrefixLen {
- getPrefixLen :: Word8
}
addPrefixLen :: Word8 -> PrefixLen -> PrefixLen
takePrefix :: PrefixLen -> ByteString -> ShortByteString
data BinaryBlockInfo = BinaryBlockInfo {
- headerOffset :: !Word16
- headerSize :: !Word16
}
extractHeader :: BinaryBlockInfo -> ByteString -> ByteString
data StreamFrom blk
- = StreamFromInclusive !(RealPoint blk)
- | StreamFromExclusive !(Point blk)
newtype StreamTo blk = StreamToInclusive (RealPoint blk)
validBounds :: StandardHash blk => StreamFrom blk -> StreamTo blk -> Bool
data BlockComponent blk a where
- GetVerifiedBlock :: BlockComponent blk blk
- GetBlock :: BlockComponent blk blk
- GetRawBlock :: BlockComponent blk ByteString
- GetHeader :: BlockComponent blk (Header blk)
- GetRawHeader :: BlockComponent blk ByteString
- GetHash :: BlockComponent blk (HeaderHash blk)
- GetSlot :: BlockComponent blk SlotNo
- GetIsEBB :: BlockComponent blk IsEBB
- GetBlockSize :: BlockComponent blk Word32
- GetHeaderSize :: BlockComponent blk Word16
- GetNestedCtxt :: BlockComponent blk (SomeSecond (NestedCtxt Header) blk)
- GetPure :: a -> BlockComponent blk a
- GetApply :: BlockComponent blk (a -> b) -> BlockComponent blk a -> BlockComponent blk b
type SizeInBytes = Word32

Indexing

tipIsGenesis :: WithOrigin r -> Bool Source #

PrefixLen

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 # (/=) :: PrefixLen -> PrefixLen -> Bool #
Ord PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods compare :: PrefixLen -> PrefixLen -> Ordering # (<) :: PrefixLen -> PrefixLen -> Bool # (<=) :: PrefixLen -> PrefixLen -> Bool # (>) :: PrefixLen -> PrefixLen -> Bool # (>=) :: PrefixLen -> PrefixLen -> Bool # max :: PrefixLen -> PrefixLen -> PrefixLen # min :: PrefixLen -> PrefixLen -> PrefixLen #
Show PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods showsPrec :: Int -> PrefixLen -> ShowS # show :: PrefixLen -> String # showList :: [PrefixLen] -> ShowS #
Generic PrefixLen Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Associated Types type Rep PrefixLen :: Type -> Type # Methods from :: PrefixLen -> Rep PrefixLen x # to :: Rep PrefixLen x -> PrefixLen #
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.0-GfJNvFcM6lj2s5utKAUPEp" 'True) (C1 ('MetaCons "PrefixLen" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPrefixLen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

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

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

BinaryBlockInfo

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 # (/=) :: BinaryBlockInfo -> BinaryBlockInfo -> Bool #
Show BinaryBlockInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods showsPrec :: Int -> BinaryBlockInfo -> ShowS # show :: BinaryBlockInfo -> String # showList :: [BinaryBlockInfo] -> ShowS #
Generic BinaryBlockInfo Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Associated Types type Rep BinaryBlockInfo :: Type -> Type # Methods from :: BinaryBlockInfo -> Rep BinaryBlockInfo x # to :: Rep BinaryBlockInfo x -> BinaryBlockInfo #
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.0-GfJNvFcM6lj2s5utKAUPEp" 'False) (C1 ('MetaCons "BinaryBlockInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerOffset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16) :*: S1 ('MetaSel ('Just "headerSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16)))

extractHeader :: BinaryBlockInfo -> ByteString -> ByteString Source #

Extract the header from the given ByteString using the BinaryBlockInfo.

Iterator bounds

data StreamFrom blk Source #

The lower bound for an iterator

Hint: use StreamFromExclusive genesisPoint to start streaming from Genesis.

Constructors

StreamFromInclusive !(RealPoint blk)
StreamFromExclusive !(Point blk)

Instances

Instances details

StandardHash blk => Eq (StreamFrom blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods (==) :: StreamFrom blk -> StreamFrom blk -> Bool # (/=) :: StreamFrom blk -> StreamFrom blk -> Bool #
StandardHash blk => Show (StreamFrom blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods showsPrec :: Int -> StreamFrom blk -> ShowS # show :: StreamFrom blk -> String # showList :: [StreamFrom blk] -> ShowS #
Generic (StreamFrom blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Associated Types type Rep (StreamFrom blk) :: Type -> Type # Methods from :: StreamFrom blk -> Rep (StreamFrom blk) x # to :: Rep (StreamFrom blk) x -> StreamFrom blk #
(StandardHash blk, Typeable blk) => NoThunks (StreamFrom blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods noThunks :: Context -> StreamFrom blk -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> StreamFrom blk -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (StreamFrom blk) -> String Source #
type Rep (StreamFrom blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common type Rep (StreamFrom blk) = D1 ('MetaData "StreamFrom" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'False) (C1 ('MetaCons "StreamFromInclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "StreamFromExclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Point blk))))

newtype StreamTo blk Source #

Constructors

StreamToInclusive (RealPoint blk)

Instances

Instances details

StandardHash blk => Eq (StreamTo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods (==) :: StreamTo blk -> StreamTo blk -> Bool # (/=) :: StreamTo blk -> StreamTo blk -> Bool #
StandardHash blk => Show (StreamTo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods showsPrec :: Int -> StreamTo blk -> ShowS # show :: StreamTo blk -> String # showList :: [StreamTo blk] -> ShowS #
Generic (StreamTo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Associated Types type Rep (StreamTo blk) :: Type -> Type # Methods from :: StreamTo blk -> Rep (StreamTo blk) x # to :: Rep (StreamTo blk) x -> StreamTo blk #
(StandardHash blk, Typeable blk) => NoThunks (StreamTo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods noThunks :: Context -> StreamTo blk -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> StreamTo blk -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (StreamTo blk) -> String Source #
type Rep (StreamTo blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common type Rep (StreamTo blk) = D1 ('MetaData "StreamTo" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'True) (C1 ('MetaCons "StreamToInclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))))

validBounds :: StandardHash blk => StreamFrom blk -> StreamTo blk -> Bool Source #

Check whether the bounds make sense

An example of bounds that don't make sense:

StreamFromExclusive (BlockPoint 3 ..)
StreamToInclusive   (RealPoint  3 ..)

This function does not check whether the bounds correspond to existing blocks.

BlockComponent

data BlockComponent blk a where Source #

Which component of the block to read from a database: the whole block, its header, its hash, the block size, ..., or combinations thereof.

NOTE: when requesting multiple components, we will not optimise/cache them.

Constructors

GetVerifiedBlock :: BlockComponent blk blk	Verify the integrity of the block by checking its signature and/or hashes. The interpreter should throw an exception when the block does not pass the check.
GetBlock :: BlockComponent blk blk
GetRawBlock :: BlockComponent blk ByteString
GetHeader :: BlockComponent blk (Header blk)
GetRawHeader :: BlockComponent blk ByteString
GetHash :: BlockComponent blk (HeaderHash blk)
GetSlot :: BlockComponent blk SlotNo
GetIsEBB :: BlockComponent blk IsEBB
GetBlockSize :: BlockComponent blk Word32
GetHeaderSize :: BlockComponent blk Word16
GetNestedCtxt :: BlockComponent blk (SomeSecond (NestedCtxt Header) blk)
GetPure :: a -> BlockComponent blk a
GetApply :: BlockComponent blk (a -> b) -> BlockComponent blk a -> BlockComponent blk b

Instances

Instances details

Functor (BlockComponent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods fmap :: (a -> b) -> BlockComponent blk a -> BlockComponent blk b # (<$) :: a -> BlockComponent blk b -> BlockComponent blk a #
Applicative (BlockComponent blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.Common Methods pure :: a -> BlockComponent blk a # (<>) :: BlockComponent blk (a -> b) -> BlockComponent blk a -> BlockComponent blk b # liftA2 :: (a -> b -> c) -> BlockComponent blk a -> BlockComponent blk b -> BlockComponent blk c # (>) :: BlockComponent blk a -> BlockComponent blk b -> BlockComponent blk b # (<*) :: BlockComponent blk a -> BlockComponent blk b -> BlockComponent blk a #

Re-exports

type SizeInBytes = Word32 #