【社区投稿】给Rust的Struct自动实现trait

2024-02-17 20:04

本文主要是介绍【社区投稿】给Rust的Struct自动实现trait,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

给Rust的Struct自动实现trait

我们通常使用

#[derive(Clone, Debug)]

这样的方式给struct自动实现相应的trait,从而让struct具备某些特性,但是如果我们想让编译器给struct自动实现自己定义的trait要怎么办?

首先我们需要有一个trait,假设如下面的定义:

pub trait Printable {pub fn print_me(&self);
}

我们定义这个trait给struct赋予一个行为是逐行打印struct的所有Field。当然如果是自己实现肯定是可以凭空乱写的,那么我们可以和Debug一样,在 derive 中让编译器自动添加默认的实现。

首先需要给crate添加一个子crate:

cargo new --lib printable

然后在当前crate的 Cargo.toml 中添加依赖

[workspace]
members = [".","printable"
]
[dependencies]
printable = { version = "*", path = "printable"}

在printable 的 Cargo.toml 里还需要添加依赖

[dependencies]
syn = { version = "1.0", features = ["full"] }
quote = "1.0"
proc-macro2 = "1.0.51"

我们需要这三个crate来简化代码生成的工作,这里proc-macro2提供了自动实现宏的功能,syn用来解析结构体,quote用来输出TokenStream。

在 printable 的lib.rs 文件中

#[proc_macro_derive(Printable)]
pub fn print_info_derive(input: TokenStream) -> TokenStream {
}

我们在函数 print_info_derive 中输出的TokenStream,就会在编译时动态注入到struct中,这里参数input就是struct本身的代码流。

我们通过解析input就可以分析出 Struct的名字,Field列表,所有Field的名字,类型…..

下面是简化后的代码:

#[proc_macro_derive(Printable)]
pub fn print_info_derive(input: TokenStream) -> TokenStream {let struct_name = to_snake_case(input.ident.to_string().as_str());let fields = match input.data.clone() {syn::Data::Struct(data) => data.fields,_ => panic!("Only structs are supported"),};let fields_name: Vec<Ident> = fields.iter().map(|field| {field.ident.as_ref().unwrap().clone()}).collect();
}

之后我们就需要构建输出的代码流,这里使用 quote! 这个宏来实现。

#[proc_macro_derive(Printable)]
pub fn print_info_derive(input: TokenStream) -> TokenStream {let struct_name = to_snake_case(input.ident.to_string().as_str());let fields = match input.data.clone() {syn::Data::Struct(data) => data.fields,_ => panic!("Only structs are supported"),};let fields_name: Vec<Ident> = fields.iter().map(|field| {field.ident.as_ref().unwrap().clone()}).collect();let output_token = quote! {impl Printable for #struct_name {pub fn print_me(&self) {//这里添加逐行打印Field的代码,因为quote里本来就是在输出代码流//所以不能直接访问fields_name,比如循环之类的,所以我们这里需要//把生成这部分代码提取到函数外}}}output_token.into()
}

为了简单演示我们就使用一个函数来实现:

fn gen_print(fileds: Vec<Ident>) -> TokenStream2 {let print_stmts =fields.iter().map(|field| {quote! {println!("field:{}", &self.#field);}});quote!{#(#print_stmts)*}
}

最后组装一下,lib.rs  的代码如下:

#[proc_macro_derive(Printable)]
pub fn print_info_derive(input: TokenStream) -> TokenStream {let struct_name = to_snake_case(input.ident.to_string().as_str());let fields = match input.data.clone() {syn::Data::Struct(data) => data.fields,_ => panic!("Only structs are supported"),};let fields_name: Vec<Ident> = fields.iter().map(|field| {field.ident.as_ref().unwrap().clone()}).collect();let print_code = gen_print(fields_name);let output_token = quote! {impl Printable for #struct_name {pub fn print_me(&self) {#output_token}}}output_token.into()
}

如此这般一通操作后,我们随便一定一个Struct:

#[derive(Debug, Printable)]
struct TestTb {id: String,name: String,ts: i32
}

就可以

TestTb{id: "123".to_string(), name: "alex", ts: 111}.print_me();

就可以逐行打印出所有的Field了。

那么灵活的使用这个玩法,我们可以根据Struct的Field,自动生成 insert, update, delete的SQL也是可以的。给每个Field自动生成getter,setter方法…… (这个Java味太浓了,だめ)

研究这个是为了给 sqlx 增加一个自动生成insert,update,delete方法的增强,因为不喜欢写超长的insert和update语句。

Amusez-vous tous!

这篇关于【社区投稿】给Rust的Struct自动实现trait的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

HTML5 getUserMedia API网页录音实现指南示例小结

《HTML5getUserMediaAPI网页录音实现指南示例小结》本教程将指导你如何利用这一API,结合WebAudioAPI,实现网页录音功能,从获取音频流到处理和保存录音,整个过程将逐步... 目录1. html5 getUserMedia API简介1.1 API概念与历史1.2 功能与优势1.3

Java实现删除文件中的指定内容

《Java实现删除文件中的指定内容》在日常开发中,经常需要对文本文件进行批量处理,其中,删除文件中指定内容是最常见的需求之一,下面我们就来看看如何使用java实现删除文件中的指定内容吧... 目录1. 项目背景详细介绍2. 项目需求详细介绍2.1 功能需求2.2 非功能需求3. 相关技术详细介绍3.1 Ja

使用Python和OpenCV库实现实时颜色识别系统

《使用Python和OpenCV库实现实时颜色识别系统》:本文主要介绍使用Python和OpenCV库实现的实时颜色识别系统,这个系统能够通过摄像头捕捉视频流,并在视频中指定区域内识别主要颜色(红... 目录一、引言二、系统概述三、代码解析1. 导入库2. 颜色识别函数3. 主程序循环四、HSV色彩空间详解

PostgreSQL中MVCC 机制的实现

《PostgreSQL中MVCC机制的实现》本文主要介绍了PostgreSQL中MVCC机制的实现,通过多版本数据存储、快照隔离和事务ID管理实现高并发读写,具有一定的参考价值,感兴趣的可以了解一下... 目录一 MVCC 基本原理python1.1 MVCC 核心概念1.2 与传统锁机制对比二 Postg

一文详解MySQL如何设置自动备份任务

《一文详解MySQL如何设置自动备份任务》设置自动备份任务可以确保你的数据库定期备份,防止数据丢失,下面我们就来详细介绍一下如何使用Bash脚本和Cron任务在Linux系统上设置MySQL数据库的自... 目录1. 编写备份脚本1.1 创建并编辑备份脚本1.2 给予脚本执行权限2. 设置 Cron 任务2

SpringBoot整合Flowable实现工作流的详细流程

《SpringBoot整合Flowable实现工作流的详细流程》Flowable是一个使用Java编写的轻量级业务流程引擎,Flowable流程引擎可用于部署BPMN2.0流程定义,创建这些流程定义的... 目录1、流程引擎介绍2、创建项目3、画流程图4、开发接口4.1 Java 类梳理4.2 查看流程图4

C++中零拷贝的多种实现方式

《C++中零拷贝的多种实现方式》本文主要介绍了C++中零拷贝的实现示例,旨在在减少数据在内存中的不必要复制,从而提高程序性能、降低内存使用并减少CPU消耗,零拷贝技术通过多种方式实现,下面就来了解一下... 目录一、C++中零拷贝技术的核心概念二、std::string_view 简介三、std::stri

C++高效内存池实现减少动态分配开销的解决方案

《C++高效内存池实现减少动态分配开销的解决方案》C++动态内存分配存在系统调用开销、碎片化和锁竞争等性能问题,内存池通过预分配、分块管理和缓存复用解决这些问题,下面就来了解一下... 目录一、C++内存分配的性能挑战二、内存池技术的核心原理三、主流内存池实现:TCMalloc与Jemalloc1. TCM

OpenCV实现实时颜色检测的示例

《OpenCV实现实时颜色检测的示例》本文主要介绍了OpenCV实现实时颜色检测的示例,通过HSV色彩空间转换和色调范围判断实现红黄绿蓝颜色检测,包含视频捕捉、区域标记、颜色分析等功能,具有一定的参考... 目录一、引言二、系统概述三、代码解析1. 导入库2. 颜色识别函数3. 主程序循环四、HSV色彩空间

Python实现精准提取 PDF中的文本,表格与图片

《Python实现精准提取PDF中的文本,表格与图片》在实际的系统开发中,处理PDF文件不仅限于读取整页文本,还有提取文档中的表格数据,图片或特定区域的内容,下面我们来看看如何使用Python实... 目录安装 python 库提取 PDF 文本内容:获取整页文本与指定区域内容获取页面上的所有文本内容获取