Automod

(This project is no longer maintained.)

Pull in every source file in a directory as a module.

[dependencies]
automod = "1.0"

Syntax

automod::dir!("path/to/directory");

This macro expands to one or more mod items, one for each source file in the specified directory, excluding mod.rs, lib.rs, and main.rs.

The path is given relative to the directory containing Cargo.toml.

It is an error if the given directory contains no source files or if a file name is not valid UTF-8.

The macro takes an optional visibility to apply on the generated modules: automod::dir!(pub "path/to/directory").

Example

Suppose that we would like to keep a directory of regression tests for individual numbered issues:

• tests/
  • regression/
    • issue1.rs
    • issue2.rs
    • ...
    • issue128.rs

We would like to be able to toss files in this directory and have them automatically tested, without listing them in some explicit list of modules. Automod solves this by adding tests/regression.rs containing:

mod regression {
    automod::dir!("tests/regression");
}

The macro invocation expands to:

mod issue1;
mod issue2;
/* ... */
mod issue128;

License

^{Licensed under either of Apache License, Version 2.0 or MIT license at your option.}
_{Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.}