Defining modules in Rust

Introduction

Modules help organize your Rust code into smaller parts. This makes your code easier to read and manage.

When your program grows and you want to split code into separate files.

When you want to group related functions and types together.

When you want to control what parts of your code are visible outside.

When you want to avoid name conflicts by keeping code in separate spaces.

Syntax

Rust

mod module_name {
    // code here
}

// or in another file:
mod module_name;

Use mod to define a module inside the same file or to link to another file.

Module files should be named module_name.rs or placed in a folder module_name/mod.rs.

Examples

This defines a module named greetings inside the same file. The function hello is public so it can be used outside.

Rust

mod greetings {
    pub fn hello() {
        println!("Hello from the module!");
    }
}

fn main() {
    greetings::hello();
}

This shows how to define a module in a separate file called math.rs and use its public function.

Rust

// In main.rs
mod math;

fn main() {
    math::add(2, 3);
}

// In math.rs
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

Sample Program

This program defines a module tools with a public function hammer. The main function calls it.

Rust

mod tools {
    pub fn hammer() {
        println!("Using the hammer");
    }
}

fn main() {
    tools::hammer();
}

Important Notes

Functions and items inside a module are private by default. Use pub to make them accessible outside.

Modules can be nested inside other modules for better organization.

Use cargo build or cargo run to compile and run your Rust programs with modules.

Summary

Modules organize code into separate parts.

Use mod to define or link modules.

Make items pub to use them outside the module.

Practice

1. What keyword do you use in Rust to define a new module inside a file?

easy

A. module

B. use

C. mod

D. pub

Solution

1. Step 1: Understand Rust module declaration

   Rust uses the keyword mod to declare a module inside a file.

2. Step 2: Differentiate from other keywords

   use imports modules, pub makes items public, and module is not a Rust keyword.

3. Final Answer:

   mod -> Option C

4. Quick Check:

   Keyword for defining modules = mod [OK]

Hint: Remember: 'mod' means module in Rust [OK]

Common Mistakes:

• Using 'module' instead of 'mod'
• Confusing 'use' with 'mod'
• Forgetting 'mod' keyword

2. Which of the following is the correct syntax to declare a module named network in Rust?

easy

A. use network {}

B. module network {}

C. pub mod network() {}

D. mod network {}

Solution

1. Step 1: Recall correct module syntax

   The correct syntax to declare a module is mod name { } without parentheses.

2. Step 2: Check each option

   mod network {} uses mod network {} which is correct. module network {} uses 'module' which is invalid. pub mod network() {} adds parentheses which are not allowed. use network {} uses 'use' which is for importing.

3. Final Answer:

   mod network {} -> Option D

4. Quick Check:

   Module declaration = mod name {} [OK]

Hint: Modules use curly braces, no parentheses [OK]

Common Mistakes:

• Adding parentheses after module name
• Using 'module' instead of 'mod'
• Confusing 'use' with 'mod'

3. What will be the output of this Rust code?

mod math {
    pub fn add(a: i32, b: i32) -> i32 {
        a + b
    }
}

fn main() {
    println!("{}", math::add(3, 4));
}

medium

A. 7

B. Compilation error

C. math::add(3, 4)

D. 0

Solution

1. Step 1: Check module and function visibility

   The function add is marked pub, so it can be accessed outside the module.

2. Step 2: Evaluate the function call

   Calling math::add(3, 4) returns 3 + 4 = 7, which is printed.

3. Final Answer:

   7 -> Option A

4. Quick Check:

   Public function call returns sum = 7 [OK]

Hint: Public functions in modules can be called with module::function [OK]

Common Mistakes:

• Forgetting 'pub' causes compilation error
• Expecting function name printed
• Confusing output with zero

4. Identify the error in this Rust code:

mod utils {
    fn helper() {
        println!("Helper function");
    }
}

fn main() {
    utils::helper();
}

medium

A. Function 'helper' is private and cannot be accessed outside the module

B. Missing semicolon after println!

C. Module 'utils' is not declared correctly

D. Cannot call functions inside modules

Solution

1. Step 1: Check function visibility

   The function helper is not marked pub, so it is private to the module.

2. Step 2: Understand access from main

   Trying to call utils::helper() from outside causes a compilation error due to privacy.

3. Final Answer:

   Function 'helper' is private and cannot be accessed outside the module -> Option A

4. Quick Check:

   Private functions can't be called outside module [OK]

Hint: Add 'pub' to functions to access them outside modules [OK]

Common Mistakes:

• Assuming all functions are public by default
• Ignoring privacy rules
• Thinking modules block all calls

5. You want to organize your Rust project by splitting code into two files: main.rs and network.rs. How do you correctly declare and use the network module in main.rs?

hard

A. Write pub mod network {} in main.rs and put code inside network.rs

B. Write mod network; in main.rs and make functions in network.rs public with pub

C. Write use network; in main.rs and declare mod network {} inside network.rs

D. Write extern crate network; in main.rs and import functions manually

Solution

1. Step 1: Understand module file linking

   To link an external file as a module, use mod network; in main.rs. This tells Rust to load network.rs.

2. Step 2: Make functions public in network.rs

   Functions inside network.rs must be marked pub to be accessible from main.rs.

3. Final Answer:

   Write mod network; in main.rs and make functions in network.rs public with pub -> Option B

4. Quick Check:

   Use mod filename; and pub functions for multi-file modules [OK]

Hint: Use 'mod filename;' in main and 'pub' for access [OK]

Common Mistakes:

• Using 'use' instead of 'mod' to declare modules
• Declaring mod inside the module file
• Using extern crate for local modules