-
Notifications
You must be signed in to change notification settings - Fork 563
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
base: master
Are you sure you want to change the base?
Changes from all commits
84a8e30
2403b18
a9d8264
966e4b3
31f840e
375350a
f9cf9f5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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. | ||
|
|
||
| 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(loop {})` produces a type of `Option<!>`). | ||
|
|
||
| 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, | ||
| > }; | ||
| > ``` | ||
|
|
||
| > [!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. --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -96,6 +96,39 @@ Every binding in each `|` separated pattern must appear in all of the patterns i | |
| r[expr.match.binding-restriction] | ||
| Every binding of the same name must have the same type, and have the same binding mode. | ||
|
|
||
| r[expr.match.type] | ||
| The type of the overall `match` expression is the [least upper bound](../type-coercions.md#r-coerce.least-upper-bound) of the individual match arms. | ||
|
Comment on lines
+99
to
+100
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. If we're inlining the rule about determining the type based on the LUB for match, from https://doc.rust-lang.org/1.90.0/reference/type-coercions.html#r-coerce.least-upper-bound.intro, probably we'd need to do that for the other rules there also (and then either remove the list from there or convert it to an admonition or index).
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. As an aside, looking into this rule is what prompted me to file: |
||
|
|
||
| r[expr.match.empty] | ||
| If there are no match arms, then the `match` expression is diverging and the type is [`!`](../types/never.md). | ||
|
Member
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. does this require a diverging scrutinee expression to compile? probably worth adding an example either way
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. This is a good question! The answer is (subtly) no. Take the following: fn make<T>() -> T { loop {} }
enum Empty {}
fn diverging_match_no_arms() -> ! {
let e: Empty = make();
match e {}
}
Adding this as an example. |
||
|
|
||
| > [!EXAMPLE] | ||
| > ```rust | ||
| > # fn make<T>() -> T { loop {} } | ||
| > enum Empty {} | ||
| > | ||
| > fn diverging_match_no_arms() -> ! { | ||
| > let e: Empty = make(); | ||
| > match e {} | ||
| > } | ||
| > ``` | ||
|
|
||
|
|
||
| r[expr.match.conditional] | ||
| If either the scrutinee expression or all of the match arms diverge, then the entire `match` expression also diverges. | ||
|
|
||
| > [!NOTE] | ||
| > Even if the entire `match` expression diverges, its type may not be [`!`](../types/never.md). | ||
| > | ||
| >```rust,compile_fail,E0004 | ||
| > let a = match true { | ||
| > true => Some(panic!()), | ||
| > false => None, | ||
| > }; | ||
| > // Fails to compile because `a` has the type `Option<!>`. | ||
| > match a {} | ||
| >``` | ||
|
|
||
| r[expr.match.guard] | ||
| ## Match guards | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We try to keep the number of top-level chapters contained. Looking at it, perhaps most of what's here that can't be inlined on the pages for each expression would make sense appearing in the Expressions chapter (e.g., we talk about place and value expressions there -- the verbiage about when a place expression is diverging might make sense near that) and in the Never type chapter.