<!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="API documentation for the Rust `test` crate."><meta name="keywords" content="rust, rustlang, rust-lang, test"><title>test - Rust</title><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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../test/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a><p class='location'>Crate test</p><div class='block version'><p>Version 1.28.0</p></div>
<a id='all-types' href='all.html'><p>See all test's items</p></a><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'test', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>test</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></span><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/test/lib.rs.html#11-2121' title='goto source code'>[src]</a></span></h1><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>test</code>)</div></div><div class='docblock'><p>Support code for rustc's built in unit-test and micro-benchmarking
framework.</p>
<p>Almost all user code will only be interested in <code>Bencher</code> and
<code>black_box</code>. All other interactions (such as writing tests and
benchmarks themselves) should be done via the <code>#[test]</code> and
<code>#[bench]</code> attributes.</p>
<p>See the <a href="../book/first-edition/testing.html">Testing Chapter</a> of the book for more details.</p>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use self::<a class="enum" href="../test/enum.TestFn.html" title="enum test::TestFn">TestFn</a>::*;</code></td></tr><tr><td><code>pub use self::<a class="enum" href="../test/enum.ColorConfig.html" title="enum test::ColorConfig">ColorConfig</a>::*;</code></td></tr><tr><td><code>pub use self::<a class="enum" href="../test/enum.TestResult.html" title="enum test::TestResult">TestResult</a>::*;</code></td></tr><tr><td><code>pub use self::<a class="enum" href="../test/enum.TestName.html" title="enum test::TestName">TestName</a>::*;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class='unstable module-item'>
<td><a class="mod" href="bench/index.html"
title='mod test::bench'>bench</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="mod" href="stats/index.html"
title='mod test::stats'>stats</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="mod" href="test/index.html"
title='mod test::test'>test</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.BenchSamples.html"
title='struct test::BenchSamples'>BenchSamples</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.Bencher.html"
title='struct test::Bencher'>Bencher</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>Manager of the benchmarking runs.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.Metric.html"
title='struct test::Metric'>Metric</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.MetricMap.html"
title='struct test::MetricMap'>MetricMap</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.Options.html"
title='struct test::Options'>Options</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>In case we want to add other options as well, just add them in this struct.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.TestDesc.html"
title='struct test::TestDesc'>TestDesc</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.TestDescAndFn.html"
title='struct test::TestDescAndFn'>TestDescAndFn</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="struct" href="struct.TestOpts.html"
title='struct test::TestOpts'>TestOpts</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.BenchMode.html"
title='enum test::BenchMode'>BenchMode</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.ColorConfig.html"
title='enum test::ColorConfig'>ColorConfig</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.NamePadding.html"
title='enum test::NamePadding'>NamePadding</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.OutputFormat.html"
title='enum test::OutputFormat'>OutputFormat</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.ShouldPanic.html"
title='enum test::ShouldPanic'>ShouldPanic</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.TestEvent.html"
title='enum test::TestEvent'>TestEvent</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.TestFn.html"
title='enum test::TestFn'>TestFn</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.TestName.html"
title='enum test::TestName'>TestName</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="enum" href="enum.TestResult.html"
title='enum test::TestResult'>TestResult</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class='unstable module-item'>
<td><a class="trait" href="trait.TDynBenchFn.html"
title='trait test::TDynBenchFn'>TDynBenchFn</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>Represents a benchmark function.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.assert_test_result.html"
title='fn test::assert_test_result'>assert_test_result</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>Invoked when unit tests terminate. Should panic if the unit
test is considered a failure. By default, invokes <code>report()</code>
and checks for a <code>0</code> result.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.black_box.html"
title='fn test::black_box'>black_box</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>A function that is opaque to the optimizer, to allow benchmarks to
pretend to use outputs to assist in avoiding dead-code
elimination.</p>
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.convert_benchmarks_to_tests.html"
title='fn test::convert_benchmarks_to_tests'>convert_benchmarks_to_tests</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.filter_tests.html"
title='fn test::filter_tests'>filter_tests</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.fmt_bench_samples.html"
title='fn test::fmt_bench_samples'>fmt_bench_samples</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.iter.html"
title='fn test::iter'>iter</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.list_tests_console.html"
title='fn test::list_tests_console'>list_tests_console</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.parse_opts.html"
title='fn test::parse_opts'>parse_opts</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.run_test.html"
title='fn test::run_test'>run_test</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.run_tests.html"
title='fn test::run_tests'>run_tests</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.run_tests_console.html"
title='fn test::run_tests_console'>run_tests_console</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.test_main.html"
title='fn test::test_main'>test_main</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="fn" href="fn.test_main_static.html"
title='fn test::test_main_static'>test_main_static</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class='unstable module-item'>
<td><a class="type" href="type.MonitorMsg.html"
title='type test::MonitorMsg'>MonitorMsg</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>]
</td>
</tr>
<tr class='unstable module-item'>
<td><a class="type" href="type.OptRes.html"
title='type test::OptRes'>OptRes</a></td>
<td class='docblock-short'>
[<div class='stab unstable'>Experimental</div>] <p>Result of parsing the options.</p>
</td>
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "test";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
4e2dbb669434a7691662cb2f0ad38972
>
files
>
15255
