How can I use a module from outside the src folder in a binary project, such as for integration tests or benchmarks?

by

Here’s a literal answer, but don’t actually use this!

#![feature(test)]
extern crate test;

#[path = "../src/foo.rs"] // Here
mod foo;

#[bench]
fn bencher(_: &mut test::Bencher) {
    println!("{:?}", foo::Thang);
}

In fact, it’s very likely that this won’t work because your code in foo.rs needs supporting code from other files that won’t be included.

Instead of doing this, just create a library. You have the pure definition of a library – a piece of code that wants to be used in two different executables. You don’t have to give up having an executable or even create separate directories (see Rust package with both a library and a binary?), but creating reusable code is a key component of making good code.

Your end state would look something like:

demo
├── Cargo.lock
├── Cargo.toml
├── benches
│   └── crypto_bench.rs
├── benchmarks
└── src
    ├── bin
    │   └── main.rs
    ├── crypto.rs
    └── lib.rs

Move the reusable code to a library:

src/lib.rs

pub mod crypto;

src/crypto.rs

pub struct Crypto;
impl Crypto {
    pub fn secret() {}
}

Then import your library from the benchmark and the binary:

benches/crypto_bench.rs

#![feature(test)]

extern crate test;

use demo::crypto::Crypto;
use test::Bencher;

#[bench]
fn speedy(b: &mut Bencher) {
    b.iter(|| Crypto::secret());
}

src/bin/main.rs

use demo::crypto::Crypto;

fn main() {
    Crypto::secret();
    eprintln!("Did the secret thing!");
}

You can then run it in different ways:

$ cargo build
   Compiling demo v0.1.0 (/private/tmp/example)
    Finished dev [unoptimized + debuginfo] target(s) in 0.51s

$ cargo run
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
     Running `target/debug/main`
Did the secret thing!

$ cargo +nightly bench
   Compiling demo v0.1.0 (/private/tmp/example)
    Finished release [optimized] target(s) in 0.70s
     Running target/release/deps/my_benchmark-5c9c5716763252a0

running 1 test
test speedy ... bench:           1 ns/iter (+/- 0)

test result: ok. 0 passed; 0 failed; 0 ignored; 1 measured; 0 filtered out

See also:

More Related Contents:

  1. What is the difference between iter and into_iter?
  2. How does for syntax differ from a regular lifetime bound?
  3. How to get a reference to a concrete type from a trait object?
  4. Conditionally iterate over one of several possible iterators
  5. Why is this match pattern unreachable when using non-literal patterns?
  6. Is there any way to create a type alias for multiple traits?
  7. Proper way to return a new string in Rust
  8. Double mutable borrow error in a loop happens even with NLL on
  9. How to return a reference to a sub-value of a value that is under a mutex?
  10. How do I return an instance of a trait from a method?
  11. Is it possible to make a type only movable and not copyable?
  12. How to use struct self in member method closure
  13. How do I call a function through a member variable?
  14. How do you pass a Rust function as a parameter?
  15. How do I implement a trait with a generic method?
  16. Is there a way to create a function pointer to a method in Rust?
  17. How do I use conditional compilation with `cfg` and Cargo?
  18. When I can use either Cell or RefCell, which should I choose?
  19. Return an async function from a function in Rust
  20. Type mismatches resolving a closure that takes arguments by reference
  21. How can a Rust program access metadata from its Cargo package?
  22. How can the ref keyword be avoided when pattern matching in a function taking &self or &mut self?
  23. How do I disambiguate traits in Rust?
  24. Expected bound lifetime parameter, found concrete lifetime [E0271]
  25. How do I change a function’s qualifiers via conditional compilation?
  26. Creating a vector of zeros for a specific size
  27. What is the difference between immutable and const variables in Rust?
  28. What is the purpose of the unit type in Rust?
  29. How to print structs and arrays?
  30. Can Rust optimise away the bit-wise copy during move of an object someday?

Leave a Comment