Rust 1.40を早めに深掘り

こんにちは、R&Dチームの齋藤(@aznhe21)です。

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

Rustの配達員もサンタの格好をする季節

ピックアップ

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

#[non_exhaustive]によりenumの前方互換性を担保出来るようになった

これまでのRustではenumにバリアントを追加すると破壊的変更となり、そのenummatchする全てのコードの修正が必要でした。

enum Hoge {
    Foo, // 今まであったバリアント
    // あとからBarを追加すると・・・
    // Bar,
}

match hoge {
    Hoge::Foo => { ... }

    // このマッチがないのでエラーになってしまう
    // Hoge::Bar => { ... }

    // ワイルドカードを入れておくこともことも出来るが警告が出るし、
    // ワイルドカードを必須にすることも出来ない
    // _ => {}
}

このような「将来的にバリアントが増えるかもしれないenum」に#[non_exhaustive]を付けておくと、 全てのバリアントを網羅するmatchでも、常に「それ以外」=ワイルドカードのパターンを用意しなければならなくなります。

#[non_exhaustive]
pub enum Hoge {
    Foo,
    // Bar,
}

match hoge {
    Hoge::Foo => { ... }
    // ワイルドカードが必須になる
    _ => { ... }
}

また、#[non_exhaustive]enum以外にも構造体や、enumのバリアント自体に付けることが出来ます。

#[non_exhaustive]
pub struct Fuga {
    pub el: u32,
    pub psy: u32,
    // kongrooを追加するかもしれない
}

let Fuga { el, psy, .. } = fuga; // ..が必須になる

pub enum Piyo {
    #[non_exhaustive]
    Value {
        v: u32,
    }
}

match piyo {
    // ..が必須になる
    Piyo::Value { v, .. } => { ... }
}

Option::as_derefによりコンテナ型の逆参照が楽になった

これまではOption<String>matchするときStringはパターンマッチング出来ないため、 中身のStringを事前に&strに変換する必要がありました。 これは読むときは分かりにくいコードであり、書くときも面倒でした。

let opt: Option<String> = Some("foo".to_string());
match opt.as_ref().map(|x| &**x) {
    Some("foo") => { ... }
    Some("bar") => { ... }
    Some(_) => { ... }
    None => { ... }
}

これがOption::as_derefを使うと分かりやすいコードとなります。

let opt: Option<String> = Some("foo".to_string());
match opt.as_deref() {
    Some("foo") => { ... }
    Some("bar") => { ... }
    Some(_) => { ... }
    None => { ... }
}

可変参照が必要であればOption::as_deref_mutを使うと良いでしょう。

#[cfg(doctest)]属性でドキュメント化テストの実行時だけ有効なアイテムを書けるようになった

Rustではコメントをスラッシュ3つで始めることで、その直後のアイテムのドキュメントとすることができ、 その中にサンプルコードを書くことができます。 このサンプルコードはcargo testなどのテストツールには「正しく実行できる」コードとして、つまりテストコードとして扱われます。

ここで、このサンプルコードにはcompile_failを指定することで、 ユニットテストでは不可能な「コンパイル出来ないコード」を書くことも出来ます。

/// 円周率です。
///
/// # Examples
/// 
/// 円周率は3ですよね?
/// 
/// ```
/// assert_eq!(test::PI, 3.);
/// ```
/// 
/// もちろん整数のはずがないので、整数との演算は出来ません。
/// 
/// ```compile_fail
/// let _ = test::PI + 0;
/// ```
pub const PI: f32 = 3.;

この機能は大変便利なのですが、これらのコードはあくまでドキュメントの一部であるので、 ドキュメントには書きたくない「コンパイル出来ないコード」を書こうとすると色々と考えることが出てきます *1#[cfg(doctest)]を使えば、それがテスト目的であることが明示でき、 しかもコンパイル対象ではないのでコンパイラに叱られることもありません。

// PIは関数でもないはず・・・。
/// ```compile_fail
/// test::PI();
/// ```
#[cfg(doctest)]
// 以前は#[allow(dead_code, non_camel_case_types)]などが必要だった
pub struct pi_is_not_a_fn;

また、extern_docが安定化されればREADME内のコードまでテストできるようになるそうです (doc_commentクレートで先取りが出来るようです)。 素晴らしいですね!

#[doc(include="../README.md")]
#[cfg(doctest)]
pub struct ReadmeDoctests;

変更点リスト

言語

constの文脈でタプル構造体などのコンストラクタを使えるようになった

タプル構造体やenumのタプル形式のバリアントのコンストラクタを定数関数として扱えるようになりました。 これまでも直接値を生成することは出来ましたが、一旦変数に代入しておいて、あとから呼び出すことが出来るようになりました。

pub enum Hoge {
    Foo(u32),
    Bar(u32),
}

const HOGE: Hoge = {
    #[cfg(feature = "foo")]
    let constructor = Hoge::Foo;
    #[cfg(not(feature = "foo"))]
    let constructor = Hoge::Bar;

    constructor(0)
};

非網羅的マッチを強制出来るようになった

構造体やenum、及びenumのバリアントに#[non_exhaustive]属性を指定できるようになり、 将来的にバリアントやフィールドが追加されるかもしれないことを明示できるようになりました。

例えば、#[non_exhaustive]を付けたenummatchで分岐するとき、 必ずワイルドカードのパターン(_ => {})を入れる必要があります(RFC 2008)。

マクロがより多くの場所で使えるようになった

関数形式のマクロや属性マクロをexternブロックで使えるようになり、 また、関数形式のマクロを型エイリアスの場所で使えるようになりました。

extern {
    makkuro!();
}

type Type = taipu!();

手続きマクロがマクロを生成できるようになった

関数形式、及び属性での手続きマクロがmacro_rules!を生成できるようになり、 「マクロを生成する手続きマクロ」を作れるようになりました。

macro_rules!でのmetaパターンが任意のトークンを受け入れるようになった

例えば、(#[$m:meta])#[attr]#[attr{tokens}]#[attr[tokens]]、そして#[attr(tokens)]などにマッチするようになりました。

コンパイラ

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

ライブラリ

安定化されたAPI

{BTreeMap,HashMap}::get_key_value

指定されたキーに対応するキーと値のペアを返す。

指定するキーは、キーの型を借用した型であれば良い。

Option::as_deref_mut

Option<T>(あるいは&mut Option<T>)をOption<&mut T::Target>に変換する。

元の値はそのままに、内部の値をDerefによって型強制して作った可変参照をもとに、新しい値を生成する。

Option::as_deref

Option<T>(あるいは&Option<T>)をOption<&T::Target>に変換する。

元の値はそのままに、内部の値をDerefによって型強制して作った参照をもとに、新しい値を生成する。

Option::flatten

Option<Option<T>>Option<T>に変換する。

UdpSocket::peer_addr

このソケットが接続しているピアのソケットアドレスを返す。

{f32,f64}::to_be_bytes

この浮動小数点数のメモリ表現をビッグエンディアンのバイトオーダー(ネットワークバイトオーダー)で返す。

{f32,f64}::to_le_bytes

この浮動小数点数のメモリ表現をリトルエンディアンのバイトオーダーで返す。

{f32,f64}::to_ne_bytes

この浮動小数点数のメモリ表現をCPUネイティブのバイトオーダーで返す。

ターゲットプラットフォームのエンディアンが使われるため、 ポータブルなコードではto_be_bytesto_le_bytesを代わりに使うべきである。

{f32,f64}::from_be_bytes

ビッグエンディアンで表現されたバイト配列から浮動小数点数に変換する。

{f32,f64}::from_le_bytes

リトルエンディアンで表現されたバイト配列から浮動小数点数に変換する。

{f32,f64}::from_ne_bytes

CPUネイティブのエンディアンで表現されたバイト配列から浮動小数点数に変換する。

ターゲットプラットフォームのエンディアンが使われるため、 ポータブルなコードではfrom_be_bytesfrom_le_bytesを代わりに使うべきである。

mem::take

Defaultを実装した型の値に対し、値をデフォルト値に置き換え、置き換える前の値を返す。

slice::repeat

スライスをn回繰り返し、Vec<T>を生成する。

todo!

まだ実装していないコードを示す。

プロトタイプ中、型を確認するような用途に使える。

unimplemented!とは名前以外に違いがない。つまりタイピングが楽になる。

Cargo

その他

互換性メモ

関連リンク

さいごに

次のRust 1.41は2020/1/31(金)に予定されています。 新年最初のRust、楽しみですね。

オプティムではプレゼントを配る方が好きなエンジニアを募集しています。

ライセンス表記

  • この記事は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.

*1:警告を抑えたり、テストが目的であることを明示したり・・・