Для чего нужен файл mod.rs в Rust? Объясните на примере

Что такое mod.rs и зачем он нужен?

Файл mod.rs — это точка входа для модуля, который представляет собой директорию. В Rust каждый модуль может быть либо отдельным файлом (module_name.rs), либо директорией с файлом mod.rs внутри. Этот файл объявляет публичные подмодули и функции, которые доступны извне.

Как это работает на практике?

Когда вы пишете mod utils; в main.rs, компилятор ищет:

• Файл utils.rs рядом с main.rs, или
• Директорию utils/ с файлом mod.rs внутри.

Внутри mod.rs вы объявляете подмодули и реэкспортируете нужные элементы. Пример правильной структуры:

// src/utils/mod.rs
pub mod helpers;  // объявляем подмодуль helpers

// Можно также реэкспортировать функции для удобства
pub use helpers::say_hello;

// src/utils/helpers.rs
pub fn say_hello() {
    println!("Hello from helpers!");
}

// src/main.rs
mod utils;  // теперь работает!

fn main() {
    // Вариант 1: через подмодуль
    utils::helpers::say_hello();
    
    // Вариант 2: через реэкспорт (если использовали pub use)
    utils::say_hello();
}

Современная альтернатива: module_name.rs как корень модуля

Начиная с Rust 2018 Edition, вы можете использовать файл с тем же именем, что и директория, вместо mod.rs. Например:

// Вместо src/utils/mod.rs используем src/utils.rs
// src/utils.rs
pub mod helpers;

// src/utils/helpers.rs
pub fn say_hello() {
    println!("Hello!");
}

// src/main.rs
mod utils;

fn main() {
    utils::helpers::say_hello();
}

Это более интуитивно понятно, особенно для новичков. Однако mod.rs всё ещё широко используется и полностью поддерживается.

Почему ваш код не работал?

Вы создали папку utils с файлом helpers.rs, но не добавили mod.rs. Компилятор не знает, что helpers.rs — это часть модуля utils. Без mod.rs (или utils.rs) директория игнорируется.

Дополнительные советы

• Используйте pub mod в mod.rs, чтобы сделать подмодули публичными.
• Для реэкспорта используйте pub use — это упрощает импорт для пользователей вашего модуля.
• В больших проектах часто используют mod.rs как "фасад", который скрывает внутреннюю структуру.

Рекомендую ознакомиться с официальной документацией по модулям для более глубокого понимания.

// src/utils/mod.rs
mod helpers;  // приватный подмодуль

// Реэкспортируем только то, что нужно пользователю
pub use helpers::say_hello;
pub use helpers::HelperStruct;

// src/utils/helpers.rs
pub fn say_hello() {
    println!("Hello!");
}

pub struct HelperStruct {
    pub name: String,
}

impl HelperStruct {
    pub fn new(name: &str) -> Self {
        Self { name: name.to_string() }
    }
}

// src/main.rs
mod utils;

fn main() {
    utils::say_hello();
    let obj = utils::HelperStruct::new("Rust");
    println!("{}", obj.name);
}