Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement visibility for fields #4837

Closed
Tracked by #4515
jfecher opened this issue Apr 18, 2024 · 0 comments · Fixed by #6221
Closed
Tracked by #4515

Implement visibility for fields #4837

jfecher opened this issue Apr 18, 2024 · 0 comments · Fixed by #6221
Labels
enhancement New feature or request

Comments

@jfecher
Copy link
Contributor

jfecher commented Apr 18, 2024

Problem

The standard library includes several types such as BoundedVec and HashMap which are only meant to be interacted with via their APIs. Allowing users to access and mutate fields directly can lead to them being in an invalid state.

Happy Case

We should add visibility for fields (private, public, pub(crate)) to control access to them.

A private field would also make the constructor of a type automatically private.

Project Impact

None

Impact Context

No response

Workaround

None

Workaround Description

No response

Additional Context

No response

Would you like to submit a PR for this Issue?

None

Support Needs

No response

@jfecher jfecher added the enhancement New feature or request label Apr 18, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Apr 18, 2024
github-merge-queue bot pushed a commit that referenced this issue Oct 9, 2024
# Description

## Problem

Resolves #4837

Part of #4515

## Summary

This checks struct visibility in member access, constructors and
patterns.

## Additional Context

Private fields are still suggested in LSP. I plan to hide those fields
in a follow-up PR.


## Documentation

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[For Experimental Features]** Documentation to be submitted in a
separate PR.

# PR Checklist

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

1 participant