学习 Rust 的第十一天:如何使用模块

2024-04-25 11:28

本文主要是介绍学习 Rust 的第十一天:如何使用模块,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

大家好,

今天是学习 Rust 的第 11 天,今天我们来看看 Rust 的模块系统。我们可以利用这个系统来管理不断增长的项目,并跟踪各个模块的存储位置。

介绍

在 Rust 中,模块系统通过将相关函数、类型和其他项目分组来帮助保持代码组织良好,从而更容易管理和重用项目中的代码。

例如:

假设你的一部分代码是用于管理数据库,你并不希望它被图像渲染器访问。所以我们将它们存储在不同的位置,不同的 modules 中。

我们可以使用 use 关键字来访问不同 modules 的特定部分。

当我们运行 cargo new 命令时,我们实际上正在创建一个包,而包存储着 crates。有两种类型的 crates:

  1. 二进制 crate:可以直接执行
  2. 库 crate:可以被其他程序/包使用

每个 crate 都存储着模块,这些模块组织了代码并控制了 Rust 程序的私密性。

让我们深入了解一下。

通过运行以下命令创建一个新的包:

$ cargo new module_system  
$ cd module_system  
$ ls  
Cargo.toml  
src/

查看 Cargo.toml 文件,我们可以看到:

[package]  
name = "module_system"  
version = "0.1.0"  
edition = "2021"  [dependencies]  

根据 Rust 的约定,我们在这个文件中看不到任何 crates,但是我们确实有一个 main.rs 文件。这意味着在我们的包中默认有一个名为 module_system 的二进制 crate。

如果在我们的 src 目录中有 lib.rs 文件,库 crate 也会遵循同样的约定,它将自动创建一个名为 module_system 的库 crate。

包和 crate 的规则

  1. 一个包至少必须有一个 crate。
  2. 一个包可以包含 0 个库 crate 或 1 个库 crate。
  3. 一个包可以有 n 个二进制 crates。

模块

模块是使用 mod 关键字定义的库 crate。它们用于更好地结构化 Rust 应用程序,让我们通过一个示例更好地理解它。

要创建一个库 crate,我们可以使用以下命令

cargo new --lib user
//文件:src/lib.rs  mod user{  mod authentication{  fn create_account(){}  fn login(){}  fn forgot_password(){}  }  mod edit_profile{  fn change_username(){}  fn chang_pfp(){}  fn change_email(){}  }  
}

这就是一个模块会是什么样子。

一个模块可以包含多个子模块,在一个模块内部我们可以定义结构体、枚举、函数等。

这种方法在管理和维护代码库方面非常有用。未来,如果我们需要更改 forgot_password 函数的某个特定部分,我们将准确地知道在哪里找到它…

调用模块中的函数

假设我想要在我的服务中注册一个新用户,并且需要使用 create_account 函数。我该如何调用它呢?

//文件:src/lib.rs  mod user{  pub mod authentication{  pub fn create_account(){}  fn login(){}  fn forgot_password(){}  }  mod edit_profile{  fn change_username(){}  fn chang_pfp(){}  fn change_email(){}  }  
}  pub fn call_module_function(){  //绝对路径  crate::user::authentication::create_account();  //相对路径  user::authentication::create_account();  
}

我们为我们的 authentication 模块和 create_account 函数添加了 pub 关键字,因为默认情况下它是 private 的,不能被调用,因为模块私密性规则的存在

相对路径 指的是在同一模块层次结构中访问模块或项而不指定根路径,而 绝对路径 指的是通过指定根模块或 crate 来访问它们。

作为参考,这里是模块层次结构的示意图…

super 关键字也可以用于相对调用函数,super 允许我们引用父模块…

示例

mod parent_module {  pub fn parent_function() {  println!("This is a function in the parent module.");  }  
}  mod child_module {  // 使用 `super` 从父模块导入 `parent_function`  use super::parent_module;  pub fn child_function() {  println!("This is a function in the child module.");  // 使用 `super` 调用父函数  parent_module::parent_function();  }  
}  fn main() {  // 调用子函数,进而调用父函数  child_module::child_function();  
}

模块私密性规则

模块具有控制哪些项(如结构体、函数和变量)可见或可访问的私密性规则。

这些规则有助于实施封装,并防止意外访问模块内部细节。

mod my_module {  // 公有结构体  pub struct PublicStruct {  pub public_field: u32,  }  // 私有结构体  struct PrivateStruct {  private_field: u32,}  // 创建 `PrivateStruct` 实例的公有函数  pub fn create_private_struct() -> PrivateStruct {  PrivateStruct { private_field: 42 }  }  
}  fn main() {  // 从外部模块创建 PublicStruct 实例是允许的  let public_instance = my_module::PublicStruct { public_field: 10 };  println!("Public field of PublicStruct: {}", public_instance.public_field);  // 从外部模块创建 PrivateStruct 实例是不允许的  // let private_instance = my_module::PrivateStruct { private_field: 20 }; // 这将导致编译时错误  // 不允许访问 PublicStruct 的私有字段  // println!("Private field of PublicStruct: {}", public_instance.private_field); // 这将导致编译时错误  // 但是,我们可以使用提供的公有函数创建和访问 PrivateStruct 的实例  let private_instance = my_module::create_private_struct();  // println!("Private field of PrivateStruct: {}", private_instance.private_field); // 这将导致编译时错误  
}
  • Rust 的模块系统允许将代码组织成逻辑单元。
  • Rust 模块中的可见性和访问控制通过私密性规则实施。
  • 在 Rust 中,项(如结构体、函数和变量)可以在模块内部标记为公有或私有。
  • 公有项可以从模块外部访问,而私有项则不行。
  • 公有项通常使用 pub 关键字标记,而私有项则没有显式标记。
  • 私有项只能在定义它们的模块内部访问,促进封装并隐藏实现细节。
  • pub 关键字用于使项在模块外部可见,允许它们被代码库的其他部分使用。
  • Rust 中的 super 关键字允许访问父模块中的项,便于在 crate 中进行分层组织和访问控制。

Use 关键字

use 关键字允许将路径引入作用域,这样你就不必一遍又一遍地指定路径了,让我们来看看我们之前的例子。


//文件:src/lib.rs  mod user{  pub mod authentication{  pub fn create_account(){}  fn login(){}  fn forgot_password(){}  }  mod edit_profile{  fn change_username(){}  fn chang_pfp(){}  fn change_email(){}  }  
}  //将模块添加到我们的作用域中  
use crate::user::authentication;  pub fn call_module_function(){  //我们可以直接调用它们,而不是这样  //crate::user::authentication::create_account();  //user::authentication::create_account();  authentication::create_account();  
}

嵌套路径

mod outer_module {  pub mod inner_module {  pub fn inner_function() {  println!("This is an inner function.");  }  pub struct InnerStruct {  pub value: i32,  }  }  
}  use outer_module::inner_module::inner_function;  
use outer_module::inner_moduel::InnerStruct;  fn main() {  // 调用内部函数  inner_function();  // 创建 InnerStruct 的实例  let inner_struct_instance = InnerStruct { value: 42 };  println!("Value of inner struct: {}", inner_struct_instance.value);  
}

注意两个 use 语句都以 outer_module::inner_module:: 开头

我们可以通过以下方式嵌套两个 use 语句:

use outer_module::inner_module::{inner_function, InnerStruct};

分离文件中的模块

为了更好地跟踪我们的项目并更好地组织它,我们可以将不同的模块存储在不同的文件中。让我们将 authentication 模块做到这一点。


mod user{  pub mod authentication{  pub fn create_account(){}  fn login(){}  fn forgot_password(){}  }  mod edit_profile{  fn change_username(){}  fn chang_pfp(){}  fn change_email(){}  }  
}

步骤 1:在 src/ 目录中创建与模块名相同的文件,在我们的情况下是 authentication.rs

步骤 2:将所有函数复制到该文件中,但保留模块声明


//文件:src/authentication.rs  
pub fn create_account(){}  
fn login(){}  
fn forgot_password(){}//文件:src/lib.rs  
mod user{  pub mod authentication; //将花括号改为分号  mod edit_profile{  fn change_username(){}  fn chang_pfp(){}  fn change_email(){}  }  
}

这样做的效果是,编译器会查找与模块名相同的文件,并将所有函数和其他数据放入该模块。

我们也可以对父模块做同样的操作…

结论

总之,Rust 的模块系统是一个有效的工具,用于将代码组织成逻辑片段,从而实现代码的维护和重用。模块支持分层组织、私密性管理和代码封装。Rust 通过诸如 use 关键字、嵌套路径和将模块划分为独立文件等功能,为开发人员提供了多功能且可扩展的方法来管理项目复杂性。

这篇关于学习 Rust 的第十一天:如何使用模块的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!


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

相关文章

postgresql使用UUID函数的方法

《postgresql使用UUID函数的方法》本文给大家介绍postgresql使用UUID函数的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录PostgreSQL有两种生成uuid的方法。可以先通过sql查看是否已安装扩展函数,和可以安装的扩展函数

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter

MySQL中比较运算符的具体使用

《MySQL中比较运算符的具体使用》本文介绍了SQL中常用的符号类型和非符号类型运算符,符号类型运算符包括等于(=)、安全等于(=)、不等于(/!=)、大小比较(,=,,=)等,感兴趣的可以了解一下... 目录符号类型运算符1. 等于运算符=2. 安全等于运算符<=>3. 不等于运算符<>或!=4. 小于运

使用zip4j实现Java中的ZIP文件加密压缩的操作方法

《使用zip4j实现Java中的ZIP文件加密压缩的操作方法》本文介绍如何通过Maven集成zip4j1.3.2库创建带密码保护的ZIP文件,涵盖依赖配置、代码示例及加密原理,确保数据安全性,感兴趣的... 目录1. zip4j库介绍和版本1.1 zip4j库概述1.2 zip4j的版本演变1.3 zip4

Python 字典 (Dictionary)使用详解

《Python字典(Dictionary)使用详解》字典是python中最重要,最常用的数据结构之一,它提供了高效的键值对存储和查找能力,:本文主要介绍Python字典(Dictionary)... 目录字典1.基本特性2.创建字典3.访问元素4.修改字典5.删除元素6.字典遍历7.字典的高级特性默认字典

使用Python构建一个高效的日志处理系统

《使用Python构建一个高效的日志处理系统》这篇文章主要为大家详细讲解了如何使用Python开发一个专业的日志分析工具,能够自动化处理、分析和可视化各类日志文件,大幅提升运维效率,需要的可以了解下... 目录环境准备工具功能概述完整代码实现代码深度解析1. 类设计与初始化2. 日志解析核心逻辑3. 文件处

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

C++中assign函数的使用

《C++中assign函数的使用》在C++标准模板库中,std::list等容器都提供了assign成员函数,它比操作符更灵活,支持多种初始化方式,下面就来介绍一下assign的用法,具有一定的参考价... 目录​1.assign的基本功能​​语法​2. 具体用法示例​​​(1) 填充n个相同值​​(2)

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

使用Python删除Excel中的行列和单元格示例详解

《使用Python删除Excel中的行列和单元格示例详解》在处理Excel数据时,删除不需要的行、列或单元格是一项常见且必要的操作,本文将使用Python脚本实现对Excel表格的高效自动化处理,感兴... 目录开发环境准备使用 python 删除 Excphpel 表格中的行删除特定行删除空白行删除含指定