RUST包管理 模块系统讲解

RUST包管理 模块系统

一个经典的rust项目目录结构

一个真实项目中典型的 Package，会包含多个二进制包，这些包文件被放在 src/bin 目录下，每一个文件都是独立的二进制包，同时也会包含一个库包，该包只能存在一个 src/lib.rs：

.
├── Cargo.toml
├── Cargo.lock
├── src
│   ├── main.rs
│   ├── lib.rs
│   └── bin
│       └── main1.rs
│       └── main2.rs
├── tests
│   └── some_integration_tests.rs
├── benches
│   └── simple_bench.rs
└── examples
    └── simple_example.rs

• 唯一库包：src/lib.rs
• 默认二进制包：src/main.rs，编译后生成的可执行文件与 Package 同名
• 其余二进制包：src/bin/main1.rs 和 src/bin/main2.rs，它们会分别生成一个文件同名的二进制可执行文件
• 集成测试文件：tests 目录下
• 基准性能测试 benchmark 文件：benches 目录下
• 项目示例：examples 目录下
  这种目录结构基本上是 Rust 的标准目录结构，在 GitHub 的大多数项目上，你都将看到它的身影。

0 一些基本概念

• package：包，cargo new生成的整个项目应该可以叫做包（我个人理解是这样的，至少package是最顶层的）
  • 一个package包含零个或一个库crate（library crate）
  • 一个package可以包含任意多个binary crate
  • 一个package至少包含一个crate，因为crate是rust项目编译的基本单位
• crate：单元包，分为binary（可执行/二进制单元包）和library（库包）两种类型
  • src/main.rs：是binary crate的根，也就是主函数入口文件，cargo run的时候，默认执行这个文件
  • src/lib.rs:是library crate的根，同样也是一个主函数入口文件
  • 上面两个概念挺阴间的，更加阴间的是，cargo new XXX（包名），这时候main.rs和lib.rs也是同名为xxx的。
  • 对于多个binary文件（可执行），可以放在src/bin下，调用的时候用cargo run --bin/xxx
• module：

---

访问crate下的module

//main.rs
mod nice{
    pub fn hello(){				//pub声明为public
        println!("nice::hello");
    }
    pub fn good(){
        println!("nice::good");
    }
    //mod里面套mod
    pub mod yes{
        pub fn hello(){
            println!("nice::good::hello");
            crate::nice::good::hello();  //crate指 本文件
            super::good::hello();  	//super表示父级mod，这里也就是nice
        }
    }
}

导入别的crate文件

//已知有一个名为nice.rs的crate  或者是同级目录下有个nice文件夹，里面有mod.rs文件
//这是main.rs
use nice;
//访问nice中的mod
nice::

use关键字缩短路径

//调用同一个modulel
//一般情况调用，会很长
crate::nice::yes::hello();
//-----------------------------------------
//通过use导入本地命名空间
use crate::nice::yes::hello;
hello();   //直接调用

甚至还能用use取别名

类似import xx as xx

use crate::nice::yes::hello as hello_from_yes;
hello_from_yes();