【rust】10 project、crate、mod、pub、use、项目目录层级组织、概念和实战


文章目录

  • 一、项目目录层级组织概念
    • 1.1 cargo new 创建同名 的 Project 和 crate
    • 1.2 多 crate 的 package
    • 1.3 mod 模块
      • 1.3.1 创建嵌套 mod
      • 1.3.2 mod 树
      • 1.3.3 用路径引用 mod
        • 1.3.3.1 使用绝对还是相对?
      • 1.3.4 代码可见性
        • 1.3.4.1 pub 关键字
        • 1.3.4.2 用 super 引用 mod
        • 1.3.4.3 用 self 引用 mod
      • 1.3.5 struct 和 enum 的可见性
      • 1.3.6 把 mod 和文件分离: 拆分到单独文件或文件夹中
        • 1.3.6.1 拆分到单独的文件中
        • 1.3.6.2 拆分到单独的文件夹中
    • 1.4 use
      • 1.4.1 基本引入方式
        • 1.4.1.1 绝对路径引入 mod
        • 1.4.1.2 相对路径引入 mod 中的 fn
        • 1.4.1.3 引入 mod 还是 fn
      • 1.4.2 避免同名引入
        • 1.4.2.1 模块::函数
        • 1.4.2.2 as 别名引用
      • 1.4.3 引入项再导出
      • 1.4.4 使用第三方 crate
      • 1.4.5 用 {} 简化引用方式
        • 1.4.5.1 self
      • 1.4.6 用 * 引入 mod 下的所有项
      • 1.4.7 受限的可见性
        • 1.4.7.1 限制可见性语法
        • 1.4.7.2 一个综合例子
  • 二、目录层级实战
    • 2.1 单文件拆分为 services, clients, utils 等多个 mod

一、项目目录层级组织概念

cargo new 出来的是 Project 项目

project 中有多个 crate 包

crate 包有多个 mod 模块组成

1.1 cargo new 创建同名 的 Project 和 crate

通过 cargo new my-project 会创建一个 my-project 的 Project, 同时会创建一个同名(即 my-project) 的 crate. 该 crate 的根文件是 src/main.rs 如下所示:

src
├── main.rs
Cargo.toml# cargo r
Hello, world!

通过 cargo new my-lib --lib 会创建一个 my-lib 的 Project, 同时会创建一个同名(即 my-lib) 的 crate. 该 crate 的根文件是 src/lib.rs, 如下所示:

src
├── lib.rs
Cargo.toml# cargo r
error: a bin target must be available for `cargo run`

所以 Package 和 crate 容易混淆, 是因为用 cargo new 创建的是同名的.

1.2 多 crate 的 package

真实项目会包含多个 crate, 只能有一个 lib crate, 可以有多个 bin crate. 组织层级如下:

.
├── 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

说明如下:

  • 唯一 lib crate: src/lib.rs
  • 默认 bin crate: src/main.rs, 编译后生成和 Package 同名的 可执行程序
  • 其他 bin crate: src/bin/main1.rs, src/bin/main2.rs, 分别生成一个和文件同名的 可执行程序
  • 集成测试: tests 目录
  • 性能测试: benches 目录
  • 示例: examples 目录

1.3 mod 模块

用 mod 可以拆分代码, 按功能重组, 更易于维护.

1.3.1 创建嵌套 mod

cargo new --lib restaurant
src
└── lib.rs// lib.rs 内容如下
// 餐厅前台, 用于吃饭
mod front_of_house {// 招待客人mod hosting {fn add_to_waitlist() {}fn seat_at_table() {}}// 服务mod serving {fn take_order() {}fn serve_order() {}fn take_payment() {}}
}// 上述代码创建了三个 mod
// 用 mod 关键字可以创建新 mod
// mod 可以嵌套, 因为 招待客人 和 服务 都发生在前台, 所以嵌套, 模拟了真实场景
// mod 里定义了各种 rust 类型, 如fn, struct, enum, trait
// 所有 mod 都定义在同一个文件中

类似上述代码中所做的,使用模块,我们就能将功能相关的代码组织到一起,然后通过一个模块名称来说明这些代码为何被组织在一起。这样其它程序员在使用你的模块时,就可以更快地理解和上手。

1.3.2 mod 树

因为 src/main.rs 和 src/lib.rs 这两个文件形成了两个 crate. 而且这两个文件是 crate root (即 mod 树的顶层).

如上例, lib.rs 中的其他三个 mod 成为了 mod 树的子模块. 例如 hosting 是 add_to_waitlist 的 父.

crate└── front_of_house├── hosting│   ├── add_to_waitlist│   └── seat_at_table└── serving├── take_order├── serve_order└── take_payment

1.3.3 用路径引用 mod

想要调用一个函数,就需要知道它的路径,在 rust 中,这种路径有两种形式:

  • 绝对路径: 从 crate root 开始, 路径名以 package 名 或 crate 名, 作为开头.
  • 相对路径: 从 当前 mod 开始, 路径名以 self, super, 或当前 mod 的标识符, 作为开头.

示例如下, 添加如下功能:

// 餐厅前台, 用于吃饭
mod front_of_house {// 招待客人pub mod hosting {pub fn add_to_waitlist() {}fn seat_at_table() {}}// 服务mod serving {fn take_order() {}fn serve_order() {}fn take_payment() {}}
}pub fn eat_at_resturant() {// 绝对路径crate::front_of_house::hosting::add_to_waitlist(); // 需要如下 pub 权限: pub mod hosting, pub fn add_to_waitlist// 相对路径front_of_house::hosting::add_to_waitlist();self::front_of_house::hosting::add_to_waitlist();
}
1.3.3.1 使用绝对还是相对?

都可以, 视情况而定. 原则是: 当代码被挪动位置时,尽量减少引用路径的修改.

  • 如果原来用的是绝对路径, 但现在 front_of_house 的绝对路径变了, 那得改. (例如把 front_of_house 模块和 eat_at_restaurant 移动到一个模块 customer_experience中)
crate└── customer_experience└── eat_at_restaurant└── front_of_house├── hosting│   ├── add_to_waitlist│   └── seat_at_table
  • 如果原来用的是相对路径, 但现在 eat_at_resturant 的绝对路径变了, 那也得改. (例如把 eat_at_restaurant 移动到模块 dining 中)
crate└── dining└── eat_at_restaurant└── front_of_house├── hosting│   ├── add_to_waitlist

如果不确定哪个更好, 可以优先考虑用绝对路径, 因为调用的地方, 和定义的地方, 往往是分离的, 而定义的地方较少的会变动.

1.3.4 代码可见性

mod front_of_house {mod hosting {fn add_to_waitlist() {}}
}pub fn eat_at_restaurant() {// Absolute pathcrate::front_of_house::hosting::add_to_waitlist();// Relative pathfront_of_house::hosting::add_to_waitlist();
}

上述代码意料之外的报错了, hosting 不是 pub 的, 不可见.

error[E0603]: module `hosting` is private--> src/main.rs:13:28|
13 |     crate::front_of_house::hosting::add_to_waitlist();|                            ^^^^^^^  --------------- function `add_to_waitlist` is not publicly re-exported|                            ||                            private module|
note: the module `hosting` is defined here--> src/main.rs:6:5|
6  |     mod hosting {|     ^^^^^^^^^^^For more information about this error, try `rustc --explain E0603`.
error: could not compile `my-project` (bin "my-project") due to 1 previous error

但为什么 mod front_of_house {} 可以访问呢? 是因为它和 fn eat_at_restaurant() 在同一个 crate root 作用域内. 同一个 mod 内的代码自然不存在可见性问题(所以我们之前的代码都没报过这个错误)

mod 不仅对组织代码很有用, 还能定义代码的可见性, 默认所有类型都是 private 的(fn, struct, enum, 甚至包括 mod).

重要的一点是: 在 rust 中, 父无法访问子, 但是子可以访问父. 即父 mod 完全无法访问 子 mod 的任何 private 项, 但是 子 mod 却可以访问 父 mod, 父父 mod 的 private 项.

1.3.4.1 pub 关键字

如果只改 hosting 为 pub, 还是会报错

mod front_of_house {pub mod hosting {fn add_to_waitlist() {}}
}// cargo r
error[E0603]: function `add_to_waitlist` is private--> src/lib.rs:12:30|
12 |     front_of_house::hosting::add_to_waitlist();|                              ^^^^^^^^^^^^^^^ private function

所以, mod 的可见性还不够, 还需要把 add_to_waitlist 标记为 pub. 这是因为 mod 的可见性, 仅仅是允许其他 mod 去引用它, 并不代表 mod 内部项的可见性. 如果想引用它的内部项, 还需要把对应的内部项也标记为 pub.

实际项目中, 一个 mod 需要对外暴露的 数据 和 fn, 往往非常少, 所以 rust 是这样设计的.

所以改为如下, 即可通过编译

fn main() {println!("Hello, world!");
}mod front_of_house {pub mod hosting { // pubpub fn add_to_waitlist() {} // pub}
}pub fn eat_at_restaurant() {// Absolute pathcrate::front_of_house::hosting::add_to_waitlist();// Relative path// front_of_house::hosting::add_to_waitlist();
}
1.3.4.2 用 super 引用 mod

在 用路径引用mod 中,我们提到了相对路径有三种方式开始:selfsupercrate 或者模块名,其中第三种在前面已经讲到过,现在来看看通过 super 的方式引用模块项。

super 是父 mod, 示例如下:

fn serve_order() {}// 厨房模块
mod back_of_house {fn fix_incorrect_order() {cook_order();super::serve_order();}fn cook_order() {}
}

嗯,我们的小餐馆又完善了,终于有厨房了!看来第一个客人也快可以有了。。。在厨房模块中,使用 super::serve_order 语法,调用了父模块(包根)中的 serve_order 函数。

那么你可能会问,为何不使用 crate::serve_order 的方式?额,其实也可以,不过如果你确定未来这种层级关系不会改变,那么 super::serve_order 的方式会更稳定,未来就算它们都不在包根了,依然无需修改引用路径。所以路径的选用,往往还是取决于场景,以及未来代码的可能走向。

1.3.4.3 用 self 引用 mod

self 其实就是引用自身模块中的项,也就是说和我们之前章节的代码类似,都调用同一模块中的内容,区别在于之前章节中直接通过名称调用即可,而 self,你得多此一举:

fn serve_order() {self::back_of_house::cook_order();back_of_house::cook_order();
}mod back_of_house {fn fix_incorrect_order() {cook_order();crate::serve_order();}pub fn cook_order() {}
}

是的,多此一举,因为完全可以直接调用 back_of_house,但是 self 还有一个大用处,在下一节中我们会讲。

1.3.5 struct 和 enum 的可见性

为何要把 struct 和 enum 的可见性单独拎出来讲呢?因为这两个家伙的成员字段拥有完全不同的可见性:

  • 将 struct 设置为 pub,但它的所有字段依然是私有的
  • 将 enum 设置为 pub,它的所有字段也将对外可见

原因在于,struct 和 enum 的使用方式不一样。如果 enum 的成员对外不可见,那该 enum 将一点用都没有,因此 enum 成员的可见性自动跟 enum 可见性保持一致,这样可以简化用户的使用。

而 struct 的应用场景比较复杂,其中的字段也往往部分在 A 处被使用,部分在 B 处被使用,因此无法确定成员的可见性,那索性就设置为全部不可见,将选择权交给程序员。

1.3.6 把 mod 和文件分离: 拆分到单独文件或文件夹中

首先回忆一下之前的例子, 我们所有的模块都定义在 src/lib.rs 中,如下:

src
└── lib.rsmod front_of_house {pub mod hosting {pub fn add_to_waitlist() {}}
}pub fn eat_at_restaurant() {// Absolute pathcrate::front_of_house::hosting::add_to_waitlist();// Relative pathfront_of_house::hosting::add_to_waitlist();
}

但是当模块变多或者变大时,需要将模块放入一个单独的文件中,让代码更好维护。

1.3.6.1 拆分到单独的文件中

现在,把 front_of_house 前厅分离出来,放入一个单独的文件中 src/front_of_house.rs

src
├── front_of_house.rs
└── lib.rs// src/front_of_house.rs 内容如下: 
pub mod hosting {pub fn add_to_waitlist() {}
}// src/lib.rs 内容如下:
mod front_of_house; // 告诉 rust 从另一个 模块 front_of_hose 同名的文件中加载该模块的内容
pub fn eat_at_restaurant() {crate::front_of_house::hosting::add_to_waitlist(); // Absolute pathfront_of_house::hosting::add_to_waitlist(); // Relative path
}

要注意, 和之前代码中 mod front_of_house {..} 的完整模块不同, 现在的代码中, mod 的声明和实现是分离的

  • 实现是在 单独的 front_of_house.rs 文件中
  • 然后通过 mod front_of_house 这条声明语句, 从该文件中把模块加载进来
  • 所以可以认为, 模块 front_of_house 的定义还是在 src/lib.rs 中, 只不过模块的具体内容被移动到了 src/front_of_house.rs 文件中
1.3.6.2 拆分到单独的文件夹中

当一个模块有许多子模块时,我们也可以通过文件夹的方式来组织这些子模块。

例如, 上述例子中,我们可以创建一个目录 front_of_house,然后在文件夹里创建一个 mod.rs 和 hosting.rs 文件, 整体层级如下:

src
├── front_of_house
│   ├── hosting.rs
│   └── mod.rs
└── lib.rs// src/lib.rs 内容如下:
mod front_of_house; // 引用另一个 front_of_house 模块的内容(来自 front_of_house.rs 或 front_of_house 文件夹)
pub fn eat_at_restaurant() {crate::front_of_house::hosting::add_to_waitlist(); // Absolute pathfront_of_house::hosting::add_to_waitlist(); // Relative path
}// src/front_of_house/mod.rs 内容如下:
pub mod hosting; // 引用另一个 hosting 模块的内容(来自 hosting.rs 或 hosting 文件夹)// src/front_of_house/hosting.rs 内容如下:
pub fn add_to_waitlist() {} // 没有用 mod 引用别人, 自己就是自己的内容

所以, mod 关键字类似于 golang 的 package 和 import 关键字的整合

  • 像 package: 可以在同一个文件中定义 mod
  • 像 import: 可以在不同文件中引用 mod

1.4 use

如果代码中,通篇都是 crate::front_of_house::hosting::add_to_waitlist 这样的函数调用形式,我不知道有谁会喜欢,也许靠代码行数赚工资的人会很喜欢,但是强迫症肯定受不了,悲伤的是程序员大多都有强迫症。。。

因此我们需要一个办法来简化这种使用方式,在 Rust 中,可以使用 use 关键字把路径提前引入到当前作用域中,随后的调用就可以省略该路径,极大地简化了代码。

1.4.1 基本引入方式

1.4.1.1 绝对路径引入 mod
mod front_of_house {pub mod hosting {pub fn add_to_waitlist() {}}
}use crate::front_of_house::hosting;pub fn eat_at_restaurant() {hosting::add_to_waitlist();hosting::add_to_waitlist();hosting::add_to_waitlist();
}

这里,我们使用 use 和绝对路径的方式,将 hosting 模块引入到当前作用域中,然后只需通过 hosting::add_to_waitlist 的方式,即可调用目标模块中的函数,相比 crate::front_of_house::hosting::add_to_waitlist() 的方式要简单的多,那么还能更简单吗?

1.4.1.2 相对路径引入 mod 中的 fn

在下面代码中,我们不仅要使用相对路径进行引入,而且与上面引入 hosting 模块不同,直接引入该模块中的 add_to_waitlist 函数:

mod front_of_house {pub mod hosting {pub fn add_to_waitlist() {}}
}use front_of_house::hosting::add_to_waitlist;pub fn eat_at_restaurant() {add_to_waitlist();add_to_waitlist();add_to_waitlist();
}
1.4.1.3 引入 mod 还是 fn

优先使用最细粒度(引入函数、结构体等)的引用方式,如果引起了某种麻烦(例如前面两种情况),再使用引入 mod 的方式。

从使用简洁性来说,引入函数自然是更甚一筹,但是在某些时候,引入模块会更好:

  • 需要引入同一个模块的多个函数
  • 作用域中存在同名函数

例如,如果想使用 HashMap,那么直接引入该结构体是比引入模块更好的选择,因为在 collections 模块中,我们只需要使用一个 HashMap 结构体:

use std::collections::HashMap;fn main() {let mut map = HashMap::new();map.insert(1, 2);
}

1.4.2 避免同名引入

1.4.2.1 模块::函数
use std::fmt;
use std::io;fn function1() -> fmt::Result {// --snip--
}fn function2() -> io::Result<()> {// --snip--
}

上面的例子给出了很好的解决方案,使用模块引入的方式,具体的 Result 通过 模块::Result 的方式进行调用。

可以看出,避免同名冲突的关键,就是使用父模块的方式来调用,除此之外,还可以给予引入的项起一个别名。

1.4.2.2 as 别名引用

对于同名冲突问题,还可以使用 as 关键字来解决,它可以赋予引入项一个全新的名称:

use std::fmt::Result;
use std::io::Result as IoResult;fn function1() -> Result {// --snip--
}fn function2() -> IoResult<()> {// --snip--
}

如上所示,首先通过 use std::io::Result 将 Result 引入到作用域,然后使用 as 给予它一个全新的名称 IoResult,这样就不会再产生冲突:

  • Result 代表 std::fmt::Result
  • IoResult 代表 std:io::Result

1.4.3 引入项再导出

在 Rust 中,pub use 语句被用于重新导出模块中的项(如函数、结构体、枚举、trait等),使得它们可以在当前模块的父模块中被访问。这样做通常是为了创建一个更加方便的公共API,或者重新组织模块结构而不破坏现有代码。

当你在一个模块中写 pub use 时,你不仅使得项在当前模块中可用,而且允许外部代码通过当前模块的路径来访问这些项。

// 在 some_module.rs 文件中
pub mod nested_module {pub fn useful_function() {}
}// 重新导出 `useful_function`,让外部代码可以直接通过 `some_module::useful_function` 来调用。
pub use nested_module::useful_function;

在这个例子中,useful_function 原本只能通过 some_module::nested_module::useful_function 的路径来访问。通过使用 pub use,它现在也可以通过 some_module::useful_function 的路径来访问。这样做简化了函数的访问路径,对于使用该模块的外部代码来说更加方便。

示例如下:

src
├── front_of_house.rs
└── lib.rs// lib.rs 如下
mod front_of_house;
pub fn eat_at_restaurant() {front_of_house::add_to_waitlist(); // 外部包可以直接访问 front_of_house mod 的 add_to_waitlist() fn, 而不需要经过中间的 hosting 了
}// front_of_house.rs 如下
pub mod hosting {pub fn add_to_waitlist() {}
}
pub use hosting::add_to_waitlist; // 重新导出 add_to_waitlist, 使得外部包可以直接访问 front_of_house mod 的 add_to_waitlist() fn, 而不需要经过中间的 hosting 了

1.4.4 使用第三方 crate

例如以 rand crate 为例, cargo add rand

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

Rust 社区已经为我们贡献了大量高质量的第三方包,你可以在 crates.io 或者 lib.rs 中检索和使用,从目前来说查找包更推荐 lib.rs,搜索功能更强大,内容展示也更加合理,但是下载依赖包还是得用crates.io。

1.4.5 用 {} 简化引用方式

use std::io;
use std::io::Write;

可以简化为

use std::io::{self, Write};
1.4.5.1 self

上面使用到了模块章节提到的 self 关键字,用来替代模块自身,结合上一节中的 self,可以得出它在模块中的两个用途:

  • use self::xxx,表示加载当前模块中的 xxx。此时 self 可省略
  • use xxx::{self, yyy},表示,加载当前路径下模块 xxx 本身,以及模块 xxx 下的 yyy

1.4.6 用 * 引入 mod 下的所有项

对于之前一行一行引入 std::collections 的方式,我们还可以使用

use std::collections::*;

以上这种方式来引入 std::collections 模块下的所有公共项,这些公共项自然包含了 HashMap,HashSet 等想手动引入的集合类型。

当使用 * 来引入的时候要格外小心,因为你很难知道到底哪些被引入到了当前作用域中,有哪些会和你自己程序中的名称相冲突:

use std::collections::*;struct HashMap;
fn main() {let mut v =  HashMap::new();v.insert("a", 1);
}

以上代码中,std::collection::HashMap* 引入到当前作用域,但是由于存在另一个同名的结构体,因此 HashMap::new 根本不存在,因为对于编译器来说,本地同名类型的优先级更高。

在实际项目中,这种引用方式往往用于快速写测试代码,它可以把所有东西一次性引入到 tests 模块中。

1.4.7 受限的可见性

在上一节中,我们学习了可见性这个概念,这也是模块体系中最为核心的概念,控制了模块中哪些内容可以被外部看见,但是在实际使用时,光被外面看到还不行,我们还想控制哪些人能看,这就是 Rust 提供的受限可见性。

例如,在 Rust 中,包是一个模块树,我们可以通过 pub(crate) item; 这种方式来实现:item 虽然是对外可见的,但是只在当前包内可见,外部包无法引用到该 item

所以,如果我们想要让某一项可以在整个包中都可以被使用,那么有两种办法:

  • 在包根中定义一个非 pub 类型的 X(父模块的项对子模块都是可见的,因此包根中的项对模块树上的所有模块都可见)
  • 在子模块中定义一个 pub 类型的 Y,同时通过 use 将其引入到包根
mod a {pub mod b {pub fn c() {println!("{:?}",crate::X);}#[derive(Debug)]pub struct Y;}
}#[derive(Debug)]
struct X;
use a::b::Y;
fn d() {println!("{:?}",Y);
}

以上代码充分说明了之前两种办法的使用方式,但是有时我们会遇到这两种方法都不太好用的时候。例如希望对于某些特定的模块可见,但是对于其他模块又不可见:

这段代码会报错,因为与父模块中的项对子模块可见相反,子模块中的项对父模块是不可见的。这里 semisecret 方法中,a -> b -> c 形成了父子模块链,那 c 中的 J 自然对 a 模块不可见。


如果使用之前的可见性方式,那么想保持 J 私有,同时让 a 继续使用 semisecret 函数的办法是将该函数移动到 c 模块中,然后用 pub use 将 semisecret 函数进行再导出:


这段代码说实话问题不大,但是有些破坏了我们之前的逻辑,如果想保持代码逻辑,同时又只让 J 在 a 内可见该怎么办?

pub mod a {pub const I: i32 = 3;fn semisecret(x: i32) -> i32 {use self::b::c::J;x + J}pub fn bar(z: i32) -> i32 {semisecret(I) * z}pub fn foo(y: i32) -> i32 {semisecret(I) + y}mod b {pub(in crate::a) mod c {pub(in crate::a) const J: i32 = 4;}}
}

通过 pub(in crate::a) 的方式,我们指定了模块 c 和常量 J 的可见范围都只是 a 模块中,a 之外的模块是完全访问不到它们的。

1.4.7.1 限制可见性语法

pub(crate)pub(in crate::a) 就是限制可见性语法,前者是限制在整个包内可见,后者是通过绝对路径,限制在包内的某个模块内可见,总结一下:

  • pub 意味着可见性无任何限制
  • pub(crate) 表示在当前包可见
  • pub(self) 在当前模块可见
  • pub(super) 在父模块可见
  • pub(in <path>) 表示在某个路径代表的模块中可见,其中 path 必须是父模块或者祖先模块
1.4.7.2 一个综合例子
// 一个名为 `my_mod` 的模块
mod my_mod {// 模块中的项默认具有私有的可见性fn private_function() {println!("called `my_mod::private_function()`");}// 使用 `pub` 修饰语来改变默认可见性。pub fn function() {println!("called `my_mod::function()`");}// 在同一模块中,项可以访问其它项,即使它是私有的。pub fn indirect_access() {print!("called `my_mod::indirect_access()`, that\n> ");private_function();}// 模块也可以嵌套pub mod nested {pub fn function() {println!("called `my_mod::nested::function()`");}#[allow(dead_code)]fn private_function() {println!("called `my_mod::nested::private_function()`");}// 使用 `pub(in path)` 语法定义的函数只在给定的路径中可见。// `path` 必须是父模块(parent module)或祖先模块(ancestor module)pub(in crate::my_mod) fn public_function_in_my_mod() {print!("called `my_mod::nested::public_function_in_my_mod()`, that\n > ");public_function_in_nested()}// 使用 `pub(self)` 语法定义的函数则只在当前模块中可见。pub(self) fn public_function_in_nested() {println!("called `my_mod::nested::public_function_in_nested");}// 使用 `pub(super)` 语法定义的函数只在父模块中可见。pub(super) fn public_function_in_super_mod() {println!("called my_mod::nested::public_function_in_super_mod");}}pub fn call_public_function_in_my_mod() {print!("called `my_mod::call_public_funcion_in_my_mod()`, that\n> ");nested::public_function_in_my_mod();print!("> ");nested::public_function_in_super_mod();}// `pub(crate)` 使得函数只在当前包中可见pub(crate) fn public_function_in_crate() {println!("called `my_mod::public_function_in_crate()");}// 嵌套模块的可见性遵循相同的规则mod private_nested {#[allow(dead_code)]pub fn function() {println!("called `my_mod::private_nested::function()`");}}
}fn function() {println!("called `function()`");
}fn main() {// 模块机制消除了相同名字的项之间的歧义。function();my_mod::function();// 公有项,包括嵌套模块内的,都可以在父模块外部访问。my_mod::indirect_access();my_mod::nested::function();my_mod::call_public_function_in_my_mod();// pub(crate) 项可以在同一个 crate 中的任何地方访问my_mod::public_function_in_crate();// pub(in path) 项只能在指定的模块中访问// 报错!函数 `public_function_in_my_mod` 是私有的// my_mod::nested::public_function_in_my_mod();// 试一试 ^ 取消该行的注释// 模块的私有项不能直接访问,即便它是嵌套在公有模块内部的// 报错!`private_function` 是私有的// my_mod::private_function();// 试一试 ^ 取消此行注释// 报错!`private_function` 是私有的// my_mod::nested::private_function();// 试一试 ^ 取消此行的注释// 报错! `private_nested` 是私有的// my_mod::private_nested::function();// 试一试 ^ 取消此行的注释
}

二、目录层级实战

2.1 单文件拆分为 services, clients, utils 等多个 mod

main.rs 调用 service 和 util, service 调用 client, client 调用 util, 应该怎么实现呢?

实现方式如下:每个 services 模块中的函数都能够通过 crate::utilscrate::clients 调用 utilsclients 模块中的函数。main.rs 也相应地调用 services 模块中的函数。

src/
|-- main.rs
|-- clients/
|   |-- mod.rs
|-- utils/
|   |-- mod.rs
|-- services/
|   |-- mod.rs

main.rs

mod services;
mod utils;
mod clients;use clap::Parser;#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {let arg = services::Arg::parse();services::f1().await?;Ok(())
}

clients/mod.rs

use serde::Serialize;
use reqwest::StatusCode;pub async fn http_post<T: Serialize>(addr: String, body: T) -> Result<(), reqwest::Error> {// ... 函数内容保持不变
}

utils/mod.rs

pub fn parse_str_to_timestamp(date_string: &str) -> Result<i64, chrono::ParseError> {// ... 函数内容保持不变
}

service/mod.rs: 关键是 use ceate::clients 可以从 root crate 访问绝对路径

use crate::clients;
use crate::utils;#[derive(Parser, Debug, Clone)]
pub struct Arg {// ... 结构体内容保持不变
}pub async fn f1(arg: Arg) -> Result<(), sqlx::Error> {clients.a();utils.b();// ... 函数内容保持不变,确保调用 utils 和 clients 的函数
}
pub async fn f2(arg: Arg) -> Result<(), sqlx::Error> {// ... 函数内容保持不变,确保调用 utils 和 clients 的函数
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/266205.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

[MYSQL数据库]--mysql的基础知识

前言 作者&#xff1a;小蜗牛向前冲 名言&#xff1a;我可以接受失败&#xff0c;但我不能接受放弃 如果觉的博主的文章还不错的话&#xff0c;还请点赞&#xff0c;收藏&#xff0c;关注&#x1f440;支持博主。如果发现有问题的地方欢迎❀大家在评论区指正 目录 一、数据库…

linux 文本编辑命令【重点】

目录 vi&vim介绍 vim安装 vim使用 查找命令 find grep 文本编辑的命令&#xff0c;主要包含两个: vi 和 vim vi&vim介绍 作用: vi命令是Linux系统提供的一个文本编辑工具&#xff0c;可以对文件内容进行编辑&#xff0c;类似于Windows中的记事本 语法: vi file…

android开发书籍推荐,android面试复习

笼统来说&#xff0c;中年程序员容易被淘汰的原因其实不外乎三点。 1、输出能力已到顶点。这个人奋斗十来年了&#xff0c;依旧碌碌无为&#xff0c;很明显这人的天花板就这样了&#xff0c;说白了&#xff0c;天赋就这样。 2、适应能力越来越差。年纪大&#xff0c;有家庭&…

双指针问题(Java编写)

日升时奋斗&#xff0c;日落时自省 目录 一、移动零 二、盛水最多的容器 三、快乐数 四、复写零 五、三数之和 六、有效三角形的个数 七、四数之和 一、移动零 题目来源&#xff1a;. - 力扣&#xff08;LeetCode&#xff09; 题目主要内容就是将数组中所有的零移动到…

【Go-Zero】测试API查询信息无法返回数据库信息与api、rpc文件编写规范

【Go-Zero】测试API查询信息无法返回数据库信息与api、rpc文件编写规范 大家好 我是寸铁&#x1f44a; 总结了一篇测试API查询信息无法返回数据库信息与api、rpc文件编写规范的文章✨ 喜欢的小伙伴可以点点关注 &#x1f49d; 问题背景 大家好&#xff0c;我是寸铁&#xff01…

浅析扩散模型与图像生成【应用篇】(二)——ADM

2. Diffusion Models Beat GANs on Image Synthesis 该文基于扩散模型主要做了两方面的工作&#xff1a;一是通过多种方式优化改进了UNet网络结构以提升扩散模型的生成效果&#xff1b;二是提出一种类别引导的条件生成方法&#xff0c;通过在多个数据集上的实验结果表明&#x…

NerfStudio安装及第一个场景重建

NerfStudio文档是写在windows和linux上安装&#xff0c;本文记录Linux安装的过程&#xff0c;且我的cuda是11.7 创建环境 conda create --name nerfstudio -y python3.8 conda activate nerfstudio python -m pip install --upgrade pip Pytorch要求2.0.1之后的,文档推荐cud…

【论文阅读】深度学习在过冷沸腾气泡动力学分割中的应用

Application of deep learning for segmentation of bubble dynamics in subcooled boiling 深度学习在过冷沸腾气泡动力学分割中的应用 期刊信息&#xff1a;International Journal of Multiphase Flow 2023 级别&#xff1a;EI检索 SCI升级版工程技术2区 SCI基础版工程技术3区…

代码随想录刷题笔记-Day25

1. 分割回文串 131. 分割回文串https://leetcode.cn/problems/palindrome-partitioning/ 给你一个字符串 s&#xff0c;请你将 s 分割成一些子串&#xff0c;使每个子串都是 回文串 。返回 s 所有可能的分割方案。 回文串 是正着读和反着读都一样的字符串。 示例 1&#xf…

Pytorch学习 day01(Jupyter安装

Jupyter 安装过程中遇到的问题&#xff1a; Anaconda的base环境会自动安装Jupyter&#xff0c;但是如果我们要在其他环境中安装Jupyter&#xff0c;就需要注意&#xff0c;该环境的python版本不能高于3.11&#xff0c;且用以下代码安装&#xff1a; conda install nb_conda_…

部署PhotoMaker通过堆叠 ID 嵌入自定义逼真的人物照片

PhotoMaker只需要一张人脸照片就可以生成不同风格的人物照片&#xff0c;可以快速出图&#xff0c;无需额外的LoRA培训。 安装环境 python 3.10gitVisual Studio 2022 安装依赖库 git clone https://github.com/bmaltais/PhotoMaker.git cd PhotoMaker python -m venv venv…

lv19 多态 4

1 虚函数 虚函数&#xff08; 基类指针可指向派生类对象&#xff0c; 动态联编&#xff09; 先看示例&#xff0c;不加virtual&#xff0c;不认对象认指针。 #include <iostream>using namespace std;class A{ public:A(){ }~A(){ }void show(){cout<<"AAA…

江科大stm32学习笔记——【5-2】对射式红外传感器计次旋转编码计次

一.对射式红外传感器计次 1.原理 2.硬件连接 3.程序 CountSensor.c: #include "stm32f10x.h" // Device header #include "Delay.h"uint16_t CountSensor_Count;void CountSensor_Init(void) {//配置RCC时钟&#xff1a;RCC_APB2Perip…

OpenAI Triton 入门教程

文章目录 Triton 简介背景Triton 与 CUDA 的关系 Triton 开发样例样例一&#xff1a;Triton vector addition 算子Triton kernel 实现kernel 函数封装函数调用性能测试 样例二&#xff1a;融合 Softmax 算子动机Triton kernel 实现kernel 封装单元测试性能测试 样例三&#xff…

【知识整理】Git Commit Message 规范

一. 概述 前面咱们整理过 Code Review 一文&#xff0c;提到了 Review 的重要性&#xff0c;已经同过gitlab进行CodeReview 的方式&#xff0c;那么本文详细说明一下对CodeReivew非常重要的Git Commit Message 规范。 我们在每次提交代码时&#xff0c;都需要编写 Commit Mes…

会声会影2024出来了吗?

近年来&#xff0c;随着人们对于娱乐和创意的需求不断增长&#xff0c;视频编辑软件也越来越受到大众的关注。其中&#xff0c;会声会影是一款备受欢迎的视频编辑软件&#xff0c;许多用户都在关注其新版本——会声会影2024。 然而&#xff0c;目前并没有官方宣布会声会影2024的…

如何制作一款建材商城微信小程序

现在&#xff0c;微信小程序已经成为了很多企业和商家开展线上业务的重要渠道之一。对于建材商城而言&#xff0c;制作一款专属的微信小程序可以帮助企业更好地展示产品、提供服务&#xff0c;并增加销售额。下面将介绍如何制作一款建材商城微信小程序。 首先&#xff0c;登录【…

C#,动态规划(DP)金矿问题(Gold Mine Problem)的算法与源代码

1 金矿问题&#xff08;Gold Mine Problem&#xff09; 给定一个N*M尺寸的金矿&#xff0c;每个点都有一个非负数表示当前点所含的黄金数目&#xff0c;最开始矿工位于第一列&#xff0c;但是可以位于任意行。矿工只能向右&#xff0c;右上&#xff0c;右下三个方向移动。问该…

solidity编程

一.Solidity 简介 Solidity 是⼀种⽤于编写以太坊虚拟机&#xff08; EVM &#xff09;智能合约的 编程语⾔。我认为掌握 Solidity 是参与链上项⽬的必备技 能&#xff1a;区块链项⽬⼤部分是开源的&#xff0c;如果你能读懂代码&#xff0c;就可以 规避很多亏钱项⽬。…

javaweb学习(day04-XML)

一、介绍 1 官方文档 地址: https://www.w3school.com.cn/xml/index.asp 2 为什么需要 XML 需求 1 : 两个程序间进行数据通信需求 2 : 给一台服务器&#xff0c;做一个配置文件&#xff0c;当服务器程序启动时&#xff0c;去读取它应当监听的端口号、还有连接数据库的用户名…