Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Why do proc-macros have to be defined in proc-macro crate?

I was trying to create a derive macro for my trait, to simplify some stuff.

I've encountered some problems:

the #[proc_macro_derive] attribute is only usable with crates of the proc-macro crate type

and, after the small fix proc-macro=true:

proc-macro crate types cannot export any items other than functions tagged with #[proc_macro_derive] currently functions tagged with #[proc_macro_derive] must currently reside in the root of the crate`

What is the reason for this behavior?

like image 404
majkrzak Avatar asked Jun 22 '19 08:06

majkrzak


People also ask

What are proc macros?

Procedural macros allow you to run code at compile time that operates over Rust syntax, both consuming and producing Rust syntax. You can sort of think of procedural macros as functions from an AST to another AST. Procedural macros must be defined in a crate with the crate type of proc-macro .

What is a Rust macro?

What are Rust macros? Rust has excellent support for macros. Macros enable you to write code that writes other code, which is known as metaprogramming. Macros provide functionality similar to functions but without the runtime cost. There is some compile-time cost, however, since macros are expanded during compile time.


1 Answers

Procedural macros are fundamentally different from normal dependencies in your code. A normal library is just linked into your code, but a procedural macro is actually a compiler plugin.

Consider the case of cross-compiling: you are working on a Linux machine, but building a WASM project.

  • A normal crate will be cross-compiled, generate WASM code and linked with the rest of the crates.
  • A proc-macro crate must be compiled natively, in this case to Linux code, linked with the current compiler runtime (stable, beta, nightly) and be loaded by the compiler itself when compiling the crates where it is actually used. It will not be linked to the rest of the crates (different architecture!).

And since the compilation flow is different, the crate type must also be different, that is why the proc_macro=true is needed.

About this restriction:

proc-macro crate types cannot export any items other than functions tagged with #[proc_macro_derive]

Well, since the proc-macro crate is loaded by the compiler, not linked to the rest of your crates, any non-proc-macro code you export from this crate would be useless.

Note that the error message is inexact, as you can also export functions tagget with #[proc_macro].

And about this other restriction:

functions tagged with #[proc_macro_derive] must currently reside in the root of the crate

Adding proc_macro or proc_macro_derive items in nested modules is not currently supported, and does not seem to be particularly useful, IMHO.

like image 112
rodrigo Avatar answered Oct 02 '22 17:10

rodrigo