tony/CHORUS
1
0
Fork 0
Code Issues 10 Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Comprehensive inline rustdoc and architectural summary PDF

Browse Source
This commit is contained in:
anthonyrawlins
2026-03-03 18:05:53 +11:00
parent cc03616918
commit 0f28e4b669
2932 changed files with 14552 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
target/doc/search.desc/chrs_agent/chrs_agent-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_agent", 0, "Represents a running CHORUS agent.\nReturns the argument unchanged.\nInitializes a new <code>CHORUSAgent</code>.\nCalls <code>U::from(self)</code>.\nEntry point for the CHORUS agent binary.\nMain event loop of the agent.")

1
target/doc/search.desc/chrs_bubble/chrs_bubble-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_bubble", 0, "Errors that can arise when working with a <code>ProvenanceGraph</code>.\nThe target node <em>cites</em> the source node.\nThe target node was <em>derived</em> from the source node.\nThe target node was <em>influenced</em> by the source node.\nRepresents the kind of relationship between two provenance …\nCore structure that maintains an in‑memory DAG of …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCreates a new <code>ProvenanceGraph</code> backed by a …\nRecords a directed edge between two existing nodes.\nRecords a provenance node with a unique <code>Uuid</code> and an …")

1
target/doc/search.desc/chrs_graph/chrs_graph-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_graph", 0, "chrs-graph library implementation using Dolt for graph …\nRepresents a failure when executing a Dolt command.\nWrapper around a Dolt repository that stores graph data.\nEnumeration of possible errors that can arise while …\nPropagates I/O errors from the standard library (e.g., …\nA generic catch‑all for errors that don’t fit the …\nPropagates JSON (de)serialization errors from <code>serde_json</code>.\nStage all changes and commit them with the provided <code>message</code>…\nCreate a SQL table within the Dolt repository.\nReturns the argument unchanged.\nReturns the argument unchanged.\nInitialise (or open) a Dolt repository at the given <code>path</code>.\nInsert a node represented by a JSON object into the …\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nFilesystem path to the root of the Dolt repository.")

1
target/doc/search.desc/chrs_mail/chrs_mail-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_mail", 0, "chrs-mail library implementation\nPropagates chrono parsing errors, primarily when …\nPropagates JSON (de)serialization errors from <code>serde_json</code>.\nErrors that can occur while using the <code>Mailbox</code>.\nWrapper around a SQLite connection providing …\nRepresents a mail message stored in the mailbox.\nPropagates any <code>rusqlite::Error</code> encountered while …\nPropagates UUID parsing errors.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nIdentifier of the sending peer.\nGlobally unique identifier for the message.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nMark a message as read by setting its <code>read_at</code> timestamp.\nOpen (or create) a mailbox database at <code>path</code>.\nArbitrary JSON payload containing the message body.\nOptional timestamp (UTC) when the recipient read the …\nRetrieve all unread messages addressed to <code>peer_id</code>.\nStore a new message in the mailbox.\nTimestamp (UTC) when the message was sent.\nIdentifier of the receiving peer.\nTopic or channel of the message; used for routing/filters.")

1
target/doc/search.desc/chrs_poc/chrs_poc-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_poc", 0, "Entry point for the proof‑of‑concept binary.")

1
target/doc/search.desc/chrs_shhh/chrs_shhh-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_shhh", 0, "Represents a single rule used to redact a secret.\nThe main entry point for secret detection and redaction.\nChecks whether any of the configured rules match <code>input</code>.\nReturns the argument unchanged.\nReturns the argument unchanged.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nHuman‑readable name for the rule.\nConstructs a <code>SecretSentinel</code> pre‑populated with a …\nCompiled regular expression that matches the secret.\nText that will replace the matched secret.\nRedacts all secrets found in <code>input</code> according to the …")

1
target/doc/search.desc/chrs_slurp/chrs_slurp-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_slurp", 0, "chrs-slurp\nCore engine that validates and persists <code>DecisionRecord</code>s …\nA record representing a curated decision within the CHORUS …\nErrors that can arise while slurping (curating) a decision …\nIdentifier of the agent or human that authored the …\nSerialized UCXL addresses that serve as citations for the …\nValidates the citations in <code>dr</code> and persists the decision …\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nUnique identifier for the decision.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCreates a new <code>CurationEngine</code> bound to the supplied …\nFree‑form textual reasoning explaining the decision.\nThe moment the decision was created.")

1
target/doc/search.desc/chrs_sync/chrs_sync-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("chrs_sync", 0, "Manages synchronization of a Dolt repository across peers.\nBroadcasts the current repository state to a remote peer.\nReturns the argument unchanged.\nHandles an incoming <code>sync_signal</code> message.\nCalls <code>U::from(self)</code>.\nCreates a new <code>SyncManager</code>.")

1
target/doc/search.desc/ucxl/ucxl-desc-0-.js Normal file
View File

@@ -0,0 +1 @@
searchState.loadedDescShard("ucxl", 0, "UCXL core data structures and utilities.\nFuture (“^^”) – a speculative or planned version of …\nIn‑memory implementation of <code>MetadataStore</code> backed by a …\nTrait defining a simple key‑value metadata store.\nPast (“~~”) – a historical snapshot of a resource.\nPresent (“#”) – the current version of a resource.\nRepresents the temporal axis in a UCXL address.\nRepresents a parsed UCXL address.\nThe identifier of the agent (e.g., a user or system …\nFormats the temporal axis back to its string token.\nSerialises the address back to its canonical string form.\nReturns the argument unchanged.\nReturns the argument unchanged.\nReturns the argument unchanged.\nParses a temporal axis token from its textual …\nParses a full UCXL address string into a <code>UCXLAddress</code> value.\nRetrieves the metadata for <code>path</code> if it exists.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCalls <code>U::from(self)</code>.\nCreates a fresh, empty <code>InMemoryMetadataStore</code>.\nPath to the resource relative to the project root.\nThe project namespace this address belongs to.\nRemoves the metadata entry for <code>path</code>, returning the old …\nOptional role associated with the agent (e.g., “admin”…\nStores <code>metadata</code> for <code>path</code>, overwriting any existing value.\nThe specific task within the project.\nTemporal axis indicating present, past or future.\nUCXL filesystem watcher.\nRepresents a watcher rooted at a specific base path.\nReturns the argument unchanged.\nCalls <code>U::from(self)</code>.\nCreates a new <code>UCXLWatcher</code> for the given path.\nStarts the watch loop, blocking indefinitely while …")