deriveマクロのquote!の中で、メソッドの戻り値を実装先の構造体名にすることはできますか？！

Question

前提

まず、ここではRust book のMacroのページを参考にさせてください。

例ではまず以下のようなtraitがあって

src/lib.rs

pub trait HelloMacro {
    fn hello_macro();
}

以下のderiveマクロを作成しています。

hello_macro_derive/src/lib.rs

extern crate proc_macro;

use proc_macro::TokenStream;
use quote::quote;
use syn;

#[proc_macro_derive(HelloMacro)]
pub fn hello_macro_derive(input: TokenStream) -> TokenStream {
    let ast = syn::parse(input).unwrap();

    impl_hello_macro(&ast)
}

fn impl_hello_macro(ast: &syn::DeriveInput) -> TokenStream {
    let name = &ast.ident;
    let gen = quote! {
        impl HelloMacro for #name {
            fn hello_macro() {
                println!("Hello, Macro! My name is {}!", stringify!(#name));
            }
        }
    };
    gen.into()
}

質問

ここで、例えばこのマクロの中で、

fn hello_macro() {hoge}

となっている部分を

fn hello_macro() -> #name {hoge}

としたのですが、この場合元のtraitのほうでの戻り値と整合性が取れていないためエラーとなりました。しかしtrait定義の方では、実装先の構造体の名前である#nameを使うことはできません。
この場合このようなマクロ(メソッドの戻り値を動的に構造体にする)を作るのは不可能なのでしょうか？

Answer 1

Rustでは、メソッドの引数型、戻り値型、メソッドの本体で、実装先の構造体の名前の代わりにSelfと書くことができます。

トレイト定義とderiveマクロによるimplの両方でfn hello_macro() -> Selfとすればうまくいくと思います。

Comments

[KOTTON]

traitにSelfと記述すれば実装先の構造体になるんですね、すごい柔軟ですね...！こんな簡単とは思いませんでした、ありがとうございます！
もう2つだけ質問してもよろしいでしょうか
Aクレートの中にA_deriveというマクロ用のサブクレートが入っているとして、このAクレート内のexamples/hoge.rsの中からA_deriveクレートにアクセスするにはどうすればいいのでしょうか？
また、これらをcrates.ioにパブリッシュしたい場合、おそらくA_deriveは自動でexcludeされてしまうと思うのですが、つまりAとA_deriveをまとめてワークスペース化するというのが一般的なのでしょうか

いつも回答ありがとうございます、githubのスターもありがとうございました！(稚拙なコードですが

[tatsuya6502]

AクレートのCargo.tomlのdependenciesに以下のように書いてください。

A_derive = { path = "./A_derive", version = "0.1" }

こうすると、ローカルでAクレートを開発しているときは相対pathにあるA_deriveクレートが使われ、crates.ioにパブリッシュしたときはcrates.ioに別途公開したA_deriveクレートが使われるようになります。Cargo.tomlの修正後、examples/hoge.rsで `use A_derive:: ... ;` とすればOKです。

https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#multiple-locations

> crates.ioにパブリッシュしたい場合、おそらくA_deriveは自動でexcludeされてしまうと思うのですが、つまりAとA_deriveをまとめてワークスペース化するというのが一般的なのでしょうか

ワークスペース化しても、crates.ioにパブリッシュするときは path = のところが自動的に削除されると思います（A_derive = "0.1"の指定だけ残る）　そのため、Aクレートの中にA_deriveクレートを埋め込んでパブリッシュしたとしても、Aクレートを使う人は、そのA_deriveのコードにはアクセスできません。

AクレートとA_deriveクレートをそれぞれ別のクレートとしてパブリッシュしないといけないはずです。

[KOTTON]

出来ました！！！ありがとうございます
パブリッシュすると、path= の部分が消えるというのは初めて知りました。開発中はこのようにするのがいいんですね...最適解を知ることができました！