【Rust中级教程】2.10. API设计原则之受约束性(constrained) Pt.1:对类型进行修改、`#[non_exhaustive]`注解

喜欢的话别忘了点赞、收藏加关注哦(加关注即可阅读全文),对接下来的教程有兴趣的可以关注专栏。谢谢喵!(=・ω・=)
请添加图片描述

2.10.1. 接口的更改要三思

如果你的接口要做出对用户可见的更改,那么一定要三思而后行。

你需要确保你做出的变化:

  • 不会破坏现有用户的代码
  • 这次变化应该保留一段时间

频繁推送向后不兼容的更改(主版本增加),会导致用户的不满。

2.10.2. 向后不兼容的更改

有些向后不兼容的更改是显而易见的,比如说你改变公共类型的名称,或事为它添加一个新的公共方法。

有些向后不兼容的更改则很微妙,这与Rust的工作方式息息相关。这篇文章主要讲的就是这种更改,以及你作为开发者应该如何为其制定修改计划。

在这个过程中,有时候你就需要在接口的灵活性上做出权衡与妥协。

2.10.3. 对类型进行修改

如果你移除或重命名一个公共类型几乎肯定会破坏用户的代码,解决办法就是尽可能利用可见性修饰符。比如说:

  • pub(crate):对当前这个crate可见
  • pub(in path):对指定的路径可见

看个例子:

pub mod outer_mod {
    pub mod inner_mod {
        // 该函数仅对 `outer_mod` 可见
        pub(in crate::outer_mod) fn outer_mod_visible_fn() {}

        // 该函数对整个 crate 可见
        pub(crate) fn crate_visible_fn() {}

        // 该函数仅对 `outer_mod` 可见(使用 `super` 指向外部模块)
        pub(super) fn super_mod_visible_fn() {
            // 由于 `inner_mod_visible_fn` 在相同模块内可见,可以正常调用
            inner_mod_visible_fn();
        }

        // 该函数仅对 `inner_mod` 内部可见,相当于 `private`
        pub(self) fn inner_mod_visible_fn() {}
    }

    pub fn foo() {
        inner_mod::outer_mod_visible_fn();
        inner_mod::crate_visible_fn();
        inner_mod::super_mod_visible_fn();

        // 该函数不再可见,因为我们已经在 `inner_mod` 之外
        // Error! `inner_mod_visible_fn` 是私有的
        inner_mod::inner_mod_visible_fn();
    }
}

fn bar() {
    // 这个函数仍然可见,因为我们在同一个 crate 内
    outer_mod::inner_mod::crate_visible_fn();

    // 这个函数在 `outer_mod` 之外不再可见
    // Error! `super_mod_visible_fn` 是私有的
    outer_mod::inner_mod::super_mod_visible_fn();

    // 这个函数在 `outer_mod` 之外也不可见
    // Error! `outer_mod_visible_fn` 是私有的
    outer_mod::inner_mod::outer_mod_visible_fn();

    outer_mod::foo();
}

inner_mod模块中函数的可见性控制:

  • outer_mod_visible_fn(): 仅在outer_mod内部可见,外部无法访问。
  • crate_visible_fn(): 整个crate可见,即bar()仍然可以访问它。
  • super_mod_visible_fn(): outer_mod内部可见bar()无法访问
  • inner_mod_visible_fn(): 私有,仅inner_mod 内部可见

你写的API中公共类型越少,更改时就越自由(自由指保证不会破坏现有代码)。


#[non_exhaustive]注解

用户的代码不仅仅通过名称依赖于你的类型。看个例子:

一个破坏性变更的例子

最开始在lib.rs中我写了一个结构体名叫Unit

pub struct Unit;

然后我在main.rs中使用了Unit

fn main() {
	let u = constrained::Unit;
}
  • 这没有任何问题。

后来呢,我对Unit进行了一些修改,因为用户要用:

pub struct Unit {
	pub field: bool;
}

在main.rs中代码也会变:

fn is_true(u: constrained::Unit) -> bool {
	matches!(u, constrained::Unit { field: true })
}

fn main() {
	let u = constrained::Unit; 
}
  • is_true这个函数用到了修改后Unit的字段
  • 但是main函数中本来的代码就会报错

这种情况也会在Unitfield是私有字段时发生。因为编译器知道Unit有字段,而你没有填写这个字段的值。


解决方案

针对这种情况,Rust提供了#[non_exhaustive]注解来缓解这些问题。它可以引用于structenumenum的变体。这个注解表示类型或枚举在将来可能会添加更多字段或变体。

如果你使用了它,那么别人在使用你的crate时,编译器会:

  • 禁止显式的构造,比如:lib::Unit { field: true }
  • 禁止非穷尽模式的匹配(即没有尾随..的模式)

如果你的接口比较稳定,就应该避免使用这个注解。

看例子:

lib.rs:

#[non_exhaustive]
pub struct Config {
    pub window_width: u16,
    pub window_height: u16,
}

fn SomeFunction() {
    let config: Config = Config {
        window_width: 640,
        window_height: 480,
    };

    // Non-exhaustive structs can be matched on exhaustively within the defining crate.
    if let Config {
        window_width: u16,
        window_height: u16,
    } = config
    {
        // ...
    }
}
  • 标注了#[non_exhaustive],lib.rs里仍然可以使用显式的构造,仍然可以使用非穷尽模式的匹配,因为这些代码与定义这个结构体的代码属于同一crate之内

那么我在main.rs这么写呢:

use constrained::Config;

fn main() {
	let config: Config = Config {
        window_width: 640,
        window_height: 480,
    };

	if let Config {
        window_width: u16,
        window_height: u16,
    } = config
}
  • 这样写就会报错,因为这里的代码属于外部crate,编译器就会静止上面所说的两种操作

我们可以稍微改一下代码使main.rs中的非穷尽模式的匹配变成穷尽模式的匹配:

if let Config {
    window_width: u16,
    window_height: u16,
    ..  // 它用于忽略结构体、元组或枚举中的其余字段或变体
} = config

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

【阿】(阿联酋)迪拜求职指南(Gulftalent)

https://www.gulftalent.com/resources/dubai-jobs-guide 文章目录 Types of Employers 雇主类型Multinationals 跨国公司Large local firms 大型本地公司Local SMEs 本地中小企Government 政府Assessing your Chances 评估您的机会其他城市(阿布扎比和沙迦&#xf…

win11 24h2 远程桌面 频繁断开 已失去连接 2025

一、现象 Windows11自升级2025年2月补丁后版本号为系统版本是26100.3194,远程桌面频繁断开连接,尝试连接,尤其在连接旧的server2012 二、临时解决方案 目前经测试,在组策略中,远程桌面连接客户端,关闭客户…

[算法--前缀和] 二维前缀和

目录 1. 前缀和数组的递推公式: dp[i][j] = dp[i-1][j] + dp[i][j-1] + nums[i][j] - dp[i-1][j-1].2. 前缀和数组需要额外开一行一列.3. 想要快速求任意一个矩形和, 实际上是多个前缀和的拼凑.今天来贴一道模板题 -> 二位前缀和 然后我们来简单总结两个公式: 因为这是一个…

公共数据授权运营模式研究(总体框架、主要模式及发展趋势)

本报告以公共数据运营模式为核心,以释放公共数据价值为目标,深入分析公共数据概念及特征,厘清公共数据运营的内涵及本质,提出纵深分域数据要素市场运营体系的总体思路,构建了一座(一个数据底座)…

MySQL主从架构

MySQL主从架构 MySQL REPLICATION 在实际生产环境中,如果对数据库的读和写都在一个数据库服务器中操作。无论是在安全性、高可用性,还是高并发等各个方面都是完全不能满足实际需求的,因此,一般来说都是通过主从复制(…

C# Combox 绑定数据

1.在界面中添加一个combox 2.将数据绑定到combox List<GrindingType> type new List<GrindingType>();type.Add(new GrindingType { Id 1, Name "Product A", Type new List<string> { "1", "2" } });type.Add(new Grin…

idea 部署 AJ-Report 启动的注意事项

AJ-Report 入门参考&#xff1a; AJ-Report 初学(入门教程) gitee 下载&#xff1a;https://gitee.com/anji-plus/report/releases 根据上面提供的 gitee 下载链接&#xff0c;点击直接下载 最上面的就是最新版本的&#xff0c;旧版本往下拉就可以找到&#xff0c;有三个下载…

【Go | 从0实现简单分布式缓存】-3:分布式节点通信

本文目录 一、通信流程二、peers.go三、http.go四、geecache.go五、测试代码 本文为极客兔兔动手写分布式缓存GeeCache学习笔记。 一、通信流程 在前面一节中&#xff0c;已经为 HTTPPool 实现了服务端功能&#xff0c;通信不仅需要服务端还需要客户端&#xff0c;因此本节来…

Win32/ C++ 简易对话框封装框架(多语言, 通知栏菜单, 拖拽文件处理)

Win32 简易对话框封装简易框架示例 1. 菜单操作: 多语言 2. 通知栏图标菜单 3. 其他操作: 接受拖拽文件等等 CDialogFrame.h #pragma once #include "CWindow/CDialogBase.h" #include "CNSFHeader.h" #include "Win32Utils/CBytesUtils.h" …

如何在 Linux 上安装和配置 Zsh

文章目录 如何在 Linux 上安装和配置 Zsh1. 安装 Zsh1.1 在 Ubuntu/Debian 上安装1.2 在 CentOS/RHEL/Fedora 上安装1.3 在 Arch Linux 上安装1.4 验证 Zsh 安装 2. 设置 Zsh 为默认 Shell2.1 验证默认 shell 3. 配置 Zsh3.1 使用 Oh My Zsh3.1.1 安装 Oh My Zsh3.1.2 启用插件…

Ubuntu搭建esp32环境 配置打开AT指令集 websocket功能

1&#xff0c;搭建前提 环境搭建参考乐鑫官网给的本地编译 ESP-AT 工程方法 因为公司电脑和网络的特殊性&#xff0c;不能正确解析域名&#xff08;仅在浏览器上可以访问&#xff09; &#xff0c;所以这边访问的时候改成了ssh 未了避免使用外网困难的问题&#xff0c;这里用…

网络安全第三次练习

一、实验拓扑 二、实验要求 配置真实DNS服务信息&#xff0c;创建虚拟服务&#xff0c;配置DNS透明代理功能 三、需求分析 1.创建用户并配置认证策略 2.安全策略划分接口 3.ip与策略配置 四、实验步骤 1.划分安全策略接口 2.创建用户并进行策略认证 3.配置安全策略 4.NAT配…

Web自动化之Selenium下Chrome与Edge的Webdriver常用Options参数

目录 引言 说明 Add_argument() 添加方式 常用参数 Add_experimental_option() 添加方式 常用方法 任务结束后仍然保持浏览器打开 禁用“Chrome 正受到自动测试软件的控制”提示 设置下载路径 禁用弹窗拦截 禁用图片加载 禁用 JavaScript 注意 引言 …

【无标题】网络安全公钥密码体制

第一节 网络安全 概述 一、基本概念 网络安全通信所需要的基本属性“ 机密性&#xff1b;消息完整性&#xff1b;可访问性与可用性&#xff1b;身份认证。 二、网络安全威胁 窃听&#xff1b;插入&#xff1b;假冒&#xff1b;劫持&#xff1b;拒绝服务Dos和分布式拒绝服务…

2024年国赛高教杯数学建模D题反潜航空深弹命中概率问题解题全过程文档及程序

2024年国赛高教杯数学建模 D题 反潜航空深弹命中概率问题 原题再现 应用深水炸弹&#xff08;简称深弹&#xff09;反潜&#xff0c;曾是二战时期反潜的重要手段&#xff0c;而随着现代军事技术的发展&#xff0c;鱼雷已成为现代反潜作战的主要武器。但是&#xff0c;在海峡或…

在vscode中编译运行c语言文件,配置并运行OpenMP多线程并行程序设计

1.下载安装vscode Visual Studio Code - Code Editing. Redefined 2.安装vscode扩展 打开vscode,按ctrl+shift+x,打开扩展,搜索c/c++,下载相应的扩展 3.下载MinGW-w64 MinGW-w64 提供了 GNU 编译器集合,可以编译c/c++文件 这里下载见我的资源,可直接下载 把压缩包解压…

PyCharm Professional 2025 安装配置全流程指南(Windows平台)

一、软件定位与核心功能 PyCharm 2025 是 JetBrains 推出的智能 Python IDE&#xff0c;新增深度学习框架自动补全、实时性能热力图等功能1。相较于社区版&#xff0c;专业版支持&#xff1a; Web开发&#xff08;Django/Flask&#xff09;数据库工具&#xff08;PostgreSQL/…

从两地三中心到多地多中心,OceanBase如何实现金融级高可用

“两地三中心”已成为金融领域基准的容灾部署模式。本文将简要阐述金融行业容灾架构中“两地三中心”的具体要求和部署&#xff0c;并进一步探讨OceanBase在实现“两地三中心”标准后&#xff0c;再至“多地多中心”部署中所展现的独特优势与特点。 商业银行的容灾要求 《商业…

九、数据治理架构流程

一、总体结构 《数据治理架构流程图》&#xff08;Data Governance Architecture Flowchart&#xff09; 水平结构&#xff1a;流程图采用水平组织&#xff0c;显示从数据源到数据应用的进程。 垂直结构&#xff1a;每个水平部分进一步划分为垂直列&#xff0c;代表数据治理的…

6.将cr打包成网络服务|使用postman进行测试|编写oj_server的服务路由功能(C++)

将cr打包成网络服务 compile_server.cc #include "compile_run.hpp" #include "../comm/httplib.h"using namespace ns_compile_and_run; using namespace httplib;//编译服务随时可能被多个人请求&#xff0c;必须保证传递上来的code&#xff0c;形成源…