-
Notifications
You must be signed in to change notification settings - Fork 565
Add a chapter on divergence #2067
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
Open
jackh726
wants to merge
9
commits into
rust-lang:master
Choose a base branch
from
jackh726:reference-type-inference-divergence
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+168
−2
Open
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
84a8e30
Write chapter on divergence
jackh726 2403b18
Slight edits from lcnr's review
jackh726 a9d8264
Address some review comments
jackh726 966e4b3
Use functions returning ! in tests
jackh726 31f840e
Reviews from Jane
jackh726 375350a
Fix test - updating items.fn.implicit-return to be more specific
jackh726 f9cf9f5
Fix CI
jackh726 09d0f2b
Add section about uninhabited types in divergence.md
jackh726 4f34b11
Address Niko's comments.
jackh726 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| r[divergence] | ||
| # Divergence | ||
|
|
||
| r[divergence.intro] | ||
| Divergence is the state where a particular section of code could never be encountered at runtime. Importantly, while there are certain language constructs that immediately produce a _diverging expression_ of the type [`!`](./types/never.md), divergence can also propogate to the surrounding block. | ||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Any expression of type [`!`](./types/never.md) is a _diverging expression_, but there are also diverging expressions which are not of type `!` (e.g. `Some(panic!())`). | ||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| r[divergence.fallback] | ||
| ## Fallback | ||
| If a type to be inferred is only unified with diverging expressions, then that type will be inferred to be `!`. | ||
|
|
||
| > [!EXAMPLE] | ||
| > ```rust,compile_fail,E0277 | ||
| > fn foo() -> i32 { 22 } | ||
| > match foo() { | ||
| > // ERROR: The trait bound `!: Default` is not satisfied. | ||
| > 4 => Default::default(), | ||
| > _ => return, | ||
| > }; | ||
| > ``` | ||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| > [!EDITION-2024] | ||
| > Before the 2024 edition, the type was inferred to instead be `()`. | ||
| > [!NOTE] | ||
| > Importantly, type unification may happen *structurally*, so the fallback `!` may be part of a larger type. The > following compiles: | ||
| > ```rust | ||
| > fn foo() -> i32 { 22 } | ||
| > // This has the type `Option<!>`, not `!` | ||
| > match foo() { | ||
| > 4 => Default::default(), | ||
| > _ => Some(return), | ||
| > }; | ||
| > ``` | ||
| <!-- TODO: This last point should likely should be moved to a more general "type inference" section discussing generalization + unification. --> | ||
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -44,7 +44,7 @@ r[expr.block.result] | |||||||||||||||||
| Then the final operand is executed, if given. | ||||||||||||||||||
|
|
||||||||||||||||||
| r[expr.block.type] | ||||||||||||||||||
| The type of a block is the type of the final operand, or `()` if the final operand is omitted. | ||||||||||||||||||
| Except in the case of divergence (see below), the type of a block is the type of the final operand, or `()` if the final operand is omitted. | ||||||||||||||||||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||
|
|
||||||||||||||||||
| ```rust | ||||||||||||||||||
| # fn fn_call() {} | ||||||||||||||||||
|
|
@@ -63,6 +63,48 @@ assert_eq!(5, five); | |||||||||||||||||
| > [!NOTE] | ||||||||||||||||||
| > As a control flow expression, if a block expression is the outer expression of an expression statement, the expected type is `()` unless it is followed immediately by a semicolon. | ||||||||||||||||||
|
|
||||||||||||||||||
| r[expr.block.type.diverging] | ||||||||||||||||||
| A block is itself considered to be [diverging](../divergence.md) if all reachable control flow paths contain a [diverging expression](../divergence.md#r-divergence.diverging-expressions), unless that expression is a place expression that is not read from. | ||||||||||||||||||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||
|
|
||||||||||||||||||
| ```rust | ||||||||||||||||||
| # #![ feature(never_type) ] | ||||||||||||||||||
| # fn make<T>() -> T { loop {} } | ||||||||||||||||||
| let no_control_flow: ! = { | ||||||||||||||||||
| // There are no conditional statements, so this entire block is diverging. | ||||||||||||||||||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||
| loop {} | ||||||||||||||||||
| }; | ||||||||||||||||||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||
|
|
||||||||||||||||||
| let control_flow_diverging: ! = { | ||||||||||||||||||
| // All paths are diverging, so this entire block is diverging. | ||||||||||||||||||
| if true { | ||||||||||||||||||
| loop {} | ||||||||||||||||||
| } else { | ||||||||||||||||||
| loop {} | ||||||||||||||||||
| } | ||||||||||||||||||
| }; | ||||||||||||||||||
|
|
||||||||||||||||||
| let control_flow_not_diverging: () = { | ||||||||||||||||||
| // Some paths are not diverging, so this entire block is not diverging. | ||||||||||||||||||
| if true { | ||||||||||||||||||
| () | ||||||||||||||||||
| } else { | ||||||||||||||||||
| loop {} | ||||||||||||||||||
| } | ||||||||||||||||||
| }; | ||||||||||||||||||
|
|
||||||||||||||||||
| struct Foo { | ||||||||||||||||||
| x: !, | ||||||||||||||||||
| } | ||||||||||||||||||
|
Comment on lines
+95
to
+97
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can this be rewritten to use an empty enum to avoid the need for nightly features? For example:
Suggested change
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||||||||||||||
|
|
||||||||||||||||||
| let foo = Foo { x: make() }; | ||||||||||||||||||
| let diverging_place_not_read: () = { | ||||||||||||||||||
| let _: () = { | ||||||||||||||||||
| // Asssignment to `_` means the place is not read | ||||||||||||||||||
| let _ = foo.x; | ||||||||||||||||||
| }; | ||||||||||||||||||
| }; | ||||||||||||||||||
jackh726 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
traviscross marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||
| ``` | ||||||||||||||||||
|
|
||||||||||||||||||
| r[expr.block.value] | ||||||||||||||||||
| Blocks are always [value expressions] and evaluate the last operand in value expression context. | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.