rust多文件/文件夹及模块管理

结论

两种方式:1)include宏,即 include!("file_path");2)mod 方式。

使用场景或者使用最佳实践如下,
一、大部分时候是用 mod 方式。每个文件夹下有一个 mod.rs 文件来控制 struct/func/等 的导出,用来给内部、外部模块使用。
二、include宏等价于复制粘贴,和C/C++的include一样,在宏展开阶段会将整个文件 copy 过来。include宏也有两种场景:1)例如结构体方法的实现,是在多个文件中实现的。另外有时候该多个结构体方法的实现文件组织在一个或几个文件夹中,但却不想将该文件夹声明为模块(mod.rs)。2)文件或者文件夹名字中有中文,使用 mod.rs 方式会报错,此时要么改名为无中文,要么使用include宏。

详细

以力扣刷题场景为例(我学习新语言经常喜欢用力扣刷题来熟悉),我的习惯如下(Java项目为例),


Java刷力扣文件组织方式.png

如图,在src/main/java下,有汇总目录,例如1-100题、101-200题等。每个汇总目录下,有单个题目的目录,用来存放某道题的题目描述和解法,有些题目有多个解法,就会有多个Solution类,如图中Solution和Solution2。这样安排的目的是:1)方便快速检索;2)方便单个题目的组织管理。

这次用rust也希望按照这种管理方式。但是rust的mod管理方式不是基于文件系统的,也就是说rust文件有两个视角,一个是文件系统视角,另一个是rust编译器视角(即mod视角)。
mod具体可参阅rust官方的文档了解,此处不赘述。

mod 方式

该方式下文也会称 mod.rs,两个表述等价。
这种方式下,每个子文件夹下都需要一个 mod.rs 文件,如下图,


Mod方式.png

可以看到,每个文件夹下面有一个mod.rs文件,在mod.rs文件中控制该文件夹下什么东西导出。另外可以看出一些规律,

  • p001_100文件夹下的mod.rs,mod文件中 pub mod 后面是其子文件夹的名字。
  • p001两数之和、p002两数相加文件夹下的mod.rs,mod文件中 pub mod 后面是其子文件的名字。

以p002两数相加文件夹为例,可以看下如何导入导出,


例子.png

include宏方式

该方式下文也会简称include方式。

include上面也提到了有两种方式。
第一种方式。像上面举例的mod方式,文件夹名字是有中文的, rust是会报错的,例如,error[E0754]: trying to load file for module `p001两数之和` with non-ascii identifier name

路径中有中文.png

那么此时可以用include方式,见上图,第一个框的注释掉并且打开include宏的注释即可正常运行。

第二种方式。结构体方法的实现文件组织在多个文件中,或者组织在一个/多个文件夹中,但却不想将该文件夹声明为模块(文件夹声明为模块需要添加mod.rs文件,文件夹多了之后会显得乱),此时就可以使用include。

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

推荐阅读更多精彩内容