Find the crate name from the current Cargo.toml
($crate
for proc-macro).
When writing declarative macros, $crate
representing the current crate is very useful, but procedural macros do not have this. If you know the current name of the crate you want to use, you can do the same thing as $crate
. This crate provides the features to make it easy.
Add this to your Cargo.toml
:
toml
[dependencies]
find-crate = "0.3"
Now, you can use find-crate:
rust
use find_crate::find_crate;
The current version of find-crate requires Rust 1.15 or later.
find_crate()
gets the crate name from the current Cargo.toml
.
```rust use findcrate::findcrate; use proc_macro2::{Ident, Span, TokenStream}; use quote::quote;
fn import() -> TokenStream {
let name = findcrate(|s| s == "foo").unwrap();
let name = Ident::new(&name, Span::callsite());
// If your proc-macro crate is 2018 edition, use quote!(use #name as _foo;)
instead.
quote!(extern crate #name as _foo;)
}
```
As in this example, it is easy to handle cases where proc-macro is exported from multiple crates.
```rust use findcrate::findcrate; use proc_macro2::{Ident, Span, TokenStream}; use quote::quote;
fn import() -> TokenStream {
let name = findcrate(|s| s == "foo" || s == "foo-core").unwrap();
let name = Ident::new(&name, Span::callsite());
// If your proc-macro crate is 2018 edition, use quote!(use #name as _foo;)
instead.
quote!(extern crate #name as _foo;)
}
```
Search for multiple crates. It is much more efficient than using find_crate()
for each crate.
```rust use findcrate::Manifest; use procmacro2::{Ident, Span, TokenStream}; use quote::quote;
const CRATE_NAMES: &[&[&str]] = &[ &["foo", "foo-core"], &["bar", "bar-util", "bar-core"], &["baz"], ];
fn imports() -> TokenStream { let mut tts = TokenStream::new(); let manifest = Manifest::new().unwrap(); let manifest = manifest.lock();
for names in CRATE_NAMES {
let name = manifest.find_name(|s| names.iter().any(|x| s == *x)).unwrap();
let name = Ident::new(&name, Span::call_site());
let import_name = Ident::new(&format!("_{}", names[0]), Span::call_site());
// If your proc-macro crate is 2018 edition, use `quote!(use #name as #import_name;)` instead.
tts.extend(quote!(extern crate #name as #import_name;));
}
tts
} ```
By default it will be searched from dependencies
, dev-dependencies
and build-dependencies
.
Also, find_crate()
and Manifest::new()
read Cargo.toml
in CARGO_MANIFEST_DIR
as manifest.
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.