Nyakio's Tech Tidbits
Rust Project Structure Demystified

Rust Project Structure Demystified

Nyakio Maina's photo
Nyakio Maina
·

3 min read

Hello, fellow learner! As you venture into the exciting world of Rust, understanding the project structure is crucial to help you maintain your code, ensure readability, and make it scalable as your project grows. That's why I've created this beginner-friendly guide just for you!

Rust Project Structure: A Step-by-Step Walkthrough

Step 1: Creating a New Project

To create a new Rust project, open your terminal or command prompt and run the following command:

cargo new my_project

Step 2: Exploring the Project Structure

Navigate to your project directory:

cd my_project

You'll see the following structure:

my_project/
  ├── Cargo.toml
  └── src/
      └── main.rs

Let's go over the main components:

  • Cargo.toml: This is the manifest file for your Rust project. It contains metadata about the project, such as the name, version, authors, and dependencies.

  • src/: This directory contains the source code for your project. In this case, there's a single file called main.rs which serves as the entry point for your program.

Now let's dive into Rust's project structure, including modules and libraries.

Modules and Libraries

In Rust, you can use modules and libraries to organize your code and make it more modular and easier to navigate. Modules help you split your code into separate files and namespaces, while libraries allow you to create reusable code components. Here's how they work:

Modules

Modules help you organize your code into separate files and namespaces. To create a module, use the mod keyword followed by the module's name. For example, if you have a file named greetings.rs in your src directory, and you want to use it as a module, include it in your main.rs or lib.rs file like this:

mod greetings;

You can also create submodules by creating a directory named after the parent module and placing a mod.rs file inside. This file will serve as the entry point for the submodule. For example, if you want to create a submodule named farewells inside the greetings module, you can create a directory structure like this:

src/
  ├── main.rs
  ├── greetings/
  │   ├── mod.rs
  │   └── farewells.rs

Then, in greetings/mod.rs, you can declare the farewells submodule like this:

mod farewells;

Libraries

A library is essentially a package of reusable code that can be included and used in other programs. If you find yourself writing the same functions or modules across different projects, it might be a good idea to create a library to reuse that code and avoid repetition.

To create a library in Rust, you essentially create a new project with a lib.rs file in the src directory. This lib.rs file is the primary entry point for the library, and it is where you define the public API and exports for your library.

Basic example of what a Rust library project structure might look like:

my_project/
  ├── Cargo.toml
  └── src/
      └── lib.rs

In your lib.rs file, you would define your library's public API and exports. For instance, you might have a greetings module with a public hello function:

pub mod greetings {
    pub fn hello() {
        println!("Hello, world!");
    }
}

In this example, the pub keyword makes the greetings module and the hello function inside it public, meaning they can be accessed from outside the library.

Other Rust programs can use your library by adding it as a dependency in their Cargo.toml file. Once added, they can bring the library, or specific parts of it, into scope using the use keyword:

// Import the `hello` function from the `greetings` module in `my_library`
use my_library::greetings::hello;

fn main() {
    // Now we can use the `hello` function
    hello();
}

In this way, Rust libraries help you create more modular, reusable, and maintainable code.

RustLangRust