automoduse

Crates.ioautomoduse
lib.rsautomoduse
version1.0.0
created_at2025-12-15 16:14:08.082084+00
updated_at2025-12-15 16:14:08.082084+00
descriptionPull in every source file in a directory as a module and optionally re-export their contents.
homepage
repositoryhttps://github.com/yvvki/automoduse
max_upload_size
id1986323
size26,547
Yuuki Rika (yvvki)

documentation

https://docs.rs/automoduse

README

Automoduse

github crates.io docs.rs build status

Pull in every source file in a directory as a module and optionally re-export their contents.

[dependencies]
automoduse = "1.0"

Syntax

automoduse::dir!("path/to/directory" pub use);

This macro expands to one or more mod items, one for each source file in the specified directory, and its contents re-exported with pub use.

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: automoduse::dir!(pub "path/to/directory" use).

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. Automoduse solves this by adding tests/regression.rs containing:

mod regression {
    automoduse::dir!("tests/regression" pub use);
}

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.
Commit count: 0

cargo fmt