feat!: Hide FuncDefn/cl fields, add accessors and ::new(...) #2213
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
aborgna-q
reviewed
May 14, 2025
Comment on lines
+66
to
+67
| /// Create a new instance with the given name and signature | ||
| pub fn new(name: impl Into<String>, signature: impl Into<PolyFuncType>) -> Self { |
There was a problem hiding this comment.
Couldn't we just add new_public now, since it's what it's effectively doing?
There was a problem hiding this comment.
I think new is the right move now since the semantics of "public" are not defined yet, we can deprecate it when adding new_public and new_private which will indicate downstream that changes are required because linters will complain (even though it will be non-breaking)
There was a problem hiding this comment.
I don't think it is. Quite a lot of code (e.g. dataflow analyses) takes an explicit list of entry points rather than assuming functions are public/private. Moreover, public functions not child of the Module, will likely become illegal...
Seyon suggests that we can deprecate this when adding new_private/new_public, which sounds good to me.
|
This PR contains breaking changes to the public Rust API. cargo-semver-checks summary |
acl-cqc
changed the title
|
I'm not really persuaded about hiding |
|
No, if there's at least one private field then |
acl-cqc
changed the title
ss2165
reviewed
May 14, 2025
hugr-core/src/ops/module.rs
Outdated
| &self.name | ||
| } | ||
|
|
||
| /// Sets the name of the function (as per [Self::func_name]) |
There was a problem hiding this comment.
Suggested change
| /// Sets the name of the function (as per [Self::func_name]) | |
| /// Allows mutating the name of the function (as per [Self::func_name]) |
hugr-core/src/ops/module.rs
Outdated
| } | ||
| } | ||
|
|
||
| /// The name of the function (not, the name of the Op) |
There was a problem hiding this comment.
Suggested change
| /// The name of the function (not, the name of the Op) | |
| /// The name of the function (not the name of the Op) |
| /// The name of the function (not, the name of the Op) | ||
| pub fn func_name(&self) -> &String { | ||
| &self.name | ||
| } |
There was a problem hiding this comment.
Yeah, so this lead to spotting #2215
ss2165
approved these changes
May 14, 2025
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2213 +/- ##
==========================================
- Coverage 82.10% 82.00% -0.10%
==========================================
Files 230 230
Lines 40943 40940 -3
Branches 37044 37041 -3
==========================================
- Hits 33616 33574 -42
- Misses 5363 5398 +35
- Partials 1964 1968 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This was referenced May 14, 2025
Merged
Closed
Closed
Merged
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.
Accessors ::func_name, ::func_name_mut, ::signature, ::signature_mut.
Constructor ::new takes name + sig using
impl Into.BREAKING CHANGE: construction, destruction, and field access should use new methods