Rust for cpp devs - 用 Packages Crates 和 Modules 管理项目

Rust 中包含三个不同层级的结构:

  • package
  • crate
  • module

package 是由一个或多个 crates 组成,并且包含一个 Cargo.toml 配置文件来描述如何编译这些 crates。我们通过 cargo new my-project 创建出来的就是一个 package。而其中包含的 src/main.rs 就是默认创建的名为 my-project(与项目名相同)的二进制 crate。

crate 可以是一个二进制文件,或者是一个库文件。它将相关的功能组合在一个 scope 中,从而在不同的项目中共享。如果我们把 .rs 文件放入 src/bin 目录下,每个文件都会编译成一个独立的二进制 crate。

module 允许我们在 crate 内再细分代码,同时,它也控制哪些代码对外部可见(public),哪些是私有的(private)。

Path and Module

我们使用 path 来指定某个 module。path 可以有两种表现形式:

  • 绝对路径
    crate:: 作为”根目录“,类似于 linux 中的 /。
  • 相对路径
    从当前??榭嫉南喽月肪?/li>

路径用符号 :: 分隔。

这两者的区别是,如果经常把 module 定义和调用作为整体移动,则更适合相对路径。如果经常单独移动调用者,则更适合绝对路径。一般来讲,偏向使用绝对路径。

使用 Module 来管理 private 和 public

Module 中的函数、结构体等默认都是 private 的。我们需要使用 pub 指明是 public 的,例如:

mod front_of_house {
    pub mod hosting {
        pub fn add_to_waitlist() {}
        pub fn seat_at_table() {}
    }
}

这样才可以在同一个项目的另一个文件中如下调用:

mod front_of_house;

#[cfg(test)]
mod tests {
    #[test]
    fn test_eat_at_restaurant() {
        use crate::front_of_house::hosting;
        hosting::add_to_waitlist();
        hosting::seat_at_table();
    }
}

这里我们使用 use 关键字来将 hosting 引入当前 scope。类似于 python,我们也可以使用 as 来重命名。

use std::io::Result as IoResult;

将 module 放在不同文件中

实际项目中,我们不可能把所有代码都写在一个文件中。一般我们可以根据 module 来拆分成不同的文件。

mod front_of_house;

这行代码的意义是让 Rust 从另一个名为 src/front_of_house.rs 的文件中加载这个 module,有点类似于 C++ 的声明。只要把这行代码加入 lib.rs 或者 main.rs,Rust 就会去寻找并加载 front_of_house.rs 这个文件。注意,此时这个文件自身就是一个 module,无需再定义一个 front_of_house。

将 module 放入文件夹

如果希望将 module 放入文件夹,那么更加复杂一些。我们需要

  1. 建立 src/front_of_house 文件夹,并在里面创建 src/front_of_house/hosting.rs 文件
  2. 增加一个叫 src/front_of_house.rs 的文件,必须与文件夹同名
  3. src/front_of_house.rs 中添加代码声明 hosting 模块:
mod hosting;
  1. src/lib.rs 中添加代码声明 front_of_house ??椋?/li>
mod front_of_house;

使用外部 package

Rust 社区有很多 packages,我们只需要以下两步就能将 package 导入自己的项目。

  • Cargo.toml 配置文件中添加依赖的 package:
[dependencies]
rand = "0.5.5"
  • 使用 use 将依赖的 package 引入 scope:
use rand::Rng;

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

参考

  1. Clear explanation of Rust’s module system
最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352

推荐阅读更多精彩内容