Tidy subxt-codegen crate interface
#1225
Conversation
| .map_err(|e| eyre!("Cannot decode the provided metadata: {e}"))?; | ||
| let code = codegen | ||
| .generate(metadata) | ||
| .map_err(|e| eyre!("Cannot generate code: {e}"))?; |
There was a problem hiding this comment.
This is so much cleaner now 👍
| #[doc(hidden)] | ||
| pub mod __private { | ||
| pub use crate::types::{DerivesRegistry, TypeDefGen, TypeGenerator, TypeSubstitutes}; | ||
| } |
There was a problem hiding this comment.
Thanks for keeping it exposed, later we can have a cleaner solution.
|
|
||
| /// A newtype wrapper which stores the path to the Subxt crate. | ||
| #[derive(Debug, Clone)] | ||
| pub struct CratePath(syn::Path); |
There was a problem hiding this comment.
I like that this got removed, it was a bit annoying to work with.
| codegen.set_target_module(item_mod); | ||
|
|
||
| // Use the provided crate path: | ||
| if let Some(crate_path) = args.crate_path { |
There was a problem hiding this comment.
The args used in the macro are very similar to the args used in the CLI, but I think it would be difficult/not worth it to unify them somehow?
There was a problem hiding this comment.
Yeah; I mean ideally they would be about identical. The types will vary a bit just because they come from different sources (eg strings from a terminal vs syn::Paths from a lib call or whatever)
| .generate_docs(should_gen_docs) | ||
| .runtime_types_only(args.runtime_types_only); | ||
| // Do we want to fetch unstable metadata? This only works if fetching from a URL. | ||
| let unstable_metadata = args.unstable_metadata.is_present(); |
There was a problem hiding this comment.
What is the reasoning behind allowing unstable metadata only from URLs?
There was a problem hiding this comment.
Oh; this is just because if you provide the metadata, you can't pick what version it will be, but if you fetch from a URL you can decide what to fetch. No real need for this option at the mo since it wouldn't actually work, but when we start work on V16 metadata at some point it'll become useful again to try it out in Subxt :)
| ) | ||
| let mut codegen = CodegenBuilder::new(); | ||
| codegen.set_target_module(item_mod); | ||
| let generated_code = codegen |
There was a problem hiding this comment.
This looks way better! Nice!
This crate interface has always been a bit all over the place, being intended primarily for internal use. However, that's not been clear, and so it has been used.
This PR:
#[subxt]macro orsubxt codegenCLI tool. The aim here is to provided a supported third means to generate the interface; via a rust library instead of macro/CLI.__privatemodule that should not be relied on, just becausesubxt-exploreris currently relying on them.fetch-metadataflag very much opt-in (the codegen stuff should just be pure code really; we only have these fns here because they would need to live in a new crate otherwise).CratePathand some other bits that were sortof pointless (and I didn't want to expose such a thing in the public interface).With this, I'd be happy saying that we supported people using the
codegencrate directly. Ultmately, the type generation code should all be moved into a separate crate and the overall interfaces tidied up etc. This PR will allow that to happen without affecting thesubxt-codegencrate (hopefully).