Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Storage.VolatileDB.Impl.State

10 types
6 values

Packageouroboros-consensus-4.2.1.0
Exports16
LicenceApache-2.0

valueappendOpenState

:: (IOLike m, Typeable blk, StandardHash blk)
=> VolatileDBEnv m blk
-> forall h. Eq h => HasFS m h -> ModifyOpenState m blk h a
-> m a

valuecloseOpenHandles :: HasFS m h -> OpenState blk h -> m ()

valuedbIsOpen :: InternalState blk h -> Bool

valuemkOpenState

:: (HasCallStack, IOLike m, GetPrevHash blk, HasBinaryBlockInfo blk, HasNestedContent Header blk, DecodeDisk blk (ByteString -> Either DecoderError blk))
=> CodecConfig blk
-> HasFS m h
-> blk -> Bool
-> BlockValidationPolicy
-> Tracer m (TraceEvent blk)
-> BlocksPerFile
-> m (OpenState blk h)

valuewithOpenState

:: (IOLike m, StandardHash blk, Typeable blk)
=> VolatileDBEnv m blk
-> forall h. HasFS m h -> OpenState blk h -> m r
-> m r

valuewriteOpenState

:: (IOLike m, Typeable blk, StandardHash blk)
=> VolatileDBEnv m blk
-> forall h. Eq h => HasFS m h -> ModifyOpenState m blk h a
-> m a

datadata InternalState blk h

Constructors

DbClosed
DbOpen !(OpenState blk h)

Instances3Generic, NoThunks, Rep

Generic (InternalState blk h)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.State
(StandardHash blk, Typeable blk) => NoThunks (InternalState blk h)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.State
type Rep (InternalState blk h) = D1 ('MetaData "InternalState" "Ouroboros.Consensus.Storage.VolatileDB.Impl.State" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "DbClosed" 'PrefixI 'False) U1 :+: C1 ('MetaCons "DbOpen" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (OpenState blk h))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.State

typetype ModifyOpenState (m :: Type -> Type) blk h = StateT (OpenState blk h) (WithTempRegistry (OpenState blk h) m)

datadata OpenState blk h

Constructors

OpenState
- currentWriteHandle :: !Handle h
- currentWritePath :: !FsPath
- currentWriteId :: !FileId
- currentWriteOffset :: !Word64
- currentMap :: !Index blk
- currentRevMap :: !ReverseIndex blk
- currentSuccMap :: !SuccessorsIndex blk
- currentMaxSlotNo :: !MaxSlotNo

Instances3Generic, NoThunks, Rep

Generic (OpenState blk h)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.State
(StandardHash blk, Typeable blk) => NoThunks (OpenState blk h)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.State
type Rep (OpenState blk h) = D1 ('MetaData "OpenState" "Ouroboros.Consensus.Storage.VolatileDB.Impl.State" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "OpenState" 'PrefixI 'True) (((S1 ('MetaSel ('Just "currentWriteHandle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Handle h)) :*: S1 ('MetaSel ('Just "currentWritePath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FsPath)) :*: (S1 ('MetaSel ('Just "currentWriteId") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 FileId) :*: S1 ('MetaSel ('Just "currentWriteOffset") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64))) :*: ((S1 ('MetaSel ('Just "currentMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Index blk)) :*: S1 ('MetaSel ('Just "currentRevMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ReverseIndex blk))) :*: (S1 ('MetaSel ('Just "currentSuccMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SuccessorsIndex blk)) :*: S1 ('MetaSel ('Just "currentMaxSlotNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MaxSlotNo)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.State

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

Constructors

forall h. Eq h => VolatileDBEnv
- hasFS :: !HasFS m h
- varInternalState :: !RAWLock m (InternalState blk h)
- maxBlocksPerFile :: !BlocksPerFile
- checkIntegrity :: !blk -> Bool
- codecConfig :: !CodecConfig blk
- tracer :: !Tracer m (TraceEvent blk)

newtypenewtype BlockOffset

Constructors

BlockOffset
- unBlockOffset :: Word64

Instances5Eq, Show, Generic, NoThunks, Rep

Eq BlockOffsetDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
Show BlockOffsetDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
Generic BlockOffsetDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
NoThunks BlockOffsetDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
type Rep BlockOffset = D1 ('MetaData "BlockOffset" "Ouroboros.Consensus.Storage.VolatileDB.Impl.Types" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "BlockOffset" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlockOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types

newtypenewtype BlockSize

Constructors

BlockSize
- unBlockSize :: Word32

Instances5Eq, Show, Generic, NoThunks, Rep

Eq BlockSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
Show BlockSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
Generic BlockSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
NoThunks BlockSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
type Rep BlockSize = D1 ('MetaData "BlockSize" "Ouroboros.Consensus.Storage.VolatileDB.Impl.Types" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "BlockSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlockSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types

typetype FileId = Int

typetype ReverseIndex blk = Map (HeaderHash blk) (InternalBlockInfo blk)

typetype SuccessorsIndex blk = Map (ChainHash blk) (Set (HeaderHash blk))

datadata TraceEvent blk

Constructors

DBAlreadyClosed
BlockAlreadyHere (HeaderHash blk)
Truncate (ParseError blk) FsPath BlockOffset
InvalidFileNames [FsPath]
DBClosed

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (TraceEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
StandardHash blk => Show (TraceEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
Generic (TraceEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types
type Rep (TraceEvent blk) = D1 ('MetaData "TraceEvent" "Ouroboros.Consensus.Storage.VolatileDB.Impl.Types" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) ((C1 ('MetaCons "DBAlreadyClosed" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BlockAlreadyHere" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HeaderHash blk)))) :+: (C1 ('MetaCons "Truncate" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParseError blk)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FsPath) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockOffset))) :+: (C1 ('MetaCons "InvalidFileNames" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FsPath])) :+: C1 ('MetaCons "DBClosed" 'PrefixI 'False) U1)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.VolatileDB.Impl.Types