Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Storage.ImmutableDB.Impl

8 types
5 values

Packageouroboros-consensus-4.2.1.0
Exports13
LicenceApache-2.0

valuedefaultArgs :: Monad m => Incomplete ImmutableDbArgs m blk

valuedeleteAfter

:: HasCallStack
=> Internal m blk
-> WithOrigin (Tip blk)
-> m ()

valuegetHashForSlot

:: HasCallStack
=> Internal m blk
-> SlotNo
-> m (Maybe (HeaderHash blk))

valueopenDB

:: (IOLike m, GetPrevHash blk, ConvertRawHash blk, ImmutableDbSerialiseConstraints blk, HasCallStack)
=> Complete ImmutableDbArgs m blk
-> m (ImmutableDB m blk)

valueopenDBInternal

:: (IOLike m, GetPrevHash blk, ConvertRawHash blk, ImmutableDbSerialiseConstraints blk, HasCallStack)
=> Complete ImmutableDbArgs m blk
-> m (ImmutableDB m blk, Internal m blk)

datadata ImmutableDbArgs (f :: Type -> Type) (m :: Type -> Type) blk

Constructors

ImmutableDbArgs
- immCacheConfig :: CacheConfig
- immCheckIntegrity :: HKD f (blk -> Bool)
- immChunkInfo :: HKD f ChunkInfo
- immCodecConfig :: HKD f (CodecConfig blk)
- immHasFS :: HKD f (SomeHasFS m)
- immRegistry :: HKD f (ResourceRegistry m)
- immTracer :: Tracer m (TraceEvent blk)
- immValidationPolicy :: ValidationPolicy

type

type ImmutableDbSerialiseConstraints blk = (EncodeDisk blk blk, DecodeDisk blk (ByteString -> Either DecoderError blk), DecodeDiskDep (NestedCtxt Header) blk, ReconstructNestedCtxt Header blk, HasBinaryBlockInfo blk)

datadata Internal (m :: Type -> Type) blk

Constructors

Internal
- deleteAfter_ :: HasCallStack => WithOrigin (Tip blk) -> m ()
- getHashForSlot_ :: HasCallStack => SlotNo -> m (Maybe (HeaderHash blk))

datadata CacheConfig

Constructors

CacheConfig
- pastChunksToCache :: Word32
- expireUnusedAfter :: DiffTime

Instances2Eq, Show

Eq CacheConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Index.Cache
Show CacheConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Index.Cache

datadata ChunkFileError blk

Constructors

ChunkErrRead ReadIncrementalErr
ChunkErrHashMismatch (HeaderHash blk) (ChainHash blk)
ChunkErrCorrupt (Point blk)

Instances2Eq, Show

StandardHash blk => Eq (ChunkFileError blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
StandardHash blk => Show (ChunkFileError blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types

datadata TraceChunkValidation blk validateTo

Constructors

StartedValidatingChunk ChunkNo validateTo
ValidatedChunk ChunkNo validateTo
MissingChunkFile ChunkNo
InvalidChunkFile ChunkNo (ChunkFileError blk)
MissingPrimaryIndex ChunkNo
MissingSecondaryIndex ChunkNo
InvalidPrimaryIndex ChunkNo
InvalidSecondaryIndex ChunkNo
RewritePrimaryIndex ChunkNo
RewriteSecondaryIndex ChunkNo

Instances5Functor, Eq, Show, Generic, Rep

Functor (TraceChunkValidation blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
(StandardHash blk, Eq validateTo) => Eq (TraceChunkValidation blk validateTo)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
(StandardHash blk, Show validateTo) => Show (TraceChunkValidation blk validateTo)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
Generic (TraceChunkValidation blk validateTo)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
type Rep (TraceChunkValidation blk validateTo) = D1 ('MetaData "TraceChunkValidation" "Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (((C1 ('MetaCons "StartedValidatingChunk" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 validateTo)) :+: C1 ('MetaCons "ValidatedChunk" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 validateTo))) :+: (C1 ('MetaCons "MissingChunkFile" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo)) :+: (C1 ('MetaCons "InvalidChunkFile" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ChunkFileError blk))) :+: C1 ('MetaCons "MissingPrimaryIndex" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo))))) :+: ((C1 ('MetaCons "MissingSecondaryIndex" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo)) :+: C1 ('MetaCons "InvalidPrimaryIndex" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo))) :+: (C1 ('MetaCons "InvalidSecondaryIndex" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo)) :+: (C1 ('MetaCons "RewritePrimaryIndex" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo)) :+: C1 ('MetaCons "RewriteSecondaryIndex" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types

datadata TraceEvent blk

Constructors

NoValidLastLocation
ValidatedLastLocation ChunkNo (Tip blk)
ChunkValidationEvent (TraceChunkValidation blk ChunkNo)
ChunkFileDoesntFit (ChainHash blk) (ChainHash blk)
Migrating Text
DeletingAfter (WithOrigin (Tip blk))
DBAlreadyClosed
DBClosed
TraceCacheEvent !TraceCacheEvent

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (TraceEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
StandardHash blk => Show (TraceEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
Generic (TraceEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
type Rep (TraceEvent blk) = D1 ('MetaData "TraceEvent" "Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (((C1 ('MetaCons "NoValidLastLocation" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ValidatedLastLocation" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Tip blk)))) :+: (C1 ('MetaCons "ChunkValidationEvent" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TraceChunkValidation blk ChunkNo))) :+: C1 ('MetaCons "ChunkFileDoesntFit" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ChainHash blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ChainHash blk))))) :+: ((C1 ('MetaCons "Migrating" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "DeletingAfter" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WithOrigin (Tip blk))))) :+: (C1 ('MetaCons "DBAlreadyClosed" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "DBClosed" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TraceCacheEvent" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TraceCacheEvent))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types

datadata ValidationPolicy

ValidateMostRecentChunk ValidateAllChunks

Instances4Eq, Show, Generic, Rep

Eq ValidationPolicyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
Show ValidationPolicyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
Generic ValidationPolicyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types
type Rep ValidationPolicy = D1 ('MetaData "ValidationPolicy" "Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ValidateMostRecentChunk" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ValidateAllChunks" 'PrefixI 'False) U1)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types