Rust 1.42を早めに深掘り

こんにちは、R&Dチームの齋藤(@aznhe21)です。 コロナウィルスの影響を受けて導入された時差勤務のおかげで早く帰ることができ、最近は平日も楽しいです。 リモートワークも出来ますが、家に籠もりきりになって逆に不健康になりそうで怖いのでやってません。

さて、本日、日本時間3/13(金)、Rust 1.42がリリースされました。 この記事ではRust 1.42での変更点を詳しく紹介します。 なお、この記事は公式リリースノートをベースに、意訳・編集・追記をしています。

3/13は青函トンネル開通によって海底駅が誕生した日

ピックアップ

個人的に注目する変更点を「ピックアップ」としてまとめました。 全ての変更点を網羅したリストは変更点リストをご覧ください。

一部のパニック時に表示される場所が呼び出し場所になった

Option::unwrapResult::unwrapなどでパニックした場合、今まではlibcoreの行番号が表示されていましたが、 Rust 1.42からはそのメソッドを呼び出した場所が表示されるようになります。

fn main() {
    let v: Option<u32> = None;
    v.unwrap();
}

今まで

thread 'main' panicked at 'called `Option::unwrap()` on a `None` value', /rustc/f3e1a954d2ead4e2fc197c7da7d71e6c61bad196/src/libcore/macros/mod.rs:15:40
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace.

Rust 1.42から

thread 'main' panicked at 'called `Option::unwrap()` on a `None` value', src/main.rs:3:5
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

スライスを柔軟にパターンマッチ出来るようになった

以前から、スライス全ての要素を指定するパターンマッチは書けていました。 ただ、これではとても読みにくいのが分かるかと思います。

enum ImageFormat {
  Jpeg,
  Png,
  Gif,
}

// 画像の形式を検出する関数
fn guess_image_format(data: &[u8]) -> Option<ImageFormat> {
    // マッチさせたい長さにそれぞれ切り出して比較する
    match (&data[0..=3], &data[0..=8], &data[0..=6]) {
        (&[0xFF, 0xD8, 0xFF], _, _) => Some(ImageFormat::Jpeg),
        (_, b"\x89PNG\r\n\x1A\x0A", _) => Some(ImageFormat::Png),
        (_, _, b"GIF87a") | (_, _, b"GIF89a") => Some(ImageFormat::Gif),
        _ => None,
    }
}

このコードがRust 1.42からはシンプルに書けるようになります。

enum ImageFormat {
  Jpeg,
  Png,
  Gif,
}

// 画像の形式を検出する関数
fn guess_image_format(data: &[u8]) -> Option<ImageFormat> {
    // バイト文字列は使えなくなってしまうが、長さを明示する必要はなく拡張しやすい
    match data {
        &[0xFF, 0xD8, 0xFF, ..] => Some(ImageFormat::Jpeg),
        &[0x89, b'P', b'N', b'G', b'\r', b'\n', 0x1A, 0x0A, ..] => Some(ImageFormat::Png),
        &[b'G', b'I', b'F', b'8', b'7', b'a', ..] | &[b'G', b'I', b'F', b'8', b'9', b'a', ..] => {
            Some(ImageFormat::Gif)
        }
        _ => None,
    }
}

値がパターンにマッチするかどうかを検査できるようになった

matches!マクロにより、値がパターンにマッチするかどうかを検査できるようになりました。 今まではmatchesクレートを使えばこの機能を実現できていましたが、これからは標準ライブラリだけで実現できます。

fn main() {
    let data = b"\xFF\xD8\xFF\xE0\x00\x10JFIF\x00\x01\x01\x00\x00\x01\x00\x01\x00\x00\xFF\xDB\x00C";
    // data.starts_with()でも良い
    if matches!(data, &[0xFF, 0xD8, 0xFF, ..]) {
        println!("JPEGっぽい");
    }
}

なお、matchesクレートにあったassert_matches!マクロは標準化されていないため、 テスト時にはassert!マクロと組み合わせる必要があります。

#[derive(Debug, PartialEq, Eq)]
enum Hoge {
    Fuga { foo: u32 },
    Piyo { bar: u32 },
}

#[test]
fn test() {
    let v = Hoge::Fuga { foo: 100 };
    assert!(matches!(v, Hoge::Piyo { bar: 100 }), "Hoge::Piyoではない🤔");
}

CondVarで条件を満たすまで待機することが出来るようになった

条件変数は一般的にspurious wakeupのために単体では使わず、別の変数を用いて正しい条件のもと待機する必要があるものです。 今まで、Rustの条件変数にはその機能がなかったため、公式サンプルのようにループで処理しなければならず、面倒でした。

Rust 1.42からはMutex内部の値をもとに待機することが出来るようになり、Condvarを簡単に使えるようになります。

use std::sync::{Arc, Condvar, Mutex};
use std::thread;

fn main() {
    let pair = Arc::new((Mutex::new(false), Condvar::new()));
    let pair2 = pair.clone();

    thread::spawn(move || {
        let (lock, cvar) = &*pair2;
        let mut started = lock.lock().unwrap();
        *started = true;

        cvar.notify_one();
    });

    let (lock, cvar) = &*pair;
    let started = lock.lock().unwrap();

    // 以前はwhile !*started {}で回す必要があった
    // クロージャーにはMutex<bool>の内部の値への可変参照(&mut bool)が渡される
    let _ = cvar.wait_while(started, |started| !*started).unwrap();
}

変更点リスト

言語

スライスに部分的にパターンマッチ出来るようになった

スライスの一部分にマッチするパターンが書けるようになった。

fn foo(words: &[&str]) {
    match words {
        ["Hello", "World", "!", ..] => println!("Hello World!"),
        ["Foo", "Bar", ..] => println!("Baz"),
        rest => println!("{:?}", rest),
    }
}

#[repr(transparent)]を単一バリアントのenumで使えるようになった

これにより、単一バリアントのenumが、内部に保持する値と同じメモリレイアウト、同じABIで使えるようになる。

いくつかの構文のみの変更

構文上でのみ、以下の記述が許されるようになった。

  • トレイト内アイテムでのdefaultが構文的に許されるようになった
  • 実装ブロック内で定義される定数や型、関数などにおいて、内容の無いまま;が来ても、構文上は許されるようになった
  • 実装ブロック内の関連型での境界が構文上許されるようになった(例:type Foo: Ord;
  • ...(Cの可変長型) が、あらゆる関数において型として、構文上は使えるようになった

これらは依然としてコンパイルエラーとなるが、手続きマクロや条件コンパイルにおいては使用することが出来る。

コンパイラ

サポートするターゲットの変更

※RustのTierによるプラットフォームサポートの詳細はプラットフォームサポートのページを参照 ※訳注:英語ページ

パニック時に表示される場所がlibcoreではなく呼び出し元になった

Option::{expect,unwrap}及びResult::{expect, expect_err, unwrap, unwrap_err}のパニック時のメッセージにおいて、 表示されるパスや行番号が、libcoreではなくそれらメソッドの呼び出し元メソッドになった

ライブラリ

iter::Emptyが常にSendやSyncを実装するようになった

TSendSyncを実装していなくても、iter::Empty<T>SendSyncを実装するようになった。

PinのいくつかのメソッドがSizedを要求しなくなった

Pin::{map_unchecked, map_unchecked_mut}において、戻り値がSizedである必要がなくなった。

io::CursorがPartialEqとEqを導出するようになった

io::Cursor同士を比較することが出来るようになった。

Layout::newが定数関数となった

メモリを確保するためのレイアウトを定数として持つことが出来るようになった。

riscv64gc-unknown-linux-gnu向けに標準ライブラリのサポートが追加された

RISC-V 64bit GNU/Linux向けの標準ライブラリのサポートが追加された。

安定化されたAPI

CondVar::wait_while

条件変数が通知を受け取り、かつ要求された関数がtrueを返すまで、現在のスレッドをブロックする。

この関数は指定されたミューテックスを自動でアンロックし、その後スレッドをブロックする。 必然的に、ロックが解除されたあとに発生するnotify_onenotify_allの呼び出しによってスレッドが起床されるということである。 この関数が戻った時、指定されたミューテックスは再度ロックされる。

CondVar::wait_timeout_while

条件変数が通知を受け取り、かつ要求された関数がtrueを返す、あるいは指定された時間が経過するまで現在のスレッドをブロックする。

この関数は指定された時間よりも長くスレッドをブロックしないことを除けば、 wait_untilと同じ使い方が出来る。

なお、タイムアウトは相対時間で計測されるため、システム時刻を変更しても影響はない。

戻り値のWaitTimeoutResultは条件が満たされずにタイムアウトしたかどうかを示す。

wait_whileのように、 タイムアウトしたかどうかに関わらず、この関数が戻ったときは指定されたミューテックスは再度ロックされる。

DebugMap::key

Mapの出力に対し、新しくキー部分を追加する。

valueメソッドと共に使われるこのメソッドは、entryメソッドの代わりとして、 ループ中にエントリ全体が取得できないときに使うことが出来る。 エントリ全体が取得できている際はentryメソッドを使うことが推奨される。

keyメソッドはvalueメソッドと共に使われなければならず、 keyの後にvalueが呼ばれなかったり、keyの前にvalueが呼ばれたりするとパニックする。

DebugMap::value

Mapの出力に対し、新しく値部分を追加する。

keyメソッドと共に使われるこのメソッドは、entryメソッドの代わりとして、 ループ中にエントリ全体が取得できないときに使うことが出来る。 エントリ全体が取得できている際はentryメソッドを使うことが推奨される。

valueメソッドはkeyメソッドと共に使われなければならず、 valueの前にkeyが呼ばれなかったり、valueの後にkeyが呼ばれたりするとパニックする。

ManuallyDrop::take

ManuallyDrop<T>が保持する値を、所有権を奪わずに取得する。

このメソッドは主に値を破棄するために使われる。 ManuallyDrop::dropの代わりに、値を取得して何らかの処理を行う際に使うことが出来る。

値の複製を防ぐために、出来る限りinto_innerを使うべきである。

この関数は以降のManuallyDropの使用を制限しないまま、ManuallyDropの値を変化させずに値をムーブする。 ManuallyDropが再度使用されることが無いよう、実装者が責任を持つ必要がある。

matches!

指定された値が、指定されたパターンにマッチするかどうかを返す。 match式のように、パターンにはifを続けることが出来る。

ptr::slice_from_raw_parts_mut

ptr::slice_from_raw_partsと同じだが、不変スライスではなく可変スライスが返される点が異なる。

詳しくはptr::slice_from_raw_partsのドキュメントを参照されたい。

この関数は安全だが、戻り値の使用は非安全である。安全なスライスの要件はslice::from_raw_parts_mutのドキュメントを参照されたい。

ptr::slice_from_raw_parts

ポインタと長さから、スライスへのポインタに変換する。

第二引数はスライスの長さを示す。バイト数ではない。

この関数は安全だが、戻り値の使用は非安全である。安全なスライスの要件はslice::from_raw_partsのドキュメントを参照されたい。

Cargo

互換性メモ

関連リンク

さいごに

次のRust 1.43は2020/4/24(金)に予定されています。 Box<[T]>からBox<[T; N]>に変換する機能などの導入が予定されています。 配列を借用せずにイテレートする機能は互換性の面から難航しているようです・・・。ArrayVecを使いましょう。

オプティムではトンネリングエンジニアを募集しています。

ライセンス表記

  • この記事はApache 2/MITのデュアルライセンスで公開されている公式リリースノートを翻訳・追記をしています
  • 冒頭の画像中にはRust公式サイトで配布されているロゴを使用しており、 このロゴはMozillaによってCC-BYの下で配布されています
  • 冒頭の画像はいらすとやさんの画像を使っています。いつもありがとうございます

MIT License

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Apache License

                              Apache License
                        Version 2.0, January 2004
                     http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

   To apply the Apache License to your work, attach the following
   boilerplate notice, with the fields enclosed by brackets "[]"
   replaced with your own identifying information. (Don't include
   the brackets!)  The text should be enclosed in the appropriate
   comment syntax for the file format. We also recommend that a
   file or class name and description of purpose be included on the
   same "printed page" as the copyright notice for easier
   identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.