Support associated type in getter trait#191
Merged
soareschen merged 11 commits intomainfrom Feb 1, 2026
Merged
Conversation
This file contains hidden or 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
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.
Summary
This PR adds support to define getter traits with abstract field types through a local associated type. For example, one can now define an auto getter trait like follows:
The
HasNametrait now has an abstractNametype that is automatically derived from thenamefield in a struct. With that, given a struct like:The
HasNametrait would be automatically implemented withStringas theNametype.Benefits
The main benefit of this is that it becomes much less tedious to define getter methods containing types that we don't care. Without it, we would need to also define an abstract type trait, which does not support auto derivation:
This is significantly more tedious, and discourages users from defining the getter field with abstract types.
Use with
#[cgp_getter]The abstract field type can also be used with
#[cgp_getter], such as:With that, the getter trait may be implemented through
UseFieldas usual:Limitation
Abstract types in getter traits can only be used when there is exactly one getter method. Additionally, the return type must precisely match the associated type, modulo the modifiers like
&and&mut. e.g. you can't define a getter likefn optional_name(&self) -> Option<&Self::Name>.