mod — コードを名前空間で分けるのサンプルコード — Rust

1最小のモジュール — 関数をひとまとめにする

mod ブロックで関連する関数を1つの名前空間にまとめる、いちばん素朴な例です。中の関数は math::double のように「モジュール名::関数名」のパスで呼び出します。計算ロジックの置き場所に名前を付けるだけでも、コードのどこに何があるかが格段に追いやすくなります。

Rust

mod math {
    pub fn double(n: i32) -> i32 {
        n * 2
    }

    pub fn triple(n: i32) -> i32 {
        n * 3
    }
}

fn main() {
    println!("double = {}", math::double(5));
    println!("triple = {}", math::triple(5));
}

2別モジュールなら同名の関数を持てる

モジュールが名前の衝突を防ぐ仕切りになることを示す例です。japanese と english の両方に greet という関数がありますが、パスが違うので問題なく共存できます。実務でも「同じ操作の別実装」をモジュール名で区別する場面は頻繁にあります。

Rust

mod japanese {
    pub fn greet(name: &str) {
        println!("こんにちは、{}さん", name);
    }
}

mod english {
    pub fn greet(name: &str) {
        println!("Hello, {}!", name);
    }
}

fn main() {
    japanese::greet("花子"); // 同名でもパスで区別できる
    english::greet("Hanako");
}

3モジュールの入れ子で階層を作る

mod の中にさらに mod を書いて、階層構造を作る例です。呼び出すときは app::ui::render のようにパスを :: でつないでたどります。実務のプロジェクトでは「アプリ全体 → 機能 → 細かい部品」という階層をこの入れ子(と、それをファイルに分けた形)で表現します。

Rust

mod app {
    pub mod ui {
        pub fn render() {
            println!("画面を描画します");
        }
    }

    pub mod storage {
        pub fn save() {
            println!("データを保存します");
        }
    }
}

fn main() {
    app::ui::render(); // 階層を :: でたどって呼ぶ
    app::storage::save();
}

4モジュール内どうしは修飾なしで呼べる

同じモジュールの中なら、report:: を付けずに関数を直接呼べることを示す例です。外から呼ぶときだけパスで修飾する、という内と外の違いがモジュールの本質です。集計の部品(average)と、それを組み立てた窓口(print_summary)を同じモジュールに置く構成は実務でも定番です。

Rust

mod report {
    pub fn average(total: i32, count: i32) -> i32 {
        total / count
    }

    pub fn print_summary(total: i32, count: i32) {
        let avg = average(total, count); // 同じモジュール内は修飾なしで呼べる
        println!("合計 = {}, 平均 = {}", total, avg);
    }
}

fn main() {
    report::print_summary(300, 4); // 外からはモジュール名を付けて呼ぶ
    println!("平均だけ使う = {}", report::average(300, 4));
}

5設定モジュールと起動処理の分割

「設定値を返す config」と「起動メッセージを出す startup」という関心の違いをモジュール分割で表した、実務寄りの例です。設定の取得元をあとでファイル読み込みに変えても、config の中だけ直せば済みます。main が各モジュールをつなぐ司令塔になる構成は、実際のアプリケーションの縮図です。

Rust

mod config {
    pub fn app_name() -> String {
        String::from("order-service")
    }

    pub fn max_retries() -> u32 {
        3
    }
}

mod startup {
    pub fn banner(name: &str, retries: u32) {
        println!("[{}] 起動しました (リトライ上限: {})", name, retries);
    }
}

fn main() {
    let name = config::app_name();
    startup::banner(&name, config::max_retries());
}

サンプルコードで身につける: mod — コードを名前空間で分ける

1最小のモジュール — 関数をひとまとめにする

2別モジュールなら同名の関数を持てる

3モジュールの入れ子で階層を作る

4モジュール内どうしは修飾なしで呼べる

5設定モジュールと起動処理の分割