obnam_benchmark/lib.rs
1//! Run benchmarks for the Obnam backup program.
2//!
3//! Obnam is a backup system. This crate a way to specifying
4//! benchmarks in YAML and running them. A specification file looks
5//! like:
6//!
7//! ```yaml
8//! benchmarks:
9//! - benchmark: maildir
10//! backups:
11//! - changes:
12//! - create:
13//! files: 100
14//! file_size: 0
15//! - changes:
16//! - rename:
17//! files: 10
18//! - delete:
19//! files: 10
20//! - create:
21//! files: 10
22//! file_size: 0
23//! ```
24//!
25//! A [specification][] is broken down into a sequence of
26//! [steps](step). Steps, if executed in order, perform the benchmark.
27//!
28//! This crate only collects data from a set of benchmarks. It does
29//! not analyze the data. The data can be stored for later analysis.
30
31pub mod builder;
32pub mod client;
33pub mod daemon;
34pub mod junk;
35pub mod obnam;
36pub mod report;
37pub mod result;
38pub mod server;
39pub mod specification;
40pub mod step;
41pub mod suite;
42pub mod summain;
43pub mod tlsgen;