automoduse 1.0.0

Pull in every source file in a directory as a module and optionally re-export their contents.
Documentation
  • Coverage
  • 50%
    1 out of 2 items documented1 out of 2 items with examples
  • Size
  • Source code size: 26.02 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 313.98 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 5s Average build duration of successful builds.
  • all releases: 5s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • yvvki/automoduse
    0 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • yvvki

Automoduse

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