ouroboros-consensus
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo

Description

Information about the files stored by the volatile DB

Intended for qualified import.

Synopsis

opaque

data FileInfo blk Source #

The internal information the VolatileDB keeps for each file.

Instances

Instances details
Generic (FileInfo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo

Associated Types

type Rep (FileInfo blk) 
Instance details

Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo

type Rep (FileInfo blk) = D1 ('MetaData "FileInfo" "Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "FileInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxSlotNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MaxSlotNo) :*: S1 ('MetaSel ('Just "hashes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set (HeaderHash blk)))))

Methods

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

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

StandardHash blk ⇒ Show (FileInfo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo

Methods

showsPrec ∷ Int → FileInfo blk → ShowS #

show ∷ FileInfo blk → String #

showList ∷ [FileInfo blk] → ShowS #

StandardHash blk ⇒ NoThunks (FileInfo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo

Methods

noThunks ∷ Context → FileInfo blk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → FileInfo blk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (FileInfo blk) → String Source #

type Rep (FileInfo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo

type Rep (FileInfo blk) = D1 ('MetaData "FileInfo" "Ouroboros.Consensus.Storage.VolatileDB.Impl.FileInfo" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "FileInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxSlotNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MaxSlotNo) :*: S1 ('MetaSel ('Just "hashes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set (HeaderHash blk)))))

Construction

addBlock ∷ StandardHash blk ⇒ SlotNo → HeaderHash blk → FileInfo blk → FileInfo blk Source #

Adds a block to a FileInfo.

empty ∷ FileInfo blk Source #

fromParsedBlockInfos ∷ StandardHash blk ⇒ [ParsedBlockInfo blk] → FileInfo blk Source #

Construct a FileInfo from the parser result.

Queries

canGC Source #

Arguments

∷ FileInfo blk 
→ SlotNo

The slot which we want to GC

→ Bool 

Checks if this file can be GCed.

hashes ∷ FileInfo blk → Set (HeaderHash blk) Source #

isFull ∷ BlocksPerFile → FileInfo blk → Bool Source #

Has this file reached its maximum size?

maxSlotNo ∷ FileInfo blk → MaxSlotNo Source #

maxSlotNoInFiles ∷ [FileInfo blk] → MaxSlotNo Source #