11.使用包、Crate控制不断增长的项目

包和Crate

定义模块控制作用域与私有性

这里的使用方法有private和public两种形式

fn main() {
mod front_of_house {mod hosting {fn add_to_waitlist() {}fn seat_at_table() {}}mod serving {fn take_order() {}fn server_order() {}fn take_payment() {}}
}
}
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();
}

更倾向于使用绝对路径,而不是用相对路径,因为绝对路径中将一个mod移动之后修改较为方便。

  • Rust中默认的所有项(函数、方法、结构体、枚举、模块和常量)均为私有变量,父模块中项不能使用子模块中的私有项,但是子模块中项可以使用父模块中的项。
  • 可以使用关键命令pub将子模块中的私有变量转换为公共变量,暴露给上级变量。
  • 私有性不但作用于变量本身,而且作用于模块等等。
  • rust中同一crate中兄弟模块可以相互访问。
mod front_of_house {pub 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();
}
$ cargo buildCompiling restaurant v0.1.0 (file:///projects/restaurant)
error[E0603]: function `add_to_waitlist` is private--> src/lib.rs:9:37|
9 |     crate::front_of_house::hosting::add_to_waitlist();|                                     ^^^^^^^^^^^^^^^ private function|
note: the function `add_to_waitlist` is defined here--> src/lib.rs:3:9|
3 |         fn add_to_waitlist() {}|         ^^^^^^^^^^^^^^^^^^^^error[E0603]: function `add_to_waitlist` is private--> src/lib.rs:12:30|
12 |     front_of_house::hosting::add_to_waitlist();|                              ^^^^^^^^^^^^^^^ private function|
note: the function `add_to_waitlist` is defined here--> src/lib.rs:3:9|
3  |         fn add_to_waitlist() {}|         ^^^^^^^^^^^^^^^^^^^^For more information about this error, try `rustc --explain E0603`.
error: could not compile `restaurant` due to 2 previous errors

以上的代码则准确的说明了这个点,虽然hosting模块是公有的,但是它内部的add_to_waitlist()是私有变量,不能够直接引用。

mod 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();
}

crate中front_of_housefn eat_at_restaurant是处在crate中中的兄弟模块,可以相互调用,而不需要设置公有变量。

使用super起始的相对路径

fn serve_order()
{}mod back_of_house{fn fix_incorrect_order(){cook_order();super::serve_order();
}fn cook_order(){}
}
  • super能够在进入back_of_house的父系中使用serve_order()函数,如果这段代码被移植到新的crate中,只需要修改较短代码即可完成。

创建公有的结构体和枚举

使用pub设计公有结构体和枚举

  • 需要注意的是,尽管结构体是公有的,其中的字段仍然是私有的。
mod back_of_house
{pub struct Breakfast{pub toast:String,seasonal_fruit:String,}impl Breakfast{pub fn summer(toast: &str) -> Breakfast{Breakfast{toast: String:from(toast),seasonal_fruit:String::from("peaches"),}}
}}
pub fn eat_at_restaurant()
{let mut meal = back_of_house::Breakfast::summer("Rye");meal.toast = String::from("Wheat");println!("I'd like {} toast please",meal.toast);}

带有公有和私有字段的结构体,toast是公有字段,而私有字段则不行。

  • 结构体中私有和公有设置如上段代码所示,而枚举中则不同,枚举设置为公有之后全部都是公有。
mod back_of_house
{	pub enum Appetizer{Soup,Salad,}
}pub fn eat_at_restaurant()
{let order1 = back_of_house::Appetizer::Soup;let order2 = back_of_house::Appetizer::Salad;}		
  • 公有枚举会使所有成员变成公有,枚举中的成员默认是公有的,而结构体中默认是私有的,只有添加公有关键字才会变成公有。

use关键字将名称引入作用域

  • use关键字可以改写相对路径和绝对路径的冗杂性。
  • 只需要指定对应的模组即可在这个模组中使用相应的函数。
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字段相当于在文件系统中添加软连接(symbolic link),这就相当于将hosting添加到crate根目录中,这段文件也会检查它本身的私有特性。
  • use同时可以使用相对路径添加文件到crate根目录。
mod front_of_house
{pub mod hosting{pub fn add_to_waitlist(){}}
}
use front_of_house::hosting;pub fn eat_at_restaurant()
{hosting::add_to_waitlist();hosting::add_to_waitlist();hosting::add_to_waitlist();
}
  • 这两种方式分别以绝对路径和相对路径引入到作用域。

创建惯用的use路径

  • 创建惯用的use路径一般是将mod模块引入到路径中,而不是将直接引入到函数下面,这样一方面是为了满足明确表明函数的定义位置。
  • 同时,在use使用结构体、枚举和其他项的时候,习惯表示出他们的完整路径。
    文件main.rs
use std::collections::HashMap;
fn main()
{let mut map = HashMap::new();map.inserrt(1,2);
}

文件lib.rs

use std::io;
use std::fmt;fn function1() -> fmt::Result{
}
fn function2() -> io::Result<()>
{}
  • Rust使用父模块区别这两个Result类型,但是在使用的时候则不知道我们要使用哪个Result,这个时候就要使用as关键字

使用as关键字提供新名称

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

*建议使用Result的第二种方法进行处理,重命名有助于理解函数。

使用pub use重导出名称

  • 结合pub和use引用可以让外部代码也可以使用作用域中的函数。
    src/lib.rs
mod front_of_house
{pub mod hosting{pub fn add_to_waitlist(){}}
}
pub use crate::front_of_house::hosting;pub fn eat_at_restaurant()
{hosting::add_to_waitlist();//snip!
}

这段代码则是利用了pub use,这样不仅可以在eat_at_restaurant中使用,同时也可以在其外部使用,如果仅仅使用use,则不可能。

接着是一段官方文档
在这里插入图片描述

use路径的简化

  • 在使用同一个路径的不同包之下,可以进行下面的简化:
fn main() {
use std::cmp::Ordering;
use std::io;
// ---snip---
}

简化成为:

use std::{cmp::Ordering,io};
//snip!
use std::io;
use std::io::Write;

简化成为:

use std::io{self,Write};
  • 这段话中self和之前结构体中的语法相同,代表自己本身。

通过glob运算符引进公有定义到作用域

  • 这里的glob运算符是*,这会将所有的公有项引入到作用域
use std::collections::*;

使用glob时应该谨慎,因为这会造成代码阅读的不方便性,无法得知代码的父系是哪里

将模块分割进不同的文件

  • 当模块较大的时候,就需要对模块进行分割,定义到单独的文件中。
  • 这里直接使用官方文档

在这里插入图片描述
在这里插入图片描述

  • 这两种方式的使用方法能够极大清晰代码,同时也能够对代码中的分级关系较为清楚。
  • 在这里插入图片描述
    注意:cargo run命令不能够直接运行这段代码。原因如上,使用cargo test可以


本文来自互联网用户投稿,文章观点仅代表作者本人,不代表本站立场,不承担相关法律责任。如若转载,请注明出处。 如若内容造成侵权/违法违规/事实不符,请点击【内容举报】进行投诉反馈!

相关文章

立即
投稿

微信公众账号

微信扫一扫加关注

返回
顶部