diesel/master/quickcheck/index.html at gh-pages · ITCSsDeveloper/diesel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
<!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="This crate is a port of Haskell’s QuickCheck."><meta name="keywords" content="rust, rustlang, rust-lang, quickcheck"><title>quickcheck - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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">&#9776;</button><a class="sidebar-logo" href="../quickcheck/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
        </a><h2 class="location"></h2>
    </nav>
    <nav class="sidebar"><a class="sidebar-logo" href="../quickcheck/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
        </a><h2 class="location"><a href="#">Crate quickcheck</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 1.0.3</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../quickcheck/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1">
                                <a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
                        </div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
    <h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">quickcheck</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/quickcheck/lib.rs.html#1-93">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate is a port of
<a href="https://hackage.haskell.org/package/QuickCheck">Haskell’s QuickCheck</a>.</p>
<p>For detailed examples, please see the
<a href="https://github.com/BurntSushi/quickcheck">README</a>.</p>
<h2 id="compatibility"><a href="#compatibility">Compatibility</a></h2>
<p>In general, this crate considers the <code>Arbitrary</code> implementations provided as
implementation details. Strategies may or may not change over time, which may
cause new test failures, presumably due to the discovery of new bugs due to a
new kind of witness being generated. These sorts of changes may happen in
semver compatible releases.</p>
</div></details><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.quickcheck.html" title="quickcheck::quickcheck macro">quickcheck</a></div><div class="item-right docblock-short"><p>A macro for writing quickcheck tests.</p>
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Gen.html" title="quickcheck::Gen struct">Gen</a></div><div class="item-right docblock-short"><p>Gen represents a PRNG.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.QuickCheck.html" title="quickcheck::QuickCheck struct">QuickCheck</a></div><div class="item-right docblock-short"><p>The main QuickCheck type for setting configuration and running QuickCheck.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TestResult.html" title="quickcheck::TestResult struct">TestResult</a></div><div class="item-right docblock-short"><p>Describes the status of a single instance of a test.</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Arbitrary.html" title="quickcheck::Arbitrary trait">Arbitrary</a></div><div class="item-right docblock-short"><p><code>Arbitrary</code> describes types whose values can be randomly generated and
shrunk.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Testable.html" title="quickcheck::Testable trait">Testable</a></div><div class="item-right docblock-short"><p><code>Testable</code> describes types (e.g., a function) whose values can be
tested.</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.empty_shrinker.html" title="quickcheck::empty_shrinker fn">empty_shrinker</a></div><div class="item-right docblock-short"><p>Creates a shrinker with zero elements.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.quickcheck.html" title="quickcheck::quickcheck fn">quickcheck</a></div><div class="item-right docblock-short"><p>Convenience function for running QuickCheck.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.single_shrinker.html" title="quickcheck::single_shrinker fn">single_shrinker</a></div><div class="item-right docblock-short"><p>Creates a shrinker with a single element.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="quickcheck" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (495b21669 2022-07-03)" ></div>
</body></html>