Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

Synopsis

class NoThunks (Resources m backend) ⇒ Backend (m ∷ Type → Type) backend blk where
- data Args (m ∷ Type → Type) backend
- data Resources (m ∷ Type → Type) backend
- data Trace (m ∷ Type → Type) backend
- mkResources ∷ Proxy blk → Tracer m LedgerDBV2Trace → Args m backend → ResourceRegistry m → SomeHasFS m → m (Resources m backend)
- releaseResources ∷ Proxy blk → Resources m backend → m ()
- newHandleFromValues ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → Resources m backend → ExtLedgerState blk ValuesMK → m (LedgerTablesHandle m (ExtLedgerState blk))
- newHandleFromSnapshot ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → CodecConfig blk → SomeHasFS m → Resources m backend → DiskSnapshot → ExceptT (SnapshotFailure blk) m (LedgerSeq' m blk, RealPoint blk)
- snapshotManager ∷ Proxy blk → Resources m backend → CodecConfig blk → Tracer m (TraceSnapshotEvent blk) → SomeHasFS m → SnapshotManager m m blk (StateRef m (ExtLedgerState blk))
data family Args (m ∷ Type → Type) backend
data Mem
data family YieldArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type)
data family SinkArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type)
mkInMemoryArgs ∷ ∀ (m ∷ Type → Type) blk a. (IOLike m, LedgerDbSerialiseConstraints blk, LedgerSupportsProtocol blk, LedgerSupportsInMemoryLedgerDB (LedgerState blk)) ⇒ a → (LedgerDbBackendArgs m blk, a)

Documentation

class NoThunks (Resources m backend) ⇒ Backend (m ∷ Type → Type) backend blk where Source #

Operations needed to open and operate a LedgerDB V2

Associated Types

data Args (m ∷ Type → Type) backend Source #

The Arguments that will be used initially to create the Resources.

data Resources (m ∷ Type → Type) backend Source #

The Resources that will be stored in the LedgerDB environment and given to the handle operations.

data Trace (m ∷ Type → Type) backend Source #

A trace dependent on the particular backend.

Methods

mkResources ∷ Proxy blk → Tracer m LedgerDBV2Trace → Args m backend → ResourceRegistry m → SomeHasFS m → m (Resources m backend) Source #

Transform Args into Resources, with some context made up of LedgerDbArgs.

releaseResources ∷ Proxy blk → Resources m backend → m () Source #

Release the acquired resources.

newHandleFromValues ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → Resources m backend → ExtLedgerState blk ValuesMK → m (LedgerTablesHandle m (ExtLedgerState blk)) Source #

Create a new handle from the given values. This will only be called when starting Consensus from Genesis.

newHandleFromSnapshot ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → CodecConfig blk → SomeHasFS m → Resources m backend → DiskSnapshot → ExceptT (SnapshotFailure blk) m (LedgerSeq' m blk, RealPoint blk) Source #

Create a new handle from a snapshot.

snapshotManager ∷ Proxy blk → Resources m backend → CodecConfig blk → Tracer m (TraceSnapshotEvent blk) → SomeHasFS m → SnapshotManager m m blk (StateRef m (ExtLedgerState blk)) Source #

Instantiate the SnapshotManager for this backend.

Instances

Instances details

(IOLike m, LedgerDbSerialiseConstraints blk, LedgerSupportsProtocol blk, LedgerSupportsInMemoryLedgerDB (LedgerState blk)) ⇒ Backend m Mem blk Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

Associated Types

data Args m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data Args m Mem = InMemArgs
newtype Resources m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory newtype Resources m Mem = Resources (SomeHasFS m)
newtype Trace m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory newtype Trace m Mem = NoTrace Void

Methods

mkResources ∷ Proxy blk → Tracer m LedgerDBV2Trace → Args m Mem → ResourceRegistry m → SomeHasFS m → m (Resources m Mem) Source #

releaseResources ∷ Proxy blk → Resources m Mem → m () Source #

newHandleFromValues ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → Resources m Mem → ExtLedgerState blk ValuesMK → m (LedgerTablesHandle m (ExtLedgerState blk)) Source #

newHandleFromSnapshot ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → CodecConfig blk → SomeHasFS m → Resources m Mem → DiskSnapshot → ExceptT (SnapshotFailure blk) m (LedgerSeq' m blk, RealPoint blk) Source #

snapshotManager ∷ Proxy blk → Resources m Mem → CodecConfig blk → Tracer m (TraceSnapshotEvent blk) → SomeHasFS m → SnapshotManager m m blk (StateRef m (ExtLedgerState blk)) Source #

data family Args (m ∷ Type → Type) backend Source #

The Arguments that will be used initially to create the Resources.

Instances

Instances details

data Args m Mem Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data Args m Mem = InMemArgs

data Mem Source #

Instances

Instances details

IOLike m ⇒ StreamingBackend m Mem l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

Associated Types

data YieldArgs m Mem l
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data YieldArgs m Mem l = YieldInMemory (MountPoint → SomeHasFS m) FilePath (Decoders l)
data SinkArgs m Mem l
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data SinkArgs m Mem l = SinkInMemory Int (TxIn l → Encoding) (TxOut l → Encoding) (SomeHasFS m) FilePath

Methods

yield ∷ Proxy Mem → YieldArgs m Mem l → Yield m l Source #

sink ∷ Proxy Mem → SinkArgs m Mem l → Sink m l Source #

(IOLike m, LedgerDbSerialiseConstraints blk, LedgerSupportsProtocol blk, LedgerSupportsInMemoryLedgerDB (LedgerState blk)) ⇒ Backend m Mem blk Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

Associated Types

data Args m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data Args m Mem = InMemArgs
newtype Resources m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory newtype Resources m Mem = Resources (SomeHasFS m)
newtype Trace m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory newtype Trace m Mem = NoTrace Void

Methods

mkResources ∷ Proxy blk → Tracer m LedgerDBV2Trace → Args m Mem → ResourceRegistry m → SomeHasFS m → m (Resources m Mem) Source #

releaseResources ∷ Proxy blk → Resources m Mem → m () Source #

newHandleFromValues ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → Resources m Mem → ExtLedgerState blk ValuesMK → m (LedgerTablesHandle m (ExtLedgerState blk)) Source #

newHandleFromSnapshot ∷ Tracer m LedgerDBV2Trace → ResourceRegistry m → CodecConfig blk → SomeHasFS m → Resources m Mem → DiskSnapshot → ExceptT (SnapshotFailure blk) m (LedgerSeq' m blk, RealPoint blk) Source #

snapshotManager ∷ Proxy blk → Resources m Mem → CodecConfig blk → Tracer m (TraceSnapshotEvent blk) → SomeHasFS m → SnapshotManager m m blk (StateRef m (ExtLedgerState blk)) Source #

Show (Trace m Mem) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

Methods

showsPrec ∷ Int → Trace m Mem → ShowS #

show ∷ Trace m Mem → String #

showList ∷ [Trace m Mem] → ShowS #

NoThunks (Resources m Mem) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

Methods

noThunks ∷ Context → Resources m Mem → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Resources m Mem → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Resources m Mem) → String Source #

data SinkArgs m Mem l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

data SinkArgs m Mem l = SinkInMemory Int (TxIn l → Encoding) (TxOut l → Encoding) (SomeHasFS m) FilePath

data YieldArgs m Mem l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

data YieldArgs m Mem l = YieldInMemory (MountPoint → SomeHasFS m) FilePath (Decoders l)

data Args m Mem Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

data Args m Mem = InMemArgs

newtype Resources m Mem Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

newtype Resources m Mem = Resources (SomeHasFS m)

newtype Trace m Mem Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

newtype Trace m Mem = NoTrace Void

data family YieldArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type) Source #

Instances

Instances details

data YieldArgs m Mem l Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data YieldArgs m Mem l = YieldInMemory (MountPoint → SomeHasFS m) FilePath (Decoders l)

data family SinkArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type) Source #

Instances

Instances details

data SinkArgs m Mem l Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data SinkArgs m Mem l = SinkInMemory Int (TxIn l → Encoding) (TxOut l → Encoding) (SomeHasFS m) FilePath

mkInMemoryArgs ∷ ∀ (m ∷ Type → Type) blk a. (IOLike m, LedgerDbSerialiseConstraints blk, LedgerSupportsProtocol blk, LedgerSupportsInMemoryLedgerDB (LedgerState blk)) ⇒ a → (LedgerDbBackendArgs m blk, a) Source #

Create arguments for initializing the LedgerDB using the InMemory backend.