改进rust代码的35种具体方法-类型(二十二)-最小化可见度

本文主要是介绍改进rust代码的35种具体方法-类型(二十二)-最小化可见度,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

上一篇文章 改进rust代码的35种具体方法-类型(二十一)-熟悉Cargo.toml版本使用


Rust允许将代码元素隐藏或暴露给代码库的其他部分。本项目探讨了为此提供的机制,并就应在何时何地使用它们提出建议。

可见性语法

Rust的基本可见性单位是模块。默认情况下,模块的项目(类型、方法、常量)是私有的,只能访问同一模块及其子模块中的代码。

需要更广泛可用的代码用pub关键字标记,使其向其他范围公开。对于大多数Rust语法功能,使功能pub不会自动公开内容——pub mod中的类型和功能不是公开的,也不是pub struct中的字段。然而,有几个例外情况是,将可见性应用于内容是有意义的:

  • 公开枚举会自动使类型的变体也公开(以及这些变体中可能存在的任何字段)。
  • 公开trait会自动公开该特征的方法。

因此,模块中的类型集合:

pub mod somemodule {// Making a `struct` public does not make its fields public.#[derive(Debug, Default)]pub struct AStruct {// By default fields are inaccessible.count: i32,// Fields have to be explicitly marked `pub` to be visible.pub name: String,}// Likewise, methods on the struct need individual `pub` markers.impl AStruct {// By default methods are inaccessible.fn canonical_name(&self) -> String {self.name.to_lowercase()}// Methods have to be explicitly marked `pub` to be visible.pub fn id(&self) -> String {format!("{}-{}", self.canonical_name(), self.count)}}// Making an `enum` public also makes all of its variants public.#[derive(Debug)]pub enum AnEnum {VariantOne,// Fields in variants are also made public.VariantTwo(u32),VariantThree { name: String, value: String },}// Making a `trait` public also makes all of its methods public.pub trait DoSomething {fn do_something(&self, arg: i32);}
}

允许访问pub的东西和前面提到的例外情况:

use somemodule::*;let mut s = AStruct::default();
s.name = "Miles".to_string();
println!("s = {:?}, name='{}', id={}", s, s.name, s.id());let e = AnEnum::VariantTwo(42);
println!("e = {e:?}");#[derive(Default)]
pub struct DoesSomething;
impl DoSomething for DoesSomething {fn do_something(&self, _arg: i32) {}
}let d = DoesSomething::default();
d.do_something(42);

但非pub的东西通常无法进入:

let mut s = AStruct::default();
s.name = "Miles".to_string();
println!("(inaccessible) s.count={}", s.count);
println!("(inaccessible) s.canonical_name()={}", s.canonical_name());
error[E0616]: field `count` of struct `somemodule::AStruct` is private--> src/main.rs:230:45|
230 |     println!("(inaccessible) s.count={}", s.count);|                                             ^^^^^ private field
error[E0624]: method `canonical_name` is private--> src/main.rs:231:56|
86  |         fn canonical_name(&self) -> String {|         ---------------------------------- private method defined here
...
231 |     println!("(inaccessible) s.canonical_name()={}", s.canonical_name());|                                         private method ^^^^^^^^^^^^^^
Some errors have detailed explanations: E0616, E0624.
For more information about an error, try `rustc --explain E0616`.

最常见的可见性标记是裸露的pub关键字,它使该项目对任何能够看到它所在的模块的东西可见。最后一个细节很重要:如果asomecratesomecrate::somemodule模块首先对其他代码不可见,那么它里面的任何pub仍然不可见。

然而,pub也有一些更具体的变体,允许限制可见性的范围。按有用性降序排列,如下所示:

如果您有一个对模块私有但未在该模块(及其子模块)中使用的代码项,Rust编译器将警告您:

pub mod anothermodule {// Private function that is not used within its module.fn inaccessible_fn(x: i32) -> i32 {x + 3}
}

虽然警告表示代码在其拥有的模块中“从未使用过”,但在实践中,此警告通常表明代码不能从模块外部使用,因为可见性限制不允许:

warning: function `inaccessible_fn` is never used--> src/main.rs:56:8|
56 |     fn inaccessible_fn(x: i32) -> i32 {|        ^^^^^^^^^^^^^^^|= note: `#[warn(dead_code)]` on by default

可见性语义

与如何提高知名度的问题不同,是何时这样做的问题。对此普遍接受的答案尽可能少,至少对于任何将来可能被使用和重复使用的代码。

提出这个建议的第一个原因是,可见性的变更很难撤销。一旦一个 crate 项是公共的,就不能再将其设置为私有,否则会破坏使用 crate 的任何代码,从而需要进行主要版本的升级。相反,事实并非如此:将私人项目移动为公共项目通常只需要一个次要版本颠簸,并且不会让板条箱用户不受影响——阅读Rust的API兼容性指南,并注意只有当有pub项目在起作用时,才会注意到有多少是相关的。

一个更重要但更微妙的偏爱隐私的理由是,它让你的选择保持开放。暴露的东西越多,未来需要固定的东西就越多(没有不兼容的变化)。如果您公开数据结构的内部实现细节,那么未来使用更高效算法的假定更改将成为突破性更改。如果您公开内部助手函数,一些外部代码将不可避免地取决于这些函数的确切细节。

当然,这只适用于可能具有多个用户且寿命较长的库代码。但没有什么比临时解决方案更永久的了,所以这是一个好习惯。

同样值得注意的是,这种限制可见性的建议绝不是这个项目或Rust所独有的:

这篇关于改进rust代码的35种具体方法-类型(二十二)-最小化可见度的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1064071

相关文章

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

C++使用printf语句实现进制转换的示例代码

《C++使用printf语句实现进制转换的示例代码》在C语言中,printf函数可以直接实现部分进制转换功能,通过格式说明符(formatspecifier)快速输出不同进制的数值,下面给大家分享C+... 目录一、printf 原生支持的进制转换1. 十进制、八进制、十六进制转换2. 显示进制前缀3. 指

MySQL 中查询 VARCHAR 类型 JSON 数据的问题记录

《MySQL中查询VARCHAR类型JSON数据的问题记录》在数据库设计中,有时我们会将JSON数据存储在VARCHAR或TEXT类型字段中,本文将详细介绍如何在MySQL中有效查询存储为V... 目录一、问题背景二、mysql jsON 函数2.1 常用 JSON 函数三、查询示例3.1 基本查询3.2

使用Python实现全能手机虚拟键盘的示例代码

《使用Python实现全能手机虚拟键盘的示例代码》在数字化办公时代,你是否遇到过这样的场景:会议室投影电脑突然键盘失灵、躺在沙发上想远程控制书房电脑、或者需要给长辈远程协助操作?今天我要分享的Pyth... 目录一、项目概述:不止于键盘的远程控制方案1.1 创新价值1.2 技术栈全景二、需求实现步骤一、需求

Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码

《Java中Date、LocalDate、LocalDateTime、LocalTime、时间戳之间的相互转换代码》:本文主要介绍Java中日期时间转换的多种方法,包括将Date转换为LocalD... 目录一、Date转LocalDateTime二、Date转LocalDate三、LocalDateTim

jupyter代码块没有运行图标的解决方案

《jupyter代码块没有运行图标的解决方案》:本文主要介绍jupyter代码块没有运行图标的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录jupyter代码块没有运行图标的解决1.找到Jupyter notebook的系统配置文件2.这时候一般会搜索到

Python通过模块化开发优化代码的技巧分享

《Python通过模块化开发优化代码的技巧分享》模块化开发就是把代码拆成一个个“零件”,该封装封装,该拆分拆分,下面小编就来和大家简单聊聊python如何用模块化开发进行代码优化吧... 目录什么是模块化开发如何拆分代码改进版:拆分成模块让模块更强大:使用 __init__.py你一定会遇到的问题模www.

Pydantic中Optional 和Union类型的使用

《Pydantic中Optional和Union类型的使用》本文主要介绍了Pydantic中Optional和Union类型的使用,这两者在处理可选字段和多类型字段时尤为重要,文中通过示例代码介绍的... 目录简介Optional 类型Union 类型Optional 和 Union 的组合总结简介Pyd

Oracle数据库常见字段类型大全以及超详细解析

《Oracle数据库常见字段类型大全以及超详细解析》在Oracle数据库中查询特定表的字段个数通常需要使用SQL语句来完成,:本文主要介绍Oracle数据库常见字段类型大全以及超详细解析,文中通过... 目录前言一、字符类型(Character)1、CHAR:定长字符数据类型2、VARCHAR2:变长字符数