よく使うderiveを短く書く方法

Question

よく使うテンプレ的な#[derive(...)]を短く書く方法はないでしょうか？例えば，

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord)]
struct User { ... }

を

#[derive(MyDerives)]
struct User {... }

のように書けたらうれしいのですが．

Comments

[toast-uz]

おそらく、https://doc.rust-jp.rs/book-ja/ch19-06-macros.html に記述されている「カスタムのderive マクロの書き方」で実現できると思いますが、非常に難解ですね。

Answer 1

素直にはできそうもないですね。

思いつく方法は以下のとおりです。

1. 宣言的マクロを使う
2. 手続き的マクロの一種である「属性風マクロ」を使う
3. エディターのコードスニペットや補完機能を使って楽に入力する

個人的なおすすめは最後の3.になります。

1. 宣言的マクロを使う

macro_rules!で定義できる宣言的マクロを使います。たとえば以下のようにできます。

// 宣言的マクロ my_derives! を定義する
macro_rules! my_derives {
    // アイテム（structなどが該当）1つにマッチし、#[derive(..)] を追加する
    ($item:item) => {
        #[derive(Debug, PartialEq, Eq, PartialOrd, Ord)]
        $item
    };
}

// my_derives! マクロを使う
my_derives! {
    struct User { 
        name: String,
    }
}

fn main() {
    let u1 = User { name: "Alice".into() };
    let u2 = User { name: "Bob".into() };
    // DebugトレイトやPartialOrdトレイトが実装できていることを確認する
    println!("{:?} < {:?}: {}", u1, u2, u1 < u2);
    // → User { name: "Alice" } < User { name: "Bob" }: true
}

2. 手続き的マクロの一種である「属性風マクロ」を使う

試していないので本当にできるかはわからないのですが、属性風マクロを使うと以下のように書けるかもしれません。

// 仮に、derive_setという属性風マクロを定義できたなら
// このようにして使えるはず
#[derive_set(MyDerives)]
struct User { 
    name: String,
}

これを以下のようなコードへと展開するように属性風マクロを定義します。

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord)]
struct User { 
    name: String,
}

手続き的マクロの実装方法については、以下を参照してください。

• 公式ドキュメント「The Rust Programming Language」の「マクロ」の章
• The Little Book of Rust Macros
• Synクレートのexamples

3. エディターのコードスニペットや補完機能を使って楽に入力する

コンパイラーに何かさせるのではなくて、エディターやIDEの入力サポート機能を使って、よく使うderiveの組み合わせを楽に入力できるようにします。

たとえばVisual Studio Codeとrust-analyzerを組み合わせると、#[derive()]のカッコ内にParと入力した時点でいくつかの入力候補が表示されます。

Comments

[mitiko]

２が理想的ですが，３が一番現実的ですね．
２についてはもう少し調べてみようと思います．
ありがとうございました．