From 0666e81df74c3c68b6ddbd99f456e4d57129f157 Mon Sep 17 00:00:00 2001 From: TonalidadeHidrica <47710717+TonalidadeHidrica@users.noreply.github.com> Date: Thu, 6 Feb 2025 00:03:29 +0900 Subject: [PATCH 1/4] =?UTF-8?q?if=20let=20=E3=82=B9=E3=82=B3=E3=83=BC?= =?UTF-8?q?=E3=83=97=E3=82=92=E9=80=94=E4=B8=AD=E3=81=BE=E3=81=A7=E7=BF=BB?= =?UTF-8?q?=E8=A8=B3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/rust-2024/temporary-if-let-scope.md | 191 ++++++++++++++++++++++++ 1 file changed, 191 insertions(+) create mode 100644 src/rust-2024/temporary-if-let-scope.md diff --git a/src/rust-2024/temporary-if-let-scope.md b/src/rust-2024/temporary-if-let-scope.md new file mode 100644 index 0000000..92e9b4b --- /dev/null +++ b/src/rust-2024/temporary-if-let-scope.md @@ -0,0 +1,191 @@ + + +# `if let` の一時スコープ + + + +## 概要 + + + +- 式 `if let $pat = $expr { .. } else { .. }` において `$expr`を評価する際に作られる一時値は、`else` 節以降が実行される前にドロップされます。 + + + +## 詳細 + + + +2024 エディションでは、`if let` 式の被検査体 (scurtinee) [^scurtinee]における[一時値 (temporary value)]のドロップスコープが変わります。 +これは、一時値の生存期間が長すぎることによる、ある意味想定外の挙動を避けるためのものです。 + + + +2024 より前は、以下のように、一時値が `if let` 式自体の末尾まで生存し続けることがありました。 + + + +```rust,edition2021 +// 2024 より前 +# use std::sync::RwLock; + +fn f(value: &RwLock>) { + if let Some(x) = *value.read().unwrap() { + println!("value is {x}"); + } else { + let mut v = value.write().unwrap(); + if v.is_none() { + *v = Some(true); + } + } + // <--- 読み取りロックはここでドロップされる +} +``` + + + +この例では、`value.read()` によって生成された一時的な読み取りロックが、`if let` 式の末尾まで（`else` 節の末尾まで）ドロップされませんでした。 +`else` 節が実行された場合、書き込みロックを取得しようとしてデッドロックが発生してしまいます。 + + + +2024 エディションでは、一時値の生存期間は then 節（`if let` の直後の `{ }` ブロック）の評価が完了したとき、あるいは `else` 節が開始するときに打ち切られます。 + + + +```rust,edition2024 +// 2024 以降 +# use std::sync::RwLock; + +fn f(value: &RwLock>) { + if let Some(x) = *value.read().unwrap() { + println!("value is {x}"); + } + // <--- 2024 では、読み取りロックはここでドロップされる + else { + let mut s = value.write().unwrap(); + if s.is_none() { + *s = Some(true); + } + } +} +``` + + + +一時スコープの範囲に関しての詳細は、[一時値のスコープ規則]をご参照ください。 +[末尾式の一時スコープ]の節では、末尾式に対する同様の変更について説明しています。 + + + +[^scrutinee]: [被検査体 (scurtinee)] とは、`if let` 式でマッチするかを検査される式（`=` 以降の式）のことです。 + + + +[被検査体 (scurtinee)]: https://doc.rust-lang.org/reference/glossary.html#scrutinee +[一時値 (temporary value)]: https://doc.rust-lang.org/reference/expressions.html#temporaries +[一時値のスコープ規則]: https://doc.rust-lang.org/reference/destructors.html#temporary-scopes +[末尾式の一時スコープ]: temporary-tail-expr-scope.md + +## Migration + +It is always safe to rewrite `if let` with a `match`. The temporaries of the `match` scrutinee are extended past the end of the `match` expression (typically to the end of the statement), which is the same as the 2021 behavior of `if let`. + +The [`if_let_rescope`] lint suggests a fix when a lifetime issue arises due to this change or the lint detects that a temporary value with a custom, non-trivial `Drop` destructor is generated from the scrutinee of the `if let`. For instance, the earlier example may be rewritten into the following when the suggestion from `cargo fix` is accepted: + +```rust +# use std::sync::RwLock; +fn f(value: &RwLock>) { + match *value.read().unwrap() { + Some(x) => { + println!("value is {x}"); + } + _ => { + let mut s = value.write().unwrap(); + if s.is_none() { + *s = Some(true); + } + } + } + // <--- Read lock is dropped here in both 2021 and 2024 +} +``` + +In this particular example, that's probably not what you want due to the aforementioned deadlock! However, some scenarios may be assuming that the temporaries are held past the `else` clause, in which case you may want to retain the old behavior. + +The [`if_let_rescope`] lint is part of the `rust-2024-compatibility` lint group which is included in the automatic edition migration. In order to migrate your code to be Rust 2024 Edition compatible, run: + +```sh +cargo fix --edition +``` + +After the migration, it is recommended that you review all of the changes of `if let` to `match` and decide what is the behavior that you need with respect to when temporaries are dropped. If you determine that the change is unnecessary, then you can revert the change back to `if let`. + +If you want to manually inspect these warnings without performing the edition migration, you can enable the lint with: + +```rust +// Add this to the root of your crate to do a manual migration. +#![warn(if_let_rescope)] +``` + +[`if_let_rescope`]: https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#if-let-rescope From c49a95fd1d8da32423e6d060ed0c1618ff358277 Mon Sep 17 00:00:00 2001 From: TonalidadeHidrica <47710717+TonalidadeHidrica@users.noreply.github.com> Date: Wed, 12 Feb 2025 13:50:34 +0900 Subject: [PATCH 2/4] =?UTF-8?q?=E7=BF=BB=E8=A8=B3=E3=81=8C=E5=AE=8C?= =?UTF-8?q?=E4=BA=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/rust-2024/temporary-if-let-scope.md | 57 +++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/src/rust-2024/temporary-if-let-scope.md b/src/rust-2024/temporary-if-let-scope.md index 92e9b4b..9c192b1 100644 --- a/src/rust-2024/temporary-if-let-scope.md +++ b/src/rust-2024/temporary-if-let-scope.md @@ -147,12 +147,25 @@ See the [temporary scope rules] for more information about how temporary scopes [一時値のスコープ規則]: https://doc.rust-lang.org/reference/destructors.html#temporary-scopes [末尾式の一時スコープ]: temporary-tail-expr-scope.md + + +## 移行 + +`if let` はいつでも `match` に安全に書き換えられます。 +`match` の被検査体で生成される一時値は、2021 における `if let` の挙動と同様、少なくとも `match` 式の末尾まで（多くの場合、文の末尾まで）生存します。 + +[`if_let_rescope`] リントは、本変更によってライフタイムの問題が発生する場合や、`if let` の被検査体で生成される一時値が独自の非自明な `Drop` デストラクタをもつ場合に、修正案を提示します。 +例えば、前述の例に対して `cargo fix` の提案を適用した場合、以下のように書き換えられます。 + + +```rust +# use std::sync::RwLock; +fn f(value: &RwLock>) { + match *value.read().unwrap() { + Some(x) => { + println!("value is {x}"); + } + _ => { + let mut s = value.write().unwrap(); + if s.is_none() { + *s = Some(true); + } + } + } + // <--- Rust 2021 でも 2024 でも、読み取りロックはここでドロップされる +} +``` + +特に上記のコードでは、前述の通りデッドロックが起こるため望む挙動ではないでしょうが、場合によっては従来の挙動そのままに、一時値が `else` 節以降も生き延びることを意図することもあるでしょう。 + + + +[`if_let_rescope`] リントは、自動エディション移行に含まれる `rust-2024-compatibility` リントグループの一部です。 +コードを Rust 2024 に移行するには、以下を実行します。 ```sh cargo fix --edition ``` + + +移行後、`if let` から `match` へ変更された箇所をチェックし、一時値がドロップされるタイミングを再確認することを推奨します。 +変更が不要と判断した場合は、`if let` へ戻すとよいでしょう。 + + +エディション移行ツールを使わずに手動で確認したい場合は、以下のリントをオンにしてください。 + + +```rust +// クレートのトップレベルに以下を追加すると手動移行できる +#![warn(if_let_rescope)] +``` [`if_let_rescope`]: https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#if-let-rescope From 53dbd33b2e42179e08e9bf3c273ac8375ef84cb3 Mon Sep 17 00:00:00 2001 From: TonalidadeHidrica <47710717+TonalidadeHidrica@users.noreply.github.com> Date: Wed, 12 Feb 2025 13:52:45 +0900 Subject: [PATCH 3/4] =?UTF-8?q?=E5=8E=9F=E6=96=87=E3=81=AE=E3=83=AA?= =?UTF-8?q?=E3=83=B3=E3=82=AF=E3=82=82=E8=AA=A4=E3=81=A3=E3=81=A6=E8=87=AA?= =?UTF-8?q?=E5=8B=95=E4=BF=AE=E6=AD=A3=E3=81=97=E3=81=A6=E3=81=84=E3=81=9F?= =?UTF-8?q?=E3=81=AE=E3=81=A7=E5=BE=A9=E5=85=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/rust-2024/temporary-if-let-scope.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/rust-2024/temporary-if-let-scope.md b/src/rust-2024/temporary-if-let-scope.md index 9c192b1..5411345 100644 --- a/src/rust-2024/temporary-if-let-scope.md +++ b/src/rust-2024/temporary-if-let-scope.md @@ -136,9 +136,9 @@ See the [temporary scope rules] for more information about how temporary scopes [^scrutinee]: [被検査体 (scurtinee)] とは、`if let` 式でマッチするかを検査される式（`=` 以降の式）のことです。 @@ -245,4 +245,8 @@ If you want to manually inspect these warnings without performing the edition mi #![warn(if_let_rescope)] ``` + + [`if_let_rescope`]: https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#if-let-rescope From 5a0028f18db02df661f50a0e3490a1229f0f84a2 Mon Sep 17 00:00:00 2001 From: TonalidadeHidrica <47710717+TonalidadeHidrica@users.noreply.github.com> Date: Mon, 17 Feb 2025 13:09:46 +0900 Subject: [PATCH 4/4] =?UTF-8?q?=E8=A8=B3=E6=96=87=E3=82=92=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/SUMMARY.md | 2 +- src/rust-2024/temporary-if-let-scope.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index ab10822..bc505c3 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -115,7 +115,7 @@ - [Rust 2024](rust-2024/index.md) - [Language](rust-2024/language.md) - [RPIT lifetime capture rules](rust-2024/rpit-lifetime-capture.md) - - [`if let` temporary scope](rust-2024/temporary-if-let-scope.md) + - [`if let` の一時スコープ](rust-2024/temporary-if-let-scope.md) - [Tail expression temporary scope](rust-2024/temporary-tail-expr-scope.md) - [Match ergonomics reservations](rust-2024/match-ergonomics.md) - [Unsafe `extern` blocks](rust-2024/unsafe-extern.md) diff --git a/src/rust-2024/temporary-if-let-scope.md b/src/rust-2024/temporary-if-let-scope.md index 5411345..d5c4316 100644 --- a/src/rust-2024/temporary-if-let-scope.md +++ b/src/rust-2024/temporary-if-let-scope.md @@ -14,7 +14,7 @@ - In an `if let $pat = $expr { .. } else { .. }` expression, the temporary values generated from evaluating `$expr` will be dropped before the program enters the `else` branch instead of after. --> -- 式 `if let $pat = $expr { .. } else { .. }` において `$expr`を評価する際に作られる一時値は、`else` 節以降が実行される前にドロップされます。 +- 式 `if let $pat = $expr { .. } else { .. }` において `$expr`を評価する際に作られる一時値は、`else` 節以降が実行された後ではなく、実行される前にドロップされます。 -2024 エディションでは、`if let` 式の被検査体 (scurtinee) [^scurtinee]における[一時値 (temporary value)]のドロップスコープが変わります。 -これは、一時値の生存期間が長すぎることによる、ある意味想定外の挙動を避けるためのものです。 +2024 エディションでは、`if let` 式の被検査体 (scurtinee)[^scurtinee]における[一時値 (temporary value)] のドロップスコープが変わります。 +これは、一時値の生存期間が長すぎることによる、ときに想定外の挙動を避けるためのものです。 -2024 より前は、以下のように、一時値が `if let` 式自体の末尾まで生存し続けることがありました。 +2024 より前は、以下のように、一時値が `if let` 式自体の末尾まで生存し続けていました。 -この例では、`value.read()` によって生成された一時的な読み取りロックが、`if let` 式の末尾まで（`else` 節の末尾まで）ドロップされませんでした。 +この例では、`value.read()` によって生成された一時的な読み取りロックが、`if let` 式の末尾まで（`else` 節の末尾まで）ドロップされません。 `else` 節が実行された場合、書き込みロックを取得しようとしてデッドロックが発生してしまいます。 -[^scrutinee]: [被検査体 (scurtinee)] とは、`if let` 式でマッチするかを検査される式（`=` 以降の式）のことです。 +[^scurtinee]: [被検査体 (scurtinee)] とは、`if let` 式でマッチするかを検査される式（`=` 以降の式）のことです。