是否可以通过委托给结构成员来创建实现 Ord 的宏?

Is it possible to create a macro that implements Ord by delegating to a struct member?

我有一个结构:

struct Student {
    first_name: String,
    last_name: String,
}

我想创建一个可以按 last_name 排序的 Vec<Student>。我需要实施 OrdPartialOrdPartialEq:

use std::cmp::Ordering;

impl Ord for Student {
    fn cmp(&self, other: &Student) -> Ordering {
        self.last_name.cmp(&other.last_name)
    }
}

impl PartialOrd for Student {
    fn partial_cmp(&self, other: &Student) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl PartialEq for Student {
    fn eq(&self, other: &Student) -> bool {
        self.last_name == other.last_name
    }
}

如果您有很多结构,并且要根据一个明显的字段进行排序,那么这可能会非常单调和重复。是否可以创建一个宏来自动实现它?

类似于:

impl_ord!(Student, Student.last_name)

我找到了 Automatically implement traits of enclosed type for Rust newtypes (tuple structs with one field),但这不是我要找的。

是的,你可以,但首先:请阅读为什么你不应该


为什么不呢?

当一个类型实现 OrdPartialOrd 时,这意味着该类型具有 natural 排序,这反过来意味着实现的排序是只有一个合乎逻辑的。取整数:3 自然小于 4。当然还有其他有用的顺序。您可以使用倒序对整数进行降序排序,但只有 一个 自然数。

现在你有一个由两个字符串组成的类型。有自然顺序吗?我声称:不! 有很多有用的排序,但是按姓氏排序比按名字排序更自然吗?我不这么认为。

那怎么办?

还有两种排序方式:

两者都允许您修改排序算法比较值的方式。按姓氏排序可以这样进行 (full code):

students.sort_by(|a, b| a.last_name.cmp(&b.last_name));

这样,您可以指定如何对每个方法调用进行排序。有时您可能想按姓氏排序,而其他时候您可能想按名字排序。由于没有明显和自然的排序方式,您不应该 "attach" 任何特定的排序方式本身。

但是说真的,我想要一个宏...

当然,在Rust中写这样的宏是可以的。一旦您了解了宏系统,这实际上很容易。但是我们不要为您的 Student 示例这样做,因为——我希望您现在已经理解了——这是一个坏主意。

什么时候是个好主意?当只有一个字段语义是类型的一部分时。取这个数据结构:

struct Foo {
    actual_data: String,
    _internal_cache: String,
}

在这里,_internal_cache 在语义上不属于您的类型。它只是一个实现细节,因此对于 EqOrd 应该忽略。简单的宏是:

macro_rules! impl_ord {
    ($type_name:ident, $field:ident) => {
        impl Ord for $type_name {
            fn cmp(&self, other: &$type_name) -> Ordering {
                self.$field.cmp(&other.$field)
            }
        }

        impl PartialOrd for $type_name {
            fn partial_cmp(&self, other: &$type_name) -> Option<Ordering> {
                Some(self.cmp(other))
            }
        }

        impl PartialEq for $type_name {
            fn eq(&self, other: &$type_name) -> bool {
                self.$field == other.$field
            }
        }

        impl Eq for $type_name {}
    }
}

你问我为什么把这么一大段代码叫做简单?好吧,这段代码的绝大部分正是您已经编写的:impls。我执行了两个简单的步骤:

  1. 在您的代码周围添加宏定义并考虑我们需要哪些参数(type_namefield
  2. 将所有提及的 Student 替换为 $type_name,将所有提及的 last_name 替换为 $field

这就是它被称为 "macro by example" 的原因:您基本上只是编写普通代码作为示例,但可以使每个参数的部分代码可变。

你可以测试整个东西 here

我创建了一个宏,它允许通过定义将用于比较元素的表达式来实现 Ordord_by_key::ord_eq_by_key_selector,类似于您的要求。

use ord_by_key::ord_eq_by_key_selector;

#[ord_eq_by_key_selector(|s| &s.last_name)]
struct Student {
    first_name: String,
    last_name: String,
}

如果您必须在不同的情况下按不同的标准进行排序,您可以为您的结构引入一个容器,该容器将实现不同的排序策略:

use ord_by_key::ord_eq_by_key_selector;

struct Student {
    first_name: String,
    last_name: String,
}

#[ord_eq_by_key_selector(|(s)| &s.first_name)]
struct StudentByFirstName(Student);

#[ord_eq_by_key_selector(|(s)| &s.last_name, &s.first_name)]
struct StudentByLastNameAndFirstName(Student);