2 stable releases
new 1.0.90 | Nov 2, 2024 |
---|---|
1.0.89 | Oct 31, 2024 |
#680 in Procedural macros
81 downloads per month
170KB
4K
SLoC
proc-macro2
A wrapper around the procedural macro API of the compiler's proc_macro
crate.
This library serves two purposes:
-
Bring proc-macro-like functionality to other contexts like build.rs and main.rs. Types from
proc_macro
are entirely specific to procedural macros and cannot ever exist in code outside of a procedural macro. Meanwhileproc_macro2
types may exist anywhere including non-macro code. By developing foundational libraries like syn and quote againstproc_macro2
rather thanproc_macro
, the procedural macro ecosystem becomes easily applicable to many other use cases and we avoid reimplementing non-macro equivalents of those libraries. -
Make procedural macros unit testable. As a consequence of being specific to procedural macros, nothing that uses
proc_macro
can be executed from a unit test. In order for helper libraries or components of a macro to be testable in isolation, they must be implemented usingproc_macro2
.
Usage
[dependencies]
proc-macro2 = "1.0"
The skeleton of a typical procedural macro typically looks like this:
extern crate proc_macro;
#[proc_macro_derive(MyDerive)]
pub fn my_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
let input = proc_macro2::TokenStream::from(input);
let output: proc_macro2::TokenStream = {
/* transform input */
};
proc_macro::TokenStream::from(output)
}
If parsing with Syn, you'll use parse_macro_input!
instead to propagate
parse errors correctly back to the compiler when parsing fails.
Unstable features
The default feature set of proc-macro2 tracks the most recent stable compiler
API. Functionality in proc_macro
that is not yet stable is not exposed by
proc-macro2 by default.
To opt into the additional APIs available in the most recent nightly compiler,
the procmacro2_semver_exempt
config flag must be passed to rustc. We will
polyfill those nightly-only APIs back to Rust 1.56.0. As these are unstable APIs
that track the nightly compiler, minor versions of proc-macro2 may make breaking
changes to them at any time.
RUSTFLAGS='--cfg procmacro2_semver_exempt' cargo build
Note that this must not only be done for your crate, but for any crate that depends on your crate. This infectious nature is intentional, as it serves as a reminder that you are outside of the normal semver guarantees.
Semver exempt methods are marked as such in the proc-macro2 documentation.
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.