Yui

Yui是Rust的属性读取器。

功能

属性结构

Yui提供了一个 derive 宏 YuiAttribute，通过结构体、StructStruct、TupleStruct 和 NoFieldStruct 创建属性结构，都受支持。

use yui::YuiAttribute;

#[derive(YuiAttribute)]
struct NoField;

#[derive(YuiAttribute)]
struct Tuple(i32, String);

#[derive(YuiAttribute)]
struct Struct {
    int: i32,
    float: f64,
    bool: bool,
}

类型

• String：Rust中的 String。
• Bool：Rust中的 bool。
• 整数：Rust中的任何整数类型。
• 浮点数：Rust中的任何浮点数类型。
• 对象：其他属性结构。
• 枚举：定义枚举，记得使用 enum_value=true 选项。
• Vec：T的Vec（T不能是对象、Vec或HashMap）。
• HashMap：通过 String Skey 映射的T的HashMap。如果你想使字段可选，请在字段类型上使用 Option<T>。

use yui::{YuiEnumValue, YuiAttribute};

#[derive(YuiAttribute)]
struct Bar;

#[derive(YuiEnumValue)]
enum SomeEnum {
    A,
    B
}

#[derive(YuiAttribute)]
struct Foo {
    pub string: String,
    pub bool: bool,
    pub int: i32, // or other integer types like u32 ...
    pub float: f32, // or other float types like f64
    pub object: Bar, // any defined object
    #[attribute_field(enum_value=true)]
    pub enum_field: SomeEnum, // have to add enum_value option
    pub list: Vec<i32>, // nested type of vec can`t be Object, Vec or HashMap
    pub map: std::collections::HashMap<String, SomeEnum>,
    pub optional: Option<i32> // optional field
}

选项

• 别名
  生成的读取器将使用给定的名称解析字段，而不是Rust中字段的名称。

  #[derive(YuiAttribute)]
  struct Foo {
      #[attribute_field(alias = "i32")]
      pub int32: i32,
  }
  

• 默认值
  设置此字段的默认值。如果解析时不存在值，即使字段是可选的，也将设置默认值到字段。Object、Vec 或 HashMap 字段不能有默认值。

  #[derive(YuiAttribute)]
  struct Foo {
      #[attribute_field(default = 1024)]
      pub int32: i32
  }
  

• 枚举值
  在枚举类型字段上使用 enum_value=true。

枚举

使用 derive YuiEnumValue 在枚举上创建枚举值类型。

use yui::YuiEnumValue;

#[derive(YuiEnumValue)]
enum SomeEnum {
    A,
    B
}

然后，枚举可以用作字段类型。

• variant_value 属性
  自定义与变体对应的字符串值（默认是Rust中变体名称的蛇形写法）。

use yui::YuiEnumValue;

#[derive(YuiEnumValue)]
enum SomeEnum {
    #[variant_value("aaa")] // default is 'a'
    A,
    B
}

使用 syn 和 quote 解析属性

yui::AttributeStructs<T> 可用于 parse_macro_input!

let attributes = syn::parse_macro_inpit!(input as yui::AttributeStructs<Foo>);

如果您想从 syn::Meta 解析属性，请使用 yui::AttributeStruct::from_meta()。
具有值的属性结构可以自动转换为令牌。但是，每个字段的可见性必须为公共。

use proc_macro::TokenStream;

#[derive(YuiAttribute)]
struct Foo {
    #[attribute_field(default = 1024)]
    pub int32: i32
}

fn derive_fn(input: TokenStream) -> TokenStream {
    let attributes = syn::parse_macro_input!(input as yui::AttributeStructs<Foo>);
    let attrs = attributes.attrs;

    TokenStream::from(quote::quote! {
        fn get_attrs() -> Vec<Foo> {
            vec![#(#attrs),*]
        }
    })
}

use yui::generate_reader;

generated_reader!(
    MyDerive,
    [StructAttribute1, StructAttribute2],
    [FieldAttribute1, FieldAttribute2]
);

#![feature(proc_macro_hygiene)]
use yui::{get_attribute, has_attribute};

#[derive(MyDerive)]
#[StructAttribute1("some parameters")]
struct Foo {
    #[FieldAttribute1("some parameters")]
    field: i32
}

fn some_fn() {
    assert!(has_attribute!(Foo, StructAttribute1));
    assert!(has_attribute!(Foo::field, FieldAttribute1));
    let struct_attr1: Option<StructAttribute1> = get_attribute!(Foo, StructAttribute1);
    let field_attr1: Option<StructAttribute1> = get_attribute!(Foo::field, StructAttribute1);
}