Automod is a procedural macro. It will run at compile time and transform your program's source code.

Adding `automod` macro(s) as a dependency

Run this command in a terminal, in your project's directory:

cargo add automod

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

automod = "1.0.16"

You may need to import the macro(s) with use automod::*.

Read the automod documentation.

Back to the crate overview.

Readme

Automod

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.

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

It is an error if the given directory contains no source files.

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.}

Adding automod macro(s) as a dependency

Adding `automod` macro(s) as a dependency