这篇文章是实战性质的,也就是说原理部分较少,属于经验总结,rust对于模块的例子太少了。rust特性比较多(悲),本文的内容可能只是一部分,实现方式也不一定是这一种。
关于 rust 模块的相关内容,准确来说:怎么在源码中引用其他模块的内容。
mod
、 use
、as
这几个关键字(文件名)mod.rs
文件self
、 super
、 crate
这几个路径关键字worksapce
:本文不讨论,狭义上指的是cargo的 [workspace]
部分: 可参见 The [workspace] sectionpackage
: 狭义上指的是cargo的 [package]
部分,参见 The [package] sectioncrate
:参见下文 关于 create 的定义和 cargo 管理下的 cratemodule
:本文的重点, crate 里 会有多个 module,文本讨论重点就是 mod 之间相互引用的问题。引用模块要搞清楚的:
mod
关键字:
用来声明,表现方式是包裹一个代码块。也就是说这个代码块会成为一个单独的模块。
mod xxx { <rust语句块> }
:内部写 rust 语句 。见 例一#[path="...xxxx.rs"] mod xxx;
:使用 path 属性 ,使用见例二mod xxx { include!("...xxxx.rs") }
:内部配合 include!
宏,使用见例二用来声明(“引用”)其他“模块”。(一个文件隐含的表示为一个mod)
假设使用 mod toy;
语句来引入一个模块,实际上这跟你在哪里写的这个语句有关系有关
src/main.rs
、 src/lib.rs
或者 xxx/.../mod.rs
位置上的文件; 类型B: 位置不在1中的文件。mod toy;
,你实际上在告诉编译器,你需要的模块是与此文件同级的 toy.rs
或者 toy/mod.rs
文件 。编译器会自己找下这两个被引用的位置,如果两个位置都有文件,则报错。见 例三mod toy;
,你实际上在告诉编译器,你需要的模块是与此文件(假设文件名为 foo.rs
)同级的 foo
文件夹下的 foo/toy.rs
或者 foo/toy/mod.rs
文件。编译器会自己找下这两个被引用的位置,如果两个位置都有文件,则报错。 见 例四use
关键字也有两个作用
as
关键字一起使用,进一步减少重复代码,或者防止名字重复,或者取个顺眼的名字 例子六如果我们想要调用一个函数,我们需要知道它的路径。路径有两种形式:
见文档: https://rustwiki.org/zh-CN/book/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html
我们都知道通过 cargo 创建出的工程中 src/main.rs
就是程序的入口,但是还有更多的使用方式。
下面就是一些问题了
什么是 create ? rustc 的编译入口文件,这个文件就被当做 crate 文件。
crate 类型: 有多种,最常见的是 bin
和 lib
,其他类型参见 rust参考手册-链接
cargo 怎么定义工程项目中哪些是需要编译的 crate 的? 参见: cargo手册-项目布局
▾ src/ # 包含源文件的目录
lib.rs # 库和包的主要入口点
main.rs # 包生成可执行文件的主要入口点
▾ bin/ # (可选)包含其他可执行文件的目录
*.rs
▾ */ # (可选)包含多文件可执行文件的目录
main.rs
▾ examples/ # (可选)示例
*.rs
▾ */ # (可选)包含多文件示例的目录
main.rs
▾ tests/ # (可选)集成测试
*.rs
▾ */ # (可选)包含多文件测试的目录
main.rs
▾ benches/ # (可选)基准
*.rs
▾ */ # (可选)包含多文件基准的目录
main.rs
toy
模块run
函数需要加 pub
关键字,否则不会被导出src/main.rs
mod toy {
pub fn run() {
println!("run toy");
}
}
fn main() {
toy::run();
}
输出
run toy
toy
模块src/toy_implements.rs
pub fn run() {
println!("run toy_impl !");
}
src/main.rs
mod toy1 { // 方法1: 使用 include!
include!("./toy_implements.rs");
}
#[path ="./toy_implements.rs"]
mod toy2; // 方法2: 使用 path 属性定位文件位置
fn main() {
toy1::run();
toy2::run();
}
输出
run toy_impl !
run toy_impl !
src/toy.rs
pub fn run() {
println!("run toy_impl !");
}
src/main.rs
mod toy;
fn main() {
toy::run();
}
输出
run toy_impl !
src/foo/toy.rs
pub fn run() {
println!("run toy_impl !");
}
src/foo.rs
mod toy;
fn say_hi() {
toy::run();
}
输出
run toy_impl !
之前,我们使用了 toy::run()
来调用 run
函数。现在,我们使用 use
关键字来导入 toy
模块里的内容,这样就能在 main
函数中直接使用
src/foo.rs
mod toy {
pub fn run() { // 注意使用 pub 关键字
println!("run toy");
}
}
fn main() {
use toy::*; // 使用 use 导入 toy 模块里的内容
run(); // 直接调用
}
src/foo.rs
mod toy {
pub fn run() { // 注意使用 pub 关键字
println!("run toy");
}
}
fn main() {
use toy::run as toy_run; // 使用 use + as 导入 toy 模块里的内容
toy_run();
}
src/toy/runner.rs
pub fn dog_run() { println!("dog is run !"); }
src/toy/fly.rs
pub fn fly_bird() { println!("bird is fly !"); }
src/toy/bear.rs
pub fn bear_eat() { println!("bear is eat fish !"); }
pub fn bear_sleep() { println!("bear is go sleep !"); }
src/toy/mod.rs
mod runner; // 引入同级 runner.rs 文件
mod fly; // 引入同级 fly.rs 文件
mod bear; // 引入同级 bear.rs 文件
pub use runner::dog_run; // 声明(导出) dog_run 函数
pub use fly::fly_bird as now_fly_brid; // 声明(导出) fly_bird 函数,并重命名为 now_fly_brid
pub use bear::*; // 声明(导出) dog_run 函数
src/main.rs
mod toy;
fn main() {
toy::dog_run();
toy::now_fly_brid();
toy::bear_eat();
toy::bear_sleep();
}
输出
dog is run !
bird is fly !
bear is eat fish !
bear is go sleep !
src/toy/cube/mod.rs
pub fn get_size() {
println!("size is in main");
crate::top_size(); // 必不可少的 crate 关键字
}
src/toy/mod.rs
pub mod cube;
src/main.rs
mod toy;
fn top_size() {
println!("top size one !")
}
fn main() {
toy::cube::get_size();
}
输出
size is in main
top size one !
!!强烈推荐看下面的参考做补充!!
手机扫一扫
移动阅读更方便
你可能感兴趣的文章