【Rust】use关键字妙用|模块内容拆分
前言
书接上文,本篇补充rust 组织管理中模块的细节知识,比如模块拆分。此外介绍use关键字的习惯用法,快速引用自定义模块内容或标准库,以此优化代码书写。
1、rust 中的use关键字
如果我说use
与C/C++中的include
或者是java、python中的import
用法类似,想必此时的你定是头一歪,脑子里蹦出两个字——拿捏。没错,看完本篇文章心里会更加敞亮,变得自信满满。
1.1、将模块标识符引入当前作用域
- use 关键字能够将模块标识符引入当前作用域
- 但是谨记引入的时候也遵循
私有权限
的原则
例如:
mod front_of_house{ pub mod hosting{ pub fn add_to_waitlist(){} fn some_fun(){} } } use crate::front_of_house::hosting; pub fn eat_at_restaurant(){ hosting::add_to_waitlist(); hosting::add_to_waitlist(); hosting::some_fun(); }//这里并不能使用some_fun()函数,是报错内容
我们可以看到
front_of_house
模块中嵌套了一个公共模块hosting
,但是我们知道公共模块里的内容也需要有pub
修饰才能被调用。因此没有加pub关键字的第二个函数无法被调用,这就是遵循私有权限的体现。
1.2、use特点与习惯用法
我们习惯这样使用 use:
- 不直接引入具体的函数或者方法
- 我们可以这样引入具体函数:
use crate::front_of_house::hosting::add_to_waitlist;
- 当代码比较多的时候,我们很难区分一个函数是本地自定义还是引用,因此不具体引用
- 我们可以这样引入具体函数:
- 引用函数或者方法最近的父模块
- 不必引用最外层,以免代码冗余
- 对于
struct
、enum
等函数以外的内容需要指定到完整路径(本身)- 引入过后直接使用即可
例如:
use std::collections::HashMap; fn main() { let mut map=HashMap::new(); map.insert(1, 2); println!("{:?}",map); } //打印结果:{1,2}
- 如果一个类型在不同的模块中都有,那么就要引入到父模块(同名条目)
例如:
use std::fmt; use std::io; fn f1()->fmt::Result{} fn f2()->io ::Result{}
- 针对同名条目可以使用
as
关键字来重命名类型- 指定到完整路径,给其中一个改名即可
例如:
use std::fmt::Result; use std::io::Result as IOResult; fn f1()-> Result<>{} fn f2()-> IOResult<>{}
1.3、使用pub use 重新导出名称
- 使用 use 将路径(名称)导入到作用域后,该名称在此作用域默认是私有的,外部无法访问
- pub use:重导出
- 将条目引入作用域
- 该条目可以被外部代码引入到自己的作用域
1.4、使用外部包(package)以及标准库
- Cargo.toml 添加依赖的包
- 通过该网站自动下载资源:
https://crates.io/
- 但是默认网站是在国外,需要更换国内镜像
- 这些内容在此专栏有文章讲的比较详细,不理解可以去翻阅一下
- 通过该网站自动下载资源:
- 使用
use
将特定条目引入作用域 - 标准库(std)也被当作外部包
- 无需修改
Cargo.toml
来包含std
- 但是需要用 use 将 std 中的特定条目引入到当前作用域
- 无需修改
1.5、使用嵌套路径清理大量 use 语句
当使用同一个包或模块下的多个条目时:
- 使用嵌套路径在同一行内将多个条目引入
- 路径相同的部分
::
{路径差异的部分}
- 路径相同的部分
例如:
use std::io; use std::cmp::Ordering; use std::{io,cmp::Ordering}; //前两行可用最后一行替代
- 如果包含自身,需要使用
self
例如:
use std::io; use std::io::Write; use std::io::{self,Write}; //依然是最后一行可替换前两行
1.6、通配符 *
- 使用
*
可以把路径中所有的公共条目都引入到作用域 - 需要谨慎使用,作用场景:
- 测试:将所有被测试代码引入到
tests
模块(后续文章会有) - 有时被用于预导入(prelude)模块
- 测试:将所有被测试代码引入到
2、模块内容拆分
将模块拆分为不同文件:
- 模块定义时,如果模块名后面是
;
而不是代码块:- Rust 会从与模块同名的文件中加载内容,例如:
此时的lib.rs
里不会报错,编译器看到mod front_of_house;
会在根目录src
处找到front_of_house
文件夹里的hosting.rs
文件,使用pub use
将函数引入到当前作用域(必须严格按照图示建立文件夹和文件) - 模块树的结构不会发生变化
- Rust 会从与模块同名的文件中加载内容,例如:
- 随着模块逐渐变大,该技术让你可以把模块的内容移动到其他文件中
到这里 rust 的组织管理算是彻底告一段落了,这块内容不多,但是理解起来还是要下点功夫的。如果感到有帮助就多多支持一下博主吧,让我保持创作的动力!