Export fieldindex
#58119
Open
Export fieldindex
#58119
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
At present, we export `Base.fieldname`, which maps a field's index to its symbol. Although we have the inverse function, `Base.fieldindex`, which maps a field's symbol to its index, defined and documented, we currently do not export it. This PR changes this and exports it to enhance the consistency and completeness of the field introspection functions. Additionally, it is unlikely that the function will undergo fundamental changes in the future, so exporting it should not pose a significant maintenance burden. The interface is likely fully defined by the following two properties. ```julia @test fieldname(Some{Int}, Base.fieldindex(Some{Int}, :value)) === :value @test Base.fieldindex(Some{Int}, fieldname(Some{Int}, 1)) === 1 ``` Besides doing the `export`, this PR adapts the documentation and adds test cases. Fixes JuliaLang#58092 Thanks to @nsajko for the support in covering all artifacts.
ararslan
approved these changes
Apr 15, 2025
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.
At present, we export
Base.fieldname, which maps a field's index to its symbol. Although we have the inverse function,Base.fieldindex, which maps a field's symbol to its index, defined and documented, we currently do not export it.This PR changes this and exports it to enhance the consistency and completeness of the field introspection functions. Additionally, it is unlikely that the function will undergo fundamental changes in the future, so exporting it should not pose a significant maintenance burden. The interface is likely fully defined by the following two properties.
Besides doing the
export, this PR adapts the documentation and adds test cases.Fixes #58092
Thanks to @nsajko for the support in covering all artifacts.