Skip to content

Commit

Permalink
Rerun rustdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
joelparkerhenderson committed Oct 2, 2024
1 parent c8ab5fb commit 3719c04
Show file tree
Hide file tree
Showing 162 changed files with 11,554 additions and 492 deletions.
73 changes: 18 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ For matching:

For infix operators:

* [`assert_infix!(a == b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_infix.html)
* [`assert_infix!(a && b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_infix.html)
* [`assert_infix!(a == b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_infix.html) ([more](https://docs.rs/assertables/8.11.0/assertables/assert_infix))
* [`assert_infix!(a && b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_infix.html) ([more](https://docs.rs/assertables/8.11.0/assertables/assert_infix))

For nearness:

Expand All @@ -81,35 +81,23 @@ For nearness:

For Result Ok/Err:

* [`assert_ok!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok.html)
* [`assert_ok_eq!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok_eq.html)
* [`assert_ok_eq_expr!(a, expr)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok_eq_expr.html)
* [`assert_ok_ne!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok_ne.html)
* [`assert_ok_ne_expr!(a, expr)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok_ne_expr.html)
* [`assert_err!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_err.html)
* [`assert_ok!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok.html) ([eq, ne, etc.](https://docs.rs/assertables/8.11.0/assertables/assert_ok))
* [`assert_err!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_err.html ([eq, ne, etc.](https://docs.rs/assertables/8.11.0/assertables/assert_err))

For Option Some/None:

* [`assert_some!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_some.html)
* [`assert_some_eq!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_some_eq.html)
* [`assert_some_eq_expr!(a, expr)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_some_eq_expr.html)
* [`assert_some_ne!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_some_ne.html)
* [`assert_some_ne_expr!(a, expr)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_some_ne_expr.html)
* [`assert_some!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_some.html) ([eq, ne, etc.](https://docs.rs/assertables/8.11.0/assertables/assert_some))
* [`assert_none!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_none.html)

For Poll Ready/Pending:

* [`assert_ready!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ready.html)
* [`assert_ready_eq!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ready_eq.html)
* [`assert_ready_eq_expr!(a, expr)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ready_eq_expr.html)
* [`assert_ready_ne!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ready_ne.html)
* [`assert_ready_ne_expr!(a, expr)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ready_ne_expr.html)
* [`assert_ready!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ready.html) ([eq, ne, etc.](https://docs.rs/assertables/8.11.0/assertables/assert_ready))
* [`assert_pending!(a)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_pending.html)

For collections such as arrays, vectors, maps, sets:

* [`assert_set_subset!(collection1, collection2)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_set_subset.html)
* [`assert_set_disjoint!(collection1, collection2)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_set_disjoint.html)
* [`assert_bag_eq!(collection1, collection2)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_bag_eq.html) ([more](https://docs.rs/assertables/8.11.0/assertables/assert_bag)).
* [`assert_set_eq!(collection1, collection2)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_set_eq.html) [more](https://docs.rs/assertables/8.11.0/assertables/assert_set).

For file system paths and input/output readers:

Expand Down Expand Up @@ -147,46 +135,21 @@ Modules for external calls:

## Forms

All assertables macros have forms for different outcomes:

### Forms for panic versus error
* [`assert_gt!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_gt.html) // panic during typical test
* [`assert_gt_as_result!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_gt_as_result.html) // return Ok or Err
* [`debug_assert_gt!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.debug_assert_gt.html) // panic when in debug mode

All the assert macros have 3 forms for different purposes:
All assertables macros have forms for an optional message:

* Panic form for typical tests.
* Debug form for debugging runtimes.
* Result form for runtime checks, verifications, validations, etc.
* [`assert_gt!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_gt.html) // automatic error message
* [`assert_gt!(a, b, "your text")`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_gt.html) // custom error message

Examples:

* [`assert_starts_with!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_starts_with.html) // panic!
* [`debug_assert_starts_with!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.debug_assert_starts_with.html) // panic! in debug mode
* [`assert_starts_with_as_result!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_starts_with_as_result.html) // return Ok or Err


### Forms for messages

All the assert macros have 2 forms for messages.
Many assertables macros have forms for comparing left hand side (LHS) and right hand side (RHS) as the same type or as an expression:

* Default message form.
* Custom message form.

Examples:

* [`assert_starts_with!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_starts_with.html)
* [`assert_starts_with!(a, b, "Your custom message here")`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_starts_with.html)


### Forms for other versus expression

Many of the assert macros have 2 forms for comparing left hand side and right hand side.

* Comparing a LHS item to a RHS other of the same type.
* Comparing a LHS item to a RHS expression.

Examples:

* [`assert_io_read_to_string_eq!(reader1, reader2)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_io_read_to_string_eq.html)
* [`assert_io_read_to_string_eq_expr!(reader, expr)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_io_read_to_string_eq_expr.html)
* [`assert_ok_eq!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok_eq.html) // Ok(…) = Ok(…)
* [`assert_ok_eq_expr!(a, b)`](https://docs.rs/assertables/8.11.0/assertables/macro.assert_ok_eq_expr.html) // Ok(…) = expression


## Tracking
Expand Down
14 changes: 14 additions & 0 deletions doc/lib/assert_err/assert_err/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!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="Assert expression is Err(_)."><title>lib::assert_err::assert_err - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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="../../../lib/index.html">lib</a></h2></div><h2 class="location"><a href="#">Module assert_err</a></h2><div class="sidebar-elems"><h2><a href="../index.html">In lib::assert_err</a></h2></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>Module <a href="../../index.html">lib</a>::<wbr><a href="../index.html">assert_err</a>::<wbr><a class="mod" href="#">assert_err</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/lib/assert_err/assert_err.rs.html#1-195">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Assert expression is Err(_).</p>
<p>Pseudocode:<br>
a is Err(_)</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>assertables::<span class="kw-2">*</span>;
<span class="kw">let </span>a: <span class="prelude-ty">Result</span>&lt;(), i8&gt; = <span class="prelude-val">Err</span>(<span class="number">1</span>);
<span class="macro">assert_err!</span>(a);</code></pre></div>
<h2 id="module-macros"><a class="doc-anchor" href="#module-macros">§</a>Module macros</h2>
<ul>
<li><a href="../../macro.assert_err.html" title="macro lib::assert_err"><code>assert_err</code></a></li>
<li><a href="../../macro.assert_err_as_result.html" title="macro lib::assert_err_as_result"><code>assert_err_as_result</code></a></li>
<li><a href="../../macro.debug_assert_err.html" title="macro lib::debug_assert_err"><code>debug_assert_err</code></a></li>
</ul>
</div></details></section></div></main></body></html>
1 change: 1 addition & 0 deletions doc/lib/assert_err/assert_err/sidebar-items.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {};
15 changes: 15 additions & 0 deletions doc/lib/assert_err/assert_err_eq/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!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="Assert two expressions are Err(_) and their values are equal."><title>lib::assert_err::assert_err_eq - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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="../../../lib/index.html">lib</a></h2></div><h2 class="location"><a href="#">Module assert_err_eq</a></h2><div class="sidebar-elems"><h2><a href="../index.html">In lib::assert_err</a></h2></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>Module <a href="../../index.html">lib</a>::<wbr><a href="../index.html">assert_err</a>::<wbr><a class="mod" href="#">assert_err_eq</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/lib/assert_err/assert_err_eq.rs.html#1-257">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Assert two expressions are Err(_) and their values are equal.</p>
<p>Pseudocode:<br>
(a ⇒ Err(a̅) ⇒ a̅) = (b ⇒ Err(b̅) ⇒ b̅)</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>assertables::<span class="kw-2">*</span>;
<span class="kw">let </span>a: <span class="prelude-ty">Result</span>&lt;i8, i8&gt; = <span class="prelude-val">Err</span>(<span class="number">1</span>);
<span class="kw">let </span>b: <span class="prelude-ty">Result</span>&lt;i8, i8&gt; = <span class="prelude-val">Err</span>(<span class="number">1</span>);
<span class="macro">assert_err_eq!</span>(a, b);</code></pre></div>
<h2 id="module-macros"><a class="doc-anchor" href="#module-macros">§</a>Module macros</h2>
<ul>
<li><a href="../../macro.assert_err_eq.html" title="macro lib::assert_err_eq"><code>assert_err_eq</code></a></li>
<li><a href="../../macro.assert_err_eq_as_result.html" title="macro lib::assert_err_eq_as_result"><code>assert_err_eq_as_result</code></a></li>
<li><a href="../../macro.debug_assert_err_eq.html" title="macro lib::debug_assert_err_eq"><code>debug_assert_err_eq</code></a></li>
</ul>
</div></details></section></div></main></body></html>
1 change: 1 addition & 0 deletions doc/lib/assert_err/assert_err_eq/sidebar-items.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {};
15 changes: 15 additions & 0 deletions doc/lib/assert_err/assert_err_eq_expr/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!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="Assert an expression is Err(_) and its value is equal to an expression."><title>lib::assert_err::assert_err_eq_expr - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="lib" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[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="../../../lib/index.html">lib</a></h2></div><h2 class="location"><a href="#">Module assert_err_eq_expr</a></h2><div class="sidebar-elems"><h2><a href="../index.html">In lib::assert_err</a></h2></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>Module <a href="../../index.html">lib</a>::<wbr><a href="../index.html">assert_err</a>::<wbr><a class="mod" href="#">assert_err_eq_expr</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/lib/assert_err/assert_err_eq_expr.rs.html#1-252">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Assert an expression is Err(_) and its value is equal to an expression.</p>
<p>Pseudocode:<br>
(a ⇒ Err(a̅) ⇒ a̅) = b</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>assertables::<span class="kw-2">*</span>;
<span class="kw">let </span>a: <span class="prelude-ty">Result</span>&lt;i8, i8&gt; = <span class="prelude-val">Err</span>(<span class="number">1</span>);
<span class="kw">let </span>b: i8 = <span class="number">1</span>;
<span class="macro">assert_err_eq_expr!</span>(a, b);</code></pre></div>
<h2 id="module-macros"><a class="doc-anchor" href="#module-macros">§</a>Module macros</h2>
<ul>
<li><a href="../../macro.assert_err_eq_expr.html" title="macro lib::assert_err_eq_expr"><code>assert_err_eq_expr</code></a></li>
<li><a href="../../macro.assert_err_eq_expr_as_result.html" title="macro lib::assert_err_eq_expr_as_result"><code>assert_err_eq_expr_as_result</code></a></li>
<li><a href="../../macro.debug_assert_err_eq_expr.html" title="macro lib::debug_assert_err_eq_expr"><code>debug_assert_err_eq_expr</code></a></li>
</ul>
</div></details></section></div></main></body></html>
1 change: 1 addition & 0 deletions doc/lib/assert_err/assert_err_eq_expr/sidebar-items.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {};
Loading

0 comments on commit 3719c04

Please sign in to comment.