Crate automod

source ·
Expand description


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



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").


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

  • tests/
    • regression/

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/ containing:

mod regression {

The macro invocation expands to:

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