Refactor alises support on ToSchema derive
#546
Merged
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
Prior to this commit the implementation was not able to resolve
nested generics within aliases. That lead scenarios where types with
extensive use of lifetimes was not possible.
This commit takes another approach on aliases support for `ToSchema`
derive macro that provides generic schema types. Instead of trying to
parse `Generics` manually we parse `syn::Type` instead that contains
generics as is allowing complex generic arguments with lifetimes to be
used.
Fundamental difference is that we create `TypeTree` for alias and the
implementor type. Then we compare generic arguments to the field
arguments and replace matching occurrences.
```rust
#[derive(ToSchema)]
#[aliases(Paginated1<'b> = Paginated<'b, String>, Paginated2<'b> = Paginated<'b, Cow<'b, bool>>)]
struct Paginated<'r, T> {
pub total: usize,
pub data: Vec<T>,
pub next: Option<&'r str>,
pub prev: Option<&'r str>,
}
```
One caveat with this approach is that the lifetimes now need to be also
defined on the left side of the equals (=) mark.
This was referenced Mar 27, 2023
Closed
Remove need to define lifetimes on left side of equals (=) sign. ```rust #[aliases(Paginated1 = Paginated<'b, String>, Paginated2 = Paginated<'b, Cow<'b, bool>>)] ```
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.
Prior to this commit the implementation was not able to resolve nested generics within aliases. That lead scenarios where types with extensive use of lifetimes was not possible.
This commit takes another approach on aliases support for
ToSchemaderive macro that provides generic schema types. Instead of trying to parseGenericsmanually we parsesyn::Typeinstead that contains generics as is allowing complex generic arguments with lifetimes to be used.Fundamental difference is that we create
TypeTreefor alias and the implementor type. Then we compare generic arguments to the field arguments and replace matching occurrences.One caveat with this approach is that the lifetimes now need to be also defined on the left side of the equals (=) mark.Removed the need to define lifetimes on left side of the equals (=) sign.
Fixes #427, Fixes #524