34 lines
6.0 KiB
HTML
34 lines
6.0 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="chrs-slurp"><title>chrs_slurp - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-916cea96.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="chrs_slurp" data-themes="" data-resource-suffix="" data-rustdoc-version="1.87.0 (17067e9ac 2025-05-09)" data-channel="1.87.0" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js" ><script src="../static.files/storage-82c7156e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-fb8c74a8.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../chrs_slurp/index.html">chrs_<wbr>slurp</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#chrs-slurp" title="chrs-slurp">chrs-slurp</a><ul><li><a href="#architectural-rationale" title="Architectural Rationale">Architectural Rationale</a></li></ul></li><li><a href="#public-api" title="Public API">Public API</a></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>chrs_slurp</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/chrs_slurp/lib.rs.html#1-181">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="chrs-slurp"><a class="doc-anchor" href="#chrs-slurp">§</a>chrs-slurp</h2>
|
||
<p><strong>Intelligence Crate</strong> – Provides the <em>curation</em> layer for the CHORUS system.</p>
|
||
<p>The purpose of this crate is to take <strong>Decision Records</strong> generated by autonomous
|
||
agents, validate them, and persist them into the graph database. It isolates the
|
||
validation and storage concerns so that other components (e.g. provenance, security)
|
||
can work with a clean, audited data model.</p>
|
||
<h3 id="architectural-rationale"><a class="doc-anchor" href="#architectural-rationale">§</a>Architectural Rationale</h3>
|
||
<ul>
|
||
<li><strong>Separation of concerns</strong> – Agents produce raw decisions; this crate is the
|
||
single source of truth for how those decisions are stored.</li>
|
||
<li><strong>Auditability</strong> – By persisting to a Dolt‑backed graph each decision is versioned
|
||
and can be replay‑backed, satisfying CHORUS’s requirement for reproducible
|
||
reasoning.</li>
|
||
<li><strong>Extensibility</strong> – The <code>CurationEngine</code> can be extended with additional validation
|
||
steps (e.g. policy checks) without touching the agents themselves.</li>
|
||
</ul>
|
||
<p>The crate depends on:</p>
|
||
<ul>
|
||
<li><code>chrs-graph</code> – a thin wrapper around a Dolt‑backed graph implementation.</li>
|
||
<li><code>ucxl</code> – for addressing external knowledge artefacts.</li>
|
||
<li><code>chrono</code>, <code>serde</code>, <code>uuid</code> – standard utilities for timestamps, (de)serialization
|
||
and unique identifiers.</li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="public-api"><a class="doc-anchor" href="#public-api">§</a>Public API</h2>
|
||
<p>The public surface consists of three items:</p>
|
||
<ul>
|
||
<li><code>DecisionRecord</code> – data structure representing a curated decision.</li>
|
||
<li><code>SlurpError</code> – enumeration of possible errors while curating.</li>
|
||
<li><code>CurationEngine</code> – the engine that validates and persists <code>DecisionRecord</code>s.</li>
|
||
</ul>
|
||
<p>Each item is documented in‑line below.</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CurationEngine.html" title="struct chrs_slurp::CurationEngine">Curation<wbr>Engine</a></dt><dd>Core engine that validates and persists <code>DecisionRecord</code>s into the
|
||
Dolt‑backed graph.</dd><dt><a class="struct" href="struct.DecisionRecord.html" title="struct chrs_slurp::DecisionRecord">Decision<wbr>Record</a></dt><dd>A record representing a curated decision within the CHORUS system.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.SlurpError.html" title="enum chrs_slurp::SlurpError">Slurp<wbr>Error</a></dt><dd>Errors that can arise while slurping (curating) a decision record.</dd></dl></section></div></main></body></html> |