Rust 1.58を早めに深掘り

Rust
このエントリーをはてなブックマークに追加 follow us in feedly

こんにちは、R&Dチームの齋藤（@aznhe21）です。 年末年始の進捗はゼロです。

さて、本日1/14(金)にRust 1.58がリリースされました。 この記事ではRust 1.58での変更点を詳しく紹介します。

1/14は探査機ホイヘンス・プローブが土星の衛星タイタンに着陸した日 土星とタイタンとホイヘンス・プローブ

ピックアップ

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

フォーマット文字列で変数を直接参照できるようになった

format!やprintln!などフォーマット系のマクロで変数を直接参照できるようになりました。 これによりprintln!("{}", x)やprintln!("{x}", x = x)ではなく、println!("{x}")と簡単に書くことができます。

fn main() {
    let x = 42;
    println!("{x}");
    log::info!("{x}");
    panic!("{x}"); // 2021エディションが必要
}

なお名前付きパラメータを指定している場合はそちらが優先されます。

fn main() {
    let x = 42;
    // 84が出力される
    println!("{x}", x = x * 2);
}

ただし指定できるのは識別子のみであり、式を指定することはできません。 今後これを行えるようにしたいという議論も進行中です。

fn main() {
    let x = 42;
    // ERROR
    println!("{x * 2}");
    // 84
    println!("{}", x * 2);

    // ERROR
    println!("{u32::BITS}");
    // 32
    println!("{}", u32::BITS);
}

ビルドと同時にstripできるようになった

rustcのコンパイルオプションとして-C strip=<value>を指定することでビルドと同時にデバッグ情報を取り除くことができるようになりました。 リリース用のバイナリ向けにstripコマンドを実行する手間が無くなります。

<value>には以下の値を指定できます。

  • none：デバッグ情報を除去しない。gccなどではリンカへのオプション指定無しに、MSVCではlink.exe /DEBUG ...に相当
  • debuginfo：デバッグシンボルのみを除去する。gccなどではld --strip-debug ...に、MSVCではlink.exe /DEBUG:NONE ...に相当
  • symbols：すべてのデバッグ情報を除去する。gccなどではld --strip-all ...に、MSVCではlink.exe /DEBUG:NONE ...に相当

ただしCargoでのサポートはまだのため、RUSTFLAGSに値を指定すると良いでしょう。

$ RUSTFLAGS="-C strip=none" cargo build --release
$ RUSTFLAGS="-C strip=debuginfo" cargo build --release
$ RUSTFLAGS="-C strip=symbols" cargo build --release

また、これまでmuslではデフォルトでデバッグ情報が取り除かれていましたが、 Rust 1.58からは（他のプラットフォームに合わせて）デバッグ情報が含まれるようになりました。 これまでと同じ動作をさせるにはrustcに-C strip=<value>を指定するかstripコマンドを使用してください。

Windowsでファイル操作時に長いパスを正規化するようになった

Windowsのファイル操作にはMAX_PATHの呪縛というものがあり、何も考慮しなければ概ね260文字を超えるファイルパスを扱うことが出来ません。 Rustでも1.57までは特に考慮なしにWindows APIを呼び出していたため、260文字を超えるパスを扱うとエラーが発生します。

Rust 1.58ではファイルを操作する一通りのAPIでは（必要であれば）\\?\や\\?\UNC\のプレフィクスを自動的に追加し、長いパスも扱えるようになりました。

Windowsでコマンドを実行する際は作業ディレクトリを検索しなくなった

Command::newにファイル名のみを渡したとき、作業ディレクトリにある実行可能ファイルを検索しなくなりました。 これはripgrepの脆弱性（CVE-2021-3013）に端を発するもので、意図しない実行可能ファイルの参照を防ぎます。 DLLプリロード問題に近い気がします。

Rust 1.58以降で作業ディレクトリ内の実行可能ファイルを参照するには相対パスを使って.\hoge.exeのように指定します。 つまりPowerShell（既定）と同様の検索手順であると言えます。

なお16ビットシステム用ディレクトリ（C:\Windows\System）も（取得用関数がないため）検索対象ではなくなっていますが、 最早使われていないため影響は無いと思われます。

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

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

原典

impl Metadata {
    #[must_use]
    #[stable(feature = "is_symlink", since = "1.57.0")]
    pub fn is_symlink(&self) -> bool
    { /* 実装は省略 */ }
}

メタデータがシンボリックリンクのものであればtrueを返す。

サンプル
use std::fs;
use std::path::Path;
use std::os::unix::fs::symlink;

fn main() -> std::io::Result<()> {
    let link_path = Path::new("link");
    symlink("/存在しない原点/", link_path)?;

    let metadata = fs::symlink_metadata(link_path)?;

    assert!(metadata.is_symlink());
    Ok(())
}

原典

impl Path {
    #[must_use]
    #[stable(feature = "is_symlink", since = "1.57.0")]
    pub fn is_symlink(&self) -> bool
    { /* 実装は省略 */ }
}

パスがディスクに存在し、かつシンボリックリンクを指していればtrueを返す。

この関数はシンボリックリンクを辿らない。そのため、シンボリックリンクが壊れていたとしてもtrueを返す。

パーミッションのエラーなどでファイルを含むディレクトリにアクセスできない場合はfalseを返す。

サンプル
use std::path::Path;
use std::os::unix::fs::symlink;

let link_path = Path::new("link");
symlink("/存在しない原点/", link_path).unwrap();
assert_eq!(link_path.is_symlink(), true);
assert_eq!(link_path.exists(), false);

{integer}::saturating_div

原典

#[lang = "i8"]
impl i8 {
    #[stable(feature = "saturating_div", since = "1.58.0")]
    #[must_use = "this returns the result of the operation, \
                  without modifying the original"]
    #[inline]
    pub const fn saturating_div(self, rhs: Self) -> Self
    { /* 実装は省略 */ }
}

飽和する整数の除算。self / rhsを計算するが、オーバーフローする代わりに数値の境界で飽和する。

サンプル

基本的な使い方

assert_eq!(5i8.saturating_div(2), 2);
assert_eq!(i8::MAX.saturating_div(-1), i8::MIN + 1);
assert_eq!(i8::MIN.saturating_div(-1), i8::MAX);

let _ = 1i8.saturating_div(0);

Option::unwrap_unchecked

原典

impl<T> Option<T> {
    #[inline]
    #[track_caller]
    #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
    pub unsafe fn unwrap_unchecked(self) -> T
    { /* 実装は省略 */ }
}

値がNoneではないことを確認しないまま、selfを消費して、内包するSomeの値を返す。

安全性

Noneに対してこのメソッドを呼び出すのは未定義動作である。

サンプル
let x = Some("air");
assert_eq!(unsafe { x.unwrap_unchecked() }, "air");

let x: Option<&str> = None;
assert_eq!(unsafe { x.unwrap_unchecked() }, "air"); // 未定義動作😡

Result::unwrap_unchecked

原典

impl<T, E> Result<T, E> {
    #[inline]
    #[track_caller]
    #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
    pub unsafe fn unwrap_unchecked(self) -> T
    { /* 実装は省略 */ }
}

値がErrではないことを確認しないまま、selfを消費して、内包するOkの値を返す。

安全性

Errに対してこのメソッドを呼び出すのは未定義動作である。

サンプル
let x: Result<u32, &str> = Ok(2);
assert_eq!(unsafe { x.unwrap_unchecked() }, 2);

let x: Result<u32, &str> = Err("緊急停止");
unsafe { x.unwrap_unchecked(); } // 未定義動作😡

Result::unwrap_err_unchecked

原典

impl<T, E> Result<T, E> {
    #[inline]
    #[track_caller]
    #[stable(feature = "option_result_unwrap_unchecked", since = "1.58.0")]
    pub unsafe fn unwrap_err_unchecked(self) -> E
    { /* 実装は省略 */ }
}

値がOkではないことを確認しないまま、selfを消費して、内包するErrの値を返す。

安全性

Okに対してこのメソッドを呼び出すのは未定義動作である。

サンプル
let x: Result<u32, &str> = Ok(2);
unsafe { x.unwrap_err_unchecked() }; // 未定義動作😡

let x: Result<u32, &str> = Err("緊急停止");
assert_eq!(unsafe { x.unwrap_err_unchecked() }, "緊急停止");

File::options

原典

impl File {
    #[must_use]
    #[stable(feature = "with_options", since = "1.58.0")]
    pub fn options() -> OpenOptions
    { /* 実装は省略 */ }
}

新しいOpenOptionsオブジェクトを返す。

この関数は、open()やcreate()の使用にそぐわない場合でも、具体的なオプションを用いてファイルを開いたり作成したりできる新しいOpenOptionsオブジェクトを返す。

OpenOptions::new()と同義だが、より読みやすいコードを書くことができる。 OpenOptions::new().read(true).open("hoge.txt")ではなくFile::options().read(true).open("hoge.txt")と書ける。 OpenOptionsをインポートする必要がないという意味もある。

詳細はOpenOptions::newを参照のこと。

サンプル
use std::fs::File;

fn main() -> std::io::Result<()> {
    let mut f = File::options().read(true).open("foo.txt")?;
    Ok(())
}

変更点リスト

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

言語

コンパイラ

※Rustのティア付けされたプラットフォームサポートの詳細はPlatform Supportのページ（英語）を参照

ライブラリ

安定化されたAPI

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

以下のAPIが定数文脈でも使えるようになった。

Cargo

互換性メモ

内部の変更

これらの変更は直接ユーザーの利益に繋がるものではないが、rustc及び関連ツールにおける内部の改善や全体的なパフォーマンスの改善をもたらす。

関連リンク

さいごに

次のRust 1.59は2022/2/25(金)に予定されています。 定数ジェネリクスにデフォルト値が指定できるようになるようです。

オプティムでは宇宙規模のエンジニアを募集しています。

ライセンス表記

  • この記事はApache 2/MITのデュアルライセンスで公開されている公式リリースノート及びドキュメントから翻訳・追記をしています
  • 冒頭の画像中にはRust公式サイトで配布されているロゴを使用しており、 このロゴはMozillaまたはRust財団によって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.