Skip to main content

Module workspace

Module workspace 

Source
Expand description

Pure logic for zenith workspace scratch, zenith workspace candidate, zenith workspace promote, zenith workspace bundle, zenith workspace unbundle, and zenith workspace finalize.

Submodules:

  • scratchzenith workspace scratch new/list/show
  • candidatezenith workspace candidate (set lifecycle status)
  • promotezenith workspace promote (merge a selected candidate into a page)
  • bundlezenith workspace bundle/unbundle
  • finalizezenith workspace finalize (cleanup-policy compaction)

Structs§

ScratchNewOutcome
Outcome of scratch new: the created candidate id plus any non-fatal warning surfaced while transparently attaching a doc-id (e.g. the file was stamped but the initial history version could not be recorded).

Functions§

bundle_doc
Pack the session store for the document at doc_path into out_path.
bundle_doc_in
Testable variant with an explicit store root.
candidate_set_status
Transition cand_id’s lifecycle status to status_str and return a confirmation line.
candidate_set_status_in
Testable variant with an explicit store root.
finalize
Apply each rejected candidate’s cleanup-policy to the scratch store and return a human-readable or JSON report.
finalize_in
Testable variant with an explicit store root.
promote
Promote candidate cand_id from the session store into the page into_page of the deliverable document at doc_path, and write the result back.
promote_in
Testable variant with an explicit store root.
scratch_list
List all scratch candidates for the document at doc_path.
scratch_list_in
Testable variant with an explicit store root.
scratch_new
Record the document bytes as a new scratch candidate.
scratch_new_in
Testable variant with an explicit store root.
scratch_show
Show detail for the candidate with cand_id in the document at doc_path.
scratch_show_in
Testable variant with an explicit store root.
unbundle_doc
Restore a document’s session store from the .zenithbundle at bundle_path.
unbundle_doc_in
Testable variant with an explicit store root.