Interface SnapshotStorage

Storage contract for snapshot persistence and retrieval.

interface SnapshotStorage {
    close(): Promise<void>;
    isOpen(): boolean;
    load(): Promise<Snapshot | null>;
    open(): Promise<void>;
    readMetadata(): Promise<SnapshotMetaData | null>;
    save(snapshot: Snapshot): Promise<void>;
}

Index

Methods

close isOpen load open readMetadata save

Methods

close

close(): Promise<void>
Closes storage resources.

Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/SnapshotStorage.ts:30

isOpen

isOpen(): boolean
Returns true when storage is open.

Returns boolean
- Defined in packages/raft-core/src/storage/interfaces/SnapshotStorage.ts:32

load

load(): Promise<Snapshot | null>
Loads complete snapshot payload, or null when absent.

Returns Promise<Snapshot | null>
- Defined in packages/raft-core/src/storage/interfaces/SnapshotStorage.ts:41

open

open(): Promise<void>
Opens storage resources.

Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/SnapshotStorage.ts:28

readMetadata

readMetadata(): Promise<SnapshotMetaData | null>
Reads only snapshot metadata, or null when no snapshot exists.

Returns Promise<SnapshotMetaData | null>
- Defined in packages/raft-core/src/storage/interfaces/SnapshotStorage.ts:35

save

save(snapshot: Snapshot): Promise<void>
Saves complete snapshot payload.
Parameters
- snapshot: Snapshot
Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/SnapshotStorage.ts:38