Liking cljdoc? Tell your friends :D

vaelii.impl.types.snapshot

The snapshot sink and source protocols, as a held namespace (vaelii.impl.types.prover states what that means). The three media the engine ships, and writing and reading an index image through them, are vaelii.impl.io.snapshot.

The snapshot sink and source protocols, as a held namespace (`vaelii.impl.types.prover`
states what that means).  The three media the engine ships, and writing and reading an
index image through them, are `vaelii.impl.io.snapshot`.
raw docstring

SnapshotSinkcljprotocol

Where a snapshot's bytes go — a directory, a database, memory. Two ops: stream a named section, and commit the manifest that vouches for the lot.

Where a snapshot's bytes go — a directory, a database, memory.  Two ops: stream a
named section, and commit the manifest that vouches for the lot.

commit!clj

(commit! sink manifest)

Write manifest as the completion marker — last, after every section, so an image with no committed manifest is never offered.

Write `manifest` as the completion marker — **last**, after every section, so an
image with no committed manifest is never offered.

write-section!clj

(write-section! sink name frames)

Write the lazy seq frames to the section named name, one chunk in memory at a time. Returns the number of frames written.

Write the lazy seq `frames` to the section named `name`, one chunk in memory at a
time.  Returns the number of frames written.
sourceraw docstring

SnapshotSourcecljprotocol

Where a snapshot's bytes come from. Two ops mirroring the sink: read the manifest, and stream a named section back.

Where a snapshot's bytes come from.  Two ops mirroring the sink: read the manifest, and
stream a named section back.

read-manifestclj

(read-manifest source)

The committed manifest map, or nil when the image is absent or was never committed.

The committed manifest map, or nil when the image is absent or was never committed.

read-sectionclj

(read-section source name)

A constant-memory lazy seq of the frames in the section named name.

A constant-memory lazy seq of the frames in the section named `name`.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close