Skip to content

Add some high-level docs to FnCtxt and ItemCtxt - #100256

Merged
bors merged 2 commits into
rust-lang:masterfrom
camelid:typeck-ctxt-doc
Aug 10, 2022
Merged

Add some high-level docs to FnCtxt and ItemCtxt#100256
bors merged 2 commits into
rust-lang:masterfrom
camelid:typeck-ctxt-doc

Conversation

@camelid

@camelidcamelid commented Aug 8, 2022

Copy link
Copy Markdown
Member

I haven't understood the difference between these before, but
@compiler-errors helped me clear it up. Hopefully this will help other
people who've been confused!

r? @compiler-errors

@camelid
Add some high-level docs to FnCtxt and ItemCtxt
1f75142
I haven't understood the difference between these before, but
`@compiler-errors` helped me clear it up. Hopefully this will help other
people who've been confused!
@rustbotrustbot added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Aug 8, 2022
@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 8, 2022
@camelid

camelid commented Aug 8, 2022

Copy link
Copy Markdown
MemberAuthor

Please let me know if I mixed these up or if there are any other inaccuracies :)

compiler-errors
compiler-errors reviewed Aug 8, 2022
View reviewed changes
Comment threadcompiler/rustc_typeck/src/check/fn_ctxt/mod.rs Outdated
use std::ops::Deref;

/// The `FnCtxt` stores type-checking context needed to type-check function bodies,
/// in contrast to [`ItemCtxt`], which is used to type-check item *signatures*.

@compiler-errorscompiler-errorsAug 8, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit more accurate to mention:

  1. that this is used to lower things where we don't care about the body. For example, ItemCtxt is used to check structs and stuff too.
    i. An important distinction is that FnCtxt has an InferCtxt, while ItemCtxt expects no inference to go on in there.
  2. This is also (via the AstConv trait) primarily used for lowering things from HIR -> middle representations of things. For example, we use it in the tcx.type_of query, which does little checking and mostly lowering.

@camelidcamelidAug 8, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I added the info you suggested.

The one thing is that I couldn't find an InferCtxt field -- or any mention of InferCtxt for that matter -- in FnCtxt. Is it accessed in some indirect way?

@compiler-errorscompiler-errorsAug 8, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it accessed in some indirect way

Yea, good question. It's stored in inh: &Inherited -- this is how several FnCtxts actually share the same InferCtxt. This Inherited struct is important because closures can share inference variables and other info to their containing functions, for example.

@camelidcamelidAug 8, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that makes sense! Thanks :)

compiler-errors
compiler-errors reviewed Aug 8, 2022
View reviewed changes
Comment threadcompiler/rustc_typeck/src/collect.rs Outdated
@rust-log-analyzer

This comment has been minimized.

Sign in to view
compiler-errors
compiler-errors approved these changes Aug 8, 2022
View reviewed changes

@compiler-errorscompiler-errors left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good addition, thanks.

r=me once CI is green.

@camelid

camelid commented Aug 8, 2022

Copy link
Copy Markdown
MemberAuthor

@bors r=compiler-errors rollup

@bors

bors commented Aug 8, 2022

Copy link
Copy Markdown
Collaborator

📌 Commit 2887e03 has been approved by compiler-errors

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 8, 2022
@matthiaskrgrmatthiaskrgr mentioned this pull request Aug 8, 2022
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 8, 2022
@matthiaskrgr
Rollup merge ofrust-lang#100256- camelid:typeck-ctxt-doc, r=compile…
156cd28
…r-errors
Add some high-level docs to `FnCtxt` and `ItemCtxt`
I haven't understood the difference between these before, but
``@compiler-errors`` helped me clear it up. Hopefully this will help other
people who've been confused!
r? `@compiler-errors`
@matthiaskrgr

matthiaskrgr commented Aug 9, 2022

Copy link
Copy Markdown
Member

@bors r-
failed in #100279 (comment)

@borsbors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Aug 9, 2022
@compiler-errors

compiler-errors commented Aug 9, 2022

Copy link
Copy Markdown
Contributor

r=me when things work

@camelid

camelid commented Aug 9, 2022

Copy link
Copy Markdown
MemberAuthor

Should be good now. @bors r=compiler-errors

@bors

bors commented Aug 9, 2022

Copy link
Copy Markdown
Collaborator

📌 Commit 31a0518 has been approved by compiler-errors

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Aug 9, 2022
@matthiaskrgrmatthiaskrgr mentioned this pull request Aug 9, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 10, 2022
@bors
Auto merge ofrust-lang#100346- matthiaskrgr:rollup-6rljn4p, r=matth…
0459d2f
…iaskrgr
Rollup of 14 pull requests
Successful merges:
- rust-lang#98775 (rustdoc: improve scroll locking in the rustdoc mobile sidebars)
- rust-lang#99479 (rustdoc-json: Remove doc FIXME for Import::id and explain)
- rust-lang#100040 (Error on broken pipe but do not backtrace or ICE)
- rust-lang#100072 (linker-plugin-lto.md: Correct the name of example c file)
- rust-lang#100098 (Some "this expression has a field"-related fixes)
- rust-lang#100226 (Do not manually craft a span pointing inside a multibyte character.)
- rust-lang#100240 (Fail gracefully when const pattern is not structural match.)
- rust-lang#100256 (Add some high-level docs to `FnCtxt` and `ItemCtxt`)
- rust-lang#100261 (Set tainted errors bit before emitting coerce suggestions.)
- rust-lang#100275 (also update anyhow in codegen_cranelift)
- rust-lang#100281 (Remove more Clean trait implementations)
- rust-lang#100314 (Mention `unit-test` in MIR opt test README)
- rust-lang#100319 (Remove more Clean trait implementations)
- rust-lang#100323 ([rustdoc] Don't render impl blocks with doc comment if they only contain private items by default)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 4add514 into rust-lang:masterAug 10, 2022
@rustbotrustbot added this to the 1.65.0 milestone Aug 10, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@compiler-errorscompiler-errorscompiler-errors approved these changes
@dthompson11dthompson11dthompson11 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@compiler-errorscompiler-errors

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.65.0

Development

Successfully merging this pull request may close these issues.

8 participants

@camelid@rust-log-analyzer@bors@matthiaskrgr@compiler-errors@dthompson11@rust-highfive@rustbot