docs/generated/vocabulary.mdgenerated from code
Reference · 15 min read
Constants: format
Vocabulary: Constants in format.
Read as
Source: crates/lvcs-vocab/src/format.rs.
| Name | Value | Meaning |
|---|---|---|
FORMAT_MAGIC | LVCS | The first four bytes of every format header. |
FORMAT_HEADER_BYTES | 8 | Bytes of a format header: the magic, the kind byte, a zero byte, and the big-endian u16 version. |
JOURNAL_FORMAT | 68 | The journal's format version. Version 1 is the first with a header; records follow it, each a 4-byte big-endian length and one canonical CBOR entry. Version 2's entries hold the events of discussion:owner/277 to 279 and the transport's Identified with dialed, which version 1's do not decode as. Version 3's hold the transport's Disconnected with failed and the check streaks' Passed with now_ms, which version 2's do not decode as. Version 4's hold the transport's Start with the wire major in its Config and Identified with sync and agent, which version 3's do not decode as. Version 5's entries are {actor, event, trace, local_ts} ( discussion:owner/286): each machine's generated sml event and the sml logger trace of handling it, with a document's DocFingerprint as its only content check; version 4's snapshots and hand-written event enums do not decode as them. Version 6's may hold the updater actor's entries (the updater row), which version 5's readers do not decode. Version 7's updater entries may hold Locked, and its traces pass through Locking before a download, which version 6's do not decode or replay as. Version 8's imports entries may hold Polled with imported and ImportFailed, which version 7's do not decode as, and their traces pass through restore, which version 7's do not replay as. Version 9's tree entries may hold SaveRefused, and every render's trace passes through Answered, which version 8's do not decode or replay as; setting a version 8 journal aside also drops the disk bases its refused saves left, which a render of a deleted document would have removed the file over. Version 10's traces pass through SaveCurrent (discussion:owner/350), which version 9's do not replay as. Version 11's actor entries may name a string an earlier entry of their segment holds by its hash, in a CBOR tag (discussion:owner/342), which version 10's readers would decode as the string. Version 12's may hold the steps actor's entries (discussion:owner/354), whose events (Queued, Stepped, Cleared) version 11's readers do not decode. Version 13's may hold the run_reads actor's entries ( discussion:owner/357), whose events (ReadsSent, ReadRefused) version 12's readers do not decode. Version 14's tree entries may hold Probed ( discussion:owner/361), which version 13's readers do not decode. Version 15's rpc_session entries may hold HostOff, and the host journal may hold rendezvous entries with Off and host_node entries (discussion:owner/359), which version 14's readers do not decode. Version 16's issues entries hold Saved for every save or edit with a caller, whatever the document (discussion:owner/334), which version 15's do not decode or replay as. Version 17's intake entries may hold TreeFileClosed (discussion:owner/363), which version 16's readers do not decode. Version 18's context changes (discussion:owner/370) version 17's readers do not decode. Version 19's steps entries carry each document's priority in place of requested, which version 18's readers do not decode, and the runner decides an unanswered Prepared before its other guards and counts its tries, which version 18's traces do not replay as. Version 20's entries (discussion:owner/353) version 19's readers do not decode. Version 21's inbox entries may hold an executable_cleared notification (discussion:owner/366), whose kind version 20's readers do not decode. Version 22's channels entries may hold QueriesDue, which version 21's readers do not decode. Version 23's document entries may hold RefusedSave, and its intake entries hold SaveJudged with held and may hold SaveWeighed, and a refused save's trace may pass through weighable and Weighed (discussion:owner/360), which version 22's do not decode or replay as. Version 24's transport entries hold Tick with each sync stream's quiet time, and their traces pass through keep_streams on every tick and stream_replaces on every refused stream (discussion:owner/364), which version 23's do not decode or replay as. Version 25's rpc_session traces refuse an anonymous reader the ops anyone_may doesn't admit (discussion:owner/382), which version 24's traces do not replay as. Version 26's rpc_session entries' Call carries live and write, a lapsed one ends the session, and a device's write op is decided by write (discussion:owner/379), which version 25's readers do not decode or replay as. Version 27's may hold directory entries (discussion:owner/305), whose kind version 26's readers do not decode. Version 28's host entries' Settled carries how the root settled and Ended the join that ended, and its hosted entries' JoinEnded carries the join's shortfall, and its host_node entries' Enable and Disable carry their asker, NotKept and ListenFailed their reason, and Listened is new (owner/7), which version 27's readers do not decode. Version 28's file documents' PathKnown also carries the file's path history, which their fingerprint covers and their sync judges by (discussion:owner/616), which version 27's do not replay as. Version 28's document traces pass an event another kind's machine doesn't take through Foreign and refuse_foreign (discussion:owner/621), and CompactTick through compact (discussion:owner/615), which version 27's do not replay as. Version 29's Check, GossipTaken, Ask, and Rendered gained fields version 28's readers do not decode (session-062e63ba/5). Version 30's peers entries may hold AskAt, and its traces pass through the rows that hold waiting questions, and a control document's write traces answer after they render (answer_issued and its like in place of render_issued; secfix/6), which version 29's do not decode or replay as. Version 31's namespace traces answer a create once its change is stored and pass a failed create's SignFailed through refuse_create (secfix/30), which version 30's do not replay as. Version 32's transport traces pass a failed dial through bootstraps_unanswered and its lifecycle traces a join's tick through join_unanswered, and lifecycle entries may hold JoinUnanswered (launch-qa/8). Its document sync holds a change from a signer the project doesn't name yet, instead of decoding it, so a caps or document machine's state_after where an unnamed signer's forged change used to disconnect its node now keeps that change waiting (launch-qa/12). Its inbox traces hold an Item or Check that comes before its peer's first Local (secfix/8), and its gossip entries may hold HoldDelivery (secfix/7). Version 31's do not decode or replay as either. Version 33's protected entries hold ProtectedOpen, Rendered, Baseline, Followed, and Gate with the file document they are of, may hold Documented, and their traces pass through the rows that replace a path's document (discussion:owner/670), which version 32's do not decode or replay as. Version 34's ProtectedOpen holds the facts of its restore, its entries may hold Verified, and a restore's traces pass through Unverified and the rows that judge those facts (discussion:owner/670), which version 33's do not decode or replay as. Version 35's router entries may hold SetAside and StuckAsked (discussion:owner/671), which version 34's readers do not decode. Version 36's protected entries hold Baseline with moved_in, their persisted approvals always name a document, and their traces pass through the rows that hold a baseline of a replaced or moved-in path (discussion:owner/670), which version 35's do not decode or replay as. Version 37's router entries hold FileAsked with waits (discussion:owner/653), which version 36's do not decode. Version 38's host traces hold a hello and a Register or Configure that waits through the rows that keep it in the context (hold, park_register, park_configure; secfix/25), its host_node entries may hold Switched, and their traces hold the opposite ask for the next switch (secfix/17), its note traces pass through Waited (secfix/12), and its board traces evaluate late_span on a repeated NodeNotification (secfix/12), and its transport steps open a cleared node's stream at once, so their opening differs before the next tick (secfix/19), which version 37's do not decode or replay as. Version 39's inbox entries may hold Resumed, each incarnation's first, and one that resumes is rebuilt from the incarnations before it (discussion:owner/679), and their Gone traces answer the waits running through end_waits (secfix/37), and their text saves may hold the text their tree's disk held that no version holds (held, secfix/43), their traces evaluate edited_from_base before the render (integrity-disk/9), and its tree_file traces move each standing intent through IntentSync where a member's rows took Intended and IntentEnded (integrity-fable/3), and its intake entries may hold SaveDropped, a tree save whose change never became durable (f-perf/3), and its text saves may hold after_landed and pass a save that is exactly an older version through refuse_old_version where it took keep_old_version (discussion:owner/724), which version 38's do not decode or replay as. Version 40's document SignFailed and RetrySigning hold the incarnation of the request they answer (f-perf/2), which version 39's, 0.2.12's, do not decode (session-abaf70f8/2). Version 41's documents judge by verifier rules 3 (lvcs_doc::change::VERIFIER_RULES, discussion:owner/780), which version 40's ledgers, loaded under rules 2, do not replay as; and its caps and namespace documents answer a rest request as every other kind does, resting on the second (owner/790), where 40's kept running. Version 42's permit_holding Took holds held_back, whether the document still holds the node's changes back after that sync; its memory_budget Asked and AskedHeld hold from, the node a charge is for, and its traces may pass through Shared; and its sync DocSettled holds held_back (caps-transport), which version 41's do not decode or replay as (the fntvtx6s canary, mac-daemon-main). Version 43's permit_holding Took holds held_bytes, what the document holds back from the node after that sync, in place of held_back; its permit_holding outputs may resize a charge, and its memory_budget takes Resized (discussion:owner/762 rule 7 as amended, caps-transport), which version 42's do not decode or replay as. Version 44's document events may be TellPaths, the namespace's render at a load, and its router's ListingAsked (tree-render/8), which version 43's do not decode. Version 45's document events may be LedgerWritten, where the document's store durably wrote change records (each change's id with its record's offset), and its document traces pass it through record_written (discussion:owner/792 step 1), which version 44's do not decode or replay as. Version 46's plugin journals may hold an event whose shape a plugin changed: a retry that names the retry it answers (orchestrator/55), which version 45's do not decode. Version 47's document events may be AnswerUnread, an answer whose stored changes the document's executor couldn't read from the ledger file, and its document traces pass it through unanswer (discussion:owner/792 step 3), which version 46's do not decode or replay as. Version 48's plugin_keeper entries may hold Admitted, RestAsked, Busy, and RestGrace, its Exited holds peak_bytes, and its traces pass through Admitting and Resting, every start asking the plugin admitter first; and the host journal may hold plugin_admitter entries (discussion:owner/790 item 3), which version 47's do not decode or replay as. Version 49's document events may be RejudgeChanges, a re-check's chunk of held changes read from the ledger file (its ids and digest, never the bytes), and RejudgeUnread; its document fingerprints cover the re-check read out and the next read's tag; and its traces pass through the re-check's rows (discussion:owner/792 step 4), which version 48's do not decode or replay as. Version 50's protected-path machines take a render's gates of a path as one Gates event, in place of one Gate each (owner/791 (e), tree-render), which version 49's do not decode. Version 51's protected-path Descended may name the sides the document lacks (lacks, owner/791 (d)), which version 50's do not replay as. Version 52's memory_budget keeps its waiting asks in its own queues and leaves them in no sml defer queue: its traces pass through Open alone, with no Shared or Full and no replayed Asked (the kmbrw5za canary hang, caps-transport), which version 51's do not replay as. Version 53's plugin keeper takes Pushed, its Connected names its connection and its Dormant document patterns, and a plugin_holder keeps the pushes it holds (discussion:owner/797), which version 52's do not decode. Version 54's host journal may hold opener entries, the daemon's open turn that one project opening at a time holds, and its rester takes Stopping and drops a closed opening's loads (daemon-memory/7), which version 53's do not decode or replay as. Version 55's plugin_admitter takes Lapsed, answers a command that waited with Waiting and arms ArmLapse in place of refusing it, and fits commands before serve starts and serve starts in order (ruling lnhoqmrf on dormant-proof/2), and charges a first run's estimate only until its first sample, which version 54's do not decode or replay as. Version 56's rester LoadAsked says whether a client's request waits on the load (asked), and such loads wait ahead of background ones (mac-daemon-main/9), which version 55's do not decode or replay as. Version 57's rester takes Promote: a client's request moves a load that waits as a background one ahead (fold-hsm's L1), which version 56's do not decode. Version 58's documents take EvidenceHeld and EvidenceUnread, an equivocation's held change read from the ledger file, and journal their pending pairs in the fingerprint (discussion:owner/792 step 5), which version 57's do not decode or replay as. Version 59's broadcaster Watch names since_ms and the snapshotting machine takes Scoped (owner/795), which version 58's do not decode. Version 60's rester Kept says whether a joined node isn't settled with the document yet (unsettled, request-flood/1), which version 59's do not decode. Version 61's rester admits loads into the room while every loaded document is barred, lifts its bars only past the room or under pressure, and tells Overdraw (owner/776 option C), which version 60's do not replay as. Version 62's rester admits into the room while every loaded document is barred or unsettled with a joined node, and once the room is used asks the oldest unsettled with unsettled_ok, only as many as the waiting loads need (request-flood/1), which version 61's do not replay as. Version 63's actions plugin streaks Loaded names its ended streaks and the shell's time, each stored streak the tells not yet published and its latest failure's tail and tests, and it takes Published (actions-arena/1), which version 62's do not decode. Version 64's rester admits past the room up to the byte budget's pressure while no loaded document would rest (barred, unsettled, or busy), at most LOADS_IN_FLIGHT_MIN past it unloaded at once, asks a load's unknown documents while stalled, and under pressure presses the newest unsettled, LOADS_IN_FLIGHT_MIN out at once, and counts each loaded document in memory's units (its stored bytes at RESIDENT_FACTOR, at least LOADED_DOC_MIN_BYTES) against the resident mark (owner/776 as amended, request-flood/1), which version 63's do not replay as. Version 65's plugin_keeper rouses a serve woken, pushed to, or exiting not cleanly while it settles (Roused), and starts it again at once with no failure counted (actions-arena/2), which version 64's do not replay as. Version 66's plugin_keeper counts as roused only a settling serve's EX_TEMPFAIL exit and a roused one's exit 0 or EX_TEMPFAIL, backing off and counting any other exit of either as a crash, and refuses a roused serve's own second ask, which then serves again (actions-arena/2, fold-hsm's P2 and P3), which version 65's do not replay as. Version 67's plugin_enabler takes Recover, looks with Operation::Recover (its Found holding the install intent), and its Did may hold Done::Compensated (discussion:owner/803), which version 66's do not decode. Version 68's rester LoadAsked says whether a frame's charge rides on the load (charged) and it takes Charged; it admits a client's loads by a byte share, a charged load under the byte budget's pressure, and a document past the room alone (daemon-memory/19), and a local change's disk edit asks its load as a client's (release-qual/9). The tree takes AskedRead, and its FsChanged and DiskEdit say whether a local change raised them (local_change, discussion:owner/818). A document answers a node's unmoved have with a batch once and holds a rest while a resend is undone (r3-actions/14). Version 67's do not decode or replay as these. Also version 68, with no bump (it is unreleased, and both are additive): the router takes RemovedAtAsked, a query that changes no state, so a journal holding none replays as before; and the namespace's PathKnown may name lasts (discussion:owner/790), absent from every entry written before it, which reads as none and steps as it did, and left out of an entry that names none, so such an entry is written as before. Also version 68, with no bump (unreleased): the sync link takes NodesAdmitted, the daemon's count of admitted nodes, which sets its cap on node-started joins (daemon-memory/19). A journal holding none replays as before (the cap stays SYNC_UNSETTLED_MAX); an older binary does not decode a journal that holds one. Also version 68, with no bump (unreleased): a link's writer carries at most its share of SYNC_ANSWERS_DAEMON_MAX_BYTES across the admitted nodes NodesAdmitted counts (r3-memory/12), no new event or field; a journal holding no count replays as before (the share stays the stream's queue and SYNC_BLOCKED_MAX_BYTES). Also version 68, with no bump (unreleased): the transport's RoomAwaited names the room the sync actor's next frame needs (room, r3-memory/12); an entry written before it names none and reads as half the stream's queue, which every one waited for then. Also version 68, with no bump (unreleased): the router takes Relisting, a loading namespace's word that it tells its whole listing, and at the Listed that follows un-names the files the telling left out (r3-join/19). A journal holding none replays as before; an older binary does not decode a journal that holds one. Also version 68, with no bump (unreleased): the router's Stored may name kept, the documents whose ledger keeps a refusal, and a sync link's NodeOpened may name refusing, the ones it leaves out of the heads it sends and matches until the node has their refusals (r3-join/17). Both are left out when empty, so an entry that names none is written as before, and one written before reads as naming none. |
PROJECT_FORMAT | 1 | project.json's format version: a JSON object after the header. |
CAPABILITIES_FORMAT | 1 | capabilities.cbor's format version: one canonical CBOR CapsFile. |
APPROVED_FORMAT | 2 | approved.cbor's, and each approved.d/ file's, format version: a canonical CBOR map from address to its entry, the sorted heads and the address of the file document they are of (discussion:owner/670). Version 1's values are the heads alone; agentflare migrate resolves each against the stored documents and writes the version the signatures support. |
CHECK_STREAKS_FORMAT | 1 | check-streaks.cbor's format version: a CBOR list of stored streaks. |
STALE_SAVES_FORMAT | 1 | stale-saves.json's format version: a JSON object after the header. |
LEDGER_FORMAT | 4 | A .ledger's format version: canonical CBOR records, concatenated, each a signed change, a refused peer, equivocation evidence, or a merged save (discussion:owner/728). Version 1's refusals carry no stamp; lvcs migrate writes each at rules 0 (discussion:owner/671). Version 2 holds no merged saves and reads as it is; agentflare migrate rewrites its header only. Version 4's refusals may name the grants they were judged under (discussion:owner/787); version 3's name none, read as they are, and are lifted once at their first load. |
KEY_FORMAT | 1 | A key file's format version: the 32-byte Ed25519 secret. |
REGISTRY_FORMAT | 1 | The registry's format version: a JSON list of registered projects, each its root, default peer, and transport (discussion:owner/272). |
UPDATE_STATE_FORMAT | 1 | The updater state's format version: a JSON object after the header (the updater row). |
HOST_KEY_FORMAT | 1 | The host key's format version: the 32-byte Ed25519 secret ( discussion:owner/300). |
HOST_CERT_FORMAT | 1 | The host certificate's format version: its PEM text (discussion:owner/300). |
HOST_NODE_FORMAT | 1 | The host node setting's format version: a JSON object (discussion:owner/300). |
LISTING_FORMAT | 1 | The directory listing's format version: a JSON object with description and language (discussion:owner/305). |
LISTED_FORMAT | 1 | The listed state's format version: a JSON boolean (discussion:owner/305). |
ROOT_INDEX_FORMAT | 2 | The root index's format version: a CBOR sequence of each path's entry (discussion:owner/433). Version 2's entries may name a save in flight (discussion:owner/730); a version 1 entry reads as one naming none, so agentflare migrate rewrites its header only. |
SESSION_FORMAT | 1 | A session binding's format version: the peer id in ID_ENCODING (discussion:owner/497). |
PLUGINS_FORMAT | 1 | An installed plugin's format version: one JSON object (discussion:owner/514). |
RETIRED_FORMAT | 1 | The retired writers' format version: a CBOR list of Loro peers (secfix/31). |
DESCENT_FACTS_FORMAT | 1 | A protected path's descent facts' format version: one CBOR map, its document's address and its facts (discussion:owner/791). |
PLUGIN_INTENT_FORMAT | 1 | A plugin install intent's format version: one CBOR map, the install's path, peers, receipt, and what an undo restores (discussion:owner/803). |