Safe Haskell	None
Language	Haskell2010

Test.Ouroboros.Storage.VolatileDB.Model

Contents

Basic API
Corruptions
Exported for testing purposes

Description

In-memory model implementation of VolatileDB

Synopsis

data DBModel blk = DBModel {
- blocksPerFile ∷ BlocksPerFile
- open ∷ Bool
- fileIndex ∷ Map FileId (BlocksInFile blk)
- codecConfig ∷ CodecConfig blk
}
initDBModel ∷ BlocksPerFile → CodecConfig blk → DBModel blk
closeModel ∷ DBModel blk → DBModel blk
filterByPredecessorModel ∷ GetPrevHash blk ⇒ DBModel blk → Either (VolatileDBError blk) (ChainHash blk → Set (HeaderHash blk))
garbageCollectModel ∷ HasHeader blk ⇒ SlotNo → DBModel blk → Either (VolatileDBError blk) (DBModel blk)
getBlockComponentModel ∷ (HasHeader blk, GetHeader blk, HasBinaryBlockInfo blk, EncodeDisk blk blk, HasNestedContent Header blk) ⇒ BlockComponent blk b → HeaderHash blk → DBModel blk → Either (VolatileDBError blk) (Maybe b)
getBlockInfoModel ∷ (GetPrevHash blk, HasBinaryBlockInfo blk) ⇒ DBModel blk → Either (VolatileDBError blk) (HeaderHash blk → Maybe (BlockInfo blk))
getMaxSlotNoModel ∷ HasHeader blk ⇒ DBModel blk → Either (VolatileDBError blk) MaxSlotNo
isOpenModel ∷ DBModel blk → Bool
putBlockModel ∷ HasHeader blk ⇒ blk → DBModel blk → Either (VolatileDBError blk) (DBModel blk)
reOpenModel ∷ DBModel blk → DBModel blk
runCorruptionsModel ∷ EncodeDisk blk blk ⇒ Corruptions → DBModel blk → DBModel blk
newtype BlocksInFile blk = BlocksInFile {
- getBlocksInFile ∷ [blk]
}
blockHashes ∷ HasHeader blk ⇒ DBModel blk → [HeaderHash blk]
blockIndex ∷ HasHeader blk ⇒ DBModel blk → Map (HeaderHash blk) blk
getCurrentFile ∷ DBModel blk → FsPath
getDBFileIds ∷ DBModel blk → [FileId]
getDBFiles ∷ DBModel blk → [FsPath]

Documentation

data DBModel blk Source #

Constructors

DBModel

Fields

blocksPerFile ∷ BlocksPerFile
How many blocks each file has (should follow the real implementation).
open ∷ Bool
Indicates if the DB is open.
fileIndex ∷ Map FileId (BlocksInFile blk)
What each file contains in the real implementation.
INVARIANT: the map is never empty.
INVARIANT: the BlocksInFile associated with the highest FileId has always fewer than blocksPerFile blocks.
codecConfig ∷ CodecConfig blk

Instances

Instances details

Generic (DBModel blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

Associated Types

type Rep (DBModel blk)

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

type Rep (DBModel blk) = D1 ('MetaData "DBModel" "Test.Ouroboros.Storage.VolatileDB.Model" "ouroboros-consensus-0.26.0.0-inplace-storage-test" 'False) (C1 ('MetaCons "DBModel" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blocksPerFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlocksPerFile) :*: S1 ('MetaSel ('Just "open") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "fileIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map FileId (BlocksInFile blk))) :*: S1 ('MetaSel ('Just "codecConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CodecConfig blk)))))

Methods

from ∷ DBModel blk → Rep (DBModel blk) x #

to ∷ Rep (DBModel blk) x → DBModel blk #

(Show blk, Show (CodecConfig blk)) ⇒ Show (DBModel blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

Methods

showsPrec ∷ Int → DBModel blk → ShowS #

show ∷ DBModel blk → String #

showList ∷ [DBModel blk] → ShowS #

(ToExpr blk, ToExpr (CodecConfig blk)) ⇒ ToExpr (DBModel blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

Methods

toExpr ∷ DBModel blk → Expr Source #

listToExpr ∷ [DBModel blk] → Expr Source #

type Rep (DBModel blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

type Rep (DBModel blk) = D1 ('MetaData "DBModel" "Test.Ouroboros.Storage.VolatileDB.Model" "ouroboros-consensus-0.26.0.0-inplace-storage-test" 'False) (C1 ('MetaCons "DBModel" 'PrefixI 'True) ((S1 ('MetaSel ('Just "blocksPerFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlocksPerFile) :*: S1 ('MetaSel ('Just "open") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "fileIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map FileId (BlocksInFile blk))) :*: S1 ('MetaSel ('Just "codecConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CodecConfig blk)))))

initDBModel ∷ BlocksPerFile → CodecConfig blk → DBModel blk Source #

Basic API

closeModel ∷ DBModel blk → DBModel blk Source #

filterByPredecessorModel ∷ GetPrevHash blk ⇒ DBModel blk → Either (VolatileDBError blk) (ChainHash blk → Set (HeaderHash blk)) Source #

garbageCollectModel ∷ HasHeader blk ⇒ SlotNo → DBModel blk → Either (VolatileDBError blk) (DBModel blk) Source #

getBlockComponentModel ∷ (HasHeader blk, GetHeader blk, HasBinaryBlockInfo blk, EncodeDisk blk blk, HasNestedContent Header blk) ⇒ BlockComponent blk b → HeaderHash blk → DBModel blk → Either (VolatileDBError blk) (Maybe b) Source #

getBlockInfoModel ∷ (GetPrevHash blk, HasBinaryBlockInfo blk) ⇒ DBModel blk → Either (VolatileDBError blk) (HeaderHash blk → Maybe (BlockInfo blk)) Source #

getMaxSlotNoModel ∷ HasHeader blk ⇒ DBModel blk → Either (VolatileDBError blk) MaxSlotNo Source #

isOpenModel ∷ DBModel blk → Bool Source #

putBlockModel ∷ HasHeader blk ⇒ blk → DBModel blk → Either (VolatileDBError blk) (DBModel blk) Source #

reOpenModel ∷ DBModel blk → DBModel blk Source #

Corruptions

runCorruptionsModel ∷ EncodeDisk blk blk ⇒ Corruptions → DBModel blk → DBModel blk Source #

Exported for testing purposes

newtype BlocksInFile blk Source #

The blocks in a file, in the same order as they would be written to the file in the real implementation.

Constructors

BlocksInFile
Fields getBlocksInFile ∷ [blk]

Instances

Instances details

Generic (BlocksInFile blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

Associated Types

type Rep (BlocksInFile blk)
Instance details Defined in Test.Ouroboros.Storage.VolatileDB.Model type Rep (BlocksInFile blk) = D1 ('MetaData "BlocksInFile" "Test.Ouroboros.Storage.VolatileDB.Model" "ouroboros-consensus-0.26.0.0-inplace-storage-test" 'True) (C1 ('MetaCons "BlocksInFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "getBlocksInFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [blk])))

Methods

from ∷ BlocksInFile blk → Rep (BlocksInFile blk) x #

to ∷ Rep (BlocksInFile blk) x → BlocksInFile blk #

Show blk ⇒ Show (BlocksInFile blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

Methods

showsPrec ∷ Int → BlocksInFile blk → ShowS #

show ∷ BlocksInFile blk → String #

showList ∷ [BlocksInFile blk] → ShowS #

ToExpr blk ⇒ ToExpr (BlocksInFile blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

Methods

toExpr ∷ BlocksInFile blk → Expr Source #

listToExpr ∷ [BlocksInFile blk] → Expr Source #

type Rep (BlocksInFile blk) Source #

Instance details

Defined in Test.Ouroboros.Storage.VolatileDB.Model

type Rep (BlocksInFile blk) = D1 ('MetaData "BlocksInFile" "Test.Ouroboros.Storage.VolatileDB.Model" "ouroboros-consensus-0.26.0.0-inplace-storage-test" 'True) (C1 ('MetaCons "BlocksInFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "getBlocksInFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [blk])))

blockHashes ∷ HasHeader blk ⇒ DBModel blk → [HeaderHash blk] Source #

blockIndex ∷ HasHeader blk ⇒ DBModel blk → Map (HeaderHash blk) blk Source #

getCurrentFile ∷ DBModel blk → FsPath Source #

getDBFileIds ∷ DBModel blk → [FileId] Source #

getDBFiles ∷ DBModel blk → [FsPath] Source #