bookspec/target/doc/bookspec_runner/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 conformance runner: it drives any `Engine` through the examples and reports, per rule, pass, fail or not claimed (`plan/served.md` 8.2 P13 step 2)."><title>bookspec_runner - 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_runner" 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="../crates.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 crate"><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="#">Crate bookspec_runner</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bookspec_runner/index.html">bookspec_<wbr>runner</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="#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><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>bookspec_<wbr>runner</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_runner/lib.rs.html#1-302">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>bookspec’s conformance runner: it drives any <a href="../bookspec_checker/engine/trait.Engine.html" title="trait bookspec_checker::engine::Engine"><code>Engine</code></a> through the
examples and reports, per rule, pass, fail or not claimed
(<code>plan/served.md</code> 8.2 P13 step 2).</p>
<p>The runner is the only judge. An engine answers; the runner compares the
answer with the example’s expected values, and with the refusal the
example names when the engine refuses. The engine is never asked
whether its own answer is right.</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.ExampleReport.html" title="struct bookspec_runner::ExampleReport">Example<wbr>Report</a></dt><dd>One example’s outcome.</dd><dt><a class="struct" href="struct.Report.html" title="struct bookspec_runner::Report">Report</a></dt><dd>The runner’s report: what it found of each rule, and each example.</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.Outcome.html" title="enum bookspec_runner::Outcome">Outcome</a></dt><dd>What the runner says about one rule.</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.run.html" title="fn bookspec_runner::run">run</a></dt><dd>Run <code>examples</code> against engines made by <code>make</code>, one fresh engine per
example, and report per rule against <code>catalog</code> (normally
<a href="../bookspec_checker/rules/fn.rules.html" title="fn bookspec_checker::rules::rules"><code>bookspec_checker::rules()</code></a>).</dd><dt><a class="fn" href="fn.run_example.html" title="fn bookspec_runner::run_example">run_<wbr>example</a></dt><dd>Run one example against one engine: load the setup, apply every event
(accepted or refused as the example says), check the expectations named
after each event, make the changes named after it, then check the rest.</dd></dl></section></div></main></body></html>