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

Stronger typing for DefIds #623

Closed
1 of 3 tasks
Noratrieb opened this issue Apr 26, 2023 · 3 comments
Closed
1 of 3 tasks

Stronger typing for DefIds #623

Noratrieb opened this issue Apr 26, 2023 · 3 comments
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@Noratrieb
Copy link
Member

Proposal

Currently, the compiler just uses DefId everywhere. This is bad for correctness (you just get ICEs instead of compiler errors when passing an ID of the wrong kind) and documentation (DefId doesn't clearly document which kinds are expected).

Instead, we should be using more strongly typed versions that assert that correct IDs are passed at compile time and clearly document which kinds are expected.

This MCP proposes to add strongly typed versions of def ids like ModDefId or TraitDefId. These types will be used as much as possible when a specific def kind is expected.

When a specific set of multiple def kinds is accepted, we can also create newtypes for such a set specifically.

This will lead to a hierarchy of (local) def ids. Casting up (like from a TraitDefId to a DefId) will be possible using From and IntoQueryParam impls to make it as implicit as possible as there is no concern with such casts. I am not entirely sure yet on how to best write the required macros and impls to make sure that the addition of new IDs is as simple as possible, but this is my goal.

Local versions of all the typed def ids will exist as well.

I have already created an MVP PR for ModDefId and the results are quite promising: rust-lang/rust#110862

Mentors or Reviewers

I will not have the time to implement it all by myself, but I may be able to do some of the generic work necessary for making it easy to add new typed def ids. This is a big change affecting all regions of code.

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

Comments

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

@Noratrieb Noratrieb added T-compiler Add this label so rfcbot knows to poll the compiler team major-change A proposal to make a major change to rustc labels Apr 26, 2023
@rustbot
Copy link
Collaborator

rustbot commented Apr 26, 2023

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

cc @rust-lang/compiler @rust-lang/compiler-contributors

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Apr 26, 2023
@WaffleLapkin
Copy link
Member

@rustbot second

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label Apr 26, 2023
@apiraino
Copy link
Contributor

@rustbot label -final-comment-period +major-change-accepted

@rustbot rustbot added major-change-accepted A major change proposal that was accepted and removed final-comment-period The FCP has started, most (if not all) team members are in agreement labels May 10, 2023
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Development

No branches or pull requests

4 participants