rust模块

August 2, 2022

rust

使用 Cargo 管理包

一个包中至多包含一个 库 crate (library crate)
可以包含任意多个 二进制 crate (binary crate)
每个包中至少包含一个 crate

目录结构

src/main.rs 就是一个与包同名的 二进制 crate 的 crate 根

src/lib.rs 则是一个与包同名的 库 crate 的 crate 根

库 crate 至多存在一个，而 二进制 crate 若存在多个，则每个 src/bin 下的文件都会被编译成一个独立的 二进制 crate

mod 关键字

使用 mod 关键字声明模块，模块可以任意层级嵌套

rust

// src/lib.rs
mod module_name {
    mod sub_module {
        fn do_something() {}
    }
}

路径

使用路径获取模块。
以 crate:: 开头的为绝对路径，从 crate 根开始查找；相对路径则从当前文件进行查找
例如：

rust

// src/lib.rs
create::module_name::sub_module::do_something();
module_name::sub_module::do_something();

以 super:: 开头的，super 指代当前模块的父模块名
例如：

rust

// src/lib.rs
mod outer {
    fn f1() {}
    mod inner {
        fn f2() {}
        fn f3() {
            super::f1(); // 获取父层级
            f2(); // 获取同层级
        }
    }
}

pub 关键字

rust

// src/lib.rs
mod outer {
    pub mod inner {
        pub fn f() {}
    }
    pub struct Season { // pub 结构体只有 pub 字段才对外可见
        pub display: String, // 此字段可见
        value: i32, // 此字段不可见
    }
    pub enum Boolean { // pub 枚举的成员都自动为 pub
        False,
        True,
    }
}

pub fn todo() {
    // Absolute path
    crate::outer::inner::f();

    // Relative path
    outer::inner::f();
}

use 关键字

use 将暴露的项引入作用域

rust

use outer::inner::f;
f();
// or
use outer::inner;
inner::f();
// or ...

在测试时，可以使用通配符，引入所有

rust

use outer::*;
inner::f();
let bool = Boolean::True;
// 这里注意，如果结构体含有非 pub 字段，则无法直接实例化
// 例如，以下代码无法编译：
let s = Season {
    display: String::from("123"),
    value: 123, // 这个字段是私有的！！
};

使用花括号导入路径的多个部分

rust

use outer::inner::{Season, Boolean};

use outer::{inner::Season, f};

use outer::inner::{self, f}; // self 表示路径本身
/* 相当于：
use outer::inner;
use outer::inner::f;
*/

as 关键字

使用 as 关键字提供新的名称

rust

use outer::inner::f as function;
function();

使用 pub use 重导出名称

rust

// src/lib.rs
mod outer {
    fn f1() {}
    mod inner {
        fn f2() {}
    }
}

pub use crate::outer::inner;
pub fn f3() {
    inner::f2();
}

使用外部包

toml

//  Cargo.toml
clap = "2.27.1" # 来自 crates.io
rand = { git = "https://github.com/rust-lang-nursery/rand" } # 来自网上的仓库
bar = { path = "../bar" } # 来自本地文件系统的路径

rust

use rand::Rng;
fn main() {
    let secret_number = rand::thread_rng().gen_range(1..101);
}

将模块分割进文件

rust

// src/utils.rs
pub mod toolbox {
    pub fn fix() {}
}

rust

// src/lib.rs
mod utils; // 在另一个文件的模块
pub use crate::utils::toolbox;

toolbox::fix();

文件分层

|-- my
|   |-- inaccessible.rs
|   |-- mod.rs
|   `-- nested.rs
`-- split.rs

split.rs

mod my;
// 这个声明会查找 `my.rs` 或 `my/mod.rs` 文件，然后将该文件的内容放到当前作用域中一个名为 `my` 的模块里面。

my/mod.rs

mod inaccessible;
pub mod nested;
// 此处同理

一个包中管理多个 crate

https://www.rustwiki.org.cn/zh-CN/book/ch14-03-cargo-workspaces.html

库，生成 rlib 文件

mylib.rs

pub fn public_function() {
    println!("`public_function()` is called");
}

$ rustc --crate-type=lib mylib.rs

同目录下得到 libmylib.rlib 文件（默认添加了 lib 前缀）
参见：https://www.rustwiki.org.cn/zh-CN/rust-by-example/attribute/crate.html

run.rs

fn main(){
    mylib::public_function();
}

$ rustc run.rs --extern mylib=libmylib.rlib
# extern 的参数是 导入的库名=库的路径

$ ./run

`public_function()` is called

←Back to home