#syntax #directory #file #module

macro no-std automod

Pull in every source file in a directory as a module

11 releases (5 stable)

1.0.4 Aug 1, 2022
1.0.3 Apr 30, 2022
1.0.2 Jun 3, 2021
1.0.0 Sep 5, 2020
0.1.1 Feb 28, 2019

#66 in Build Utils

Download history 616/week @ 2022-06-11 796/week @ 2022-06-18 704/week @ 2022-06-25 727/week @ 2022-07-02 701/week @ 2022-07-09 620/week @ 2022-07-16 715/week @ 2022-07-23 835/week @ 2022-07-30 802/week @ 2022-08-06 788/week @ 2022-08-13 867/week @ 2022-08-20 641/week @ 2022-08-27 707/week @ 2022-09-03 749/week @ 2022-09-10 911/week @ 2022-09-17 980/week @ 2022-09-24

3,506 downloads per month
Used in 84 crates (14 directly)

MIT/Apache

9KB
118 lines

Automod

github crates.io docs.rs build status

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.

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.

Dependencies

~220–630KB
~15K SLoC