Rust: Implement toString for struct fields and visibility#20924
Merged
paldepind merged 3 commits intogithub:mainfrom Dec 1, 2025
Merged
Rust: Implement toString for struct fields and visibility#20924paldepind merged 3 commits intogithub:mainfrom
toString for struct fields and visibility#20924paldepind merged 3 commits intogithub:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements custom toString methods for StructField and Visibility AST nodes in the Rust CodeQL library, improving their string representations from generic class names to meaningful syntax-based descriptions.
- Implements
toStringforVisibilityto displaypuborpub(path)instead ofVisibility - Implements
toStringforStructFieldto display field signatures likefield: typeorpub field: type - Updates all test expectations to reflect the new string representations
Reviewed changes
Copilot reviewed 7 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
rust/ql/lib/codeql/rust/elements/internal/VisibilityImpl.qll |
Implements toStringImpl and toAbbreviatedString for Visibility to render as pub or pub(path) |
rust/ql/lib/codeql/rust/elements/internal/StructFieldImpl.qll |
Implements toStringImpl for StructField to render field signatures with optional visibility, name, and type |
rust/ql/.gitattributes |
Removes VisibilityImpl.qll from linguist-generated list since it's now hand-modified |
rust/ql/.generated.list |
Removes VisibilityImpl.qll from the generated files list |
rust/ql/test/extractor-tests/utf8/ast.expected |
Updates test expectations for Visibility and StructField toString output |
rust/ql/test/extractor-tests/macro-in-library/PrintAst.expected |
Updates test expectations for Visibility toString output |
rust/ql/test/extractor-tests/macro-expansion/PrintAst.expected |
Updates test expectations for Visibility and StructField toString output |
rust/ql/test/extractor-tests/generated/Visibility/Visibility.expected |
Updates test expectations for Visibility instances |
rust/ql/test/extractor-tests/generated/Trait/Trait.expected |
Updates test expectations for Visibility in trait declarations |
rust/ql/test/extractor-tests/generated/StructFieldList/StructFieldList.expected |
Updates test expectations for StructField instances in field lists |
rust/ql/test/extractor-tests/generated/StructField/StructField.expected |
Updates test expectations for StructField instances |
rust/ql/test/extractor-tests/generated/Module/Module.expected |
Updates test expectations for Visibility in module declarations |
rust/ql/test/extractor-tests/generated/MacroDef/MacroDef.expected |
Updates test expectations for Visibility in macro definitions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hvitved
requested changes
Nov 30, 2025
| /** Holds if this record field is named `name` and belongs to the struct `s`. */ | ||
| predicate isStructField(Struct s, string name) { this = s.getStructField(name) } | ||
|
|
||
| override string toStringImpl() { result = concat(int i | | this.toStringPart(i) order by i) } |
Contributor
Author
There was a problem hiding this comment.
Done. But I don't really understand why. It doesn't make a difference here does it? Should we use strictconcat in all toStringImpls (like this one)?
Contributor
There was a problem hiding this comment.
strictconcat produces slightly simpler DIL; it is generally always preferable to use strict aggregates when we know that the range is non-empty.
Contributor
Author
There was a problem hiding this comment.
Thanks. So the answer to the second question is: yes, we should also use strictconcat in the other toStringImpls.
hvitved
approved these changes
Dec 1, 2025
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
2 participants
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.
Implements
toStringforStructFieldandVisibility.