bookspec/target/doc/bookspec_checker/rules/index.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="bookspec’s rule identifiers and their catalogue."><title>bookspec_checker::rules - 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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-0c87338a.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bookspec_checker" data-themes="" data-resource-suffix="" data-rustdoc-version="1.99.1 (58cf8f9c3 2026-10-13)" data-channel="1.99.1" data-search-js="search-cf4fc35e.js" data-stringdex-js="stringdex-b5109af9.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-9f56287d.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module rules</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bookspec_checker/index.html">bookspec_<wbr>checker</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module rules</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bookspec_<wbr>checker</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">bookspec_checker</a></div><h1>Module <span>rules</span>&nbsp;<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/bookspec_checker/rules.rs.html#1-594">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>bookspec’s rule identifiers and their catalogue.</p>
<p>Every rule of <code>docs/spec/rules.md</code> (B-1 to B-45) has one bookspec
identifier, <code>BS-&lt;area&gt;-&lt;n&gt;</code>, allocated by <a href="enum.Area.html" title="enum bookspec_checker::rules::Area"><code>Area</code></a> and numbered in
B-rule order within its area. <code>bookspec/spec/rules-index.md</code> is the
table, and a test keeps the two in step. The rules from B-39 on are
allocated in <code>plan/served.md</code> 8.0.3 but not yet stated; they carry an
identifier and an area and no status, so a later unit fills them in
without moving anyone else’s number.</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.Rule.html" title="struct bookspec_checker::rules::Rule">Rule</a></dt><dd>One rule of the specification.</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.Area.html" title="enum bookspec_checker::rules::Area">Area</a></dt><dd>One of bookspec’s areas: the subject a rule belongs to.</dd><dt><a class="enum" href="enum.Status.html" title="enum bookspec_checker::rules::Status">Status</a></dt><dd>The status of a rule, in bookspec’s vocabulary: what its statement
rests on. <code>docs/spec/rules.md</code>’s “DECISION” is bookspec’s <a href="enum.Status.html#variant.Choice" title="variant bookspec_checker::rules::Status::Choice"><code>Status::Choice</code></a>
(<code>plan/served.md</code> P13 step 3): the specification names the options, and
an engine declares its pick through <a href="../engine/struct.Claims.html" title="struct bookspec_checker::engine::Claims"><code>crate::Claims</code></a>.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.covered_rules.html" title="fn bookspec_checker::rules::covered_rules">covered_<wbr>rules</a></dt><dd>The rules an engine can claim today: those with at least one example.
A rule with no example has no evidence, so an engine cannot claim it
(<code>plan/served.md</code> P13 step 4 fills the rest in).</dd><dt><a class="fn" href="fn.rule.html" title="fn bookspec_checker::rules::rule">rule</a></dt><dd>The rule <code>b</code> (1 to 45).</dd><dt><a class="fn" href="fn.rule_for_id.html" title="fn bookspec_checker::rules::rule_for_id">rule_<wbr>for_<wbr>id</a></dt><dd>The rule <code>id</code> names, if the specification states it.</dd><dt><a class="fn" href="fn.rule_for_refusal.html" title="fn bookspec_checker::rules::rule_for_refusal">rule_<wbr>for_<wbr>refusal</a></dt><dd>The rule a refusal belongs to, by its reason in the examples’ words
(bookspec/README.md).</dd><dt><a class="fn" href="fn.rules.html" title="fn bookspec_checker::rules::rules">rules</a></dt><dd>The catalogue: every rule, in B-rule order.</dd></dl></section></div></main></body></html>