bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Add time crate to index, expand docs of test.

Browse source
This commit is contained in:
Huon Wilson 2014-02-28 23:25:44 +11:00
parent 31e9c947a3
commit 1b5be76bdf
2 changed files with 21 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/doc/index.md
View file

@ -42,7 +42,8 @@ li {list-style-type: none; }
* [The `sync` library for concurrency-enabled mechanisms and primitives](sync/index.html) * [The `sync` library for concurrency-enabled mechanisms and primitives](sync/index.html)
* [The `syntax` library, the Rust parser](syntax/index.html) * [The `syntax` library, the Rust parser](syntax/index.html)
* [The `term` terminal-handling library](term/index.html) * [The `term` terminal-handling library](term/index.html)
* [The `test` library](test/index.html) * [The `test` library containing the unit-testing & micro-benchmark framework](test/index.html)
* [The `time` library](time/index.html)
* [The `uuid` 128-bit universally unique identifier library](uuid/index.html) * [The `uuid` 128-bit universally unique identifier library](uuid/index.html)
# Tooling # Tooling

25
src/libtest/lib.rs
View file

@ -8,10 +8,20 @@
// option. This file may not be copied, modified, or distributed // option. This file may not be copied, modified, or distributed
// except according to those terms. // except according to those terms.
// Support code for rustc's built in test runner generator. Currently, //! Support code for rustc's built in unit-test and micro-benchmarking
// none of this is meant for users. It is intended to support the //! framework.
// simplest interface possible for representing and running tests //!
// while providing a base that other test frameworks may build off of. //! Almost all user code will only be interested in `BenchHarness` and
//! `black_box`. All other interactions (such as writing tests and
//! benchmarks themselves) should be done via the `#[test]` and
//! `#[bench]` attributes.
//!
//! See the [Testing Guide](../guide-testing.html) for more details.
// Currently, not much of this is meant for users. It is intended to
// support the simplest interface possible for representing and
// running tests while providing a base that other test frameworks may
// build off of.
#[crate_id = "test#0.10-pre"]; #[crate_id = "test#0.10-pre"];
#[comment = "Rust internal test library only used by rustc"]; #[comment = "Rust internal test library only used by rustc"];
@ -127,7 +137,11 @@ impl TestFn {
} }
} }
// Structure passed to BenchFns /// Manager of the benchmarking runs.
///
/// This is feed into functions marked with `#[bench]` to allow for
/// set-up & tear-down before running a piece of code repeatedly via a
/// call to `iter`.
pub struct BenchHarness { pub struct BenchHarness {
priv iterations: u64, priv iterations: u64,
priv ns_start: u64, priv ns_start: u64,
@ -1575,4 +1589,3 @@ mod tests {
assert_eq!(*(m4.find(&~"throughput").unwrap()), Metric::new(50.0, 2.0)); assert_eq!(*(m4.find(&~"throughput").unwrap()), Metric::new(50.0, 2.0));
} }
} }