如何以编程方式获取结构的字段数？

Question

我有一个自定义结构，如下所示：

struct MyStruct {
    first_field: i32,
    second_field: String,
    third_field: u16,
}

是否可以通过编程方式获取结构字段的数量（例如，通过方法调用field_count()）：

let my_struct = MyStruct::new(10, "second_field", 4);
let field_count = my_struct.field_count(); // Expecting to get 3

对于这个结构：

struct MyStruct2 {
    first_field: i32,
}

...下面的调用应该返回1:

let my_struct_2 = MyStruct2::new(7);
let field_count = my_struct2.field_count(); // Expecting to get count 1

是否有类似field_count() 的 API 或者只能通过宏来获取？

如果这可以通过宏实现，应该如何实现？

Answer 1

当结构本身由宏生成时，这是可能的 - 在这种情况下，您可以只计算传递给宏的令牌，如 here 所示。这就是我想出的：

macro_rules! gen {
    ($name:ident {$($field:ident : $t:ty),+}) => {
        struct $name { $($field: $t),+ }
        impl $name {
            fn field_count(&self) -> usize {
                gen!(@count $($field),+)
            }
        }
    };
    (@count $t1:tt, $($t:tt),+) => { 1 + gen!(@count $($t),+) };
    (@count $t:tt) => { 1 };
}

Playground（带有一些测试用例）

这种方法的缺点（一个 - 可能还有更多）是向该函数添加属性并非易事 - 例如，添加到 #[derive(...)] 上的某些东西。另一种方法是编写自定义派生宏，但我暂时无法谈论。

Answer 2

是否有任何可能的 API，例如 field_count()，或者只能通过宏获得？

没有这样的内置 API 可以让您在运行时获取此信息。 Rust 没有运行时反射（有关更多信息，请参阅this question）。但确实可以通过 proc-macros 实现！

注意：proc-macros 不同于“macro by example”（通过macro_rules! 声明）。后者不如 proc-macros 强大。

如果这可以通过宏实现，应该如何实现？

(这不是对 proc-macros 的介绍；如果这个主题对您来说是全新的，请先阅读其他地方的介绍。)

在 proc 宏（例如自定义派生）中，您可能需要以某种方式获取结构定义为 TokenStream。使用 TokenStream 和 Rust 语法的实际解决方案是通过 syn 解析它：

#[proc_macro_derive(FieldCount)]
pub fn derive_field_count(input: TokenStream) -> TokenStream {
    let input = parse_macro_input!(input as ItemStruct);

    // ...
}

input 的类型是ItemStruct。如您所见，它具有fields 类型的Fields 字段。在该字段上，您可以调用iter() 来获取结构所有字段的迭代器，然后您可以调用count()：

let field_count = input.fields.iter().count();

现在你有你想要的了。

也许您想将此field_count() 方法添加到您的类型中。您可以通过自定义派生（在此处使用quote crate）来做到这一点：

let name = &input.ident;

let output = quote! {
    impl #name {
        pub fn field_count() -> usize {
            #field_count
        }
    }
};

// Return output tokenstream
TokenStream::from(output)

然后，在您的应用程序中，您可以编写：

#[derive(FieldCount)]
struct MyStruct {
    first_field: i32,
    second_field: String,
    third_field: u16,
}

MyStruct::field_count(); // returns 3