Rust 1.54を早めに深掘り

こんにちは、R&Dチームの齋藤（@aznhe21）です。オリンピックでは日本が金メダルラッシュですね！現地まで見に行けない分テレビ前での応援に力が入ります。

さて、本日、日本時間7/30(金)、Rust 1.54がリリースされました。この記事ではRust 1.54での変更点を詳しく紹介します。

7/30は映画「モスラ」公開の日総天然色　ラスト1.54

ピックアップ
安定化されたAPIのドキュメント
変更点リスト
関連リンク
さいごに
ライセンス表記

ピックアップ

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

一部の属性内で値としてマクロを使えるようになった

#[doc]など組込みの属性の中で、値としてマクロを使えるようになりました。

例えばこのように、ドキュメントにクレートのバージョンを含めることが出来ます。

// `/// version: 0.1.0`と書くのと同等
#[doc = concat!("version: ", env!("CARGO_PKG_VERSION"))]
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

また、README.mdを取り込むことでドキュメントの整備が簡単になります。

// lib.rs

// ここでREADME.mdの内容がクレートのドキュメントとして取り込まれる。
#![doc = include_str!("README.md")]

WebAssemblyでSIMDが使えるようになった

arch::wasm32モジュール内の関数が安定化されてSIMDが使えるようになりました。画像処理や機械学習などの高速化が期待出来ます。

eBPF向けにビルド出来るようになった

最近話題のeBPF向けに、ターゲットbpfel-unknown-none及びbpfeb-unknown-noneを使ってビルド出来るようになりました。 bpfel-unknown-noneはリトルエンディアン、bpfeb-unknown-noneはビッグエンディアンのようです。

ただし、これはティア3としてのサポートであるため動作は保証されておらず、場合によっては誤った動作をすることがあります。

安定化されたAPIのドキュメント

安定化されたAPIのドキュメントを独自に訳して紹介します。リストだけ見たい方は安定化されたAPIをご覧ください。

`BTreeMap::into_keys`

原典

impl<K, V> BTreeMap<K, V> {
    #[inline]
    #[stable(feature = "map_into_keys_values", since = "1.54.0")]
    pub fn into_keys(self) -> IntoKeys<K, V>
    { /* 実装は省略 */ }
}

全てのキーを、ソートした状態で所有権を奪いつつループするイテレーターを生成する。このメソッドを呼び出したあとはマップを使うことは出来なくなる。イテレーターの要素型はK。

サンプル

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(2, "b");
a.insert(1, "a");

let keys: Vec<i32> = a.into_keys().collect();
assert_eq!(keys, [1, 2]);

`BTreeMap::into_values`

原典

impl<K, V> BTreeMap<K, V> {
    #[inline]
    #[stable(feature = "map_into_keys_values", since = "1.54.0")]
    pub fn into_values(self) -> IntoValues<K, V>
    { /* 実装は省略 */ }
}

全ての値を、キーでソートされた状態で所有権を奪いつつループするイテレーターを生成する。このメソッドを呼び出したあとはマップを使うことは出来なくなる。イテレーターの要素型はV。

サンプル

use std::collections::BTreeMap;

let mut a = BTreeMap::new();
a.insert(1, "hello");
a.insert(2, "goodbye");

let values: Vec<&str> = a.into_values().collect();
assert_eq!(values, ["hello", "goodbye"]);

`HashMap::into_keys`

原典

impl<K, V, S> HashMap<K, V, S>
where
    K: Eq + Hash,
    S: BuildHasher,
{
    #[inline]
    #[stable(feature = "map_into_keys_values", since = "1.54.0")]
    pub fn into_keys(self) -> IntoKeys<K, V>
    { /* 実装は省略 */ }
}

全てのキーを、任意の並び順で所有権を奪いつつループするイテレーターを生成する。このメソッドを呼び出したあとはマップを使うことは出来なくなる。イテレーターの要素型はK。

サンプル

use std::collections::HashMap;

let mut map = HashMap::new();
map.insert("a", 1);
map.insert("b", 2);
map.insert("c", 3);

let vec: Vec<&str> = map.into_keys().collect();

`HashMap::into_values`

原典

impl<K, V, S> HashMap<K, V, S>
where
    K: Eq + Hash,
    S: BuildHasher,
{
    #[inline]
    #[stable(feature = "map_into_keys_values", since = "1.54.0")]
    pub fn into_values(self) -> IntoValues<K, V>
    { /* 実装は省略 */ }
}

全ての値を、任意の並び順で所有権を奪いつつループするイテレーターを生成する。このメソッドを呼び出したあとはマップを使うことは出来なくなる。イテレーターの要素型はV。

サンプル

use std::collections::HashMap;

let mut map = HashMap::new();
map.insert("a", 1);
map.insert("b", 2);
map.insert("c", 3);

let vec: Vec<i32> = map.into_values().collect();

`arch::wasm32`

原典

wasm32プラットフォーム特有の、プラットフォーム依存の組込み関数群。

`VecDeque::binary_search`

原典

impl<T> VecDeque<T> {
    #[stable(feature = "vecdeque_binary_search", since = "1.54.0")]
    #[inline]
    pub fn binary_search(&self, x: &T) -> Result<usize, usize>
    where
        T: Ord,
    { /* 実装は省略 */ }
}

ソートされたVecDequeを指定された値で二分探索する。

値が見つかれば、一致した要素のインデックスを含むResult::Okが返る。複数の一致がある場合にどの要素が返るかは分からない。値が見つからなければ、ソート状態を維持したまま要素を挿入出来るインデックスを含むResult::Errが返る。

サンプル

4つの要素を検索する。この時、1番目の値は特定の位置で見つかる。 2番目と3番目の値は見つからない。 4番目の要素は[1, 4]のいずれかの位置で見つかる。

use std::collections::VecDeque;

let deque: VecDeque<_> = vec![0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55].into();

assert_eq!(deque.binary_search(&13),  Ok(9));
assert_eq!(deque.binary_search(&4),   Err(7));
assert_eq!(deque.binary_search(&100), Err(13));
let r = deque.binary_search(&1);
assert!(matches!(r, Ok(1..=4)));

ソート済みのVecDequeに、ソート状態を維持したままアイテムを挿入する場合。

use std::collections::VecDeque;

let mut deque: VecDeque<_> = vec![0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55].into();
let num = 42;
let idx = deque.binary_search(&num).unwrap_or_else(|x| x);
deque.insert(idx, num);
assert_eq!(deque, &[0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 42, 55]);

`VecDeque::binary_search_by`

原典

impl<T> VecDeque<T> {
    #[stable(feature = "vecdeque_binary_search", since = "1.54.0")]
    pub fn binary_search_by<'a, F>(&'a self, mut f: F) -> Result<usize, usize>
    where
        F: FnMut(&'a T) -> Ordering,
    { /* 実装は省略 */ }
}

ソートされたVecDequeを比較関数を用いて二分探索する。

比較関数は、対象のVecDequeにおけるソート順と一致するように、目的要素と引数からLessかEqual、またはGreaterを示す順序コードを返すように実装するべきである。

binary_searchやbinary_search_by_key、またpartition_pointも参照されたい。

サンプル

use std::collections::VecDeque;

let deque: VecDeque<_> = vec![0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55].into();

assert_eq!(deque.binary_search_by(|x| x.cmp(&13)),  Ok(9));
assert_eq!(deque.binary_search_by(|x| x.cmp(&4)),   Err(7));
assert_eq!(deque.binary_search_by(|x| x.cmp(&100)), Err(13));
let r = deque.binary_search_by(|x| x.cmp(&1));
assert!(matches!(r, Ok(1..=4)));

`VecDeque::binary_search_by_key`

原典

impl<T> VecDeque<T> {
    #[stable(feature = "vecdeque_binary_search", since = "1.54.0")]
    #[inline]
    pub fn binary_search_by_key<'a, B, F>(&'a self, b: &B, mut f: F) -> Result<usize, usize>
    where
        F: FnMut(&'a T) -> B,
        B: Ord,
    { /* 実装は省略 */ }
}

ソートされたVecDequeを指定されたキー抽出関数で二分探索する。

VecDequeがキーによってソートされていると仮定する。例えば同じキー抽出関数を用いてmake_contiguous().sort_by_key()を呼び出してソートする。

binary_searchやbinary_search_by、またpartition_pointも参照されたい。

サンプル

4つの要素を、2番めの要素でソートされたスライスから検索する。この時、1番目の値は特定の位置で見つかる。 2番目と3番目の値は見つからない。 4番目の要素は[1, 4]のいずれかの位置で見つかる。

use std::collections::VecDeque;

let deque: VecDeque<_> = vec![(0, 0), (2, 1), (4, 1), (5, 1),
         (3, 1), (1, 2), (2, 3), (4, 5), (5, 8), (3, 13),
         (1, 21), (2, 34), (4, 55)].into();

assert_eq!(deque.binary_search_by_key(&13, |&(a, b)| b),  Ok(9));
assert_eq!(deque.binary_search_by_key(&4, |&(a, b)| b),   Err(7));
assert_eq!(deque.binary_search_by_key(&100, |&(a, b)| b), Err(13));
let r = deque.binary_search_by_key(&1, |&(a, b)| b);
assert!(matches!(r, Ok(1..=4)));

`VecDeque::partition_point`

原典

impl<T> VecDeque<T> {
    #[stable(feature = "vecdeque_binary_search", since = "1.54.0")]
    pub fn partition_point<P>(&self, mut pred: P) -> usize
    where
        P: FnMut(&T) -> bool,
    { /* 実装は省略 */ }
}

与えられた述語関数において分割位置となるインデックスを返す（2つ目の区画での最初の要素のインデックス）。

デキューは与えられた述語関数で分割されていると仮定される。つまり、述語関数がtrueを返す全ての要素はスライスの先頭に、述語関数がfalseを返す全ての要素はスライスの末尾に位置していると仮定される。例えば[7, 15, 3, 5, 4, 12, 6]は述語関数x % 2 != 0で分割されている（全ての奇数は先頭に、全ての偶数は末尾にある）。

もしデキューが分割されていない場合、このメソッドは二分探索の一種を使用するため、戻り値は不定で無意味な値となる。

binary_searchやbinary_search_by、またbinary_search_by_keyも参照されたい。

サンプル

use std::collections::VecDeque;

let deque: VecDeque<_> = vec![1, 2, 3, 3, 5, 6, 7].into();
let i = deque.partition_point(|&x| x < 5);

assert_eq!(i, 4);
assert!(deque.iter().take(i).all(|&x| x < 5));
assert!(deque.iter().skip(i).all(|&x| !(x < 5)));

変更点リスト

公式リリースノートをベースに意訳・編集・追記をした変更点リストです。

言語

組み込みの属性マクロ内で、値としてマクロを使えるようになった。これだけでは些細な変更ではあるが、正しく組み合わせることで協力な機能を実現する。特筆すべきは、以下のように記述することで外部ドキュメントをクレートに含めることが出来るようになったことである。
```
#![doc = include_str!("README.md")]
```
また、このように自動生成されたモジュールをインポート出来る。
```
#[path = concat!(env!("OUT_DIR"), "/generated.rs")]
mod generated;
```
const関数で大きさのないスライス型（及び大きさのないスライスを含む型）をキャスト出来るようになった
impl Traitで複数のジェネリックな（他より明示的に長生きしない）ライフタイムを使用出来るようになった。コードで言うと、impl Trait<'a, 'b> where 'b: 'aしか使えなかったのがimpl Trait<'a, 'b>も使えるようになった

コンパイラ

※Rustのティアで管理されるプラットフォームの詳細はPlatform Supportのページ（英語）を参照

ライブラリ

panic::panic_anyに#[track_caller]が付いた
io::ErrorKindにOutOfMemoryバリアントを追加した
proc_macro::LiteralがFromStrを実装するようになった
core::arch内のベンダー組込み関数の実装が大幅にリファクタリングされた。ユーザーに見える主な変更としてはlibcore.rlibのサイズが50%削減されたことと、組み込み関数に定数を渡した時の検証がより厳密になったこと。後者は技術的には破壊的変更ではあるが、これによりRustの挙動がよりCのベンダー組込み関数に近くなった

安定化されたAPI

※各APIのドキュメントを独自に訳した安定化されたAPIのドキュメントもご参照ください。

Cargo

cargo-treeにオプション--prune <spec>を追加し、依存グラフからパッケージを除去出来るようになった
cargo-treeにオプション--depthを追加し、ツリーでの特定の深さのもののみ出力出来るようになった
cargo-tree --edgesに値no-proc-macroを追加し、手続きマクロの依存関係を隠せるようになった
新しい環境変数CARGO_TARGET_TMPDIRが使えるようになった。この変数を使うことで、結合テストとベンチマークにおけるファイルシステムを操作するテストでの「メモ帳」として使えるディレクトリを示せる

互換性メモ

クロージャーで戻り値の型を推論する時、OptionとResultを?で混合することが許可されなくなった
以前は不良動作（unsound）だった、ブランチ内の異なるコンストラクタが異なるライフタイムを要求するコードが許可されなくなった
前述の通り、std::arch組み込み関数が定数をより厳密にチェックするようになった。これにより、これまでは通っていたコードが拒絶される場合がある
Cortex M0+プラットフォームでcodegen-units = 1でコンパイルされた時、i128の掛け算が無条件にオーバーフローを起こすようになった

さいごに

次のRust 1.55は2021/9/10(金)に予定されています。配列の要素をイテレーターを経由せずにmap()出来るようになったり、MaybeUninitに対して安全に値を書き込めるようになったりするようです。

オプティムでは羽化前のエンジニアを募集しています。

ライセンス表記

この記事はApache 2/MITのデュアルライセンスで公開されている公式リリースノートを翻訳・追記をしています
冒頭の画像はいらすとやさんの画像を使っています。いつもありがとうございます

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.

OPTiM TECH BLOG

OPTiMについて

エンジニア募集中

Rust 1.54を早めに深掘り

ピックアップ

一部の属性内で値としてマクロを使えるようになった

WebAssemblyでSIMDが使えるようになった

eBPF向けにビルド出来るようになった

安定化されたAPIのドキュメント

`BTreeMap::into_keys`

サンプル

`BTreeMap::into_values`

サンプル

`HashMap::into_keys`

サンプル

`HashMap::into_values`

サンプル

`arch::wasm32`

`VecDeque::binary_search`

サンプル

`VecDeque::binary_search_by`

サンプル

`VecDeque::binary_search_by_key`

サンプル

`VecDeque::partition_point`

サンプル

変更点リスト

言語

コンパイラ

ライブラリ

安定化されたAPI

Cargo

互換性メモ

関連リンク

さいごに

ライセンス表記