Add some high-level docs to FnCtxt and ItemCtxt
#100256
Merged
Conversation
This file contains 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
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!
rustbot
added
the
T-compiler
rust-highfive
added
the
S-waiting-on-review
|
Please let me know if I mixed these up or if there are any other inaccuracies :) |
| @@ -26,6 +26,8 @@ use rustc_trait_selection::traits::{ObligationCause, ObligationCauseCode}; | |||
| use std::cell::{Cell, RefCell}; | |||
| 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*. | |||
There was a problem hiding this comment.
It's a bit more accurate to mention:
- that this is used to lower things where we don't care about the body. For example,
ItemCtxtis used to check structs and stuff too.
i. An important distinction is thatFnCtxthas anInferCtxt, whileItemCtxtexpects no inference to go on in there. - This is also (via the
AstConvtrait) primarily used for lowering things from HIR -> middle representations of things. For example, we use it in thetcx.type_ofquery, which does little checking and mostly lowering.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Ah, that makes sense! Thanks :)
This comment has been minimized.
This comment has been minimized.
camelid
force-pushed
the
typeck-ctxt-doc
branch
from
3e79ff2
to
2887e03
Compare
compiler-errors
approved these changes
Aug 8, 2022
dthompson11
approved these changes
Aug 8, 2022
|
@bors r=compiler-errors rollup |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Aug 8, 2022
…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`
|
@bors r- |
bors
added
S-waiting-on-author
camelid
force-pushed
the
typeck-ctxt-doc
branch
from
2887e03
to
31a0518
Compare
|
r=me when things work |
|
Should be good now. @bors r=compiler-errors |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Aug 10, 2022
…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
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.
I haven't understood the difference between these before, but
@compiler-errorshelped me clear it up. Hopefully this will help otherpeople who've been confused!
r? @compiler-errors