Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Storage.ImmutableDB.API

11 types
25 values

Packageouroboros-consensus-4.2.1.0
Exports36
LicenceApache-2.0

valueappendBlock :: HasCallStack => ImmutableDB m blk -> blk -> m ()

valueblockToTip :: GetHeader blk => blk -> Tip blk

valuecloseDB :: HasCallStack => ImmutableDB m blk -> m ()

valuegetBlockAtOrAfterPoint

:: HasCallStack
=> ImmutableDB m blk
-> RealPoint blk
-> m (Either SeekBlockError (RealPoint blk))

valuegetBlockComponent

:: HasCallStack
=> ImmutableDB m blk
-> BlockComponent blk b
-> RealPoint blk
-> m (Either (MissingBlock blk) b)

valuegetKnownBlockComponent

:: (MonadThrow m, HasHeader blk)
=> ImmutableDB m blk
-> BlockComponent blk b
-> RealPoint blk
-> m b

valuegetTip :: HasCallStack => ImmutableDB m blk -> STM m (WithOrigin (Tip blk))

valuegetTipAnchor

:: (MonadSTM m, HasCallStack)
=> ImmutableDB m blk
-> STM m (Anchor blk)

valuegetTipPoint

:: (MonadSTM m, HasCallStack)
=> ImmutableDB m blk
-> STM m (Point blk)

valuegetTipSlot

:: (MonadSTM m, HasCallStack)
=> ImmutableDB m blk
-> STM m (WithOrigin SlotNo)

valuehasBlock

:: (MonadSTM m, HasCallStack)
=> ImmutableDB m blk
-> RealPoint blk
-> m Bool

valueheaderToTip :: GetHeader blk => Header blk -> Tip blk

valueiteratorToList :: (HasCallStack, Monad m) => Iterator m blk b -> m [b]

valuemissingBlockPoint :: MissingBlock blk -> RealPoint blk

valuestream

:: HasCallStack
=> ImmutableDB m blk
-> ResourceRegistry m
-> BlockComponent blk b
-> StreamFrom blk
-> StreamTo blk
-> m (Either (MissingBlock blk) (Iterator m blk b))

valuestreamAfterKnownPoint

:: (MonadSTM m, MonadThrow m, HasHeader blk, HasCallStack)
=> ImmutableDB m blk
-> ResourceRegistry m
-> BlockComponent blk b
-> Point blk
-> m (Iterator m blk b)

valuestreamAfterPoint

:: (MonadSTM m, HasHeader blk, HasCallStack)
=> ImmutableDB m blk
-> ResourceRegistry m
-> BlockComponent blk b
-> Point blk
-> m (Either (MissingBlock blk) (Iterator m blk b))

valuestreamAll

:: (MonadSTM m, MonadThrow m, HasHeader blk, HasCallStack)
=> ImmutableDB m blk
-> ResourceRegistry m
-> BlockComponent blk b
-> m (Iterator m blk b)

valuethrowApiMisuse

:: (MonadThrow m, HasCallStack, StandardHash blk, Typeable blk)
=> ApiMisuse blk
-> m a

valuethrowUnexpectedFailure

:: (StandardHash blk, Typeable blk, MonadThrow m)
=> UnexpectedFailure blk
-> m a

valuetipToAnchor :: WithOrigin (Tip blk) -> Anchor blk

valuetipToPoint :: WithOrigin (Tip blk) -> Point blk

valuetipToRealPoint :: Tip blk -> RealPoint blk

valuetraverseIterator

:: Monad m
=> b -> m b'
-> Iterator m blk b
-> Iterator m blk b'

valuewithDB

:: (HasCallStack, MonadThrow m)
=> m (ImmutableDB m blk)
-> ImmutableDB m blk -> m a
-> m a

datadata ApiMisuse blk

Constructors

AppendBlockNotNewerThanTipError (RealPoint blk) (Point blk)
InvalidIteratorRangeError (StreamFrom blk) (StreamTo blk)
ClosedDBError
OpenDBError

Instances1Show

(StandardHash blk, Typeable blk) => Show (ApiMisuse blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

newtypenewtype CompareTip blk

Constructors

CompareTip
- getCompareTip :: Tip blk

Instances2Eq, Ord

Eq (CompareTip blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Ord (CompareTip blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

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

Constructors

ImmutableDB
- closeDB_ :: HasCallStack => m ()
- getTip_ :: HasCallStack => STM m (WithOrigin (Tip blk))
- getBlockComponent_ :: forall b. HasCallStack => BlockComponent blk b -> RealPoint blk -> m (Either (MissingBlock blk) b)
- appendBlock_ :: HasCallStack => blk -> m ()
- stream_ :: forall b. HasCallStack => ResourceRegistry m -> BlockComponent blk b -> StreamFrom blk -> StreamTo blk -> m (Either (MissingBlock blk) (Iterator m blk b))
- getBlockAtOrAfterPoint_ :: HasCallStack => RealPoint blk -> m (Either SeekBlockError (RealPoint blk))

Instances1NoThunks

NoThunks (ImmutableDB m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

datadata ImmutableDBError blk

Constructors

ApiMisuse (ApiMisuse blk) PrettyCallStack
UnexpectedFailure (UnexpectedFailure blk)

Instances4Show, Generic, Exception, Rep

(StandardHash blk, Typeable blk) => Show (ImmutableDBError blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Generic (ImmutableDBError blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
(StandardHash blk, Typeable blk) => Exception (ImmutableDBError blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
type Rep (ImmutableDBError blk) = D1 ('MetaData "ImmutableDBError" "Ouroboros.Consensus.Storage.ImmutableDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ApiMisuse" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ApiMisuse blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PrettyCallStack)) :+: C1 ('MetaCons "UnexpectedFailure" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UnexpectedFailure blk))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

datadata Iterator (m :: Type -> Type) blk b

Constructors

Iterator
- iteratorNext :: HasCallStack => m (IteratorResult b)
- iteratorHasNext :: HasCallStack => STM m (Maybe (RealPoint blk))
- iteratorClose :: HasCallStack => m ()

Instances2Functor, NoThunks

Functor m => Functor (Iterator m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
NoThunks (Iterator m blk b)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

datadata IteratorResult b

Instances7Functor, Foldable, Traversable, Eq, Show, Generic, …

Functor IteratorResultDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Foldable IteratorResultDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Traversable IteratorResultDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Eq b => Eq (IteratorResult b)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Show b => Show (IteratorResult b)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Generic (IteratorResult b)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
type Rep (IteratorResult b) = D1 ('MetaData "IteratorResult" "Ouroboros.Consensus.Storage.ImmutableDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "IteratorExhausted" 'PrefixI 'False) U1 :+: C1 ('MetaCons "IteratorResult" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 b)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

datadata MissingBlock blk

Constructors

EmptySlot (RealPoint blk) ChunkNo [RelativeSlot] (Maybe (StrictSeq SecondaryOffset))
WrongHash (RealPoint blk) (NonEmpty (HeaderHash blk))
NewerThanTip (RealPoint blk) (Point blk)

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (MissingBlock blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
StandardHash blk => Show (MissingBlock blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Generic (MissingBlock blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
type Rep (MissingBlock blk) = D1 ('MetaData "MissingBlock" "Ouroboros.Consensus.Storage.ImmutableDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "EmptySlot" 'PrefixI 'False) ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkNo)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RelativeSlot]) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (StrictSeq SecondaryOffset))))) :+: (C1 ('MetaCons "WrongHash" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty (HeaderHash blk)))) :+: C1 ('MetaCons "NewerThanTip" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

typetype SecondaryOffset = Word32

datadata SeekBlockError

TargetNewerThanTip TipIsOrigin

Instances2Eq, Show

Eq SeekBlockErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Show SeekBlockErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

datadata Tip blk

Constructors

Tip
- tipSlotNo :: !SlotNo
- tipIsEBB :: !IsEBB
- tipBlockNo :: !BlockNo
- tipHash :: !HeaderHash blk

Instances6Eq, Show, Generic, NFData, NoThunks, Rep

StandardHash blk => Eq (Tip blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
StandardHash blk => Show (Tip blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
Generic (Tip blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
StandardHash blk => NFData (Tip blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
StandardHash blk => NoThunks (Tip blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API
type Rep (Tip blk) = D1 ('MetaData "Tip" "Ouroboros.Consensus.Storage.ImmutableDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "Tip" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tipSlotNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 SlotNo) :*: S1 ('MetaSel ('Just "tipIsEBB") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 IsEBB)) :*: (S1 ('MetaSel ('Just "tipBlockNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 BlockNo) :*: S1 ('MetaSel ('Just "tipHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HeaderHash blk)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API

datadata UnexpectedFailure blk

Constructors

FileSystemError FsError
InvalidFileError FsPath String PrettyCallStack
MissingFileError FsPath PrettyCallStack
ChecksumMismatchError (RealPoint blk) CRC CRC FsPath PrettyCallStack
ParseError FsPath (RealPoint blk) DecoderError
TrailingDataError FsPath (RealPoint blk) ByteString
MissingBlockError (MissingBlock blk)
CorruptBlockError (RealPoint blk)

Instances1Show

(StandardHash blk, Typeable blk) => Show (UnexpectedFailure blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ImmutableDB.API