Rust folder structure / file structure import example

file_structure.md

I love ❤️ rust but I hate 😞 how vague the beginner documentation is about splitting up your project into a practical structure. This is how I do it (for a library project anyway):

.
└── project/
    ├── src/
    │   ├── lib.rs
    │   ├── top_level_module.rs
    │   └── util/
    │       ├── mod.rs
    │       ├── utility_module_1.rs
    │       ├── utility_module_2.rs
    │       └── private_module.rs
    ├── cargo.toml
    └── readme.md

./src/lib.rs

mod util;
mod top_level_module;

use util::utility_module_1::{Foo, Bar}
use util::utility_module_1::{Spam, Eggs}
use util::Sneaky;

use top_level_module::Stuff

// Do Stuff

./src/top_level_module.rs

// note: no need for `mod` since that appears in lib.rs
use util::utility_module_1::{Foo, Bar}

pub struct Stuff{
  pub ff:Foo,
  pub bb:Bar,
  // ...
}

./src/util/mod.rs

// we can choose to export sub modules as public submodules here
pub mod utility_module_1.rs
pub mod utility_module_2.rs

// we can also re-export the contents of submodules 
// as if they were defined in the `util` module
mod private_module;
pub use private_module::Sneaky;

./src/util/utility_module_1.rs

pub struct Foo(u8);
pub struct Bar(f64);

./src/util/utility_module_2.rs

// submodules can use code from eachother by pathing from the `crate::` root:
use crate::util::utility_module_1::Foo;

// OR
// they can refer to the module above using `super::`
// in this case super:: refers to util
use super::utility_module_1::Foo;

pub struct Spam();
pub struct Eggs{
    pub aa:Foo
};

./src/util/private_module.rs

pub struct Sneaky();

Thanks very much for this help!

Thanks very much for this help!

My pleasure, glad to have helped! :)

Hello reading around i can c that eryone is using the modfile method becouse they cant seem to figure out how the recommended way actually works and just go meh lets use the old way.

Does annyone know how to do it the way it is recommended in the docs (wich are verry unclear)

wich this structure instead of with the mod files.

Option 2 • <folder_name>.rs (the preferred way):

src
    utils
        bar.rs
        foo.rs
    utils.rs
    main.rs