docs: Improve substitute_type rules and alternatives #1884
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mittal-parth
changed the title
lexnv
reviewed
Dec 13, 2024
| /// | ||
| /// ### Important Notes | ||
| /// - The path to replace must be an absolute path (fully qualified) | ||
| /// - The replacement type must implement the necessary traits for encoding and decoding |
There was a problem hiding this comment.
nit: Maybe we can mention the traits here?
jsdw
reviewed
Jan 15, 2025
Comment on lines
181
to
+189
| /// #[subxt::subxt( | ||
| /// runtime_metadata_path = "../artifacts/polkadot_metadata_full.scale", | ||
| /// substitute_type(path = "sp_arithmetic::per_things::Perbill", with = "crate::Foo") | ||
| /// )] | ||
| /// mod polkadot {} | ||
| /// | ||
| /// # #[derive( | ||
| /// # scale_encode::EncodeAsType, | ||
| /// # scale_decode::DecodeAsType, | ||
| /// # codec::Encode, | ||
| /// # codec::Decode, | ||
| /// # Clone, | ||
| /// # Debug, | ||
| /// # )] | ||
| /// // In reality this needs some traits implementing on | ||
| /// // it to allow it to be used in place of Perbill: | ||
| /// pub struct Foo(u32); | ||
| /// # impl codec::CompactAs for Foo { | ||
| /// # type As = u32; | ||
| /// # fn encode_as(&self) -> &Self::As { | ||
| /// # &self.0 | ||
| /// # } | ||
| /// # fn decode_from(x: Self::As) -> Result<Self, codec::Error> { | ||
| /// # Ok(Foo(x)) | ||
| /// # } | ||
| /// # } | ||
| /// # impl From<codec::Compact<Foo>> for Foo { | ||
| /// # fn from(v: codec::Compact<Foo>) -> Foo { | ||
| /// # v.0 | ||
| /// # } | ||
| /// # } | ||
| /// # fn main() {} | ||
| /// mod polkadot { | ||
| /// // Custom type to replace Perbill | ||
| /// pub struct Foo(u32); | ||
| /// // Note: Foo must implement required traits | ||
| /// } |
There was a problem hiding this comment.
This looks wrong to me offhand; the substititue path is "crate::Foo" but then we move the type into crate::polkadot::Foo? I'd just keep the type defined at the top level to avoid anybody thinking that there is a requirement to put the substitute type into this mod with the attr on
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1464