From 698f8c2f01ea549d77d7dc3338a12e04c11057b9 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 17 Apr 2024 14:02:58 +0200 Subject: Adding upstream version 1.64.0+dfsg1. Signed-off-by: Daniel Baumann --- src/doc/reference/.github/workflows/main.yml | 35 + src/doc/reference/CONTRIBUTING.md | 76 ++ src/doc/reference/LICENSE-APACHE | 201 +++++ src/doc/reference/LICENSE-MIT | 25 + src/doc/reference/README.md | 60 ++ src/doc/reference/STYLE.md | 71 ++ src/doc/reference/book.toml | 14 + src/doc/reference/reference.md | 4 + src/doc/reference/src/SUMMARY.md | 135 ++++ src/doc/reference/src/abi.md | 100 +++ src/doc/reference/src/appendices.md | 1 + src/doc/reference/src/attributes-redirect.html | 29 + src/doc/reference/src/attributes.md | 346 ++++++++ src/doc/reference/src/attributes/codegen.md | 354 +++++++++ src/doc/reference/src/attributes/derive.md | 51 ++ src/doc/reference/src/attributes/diagnostics.md | 335 ++++++++ src/doc/reference/src/attributes/limits.md | 57 ++ src/doc/reference/src/attributes/testing.md | 90 +++ src/doc/reference/src/attributes/type_system.md | 141 ++++ .../reference/src/behavior-considered-undefined.md | 104 +++ .../src/behavior-not-considered-unsafe.md | 56 ++ src/doc/reference/src/comments.md | 125 +++ src/doc/reference/src/conditional-compilation.md | 356 +++++++++ src/doc/reference/src/const_eval.md | 141 ++++ src/doc/reference/src/crates-and-source-files.md | 191 +++++ src/doc/reference/src/destructors.md | 402 ++++++++++ src/doc/reference/src/dynamically-sized-types.md | 33 + src/doc/reference/src/expressions.md | 369 +++++++++ src/doc/reference/src/expressions/array-expr.md | 88 +++ src/doc/reference/src/expressions/await-expr.md | 60 ++ src/doc/reference/src/expressions/block-expr.md | 191 +++++ src/doc/reference/src/expressions/call-expr.md | 97 +++ src/doc/reference/src/expressions/closure-expr.md | 73 ++ src/doc/reference/src/expressions/field-expr.md | 73 ++ src/doc/reference/src/expressions/grouped-expr.md | 43 + src/doc/reference/src/expressions/if-expr.md | 155 ++++ src/doc/reference/src/expressions/literal-expr.md | 182 +++++ src/doc/reference/src/expressions/loop-expr.md | 274 +++++++ src/doc/reference/src/expressions/match-expr.md | 147 ++++ .../reference/src/expressions/method-call-expr.md | 96 +++ src/doc/reference/src/expressions/operator-expr.md | 670 ++++++++++++++++ src/doc/reference/src/expressions/path-expr.md | 32 + src/doc/reference/src/expressions/range-expr.md | 76 ++ src/doc/reference/src/expressions/return-expr.md | 21 + src/doc/reference/src/expressions/struct-expr.md | 142 ++++ src/doc/reference/src/expressions/tuple-expr.md | 80 ++ .../reference/src/expressions/underscore-expr.md | 17 + src/doc/reference/src/glossary.md | 331 ++++++++ src/doc/reference/src/identifiers.md | 72 ++ src/doc/reference/src/influences.md | 22 + src/doc/reference/src/inline-assembly.md | 614 +++++++++++++++ src/doc/reference/src/input-format.md | 3 + src/doc/reference/src/interior-mutability.md | 29 + src/doc/reference/src/introduction.md | 146 ++++ src/doc/reference/src/items.md | 96 +++ src/doc/reference/src/items/associated-items.md | 397 ++++++++++ src/doc/reference/src/items/constant-items.md | 101 +++ src/doc/reference/src/items/enumerations.md | 188 +++++ src/doc/reference/src/items/extern-crates.md | 94 +++ src/doc/reference/src/items/external-blocks.md | 235 ++++++ src/doc/reference/src/items/functions.md | 415 ++++++++++ src/doc/reference/src/items/generics.md | 305 +++++++ src/doc/reference/src/items/implementations.md | 295 +++++++ src/doc/reference/src/items/modules.md | 166 ++++ src/doc/reference/src/items/static-items.md | 131 ++++ src/doc/reference/src/items/structs.md | 88 +++ src/doc/reference/src/items/traits.md | 343 ++++++++ src/doc/reference/src/items/type-aliases.md | 47 ++ src/doc/reference/src/items/unions.md | 180 +++++ src/doc/reference/src/items/use-declarations.md | 208 +++++ src/doc/reference/src/keywords.md | 132 ++++ src/doc/reference/src/lexical-structure.md | 1 + src/doc/reference/src/lifetime-elision.md | 212 +++++ src/doc/reference/src/linkage.md | 216 +++++ src/doc/reference/src/macro-ambiguity.md | 377 +++++++++ src/doc/reference/src/macros-by-example.md | 519 ++++++++++++ src/doc/reference/src/macros.md | 104 +++ .../src/memory-allocation-and-lifetime.md | 13 + src/doc/reference/src/memory-model.md | 5 + src/doc/reference/src/names.md | 143 ++++ src/doc/reference/src/names/name-resolution.md | 3 + src/doc/reference/src/names/namespaces.md | 168 ++++ src/doc/reference/src/names/preludes.md | 173 ++++ src/doc/reference/src/names/scopes.md | 3 + src/doc/reference/src/notation.md | 41 + src/doc/reference/src/paths.md | 404 ++++++++++ src/doc/reference/src/patterns.md | 873 +++++++++++++++++++++ src/doc/reference/src/procedural-macros.md | 367 +++++++++ src/doc/reference/src/runtime.md | 85 ++ src/doc/reference/src/special-types-and-traits.md | 188 +++++ .../reference/src/statements-and-expressions.md | 11 + src/doc/reference/src/statements.md | 138 ++++ src/doc/reference/src/subtyping.md | 114 +++ src/doc/reference/src/tokens.md | 741 +++++++++++++++++ src/doc/reference/src/trait-bounds.md | 176 +++++ src/doc/reference/src/type-coercions.md | 275 +++++++ src/doc/reference/src/type-layout.md | 578 ++++++++++++++ src/doc/reference/src/type-system.md | 1 + src/doc/reference/src/types-redirect.html | 43 + src/doc/reference/src/types.md | 175 +++++ src/doc/reference/src/types/array.md | 31 + src/doc/reference/src/types/boolean.md | 118 +++ src/doc/reference/src/types/closure.md | 180 +++++ src/doc/reference/src/types/enum.md | 22 + src/doc/reference/src/types/function-item.md | 57 ++ src/doc/reference/src/types/function-pointer.md | 66 ++ src/doc/reference/src/types/impl-trait.md | 124 +++ src/doc/reference/src/types/inferred.md | 18 + src/doc/reference/src/types/never.md | 22 + src/doc/reference/src/types/numeric.md | 47 ++ src/doc/reference/src/types/parameters.md | 19 + src/doc/reference/src/types/pointer.md | 60 ++ src/doc/reference/src/types/slice.md | 31 + src/doc/reference/src/types/struct.md | 29 + src/doc/reference/src/types/textual.md | 22 + src/doc/reference/src/types/trait-object.md | 107 +++ src/doc/reference/src/types/tuple.md | 47 ++ src/doc/reference/src/types/union.md | 19 + src/doc/reference/src/unsafe-blocks.md | 22 + src/doc/reference/src/unsafe-functions.md | 5 + src/doc/reference/src/unsafety.md | 19 + src/doc/reference/src/variables.md | 45 ++ src/doc/reference/src/visibility-and-privacy.md | 245 ++++++ src/doc/reference/src/whitespace.md | 24 + src/doc/reference/style-check/Cargo.lock | 62 ++ src/doc/reference/style-check/Cargo.toml | 8 + src/doc/reference/style-check/src/main.rs | 131 ++++ src/doc/reference/theme/reference.css | 53 ++ src/doc/reference/triagebot.toml | 6 + 129 files changed, 18843 insertions(+) create mode 100644 src/doc/reference/.github/workflows/main.yml create mode 100644 src/doc/reference/CONTRIBUTING.md create mode 100644 src/doc/reference/LICENSE-APACHE create mode 100644 src/doc/reference/LICENSE-MIT create mode 100644 src/doc/reference/README.md create mode 100644 src/doc/reference/STYLE.md create mode 100644 src/doc/reference/book.toml create mode 100644 src/doc/reference/reference.md create mode 100644 src/doc/reference/src/SUMMARY.md create mode 100644 src/doc/reference/src/abi.md create mode 100644 src/doc/reference/src/appendices.md create mode 100644 src/doc/reference/src/attributes-redirect.html create mode 100644 src/doc/reference/src/attributes.md create mode 100644 src/doc/reference/src/attributes/codegen.md create mode 100644 src/doc/reference/src/attributes/derive.md create mode 100644 src/doc/reference/src/attributes/diagnostics.md create mode 100644 src/doc/reference/src/attributes/limits.md create mode 100644 src/doc/reference/src/attributes/testing.md create mode 100644 src/doc/reference/src/attributes/type_system.md create mode 100644 src/doc/reference/src/behavior-considered-undefined.md create mode 100644 src/doc/reference/src/behavior-not-considered-unsafe.md create mode 100644 src/doc/reference/src/comments.md create mode 100644 src/doc/reference/src/conditional-compilation.md create mode 100644 src/doc/reference/src/const_eval.md create mode 100644 src/doc/reference/src/crates-and-source-files.md create mode 100644 src/doc/reference/src/destructors.md create mode 100644 src/doc/reference/src/dynamically-sized-types.md create mode 100644 src/doc/reference/src/expressions.md create mode 100644 src/doc/reference/src/expressions/array-expr.md create mode 100644 src/doc/reference/src/expressions/await-expr.md create mode 100644 src/doc/reference/src/expressions/block-expr.md create mode 100644 src/doc/reference/src/expressions/call-expr.md create mode 100644 src/doc/reference/src/expressions/closure-expr.md create mode 100644 src/doc/reference/src/expressions/field-expr.md create mode 100644 src/doc/reference/src/expressions/grouped-expr.md create mode 100644 src/doc/reference/src/expressions/if-expr.md create mode 100644 src/doc/reference/src/expressions/literal-expr.md create mode 100644 src/doc/reference/src/expressions/loop-expr.md create mode 100644 src/doc/reference/src/expressions/match-expr.md create mode 100644 src/doc/reference/src/expressions/method-call-expr.md create mode 100644 src/doc/reference/src/expressions/operator-expr.md create mode 100644 src/doc/reference/src/expressions/path-expr.md create mode 100644 src/doc/reference/src/expressions/range-expr.md create mode 100644 src/doc/reference/src/expressions/return-expr.md create mode 100644 src/doc/reference/src/expressions/struct-expr.md create mode 100644 src/doc/reference/src/expressions/tuple-expr.md create mode 100644 src/doc/reference/src/expressions/underscore-expr.md create mode 100644 src/doc/reference/src/glossary.md create mode 100644 src/doc/reference/src/identifiers.md create mode 100644 src/doc/reference/src/influences.md create mode 100644 src/doc/reference/src/inline-assembly.md create mode 100644 src/doc/reference/src/input-format.md create mode 100644 src/doc/reference/src/interior-mutability.md create mode 100644 src/doc/reference/src/introduction.md create mode 100644 src/doc/reference/src/items.md create mode 100644 src/doc/reference/src/items/associated-items.md create mode 100644 src/doc/reference/src/items/constant-items.md create mode 100644 src/doc/reference/src/items/enumerations.md create mode 100644 src/doc/reference/src/items/extern-crates.md create mode 100644 src/doc/reference/src/items/external-blocks.md create mode 100644 src/doc/reference/src/items/functions.md create mode 100644 src/doc/reference/src/items/generics.md create mode 100644 src/doc/reference/src/items/implementations.md create mode 100644 src/doc/reference/src/items/modules.md create mode 100644 src/doc/reference/src/items/static-items.md create mode 100644 src/doc/reference/src/items/structs.md create mode 100644 src/doc/reference/src/items/traits.md create mode 100644 src/doc/reference/src/items/type-aliases.md create mode 100644 src/doc/reference/src/items/unions.md create mode 100644 src/doc/reference/src/items/use-declarations.md create mode 100644 src/doc/reference/src/keywords.md create mode 100644 src/doc/reference/src/lexical-structure.md create mode 100644 src/doc/reference/src/lifetime-elision.md create mode 100644 src/doc/reference/src/linkage.md create mode 100644 src/doc/reference/src/macro-ambiguity.md create mode 100644 src/doc/reference/src/macros-by-example.md create mode 100644 src/doc/reference/src/macros.md create mode 100644 src/doc/reference/src/memory-allocation-and-lifetime.md create mode 100644 src/doc/reference/src/memory-model.md create mode 100644 src/doc/reference/src/names.md create mode 100644 src/doc/reference/src/names/name-resolution.md create mode 100644 src/doc/reference/src/names/namespaces.md create mode 100644 src/doc/reference/src/names/preludes.md create mode 100644 src/doc/reference/src/names/scopes.md create mode 100644 src/doc/reference/src/notation.md create mode 100644 src/doc/reference/src/paths.md create mode 100644 src/doc/reference/src/patterns.md create mode 100644 src/doc/reference/src/procedural-macros.md create mode 100644 src/doc/reference/src/runtime.md create mode 100644 src/doc/reference/src/special-types-and-traits.md create mode 100644 src/doc/reference/src/statements-and-expressions.md create mode 100644 src/doc/reference/src/statements.md create mode 100644 src/doc/reference/src/subtyping.md create mode 100644 src/doc/reference/src/tokens.md create mode 100644 src/doc/reference/src/trait-bounds.md create mode 100644 src/doc/reference/src/type-coercions.md create mode 100644 src/doc/reference/src/type-layout.md create mode 100644 src/doc/reference/src/type-system.md create mode 100644 src/doc/reference/src/types-redirect.html create mode 100644 src/doc/reference/src/types.md create mode 100644 src/doc/reference/src/types/array.md create mode 100644 src/doc/reference/src/types/boolean.md create mode 100644 src/doc/reference/src/types/closure.md create mode 100644 src/doc/reference/src/types/enum.md create mode 100644 src/doc/reference/src/types/function-item.md create mode 100644 src/doc/reference/src/types/function-pointer.md create mode 100644 src/doc/reference/src/types/impl-trait.md create mode 100644 src/doc/reference/src/types/inferred.md create mode 100644 src/doc/reference/src/types/never.md create mode 100644 src/doc/reference/src/types/numeric.md create mode 100644 src/doc/reference/src/types/parameters.md create mode 100644 src/doc/reference/src/types/pointer.md create mode 100644 src/doc/reference/src/types/slice.md create mode 100644 src/doc/reference/src/types/struct.md create mode 100644 src/doc/reference/src/types/textual.md create mode 100644 src/doc/reference/src/types/trait-object.md create mode 100644 src/doc/reference/src/types/tuple.md create mode 100644 src/doc/reference/src/types/union.md create mode 100644 src/doc/reference/src/unsafe-blocks.md create mode 100644 src/doc/reference/src/unsafe-functions.md create mode 100644 src/doc/reference/src/unsafety.md create mode 100644 src/doc/reference/src/variables.md create mode 100644 src/doc/reference/src/visibility-and-privacy.md create mode 100644 src/doc/reference/src/whitespace.md create mode 100644 src/doc/reference/style-check/Cargo.lock create mode 100644 src/doc/reference/style-check/Cargo.toml create mode 100644 src/doc/reference/style-check/src/main.rs create mode 100644 src/doc/reference/theme/reference.css create mode 100644 src/doc/reference/triagebot.toml (limited to 'src/doc/reference') diff --git a/src/doc/reference/.github/workflows/main.yml b/src/doc/reference/.github/workflows/main.yml new file mode 100644 index 000000000..4456c3c9c --- /dev/null +++ b/src/doc/reference/.github/workflows/main.yml @@ -0,0 +1,35 @@ +name: CI +on: [push, pull_request] + +jobs: + test: + name: Test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - name: Update rustup + run: rustup self update + - name: Install Rust + run: | + rustup set profile minimal + rustup toolchain install nightly -c rust-docs + rustup default nightly + - name: Install mdbook + run: | + mkdir bin + curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin + echo "$(pwd)/bin" >> $GITHUB_PATH + - name: Report versions + run: | + rustup --version + rustc -Vv + mdbook --version + - name: Run tests + run: mdbook test + - name: Style checks + run: (cd style-check && cargo run -- ../src) + - name: Check for broken links + run: | + curl -sSLo linkcheck.sh \ + https://raw.githubusercontent.com/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh + sh linkcheck.sh --all reference diff --git a/src/doc/reference/CONTRIBUTING.md b/src/doc/reference/CONTRIBUTING.md new file mode 100644 index 000000000..8cf73c1fd --- /dev/null +++ b/src/doc/reference/CONTRIBUTING.md @@ -0,0 +1,76 @@ +Thank you for your interest in contributing to the Rust Reference! + +There are a few ways of helping with the reference: critiquing the reference, +editing the reference, fixing incorrect information, adding examples and +glossary entries, and documenting new or otherwise undocumented features in +Rust. + +For a while, the Reference was basically ignored, and Rust continued gaining new +features or changing old ones. It was also basically the introduction document +before the first edition of the Rust book, and constantly in flux from the huge +churn of the language design before v1.0.0. So there's a lot that's wrong, too +teachy for people who should have basic understanding of Rust, or is too shallow +for the Reference. As such, we have the warning saying there's work that needs +to be done. Eventually, we plan to make sure everything is well documented +enough that we can remove the warning. + +It is encouraged for you to read the [introduction] to familiarize yourself +with the kind of content the reference is expected to contain and the +conventions it uses. Also, the [style guide] provides more detailed guidelines +for formatting and content. + +## Critiquing the Reference + +This is the easiest way to contribute. Basically, as you read the reference, if +you find something confusing, incorrect, or missing, then you can file an issue +against the reference explaining your concerns. + +## Editing the Reference + +Typos and incorrect links get through from time to time. Should you find them, +we welcome PRs to fix them. Additionally, larger editing jobs that help remove +the number of parentheticals, remove comma splices, italicize term definitions +and other similar tasks are helpful. + +## Adding Examples and Glossary Entries + +Examples are great. Many people will only read examples and ignore the prose. +Ideally, every facet of every feature will have an example. + +Likewise, the reference has a glossary. It doesn't need to explain every facet +of every feature nor contain every definition, but it does need to be expanded +upon. Ideally entries in the glossary link to the associated documentation. + +## Adding Documentation + +There are a lot of features that are not documented at all or are documented +poorly. This is the hardest, but definitely most valuable. Pick an unassigned +issue from the [issue tracker], and write about it. + +While writing, you may find it handy to have a [playpen] open to test out what +you are documenting. + +Feel free to take information from the standard library and Rustonomicon as +appropriate. + +Note that we don't write documentation for purely library features such as +threads and IO and we don't write about Rust in the future. Documentation is +written as if the current stable release of Rust is the last release. The +`master` branch of the reference corresponds to what is **stable** on the +`master` branch ("nightly") of [rust-lang/rust]. If you want to write about +Rust in the future, you want [the Unstable book][unstable]. + +## Stabilization + +When something that alters the language is stabilized, an issue should be +opened on the reference [issue tracker] to track the documentation process. +This should include links to any relevant information, such as the +stabilization PR, the RFC, the tracking issue, and anything else that would be +helpful for writing the documentation. + +[introduction]: src/introduction.md +[issue tracker]: https://github.com/rust-lang/reference/issues +[playpen]: https://play.rust-lang.org/ +[rust-lang/rust]: https://github.com/rust-lang/rust/ +[style guide]: STYLE.md +[unstable]: https://doc.rust-lang.org/nightly/unstable-book/ diff --git a/src/doc/reference/LICENSE-APACHE b/src/doc/reference/LICENSE-APACHE new file mode 100644 index 000000000..16fe87b06 --- /dev/null +++ b/src/doc/reference/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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. diff --git a/src/doc/reference/LICENSE-MIT b/src/doc/reference/LICENSE-MIT new file mode 100644 index 000000000..25597d583 --- /dev/null +++ b/src/doc/reference/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2010 The Rust Project Developers + +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. diff --git a/src/doc/reference/README.md b/src/doc/reference/README.md new file mode 100644 index 000000000..65030a32c --- /dev/null +++ b/src/doc/reference/README.md @@ -0,0 +1,60 @@ +# The Rust Language Reference + +This document is the primary reference for the Rust programming language. + +This document is not normative. It may include details that are specific +to `rustc` itself, and should not be taken as a specification for the +Rust language. We intend to produce such a document someday, but this is +what we have for now. + +## Dependencies + +- rustc (the Rust compiler). +- [mdbook](https://rust-lang.github.io/mdBook/) (use `cargo install mdbook` to install it). +- rust nightly (you would be required to set your Rust version to the nightly version to make sure all tests pass) + +## Build steps + +To build the project, follow the steps given below : + +Clone the project by downloading the ZIP from the [GitHub page](https://github.com/rust-lang/reference) or +run the following command: + +``` +git clone https://github.com/rust-lang/reference +``` + +Change the directory to the downloaded repository: + +```sh +cd reference +``` + +To run the tests, you would need to set the Rust version to the nightly release. You can do this by executing the following command: + +```shell +rustup override set nightly +``` + +This will set the nightly version only for your the current project. + +If you wish to set Rust nightly for all your projects, you can run the command: + +```shell +rustup default nightly +``` + +Now, run the following command to test the code snippets to catch compilation errors: + +```shell +mdbook test +``` + + +To generate a local instance of the book, run: + +```sh +mdbook build +``` + +The generated HTML will be in the `book` folder. diff --git a/src/doc/reference/STYLE.md b/src/doc/reference/STYLE.md new file mode 100644 index 000000000..f51cba3d4 --- /dev/null +++ b/src/doc/reference/STYLE.md @@ -0,0 +1,71 @@ +# Rust reference style guide + +Some conventions and content guidelines are specified in the [introduction]. +This document serves as a guide for editors and reviewers. + +There is a [`style-check`](style-check/) tool which is run in CI to check some of these. To use it locally, run `cargo run --manifest-path=style-check/Cargo.toml src`. + +## Markdown formatting + +* Use ATX-style heading with sentence case. +* Use one line per sentence to make diffs nicer. + Do not wrap long lines. +* Use reference links, with shortcuts if appropriate. + Place the sorted link reference definitions at the bottom of the file, or at the bottom of a section if there is an unusually large number of links that are specific to the section. + + ``` + Example of shortcut link: [enumerations] + Example of reference link with label: [block expression][block] + + [block]: expressions/block-expr.md + [enumerations]: types/enum.md + ``` + +* Links should be relative with the `.md` extension. + Links to other rust-lang books that are published with the reference or the standard library API should also be relative so that the linkchecker can validate them. +* See the [Conventions] section for formatting callouts such as notes, edition differences, and warnings. +* Formatting to avoid: + * Avoid trailing spaces. + * Avoid double blank lines. + +### Code examples + +Code examples should use code blocks with triple backticks. +The language should always be specified (such as `rust`). + +```rust +println!("Hello!"); +``` + +See https://highlightjs.org/ for a list of supported languages. + +Rust examples are tested via rustdoc, and should include the appropriate annotations when tests are expected to fail: + +* `edition2015` or `edition2018` — If it is edition-specific (see `book.toml` for the default). +* `no_run` — The example should compile successfully, but should not be executed. +* `should_panic` — The example should compile and run, but produce a panic. +* `compile_fail` — The example is expected to fail to compile. +* `ignore` — The example shouldn't be built or tested. + This should be avoided if possible. + Usually this is only necessary when the testing framework does not support it (such as external crates or modules, or a proc-macro), or it contains pseudo-code which is not valid Rust. + An HTML comment such as `` should be placed before the example to explain why it is ignored. + +See the [rustdoc documentation] for more detail. + +## Language and grammar + +* Use American English spelling. +* Use Oxford commas. +* Idioms and styling to avoid: + * Avoid slashes for alternatives ("program/binary"), use conjunctions or rewrite it ("program or binary"). + * Avoid qualifying something as "in Rust", the entire reference is about Rust. + +## Content + +* Whenever there is a difference between editions, the differences should be called out with an "Edition Differences" block. + The main text should stick to what is common between the editions. + However, for large differences (such as "async"), the main text may contain edition-specific content as long as it is made clear which editions it applies to. + +[conventions]: src/introduction.md#conventions +[introduction]: src/introduction.md +[rustdoc documentation]: https://doc.rust-lang.org/rustdoc/documentation-tests.html diff --git a/src/doc/reference/book.toml b/src/doc/reference/book.toml new file mode 100644 index 000000000..2bc218fe4 --- /dev/null +++ b/src/doc/reference/book.toml @@ -0,0 +1,14 @@ +[book] + +title = "The Rust Reference" +author = "The Rust Project Developers" + +[output.html] +additional-css = ["theme/reference.css"] +git-repository-url = "https://github.com/rust-lang/reference/" + +[output.html.redirect] +"/expressions/enum-variant-expr.html" = "struct-expr.html" + +[rust] +edition = "2021" diff --git a/src/doc/reference/reference.md b/src/doc/reference/reference.md new file mode 100644 index 000000000..fdeea17ed --- /dev/null +++ b/src/doc/reference/reference.md @@ -0,0 +1,4 @@ +% The Rust Reference has moved + +We've split up the reference into chapters. Please find it at its new +home [here](reference/index.html). diff --git a/src/doc/reference/src/SUMMARY.md b/src/doc/reference/src/SUMMARY.md new file mode 100644 index 000000000..82d70d043 --- /dev/null +++ b/src/doc/reference/src/SUMMARY.md @@ -0,0 +1,135 @@ +# The Rust Reference + +[Introduction](introduction.md) + +- [Notation](notation.md) + +- [Lexical structure](lexical-structure.md) + - [Input format](input-format.md) + - [Keywords](keywords.md) + - [Identifiers](identifiers.md) + - [Comments](comments.md) + - [Whitespace](whitespace.md) + - [Tokens](tokens.md) + +- [Macros](macros.md) + - [Macros By Example](macros-by-example.md) + - [Procedural Macros](procedural-macros.md) + +- [Crates and source files](crates-and-source-files.md) + +- [Conditional compilation](conditional-compilation.md) + +- [Items](items.md) + - [Modules](items/modules.md) + - [Extern crates](items/extern-crates.md) + - [Use declarations](items/use-declarations.md) + - [Functions](items/functions.md) + - [Type aliases](items/type-aliases.md) + - [Structs](items/structs.md) + - [Enumerations](items/enumerations.md) + - [Unions](items/unions.md) + - [Constant items](items/constant-items.md) + - [Static items](items/static-items.md) + - [Traits](items/traits.md) + - [Implementations](items/implementations.md) + - [External blocks](items/external-blocks.md) + - [Generic parameters](items/generics.md) + - [Associated Items](items/associated-items.md) + +- [Attributes](attributes.md) + - [Testing](attributes/testing.md) + - [Derive](attributes/derive.md) + - [Diagnostics](attributes/diagnostics.md) + - [Code generation](attributes/codegen.md) + - [Limits](attributes/limits.md) + - [Type System](attributes/type_system.md) + +- [Statements and expressions](statements-and-expressions.md) + - [Statements](statements.md) + - [Expressions](expressions.md) + - [Literal expressions](expressions/literal-expr.md) + - [Path expressions](expressions/path-expr.md) + - [Block expressions](expressions/block-expr.md) + - [Operator expressions](expressions/operator-expr.md) + - [Grouped expressions](expressions/grouped-expr.md) + - [Array and index expressions](expressions/array-expr.md) + - [Tuple and index expressions](expressions/tuple-expr.md) + - [Struct expressions](expressions/struct-expr.md) + - [Call expressions](expressions/call-expr.md) + - [Method call expressions](expressions/method-call-expr.md) + - [Field access expressions](expressions/field-expr.md) + - [Closure expressions](expressions/closure-expr.md) + - [Loop expressions](expressions/loop-expr.md) + - [Range expressions](expressions/range-expr.md) + - [If and if let expressions](expressions/if-expr.md) + - [Match expressions](expressions/match-expr.md) + - [Return expressions](expressions/return-expr.md) + - [Await expressions](expressions/await-expr.md) + - [Underscore expressions](expressions/underscore-expr.md) + +- [Patterns](patterns.md) + +- [Type system](type-system.md) + - [Types](types.md) + - [Boolean type](types/boolean.md) + - [Numeric types](types/numeric.md) + - [Textual types](types/textual.md) + - [Never type](types/never.md) + - [Tuple types](types/tuple.md) + - [Array types](types/array.md) + - [Slice types](types/slice.md) + - [Struct types](types/struct.md) + - [Enumerated types](types/enum.md) + - [Union types](types/union.md) + - [Function item types](types/function-item.md) + - [Closure types](types/closure.md) + - [Pointer types](types/pointer.md) + - [Function pointer types](types/function-pointer.md) + - [Trait object types](types/trait-object.md) + - [Impl trait type](types/impl-trait.md) + - [Type parameters](types/parameters.md) + - [Inferred type](types/inferred.md) + - [Dynamically Sized Types](dynamically-sized-types.md) + - [Type layout](type-layout.md) + - [Interior mutability](interior-mutability.md) + - [Subtyping and Variance](subtyping.md) + - [Trait and lifetime bounds](trait-bounds.md) + - [Type coercions](type-coercions.md) + - [Destructors](destructors.md) + - [Lifetime elision](lifetime-elision.md) + +- [Special types and traits](special-types-and-traits.md) + +- [Names](names.md) + - [Namespaces](names/namespaces.md) + - [Scopes](names/scopes.md) + - [Preludes](names/preludes.md) + - [Paths](paths.md) + - [Name resolution](names/name-resolution.md) + - [Visibility and privacy](visibility-and-privacy.md) + +- [Memory model](memory-model.md) + - [Memory allocation and lifetime](memory-allocation-and-lifetime.md) + - [Variables](variables.md) + +- [Linkage](linkage.md) + +- [Inline assembly](inline-assembly.md) + +- [Unsafety](unsafety.md) + - [Unsafe functions](unsafe-functions.md) + - [Unsafe blocks](unsafe-blocks.md) + - [Behavior considered undefined](behavior-considered-undefined.md) + - [Behavior not considered unsafe](behavior-not-considered-unsafe.md) + +- [Constant Evaluation](const_eval.md) + +- [Application Binary Interface](abi.md) + +- [The Rust runtime](runtime.md) + +- [Appendices](appendices.md) + - [Macro Follow-Set Ambiguity Formal Specification](macro-ambiguity.md) + - [Influences](influences.md) + - [Glossary](glossary.md) diff --git a/src/doc/reference/src/abi.md b/src/doc/reference/src/abi.md new file mode 100644 index 000000000..374dd6d45 --- /dev/null +++ b/src/doc/reference/src/abi.md @@ -0,0 +1,100 @@ +# Application Binary Interface (ABI) + +This section documents features that affect the ABI of the compiled output of +a crate. + +See *[extern functions]* for information on specifying the ABI for exporting +functions. See *[external blocks]* for information on specifying the ABI for +linking external libraries. + +## The `used` attribute + +The *`used` attribute* can only be applied to [`static` items]. This [attribute] forces the +compiler to keep the variable in the output object file (.o, .rlib, etc. excluding final binaries) +even if the variable is not used, or referenced, by any other item in the crate. +However, the linker is still free to remove such an item. + +Below is an example that shows under what conditions the compiler keeps a `static` item in the +output object file. + +``` rust +// foo.rs + +// This is kept because of `#[used]`: +#[used] +static FOO: u32 = 0; + +// This is removable because it is unused: +#[allow(dead_code)] +static BAR: u32 = 0; + +// This is kept because it is publicly reachable: +pub static BAZ: u32 = 0; + +// This is kept because it is referenced by a public, reachable function: +static QUUX: u32 = 0; + +pub fn quux() -> &'static u32 { + &QUUX +} + +// This is removable because it is referenced by a private, unused (dead) function: +static CORGE: u32 = 0; + +#[allow(dead_code)] +fn corge() -> &'static u32 { + &CORGE +} +``` + +``` console +$ rustc -O --emit=obj --crate-type=rlib foo.rs + +$ nm -C foo.o +0000000000000000 R foo::BAZ +0000000000000000 r foo::FOO +0000000000000000 R foo::QUUX +0000000000000000 T foo::quux +``` + +## The `no_mangle` attribute + +The *`no_mangle` attribute* may be used on any [item] to disable standard +symbol name mangling. The symbol for the item will be the identifier of the +item's name. + +Additionally, the item will be publicly exported from the produced library or +object file, similar to the [`used` attribute](#the-used-attribute). + +## The `link_section` attribute + +The *`link_section` attribute* specifies the section of the object file that a +[function] or [static]'s content will be placed into. It uses the +[_MetaNameValueStr_] syntax to specify the section name. + + +```rust,no_run +#[no_mangle] +#[link_section = ".example_section"] +pub static VAR1: u32 = 1; +``` + +## The `export_name` attribute + +The *`export_name` attribute* specifies the name of the symbol that will be +exported on a [function] or [static]. It uses the [_MetaNameValueStr_] syntax +to specify the symbol name. + +```rust +#[export_name = "exported_symbol_name"] +pub fn name_in_rust() { } +``` + +[_MetaNameValueStr_]: attributes.md#meta-item-attribute-syntax +[`static` items]: items/static-items.md +[attribute]: attributes.md +[extern functions]: items/functions.md#extern-function-qualifier +[external blocks]: items/external-blocks.md +[function]: items/functions.md +[item]: items.md +[static]: items/static-items.md diff --git a/src/doc/reference/src/appendices.md b/src/doc/reference/src/appendices.md new file mode 100644 index 000000000..28acb81ce --- /dev/null +++ b/src/doc/reference/src/appendices.md @@ -0,0 +1 @@ +# Appendices diff --git a/src/doc/reference/src/attributes-redirect.html b/src/doc/reference/src/attributes-redirect.html new file mode 100644 index 000000000..a0548cc49 --- /dev/null +++ b/src/doc/reference/src/attributes-redirect.html @@ -0,0 +1,29 @@ + diff --git a/src/doc/reference/src/attributes.md b/src/doc/reference/src/attributes.md new file mode 100644 index 000000000..857cd7d72 --- /dev/null +++ b/src/doc/reference/src/attributes.md @@ -0,0 +1,346 @@ +{{#include attributes-redirect.html}} +# Attributes + +> **Syntax**\ +> _InnerAttribute_ :\ +>    `#` `!` `[` _Attr_ `]` +> +> _OuterAttribute_ :\ +>    `#` `[` _Attr_ `]` +> +> _Attr_ :\ +>    [_SimplePath_] _AttrInput_? +> +> _AttrInput_ :\ +>       [_DelimTokenTree_]\ +>    | `=` [_Expression_] + +An _attribute_ is a general, free-form metadatum that is interpreted according +to name, convention, language, and compiler version. Attributes are modeled +on Attributes in [ECMA-335], with the syntax coming from [ECMA-334] \(C#). + +_Inner attributes_, written with a bang (`!`) after the hash (`#`), apply to the +item that the attribute is declared within. _Outer attributes_, written without +the bang after the hash, apply to the thing that follows the attribute. + +The attribute consists of a path to the attribute, followed by an optional +delimited token tree whose interpretation is defined by the attribute. +Attributes other than macro attributes also allow the input to be an equals +sign (`=`) followed by an expression. See the [meta item +syntax](#meta-item-attribute-syntax) below for more details. + +Attributes can be classified into the following kinds: + +* [Built-in attributes] +* [Macro attributes][attribute macros] +* [Derive macro helper attributes] +* [Tool attributes](#tool-attributes) + +Attributes may be applied to many things in the language: + +* All [item declarations] accept outer attributes while [external blocks], + [functions], [implementations], and [modules] accept inner attributes. +* Most [statements] accept outer attributes (see [Expression Attributes] for + limitations on expression statements). +* [Block expressions] accept outer and inner attributes, but only when they are + the outer expression of an [expression statement] or the final expression of + another block expression. +* [Enum] variants and [struct] and [union] fields accept outer attributes. +* [Match expression arms][match expressions] accept outer attributes. +* [Generic lifetime or type parameter][generics] accept outer attributes. +* Expressions accept outer attributes in limited situations, see [Expression + Attributes] for details. +* [Function][functions], [closure] and [function pointer] + parameters accept outer attributes. This includes attributes on variadic parameters + denoted with `...` in function pointers and [external blocks][variadic functions]. + +Some examples of attributes: + +```rust +// General metadata applied to the enclosing module or crate. +#![crate_type = "lib"] + +// A function marked as a unit test +#[test] +fn test_foo() { + /* ... */ +} + +// A conditionally-compiled module +#[cfg(target_os = "linux")] +mod bar { + /* ... */ +} + +// A lint attribute used to suppress a warning/error +#[allow(non_camel_case_types)] +type int8_t = i8; + +// Inner attribute applies to the entire function. +fn some_unused_variables() { + #![allow(unused_variables)] + + let x = (); + let y = (); + let z = (); +} +``` + +## Meta Item Attribute Syntax + +A "meta item" is the syntax used for the _Attr_ rule by most [built-in +attributes]. It has the following grammar: + +> **Syntax**\ +> _MetaItem_ :\ +>       [_SimplePath_]\ +>    | [_SimplePath_] `=` [_Expression_]\ +>    | [_SimplePath_] `(` _MetaSeq_? `)` +> +> _MetaSeq_ :\ +>    _MetaItemInner_ ( `,` MetaItemInner )\* `,`? +> +> _MetaItemInner_ :\ +>       _MetaItem_\ +>    | [_Expression_] + +Expressions in meta items must macro-expand to literal expressions, which must not +include integer or float type suffixes. Expressions which are not literal expressions +will be syntactically accepted (and can be passed to proc-macros), but will be rejected after parsing. + +Note that if the attribute appears within another macro, it will be expanded +after that outer macro. For example, the following code will expand the +`Serialize` proc-macro first, which must preserve the `include_str!` call in +order for it to be expanded: + +```rust ignore +#[derive(Serialize)] +struct Foo { + #[doc = include_str!("x.md")] + x: u32 +} +``` + +Additionally, macros in attributes will be expanded only after all other attributes applied to the item: + +```rust ignore +#[macro_attr1] // expanded first +#[doc = mac!()] // `mac!` is expanded fourth. +#[macro_attr2] // expanded second +#[derive(MacroDerive1, MacroDerive2)] // expanded third +fn foo() {} +``` + +Various built-in attributes use different subsets of the meta item syntax to +specify their inputs. The following grammar rules show some commonly used +forms: + +> **Syntax**\ +> _MetaWord_:\ +>    [IDENTIFIER] +> +> _MetaNameValueStr_:\ +>    [IDENTIFIER] `=` ([STRING_LITERAL] | [RAW_STRING_LITERAL]) +> +> _MetaListPaths_:\ +>    [IDENTIFIER] `(` ( [_SimplePath_] (`,` [_SimplePath_])* `,`? )? `)` +> +> _MetaListIdents_:\ +>    [IDENTIFIER] `(` ( [IDENTIFIER] (`,` [IDENTIFIER])* `,`? )? `)` +> +> _MetaListNameValueStr_:\ +>    [IDENTIFIER] `(` ( _MetaNameValueStr_ (`,` _MetaNameValueStr_)* `,`? )? `)` + +Some examples of meta items are: + +Style | Example +------|-------- +_MetaWord_ | `no_std` +_MetaNameValueStr_ | `doc = "example"` +_MetaListPaths_ | `allow(unused, clippy::inline_always)` +_MetaListIdents_ | `macro_use(foo, bar)` +_MetaListNameValueStr_ | `link(name = "CoreFoundation", kind = "framework")` + +## Active and inert attributes + +An attribute is either active or inert. During attribute processing, *active +attributes* remove themselves from the thing they are on while *inert attributes* +stay on. + +The [`cfg`] and [`cfg_attr`] attributes are active. The [`test`] attribute is +inert when compiling for tests and active otherwise. [Attribute macros] are +active. All other attributes are inert. + +## Tool attributes + +The compiler may allow attributes for external tools where each tool resides +in its own namespace in the [tool prelude]. The first segment of the attribute +path is the name of the tool, with one or more additional segments whose +interpretation is up to the tool. + +When a tool is not in use, the tool's attributes are accepted without a +warning. When the tool is in use, the tool is responsible for processing and +interpretation of its attributes. + +Tool attributes are not available if the [`no_implicit_prelude`] attribute is +used. + +```rust +// Tells the rustfmt tool to not format the following element. +#[rustfmt::skip] +struct S { +} + +// Controls the "cyclomatic complexity" threshold for the clippy tool. +#[clippy::cyclomatic_complexity = "100"] +pub fn f() {} +``` + +> Note: `rustc` currently recognizes the tools "clippy" and "rustfmt". + +## Built-in attributes index + +The following is an index of all built-in attributes. + +- Conditional compilation + - [`cfg`] — Controls conditional compilation. + - [`cfg_attr`] — Conditionally includes attributes. +- Testing + - [`test`] — Marks a function as a test. + - [`ignore`] — Disables a test function. + - [`should_panic`] — Indicates a test should generate a panic. +- Derive + - [`derive`] — Automatic trait implementations. + - [`automatically_derived`] — Marker for implementations created by + `derive`. +- Macros + - [`macro_export`] — Exports a `macro_rules` macro for cross-crate usage. + - [`macro_use`] — Expands macro visibility, or imports macros from other + crates. + - [`proc_macro`] — Defines a function-like macro. + - [`proc_macro_derive`] — Defines a derive macro. + - [`proc_macro_attribute`] — Defines an attribute macro. +- Diagnostics + - [`allow`], [`warn`], [`deny`], [`forbid`] — Alters the default lint level. + - [`deprecated`] — Generates deprecation notices. + - [`must_use`] — Generates a lint for unused values. +- ABI, linking, symbols, and FFI + - [`link`] — Specifies a native library to link with an `extern` block. + - [`link_name`] — Specifies the name of the symbol for functions or statics + in an `extern` block. + - [`no_link`] — Prevents linking an extern crate. + - [`repr`] — Controls type layout. + - [`crate_type`] — Specifies the type of crate (library, executable, etc.). + - [`no_main`] — Disables emitting the `main` symbol. + - [`export_name`] — Specifies the exported symbol name for a function or + static. + - [`link_section`] — Specifies the section of an object file to use for a + function or static. + - [`no_mangle`] — Disables symbol name encoding. + - [`used`] — Forces the compiler to keep a static item in the output + object file. + - [`crate_name`] — Specifies the crate name. +- Code generation + - [`inline`] — Hint to inline code. + - [`cold`] — Hint that a function is unlikely to be called. + - [`no_builtins`] — Disables use of certain built-in functions. + - [`target_feature`] — Configure platform-specific code generation. + - [`track_caller`] - Pass the parent call location to `std::panic::Location::caller()`. +- Documentation + - `doc` — Specifies documentation. See [The Rustdoc Book] for more + information. [Doc comments] are transformed into `doc` attributes. +- Preludes + - [`no_std`] — Removes std from the prelude. + - [`no_implicit_prelude`] — Disables prelude lookups within a module. +- Modules + - [`path`] — Specifies the filename for a module. +- Limits + - [`recursion_limit`] — Sets the maximum recursion limit for certain + compile-time operations. + - [`type_length_limit`] — Sets the maximum size of a polymorphic type. +- Runtime + - [`panic_handler`] — Sets the function to handle panics. + - [`global_allocator`] — Sets the global memory allocator. + - [`windows_subsystem`] — Specifies the windows subsystem to link with. +- Features + - `feature` — Used to enable unstable or experimental compiler features. See + [The Unstable Book] for features implemented in `rustc`. +- Type System + - [`non_exhaustive`] — Indicate that a type will have more fields/variants + added in future. + +[Doc comments]: comments.md#doc-comments +[ECMA-334]: https://www.ecma-international.org/publications/standards/Ecma-334.htm +[ECMA-335]: https://www.ecma-international.org/publications/standards/Ecma-335.htm +[Expression Attributes]: expressions.md#expression-attributes +[IDENTIFIER]: identifiers.md +[RAW_STRING_LITERAL]: tokens.md#raw-string-literals +[STRING_LITERAL]: tokens.md#string-literals +[The Rustdoc Book]: ../rustdoc/the-doc-attribute.html +[The Unstable Book]: ../unstable-book/index.html +[_DelimTokenTree_]: macros.md +[_Expression_]: expressions.md +[_SimplePath_]: paths.md#simple-paths +[`allow`]: attributes/diagnostics.md#lint-check-attributes +[`automatically_derived`]: attributes/derive.md#the-automatically_derived-attribute +[`cfg_attr`]: conditional-compilation.md#the-cfg_attr-attribute +[`cfg`]: conditional-compilation.md#the-cfg-attribute +[`cold`]: attributes/codegen.md#the-cold-attribute +[`crate_name`]: crates-and-source-files.md#the-crate_name-attribute +[`crate_type`]: linkage.md +[`deny`]: attributes/diagnostics.md#lint-check-attributes +[`deprecated`]: attributes/diagnostics.md#the-deprecated-attribute +[`derive`]: attributes/derive.md +[`export_name`]: abi.md#the-export_name-attribute +[`forbid`]: attributes/diagnostics.md#lint-check-attributes +[`global_allocator`]: runtime.md#the-global_allocator-attribute +[`ignore`]: attributes/testing.md#the-ignore-attribute +[`inline`]: attributes/codegen.md#the-inline-attribute +[`link_name`]: items/external-blocks.md#the-link_name-attribute +[`link_section`]: abi.md#the-link_section-attribute +[`link`]: items/external-blocks.md#the-link-attribute +[`macro_export`]: macros-by-example.md#path-based-scope +[`macro_use`]: macros-by-example.md#the-macro_use-attribute +[`must_use`]: attributes/diagnostics.md#the-must_use-attribute +[`no_builtins`]: attributes/codegen.md#the-no_builtins-attribute +[`no_implicit_prelude`]: names/preludes.md#the-no_implicit_prelude-attribute +[`no_link`]: items/extern-crates.md#the-no_link-attribute +[`no_main`]: crates-and-source-files.md#the-no_main-attribute +[`no_mangle`]: abi.md#the-no_mangle-attribute +[`no_std`]: names/preludes.md#the-no_std-attribute +[`non_exhaustive`]: attributes/type_system.md#the-non_exhaustive-attribute +[`panic_handler`]: runtime.md#the-panic_handler-attribute +[`path`]: items/modules.md#the-path-attribute +[`proc_macro_attribute`]: procedural-macros.md#attribute-macros +[`proc_macro_derive`]: procedural-macros.md#derive-macros +[`proc_macro`]: procedural-macros.md#function-like-procedural-macros +[`recursion_limit`]: attributes/limits.md#the-recursion_limit-attribute +[`repr`]: type-layout.md#representations +[`should_panic`]: attributes/testing.md#the-should_panic-attribute +[`target_feature`]: attributes/codegen.md#the-target_feature-attribute +[`test`]: attributes/testing.md#the-test-attribute +[`track_caller`]: attributes/codegen.md#the-track_caller-attribute +[`type_length_limit`]: attributes/limits.md#the-type_length_limit-attribute +[`used`]: abi.md#the-used-attribute +[`warn`]: attributes/diagnostics.md#lint-check-attributes +[`windows_subsystem`]: runtime.md#the-windows_subsystem-attribute +[attribute macros]: procedural-macros.md#attribute-macros +[block expressions]: expressions/block-expr.md +[built-in attributes]: #built-in-attributes-index +[derive macro helper attributes]: procedural-macros.md#derive-macro-helper-attributes +[enum]: items/enumerations.md +[expression statement]: statements.md#expression-statements +[external blocks]: items/external-blocks.md +[functions]: items/functions.md +[generics]: items/generics.md +[implementations]: items/implementations.md +[item declarations]: items.md +[match expressions]: expressions/match-expr.md +[modules]: items/modules.md +[statements]: statements.md +[struct]: items/structs.md +[tool prelude]: names/preludes.md#tool-prelude +[union]: items/unions.md +[closure]: expressions/closure-expr.md +[function pointer]: types/function-pointer.md +[variadic functions]: items/external-blocks.html#variadic-functions diff --git a/src/doc/reference/src/attributes/codegen.md b/src/doc/reference/src/attributes/codegen.md new file mode 100644 index 000000000..4ebabaccf --- /dev/null +++ b/src/doc/reference/src/attributes/codegen.md @@ -0,0 +1,354 @@ +# Code generation attributes + +The following [attributes] are used for controlling code generation. + +## Optimization hints + +The `cold` and `inline` [attributes] give suggestions to generate code in a +way that may be faster than what it would do without the hint. The attributes +are only hints, and may be ignored. + +Both attributes can be used on [functions]. When applied to a function in a +[trait], they apply only to that function when used as a default function for +a trait implementation and not to all trait implementations. The attributes +have no effect on a trait function without a body. + +### The `inline` attribute + +The *`inline` [attribute]* suggests that a copy of the attributed function +should be placed in the caller, rather than generating code to call the +function where it is defined. + +> ***Note***: The `rustc` compiler automatically inlines functions based on +> internal heuristics. Incorrectly inlining functions can make the program +> slower, so this attribute should be used with care. + +There are three ways to use the inline attribute: + +* `#[inline]` *suggests* performing an inline expansion. +* `#[inline(always)]` *suggests* that an inline expansion should always be + performed. +* `#[inline(never)]` *suggests* that an inline expansion should never be + performed. + +> ***Note***: `#[inline]` in every form is a hint, with no *requirements* +> on the language to place a copy of the attributed function in the caller. + +### The `cold` attribute + +The *`cold` [attribute]* suggests that the attributed function is unlikely to +be called. + +## The `no_builtins` attribute + +The *`no_builtins` [attribute]* may be applied at the crate level to disable +optimizing certain code patterns to invocations of library functions that are +assumed to exist. + +## The `target_feature` attribute + +The *`target_feature` [attribute]* may be applied to a function to +enable code generation of that function for specific platform architecture +features. It uses the [_MetaListNameValueStr_] syntax with a single key of +`enable` whose value is a string of comma-separated feature names to enable. + +```rust +# #[cfg(target_feature = "avx2")] +#[target_feature(enable = "avx2")] +unsafe fn foo_avx2() {} +``` + +Each [target architecture] has a set of features that may be enabled. It is an +error to specify a feature for a target architecture that the crate is not +being compiled for. + +It is [undefined behavior] to call a function that is compiled with a feature +that is not supported on the current platform the code is running on, *except* +if the platform explicitly documents this to be safe. + +Functions marked with `target_feature` are not inlined into a context that +does not support the given features. The `#[inline(always)]` attribute may not +be used with a `target_feature` attribute. + +### Available features + +The following is a list of the available feature names. + +#### `x86` or `x86_64` + +Executing code with unsupported features is undefined behavior on this platform. +Hence this platform requires that `#[target_feature]` is only applied to [`unsafe` +functions][unsafe function]. + +Feature | Implicitly Enables | Description +------------|--------------------|------------------- +`adx` | | [ADX] — Multi-Precision Add-Carry Instruction Extensions +`aes` | `sse2` | [AES] — Advanced Encryption Standard +`avx` | `sse4.2` | [AVX] — Advanced Vector Extensions +`avx2` | `avx` | [AVX2] — Advanced Vector Extensions 2 +`bmi1` | | [BMI1] — Bit Manipulation Instruction Sets +`bmi2` | | [BMI2] — Bit Manipulation Instruction Sets 2 +`fma` | `avx` | [FMA3] — Three-operand fused multiply-add +`fxsr` | | [`fxsave`] and [`fxrstor`] — Save and restore x87 FPU, MMX Technology, and SSE State +`lzcnt` | | [`lzcnt`] — Leading zeros count +`pclmulqdq` | `sse2` | [`pclmulqdq`] — Packed carry-less multiplication quadword +`popcnt` | | [`popcnt`] — Count of bits set to 1 +`rdrand` | | [`rdrand`] — Read random number +`rdseed` | | [`rdseed`] — Read random seed +`sha` | `sse2` | [SHA] — Secure Hash Algorithm +`sse` | | [SSE] — Streaming SIMD Extensions +`sse2` | `sse` | [SSE2] — Streaming SIMD Extensions 2 +`sse3` | `sse2` | [SSE3] — Streaming SIMD Extensions 3 +`sse4.1` | `ssse3` | [SSE4.1] — Streaming SIMD Extensions 4.1 +`sse4.2` | `sse4.1` | [SSE4.2] — Streaming SIMD Extensions 4.2 +`ssse3` | `sse3` | [SSSE3] — Supplemental Streaming SIMD Extensions 3 +`xsave` | | [`xsave`] — Save processor extended states +`xsavec` | | [`xsavec`] — Save processor extended states with compaction +`xsaveopt` | | [`xsaveopt`] — Save processor extended states optimized +`xsaves` | | [`xsaves`] — Save processor extended states supervisor + + + +[ADX]: https://en.wikipedia.org/wiki/Intel_ADX +[AES]: https://en.wikipedia.org/wiki/AES_instruction_set +[AVX]: https://en.wikipedia.org/wiki/Advanced_Vector_Extensions +[AVX2]: https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#AVX2 +[BMI1]: https://en.wikipedia.org/wiki/Bit_Manipulation_Instruction_Sets +[BMI2]: https://en.wikipedia.org/wiki/Bit_Manipulation_Instruction_Sets#BMI2 +[FMA3]: https://en.wikipedia.org/wiki/FMA_instruction_set +[`fxsave`]: https://www.felixcloutier.com/x86/fxsave +[`fxrstor`]: https://www.felixcloutier.com/x86/fxrstor +[`lzcnt`]: https://www.felixcloutier.com/x86/lzcnt +[`pclmulqdq`]: https://www.felixcloutier.com/x86/pclmulqdq +[`popcnt`]: https://www.felixcloutier.com/x86/popcnt +[`rdrand`]: https://en.wikipedia.org/wiki/RdRand +[`rdseed`]: https://en.wikipedia.org/wiki/RdRand +[SHA]: https://en.wikipedia.org/wiki/Intel_SHA_extensions +[SSE]: https://en.wikipedia.org/wiki/Streaming_SIMD_Extensions +[SSE2]: https://en.wikipedia.org/wiki/SSE2 +[SSE3]: https://en.wikipedia.org/wiki/SSE3 +[SSE4.1]: https://en.wikipedia.org/wiki/SSE4#SSE4.1 +[SSE4.2]: https://en.wikipedia.org/wiki/SSE4#SSE4.2 +[SSSE3]: https://en.wikipedia.org/wiki/SSSE3 +[`xsave`]: https://www.felixcloutier.com/x86/xsave +[`xsavec`]: https://www.felixcloutier.com/x86/xsavec +[`xsaveopt`]: https://www.felixcloutier.com/x86/xsaveopt +[`xsaves`]: https://www.felixcloutier.com/x86/xsaves + +#### `aarch64` + +This platform requires that `#[target_feature]` is only applied to [`unsafe` +functions][unsafe function]. + +Further documentation on these features can be found in the [ARM Architecture +Reference Manual], or elsewhere on [developer.arm.com]. + +[ARM Architecture Reference Manual]: https://developer.arm.com/documentation/ddi0487/latest +[developer.arm.com]: https://developer.arm.com + +> ***Note***: The following pairs of features should both be marked as enabled +> or disabled together if used: +> - `paca` and `pacg`, which LLVM currently implements as one feature. + + +Feature | Implicitly Enables | Feature Name +---------------|--------------------|------------------- +`aes` | `neon` | FEAT_AES - Advanced SIMD AES instructions +`bf16` | | FEAT_BF16 - BFloat16 instructions +`bti` | | FEAT_BTI - Branch Target Identification +`crc` | | FEAT_CRC - CRC32 checksum instructions +`dit` | | FEAT_DIT - Data Independent Timing instructions +`dotprod` | | FEAT_DotProd - Advanced SIMD Int8 dot product instructions +`dpb` | | FEAT_DPB - Data cache clean to point of persistence +`dpb2` | | FEAT_DPB2 - Data cache clean to point of deep persistence +`f32mm` | `sve` | FEAT_F32MM - SVE single-precision FP matrix multiply instruction +`f64mm` | `sve` | FEAT_F64MM - SVE double-precision FP matrix multiply instruction +`fcma` | `neon` | FEAT_FCMA - Floating point complex number support +`fhm` | `fp16` | FEAT_FHM - Half-precision FP FMLAL instructions +`flagm` | | FEAT_FlagM - Conditional flag manipulation +`fp16` | `neon` | FEAT_FP16 - Half-precision FP data processing +`frintts` | | FEAT_FRINTTS - Floating-point to int helper instructions +`i8mm` | | FEAT_I8MM - Int8 Matrix Multiplication +`jsconv` | `neon` | FEAT_JSCVT - JavaScript conversion instruction +`lse` | | FEAT_LSE - Large System Extension +`lor` | | FEAT_LOR - Limited Ordering Regions extension +`mte` | | FEAT_MTE - Memory Tagging Extension +`neon` | | FEAT_FP & FEAT_AdvSIMD - Floating Point and Advanced SIMD extension +`pan` | | FEAT_PAN - Privileged Access-Never extension +`paca` | | FEAT_PAuth - Pointer Authentication (address authentication) +`pacg` | | FEAT_PAuth - Pointer Authentication (generic authentication) +`pmuv3` | | FEAT_PMUv3 - Performance Monitors extension (v3) +`rand` | | FEAT_RNG - Random Number Generator +`ras` | | FEAT_RAS - Reliability, Availability and Serviceability extension +`rcpc` | | FEAT_LRCPC - Release consistent Processor Consistent +`rcpc2` | `rcpc` | FEAT_LRCPC2 - RcPc with immediate offsets +`rdm` | | FEAT_RDM - Rounding Double Multiply accumulate +`sb` | | FEAT_SB - Speculation Barrier +`sha2` | `neon` | FEAT_SHA1 & FEAT_SHA256 - Advanced SIMD SHA instructions +`sha3` | `sha2` | FEAT_SHA512 & FEAT_SHA3 - Advanced SIMD SHA instructions +`sm4` | `neon` | FEAT_SM3 & FEAT_SM4 - Advanced SIMD SM3/4 instructions +`spe` | | FEAT_SPE - Statistical Profiling Extension +`ssbs` | | FEAT_SSBS - Speculative Store Bypass Safe +`sve` | `fp16` | FEAT_SVE - Scalable Vector Extension +`sve2` | `sve` | FEAT_SVE2 - Scalable Vector Extension 2 +`sve2-aes` | `sve2`, `aes` | FEAT_SVE_AES - SVE AES instructions +`sve2-sm4` | `sve2`, `sm4` | FEAT_SVE_SM4 - SVE SM4 instructions +`sve2-sha3` | `sve2`, `sha3` | FEAT_SVE_SHA3 - SVE SHA3 instructions +`sve2-bitperm` | `sve2` | FEAT_SVE_BitPerm - SVE Bit Permute +`tme` | | FEAT_TME - Transactional Memory Extension +`vh` | | FEAT_VHE - Virtualization Host Extensions + +#### `wasm32` or `wasm64` + +`#[target_feature]` may be used with both safe and +[`unsafe` functions][unsafe function] on Wasm platforms. It is impossible to +cause undefined behavior via the `#[target_feature]` attribute because +attempting to use instructions unsupported by the Wasm engine will fail at load +time without the risk of being interpreted in a way different from what the +compiler expected. + +Feature | Description +------------|------------------- +`simd128` | [WebAssembly simd proposal][simd128] + +[simd128]: https://github.com/webassembly/simd + +### Additional information + +See the [`target_feature` conditional compilation option] for selectively +enabling or disabling compilation of code based on compile-time settings. Note +that this option is not affected by the `target_feature` attribute, and is +only driven by the features enabled for the entire crate. + +See the [`is_x86_feature_detected`] or [`is_aarch64_feature_detected`] macros +in the standard library for runtime feature detection on these platforms. + +> Note: `rustc` has a default set of features enabled for each target and CPU. +> The CPU may be chosen with the [`-C target-cpu`] flag. Individual features +> may be enabled or disabled for an entire crate with the +> [`-C target-feature`] flag. + +## The `track_caller` attribute + +The `track_caller` attribute may be applied to any function with [`"Rust"` ABI][rust-abi] +with the exception of the entry point `fn main`. When applied to functions and methods in +trait declarations, the attribute applies to all implementations. If the trait provides a +default implementation with the attribute, then the attribute also applies to override implementations. + +When applied to a function in an `extern` block the attribute must also be applied to any linked +implementations, otherwise undefined behavior results. When applied to a function which is made +available to an `extern` block, the declaration in the `extern` block must also have the attribute, +otherwise undefined behavior results. + +### Behavior + +Applying the attribute to a function `f` allows code within `f` to get a hint of the [`Location`] of +the "topmost" tracked call that led to `f`'s invocation. At the point of observation, an +implementation behaves as if it walks up the stack from `f`'s frame to find the nearest frame of an +*unattributed* function `outer`, and it returns the [`Location`] of the tracked call in `outer`. + +```rust +#[track_caller] +fn f() { + println!("{}", std::panic::Location::caller()); +} +``` + +> Note: `core` provides [`core::panic::Location::caller`] for observing caller locations. It wraps +> the [`core::intrinsics::caller_location`] intrinsic implemented by `rustc`. + +> Note: because the resulting `Location` is a hint, an implementation may halt its walk up the stack +> early. See [Limitations](#limitations) for important caveats. + +#### Examples + +When `f` is called directly by `calls_f`, code in `f` observes its callsite within `calls_f`: + +```rust +# #[track_caller] +# fn f() { +# println!("{}", std::panic::Location::caller()); +# } +fn calls_f() { + f(); // <-- f() prints this location +} +``` + +When `f` is called by another attributed function `g` which is in turn called by `calls_g`, code in +both `f` and `g` observes `g`'s callsite within `calls_g`: + +```rust +# #[track_caller] +# fn f() { +# println!("{}", std::panic::Location::caller()); +# } +#[track_caller] +fn g() { + println!("{}", std::panic::Location::caller()); + f(); +} + +fn calls_g() { + g(); // <-- g() prints this location twice, once itself and once from f() +} +``` + +When `g` is called by another attributed function `h` which is in turn called by `calls_h`, all code +in `f`, `g`, and `h` observes `h`'s callsite within `calls_h`: + +```rust +# #[track_caller] +# fn f() { +# println!("{}", std::panic::Location::caller()); +# } +# #[track_caller] +# fn g() { +# println!("{}", std::panic::Location::caller()); +# f(); +# } +#[track_caller] +fn h() { + println!("{}", std::panic::Location::caller()); + g(); +} + +fn calls_h() { + h(); // <-- prints this location three times, once itself, once from g(), once from f() +} +``` + +And so on. + +### Limitations + +This information is a hint and implementations are not required to preserve it. + +In particular, coercing a function with `#[track_caller]` to a function pointer creates a shim which +appears to observers to have been called at the attributed function's definition site, losing actual +caller information across virtual calls. A common example of this coercion is the creation of a +trait object whose methods are attributed. + +> Note: The aforementioned shim for function pointers is necessary because `rustc` implements +> `track_caller` in a codegen context by appending an implicit parameter to the function ABI, but +> this would be unsound for an indirect call because the parameter is not a part of the function's +> type and a given function pointer type may or may not refer to a function with the attribute. The +> creation of a shim hides the implicit parameter from callers of the function pointer, preserving +> soundness. + +[_MetaListNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[`-C target-cpu`]: ../../rustc/codegen-options/index.html#target-cpu +[`-C target-feature`]: ../../rustc/codegen-options/index.html#target-feature +[`is_x86_feature_detected`]: ../../std/arch/macro.is_x86_feature_detected.html +[`is_aarch64_feature_detected`]: ../../std/arch/macro.is_aarch64_feature_detected.html +[`target_feature` conditional compilation option]: ../conditional-compilation.md#target_feature +[attribute]: ../attributes.md +[attributes]: ../attributes.md +[functions]: ../items/functions.md +[target architecture]: ../conditional-compilation.md#target_arch +[trait]: ../items/traits.md +[undefined behavior]: ../behavior-considered-undefined.md +[unsafe function]: ../unsafe-functions.md +[rust-abi]: ../items/external-blocks.md#abi +[`core::intrinsics::caller_location`]: ../../core/intrinsics/fn.caller_location.html +[`core::panic::Location::caller`]: ../../core/panic/struct.Location.html#method.caller +[`Location`]: ../../core/panic/struct.Location.html diff --git a/src/doc/reference/src/attributes/derive.md b/src/doc/reference/src/attributes/derive.md new file mode 100644 index 000000000..b8909ac71 --- /dev/null +++ b/src/doc/reference/src/attributes/derive.md @@ -0,0 +1,51 @@ +# Derive + +The *`derive` attribute* allows new [items] to be automatically generated for +data structures. It uses the [_MetaListPaths_] syntax to specify a list of +traits to implement or paths to [derive macros] to process. + +For example, the following will create an [`impl` item] for the +[`PartialEq`] and [`Clone`] traits for `Foo`, and the type parameter `T` will be +given the `PartialEq` or `Clone` constraints for the appropriate `impl`: + +```rust +#[derive(PartialEq, Clone)] +struct Foo { + a: i32, + b: T, +} +``` + +The generated `impl` for `PartialEq` is equivalent to + +```rust +# struct Foo { a: i32, b: T } +impl PartialEq for Foo { + fn eq(&self, other: &Foo) -> bool { + self.a == other.a && self.b == other.b + } + + fn ne(&self, other: &Foo) -> bool { + self.a != other.a || self.b != other.b + } +} +``` + +You can implement `derive` for your own traits through [procedural macros]. + +## The `automatically_derived` attribute + +The *`automatically_derived` attribute* is automatically added to +[implementations] created by the `derive` attribute for built-in traits. It +has no direct effect, but it may be used by tools and diagnostic lints to +detect these automatically generated implementations. + +[_MetaListPaths_]: ../attributes.md#meta-item-attribute-syntax +[`Clone`]: ../../std/clone/trait.Clone.html +[`PartialEq`]: ../../std/cmp/trait.PartialEq.html +[`impl` item]: ../items/implementations.md +[items]: ../items.md +[derive macros]: ../procedural-macros.md#derive-macros +[implementations]: ../items/implementations.md +[items]: ../items.md +[procedural macros]: ../procedural-macros.md#derive-macros diff --git a/src/doc/reference/src/attributes/diagnostics.md b/src/doc/reference/src/attributes/diagnostics.md new file mode 100644 index 000000000..1dd9363d8 --- /dev/null +++ b/src/doc/reference/src/attributes/diagnostics.md @@ -0,0 +1,335 @@ +# Diagnostic attributes + +The following [attributes] are used for controlling or generating diagnostic +messages during compilation. + +## Lint check attributes + +A lint check names a potentially undesirable coding pattern, such as +unreachable code or omitted documentation. The lint attributes `allow`, +`warn`, `deny`, and `forbid` use the [_MetaListPaths_] syntax to specify a +list of lint names to change the lint level for the entity to which the +attribute applies. + +For any lint check `C`: + +* `allow(C)` overrides the check for `C` so that violations will go + unreported, +* `warn(C)` warns about violations of `C` but continues compilation. +* `deny(C)` signals an error after encountering a violation of `C`, +* `forbid(C)` is the same as `deny(C)`, but also forbids changing the lint + level afterwards, + +> Note: The lint checks supported by `rustc` can be found via `rustc -W help`, +> along with their default settings and are documented in the [rustc book]. + +```rust +pub mod m1 { + // Missing documentation is ignored here + #[allow(missing_docs)] + pub fn undocumented_one() -> i32 { 1 } + + // Missing documentation signals a warning here + #[warn(missing_docs)] + pub fn undocumented_too() -> i32 { 2 } + + // Missing documentation signals an error here + #[deny(missing_docs)] + pub fn undocumented_end() -> i32 { 3 } +} +``` + +Lint attributes can override the level specified from a previous attribute, as +long as the level does not attempt to change a forbidden lint. Previous +attributes are those from a higher level in the syntax tree, or from a +previous attribute on the same entity as listed in left-to-right source order. + +This example shows how one can use `allow` and `warn` to toggle a particular +check on and off: + +```rust +#[warn(missing_docs)] +pub mod m2{ + #[allow(missing_docs)] + pub mod nested { + // Missing documentation is ignored here + pub fn undocumented_one() -> i32 { 1 } + + // Missing documentation signals a warning here, + // despite the allow above. + #[warn(missing_docs)] + pub fn undocumented_two() -> i32 { 2 } + } + + // Missing documentation signals a warning here + pub fn undocumented_too() -> i32 { 3 } +} +``` + +This example shows how one can use `forbid` to disallow uses of `allow` for +that lint check: + +```rust,compile_fail +#[forbid(missing_docs)] +pub mod m3 { + // Attempting to toggle warning signals an error here + #[allow(missing_docs)] + /// Returns 2. + pub fn undocumented_too() -> i32 { 2 } +} +``` + +> Note: `rustc` allows setting lint levels on the +> [command-line][rustc-lint-cli], and also supports [setting +> caps][rustc-lint-caps] on the lints that are reported. + +### Lint groups + +Lints may be organized into named groups so that the level of related lints +can be adjusted together. Using a named group is equivalent to listing out the +lints within that group. + +```rust,compile_fail +// This allows all lints in the "unused" group. +#[allow(unused)] +// This overrides the "unused_must_use" lint from the "unused" +// group to deny. +#[deny(unused_must_use)] +fn example() { + // This does not generate a warning because the "unused_variables" + // lint is in the "unused" group. + let x = 1; + // This generates an error because the result is unused and + // "unused_must_use" is marked as "deny". + std::fs::remove_file("some_file"); // ERROR: unused `Result` that must be used +} +``` + +There is a special group named "warnings" which includes all lints at the +"warn" level. The "warnings" group ignores attribute order and applies to all +lints that would otherwise warn within the entity. + +```rust,compile_fail +# unsafe fn an_unsafe_fn() {} +// The order of these two attributes does not matter. +#[deny(warnings)] +// The unsafe_code lint is normally "allow" by default. +#[warn(unsafe_code)] +fn example_err() { + // This is an error because the `unsafe_code` warning has + // been lifted to "deny". + unsafe { an_unsafe_fn() } // ERROR: usage of `unsafe` block +} +``` + +### Tool lint attributes + +Tool lints allows using scoped lints, to `allow`, `warn`, `deny` or `forbid` +lints of certain tools. + +Tool lints only get checked when the associated tool is active. If a lint +attribute, such as `allow`, references a nonexistent tool lint, the compiler +will not warn about the nonexistent lint until you use the tool. + +Otherwise, they work just like regular lint attributes: + +```rust +// set the entire `pedantic` clippy lint group to warn +#![warn(clippy::pedantic)] +// silence warnings from the `filter_map` clippy lint +#![allow(clippy::filter_map)] + +fn main() { + // ... +} + +// silence the `cmp_nan` clippy lint just for this function +#[allow(clippy::cmp_nan)] +fn foo() { + // ... +} +``` + +> Note: `rustc` currently recognizes the tool lints for "[clippy]" and "[rustdoc]". + +## The `deprecated` attribute + +The *`deprecated` attribute* marks an item as deprecated. `rustc` will issue +warnings on usage of `#[deprecated]` items. `rustdoc` will show item +deprecation, including the `since` version and `note`, if available. + +The `deprecated` attribute has several forms: + +- `deprecated` — Issues a generic message. +- `deprecated = "message"` — Includes the given string in the deprecation + message. +- [_MetaListNameValueStr_] syntax with two optional fields: + - `since` — Specifies a version number when the item was deprecated. `rustc` + does not currently interpret the string, but external tools like [Clippy] + may check the validity of the value. + - `note` — Specifies a string that should be included in the deprecation + message. This is typically used to provide an explanation about the + deprecation and preferred alternatives. + +The `deprecated` attribute may be applied to any [item], [trait item], [enum +variant], [struct field], [external block item], or [macro definition]. It +cannot be applied to [trait implementation items]. When applied to an item +containing other items, such as a [module] or [implementation], all child +items inherit the deprecation attribute. + + +Here is an example: + +```rust +#[deprecated(since = "5.2", note = "foo was rarely used. Users should instead use bar")] +pub fn foo() {} + +pub fn bar() {} +``` + +The [RFC][1270-deprecation.md] contains motivations and more details. + +[1270-deprecation.md]: https://github.com/rust-lang/rfcs/blob/master/text/1270-deprecation.md + +## The `must_use` attribute + +The *`must_use` attribute* is used to issue a diagnostic warning when a value +is not "used". It can be applied to user-defined composite types +([`struct`s][struct], [`enum`s][enum], and [`union`s][union]), [functions], +and [traits]. + +The `must_use` attribute may include a message by using the +[_MetaNameValueStr_] syntax such as `#[must_use = "example message"]`. The +message will be given alongside the warning. + +When used on user-defined composite types, if the [expression] of an +[expression statement] has that type, then the `unused_must_use` lint is +violated. + +```rust +#[must_use] +struct MustUse { + // some fields +} + +# impl MustUse { +# fn new() -> MustUse { MustUse {} } +# } +# +// Violates the `unused_must_use` lint. +MustUse::new(); +``` + +When used on a function, if the [expression] of an [expression statement] is a +[call expression] to that function, then the `unused_must_use` lint is +violated. + +```rust +#[must_use] +fn five() -> i32 { 5i32 } + +// Violates the unused_must_use lint. +five(); +``` + +When used on a [trait declaration], a [call expression] of an [expression +statement] to a function that returns an [impl trait] or a [dyn trait] of that trait violates +the `unused_must_use` lint. + +```rust +#[must_use] +trait Critical {} +impl Critical for i32 {} + +fn get_critical() -> impl Critical { + 4i32 +} + +// Violates the `unused_must_use` lint. +get_critical(); +``` + +When used on a function in a trait declaration, then the behavior also applies +when the call expression is a function from an implementation of the trait. + +```rust +trait Trait { + #[must_use] + fn use_me(&self) -> i32; +} + +impl Trait for i32 { + fn use_me(&self) -> i32 { 0i32 } +} + +// Violates the `unused_must_use` lint. +5i32.use_me(); +``` + +When used on a function in a trait implementation, the attribute does nothing. + +> Note: Trivial no-op expressions containing the value will not violate the +> lint. Examples include wrapping the value in a type that does not implement +> [`Drop`] and then not using that type and being the final expression of a +> [block expression] that is not used. +> +> ```rust +> #[must_use] +> fn five() -> i32 { 5i32 } +> +> // None of these violate the unused_must_use lint. +> (five(),); +> Some(five()); +> { five() }; +> if true { five() } else { 0i32 }; +> match true { +> _ => five() +> }; +> ``` + +> Note: It is idiomatic to use a [let statement] with a pattern of `_` +> when a must-used value is purposely discarded. +> +> ```rust +> #[must_use] +> fn five() -> i32 { 5i32 } +> +> // Does not violate the unused_must_use lint. +> let _ = five(); +> ``` + +[Clippy]: https://github.com/rust-lang/rust-clippy +[_MetaListNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[_MetaListPaths_]: ../attributes.md#meta-item-attribute-syntax +[_MetaNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[`Drop`]: ../special-types-and-traits.md#drop +[attributes]: ../attributes.md +[block expression]: ../expressions/block-expr.md +[call expression]: ../expressions/call-expr.md +[dyn trait]: ../types/trait-object.md +[enum variant]: ../items/enumerations.md +[enum]: ../items/enumerations.md +[expression statement]: ../statements.md#expression-statements +[expression]: ../expressions.md +[external block item]: ../items/external-blocks.md +[functions]: ../items/functions.md +[impl trait]: ../types/impl-trait.md +[implementation]: ../items/implementations.md +[item]: ../items.md +[let statement]: ../statements.md#let-statements +[macro definition]: ../macros-by-example.md +[module]: ../items/modules.md +[rustc book]: ../../rustc/lints/index.html +[rustc-lint-caps]: ../../rustc/lints/levels.html#capping-lints +[rustc-lint-cli]: ../../rustc/lints/levels.html#via-compiler-flag +[rustdoc]: ../../rustdoc/lints.html +[struct field]: ../items/structs.md +[struct]: ../items/structs.md +[trait declaration]: ../items/traits.md +[trait implementation items]: ../items/implementations.md#trait-implementations +[trait item]: ../items/traits.md +[traits]: ../items/traits.md +[union]: ../items/unions.md diff --git a/src/doc/reference/src/attributes/limits.md b/src/doc/reference/src/attributes/limits.md new file mode 100644 index 000000000..65cb55b43 --- /dev/null +++ b/src/doc/reference/src/attributes/limits.md @@ -0,0 +1,57 @@ +# Limits + +The following [attributes] affect compile-time limits. + +## The `recursion_limit` attribute + +The *`recursion_limit` attribute* may be applied at the [crate] level to set the +maximum depth for potentially infinitely-recursive compile-time operations +like macro expansion or auto-dereference. It uses the [_MetaNameValueStr_] +syntax to specify the recursion depth. + +> Note: The default in `rustc` is 128. + +```rust,compile_fail +#![recursion_limit = "4"] + +macro_rules! a { + () => { a!(1); }; + (1) => { a!(2); }; + (2) => { a!(3); }; + (3) => { a!(4); }; + (4) => { }; +} + +// This fails to expand because it requires a recursion depth greater than 4. +a!{} +``` + +```rust,compile_fail +#![recursion_limit = "1"] + +// This fails because it requires two recursive steps to auto-dereference. +(|_: &u8| {})(&&&1); +``` + +## The `type_length_limit` attribute + +The *`type_length_limit` attribute* limits the maximum number of type +substitutions made when constructing a concrete type during monomorphization. +It is applied at the [crate] level, and uses the [_MetaNameValueStr_] syntax +to set the limit based on the number of type substitutions. + +> Note: The default in `rustc` is 1048576. + +```rust,compile_fail +#![type_length_limit = "4"] + +fn f(x: T) {} + +// This fails to compile because monomorphizing to +// `f::<((((i32,), i32), i32), i32)>` requires more than 4 type elements. +f(((((1,), 2), 3), 4)); +``` + +[_MetaNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[attributes]: ../attributes.md +[crate]: ../crates-and-source-files.md diff --git a/src/doc/reference/src/attributes/testing.md b/src/doc/reference/src/attributes/testing.md new file mode 100644 index 000000000..63df999ad --- /dev/null +++ b/src/doc/reference/src/attributes/testing.md @@ -0,0 +1,90 @@ +# Testing attributes + +The following [attributes] are used for specifying functions for performing +tests. Compiling a crate in "test" mode enables building the test functions +along with a test harness for executing the tests. Enabling the test mode also +enables the [`test` conditional compilation option]. + +## The `test` attribute + +The *`test` attribute* marks a function to be executed as a test. These +functions are only compiled when in test mode. Test functions must be free, +monomorphic functions that take no arguments, and the return type must implement the [`Termination`] trait, for example: + +* `()` +* `Result<(), E> where E: Debug` +* `!` + + + + +> Note: The test mode is enabled by passing the `--test` argument to `rustc` +> or using `cargo test`. + +The test harness calls the returned value's [`report`] method, and classifies the test as passed or failed depending on whether the resulting [`ExitCode`] represents successful termination. +In particular: +* Tests that return `()` pass as long as they terminate and do not panic. +* Tests that return a `Result<(), E>` pass as long as they return `Ok(())`. +* Tests that return `ExitCode::SUCCESS` pass, and tests that return `ExitCode::FAILURE` fail. +* Tests that do not terminate neither pass nor fail. + +```rust +# use std::io; +# fn setup_the_thing() -> io::Result { Ok(1) } +# fn do_the_thing(s: &i32) -> io::Result<()> { Ok(()) } +#[test] +fn test_the_thing() -> io::Result<()> { + let state = setup_the_thing()?; // expected to succeed + do_the_thing(&state)?; // expected to succeed + Ok(()) +} +``` + +## The `ignore` attribute + +A function annotated with the `test` attribute can also be annotated with the +`ignore` attribute. The *`ignore` attribute* tells the test harness to not +execute that function as a test. It will still be compiled when in test mode. + +The `ignore` attribute may optionally be written with the [_MetaNameValueStr_] +syntax to specify a reason why the test is ignored. + +```rust +#[test] +#[ignore = "not yet implemented"] +fn mytest() { + // … +} +``` + +> **Note**: The `rustc` test harness supports the `--include-ignored` flag to +> force ignored tests to be run. + +## The `should_panic` attribute + +A function annotated with the `test` attribute that returns `()` can also be +annotated with the `should_panic` attribute. The *`should_panic` attribute* +makes the test only pass if it actually panics. + +The `should_panic` attribute may optionally take an input string that must +appear within the panic message. If the string is not found in the message, +then the test will fail. The string may be passed using the +[_MetaNameValueStr_] syntax or the [_MetaListNameValueStr_] syntax with an +`expected` field. + +```rust +#[test] +#[should_panic(expected = "values don't match")] +fn mytest() { + assert_eq!(1, 2, "values don't match"); +} +``` + +[_MetaListNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[_MetaNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[`Termination`]: ../../std/process/trait.Termination.html +[`report`]: ../../std/process/trait.Termination.html#tymethod.report +[`test` conditional compilation option]: ../conditional-compilation.md#test +[attributes]: ../attributes.md +[`ExitCode`]: ../../std/process/struct.ExitCode.html diff --git a/src/doc/reference/src/attributes/type_system.md b/src/doc/reference/src/attributes/type_system.md new file mode 100644 index 000000000..729069d26 --- /dev/null +++ b/src/doc/reference/src/attributes/type_system.md @@ -0,0 +1,141 @@ +# Type system attributes + +The following [attributes] are used for changing how a type can be used. + +## The `non_exhaustive` attribute + +The *`non_exhaustive` attribute* indicates that a type or variant may have +more fields or variants added in the future. It can be applied to +[`struct`s][struct], [`enum`s][enum], and `enum` variants. + +The `non_exhaustive` attribute uses the [_MetaWord_] syntax and thus does not +take any inputs. + +Within the defining crate, `non_exhaustive` has no effect. + +```rust +#[non_exhaustive] +pub struct Config { + pub window_width: u16, + pub window_height: u16, +} + +#[non_exhaustive] +pub enum Error { + Message(String), + Other, +} + +pub enum Message { + #[non_exhaustive] Send { from: u32, to: u32, contents: String }, + #[non_exhaustive] Reaction(u32), + #[non_exhaustive] Quit, +} + +// Non-exhaustive structs can be constructed as normal within the defining crate. +let config = Config { window_width: 640, window_height: 480 }; + +// Non-exhaustive structs can be matched on exhaustively within the defining crate. +if let Config { window_width, window_height } = config { + // ... +} + +let error = Error::Other; +let message = Message::Reaction(3); + +// Non-exhaustive enums can be matched on exhaustively within the defining crate. +match error { + Error::Message(ref s) => { }, + Error::Other => { }, +} + +match message { + // Non-exhaustive variants can be matched on exhaustively within the defining crate. + Message::Send { from, to, contents } => { }, + Message::Reaction(id) => { }, + Message::Quit => { }, +} +``` + +Outside of the defining crate, types annotated with `non_exhaustive` have limitations that +preserve backwards compatibility when new fields or variants are added. + +Non-exhaustive types cannot be constructed outside of the defining crate: + +- Non-exhaustive variants ([`struct`][struct] or [`enum` variant][enum]) cannot be constructed + with a [_StructExpression_] \(including with [functional update syntax]). +- [`enum`][enum] instances can be constructed. + + +```rust,ignore +// `Config`, `Error`, and `Message` are types defined in an upstream crate that have been +// annotated as `#[non_exhaustive]`. +use upstream::{Config, Error, Message}; + +// Cannot construct an instance of `Config`, if new fields were added in +// a new version of `upstream` then this would fail to compile, so it is +// disallowed. +let config = Config { window_width: 640, window_height: 480 }; + +// Can construct an instance of `Error`, new variants being introduced would +// not result in this failing to compile. +let error = Error::Message("foo".to_string()); + +// Cannot construct an instance of `Message::Send` or `Message::Reaction`, +// if new fields were added in a new version of `upstream` then this would +// fail to compile, so it is disallowed. +let message = Message::Send { from: 0, to: 1, contents: "foo".to_string(), }; +let message = Message::Reaction(0); + +// Cannot construct an instance of `Message::Quit`, if this were converted to +// a tuple-variant `upstream` then this would fail to compile. +let message = Message::Quit; +``` + +There are limitations when matching on non-exhaustive types outside of the defining crate: + +- When pattern matching on a non-exhaustive variant ([`struct`][struct] or [`enum` variant][enum]), + a [_StructPattern_] must be used which must include a `..`. Tuple variant constructor visibility + is lowered to `min($vis, pub(crate))`. +- When pattern matching on a non-exhaustive [`enum`][enum], matching on a variant does not + contribute towards the exhaustiveness of the arms. + + +```rust, ignore +// `Config`, `Error`, and `Message` are types defined in an upstream crate that have been +// annotated as `#[non_exhaustive]`. +use upstream::{Config, Error, Message}; + +// Cannot match on a non-exhaustive enum without including a wildcard arm. +match error { + Error::Message(ref s) => { }, + Error::Other => { }, + // would compile with: `_ => {},` +} + +// Cannot match on a non-exhaustive struct without a wildcard. +if let Ok(Config { window_width, window_height }) = config { + // would compile with: `..` +} + +match message { + // Cannot match on a non-exhaustive struct enum variant without including a wildcard. + Message::Send { from, to, contents } => { }, + // Cannot match on a non-exhaustive tuple or unit enum variant. + Message::Reaction(type) => { }, + Message::Quit => { }, +} +``` + +Non-exhaustive types are always considered inhabited in downstream crates. + +[_MetaWord_]: ../attributes.md#meta-item-attribute-syntax +[_StructExpression_]: ../expressions/struct-expr.md +[_StructPattern_]: ../patterns.md#struct-patterns +[_TupleStructPattern_]: ../patterns.md#tuple-struct-patterns +[`if let`]: ../expressions/if-expr.md#if-let-expressions +[`match`]: ../expressions/match-expr.md +[attributes]: ../attributes.md +[enum]: ../items/enumerations.md +[functional update syntax]: ../expressions/struct-expr.md#functional-update-syntax +[struct]: ../items/structs.md diff --git a/src/doc/reference/src/behavior-considered-undefined.md b/src/doc/reference/src/behavior-considered-undefined.md new file mode 100644 index 000000000..e810e8c0d --- /dev/null +++ b/src/doc/reference/src/behavior-considered-undefined.md @@ -0,0 +1,104 @@ +## Behavior considered undefined + +Rust code is incorrect if it exhibits any of the behaviors in the following +list. This includes code within `unsafe` blocks and `unsafe` functions. +`unsafe` only means that avoiding undefined behavior is on the programmer; it +does not change anything about the fact that Rust programs must never cause +undefined behavior. + +It is the programmer's responsibility when writing `unsafe` code to ensure that +any safe code interacting with the `unsafe` code cannot trigger these +behaviors. `unsafe` code that satisfies this property for any safe client is +called *sound*; if `unsafe` code can be misused by safe code to exhibit +undefined behavior, it is *unsound*. + +
+ +***Warning:*** The following list is not exhaustive. There is no formal model of +Rust's semantics for what is and is not allowed in unsafe code, so there may be +more behavior considered unsafe. The following list is just what we know for +sure is undefined behavior. Please read the [Rustonomicon] before writing unsafe +code. + +
+ +* Data races. +* Evaluating a [dereference expression] (`*expr`) on a raw pointer that is + [dangling] or unaligned, even in [place expression context] + (e.g. `addr_of!(&*expr)`). +* Breaking the [pointer aliasing rules]. `&mut T` and `&T` follow LLVM’s scoped + [noalias] model, except if the `&T` contains an [`UnsafeCell`]. +* Mutating immutable data. All data inside a [`const`] item is immutable. Moreover, all + data reached through a shared reference or data owned by an immutable binding + is immutable, unless that data is contained within an [`UnsafeCell`]. +* Invoking undefined behavior via compiler intrinsics. +* Executing code compiled with platform features that the current platform + does not support (see [`target_feature`]), *except* if the platform explicitly documents this to be safe. +* Calling a function with the wrong call ABI or unwinding from a function with the wrong unwind ABI. +* Producing an invalid value, even in private fields and locals. "Producing" a + value happens any time a value is assigned to or read from a place, passed to + a function/primitive operation or returned from a function/primitive + operation. + The following values are invalid (at their respective type): + * A value other than `false` (`0`) or `true` (`1`) in a [`bool`]. + * A discriminant in an `enum` not included in the type definition. + * A null `fn` pointer. + * A value in a `char` which is a surrogate or above `char::MAX`. + * A `!` (all values are invalid for this type). + * An integer (`i*`/`u*`), floating point value (`f*`), or raw pointer obtained + from [uninitialized memory][undef], or uninitialized memory in a `str`. + * A reference or `Box` that is [dangling], unaligned, or points to an invalid value. + * Invalid metadata in a wide reference, `Box`, or raw pointer: + * `dyn Trait` metadata is invalid if it is not a pointer to a vtable for + `Trait` that matches the actual dynamic trait the pointer or reference points to. + * Slice metadata is invalid if the length is not a valid `usize` + (i.e., it must not be read from uninitialized memory). + * Invalid values for a type with a custom definition of invalid values. + In the standard library, this affects [`NonNull`] and [`NonZero*`]. + + > **Note**: `rustc` achieves this with the unstable + > `rustc_layout_scalar_valid_range_*` attributes. +* Incorrect use of inline assembly. For more details, refer to the [rules] to + follow when writing code that uses inline assembly. + +**Note:** Uninitialized memory is also implicitly invalid for any type that has +a restricted set of valid values. In other words, the only cases in which +reading uninitialized memory is permitted are inside `union`s and in "padding" +(the gaps between the fields/elements of a type). + +> **Note**: Undefined behavior affects the entire program. For example, calling +> a function in C that exhibits undefined behavior of C means your entire +> program contains undefined behaviour that can also affect the Rust code. And +> vice versa, undefined behavior in Rust can cause adverse affects on code +> executed by any FFI calls to other languages. + +### Dangling pointers +[dangling]: #dangling-pointers + +A reference/pointer is "dangling" if it is null or not all of the bytes it +points to are part of the same live allocation (so in particular they all have to be +part of *some* allocation). The span of bytes it points to is determined by the +pointer value and the size of the pointee type (using `size_of_val`). + +If the size is 0, then the pointer must either point inside of a live allocation +(including pointing just after the last byte of the allocation), or it must be +directly constructed from a non-zero integer literal. + +Note that dynamically sized types (such as slices and strings) point to their +entire range, so it is important that the length metadata is never too large. In +particular, the dynamic size of a Rust value (as determined by `size_of_val`) +must never exceed `isize::MAX`. + +[`bool`]: types/boolean.md +[`const`]: items/constant-items.md +[noalias]: http://llvm.org/docs/LangRef.html#noalias +[pointer aliasing rules]: http://llvm.org/docs/LangRef.html#pointer-aliasing-rules +[undef]: http://llvm.org/docs/LangRef.html#undefined-values +[`target_feature`]: attributes/codegen.md#the-target_feature-attribute +[`UnsafeCell`]: ../std/cell/struct.UnsafeCell.html +[Rustonomicon]: ../nomicon/index.html +[`NonNull`]: ../core/ptr/struct.NonNull.html +[`NonZero*`]: ../core/num/index.html +[dereference expression]: expressions/operator-expr.md#the-dereference-operator +[place expression context]: expressions.md#place-expressions-and-value-expressions +[rules]: inline-assembly.md#rules-for-inline-assembly diff --git a/src/doc/reference/src/behavior-not-considered-unsafe.md b/src/doc/reference/src/behavior-not-considered-unsafe.md new file mode 100644 index 000000000..4128d7f23 --- /dev/null +++ b/src/doc/reference/src/behavior-not-considered-unsafe.md @@ -0,0 +1,56 @@ +## Behavior not considered `unsafe` + +The Rust compiler does not consider the following behaviors _unsafe_, +though a programmer may (should) find them undesirable, unexpected, +or erroneous. + +##### Deadlocks +##### Leaks of memory and other resources +##### Exiting without calling destructors +##### Exposing randomized base addresses through pointer leaks +##### Integer overflow + +If a program contains arithmetic overflow, the programmer has made an +error. In the following discussion, we maintain a distinction between +arithmetic overflow and wrapping arithmetic. The first is erroneous, +while the second is intentional. + +When the programmer has enabled `debug_assert!` assertions (for +example, by enabling a non-optimized build), implementations must +insert dynamic checks that `panic` on overflow. Other kinds of builds +may result in `panics` or silently wrapped values on overflow, at the +implementation's discretion. + +In the case of implicitly-wrapped overflow, implementations must +provide well-defined (even if still considered erroneous) results by +using two's complement overflow conventions. + +The integral types provide inherent methods to allow programmers +explicitly to perform wrapping arithmetic. For example, +`i32::wrapping_add` provides two's complement, wrapping addition. + +The standard library also provides a `Wrapping` newtype which +ensures all standard arithmetic operations for `T` have wrapping +semantics. + +See [RFC 560] for error conditions, rationale, and more details about +integer overflow. + +##### Logic errors + +Safe code may impose extra logical constraints that can be checked +at neither compile-time nor runtime. If a program breaks such +a constraint, the behavior may be unspecified but will not result in +undefined behavior. This could include panics, incorrect results, +aborts, and non-termination. The behavior may also differ between +runs, builds, or kinds of build. + +For example, implementing both `Hash` and `Eq` requires that values +considered equal have equal hashes. Another example are data structures +like `BinaryHeap`, `BTreeMap`, `BTreeSet`, `HashMap` and `HashSet` +which describe constraints on the modification of their keys while +they are in the data structure. Violating such constraints is not +considered unsafe, yet the program is considered erroneous and +its behavior unpredictable. + +[RFC 560]: https://github.com/rust-lang/rfcs/blob/master/text/0560-integer-overflow.md diff --git a/src/doc/reference/src/comments.md b/src/doc/reference/src/comments.md new file mode 100644 index 000000000..46074b45c --- /dev/null +++ b/src/doc/reference/src/comments.md @@ -0,0 +1,125 @@ +# Comments + +> **Lexer**\ +> LINE_COMMENT :\ +>       `//` (~\[`/` `!`] | `//`) ~`\n`\*\ +>    | `//` +> +> BLOCK_COMMENT :\ +>       `/*` (~\[`*` `!`] | `**` | _BlockCommentOrDoc_) +> (_BlockCommentOrDoc_ | ~`*/`)\* `*/`\ +>    | `/**/`\ +>    | `/***/` +> +> INNER_LINE_DOC :\ +>    `//!` ~\[`\n` _IsolatedCR_]\* +> +> INNER_BLOCK_DOC :\ +>    `/*!` ( _BlockCommentOrDoc_ | ~\[`*/` _IsolatedCR_] )\* `*/` +> +> OUTER_LINE_DOC :\ +>    `///` (~`/` ~\[`\n` _IsolatedCR_]\*)? +> +> OUTER_BLOCK_DOC :\ +>    `/**` (~`*` | _BlockCommentOrDoc_ ) +> (_BlockCommentOrDoc_ | ~\[`*/` _IsolatedCR_])\* `*/` +> +> _BlockCommentOrDoc_ :\ +>       BLOCK_COMMENT\ +>    | OUTER_BLOCK_DOC\ +>    | INNER_BLOCK_DOC +> +> _IsolatedCR_ :\ +>    _A `\r` not followed by a `\n`_ + +## Non-doc comments + +Comments follow the general C++ style of line (`//`) and +block (`/* ... */`) comment forms. Nested block comments are supported. + +Non-doc comments are interpreted as a form of whitespace. + +## Doc comments + +Line doc comments beginning with exactly _three_ slashes (`///`), and block +doc comments (`/** ... */`), both inner doc comments, are interpreted as a +special syntax for [`doc` attributes]. That is, they are equivalent to writing +`#[doc="..."]` around the body of the comment, i.e., `/// Foo` turns into +`#[doc="Foo"]` and `/** Bar */` turns into `#[doc="Bar"]`. + +Line comments beginning with `//!` and block comments `/*! ... */` are +doc comments that apply to the parent of the comment, rather than the item +that follows. That is, they are equivalent to writing `#![doc="..."]` around +the body of the comment. `//!` comments are usually used to document +modules that occupy a source file. + +Isolated CRs (`\r`), i.e. not followed by LF (`\n`), are not allowed in doc +comments. + +## Examples + +```rust +//! A doc comment that applies to the implicit anonymous module of this crate + +pub mod outer_module { + + //! - Inner line doc + //!! - Still an inner line doc (but with a bang at the beginning) + + /*! - Inner block doc */ + /*!! - Still an inner block doc (but with a bang at the beginning) */ + + // - Only a comment + /// - Outer line doc (exactly 3 slashes) + //// - Only a comment + + /* - Only a comment */ + /** - Outer block doc (exactly) 2 asterisks */ + /*** - Only a comment */ + + pub mod inner_module {} + + pub mod nested_comments { + /* In Rust /* we can /* nest comments */ */ */ + + // All three types of block comments can contain or be nested inside + // any other type: + + /* /* */ /** */ /*! */ */ + /*! /* */ /** */ /*! */ */ + /** /* */ /** */ /*! */ */ + pub mod dummy_item {} + } + + pub mod degenerate_cases { + // empty inner line doc + //! + + // empty inner block doc + /*!*/ + + // empty line comment + // + + // empty outer line doc + /// + + // empty block comment + /**/ + + pub mod dummy_item {} + + // empty 2-asterisk block isn't a doc block, it is a block comment + /***/ + + } + + /* The next one isn't allowed because outer doc comments + require an item that will receive the doc */ + + /// Where is my item? +# mod boo {} +} +``` + +[`doc` attributes]: ../rustdoc/the-doc-attribute.html diff --git a/src/doc/reference/src/conditional-compilation.md b/src/doc/reference/src/conditional-compilation.md new file mode 100644 index 000000000..6966cec4f --- /dev/null +++ b/src/doc/reference/src/conditional-compilation.md @@ -0,0 +1,356 @@ +# Conditional compilation + +> **Syntax**\ +> _ConfigurationPredicate_ :\ +>       _ConfigurationOption_\ +>    | _ConfigurationAll_\ +>    | _ConfigurationAny_\ +>    | _ConfigurationNot_ +> +> _ConfigurationOption_ :\ +>    [IDENTIFIER] (`=` ([STRING_LITERAL] | [RAW_STRING_LITERAL]))? +> +> _ConfigurationAll_\ +>    `all` `(` _ConfigurationPredicateList_? `)` +> +> _ConfigurationAny_\ +>    `any` `(` _ConfigurationPredicateList_? `)` +> +> _ConfigurationNot_\ +>    `not` `(` _ConfigurationPredicate_ `)` +> +> _ConfigurationPredicateList_\ +>    _ConfigurationPredicate_ (`,` _ConfigurationPredicate_)\* `,`? + +*Conditionally compiled source code* is source code that may or may not be +considered a part of the source code depending on certain conditions. Source code can be conditionally compiled +using the [attributes] [`cfg`] and [`cfg_attr`] and the built-in [`cfg` macro]. +These conditions are based on the target architecture of the compiled crate, +arbitrary values passed to the compiler, and a few other miscellaneous things +further described below in detail. + +Each form of conditional compilation takes a _configuration predicate_ that +evaluates to true or false. The predicate is one of the following: + +* A configuration option. It is true if the option is set and false if it is + unset. +* `all()` with a comma separated list of configuration predicates. It is false + if at least one predicate is false. If there are no predicates, it is true. +* `any()` with a comma separated list of configuration predicates. It is true + if at least one predicate is true. If there are no predicates, it is false. +* `not()` with a configuration predicate. It is true if its predicate is false + and false if its predicate is true. + +_Configuration options_ are names and key-value pairs that are either set or +unset. Names are written as a single identifier such as, for example, `unix`. +Key-value pairs are written as an identifier, `=`, and then a string. For +example, `target_arch = "x86_64"` is a configuration option. + +> **Note**: Whitespace around the `=` is ignored. `foo="bar"` and `foo = "bar"` +> are equivalent configuration options. + +Keys are not unique in the set of key-value configuration options. For example, +both `feature = "std"` and `feature = "serde"` can be set at the same time. + +## Set Configuration Options + +Which configuration options are set is determined statically during the +compilation of the crate. Certain options are _compiler-set_ based on data +about the compilation. Other options are _arbitrarily-set_, set based on input +passed to the compiler outside of the code. It is not possible to set a +configuration option from within the source code of the crate being compiled. + +> **Note**: For `rustc`, arbitrary-set configuration options are set using the +> [`--cfg`] flag. + +> **Note**: Configuration options with the key `feature` are a convention used +> by [Cargo][cargo-feature] for specifying compile-time options and optional +> dependencies. + +
+ +Warning: It is possible for arbitrarily-set configuration options to have the +same value as compiler-set configuration options. For example, it is possible +to do `rustc --cfg "unix" program.rs` while compiling to a Windows target, and +have both `unix` and `windows` configuration options set at the same time. It +is unwise to actually do this. + +
+ +### `target_arch` + +Key-value option set once with the target's CPU architecture. The value is +similar to the first element of the platform's target triple, but not +identical. + +Example values: + +* `"x86"` +* `"x86_64"` +* `"mips"` +* `"powerpc"` +* `"powerpc64"` +* `"arm"` +* `"aarch64"` + +### `target_feature` + +Key-value option set for each platform feature available for the current +compilation target. + +Example values: + +* `"avx"` +* `"avx2"` +* `"crt-static"` +* `"rdrand"` +* `"sse"` +* `"sse2"` +* `"sse4.1"` + +See the [`target_feature` attribute] for more details on the available +features. An additional feature of `crt-static` is available to the +`target_feature` option to indicate that a [static C runtime] is available. + +### `target_os` + +Key-value option set once with the target's operating system. This value is +similar to the second and third element of the platform's target triple. + +Example values: + +* `"windows"` +* `"macos"` +* `"ios"` +* `"linux"` +* `"android"` +* `"freebsd"` +* `"dragonfly"` +* `"openbsd"` +* `"netbsd"` + +### `target_family` + +Key-value option providing a more generic description of a target, such as the family of the +operating systems or architectures that the target generally falls into. Any number of +`target_family` key-value pairs can be set. + +Example values: + +* `"unix"` +* `"windows"` +* `"wasm"` + +### `unix` and `windows` + +`unix` is set if `target_family = "unix"` is set and `windows` is set if +`target_family = "windows"` is set. + +### `target_env` + +Key-value option set with further disambiguating information about the target +platform with information about the ABI or `libc` used. For historical reasons, +this value is only defined as not the empty-string when actually needed for +disambiguation. Thus, for example, on many GNU platforms, this value will be +empty. This value is similar to the fourth element of the platform's target +triple. One difference is that embedded ABIs such as `gnueabihf` will simply +define `target_env` as `"gnu"`. + +Example values: + +* `""` +* `"gnu"` +* `"msvc"` +* `"musl"` +* `"sgx"` + +### `target_endian` + +Key-value option set once with either a value of "little" or "big" depending +on the endianness of the target's CPU. + +### `target_pointer_width` + +Key-value option set once with the target's pointer width in bits. + +Example values: + +* `"16"` +* `"32"` +* `"64"` + +### `target_vendor` + +Key-value option set once with the vendor of the target. + +Example values: + +* `"apple"` +* `"fortanix"` +* `"pc"` +* `"unknown"` + +### `test` + +Enabled when compiling the test harness. Done with `rustc` by using the +[`--test`] flag. See [Testing] for more on testing support. + +### `debug_assertions` + +Enabled by default when compiling without optimizations. +This can be used to enable extra debugging code in development but not in +production. For example, it controls the behavior of the standard library's +[`debug_assert!`] macro. + +### `proc_macro` + +Set when the crate being compiled is being compiled with the `proc_macro` +[crate type]. + +### `panic` + +Key-value option set depending on the panic strategy. Note that more values may be added in the future. + +Example values: + +* `"abort"` +* `"unwind"` + +## Forms of conditional compilation + +### The `cfg` attribute + +> **Syntax**\ +> _CfgAttrAttribute_ :\ +>    `cfg` `(` _ConfigurationPredicate_ `)` + + + +The `cfg` [attribute] conditionally includes the thing it is attached to based +on a configuration predicate. + +It is written as `cfg`, `(`, a configuration predicate, and finally `)`. + +If the predicate is true, the thing is rewritten to not have the `cfg` attribute +on it. If the predicate is false, the thing is removed from the source code. + +Some examples on functions: + +```rust +// The function is only included in the build when compiling for macOS +#[cfg(target_os = "macos")] +fn macos_only() { + // ... +} + +// This function is only included when either foo or bar is defined +#[cfg(any(foo, bar))] +fn needs_foo_or_bar() { + // ... +} + +// This function is only included when compiling for a unixish OS with a 32-bit +// architecture +#[cfg(all(unix, target_pointer_width = "32"))] +fn on_32bit_unix() { + // ... +} + +// This function is only included when foo is not defined +#[cfg(not(foo))] +fn needs_not_foo() { + // ... +} + +// This function is only included when the panic strategy is set to unwind +#[cfg(panic = "unwind")] +fn when_unwinding() { + // ... +} + +``` + +The `cfg` attribute is allowed anywhere attributes are allowed. + +### The `cfg_attr` attribute + +> **Syntax**\ +> _CfgAttrAttribute_ :\ +>    `cfg_attr` `(` _ConfigurationPredicate_ `,` _CfgAttrs_? `)` +> +> _CfgAttrs_ :\ +>    [_Attr_] (`,` [_Attr_])\* `,`? + +The `cfg_attr` [attribute] conditionally includes [attributes] based on a +configuration predicate. + +When the configuration predicate is true, this attribute expands out to the +attributes listed after the predicate. For example, the following module will +either be found at `linux.rs` or `windows.rs` based on the target. + + +```rust,ignore +#[cfg_attr(target_os = "linux", path = "linux.rs")] +#[cfg_attr(windows, path = "windows.rs")] +mod os; +``` + +Zero, one, or more attributes may be listed. Multiple attributes will each be +expanded into separate attributes. For example: + + +```rust,ignore +#[cfg_attr(feature = "magic", sparkles, crackles)] +fn bewitched() {} + +// When the `magic` feature flag is enabled, the above will expand to: +#[sparkles] +#[crackles] +fn bewitched() {} +``` + +> **Note**: The `cfg_attr` can expand to another `cfg_attr`. For example, +> `#[cfg_attr(target_os = "linux", cfg_attr(feature = "multithreaded", some_other_attribute))]` +> is valid. This example would be equivalent to +> `#[cfg_attr(all(target_os = "linux", feature ="multithreaded"), some_other_attribute)]`. + +The `cfg_attr` attribute is allowed anywhere attributes are allowed. + +### The `cfg` macro + +The built-in `cfg` macro takes in a single configuration predicate and evaluates +to the `true` literal when the predicate is true and the `false` literal when +it is false. + +For example: + +```rust +let machine_kind = if cfg!(unix) { + "unix" +} else if cfg!(windows) { + "windows" +} else { + "unknown" +}; + +println!("I'm running on a {} machine!", machine_kind); +``` + +[IDENTIFIER]: identifiers.md +[RAW_STRING_LITERAL]: tokens.md#raw-string-literals +[STRING_LITERAL]: tokens.md#string-literals +[Testing]: attributes/testing.md +[_Attr_]: attributes.md +[`--cfg`]: ../rustc/command-line-arguments.html#--cfg-configure-the-compilation-environment +[`--test`]: ../rustc/command-line-arguments.html#--test-build-a-test-harness +[`cfg`]: #the-cfg-attribute +[`cfg` macro]: #the-cfg-macro +[`cfg_attr`]: #the-cfg_attr-attribute +[`debug_assert!`]: ../std/macro.debug_assert.html +[`target_feature` attribute]: attributes/codegen.md#the-target_feature-attribute +[attribute]: attributes.md +[attributes]: attributes.md +[cargo-feature]: ../cargo/reference/features.html +[crate type]: linkage.md +[static C runtime]: linkage.md#static-and-dynamic-c-runtimes diff --git a/src/doc/reference/src/const_eval.md b/src/doc/reference/src/const_eval.md new file mode 100644 index 000000000..c0560376c --- /dev/null +++ b/src/doc/reference/src/const_eval.md @@ -0,0 +1,141 @@ +# Constant evaluation + +Constant evaluation is the process of computing the result of +[expressions] during compilation. Only a subset of all expressions +can be evaluated at compile-time. + +## Constant expressions + +Certain forms of expressions, called constant expressions, can be evaluated at +compile time. In [const contexts](#const-context), these are the only allowed +expressions, and are always evaluated at compile time. In other places, such as +[let statements], constant expressions *may* +be, but are not guaranteed to be, evaluated at compile time. Behaviors such as +out of bounds [array indexing] or [overflow] are compiler errors if the value +must be evaluated at compile time (i.e. in const contexts). Otherwise, these +behaviors are warnings, but will likely panic at run-time. + +The following expressions are constant expressions, so long as any operands are +also constant expressions and do not cause any [`Drop::drop`][destructors] calls +to be run. + +* [Literals]. +* [Const parameters]. +* [Paths] to [functions] and [constants]. + Recursively defining constants is not allowed. +* Paths to [statics]. These are only allowed within the initializer of a static. +* [Tuple expressions]. +* [Array expressions]. +* [Struct] expressions. +* [Block expressions], including `unsafe` blocks. + * [let statements] and thus irrefutable [patterns], including mutable bindings + * [assignment expressions] + * [compound assignment expressions] + * [expression statements] +* [Field] expressions. +* Index expressions, [array indexing] or [slice] with a `usize`. +* [Range expressions]. +* [Closure expressions] which don't capture variables from the environment. +* Built-in [negation], [arithmetic], [logical], [comparison] or [lazy boolean] + operators used on integer and floating point types, `bool`, and `char`. +* Shared [borrow]s, except if applied to a type with [interior mutability]. +* The [dereference operator] except for raw pointers. +* [Grouped] expressions. +* [Cast] expressions, except + * pointer to address casts and + * function pointer to address casts. +* Calls of [const functions] and const methods. +* [loop], [while] and [`while let`] expressions. +* [if], [`if let`] and [match] expressions. + +## Const context + +A _const context_ is one of the following: + +* [Array type length expressions] +* [Array repeat length expressions][array expressions] +* The initializer of + * [constants] + * [statics] + * [enum discriminants] +* A [const generic argument] + +## Const Functions + +A _const fn_ is a function that one is permitted to call from a const context. Declaring a function +`const` has no effect on any existing uses, it only restricts the types that arguments and the +return type may use, as well as prevent various expressions from being used within it. You can freely +do anything with a const function that you can do with a regular function. + +When called from a const context, the function is interpreted by the +compiler at compile time. The interpretation happens in the +environment of the compilation target and not the host. So `usize` is +`32` bits if you are compiling against a `32` bit system, irrelevant +of whether you are building on a `64` bit or a `32` bit system. + +Const functions have various restrictions to make sure that they can be +evaluated at compile-time. It is, for example, not possible to write a random +number generator as a const function. Calling a const function at compile-time +will always yield the same result as calling it at runtime, even when called +multiple times. There's one exception to this rule: if you are doing complex +floating point operations in extreme situations, then you might get (very +slightly) different results. It is advisable to not make array lengths and enum +discriminants depend on floating point computations. + + +Notable features that are allowed in const contexts but not in const functions include: + +* floating point operations + * floating point values are treated just like generic parameters without trait bounds beyond + `Copy`. So you cannot do anything with them but copy/move them around. + +Conversely, the following are possible in a const function, but not in a const context: + +* Use of generic type and lifetime parameters. + * Const contexts do allow limited use of [const generic parameters]. + +[arithmetic]: expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[array expressions]: expressions/array-expr.md +[array indexing]: expressions/array-expr.md#array-and-slice-indexing-expressions +[array indexing]: expressions/array-expr.md#array-and-slice-indexing-expressions +[array type length expressions]: types/array.md +[assignment expressions]: expressions/operator-expr.md#assignment-expressions +[compound assignment expressions]: expressions/operator-expr.md#compound-assignment-expressions +[block expressions]: expressions/block-expr.md +[borrow]: expressions/operator-expr.md#borrow-operators +[cast]: expressions/operator-expr.md#type-cast-expressions +[closure expressions]: expressions/closure-expr.md +[comparison]: expressions/operator-expr.md#comparison-operators +[const functions]: items/functions.md#const-functions +[const generic argument]: items/generics.md#const-generics +[const generic parameters]: items/generics.md#const-generics +[constants]: items/constant-items.md +[Const parameters]: items/generics.md +[dereference operator]: expressions/operator-expr.md#the-dereference-operator +[destructors]: destructors.md +[enum discriminants]: items/enumerations.md#custom-discriminant-values-for-fieldless-enumerations +[expression statements]: statements.md#expression-statements +[expressions]: expressions.md +[field]: expressions/field-expr.md +[functions]: items/functions.md +[grouped]: expressions/grouped-expr.md +[interior mutability]: interior-mutability.md +[if]: expressions/if-expr.md#if-expressions +[`if let`]: expressions/if-expr.md#if-let-expressions +[lazy boolean]: expressions/operator-expr.md#lazy-boolean-operators +[let statements]: statements.md#let-statements +[literals]: expressions/literal-expr.md +[logical]: expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[loop]: expressions/loop-expr.md#infinite-loops +[match]: expressions/match-expr.md +[negation]: expressions/operator-expr.md#negation-operators +[overflow]: expressions/operator-expr.md#overflow +[paths]: expressions/path-expr.md +[patterns]: patterns.md +[range expressions]: expressions/range-expr.md +[slice]: types/slice.md +[statics]: items/static-items.md +[struct]: expressions/struct-expr.md +[tuple expressions]: expressions/tuple-expr.md +[while]: expressions/loop-expr.md#predicate-loops +[`while let`]: expressions/loop-expr.md#predicate-pattern-loops diff --git a/src/doc/reference/src/crates-and-source-files.md b/src/doc/reference/src/crates-and-source-files.md new file mode 100644 index 000000000..6922b0ee3 --- /dev/null +++ b/src/doc/reference/src/crates-and-source-files.md @@ -0,0 +1,191 @@ +# Crates and source files + +> **Syntax**\ +> _Crate_ :\ +>    UTF8BOM?\ +>    SHEBANG?\ +>    [_InnerAttribute_]\*\ +>    [_Item_]\* + +> **Lexer**\ +> UTF8BOM : `\uFEFF`\ +> SHEBANG : `#!` \~`\n`\+[†](#shebang) + + +> Note: Although Rust, like any other language, can be implemented by an +> interpreter as well as a compiler, the only existing implementation is a +> compiler, and the language has always been designed to be compiled. For these +> reasons, this section assumes a compiler. + +Rust's semantics obey a *phase distinction* between compile-time and +run-time.[^phase-distinction] Semantic rules that have a *static +interpretation* govern the success or failure of compilation, while +semantic rules that have a *dynamic interpretation* govern the behavior of the +program at run-time. + +The compilation model centers on artifacts called _crates_. Each compilation +processes a single crate in source form, and if successful, produces a single +crate in binary form: either an executable or some sort of +library.[^cratesourcefile] + +A _crate_ is a unit of compilation and linking, as well as versioning, +distribution, and runtime loading. A crate contains a _tree_ of nested +[module] scopes. The top level of this tree is a module that is +anonymous (from the point of view of paths within the module) and any item +within a crate has a canonical [module path] denoting its location +within the crate's module tree. + +The Rust compiler is always invoked with a single source file as input, and +always produces a single output crate. The processing of that source file may +result in other source files being loaded as modules. Source files have the +extension `.rs`. + +A Rust source file describes a module, the name and location of which — +in the module tree of the current crate — are defined from outside the +source file: either by an explicit [_Module_][module] item in a referencing +source file, or by the name of the crate itself. Every source file is a +module, but not every module needs its own source file: [module +definitions][module] can be nested within one file. + +Each source file contains a sequence of zero or more [_Item_] definitions, and +may optionally begin with any number of [attributes] +that apply to the containing module, most of which influence the behavior of +the compiler. The anonymous crate module can have additional attributes that +apply to the crate as a whole. + +```rust +// Specify the crate name. +#![crate_name = "projx"] + +// Specify the type of output artifact. +#![crate_type = "lib"] + +// Turn on a warning. +// This can be done in any module, not just the anonymous crate module. +#![warn(non_camel_case_types)] +``` + +## Byte order mark + +The optional [_UTF8 byte order mark_] (UTF8BOM production) indicates that the +file is encoded in UTF8. It can only occur at the beginning of the file and +is ignored by the compiler. + +## Shebang + +A source file can have a [_shebang_] (SHEBANG production), which indicates +to the operating system what program to use to execute this file. It serves +essentially to treat the source file as an executable script. The shebang +can only occur at the beginning of the file (but after the optional +_UTF8BOM_). It is ignored by the compiler. For example: + + +```rust,ignore +#!/usr/bin/env rustx + +fn main() { + println!("Hello!"); +} +``` + +A restriction is imposed on the shebang syntax to avoid confusion with an +[attribute]. The `#!` characters must not be followed by a `[` token, ignoring +intervening [comments] or [whitespace]. If this restriction fails, then it is +not treated as a shebang, but instead as the start of an attribute. + +## Preludes and `no_std` + +This section has been moved to the [Preludes chapter](names/preludes.md). + + +## Main Functions + +A crate that contains a `main` [function] can be compiled to an executable. If a +`main` function is present, it must take no arguments, must not declare any +[trait or lifetime bounds], must not have any [where clauses], and its return +type must implement the [`Termination`] trait. + +```rust +fn main() {} +``` +```rust +fn main() -> ! { + std::process::exit(0); +} +``` +```rust +fn main() -> impl std::process::Termination { + std::process::ExitCode::SUCCESS +} +``` + +> **Note**: Types with implementations of [`Termination`] in the standard library include: +> +> * `()` +> * [`!`] +> * [`ExitCode`] +> * `Result<(), E> where E: Debug` +> * `Result where E: Debug` + + + + +### The `no_main` attribute + +The *`no_main` [attribute]* may be applied at the crate level to disable +emitting the `main` symbol for an executable binary. This is useful when some +other object being linked to defines `main`. + +## The `crate_name` attribute + +The *`crate_name` [attribute]* may be applied at the crate level to specify the +name of the crate with the [_MetaNameValueStr_] syntax. + +```rust +#![crate_name = "mycrate"] +``` + +The crate name must not be empty, and must only contain [Unicode alphanumeric] +or `_` (U+005F) characters. + +[^phase-distinction]: This distinction would also exist in an interpreter. + Static checks like syntactic analysis, type checking, and lints should + happen before the program is executed regardless of when it is executed. + +[^cratesourcefile]: A crate is somewhat analogous to an *assembly* in the + ECMA-335 CLI model, a *library* in the SML/NJ Compilation Manager, a *unit* + in the Owens and Flatt module system, or a *configuration* in Mesa. + +[Unicode alphanumeric]: ../std/primitive.char.html#method.is_alphanumeric +[`!`]: types/never.md +[_InnerAttribute_]: attributes.md +[_Item_]: items.md +[_MetaNameValueStr_]: attributes.md#meta-item-attribute-syntax +[_shebang_]: https://en.wikipedia.org/wiki/Shebang_(Unix) +[_utf8 byte order mark_]: https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8 +[`ExitCode`]: ../std/process/struct.ExitCode.html +[`Termination`]: ../std/process/trait.Termination.html +[attribute]: attributes.md +[attributes]: attributes.md +[comments]: comments.md +[function]: items/functions.md +[module]: items/modules.md +[module path]: paths.md +[trait or lifetime bounds]: trait-bounds.md +[where clauses]: items/generics.md#where-clauses +[whitespace]: whitespace.md + + diff --git a/src/doc/reference/src/destructors.md b/src/doc/reference/src/destructors.md new file mode 100644 index 000000000..6d616b3e7 --- /dev/null +++ b/src/doc/reference/src/destructors.md @@ -0,0 +1,402 @@ +# Destructors + +When an [initialized] [variable] or [temporary] goes out of +[scope](#drop-scopes), its *destructor* is run, or it is *dropped*. [Assignment] +also runs the destructor of its left-hand operand, if it's initialized. If a +variable has been partially initialized, only its initialized fields are +dropped. + +The destructor of a type `T` consists of: + +1. If `T: Drop`, calling [`::drop`] +2. Recursively running the destructor of all of its fields. + * The fields of a [struct] are dropped in declaration order. + * The fields of the active [enum variant] are dropped in declaration order. + * The fields of a [tuple] are dropped in order. + * The elements of an [array] or owned [slice] are dropped from the + first element to the last. + * The variables that a [closure] captures by move are dropped in an + unspecified order. + * [Trait objects] run the destructor of the underlying type. + * Other types don't result in any further drops. + +If a destructor must be run manually, such as when implementing your own smart +pointer, [`std::ptr::drop_in_place`] can be used. + +Some examples: + +```rust +struct PrintOnDrop(&'static str); + +impl Drop for PrintOnDrop { + fn drop(&mut self) { + println!("{}", self.0); + } +} + +let mut overwritten = PrintOnDrop("drops when overwritten"); +overwritten = PrintOnDrop("drops when scope ends"); + +let tuple = (PrintOnDrop("Tuple first"), PrintOnDrop("Tuple second")); + +let moved; +// No destructor run on assignment. +moved = PrintOnDrop("Drops when moved"); +// Drops now, but is then uninitialized. +moved; + +// Uninitialized does not drop. +let uninitialized: PrintOnDrop; + +// After a partial move, only the remaining fields are dropped. +let mut partial_move = (PrintOnDrop("first"), PrintOnDrop("forgotten")); +// Perform a partial move, leaving only `partial_move.0` initialized. +core::mem::forget(partial_move.1); +// When partial_move's scope ends, only the first field is dropped. +``` + +## Drop scopes + +Each variable or temporary is associated to a *drop scope*. When control flow +leaves a drop scope all variables associated to that scope are dropped in +reverse order of declaration (for variables) or creation (for temporaries). + +Drop scopes are determined after replacing [`for`], [`if let`], and +[`while let`] expressions with the equivalent expressions using [`match`]. +Overloaded operators are not distinguished from built-in operators and [binding +modes] are not considered. + +Given a function, or closure, there are drop scopes for: + +* The entire function +* Each [statement] +* Each [expression] +* Each block, including the function body + * In the case of a [block expression], the scope for the block and the + expression are the same scope. +* Each arm of a `match` expression + +Drop scopes are nested within one another as follows. When multiple scopes are +left at once, such as when returning from a function, variables are dropped +from the inside outwards. + +* The entire function scope is the outer most scope. +* The function body block is contained within the scope of the entire function. +* The parent of the expression in an expression statement is the scope of the + statement. +* The parent of the initializer of a [`let` statement] is the `let` statement's + scope. +* The parent of a statement scope is the scope of the block that contains the + statement. +* The parent of the expression for a `match` guard is the scope of the arm that + the guard is for. +* The parent of the expression after the `=>` in a `match` expression is the + scope of the arm that it's in. +* The parent of the arm scope is the scope of the `match` expression that it + belongs to. +* The parent of all other scopes is the scope of the immediately enclosing + expression. + +### Scopes of function parameters + +All function parameters are in the scope of the entire function body, so are +dropped last when evaluating the function. Each actual function parameter is +dropped after any bindings introduced in that parameter's pattern. + +```rust +# struct PrintOnDrop(&'static str); +# impl Drop for PrintOnDrop { +# fn drop(&mut self) { +# println!("drop({})", self.0); +# } +# } +// Drops `y`, then the second parameter, then `x`, then the first parameter +fn patterns_in_parameters( + (x, _): (PrintOnDrop, PrintOnDrop), + (_, y): (PrintOnDrop, PrintOnDrop), +) {} + +// drop order is 3 2 0 1 +patterns_in_parameters( + (PrintOnDrop("0"), PrintOnDrop("1")), + (PrintOnDrop("2"), PrintOnDrop("3")), +); +``` + +### Scopes of local variables + +Local variables declared in a `let` statement are associated to the scope of +the block that contains the `let` statement. Local variables declared in a +`match` expression are associated to the arm scope of the `match` arm that they +are declared in. + +```rust +# struct PrintOnDrop(&'static str); +# impl Drop for PrintOnDrop { +# fn drop(&mut self) { +# println!("drop({})", self.0); +# } +# } +let declared_first = PrintOnDrop("Dropped last in outer scope"); +{ + let declared_in_block = PrintOnDrop("Dropped in inner scope"); +} +let declared_last = PrintOnDrop("Dropped first in outer scope"); +``` + +If multiple patterns are used in the same arm for a `match` expression, then an +unspecified pattern will be used to determine the drop order. + +### Temporary scopes + +The *temporary scope* of an expression is the scope that is used for the +temporary variable that holds the result of that expression when used in a +[place context], unless it is [promoted]. + +Apart from lifetime extension, the temporary scope of an expression is the +smallest scope that contains the expression and is one of the following: + +* The entire function body. +* A statement. +* The body of a [`if`], [`while`] or [`loop`] expression. +* The `else` block of an `if` expression. +* The condition expression of an `if` or `while` expression, or a `match` + guard. +* The expression for a match arm. +* The second operand of a [lazy boolean expression]. + +> **Notes**: +> +> Temporaries that are created in the final expression of a function +> body are dropped *after* any named variables bound in the function body, as +> there is no smaller enclosing temporary scope. +> +> The [scrutinee] of a `match` expression is not a temporary scope, so +> temporaries in the scrutinee can be dropped after the `match` expression. For +> example, the temporary for `1` in `match 1 { ref mut z => z };` lives until +> the end of the statement. + +Some examples: + +```rust +# struct PrintOnDrop(&'static str); +# impl Drop for PrintOnDrop { +# fn drop(&mut self) { +# println!("drop({})", self.0); +# } +# } +let local_var = PrintOnDrop("local var"); + +// Dropped once the condition has been evaluated +if PrintOnDrop("If condition").0 == "If condition" { + // Dropped at the end of the block + PrintOnDrop("If body").0 +} else { + unreachable!() +}; + +// Dropped at the end of the statement +(PrintOnDrop("first operand").0 == "" +// Dropped at the ) +|| PrintOnDrop("second operand").0 == "") +// Dropped at the end of the expression +|| PrintOnDrop("third operand").0 == ""; + +// Dropped at the end of the function, after local variables. +// Changing this to a statement containing a return expression would make the +// temporary be dropped before the local variables. Binding to a variable +// which is then returned would also make the temporary be dropped first. +match PrintOnDrop("Matched value in final expression") { + // Dropped once the condition has been evaluated + _ if PrintOnDrop("guard condition").0 == "" => (), + _ => (), +} +``` + +### Operands + +Temporaries are also created to hold the result of operands to an expression +while the other operands are evaluated. The temporaries are associated to the +scope of the expression with that operand. Since the temporaries are moved from +once the expression is evaluated, dropping them has no effect unless one of the +operands to an expression breaks out of the expression, returns, or panics. + +```rust +# struct PrintOnDrop(&'static str); +# impl Drop for PrintOnDrop { +# fn drop(&mut self) { +# println!("drop({})", self.0); +# } +# } +loop { + // Tuple expression doesn't finish evaluating so operands drop in reverse order + ( + PrintOnDrop("Outer tuple first"), + PrintOnDrop("Outer tuple second"), + ( + PrintOnDrop("Inner tuple first"), + PrintOnDrop("Inner tuple second"), + break, + ), + PrintOnDrop("Never created"), + ); +} +``` + +### Constant promotion + +Promotion of a value expression to a `'static` slot occurs when the expression +could be written in a constant and borrowed, and that borrow could be dereferenced +where +the expression was originally written, without changing the runtime behavior. +That is, the promoted expression can be evaluated at compile-time and the +resulting value does not contain [interior mutability] or [destructors] (these +properties are determined based on the value where possible, e.g. `&None` +always has the type `&'static Option<_>`, as it contains nothing disallowed). + +### Temporary lifetime extension + +> **Note**: The exact rules for temporary lifetime extension are subject to +> change. This is describing the current behavior only. + +The temporary scopes for expressions in `let` statements are sometimes +*extended* to the scope of the block containing the `let` statement. This is +done when the usual temporary scope would be too small, based on certain +syntactic rules. For example: + +```rust +let x = &mut 0; +// Usually a temporary would be dropped by now, but the temporary for `0` lives +// to the end of the block. +println!("{}", x); +``` + +If a borrow, dereference, field, or tuple indexing expression has an extended +temporary scope then so does its operand. If an indexing expression has an +extended temporary scope then the indexed expression also has an extended +temporary scope. + +#### Extending based on patterns + +An *extending pattern* is either + +* An [identifier pattern] that binds by reference or mutable reference. +* A [struct][struct pattern], [tuple][tuple pattern], [tuple struct][tuple + struct pattern], or [slice][slice pattern] pattern where at least one of the + direct subpatterns is a extending pattern. + +So `ref x`, `V(ref x)` and `[ref x, y]` are all extending patterns, but `x`, +`&ref x` and `&(ref x,)` are not. + +If the pattern in a `let` statement is an extending pattern then the temporary +scope of the initializer expression is extended. + +#### Extending based on expressions + +For a let statement with an initializer, an *extending expression* is an +expression which is one of the following: + +* The initializer expression. +* The operand of an extending [borrow expression]. +* The operand(s) of an extending [array][array expression], [cast][cast + expression], [braced struct][struct expression], or [tuple][tuple expression] + expression. +* The final expression of any extending [block expression]. + +So the borrow expressions in `&mut 0`, `(&1, &mut 2)`, and `Some { 0: &mut 3 }` +are all extending expressions. The borrows in `&0 + &1` and `Some(&mut 0)` are +not: the latter is syntactically a function call expression. + +The operand of any extending borrow expression has its temporary scope +extended. + +#### Examples + +Here are some examples where expressions have extended temporary scopes: + +```rust +# fn temp() {} +# trait Use { fn use_temp(&self) -> &Self { self } } +# impl Use for () {} +// The temporary that stores the result of `temp()` lives in the same scope +// as x in these cases. +let x = &temp(); +let x = &temp() as &dyn Send; +let x = (&*&temp(),); +let x = { [Some { 0: &temp(), }] }; +let ref x = temp(); +let ref x = *&temp(); +# x; +``` + +Here are some examples where expressions don't have extended temporary scopes: + +```rust,compile_fail +# fn temp() {} +# trait Use { fn use_temp(&self) -> &Self { self } } +# impl Use for () {} +// The temporary that stores the result of `temp()` only lives until the +// end of the let statement in these cases. + +let x = Some(&temp()); // ERROR +let x = (&temp()).use_temp(); // ERROR +# x; +``` + +## Not running destructors + +[`std::mem::forget`] can be used to prevent the destructor of a variable from being run, +and [`std::mem::ManuallyDrop`] provides a wrapper to prevent a +variable or field from being dropped automatically. + +> Note: Preventing a destructor from being run via [`std::mem::forget`] or other means is safe even if it has a type that isn't `'static`. +> Besides the places where destructors are guaranteed to run as defined by this document, types may *not* safely rely on a destructor being run for soundness. + +[Assignment]: expressions/operator-expr.md#assignment-expressions +[binding modes]: patterns.md#binding-modes +[closure]: types/closure.md +[destructors]: destructors.md +[expression]: expressions.md +[identifier pattern]: patterns.md#identifier-patterns +[initialized]: glossary.md#initialized +[interior mutability]: interior-mutability.md +[lazy boolean expression]: expressions/operator-expr.md#lazy-boolean-operators +[place context]: expressions.md#place-expressions-and-value-expressions +[promoted]: destructors.md#constant-promotion +[scrutinee]: glossary.md#scrutinee +[statement]: statements.md +[temporary]: expressions.md#temporaries +[variable]: variables.md + +[array]: types/array.md +[enum variant]: types/enum.md +[slice]: types/slice.md +[struct]: types/struct.md +[Trait objects]: types/trait-object.md +[tuple]: types/tuple.md + +[slice pattern]: patterns.md#slice-patterns +[struct pattern]: patterns.md#struct-patterns +[tuple pattern]: patterns.md#tuple-patterns +[tuple struct pattern]: patterns.md#tuple-struct-patterns + +[array expression]: expressions/array-expr.md#array-expressions +[block expression]: expressions/block-expr.md +[borrow expression]: expressions/operator-expr.md#borrow-operators +[cast expression]: expressions/operator-expr.md#type-cast-expressions +[struct expression]: expressions/struct-expr.md +[tuple expression]: expressions/tuple-expr.md#tuple-expressions + +[`for`]: expressions/loop-expr.md#iterator-loops +[`if let`]: expressions/if-expr.md#if-let-expressions +[`if`]: expressions/if-expr.md#if-expressions +[`let` statement]: statements.md#let-statements +[`loop`]: expressions/loop-expr.md#infinite-loops +[`match`]: expressions/match-expr.md +[`while let`]: expressions/loop-expr.md#predicate-pattern-loops +[`while`]: expressions/loop-expr.md#predicate-loops + +[`::drop`]: ../std/ops/trait.Drop.html#tymethod.drop +[`std::ptr::drop_in_place`]: ../std/ptr/fn.drop_in_place.html +[`std::mem::forget`]: ../std/mem/fn.forget.html +[`std::mem::ManuallyDrop`]: ../std/mem/struct.ManuallyDrop.html diff --git a/src/doc/reference/src/dynamically-sized-types.md b/src/doc/reference/src/dynamically-sized-types.md new file mode 100644 index 000000000..cab1ec510 --- /dev/null +++ b/src/doc/reference/src/dynamically-sized-types.md @@ -0,0 +1,33 @@ +# Dynamically Sized Types + +Most types have a fixed size that is known at compile time and implement the +trait [`Sized`][sized]. A type with a size that is known only at run-time is +called a _dynamically sized type_ (_DST_) or, informally, an unsized type. +[Slices] and [trait objects] are two examples of DSTs. Such types can only be used in certain cases: + +* [Pointer types] to DSTs are + sized but have twice the size of pointers to sized types + * Pointers to slices also store the number of elements of the slice. + * Pointers to trait objects also store a pointer to a vtable. +* DSTs can be provided as + type arguments to generic type parameters having the special `?Sized` bound. + They can also be used for associated type definitions when the corresponding associated type declaration has a `?Sized` bound. + By default, any type parameter or associated type has a `Sized` bound, unless it is relaxed using `?Sized`. +* Traits may be implemented for DSTs. + Unlike with generic type parameters, `Self: ?Sized` is the default in trait definitions. +* Structs may contain a DST as the + last field; this makes the struct itself a + DST. + +> **Note**: [variables], function parameters, [const] items, and [static] items must be +`Sized`. + +[sized]: special-types-and-traits.md#sized +[Slices]: types/slice.md +[trait objects]: types/trait-object.md +[Pointer types]: types/pointer.md +[variables]: variables.md +[const]: items/constant-items.md +[static]: items/static-items.md diff --git a/src/doc/reference/src/expressions.md b/src/doc/reference/src/expressions.md new file mode 100644 index 000000000..32ee658ff --- /dev/null +++ b/src/doc/reference/src/expressions.md @@ -0,0 +1,369 @@ +# Expressions + +> **Syntax**\ +> _Expression_ :\ +>       _ExpressionWithoutBlock_\ +>    | _ExpressionWithBlock_ +> +> _ExpressionWithoutBlock_ :\ +>    [_OuterAttribute_]\*[†](#expression-attributes)\ +>    (\ +>          [_LiteralExpression_]\ +>       | [_PathExpression_]\ +>       | [_OperatorExpression_]\ +>       | [_GroupedExpression_]\ +>       | [_ArrayExpression_]\ +>       | [_AwaitExpression_]\ +>       | [_IndexExpression_]\ +>       | [_TupleExpression_]\ +>       | [_TupleIndexingExpression_]\ +>       | [_StructExpression_]\ +>       | [_CallExpression_]\ +>       | [_MethodCallExpression_]\ +>       | [_FieldExpression_]\ +>       | [_ClosureExpression_]\ +>       | [_ContinueExpression_]\ +>       | [_BreakExpression_]\ +>       | [_RangeExpression_]\ +>       | [_ReturnExpression_]\ +>       | [_UnderscoreExpression_]\ +>       | [_MacroInvocation_]\ +>    ) +> +> _ExpressionWithBlock_ :\ +>    [_OuterAttribute_]\*[†](#expression-attributes)\ +>    (\ +>          [_BlockExpression_]\ +>       | [_AsyncBlockExpression_]\ +>       | [_UnsafeBlockExpression_]\ +>       | [_LoopExpression_]\ +>       | [_IfExpression_]\ +>       | [_IfLetExpression_]\ +>       | [_MatchExpression_]\ +>    ) + +An expression may have two roles: it always produces a *value*, and it may have +*effects* (otherwise known as "side effects"). An expression *evaluates to* a +value, and has effects during *evaluation*. Many expressions contain +sub-expressions, called the *operands* of the expression. The meaning of each +kind of expression dictates several things: + +* Whether or not to evaluate the operands when evaluating the expression +* The order in which to evaluate the operands +* How to combine the operands' values to obtain the value of the expression + +In this way, the structure of expressions dictates the structure of execution. +Blocks are just another kind of expression, so blocks, statements, expressions, +and blocks again can recursively nest inside each other to an arbitrary depth. + +> **Note**: We give names to the operands of expressions so that we may discuss +> them, but these names are not stable and may be changed. + +## Expression precedence + +The precedence of Rust operators and expressions is ordered as follows, going +from strong to weak. Binary Operators at the same precedence level are grouped +in the order given by their associativity. + +| Operator/Expression | Associativity | +|-----------------------------|---------------------| +| Paths | | +| Method calls | | +| Field expressions | left to right | +| Function calls, array indexing | | +| `?` | | +| Unary `-` `*` `!` `&` `&mut` | | +| `as` | left to right | +| `*` `/` `%` | left to right | +| `+` `-` | left to right | +| `<<` `>>` | left to right | +| `&` | left to right | +| `^` | left to right | +| | | left to right | +| `==` `!=` `<` `>` `<=` `>=` | Require parentheses | +| `&&` | left to right | +| || | left to right | +| `..` `..=` | Require parentheses | +| `=` `+=` `-=` `*=` `/=` `%=`
`&=` |= `^=` `<<=` `>>=` | right to left | +| `return` `break` closures | | + +## Evaluation order of operands + +The following list of expressions all evaluate their operands the same way, as +described after the list. Other expressions either don't take operands or +evaluate them conditionally as described on their respective pages. + +* Dereference expression +* Error propagation expression +* Negation expression +* Arithmetic and logical binary operators +* Comparison operators +* Type cast expression +* Grouped expression +* Array expression +* Await expression +* Index expression +* Tuple expression +* Tuple index expression +* Struct expression +* Call expression +* Method call expression +* Field expression +* Break expression +* Range expression +* Return expression + +The operands of these expressions are evaluated prior to applying the effects of +the expression. Expressions taking multiple operands are evaluated left to right +as written in the source code. + +> **Note**: Which subexpressions are the operands of an expression is +> determined by expression precedence as per the previous section. + +For example, the two `next` method calls will always be called in the same +order: + +```rust +# // Using vec instead of array to avoid references +# // since there is no stable owned array iterator +# // at the time this example was written. +let mut one_two = vec![1, 2].into_iter(); +assert_eq!( + (1, 2), + (one_two.next().unwrap(), one_two.next().unwrap()) +); +``` + +> **Note**: Since this is applied recursively, these expressions are also +> evaluated from innermost to outermost, ignoring siblings until there are no +> inner subexpressions. + +## Place Expressions and Value Expressions + +Expressions are divided into two main categories: place expressions and value +expressions; there is also a third, minor category of expressions called +assignee expressions. Within each expression, operands may likewise occur in +either place context or value context. The evaluation of an expression depends +both on its own category and the context it occurs within. + +A *place expression* is an expression that represents a memory location. These +expressions are [paths] which refer to local variables, [static variables], +[dereferences][deref] (`*expr`), [array indexing] expressions (`expr[expr]`), +[field] references (`expr.f`) and parenthesized place expressions. All other +expressions are value expressions. + +A *value expression* is an expression that represents an actual value. + +The following contexts are *place expression* contexts: + +* The left operand of a [compound assignment] expression. +* The operand of a unary [borrow], [address-of][addr-of] or [dereference][deref] operator. +* The operand of a field expression. +* The indexed operand of an array indexing expression. +* The operand of any [implicit borrow]. +* The initializer of a [let statement]. +* The [scrutinee] of an [`if let`], [`match`][match], or [`while let`] + expression. +* The base of a [functional update] struct expression. + +> Note: Historically, place expressions were called *lvalues* and value +> expressions were called *rvalues*. + +An *assignee expression* is an expression that appears in the left operand of an +[assignment][assign] expression. Explicitly, the assignee expressions are: + +- Place expressions. +- [Underscores][_UnderscoreExpression_]. +- [Tuples][_TupleExpression_] of assignee expressions. +- [Slices][_ArrayExpression_] of assingee expressions. +- [Tuple structs][_StructExpression_] of assignee expressions. +- [Structs][_StructExpression_] of assignee expressions (with optionally named + fields). +- [Unit structs][_StructExpression_]. + +Arbitrary parenthesisation is permitted inside assignee expressions. + +### Moved and copied types + +When a place expression is evaluated in a value expression context, or is bound +by value in a pattern, it denotes the value held _in_ that memory location. If +the type of that value implements [`Copy`], then the value will be copied. In +the remaining situations, if that type is [`Sized`], then it may be possible to +move the value. Only the following place expressions may be moved out of: + +* [Variables] which are not currently borrowed. +* [Temporary values](#temporaries). +* [Fields][field] of a place expression which can be moved out of and + don't implement [`Drop`]. +* The result of [dereferencing][deref] an expression with type [`Box`] and + that can also be moved out of. + +After moving out of a place expression that evaluates to a local variable, the +location is deinitialized and cannot be read from again until it is +reinitialized. In all other cases, trying to use a place expression in a value +expression context is an error. + +### Mutability + +For a place expression to be [assigned][assign] to, mutably [borrowed][borrow], +[implicitly mutably borrowed], or bound to a pattern containing `ref mut`, it +must be _mutable_. We call these *mutable place expressions*. In contrast, +other place expressions are called *immutable place expressions*. + +The following expressions can be mutable place expression contexts: + +* Mutable [variables] which are not currently borrowed. +* [Mutable `static` items]. +* [Temporary values]. +* [Fields][field]: this evaluates the subexpression in a mutable place + expression context. +* [Dereferences][deref] of a `*mut T` pointer. +* Dereference of a variable, or field of a variable, with type `&mut T`. Note: + This is an exception to the requirement of the next rule. +* Dereferences of a type that implements `DerefMut`: this then requires that + the value being dereferenced is evaluated in a mutable place expression context. +* [Array indexing] of a type that implements `IndexMut`: this + then evaluates the value being indexed, but not the index, in mutable place + expression context. + +### Temporaries + +When using a value expression in most place expression contexts, a temporary +unnamed memory location is created and initialized to that value. The expression +evaluates to that location instead, except if [promoted] to a `static`. The +[drop scope] of the temporary is usually the end of the enclosing statement. + +### Implicit Borrows + +Certain expressions will treat an expression as a place expression by implicitly +borrowing it. For example, it is possible to compare two unsized [slices][slice] for +equality directly, because the `==` operator implicitly borrows its operands: + +```rust +# let c = [1, 2, 3]; +# let d = vec![1, 2, 3]; +let a: &[i32]; +let b: &[i32]; +# a = &c; +# b = &d; +// ... +*a == *b; +// Equivalent form: +::std::cmp::PartialEq::eq(&*a, &*b); +``` + +Implicit borrows may be taken in the following expressions: + +* Left operand in [method-call] expressions. +* Left operand in [field] expressions. +* Left operand in [call expressions]. +* Left operand in [array indexing] expressions. +* Operand of the [dereference operator][deref] (`*`). +* Operands of [comparison]. +* Left operands of the [compound assignment]. + +## Overloading Traits + +Many of the following operators and expressions can also be overloaded for +other types using traits in `std::ops` or `std::cmp`. These traits also +exist in `core::ops` and `core::cmp` with the same names. + +## Expression Attributes + +[Outer attributes][_OuterAttribute_] before an expression are allowed only in +a few specific cases: + +* Before an expression used as a [statement]. +* Elements of [array expressions], [tuple expressions], [call expressions], + and tuple-style [struct] expressions. + +* The tail expression of [block expressions]. + + +They are never allowed before: +* [Range][_RangeExpression_] expressions. +* Binary operator expressions ([_ArithmeticOrLogicalExpression_], + [_ComparisonExpression_], [_LazyBooleanExpression_], [_TypeCastExpression_], + [_AssignmentExpression_], [_CompoundAssignmentExpression_]). + + +[block expressions]: expressions/block-expr.md +[call expressions]: expressions/call-expr.md +[field]: expressions/field-expr.md +[functional update]: expressions/struct-expr.md#functional-update-syntax +[`if let`]: expressions/if-expr.md#if-let-expressions +[match]: expressions/match-expr.md +[method-call]: expressions/method-call-expr.md +[paths]: expressions/path-expr.md +[struct]: expressions/struct-expr.md +[tuple expressions]: expressions/tuple-expr.md +[`while let`]: expressions/loop-expr.md#predicate-pattern-loops + +[array expressions]: expressions/array-expr.md +[array indexing]: expressions/array-expr.md#array-and-slice-indexing-expressions + +[assign]: expressions/operator-expr.md#assignment-expressions +[borrow]: expressions/operator-expr.md#borrow-operators +[addr-of]: expressions/operator-expr.md#raw-address-of-operators +[comparison]: expressions/operator-expr.md#comparison-operators +[compound assignment]: expressions/operator-expr.md#compound-assignment-expressions +[deref]: expressions/operator-expr.md#the-dereference-operator + +[destructors]: destructors.md +[drop scope]: destructors.md#drop-scopes + +[`Box`]: ../std/boxed/struct.Box.html +[`Copy`]: special-types-and-traits.md#copy +[`Drop`]: special-types-and-traits.md#drop +[`Sized`]: special-types-and-traits.md#sized +[implicit borrow]: #implicit-borrows +[implicitly mutably borrowed]: #implicit-borrows +[interior mutability]: interior-mutability.md +[let statement]: statements.md#let-statements +[Mutable `static` items]: items/static-items.md#mutable-statics +[scrutinee]: glossary.md#scrutinee +[promoted]: destructors.md#constant-promotion +[slice]: types/slice.md +[statement]: statements.md +[static variables]: items/static-items.md +[Temporary values]: #temporaries +[Variables]: variables.md + +[_ArithmeticOrLogicalExpression_]: expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[_ArrayExpression_]: expressions/array-expr.md +[_AsyncBlockExpression_]: expressions/block-expr.md#async-blocks +[_AwaitExpression_]: expressions/await-expr.md +[_AssignmentExpression_]: expressions/operator-expr.md#assignment-expressions +[_BlockExpression_]: expressions/block-expr.md +[_BreakExpression_]: expressions/loop-expr.md#break-expressions +[_CallExpression_]: expressions/call-expr.md +[_ClosureExpression_]: expressions/closure-expr.md +[_ComparisonExpression_]: expressions/operator-expr.md#comparison-operators +[_CompoundAssignmentExpression_]: expressions/operator-expr.md#compound-assignment-expressions +[_ContinueExpression_]: expressions/loop-expr.md#continue-expressions +[_FieldExpression_]: expressions/field-expr.md +[_GroupedExpression_]: expressions/grouped-expr.md +[_IfExpression_]: expressions/if-expr.md#if-expressions +[_IfLetExpression_]: expressions/if-expr.md#if-let-expressions +[_IndexExpression_]: expressions/array-expr.md#array-and-slice-indexing-expressions +[_LazyBooleanExpression_]: expressions/operator-expr.md#lazy-boolean-operators +[_LiteralExpression_]: expressions/literal-expr.md +[_LoopExpression_]: expressions/loop-expr.md +[_MacroInvocation_]: macros.md#macro-invocation +[_MatchExpression_]: expressions/match-expr.md +[_MethodCallExpression_]: expressions/method-call-expr.md +[_OperatorExpression_]: expressions/operator-expr.md +[_OuterAttribute_]: attributes.md +[_PathExpression_]: expressions/path-expr.md +[_RangeExpression_]: expressions/range-expr.md +[_ReturnExpression_]: expressions/return-expr.md +[_StructExpression_]: expressions/struct-expr.md +[_TupleExpression_]: expressions/tuple-expr.md +[_TupleIndexingExpression_]: expressions/tuple-expr.md#tuple-indexing-expressions +[_TypeCastExpression_]: expressions/operator-expr.md#type-cast-expressions +[_UnderscoreExpression_]: expressions/underscore-expr.md +[_UnsafeBlockExpression_]: expressions/block-expr.md#unsafe-blocks diff --git a/src/doc/reference/src/expressions/array-expr.md b/src/doc/reference/src/expressions/array-expr.md new file mode 100644 index 000000000..fd7e2d378 --- /dev/null +++ b/src/doc/reference/src/expressions/array-expr.md @@ -0,0 +1,88 @@ +# Array and array index expressions + +## Array expressions + +> **Syntax**\ +> _ArrayExpression_ :\ +>    `[` _ArrayElements_? `]` +> +> _ArrayElements_ :\ +>       [_Expression_] ( `,` [_Expression_] )\* `,`?\ +>    | [_Expression_] `;` [_Expression_] + +*Array expressions* construct [arrays][array]. +Array expressions come in two forms. + +The first form lists out every value in the array. +The syntax for this form is a comma-separated list of expressions of uniform type enclosed in square brackets. +This produces an array containing each of these values in the order they are written. + +The syntax for the second form is two expressions separated by a semicolon (`;`) enclosed in square brackets. +The expression before the `;` is called the *repeat operand*. +The expression after the `;` is called the *length operand*. +It must have type `usize` and be a [constant expression], such as a [literal] or a [constant item]. +An array expression of this form creates an array with the length of the value of the length operand with each element being a copy of the repeat operand. +That is, `[a; b]` creates an array containing `b` copies of the value of `a`. +If the length operand has a value greater than 1 then this requires that the type of the repeat operand is [`Copy`] or that it must be a [path] to a constant item. + +When the repeat operand is a constant item, it is evaluated the length operand's value times. +If that value is `0`, then the constant item is not evaluated at all. +For expressions that are not a constant item, it is evaluated exactly once, and then the result is copied the length operand's value times. + +```rust +[1, 2, 3, 4]; +["a", "b", "c", "d"]; +[0; 128]; // array with 128 zeros +[0u8, 0u8, 0u8, 0u8,]; +[[1, 0, 0], [0, 1, 0], [0, 0, 1]]; // 2D array +const EMPTY: Vec = Vec::new(); +[EMPTY; 2]; +``` + +## Array and slice indexing expressions + +> **Syntax**\ +> _IndexExpression_ :\ +>    [_Expression_] `[` [_Expression_] `]` + +[Array] and [slice]-typed values can be indexed by writing a square-bracket-enclosed expression of type `usize` (the index) after them. +When the array is mutable, the resulting [memory location] can be assigned to. + +For other types an index expression `a[b]` is equivalent to `*std::ops::Index::index(&a, b)`, or `*std::ops::IndexMut::index_mut(&mut a, b)` in a mutable place expression context. +Just as with methods, Rust will also insert dereference operations on `a` repeatedly to find an implementation. + +Indices are zero-based for arrays and slices. +Array access is a [constant expression], so bounds can be checked at compile-time with a constant index value. +Otherwise a check will be performed at run-time that will put the thread in a _panicked state_ if it fails. + +```rust,should_panic +// lint is deny by default. +#![warn(unconditional_panic)] + +([1, 2, 3, 4])[2]; // Evaluates to 3 + +let b = [[1, 0, 0], [0, 1, 0], [0, 0, 1]]; +b[1][2]; // multidimensional array indexing + +let x = (["a", "b"])[10]; // warning: index out of bounds + +let n = 10; +let y = (["a", "b"])[n]; // panics + +let arr = ["a", "b"]; +arr[10]; // warning: index out of bounds +``` + +The array index expression can be implemented for types other than arrays and slices by implementing the [Index] and [IndexMut] traits. + +[`Copy`]: ../special-types-and-traits.md#copy +[IndexMut]: ../../std/ops/trait.IndexMut.html +[Index]: ../../std/ops/trait.Index.html +[_Expression_]: ../expressions.md +[array]: ../types/array.md +[constant expression]: ../const_eval.md#constant-expressions +[constant item]: ../items/constant-items.md +[literal]: ../tokens.md#literals +[memory location]: ../expressions.md#place-expressions-and-value-expressions +[path]: path-expr.md +[slice]: ../types/slice.md diff --git a/src/doc/reference/src/expressions/await-expr.md b/src/doc/reference/src/expressions/await-expr.md new file mode 100644 index 000000000..feea1a368 --- /dev/null +++ b/src/doc/reference/src/expressions/await-expr.md @@ -0,0 +1,60 @@ +# Await expressions + +> **Syntax**\ +> _AwaitExpression_ :\ +>    [_Expression_] `.` `await` + +An `await` expression is a syntactic construct for suspending a computation +provided by an implementation of `std::future::IntoFuture` until the given +future is ready to produce a value. +The syntax for an await expression is an expression with a type that implements the [`IntoFuture`] trait, called the *future operand*, then the token `.`, and then the `await` keyword. +Await expressions are legal only within an [async context], like an [`async fn`] or an [`async` block]. + +More specifically, an await expression has the following effect. + +1. Create a future by calling [`IntoFuture::into_future`] on the future operand. +2. Evaluate the future to a [future] `tmp`; +3. Pin `tmp` using [`Pin::new_unchecked`]; +4. This pinned future is then polled by calling the [`Future::poll`] method and passing it the current [task context](#task-context); +5. If the call to `poll` returns [`Poll::Pending`], then the future returns `Poll::Pending`, suspending its state so that, when the surrounding async context is re-polled,execution returns to step 3; +6. Otherwise the call to `poll` must have returned [`Poll::Ready`], in which case the value contained in the [`Poll::Ready`] variant is used as the result of the `await` expression itself. + +> **Edition differences**: Await expressions are only available beginning with Rust 2018. + +## Task context + +The task context refers to the [`Context`] which was supplied to the current [async context] when the async context itself was polled. +Because `await` expressions are only legal in an async context, there must be some task context available. + +## Approximate desugaring + +Effectively, an await expression is roughly equivalent to the following non-normative desugaring: + + +```rust,ignore +match operand.into_future() { + mut pinned => loop { + let mut pin = unsafe { Pin::new_unchecked(&mut pinned) }; + match Pin::future::poll(Pin::borrow(&mut pin), &mut current_context) { + Poll::Ready(r) => break r, + Poll::Pending => yield Poll::Pending, + } + } +} +``` + +where the `yield` pseudo-code returns `Poll::Pending` and, when re-invoked, resumes execution from that point. +The variable `current_context` refers to the context taken from the async environment. + +[_Expression_]: ../expressions.md +[`async fn`]: ../items/functions.md#async-functions +[`async` block]: block-expr.md#async-blocks +[`context`]: ../../std/task/struct.Context.html +[`future::poll`]: ../../std/future/trait.Future.html#tymethod.poll +[`pin::new_unchecked`]: ../../std/pin/struct.Pin.html#method.new_unchecked +[`poll::Pending`]: ../../std/task/enum.Poll.html#variant.Pending +[`poll::Ready`]: ../../std/task/enum.Poll.html#variant.Ready +[async context]: ../expressions/block-expr.md#async-context +[future]: ../../std/future/trait.Future.html +[`IntoFuture`]: ../../std/future/trait.IntoFuture.html +[`IntoFuture::into_future`]: ../../std/future/trait.IntoFuture.html#tymethod.into_future diff --git a/src/doc/reference/src/expressions/block-expr.md b/src/doc/reference/src/expressions/block-expr.md new file mode 100644 index 000000000..a68b27e56 --- /dev/null +++ b/src/doc/reference/src/expressions/block-expr.md @@ -0,0 +1,191 @@ +# Block expressions + +> **Syntax**\ +> _BlockExpression_ :\ +>    `{`\ +>       [_InnerAttribute_]\*\ +>       _Statements_?\ +>    `}` +> +> _Statements_ :\ +>       [_Statement_]\+\ +>    | [_Statement_]\+ [_ExpressionWithoutBlock_]\ +>    | [_ExpressionWithoutBlock_] + +A *block expression*, or *block*, is a control flow expression and anonymous namespace scope for items and variable declarations. +As a control flow expression, a block sequentially executes its component non-item declaration statements and then its final optional expression. +As an anonymous namespace scope, item declarations are only in scope inside the block itself and variables declared by `let` statements are in scope from the next statement until the end of the block. + +The syntax for a block is `{`, then any [inner attributes], then any number of [statements], then an optional expression, called the final operand, and finally a `}`. + +Statements are usually required to be followed by a semicolon, with two exceptions: + +1. Item declaration statements do not need to be followed by a semicolon. +2. Expression statements usually require a following semicolon except if its outer expression is a flow control expression. + +Furthermore, extra semicolons between statements are allowed, but these semicolons do not affect semantics. + +When evaluating a block expression, each statement, except for item declaration statements, is executed sequentially. +Then the final operand is executed, if given. + +The type of a block is the type of the final operand, or `()` if the final operand is omitted. + +```rust +# fn fn_call() {} +let _: () = { + fn_call(); +}; + +let five: i32 = { + fn_call(); + 5 +}; + +assert_eq!(5, five); +``` + +> Note: As a control flow expression, if a block expression is the outer expression of an expression statement, the expected type is `()` unless it is followed immediately by a semicolon. + +Blocks are always [value expressions] and evaluate the last operand in value expression context. + +> **Note**: This can be used to force moving a value if really needed. +> For example, the following example fails on the call to `consume_self` because the struct was moved out of `s` in the block expression. +> +> ```rust,compile_fail +> struct Struct; +> +> impl Struct { +> fn consume_self(self) {} +> fn borrow_self(&self) {} +> } +> +> fn move_by_block_expression() { +> let s = Struct; +> +> // Move the value out of `s` in the block expression. +> (&{ s }).borrow_self(); +> +> // Fails to execute because `s` is moved out of. +> s.consume_self(); +> } +> ``` + +## `async` blocks + +> **Syntax**\ +> _AsyncBlockExpression_ :\ +>    `async` `move`? _BlockExpression_ + +An *async block* is a variant of a block expression which evaluates to a future. +The final expression of the block, if present, determines the result value of the future. + +Executing an async block is similar to executing a closure expression: +its immediate effect is to produce and return an anonymous type. +Whereas closures return a type that implements one or more of the [`std::ops::Fn`] traits, however, the type returned for an async block implements the [`std::future::Future`] trait. +The actual data format for this type is unspecified. + +> **Note:** The future type that rustc generates is roughly equivalent to an enum with one variant per `await` point, where each variant stores the data needed to resume from its corresponding point. + +> **Edition differences**: Async blocks are only available beginning with Rust 2018. + +### Capture modes + +Async blocks capture variables from their environment using the same [capture modes] as closures. +Like closures, when written `async { .. }` the capture mode for each variable will be inferred from the content of the block. +`async move { .. }` blocks however will move all referenced variables into the resulting future. + +### Async context + +Because async blocks construct a future, they define an **async context** which can in turn contain [`await` expressions]. +Async contexts are established by async blocks as well as the bodies of async functions, whose semantics are defined in terms of async blocks. + +### Control-flow operators + +Async blocks act like a function boundary, much like closures. +Therefore, the `?` operator and `return` expressions both affect the output of the future, not the enclosing function or other context. +That is, `return ` from within a closure will return the result of `` as the output of the future. +Similarly, if `?` propagates an error, that error is propagated as the result of the future. + +Finally, the `break` and `continue` keywords cannot be used to branch out from an async block. +Therefore the following is illegal: + +```rust,compile_fail +loop { + async move { + break; // This would break out of the loop. + } +} +``` + +## `unsafe` blocks + +> **Syntax**\ +> _UnsafeBlockExpression_ :\ +>    `unsafe` _BlockExpression_ + +_See [`unsafe` block](../unsafe-blocks.md) for more information on when to use `unsafe`_ + +A block of code can be prefixed with the `unsafe` keyword to permit [unsafe operations]. +Examples: + +```rust +unsafe { + let b = [13u8, 17u8]; + let a = &b[0] as *const u8; + assert_eq!(*a, 13); + assert_eq!(*a.offset(1), 17); +} + +# unsafe fn an_unsafe_fn() -> i32 { 10 } +let a = unsafe { an_unsafe_fn() }; +``` + +## Attributes on block expressions + +[Inner attributes] are allowed directly after the opening brace of a block expression in the following situations: + +* [Function] and [method] bodies. +* Loop bodies ([`loop`], [`while`], [`while let`], and [`for`]). +* Block expressions used as a [statement]. +* Block expressions as elements of [array expressions], [tuple expressions], + [call expressions], and tuple-style [struct] expressions. +* A block expression as the tail expression of another block expression. + + +The attributes that have meaning on a block expression are [`cfg`] and [the lint check attributes]. + +For example, this function returns `true` on unix platforms and `false` on other platforms. + +```rust +fn is_unix_platform() -> bool { + #[cfg(unix)] { true } + #[cfg(not(unix))] { false } +} +``` + +[_ExpressionWithoutBlock_]: ../expressions.md +[_InnerAttribute_]: ../attributes.md +[_Statement_]: ../statements.md +[`await` expressions]: await-expr.md +[`cfg`]: ../conditional-compilation.md +[`for`]: loop-expr.md#iterator-loops +[`loop`]: loop-expr.md#infinite-loops +[`std::ops::Fn`]: ../../std/ops/trait.Fn.html +[`std::future::Future`]: ../../std/future/trait.Future.html +[`while let`]: loop-expr.md#predicate-pattern-loops +[`while`]: loop-expr.md#predicate-loops +[array expressions]: array-expr.md +[call expressions]: call-expr.md +[capture modes]: ../types/closure.md#capture-modes +[function]: ../items/functions.md +[inner attributes]: ../attributes.md +[method]: ../items/associated-items.md#methods +[mutable reference]: ../types/pointer.md#mutables-references- +[shared references]: ../types/pointer.md#shared-references- +[statement]: ../statements.md +[statements]: ../statements.md +[struct]: struct-expr.md +[the lint check attributes]: ../attributes/diagnostics.md#lint-check-attributes +[tuple expressions]: tuple-expr.md +[unsafe operations]: ../unsafety.md +[value expressions]: ../expressions.md#place-expressions-and-value-expressions diff --git a/src/doc/reference/src/expressions/call-expr.md b/src/doc/reference/src/expressions/call-expr.md new file mode 100644 index 000000000..577f3f432 --- /dev/null +++ b/src/doc/reference/src/expressions/call-expr.md @@ -0,0 +1,97 @@ +# Call expressions + +> **Syntax**\ +> _CallExpression_ :\ +>    [_Expression_] `(` _CallParams_? `)` +> +> _CallParams_ :\ +>    [_Expression_] ( `,` [_Expression_] )\* `,`? + +A *call expression* calls a function. +The syntax of a call expression is an expression, called the *function operand*, followed by a parenthesized comma-separated list of expression, called the *argument operands*. +If the function eventually returns, then the expression completes. +For [non-function types], the expression `f(...)` uses the method on one of the [`std::ops::Fn`], [`std::ops::FnMut`] or [`std::ops::FnOnce`] traits, which differ in whether they take the type by reference, mutable reference, or take ownership respectively. +An automatic borrow will be taken if needed. +The function operand will also be [automatically dereferenced] as required. + +Some examples of call expressions: + +```rust +# fn add(x: i32, y: i32) -> i32 { 0 } +let three: i32 = add(1i32, 2i32); +let name: &'static str = (|| "Rust")(); +``` + +## Disambiguating Function Calls + +All function calls are sugar for a more explicit [fully-qualified syntax]. +Function calls may need to be fully qualified, depending on the ambiguity of a call in light of in-scope items. + +> **Note**: In the past, the terms "Unambiguous Function Call Syntax", "Universal Function Call Syntax", or "UFCS", have been used in documentation, issues, RFCs, and other community writings. +> However, these terms lack descriptive power and potentially confuse the issue at hand. +> We mention them here for searchability's sake. + +Several situations often occur which result in ambiguities about the receiver or referent of method or associated function calls. +These situations may include: + +* Multiple in-scope traits define methods with the same name for the same types +* Auto-`deref` is undesirable; for example, distinguishing between methods on a smart pointer itself and the pointer's referent +* Methods which take no arguments, like [`default()`], and return properties of a type, like [`size_of()`] + +To resolve the ambiguity, the programmer may refer to their desired method or function using more specific paths, types, or traits. + +For example, + +```rust +trait Pretty { + fn print(&self); +} + +trait Ugly { + fn print(&self); +} + +struct Foo; +impl Pretty for Foo { + fn print(&self) {} +} + +struct Bar; +impl Pretty for Bar { + fn print(&self) {} +} +impl Ugly for Bar { + fn print(&self) {} +} + +fn main() { + let f = Foo; + let b = Bar; + + // we can do this because we only have one item called `print` for `Foo`s + f.print(); + // more explicit, and, in the case of `Foo`, not necessary + Foo::print(&f); + // if you're not into the whole brevity thing + ::print(&f); + + // b.print(); // Error: multiple 'print' found + // Bar::print(&b); // Still an error: multiple `print` found + + // necessary because of in-scope items defining `print` + ::print(&b); +} +``` + +Refer to [RFC 132] for further details and motivations. + +[RFC 132]: https://github.com/rust-lang/rfcs/blob/master/text/0132-ufcs.md +[_Expression_]: ../expressions.md +[`default()`]: ../../std/default/trait.Default.html#tymethod.default +[`size_of()`]: ../../std/mem/fn.size_of.html +[`std::ops::FnMut`]: ../../std/ops/trait.FnMut.html +[`std::ops::FnOnce`]: ../../std/ops/trait.FnOnce.html +[`std::ops::Fn`]: ../../std/ops/trait.Fn.html +[automatically dereferenced]: field-expr.md#automatic-dereferencing +[fully-qualified syntax]: ../paths.md#qualified-paths +[non-function types]: ../types/function-item.md diff --git a/src/doc/reference/src/expressions/closure-expr.md b/src/doc/reference/src/expressions/closure-expr.md new file mode 100644 index 000000000..bdc177bb5 --- /dev/null +++ b/src/doc/reference/src/expressions/closure-expr.md @@ -0,0 +1,73 @@ +# Closure expressions + +> **Syntax**\ +> _ClosureExpression_ :\ +>    `move`?\ +>    ( `||` | `|` _ClosureParameters_? `|` )\ +>    ([_Expression_] | `->` [_TypeNoBounds_] [_BlockExpression_]) +> +> _ClosureParameters_ :\ +>    _ClosureParam_ (`,` _ClosureParam_)\* `,`? +> +> _ClosureParam_ :\ +>    [_OuterAttribute_]\* [_PatternNoTopAlt_] ( `:` [_Type_] )? + +A *closure expression*, also know as a lambda expression or a lambda, defines a [closure type] and evaluates to a value of that type. +The syntax for a closure expression is an optional `move` keyword, then a pipe-symbol-delimited (`|`) comma-separated list of [patterns], called the *closure parameters* each optionally followed by a `:` and a type, then an optional `->` and type, called the *return type*, and then an expression, called the *closure body operand*. +The optional type after each pattern is a type annotation for the pattern. +If there is a return type, the closure body must be a [block]. + +A closure expression denotes a function that maps a list of parameters onto the expression that follows the parameters. +Just like a [`let` binding], the closure parameters are irrefutable [patterns], whose type annotation is optional and will be inferred from context if not given. +Each closure expression has a unique, anonymous type. + +Significantly, closure expressions _capture their environment_, which regular [function definitions] do not. +Without the `move` keyword, the closure expression [infers how it captures each variable from its environment](../types/closure.md#capture-modes), preferring to capture by shared reference, effectively borrowing all outer variables mentioned inside the closure's body. +If needed the compiler will infer that instead mutable references should be taken, or that the values should be moved or copied (depending on their type) from the environment. +A closure can be forced to capture its environment by copying or moving values by prefixing it with the `move` keyword. +This is often used to ensure that the closure's lifetime is `'static`. + +## Closure trait implementations + +Which traits the closure type implement depends on how variables are captured and the types of the captured variables. +See the [call traits and coercions] chapter for how and when a closure implements `Fn`, `FnMut`, and `FnOnce`. +The closure type implements [`Send`] and [`Sync`] if the type of every captured variable also implements the trait. + +## Example + +In this example, we define a function `ten_times` that takes a higher-order function argument, and we then call it with a closure expression as an argument, followed by a closure expression that moves values from its environment. + +```rust +fn ten_times(f: F) where F: Fn(i32) { + for index in 0..10 { + f(index); + } +} + +ten_times(|j| println!("hello, {}", j)); +// With type annotations +ten_times(|j: i32| -> () { println!("hello, {}", j) }); + +let word = "konnichiwa".to_owned(); +ten_times(move |j| println!("{}, {}", word, j)); +``` + +## Attributes on closure parameters + +Attributes on closure parameters follow the same rules and restrictions as [regular function parameters]. + +[_Expression_]: ../expressions.md +[_BlockExpression_]: block-expr.md +[_TypeNoBounds_]: ../types.md#type-expressions +[_PatternNoTopAlt_]: ../patterns.md +[_Type_]: ../types.md#type-expressions +[`let` binding]: ../statements.md#let-statements +[`Send`]: ../special-types-and-traits.md#send +[`Sync`]: ../special-types-and-traits.md#sync +[_OuterAttribute_]: ../attributes.md +[block]: block-expr.md +[call traits and coercions]: ../types/closure.md#call-traits-and-coercions +[closure type]: ../types/closure.md +[function definitions]: ../items/functions.md +[patterns]: ../patterns.md +[regular function parameters]: ../items/functions.md#attributes-on-function-parameters diff --git a/src/doc/reference/src/expressions/field-expr.md b/src/doc/reference/src/expressions/field-expr.md new file mode 100644 index 000000000..93777b3a7 --- /dev/null +++ b/src/doc/reference/src/expressions/field-expr.md @@ -0,0 +1,73 @@ +# Field access expressions + +> **Syntax**\ +> _FieldExpression_ :\ +>    [_Expression_] `.` [IDENTIFIER] + +A *field expression* is a [place expression] that evaluates to the location of a field of a [struct] or [union]. +When the operand is [mutable], the field expression is also mutable. + +The syntax for a field expression is an expression, called the *container operand*, then a `.`, and finally an [identifier]. +Field expressions cannot be followed by a parenthetical comma-separated list of expressions, as that is instead parsed as a [method call expression]. +That is, they cannot be the function operand of a [call expression]. + +> **Note**: Wrap the field expression in a [parenthesized expression] to use it in a call expression. +> +> ```rust +> # struct HoldsCallable { callable: F } +> let holds_callable = HoldsCallable { callable: || () }; +> +> // Invalid: Parsed as calling the method "callable" +> // holds_callable.callable(); +> +> // Valid +> (holds_callable.callable)(); +> ``` + +Examples: + + +```rust,ignore +mystruct.myfield; +foo().x; +(Struct {a: 10, b: 20}).a; +(mystruct.function_field)() // Call expression containing a field expression +``` + +## Automatic dereferencing + +If the type of the container operand implements [`Deref`] or [`DerefMut`][`Deref`] depending on whether the operand is [mutable], it is *automatically dereferenced* as many times as necessary to make the field access possible. +This processes is also called *autoderef* for short. + +## Borrowing + +The fields of a struct or a reference to a struct are treated as separate entities when borrowing. +If the struct does not implement [`Drop`] and is stored in a local variable, this also applies to moving out of each of its fields. +This also does not apply if automatic dereferencing is done though user-defined types other than [`Box`]. + +```rust +struct A { f1: String, f2: String, f3: String } +let mut x: A; +# x = A { +# f1: "f1".to_string(), +# f2: "f2".to_string(), +# f3: "f3".to_string() +# }; +let a: &mut String = &mut x.f1; // x.f1 borrowed mutably +let b: &String = &x.f2; // x.f2 borrowed immutably +let c: &String = &x.f2; // Can borrow again +let d: String = x.f3; // Move out of x.f3 +``` + +[_Expression_]: ../expressions.md +[`Box`]: ../special-types-and-traits.md#boxt +[`Deref`]: ../special-types-and-traits.md#deref-and-derefmut +[`drop`]: ../special-types-and-traits.md#drop +[IDENTIFIER]: ../identifiers.md +[call expression]: call-expr.md +[method call expression]: method-call-expr.md +[mutable]: ../expressions.md#mutability +[parenthesized expression]: grouped-expr.md +[place expression]: ../expressions.md#place-expressions-and-value-expressions +[struct]: ../items/structs.md +[union]: ../items/unions.md diff --git a/src/doc/reference/src/expressions/grouped-expr.md b/src/doc/reference/src/expressions/grouped-expr.md new file mode 100644 index 000000000..0ff7e2c90 --- /dev/null +++ b/src/doc/reference/src/expressions/grouped-expr.md @@ -0,0 +1,43 @@ +# Grouped expressions + +> **Syntax**\ +> _GroupedExpression_ :\ +>    `(` [_Expression_] `)` + +A *parenthesized expression* wraps a single expression, evaluating to that expression. +The syntax for a parenthesized expression is a `(`, then an expression, called the *enclosed operand*, and then a `)`. + +Parenthesized expressions evaluate to the value of the enclosed operand. +Unlike other expressions, parenthesized expressions are both [place expressions and value expressions][place]. +When the enclosed operand is a place expression, it is a place expression and when the enclosed operand is a value expression, it is a value expression. + +Parentheses can be used to explicitly modify the precedence order of subexpressions within an expression. + +An example of a parenthesized expression: + +```rust +let x: i32 = 2 + 3 * 4; +let y: i32 = (2 + 3) * 4; +assert_eq!(x, 14); +assert_eq!(y, 20); +``` + +An example of a necessary use of parentheses is when calling a function pointer that is a member of a struct: + +```rust +# struct A { +# f: fn() -> &'static str +# } +# impl A { +# fn f(&self) -> &'static str { +# "The method f" +# } +# } +# let a = A{f: || "The field f"}; +# +assert_eq!( a.f (), "The method f"); +assert_eq!((a.f)(), "The field f"); +``` + +[_Expression_]: ../expressions.md +[place]: ../expressions.md#place-expressions-and-value-expressions diff --git a/src/doc/reference/src/expressions/if-expr.md b/src/doc/reference/src/expressions/if-expr.md new file mode 100644 index 000000000..591437fc9 --- /dev/null +++ b/src/doc/reference/src/expressions/if-expr.md @@ -0,0 +1,155 @@ +# `if` and `if let` expressions + +## `if` expressions + +> **Syntax**\ +> _IfExpression_ :\ +>    `if` [_Expression_]_except struct expression_ [_BlockExpression_]\ +>    (`else` ( +> [_BlockExpression_] +> | _IfExpression_ +> | _IfLetExpression_ ) )\? + +An `if` expression is a conditional branch in program control. +The syntax of an `if` expression is a condition operand, followed by a consequent block, any number of `else if` conditions and blocks, and an optional trailing `else` block. +The condition operands must have the [boolean type]. +If a condition operand evaluates to `true`, the consequent block is executed and any subsequent `else if` or `else` block is skipped. +If a condition operand evaluates to `false`, the consequent block is skipped and any subsequent `else if` condition is evaluated. +If all `if` and `else if` conditions evaluate to `false` then any `else` block is executed. +An if expression evaluates to the same value as the executed block, or `()` if no block is evaluated. +An `if` expression must have the same type in all situations. + +```rust +# let x = 3; +if x == 4 { + println!("x is four"); +} else if x == 3 { + println!("x is three"); +} else { + println!("x is something else"); +} + +let y = if 12 * 15 > 150 { + "Bigger" +} else { + "Smaller" +}; +assert_eq!(y, "Bigger"); +``` + +## `if let` expressions + +> **Syntax**\ +> _IfLetExpression_ :\ +>    `if` `let` [_Pattern_] `=` [_Scrutinee_]_except lazy boolean operator expression_ +> [_BlockExpression_]\ +>    (`else` ( +> [_BlockExpression_] +> | _IfExpression_ +> | _IfLetExpression_ ) )\? + +An `if let` expression is semantically similar to an `if` expression but in place of a condition operand it expects the keyword `let` followed by a pattern, an `=` and a [scrutinee] operand. +If the value of the scrutinee matches the pattern, the corresponding block will execute. +Otherwise, flow proceeds to the following `else` block if it exists. +Like `if` expressions, `if let` expressions have a value determined by the block that is evaluated. + +```rust +let dish = ("Ham", "Eggs"); + +// this body will be skipped because the pattern is refuted +if let ("Bacon", b) = dish { + println!("Bacon is served with {}", b); +} else { + // This block is evaluated instead. + println!("No bacon will be served"); +} + +// this body will execute +if let ("Ham", b) = dish { + println!("Ham is served with {}", b); +} + +if let _ = 5 { + println!("Irrefutable patterns are always true"); +} +``` + +`if` and `if let` expressions can be intermixed: + +```rust +let x = Some(3); +let a = if let Some(1) = x { + 1 +} else if x == Some(2) { + 2 +} else if let Some(y) = x { + y +} else { + -1 +}; +assert_eq!(a, 3); +``` + +An `if let` expression is equivalent to a [`match` expression] as follows: + + +```rust,ignore +if let PATS = EXPR { + /* body */ +} else { + /*else */ +} +``` + +is equivalent to + + +```rust,ignore +match EXPR { + PATS => { /* body */ }, + _ => { /* else */ }, // () if there is no else +} +``` + +Multiple patterns may be specified with the `|` operator. This has the same semantics as with `|` in `match` expressions: + +```rust +enum E { + X(u8), + Y(u8), + Z(u8), +} +let v = E::Y(12); +if let E::X(n) | E::Y(n) = v { + assert_eq!(n, 12); +} +``` + +The expression cannot be a [lazy boolean operator expression][_LazyBooleanOperatorExpression_]. +Use of a lazy boolean operator is ambiguous with a planned feature change of the language (the implementation of if-let chains - see [eRFC 2947][_eRFCIfLetChain_]). +When lazy boolean operator expression is desired, this can be achieved by using parenthesis as below: + + +```rust,ignore +// Before... +if let PAT = EXPR && EXPR { .. } + +// After... +if let PAT = ( EXPR && EXPR ) { .. } + +// Before... +if let PAT = EXPR || EXPR { .. } + +// After... +if let PAT = ( EXPR || EXPR ) { .. } +``` + +[_BlockExpression_]: block-expr.md +[_Expression_]: ../expressions.md +[_LazyBooleanOperatorExpression_]: operator-expr.md#lazy-boolean-operators +[_Pattern_]: ../patterns.md +[_Scrutinee_]: match-expr.md +[_eRFCIfLetChain_]: https://github.com/rust-lang/rfcs/blob/master/text/2497-if-let-chains.md#rollout-plan-and-transitioning-to-rust-2018 +[`match` expression]: match-expr.md +[boolean type]: ../types/boolean.md +[scrutinee]: ../glossary.md#scrutinee diff --git a/src/doc/reference/src/expressions/literal-expr.md b/src/doc/reference/src/expressions/literal-expr.md new file mode 100644 index 000000000..4eec37dcb --- /dev/null +++ b/src/doc/reference/src/expressions/literal-expr.md @@ -0,0 +1,182 @@ +# Literal expressions + +> **Syntax**\ +> _LiteralExpression_ :\ +>       [CHAR_LITERAL]\ +>    | [STRING_LITERAL]\ +>    | [RAW_STRING_LITERAL]\ +>    | [BYTE_LITERAL]\ +>    | [BYTE_STRING_LITERAL]\ +>    | [RAW_BYTE_STRING_LITERAL]\ +>    | [INTEGER_LITERAL][^out-of-range]\ +>    | [FLOAT_LITERAL]\ +>    | `true` | `false` +> +> [^out-of-range]: A value ≥ 2128 is not allowed. + +A _literal expression_ is an expression consisting of a single token, rather than a sequence of tokens, that immediately and directly denotes the value it evaluates to, rather than referring to it by name or some other evaluation rule. + +A literal is a form of [constant expression], so is evaluated (primarily) at compile time. + +Each of the lexical [literal][literal tokens] forms described earlier can make up a literal expression, as can the keywords `true` and `false`. + +```rust +"hello"; // string type +'5'; // character type +5; // integer type +``` + +## Character literal expressions + +A character literal expression consists of a single [CHAR_LITERAL] token. + +> **Note**: This section is incomplete. + +## String literal expressions + +A string literal expression consists of a single [STRING_LITERAL] or [RAW_STRING_LITERAL] token. + +> **Note**: This section is incomplete. + +## Byte literal expressions + +A byte literal expression consists of a single [BYTE_LITERAL] token. + +> **Note**: This section is incomplete. + +## Byte string literal expressions + +A string literal expression consists of a single [BYTE_STRING_LITERAL] or [RAW_BYTE_STRING_LITERAL] token. + +> **Note**: This section is incomplete. + +## Integer literal expressions + +An integer literal expression consists of a single [INTEGER_LITERAL] token. + +If the token has a [suffix], the suffix will be the name of one of the [primitive integer types][numeric types]: `u8`, `i8`, `u16`, `i16`, `u32`, `i32`, `u64`, `i64`, `u128`, `i128`, `usize`, or `isize`, and the expression has that type. + +If the token has no suffix, the expression's type is determined by type inference: + +* If an integer type can be _uniquely_ determined from the surrounding program context, the expression has that type. + +* If the program context under-constrains the type, it defaults to the signed 32-bit integer `i32`. + +* If the program context over-constrains the type, it is considered a static type error. + +Examples of integer literal expressions: + +```rust +123; // type i32 +123i32; // type i32 +123u32; // type u32 +123_u32; // type u32 +let a: u64 = 123; // type u64 + +0xff; // type i32 +0xff_u8; // type u8 + +0o70; // type i32 +0o70_i16; // type i16 + +0b1111_1111_1001_0000; // type i32 +0b1111_1111_1001_0000i64; // type i64 + +0usize; // type usize +``` + +The value of the expression is determined from the string representation of the token as follows: + +* An integer radix is chosen by inspecting the first two characters of the string, as follows: + + * `0b` indicates radix 2 + * `0o` indicates radix 8 + * `0x` indicates radix 16 + * otherwise the radix is 10. + +* If the radix is not 10, the first two characters are removed from the string. + +* Any underscores are removed from the string. + +* The string is converted to a `u128` value as if by [`u128::from_str_radix`] with the chosen radix. +If the value does not fit in `u128`, the expression is rejected by the parser. + +* The `u128` value is converted to the expression's type via a [numeric cast]. + +> **Note**: The final cast will truncate the value of the literal if it does not fit in the expression's type. +> `rustc` includes a [lint check] named `overflowing_literals`, defaulting to `deny`, which rejects expressions where this occurs. + +> **Note**: `-1i8`, for example, is an application of the [negation operator] to the literal expression `1i8`, not a single integer literal expression. +> See [Overflow] for notes on representing the most negative value for a signed type. + +## Floating-point literal expressions + +A floating-point literal expression consists of a single [FLOAT_LITERAL] token. + +If the token has a [suffix], the suffix will be the name of one of the [primitive floating-point types][floating-point types]: `f32` or `f64`, and the expression has that type. + +If the token has no suffix, the expression's type is determined by type inference: + +* If a floating-point type can be _uniquely_ determined from the surrounding program context, the expression has that type. + +* If the program context under-constrains the type, it defaults to `f64`. + +* If the program context over-constrains the type, it is considered a static type error. + +Examples of floating-point literal expressions: + +```rust +123.0f64; // type f64 +0.1f64; // type f64 +0.1f32; // type f32 +12E+99_f64; // type f64 +5f32; // type f32 +let x: f64 = 2.; // type f64 +``` + +The value of the expression is determined from the string representation of the token as follows: + +* Any underscores are removed from the string. + +* The string is converted to the expression's type as if by [`f32::from_str`] or [`f64::from_str`]. + +> **Note**: `-1.0`, for example, is an application of the [negation operator] to the literal expression `1.0`, not a single floating-point literal expression. + +> **Note**: `inf` and `NaN` are not literal tokens. +> The [`f32::INFINITY`], [`f64::INFINITY`], [`f32::NAN`], and [`f64::NAN`] constants can be used instead of literal expressions. +> In `rustc`, a literal large enough to be evaluated as infinite will trigger the `overflowing_literals` lint check. + +## Boolean literal expressions + +A boolean literal expression consists of one of the keywords `true` or `false`. + +The expression's type is the primitive [boolean type], and its value is: + * true if the keyword is `true` + * false if the keyword is `false` + + +[boolean type]: ../types/boolean.md +[constant expression]: ../const_eval.md#constant-expressions +[floating-point types]: ../types/numeric.md#floating-point-types +[lint check]: ../attributes/diagnostics.md#lint-check-attributes +[literal tokens]: ../tokens.md#literals +[numeric cast]: operator-expr.md#numeric-cast +[numeric types]: ../types/numeric.md +[suffix]: ../tokens.md#suffixes +[negation operator]: operator-expr.md#negation-operators +[overflow]: operator-expr.md#overflow +[`f32::from_str`]: ../../core/primitive.f32.md#method.from_str +[`f32::INFINITY`]: ../../core/primitive.f32.md#associatedconstant.INFINITY +[`f32::NAN`]: ../../core/primitive.f32.md#associatedconstant.NAN +[`f64::from_str`]: ../../core/primitive.f64.md#method.from_str +[`f64::INFINITY`]: ../../core/primitive.f64.md#associatedconstant.INFINITY +[`f64::NAN`]: ../../core/primitive.f64.md#associatedconstant.NAN +[`u128::from_str_radix`]: ../../core/primitive.u128.md#method.from_str_radix +[CHAR_LITERAL]: ../tokens.md#character-literals +[STRING_LITERAL]: ../tokens.md#string-literals +[RAW_STRING_LITERAL]: ../tokens.md#raw-string-literals +[BYTE_LITERAL]: ../tokens.md#byte-literals +[BYTE_STRING_LITERAL]: ../tokens.md#byte-string-literals +[RAW_BYTE_STRING_LITERAL]: ../tokens.md#raw-byte-string-literals +[INTEGER_LITERAL]: ../tokens.md#integer-literals +[FLOAT_LITERAL]: ../tokens.md#floating-point-literals diff --git a/src/doc/reference/src/expressions/loop-expr.md b/src/doc/reference/src/expressions/loop-expr.md new file mode 100644 index 000000000..308f3e346 --- /dev/null +++ b/src/doc/reference/src/expressions/loop-expr.md @@ -0,0 +1,274 @@ +# Loops + +> **Syntax**\ +> _LoopExpression_ :\ +>    [_LoopLabel_]? (\ +>          [_InfiniteLoopExpression_]\ +>       | [_PredicateLoopExpression_]\ +>       | [_PredicatePatternLoopExpression_]\ +>       | [_IteratorLoopExpression_]\ +>    ) + +[_LoopLabel_]: #loop-labels +[_InfiniteLoopExpression_]: #infinite-loops +[_PredicateLoopExpression_]: #predicate-loops +[_PredicatePatternLoopExpression_]: #predicate-pattern-loops +[_IteratorLoopExpression_]: #iterator-loops + +Rust supports four loop expressions: + +* A [`loop` expression](#infinite-loops) denotes an infinite loop. +* A [`while` expression](#predicate-loops) loops until a predicate is false. +* A [`while let` expression](#predicate-pattern-loops) tests a pattern. +* A [`for` expression](#iterator-loops) extracts values from an iterator, looping until the iterator is empty. + +All four types of loop support [`break` expressions](#break-expressions), [`continue` expressions](#continue-expressions), and [labels](#loop-labels). +Only `loop` supports [evaluation to non-trivial values](#break-and-loop-values). + +## Infinite loops + +> **Syntax**\ +> _InfiniteLoopExpression_ :\ +>    `loop` [_BlockExpression_] + +A `loop` expression repeats execution of its body continuously: +`loop { println!("I live."); }`. + +A `loop` expression without an associated `break` expression is diverging and has type [`!`](../types/never.md). +A `loop` expression containing associated [`break` expression(s)](#break-expressions) may terminate, and must have type compatible with the value of the `break` expression(s). + +## Predicate loops + +> **Syntax**\ +> _PredicateLoopExpression_ :\ +>    `while` [_Expression_]_except struct expression_ [_BlockExpression_] + +A `while` loop begins by evaluating the [boolean] loop conditional operand. +If the loop conditional operand evaluates to `true`, the loop body block executes, then control returns to the loop conditional operand. +If the loop conditional expression evaluates to `false`, the `while` expression completes. + +An example: + +```rust +let mut i = 0; + +while i < 10 { + println!("hello"); + i = i + 1; +} +``` + +## Predicate pattern loops + +> **Syntax**\ +> [_PredicatePatternLoopExpression_] :\ +>    `while` `let` [_Pattern_] `=` [_Scrutinee_]_except lazy boolean operator expression_ +> [_BlockExpression_] + + +A `while let` loop is semantically similar to a `while` loop but in place of a condition expression it expects the keyword `let` followed by a pattern, an `=`, a [scrutinee] expression and a block expression. +If the value of the scrutinee matches the pattern, the loop body block executes then control returns to the pattern matching statement. +Otherwise, the while expression completes. + +```rust +let mut x = vec![1, 2, 3]; + +while let Some(y) = x.pop() { + println!("y = {}", y); +} + +while let _ = 5 { + println!("Irrefutable patterns are always true"); + break; +} +``` + +A `while let` loop is equivalent to a `loop` expression containing a [`match` expression] as follows. + + +```rust,ignore +'label: while let PATS = EXPR { + /* loop body */ +} +``` + +is equivalent to + + +```rust,ignore +'label: loop { + match EXPR { + PATS => { /* loop body */ }, + _ => break, + } +} +``` + +Multiple patterns may be specified with the `|` operator. +This has the same semantics as with `|` in `match` expressions: + +```rust +let mut vals = vec![2, 3, 1, 2, 2]; +while let Some(v @ 1) | Some(v @ 2) = vals.pop() { + // Prints 2, 2, then 1 + println!("{}", v); +} +``` + +As is the case in [`if let` expressions], the scrutinee cannot be a [lazy boolean operator expression][_LazyBooleanOperatorExpression_]. + +## Iterator loops + +> **Syntax**\ +> _IteratorLoopExpression_ :\ +>    `for` [_Pattern_] `in` [_Expression_]_except struct expression_ +> [_BlockExpression_] + +A `for` expression is a syntactic construct for looping over elements provided by an implementation of `std::iter::IntoIterator`. +If the iterator yields a value, that value is matched against the irrefutable pattern, the body of the loop is executed, and then control returns to the head of the `for` loop. +If the iterator is empty, the `for` expression completes. + +An example of a `for` loop over the contents of an array: + +```rust +let v = &["apples", "cake", "coffee"]; + +for text in v { + println!("I like {}.", text); +} +``` + +An example of a for loop over a series of integers: + +```rust +let mut sum = 0; +for n in 1..11 { + sum += n; +} +assert_eq!(sum, 55); +``` + +A `for` loop is equivalent to a `loop` expression containing a [`match` expression] as follows: + + +```rust,ignore +'label: for PATTERN in iter_expr { + /* loop body */ +} +``` + +is equivalent to + + +```rust,ignore +{ + let result = match IntoIterator::into_iter(iter_expr) { + mut iter => 'label: loop { + let mut next; + match Iterator::next(&mut iter) { + Option::Some(val) => next = val, + Option::None => break, + }; + let PATTERN = next; + let () = { /* loop body */ }; + }, + }; + result +} +``` + +`IntoIterator`, `Iterator`, and `Option` are always the standard library items here, not whatever those names resolve to in the current scope. +The variable names `next`, `iter`, and `val` are for exposition only, they do not actually have names the user can type. + +> **Note**: that the outer `match` is used to ensure that any [temporary values] in `iter_expr` don't get dropped before the loop is finished. +> `next` is declared before being assigned because it results in types being inferred correctly more often. + +## Loop labels + +> **Syntax**\ +> _LoopLabel_ :\ +>    [LIFETIME_OR_LABEL] `:` + +A loop expression may optionally have a _label_. The label is written as a lifetime preceding the loop expression, as in `'foo: loop { break 'foo; }`, `'bar: while false {}`, `'humbug: for _ in 0..0 {}`. +If a label is present, then labeled `break` and `continue` expressions nested within this loop may exit out of this loop or return control to its head. +See [break expressions](#break-expressions) and [continue expressions](#continue-expressions). + +## `break` expressions + +> **Syntax**\ +> _BreakExpression_ :\ +>    `break` [LIFETIME_OR_LABEL]? [_Expression_]? + +When `break` is encountered, execution of the associated loop body is immediately terminated, for example: + +```rust +let mut last = 0; +for x in 1..100 { + if x > 12 { + break; + } + last = x; +} +assert_eq!(last, 12); +``` + +A `break` expression is normally associated with the innermost `loop`, `for` or `while` loop enclosing the `break` expression, +but a [label](#loop-labels) can be used to specify which enclosing loop is affected. +Example: + +```rust +'outer: loop { + while true { + break 'outer; + } +} +``` + +A `break` expression is only permitted in the body of a loop, and has one of the forms `break`, `break 'label` or ([see below](#break-and-loop-values)) `break EXPR` or `break 'label EXPR`. + +## `continue` expressions + +> **Syntax**\ +> _ContinueExpression_ :\ +>    `continue` [LIFETIME_OR_LABEL]? + +When `continue` is encountered, the current iteration of the associated loop body is immediately terminated, returning control to the loop *head*. +In the case of a `while` loop, the head is the conditional expression controlling the loop. +In the case of a `for` loop, the head is the call-expression controlling the loop. + +Like `break`, `continue` is normally associated with the innermost enclosing loop, but `continue 'label` may be used to specify the loop affected. +A `continue` expression is only permitted in the body of a loop. + +## `break` and loop values + +When associated with a `loop`, a break expression may be used to return a value from that loop, via one of the forms `break EXPR` or `break 'label EXPR`, where `EXPR` is an expression whose result is returned from the `loop`. +For example: + +```rust +let (mut a, mut b) = (1, 1); +let result = loop { + if b > 10 { + break b; + } + let c = a + b; + a = b; + b = c; +}; +// first number in Fibonacci sequence over 10: +assert_eq!(result, 13); +``` + +In the case a `loop` has an associated `break`, it is not considered diverging, and the `loop` must have a type compatible with each `break` expression. +`break` without an expression is considered identical to `break` with expression `()`. + +[LIFETIME_OR_LABEL]: ../tokens.md#lifetimes-and-loop-labels +[_BlockExpression_]: block-expr.md +[_Expression_]: ../expressions.md +[_Pattern_]: ../patterns.md +[_Scrutinee_]: match-expr.md +[`match` expression]: match-expr.md +[boolean]: ../types/boolean.md +[scrutinee]: ../glossary.md#scrutinee +[temporary values]: ../expressions.md#temporaries +[_LazyBooleanOperatorExpression_]: operator-expr.md#lazy-boolean-operators +[`if let` expressions]: if-expr.md#if-let-expressions diff --git a/src/doc/reference/src/expressions/match-expr.md b/src/doc/reference/src/expressions/match-expr.md new file mode 100644 index 000000000..edbc63658 --- /dev/null +++ b/src/doc/reference/src/expressions/match-expr.md @@ -0,0 +1,147 @@ +# `match` expressions + +> **Syntax**\ +> _MatchExpression_ :\ +>    `match` _Scrutinee_ `{`\ +>       [_InnerAttribute_]\*\ +>       _MatchArms_?\ +>    `}` +> +>_Scrutinee_ :\ +>    [_Expression_]_except struct expression_ +> +> _MatchArms_ :\ +>    ( _MatchArm_ `=>` +> ( [_ExpressionWithoutBlock_][_Expression_] `,` +> | [_ExpressionWithBlock_][_Expression_] `,`? ) +> )\*\ +>    _MatchArm_ `=>` [_Expression_] `,`? +> +> _MatchArm_ :\ +>    [_OuterAttribute_]\* [_Pattern_] _MatchArmGuard_? +> +> _MatchArmGuard_ :\ +>    `if` [_Expression_] + +A *`match` expression* branches on a pattern. +The exact form of matching that occurs depends on the [pattern]. +A `match` expression has a *[scrutinee] expression*, which is the value to compare to the patterns. +The scrutinee expression and the patterns must have the same type. + +A `match` behaves differently depending on whether or not the scrutinee expression is a [place expression or value expression][place expression]. +If the scrutinee expression is a [value expression], it is first evaluated into a temporary location, and the resulting value is sequentially compared to the patterns in the arms until a match is found. +The first arm with a matching pattern is chosen as the branch target of the `match`, any variables bound by the pattern are assigned to local variables in the arm's block, and control enters the block. + +When the scrutinee expression is a [place expression], the match does not allocate a temporary location; +however, a by-value binding may copy or move from the memory location. +When possible, it is preferable to match on place expressions, as the lifetime of these matches inherits the lifetime of the place expression rather than being restricted to the inside of the match. + +An example of a `match` expression: + +```rust +let x = 1; + +match x { + 1 => println!("one"), + 2 => println!("two"), + 3 => println!("three"), + 4 => println!("four"), + 5 => println!("five"), + _ => println!("something else"), +} +``` + +Variables bound within the pattern are scoped to the match guard and the arm's expression. +The [binding mode] (move, copy, or reference) depends on the pattern. + +Multiple match patterns may be joined with the `|` operator. +Each pattern will be tested in left-to-right sequence until a successful match is found. + +```rust +let x = 9; +let message = match x { + 0 | 1 => "not many", + 2 ..= 9 => "a few", + _ => "lots" +}; + +assert_eq!(message, "a few"); + +// Demonstration of pattern match order. +struct S(i32, i32); + +match S(1, 2) { + S(z @ 1, _) | S(_, z @ 2) => assert_eq!(z, 1), + _ => panic!(), +} +``` + +> Note: The `2..=9` is a [Range Pattern], not a [Range Expression]. +> Thus, only those types of ranges supported by range patterns can be used in match arms. + +Every binding in each `|` separated pattern must appear in all of the patterns in the arm. +Every binding of the same name must have the same type, and have the same binding mode. + +## Match guards + +Match arms can accept _match guards_ to further refine the criteria for matching a case. +Pattern guards appear after the pattern and consist of a `bool`-typed expression following the `if` keyword. + +When the pattern matches successfully, the pattern guard expression is executed. +If the expression evaluates to true, the pattern is successfully matched against. +Otherwise, the next pattern, including other matches with the `|` operator in the same arm, is tested. + +```rust +# let maybe_digit = Some(0); +# fn process_digit(i: i32) { } +# fn process_other(i: i32) { } +let message = match maybe_digit { + Some(x) if x < 10 => process_digit(x), + Some(x) => process_other(x), + None => panic!(), +}; +``` + +> Note: Multiple matches using the `|` operator can cause the pattern guard and the side effects it has to execute multiple times. +> For example: +> +> ```rust +> # use std::cell::Cell; +> let i : Cell = Cell::new(0); +> match 1 { +> 1 | _ if { i.set(i.get() + 1); false } => {} +> _ => {} +> } +> assert_eq!(i.get(), 2); +> ``` + +A pattern guard may refer to the variables bound within the pattern they follow. +Before evaluating the guard, a shared reference is taken to the part of the scrutinee the variable matches on. +While evaluating the guard, this shared reference is then used when accessing the variable. +Only when the guard evaluates to true is the value moved, or copied, from the scrutinee into the variable. +This allows shared borrows to be used inside guards without moving out of the scrutinee in case guard fails to match. +Moreover, by holding a shared reference while evaluating the guard, mutation inside guards is also prevented. + +## Attributes on match arms + +Outer attributes are allowed on match arms. +The only attributes that have meaning on match arms are [`cfg`] and the [lint check attributes]. + +[Inner attributes] are allowed directly after the opening brace of the match expression in the same expression contexts as [attributes on block expressions]. + +[_Expression_]: ../expressions.md +[place expression]: ../expressions.md#place-expressions-and-value-expressions +[value expression]: ../expressions.md#place-expressions-and-value-expressions +[_InnerAttribute_]: ../attributes.md +[_OuterAttribute_]: ../attributes.md +[`cfg`]: ../conditional-compilation.md +[lint check attributes]: ../attributes/diagnostics.md#lint-check-attributes +[Range Expression]: range-expr.md + +[_Pattern_]: ../patterns.md +[pattern]: ../patterns.md +[Inner attributes]: ../attributes.md +[Range Pattern]: ../patterns.md#range-patterns +[attributes on block expressions]: block-expr.md#attributes-on-block-expressions +[binding mode]: ../patterns.md#binding-modes +[scrutinee]: ../glossary.md#scrutinee diff --git a/src/doc/reference/src/expressions/method-call-expr.md b/src/doc/reference/src/expressions/method-call-expr.md new file mode 100644 index 000000000..8a2f68cc3 --- /dev/null +++ b/src/doc/reference/src/expressions/method-call-expr.md @@ -0,0 +1,96 @@ +# Method-call expressions + +> **Syntax**\ +> _MethodCallExpression_ :\ +>    [_Expression_] `.` [_PathExprSegment_] `(`[_CallParams_]? `)` + +A _method call_ consists of an expression (the *receiver*) followed by a single dot, an expression path segment, and a parenthesized expression-list. +Method calls are resolved to associated [methods] on specific traits, either statically dispatching to a method if the exact `self`-type of the left-hand-side is known, or dynamically dispatching if the left-hand-side expression is an indirect [trait object](../types/trait-object.md). + +```rust +let pi: Result = "3.14".parse(); +let log_pi = pi.unwrap_or(1.0).log(2.72); +# assert!(1.14 < log_pi && log_pi < 1.15) +``` + +When looking up a method call, the receiver may be automatically dereferenced or borrowed in order to call a method. +This requires a more complex lookup process than for other functions, since there may be a number of possible methods to call. +The following procedure is used: + +The first step is to build a list of candidate receiver types. +Obtain these by repeatedly [dereferencing][dereference] the receiver expression's type, adding each type encountered to the list, then finally attempting an [unsized coercion] at the end, and adding the result type if that is successful. +Then, for each candidate `T`, add `&T` and `&mut T` to the list immediately after `T`. + +For instance, if the receiver has type `Box<[i32;2]>`, then the candidate types will be `Box<[i32;2]>`, `&Box<[i32;2]>`, `&mut Box<[i32;2]>`, `[i32; 2]` (by dereferencing), `&[i32; 2]`, `&mut [i32; 2]`, `[i32]` (by unsized coercion), `&[i32]`, and finally `&mut [i32]`. + +Then, for each candidate type `T`, search for a [visible] method with a receiver of that type in the following places: + +1. `T`'s inherent methods (methods implemented directly on `T`). +1. Any of the methods provided by a [visible] trait implemented by `T`. + If `T` is a type parameter, methods provided by trait bounds on `T` are looked up first. + Then all remaining methods in scope are looked up. + +> Note: the lookup is done for each type in order, which can occasionally lead to surprising results. +> The below code will print "In trait impl!", because `&self` methods are looked up first, the trait method is found before the struct's `&mut self` method is found. +> +> ```rust +> struct Foo {} +> +> trait Bar { +> fn bar(&self); +> } +> +> impl Foo { +> fn bar(&mut self) { +> println!("In struct impl!") +> } +> } +> +> impl Bar for Foo { +> fn bar(&self) { +> println!("In trait impl!") +> } +> } +> +> fn main() { +> let mut f = Foo{}; +> f.bar(); +> } +> ``` + +If this results in multiple possible candidates, then it is an error, and the receiver must be [converted][disambiguate call] to an appropriate receiver type to make the method call. + +This process does not take into account the mutability or lifetime of the receiver, or whether a method is `unsafe`. +Once a method is looked up, if it can't be called for one (or more) of those reasons, the result is a compiler error. + +If a step is reached where there is more than one possible method, such as where generic methods or traits are considered the same, then it is a compiler error. +These cases require a [disambiguating function call syntax] for method and function invocation. + +> **Edition Differences**: Before the 2021 edition, during the search for visible methods, if the candidate receiver type is an [array type], methods provided by the standard library [`IntoIterator`] trait are ignored. +> +> The edition used for this purpose is determined by the token representing the method name. +> +> This special case may be removed in the future. + + +
+ +***Warning:*** For [trait objects], if there is an inherent method of the same name as a trait method, it will give a compiler error when trying to call the method in a method call expression. +Instead, you can call the method using [disambiguating function call syntax], in which case it calls the trait method, not the inherent method. +There is no way to call the inherent method. +Just don't define inherent methods on trait objects with the same name as a trait method and you'll be fine. + +
+ +[_CallParams_]: call-expr.md +[_Expression_]: ../expressions.md +[_PathExprSegment_]: ../paths.md#paths-in-expressions +[visible]: ../visibility-and-privacy.md +[array type]: ../types/array.md +[trait objects]: ../types/trait-object.md +[disambiguate call]: call-expr.md#disambiguating-function-calls +[disambiguating function call syntax]: call-expr.md#disambiguating-function-calls +[dereference]: operator-expr.md#the-dereference-operator +[methods]: ../items/associated-items.md#methods +[unsized coercion]: ../type-coercions.md#unsized-coercions +[`IntoIterator`]: ../../std/iter/trait.IntoIterator.html diff --git a/src/doc/reference/src/expressions/operator-expr.md b/src/doc/reference/src/expressions/operator-expr.md new file mode 100644 index 000000000..d8658d647 --- /dev/null +++ b/src/doc/reference/src/expressions/operator-expr.md @@ -0,0 +1,670 @@ +# Operator expressions + +> **Syntax**\ +> _OperatorExpression_ :\ +>       [_BorrowExpression_]\ +>    | [_DereferenceExpression_]\ +>    | [_ErrorPropagationExpression_]\ +>    | [_NegationExpression_]\ +>    | [_ArithmeticOrLogicalExpression_]\ +>    | [_ComparisonExpression_]\ +>    | [_LazyBooleanExpression_]\ +>    | [_TypeCastExpression_]\ +>    | [_AssignmentExpression_]\ +>    | [_CompoundAssignmentExpression_] + +Operators are defined for built in types by the Rust language. +Many of the following operators can also be overloaded using traits in `std::ops` or `std::cmp`. + +## Overflow + +Integer operators will panic when they overflow when compiled in debug mode. +The `-C debug-assertions` and `-C overflow-checks` compiler flags can be used to control this more directly. +The following things are considered to be overflow: + +* When `+`, `*` or binary `-` create a value greater than the maximum value, or less than the minimum value that can be stored. +* Applying unary `-` to the most negative value of any signed integer type, unless the operand is a [literal expression] (or a literal expression standing alone inside one or more [grouped expressions][grouped expression]). +* Using `/` or `%`, where the left-hand argument is the smallest integer of a signed integer type and the right-hand argument is `-1`. + These checks occur even when `-C overflow-checks` is disabled, for legacy reasons. +* Using `<<` or `>>` where the right-hand argument is greater than or equal to the number of bits in the type of the left-hand argument, or is negative. + +> **Note**: The exception for literal expressions behind unary `-` means that forms such as `-128_i8` or `let j: i8 = -(128)` never cause a panic and have the expected value of -128. +> +> In these cases, the literal expression already has the most negative value for its type (for example, `128_i8` has the value -128) because integer literals are truncated to their type per the description in [Integer literal expressions][literal expression]. +> +> Negation of these most negative values leaves the value unchanged due to two's complement overflow conventions. +> +> In `rustc`, these most negative expressions are also ignored by the `overflowing_literals` lint check. + +## Borrow operators + +> **Syntax**\ +> _BorrowExpression_ :\ +>       (`&`|`&&`) [_Expression_]\ +>    | (`&`|`&&`) `mut` [_Expression_] + +The `&` (shared borrow) and `&mut` (mutable borrow) operators are unary prefix operators. +When applied to a [place expression], this expressions produces a reference (pointer) to the location that the value refers to. +The memory location is also placed into a borrowed state for the duration of the reference. +For a shared borrow (`&`), this implies that the place may not be mutated, but it may be read or shared again. +For a mutable borrow (`&mut`), the place may not be accessed in any way until the borrow expires. +`&mut` evaluates its operand in a mutable place expression context. +If the `&` or `&mut` operators are applied to a [value expression], then a [temporary value] is created. + +These operators cannot be overloaded. + +```rust +{ + // a temporary with value 7 is created that lasts for this scope. + let shared_reference = &7; +} +let mut array = [-2, 3, 9]; +{ + // Mutably borrows `array` for this scope. + // `array` may only be used through `mutable_reference`. + let mutable_reference = &mut array; +} +``` + +Even though `&&` is a single token ([the lazy 'and' operator](#lazy-boolean-operators)), when used in the context of borrow expressions it works as two borrows: + +```rust +// same meanings: +let a = && 10; +let a = & & 10; + +// same meanings: +let a = &&&& mut 10; +let a = && && mut 10; +let a = & & & & mut 10; +``` + +### Raw address-of operators + +Related to the borrow operators are the *raw address-of operators*, which do not have first-class syntax, but are exposed via the macros [`ptr::addr_of!(expr)`][addr_of] and [`ptr::addr_of_mut!(expr)`][addr_of_mut]. +The expression `expr` is evaluated in place expression context. +`ptr::addr_of!(expr)` then creates a const raw pointer of type `*const T` to the given place, and `ptr::addr_of_mut!(expr)` creates a mutable raw pointer of type `*mut T`. + +The raw address-of operators must be used instead of a borrow operator whenever the place expression could evaluate to a place that is not properly aligned or does not store a valid value as determined by its type, or whenever creating a reference would introduce incorrect aliasing assumptions. +In those situations, using a borrow operator would cause [undefined behavior] by creating an invalid reference, but a raw pointer may still be constructed using an address-of operator. + +The following is an example of creating a raw pointer to an unaligned place through a `packed` struct: + +```rust +use std::ptr; + +#[repr(packed)] +struct Packed { + f1: u8, + f2: u16, +} + +let packed = Packed { f1: 1, f2: 2 }; +// `&packed.f2` would create an unaligned reference, and thus be Undefined Behavior! +let raw_f2 = ptr::addr_of!(packed.f2); +assert_eq!(unsafe { raw_f2.read_unaligned() }, 2); +``` + +The following is an example of creating a raw pointer to a place that does not contain a valid value: + +```rust +use std::{ptr, mem::MaybeUninit}; + +struct Demo { + field: bool, +} + +let mut uninit = MaybeUninit::::uninit(); +// `&uninit.as_mut().field` would create a reference to an uninitialized `bool`, +// and thus be Undefined Behavior! +let f1_ptr = unsafe { ptr::addr_of_mut!((*uninit.as_mut_ptr()).field) }; +unsafe { f1_ptr.write(true); } +let init = unsafe { uninit.assume_init() }; +``` + + +## The dereference operator + +> **Syntax**\ +> _DereferenceExpression_ :\ +>    `*` [_Expression_] + +The `*` (dereference) operator is also a unary prefix operator. +When applied to a [pointer](../types/pointer.md) it denotes the pointed-to location. +If the expression is of type `&mut T` or `*mut T`, and is either a local variable, a (nested) field of a local variable or is a mutable [place expression], then the resulting memory location can be assigned to. +Dereferencing a raw pointer requires `unsafe`. + +On non-pointer types `*x` is equivalent to `*std::ops::Deref::deref(&x)` in an [immutable place expression context](../expressions.md#mutability) and `*std::ops::DerefMut::deref_mut(&mut x)` in a mutable place expression context. + +```rust +let x = &7; +assert_eq!(*x, 7); +let y = &mut 9; +*y = 11; +assert_eq!(*y, 11); +``` + +## The question mark operator + +> **Syntax**\ +> _ErrorPropagationExpression_ :\ +>    [_Expression_] `?` + +The question mark operator (`?`) unwraps valid values or returns erroneous values, propagating them to the calling function. +It is a unary postfix operator that can only be applied to the types `Result` and `Option`. + +When applied to values of the `Result` type, it propagates errors. +If the value is `Err(e)`, then it will return `Err(From::from(e))` from the enclosing function or closure. +If applied to `Ok(x)`, then it will unwrap the value to evaluate to `x`. + +```rust +# use std::num::ParseIntError; +fn try_to_parse() -> Result { + let x: i32 = "123".parse()?; // x = 123 + let y: i32 = "24a".parse()?; // returns an Err() immediately + Ok(x + y) // Doesn't run. +} + +let res = try_to_parse(); +println!("{:?}", res); +# assert!(res.is_err()) +``` + +When applied to values of the `Option` type, it propagates `None`s. +If the value is `None`, then it will return `None`. +If applied to `Some(x)`, then it will unwrap the value to evaluate to `x`. + +```rust +fn try_option_some() -> Option { + let val = Some(1)?; + Some(val) +} +assert_eq!(try_option_some(), Some(1)); + +fn try_option_none() -> Option { + let val = None?; + Some(val) +} +assert_eq!(try_option_none(), None); +``` + +`?` cannot be overloaded. + +## Negation operators + +> **Syntax**\ +> _NegationExpression_ :\ +>       `-` [_Expression_]\ +>    | `!` [_Expression_] + +These are the last two unary operators. +This table summarizes the behavior of them on primitive types and which traits are used to overload these operators for other types. +Remember that signed integers are always represented using two's complement. +The operands of all of these operators are evaluated in [value expression context][value expression] so are moved or copied. + +| Symbol | Integer | `bool` | Floating Point | Overloading Trait | +|--------|-------------|-------------- |----------------|--------------------| +| `-` | Negation* | | Negation | `std::ops::Neg` | +| `!` | Bitwise NOT | [Logical NOT] | | `std::ops::Not` | + +\* Only for signed integer types. + +Here are some example of these operators + +```rust +let x = 6; +assert_eq!(-x, -6); +assert_eq!(!x, -7); +assert_eq!(true, !false); +``` + +## Arithmetic and Logical Binary Operators + +> **Syntax**\ +> _ArithmeticOrLogicalExpression_ :\ +>       [_Expression_] `+` [_Expression_]\ +>    | [_Expression_] `-` [_Expression_]\ +>    | [_Expression_] `*` [_Expression_]\ +>    | [_Expression_] `/` [_Expression_]\ +>    | [_Expression_] `%` [_Expression_]\ +>    | [_Expression_] `&` [_Expression_]\ +>    | [_Expression_] `|` [_Expression_]\ +>    | [_Expression_] `^` [_Expression_]\ +>    | [_Expression_] `<<` [_Expression_]\ +>    | [_Expression_] `>>` [_Expression_] + +Binary operators expressions are all written with infix notation. +This table summarizes the behavior of arithmetic and logical binary operators on primitive types and which traits are used to overload these operators for other types. +Remember that signed integers are always represented using two's complement. +The operands of all of these operators are evaluated in [value expression context][value expression] so are moved or copied. + +| Symbol | Integer | `bool` | Floating Point | Overloading Trait | Overloading Compound Assignment Trait | +|--------|-------------------------|---------------|----------------|--------------------| ------------------------------------- | +| `+` | Addition | | Addition | `std::ops::Add` | `std::ops::AddAssign` | +| `-` | Subtraction | | Subtraction | `std::ops::Sub` | `std::ops::SubAssign` | +| `*` | Multiplication | | Multiplication | `std::ops::Mul` | `std::ops::MulAssign` | +| `/` | Division* | | Division | `std::ops::Div` | `std::ops::DivAssign` | +| `%` | Remainder** | | Remainder | `std::ops::Rem` | `std::ops::RemAssign` | +| `&` | Bitwise AND | [Logical AND] | | `std::ops::BitAnd` | `std::ops::BitAndAssign` | +| | | Bitwise OR | [Logical OR] | | `std::ops::BitOr` | `std::ops::BitOrAssign` | +| `^` | Bitwise XOR | [Logical XOR] | | `std::ops::BitXor` | `std::ops::BitXorAssign` | +| `<<` | Left Shift | | | `std::ops::Shl` | `std::ops::ShlAssign` | +| `>>` | Right Shift*** | | | `std::ops::Shr` | `std::ops::ShrAssign` | + +\* Integer division rounds towards zero. + +\*\* Rust uses a remainder defined with [truncating division](https://en.wikipedia.org/wiki/Modulo_operation#Variants_of_the_definition). Given `remainder = dividend % divisor`, the remainder will have the same sign as the dividend. + +\*\*\* Arithmetic right shift on signed integer types, logical right shift on +unsigned integer types. + +Here are examples of these operators being used. + +```rust +assert_eq!(3 + 6, 9); +assert_eq!(5.5 - 1.25, 4.25); +assert_eq!(-5 * 14, -70); +assert_eq!(14 / 3, 4); +assert_eq!(100 % 7, 2); +assert_eq!(0b1010 & 0b1100, 0b1000); +assert_eq!(0b1010 | 0b1100, 0b1110); +assert_eq!(0b1010 ^ 0b1100, 0b110); +assert_eq!(13 << 3, 104); +assert_eq!(-10 >> 2, -3); +``` + +## Comparison Operators + +> **Syntax**\ +> _ComparisonExpression_ :\ +>       [_Expression_] `==` [_Expression_]\ +>    | [_Expression_] `!=` [_Expression_]\ +>    | [_Expression_] `>` [_Expression_]\ +>    | [_Expression_] `<` [_Expression_]\ +>    | [_Expression_] `>=` [_Expression_]\ +>    | [_Expression_] `<=` [_Expression_] + +Comparison operators are also defined both for primitive types and many types in the standard library. +Parentheses are required when chaining comparison operators. For example, the expression `a == b == c` is invalid and may be written as `(a == b) == c`. + +Unlike arithmetic and logical operators, the traits for overloading these operators are used more generally to show how a type may be compared and will likely be assumed to define actual comparisons by functions that use these traits as bounds. +Many functions and macros in the standard library can then use that assumption (although not to ensure safety). +Unlike the arithmetic and logical operators above, these operators implicitly take shared borrows of their operands, evaluating them in [place expression context][place expression]: + +```rust +# let a = 1; +# let b = 1; +a == b; +// is equivalent to +::std::cmp::PartialEq::eq(&a, &b); +``` + +This means that the operands don't have to be moved out of. + +| Symbol | Meaning | Overloading method | +|--------|--------------------------|----------------------------| +| `==` | Equal | `std::cmp::PartialEq::eq` | +| `!=` | Not equal | `std::cmp::PartialEq::ne` | +| `>` | Greater than | `std::cmp::PartialOrd::gt` | +| `<` | Less than | `std::cmp::PartialOrd::lt` | +| `>=` | Greater than or equal to | `std::cmp::PartialOrd::ge` | +| `<=` | Less than or equal to | `std::cmp::PartialOrd::le` | + +Here are examples of the comparison operators being used. + +```rust +assert!(123 == 123); +assert!(23 != -12); +assert!(12.5 > 12.2); +assert!([1, 2, 3] < [1, 3, 4]); +assert!('A' <= 'B'); +assert!("World" >= "Hello"); +``` + +## Lazy boolean operators + +> **Syntax**\ +> _LazyBooleanExpression_ :\ +>       [_Expression_] `||` [_Expression_]\ +>    | [_Expression_] `&&` [_Expression_] + +The operators `||` and `&&` may be applied to operands of boolean type. +The `||` operator denotes logical 'or', and the `&&` operator denotes logical 'and'. +They differ from `|` and `&` in that the right-hand operand is only evaluated when the left-hand operand does not already determine the result of the expression. +That is, `||` only evaluates its right-hand operand when the left-hand operand evaluates to `false`, and `&&` only when it evaluates to `true`. + +```rust +let x = false || true; // true +let y = false && panic!(); // false, doesn't evaluate `panic!()` +``` + +## Type cast expressions + +> **Syntax**\ +> _TypeCastExpression_ :\ +>    [_Expression_] `as` [_TypeNoBounds_] + +A type cast expression is denoted with the binary operator `as`. + +Executing an `as` expression casts the value on the left-hand side to the type on the right-hand side. + +An example of an `as` expression: + +```rust +# fn sum(values: &[f64]) -> f64 { 0.0 } +# fn len(values: &[f64]) -> i32 { 0 } +fn average(values: &[f64]) -> f64 { + let sum: f64 = sum(values); + let size: f64 = len(values) as f64; + sum / size +} +``` + +`as` can be used to explicitly perform [coercions](../type-coercions.md), as well as the following additional casts. +Any cast that does not fit either a coercion rule or an entry in the table is a compiler error. +Here `*T` means either `*const T` or `*mut T`. `m` stands for optional `mut` in +reference types and `mut` or `const` in pointer types. + +| Type of `e` | `U` | Cast performed by `e as U` | +|-----------------------|-----------------------|----------------------------------| +| Integer or Float type | Integer or Float type | Numeric cast | +| C-like enum | Integer type | Enum cast | +| `bool` or `char` | Integer type | Primitive to integer cast | +| `u8` | `char` | `u8` to `char` cast | +| `*T` | `*V` where `V: Sized` \* | Pointer to pointer cast | +| `*T` where `T: Sized` | Integer type | Pointer to address cast | +| Integer type | `*V` where `V: Sized` | Address to pointer cast | +| `&m₁ T` | `*m₂ T` \*\* | Reference to pointer cast | +| `&m₁ [T; n]` | `*m₂ T` \*\* | Array to pointer cast | +| [Function item] | [Function pointer] | Function item to function pointer cast | +| [Function item] | `*V` where `V: Sized` | Function item to pointer cast | +| [Function item] | Integer | Function item to address cast | +| [Function pointer] | `*V` where `V: Sized` | Function pointer to pointer cast | +| [Function pointer] | Integer | Function pointer to address cast | +| Closure \*\*\* | Function pointer | Closure to function pointer cast | + +\* or `T` and `V` are compatible unsized types, e.g., both slices, both the same trait object. + +\*\* only when `m₁` is `mut` or `m₂` is `const`. Casting `mut` reference to +`const` pointer is allowed. + +\*\*\* only for closures that do not capture (close over) any local variables + +### Semantics + +#### Numeric cast + +* Casting between two integers of the same size (e.g. i32 -> u32) is a no-op + (Rust uses 2's complement for negative values of fixed integers) +* Casting from a larger integer to a smaller integer (e.g. u32 -> u8) will + truncate +* Casting from a smaller integer to a larger integer (e.g. u8 -> u32) will + * zero-extend if the source is unsigned + * sign-extend if the source is signed +* Casting from a float to an integer will round the float towards zero + * `NaN` will return `0` + * Values larger than the maximum integer value, including `INFINITY`, will saturate to the maximum value of the integer type. + * Values smaller than the minimum integer value, including `NEG_INFINITY`, will saturate to the minimum value of the integer type. +* Casting from an integer to float will produce the closest possible float \* + * if necessary, rounding is according to `roundTiesToEven` mode \*\*\* + * on overflow, infinity (of the same sign as the input) is produced + * note: with the current set of numeric types, overflow can only happen + on `u128 as f32` for values greater or equal to `f32::MAX + (0.5 ULP)` +* Casting from an f32 to an f64 is perfect and lossless +* Casting from an f64 to an f32 will produce the closest possible f32 \*\* + * if necessary, rounding is according to `roundTiesToEven` mode \*\*\* + * on overflow, infinity (of the same sign as the input) is produced + +\* if integer-to-float casts with this rounding mode and overflow behavior are +not supported natively by the hardware, these casts will likely be slower than +expected. + +\*\* if f64-to-f32 casts with this rounding mode and overflow behavior are not +supported natively by the hardware, these casts will likely be slower than +expected. + +\*\*\* as defined in IEEE 754-2008 §4.3.1: pick the nearest floating point +number, preferring the one with an even least significant digit if exactly +halfway between two floating point numbers. + +#### Enum cast + +Casts an enum to its discriminant, then uses a numeric cast if needed. + +#### Primitive to integer cast + +* `false` casts to `0`, `true` casts to `1` +* `char` casts to the value of the code point, then uses a numeric cast if needed. + +#### `u8` to `char` cast + +Casts to the `char` with the corresponding code point. + +#### Pointer to address cast + +Casting from a raw pointer to an integer produces the machine address of the referenced memory. +If the integer type is smaller than the pointer type, the address may be truncated; using `usize` avoids this. + +#### Address to pointer cast + +Casting from an integer to a raw pointer interprets the integer as a memory address and produces a pointer referencing that memory. + +
+ +Warning: +This interacts with the Rust memory model, which is still under development. +A pointer obtained from this cast may suffer additional restrictions even if it is bitwise equal to a valid pointer. +Dereferencing such a pointer may be [undefined behavior] if aliasing rules are not followed. + +
+ +A trivial example of sound address arithmetic: + +```rust +let mut values: [i32; 2] = [1, 2]; +let p1: *mut i32 = values.as_mut_ptr(); +let first_address = p1 as usize; +let second_address = first_address + 4; // 4 == size_of::() +let p2 = second_address as *mut i32; +unsafe { + *p2 += 1; +} +assert_eq!(values[1], 3); +``` + +## Assignment expressions + +> **Syntax**\ +> _AssignmentExpression_ :\ +>    [_Expression_] `=` [_Expression_] + +An *assignment expression* moves a value into a specified place. + +An assignment expression consists of a [mutable] [assignee expression], the *assignee operand*, followed by an equals sign (`=`) and a [value expression], the *assigned value operand*. +In its most basic form, an assignee expression is a [place expression], and we discuss this case first. +The more general case of destructuring assignment is discussed below, but this case always decomposes into sequential assignments to place expressions, which may be considered the more fundamental case. + +### Basic assignments + +Evaluating assignment expressions begins by evaluating its operands. +The assigned value operand is evaluated first, followed by the assignee expression. +For destructuring assignment, subexpressions of the assignee expression are evaluated left-to-right. + +> **Note**: This is different than other expressions in that the right operand is evaluated before the left one. + +It then has the effect of first [dropping] the value at the assigned place, unless the place is an uninitialized local variable or an uninitialized field of a local variable. +Next it either [copies or moves] the assigned value to the assigned place. + +An assignment expression always produces [the unit value][unit]. + +Example: + +```rust +let mut x = 0; +let y = 0; +x = y; +``` + +### Destructuring assignments + +Destructuring assignment is a counterpart to destructuring pattern matches for variable declaration, permitting assignment to complex values, such as tuples or structs. +For instance, we may swap two mutable variables: + +```rust +let (mut a, mut b) = (0, 1); +// Swap `a` and `b` using destructuring assignment. +(b, a) = (a, b); +``` + +In contrast to destructuring declarations using `let`, patterns may not appear on the left-hand side of an assignment due to syntactic ambiguities. +Instead, a group of expressions that correspond to patterns are designated to be [assignee expressions][assignee expression], and permitted on the left-hand side of an assignment. +Assignee expressions are then desugared to pattern matches followed by sequential assignment. +The desugared patterns must be irrefutable: in particular, this means that only slice patterns whose length is known at compile-time, and the trivial slice `[..]`, are permitted for destructuring assignment. + +The desugaring method is straightforward, and is illustrated best by example. + +```rust +# struct Struct { x: u32, y: u32 } +# let (mut a, mut b) = (0, 0); +(a, b) = (3, 4); + +[a, b] = [3, 4]; + +Struct { x: a, y: b } = Struct { x: 3, y: 4}; + +// desugars to: + +{ + let (_a, _b) = (3, 4); + a = _a; + b = _b; +} + +{ + let [_a, _b] = [3, 4]; + a = _a; + b = _b; +} + +{ + let Struct { x: _a, y: _b } = Struct { x: 3, y: 4}; + a = _a; + b = _b; +} +``` + +Identifiers are not forbidden from being used multiple times in a single assignee expression. + +[Underscore expressions][_UnderscoreExpression_] and empty [range expressions][_RangeExpression_] may be used to ignore certain values, without binding them. + +Note that default binding modes do not apply for the desugared expression. + +## Compound assignment expressions + +> **Syntax**\ +> _CompoundAssignmentExpression_ :\ +>       [_Expression_] `+=` [_Expression_]\ +>    | [_Expression_] `-=` [_Expression_]\ +>    | [_Expression_] `*=` [_Expression_]\ +>    | [_Expression_] `/=` [_Expression_]\ +>    | [_Expression_] `%=` [_Expression_]\ +>    | [_Expression_] `&=` [_Expression_]\ +>    | [_Expression_] `|=` [_Expression_]\ +>    | [_Expression_] `^=` [_Expression_]\ +>    | [_Expression_] `<<=` [_Expression_]\ +>    | [_Expression_] `>>=` [_Expression_] + +*Compound assignment expressions* combine arithmetic and logical binary operators with assignment expressions. + +For example: + +```rust +let mut x = 5; +x += 1; +assert!(x == 6); +``` + +The syntax of compound assignment is a [mutable] [place expression], the *assigned operand*, then one of the operators followed by an `=` as a single token (no whitespace), and then a [value expression], the *modifying operand*. + +Unlike other place operands, the assigned place operand must be a place expression. +Attempting to use a value expression is a compiler error rather than promoting it to a temporary. + +Evaluation of compound assignment expressions depends on the types of the operators. + +If both types are primitives, then the modifying operand will be evaluated first followed by the assigned operand. +It will then set the value of the assigned operand's place to the value of performing the operation of the operator with the values of the assigned operand and modifying operand. + +> **Note**: This is different than other expressions in that the right operand is evaluated before the left one. + +Otherwise, this expression is syntactic sugar for calling the function of the overloading compound assigment trait of the operator (see the table earlier in this chapter). +A mutable borrow of the assigned operand is automatically taken. + +For example, the following expression statements in `example` are equivalent: + +```rust +# struct Addable; +# use std::ops::AddAssign; + +impl AddAssign for Addable { + /* */ +# fn add_assign(&mut self, other: Addable) {} +} + +fn example() { +# let (mut a1, a2) = (Addable, Addable); + a1 += a2; + +# let (mut a1, a2) = (Addable, Addable); + AddAssign::add_assign(&mut a1, a2); +} +``` + +Like assignment expressions, compound assignment expressions always produce [the unit value][unit]. + +
+ +Warning: The evaluation order of operands swaps depending on the types of the operands: +with primitive types the right-hand side will get evaluated first, while with non-primitive types the left-hand side will get evaluated first. +Try not to write code that depends on the evaluation order of operands in compound assignment expressions. +See [this test] for an example of using this dependency. + +
+ +[copies or moves]: ../expressions.md#moved-and-copied-types +[dropping]: ../destructors.md +[grouped expression]: grouped-expr.md +[literal expression]: literal-expr.md#integer-literal-expressions +[logical and]: ../types/boolean.md#logical-and +[logical not]: ../types/boolean.md#logical-not +[logical or]: ../types/boolean.md#logical-or +[logical xor]: ../types/boolean.md#logical-xor +[mutable]: ../expressions.md#mutability +[place expression]: ../expressions.md#place-expressions-and-value-expressions +[assignee expression]: ../expressions.md#place-expressions-and-value-expressions +[undefined behavior]: ../behavior-considered-undefined.md +[unit]: ../types/tuple.md +[value expression]: ../expressions.md#place-expressions-and-value-expressions +[temporary value]: ../expressions.md#temporaries +[this test]: https://github.com/rust-lang/rust/blob/1.58.0/src/test/ui/expr/compound-assignment/eval-order.rs +[float-float]: https://github.com/rust-lang/rust/issues/15536 +[Function pointer]: ../types/function-pointer.md +[Function item]: ../types/function-item.md +[undefined behavior]: ../behavior-considered-undefined.md +[addr_of]: ../../std/ptr/macro.addr_of.html +[addr_of_mut]: ../../std/ptr/macro.addr_of_mut.html + +[_BorrowExpression_]: #borrow-operators +[_DereferenceExpression_]: #the-dereference-operator +[_ErrorPropagationExpression_]: #the-question-mark-operator +[_NegationExpression_]: #negation-operators +[_ArithmeticOrLogicalExpression_]: #arithmetic-and-logical-binary-operators +[_ComparisonExpression_]: #comparison-operators +[_LazyBooleanExpression_]: #lazy-boolean-operators +[_TypeCastExpression_]: #type-cast-expressions +[_AssignmentExpression_]: #assignment-expressions +[_CompoundAssignmentExpression_]: #compound-assignment-expressions + +[_Expression_]: ../expressions.md +[_TypeNoBounds_]: ../types.md#type-expressions +[_RangeExpression_]: ./range-expr.md +[_UnderscoreExpression_]: ./underscore-expr.md diff --git a/src/doc/reference/src/expressions/path-expr.md b/src/doc/reference/src/expressions/path-expr.md new file mode 100644 index 000000000..0909c5ddb --- /dev/null +++ b/src/doc/reference/src/expressions/path-expr.md @@ -0,0 +1,32 @@ +# Path expressions + +> **Syntax**\ +> _PathExpression_ :\ +>       [_PathInExpression_]\ +>    | [_QualifiedPathInExpression_] + +A [path] used as an expression context denotes either a local variable or an item. +Path expressions that resolve to local or static variables are [place expressions], other paths are [value expressions]. +Using a [`static mut`] variable requires an [`unsafe` block]. + +```rust +# mod globals { +# pub static STATIC_VAR: i32 = 5; +# pub static mut STATIC_MUT_VAR: i32 = 7; +# } +# let local_var = 3; +local_var; +globals::STATIC_VAR; +unsafe { globals::STATIC_MUT_VAR }; +let some_constructor = Some::; +let push_integer = Vec::::push; +let slice_reverse = <[i32]>::reverse; +``` + +[_PathInExpression_]: ../paths.md#paths-in-expressions +[_QualifiedPathInExpression_]: ../paths.md#qualified-paths +[place expressions]: ../expressions.md#place-expressions-and-value-expressions +[value expressions]: ../expressions.md#place-expressions-and-value-expressions +[path]: ../paths.md +[`static mut`]: ../items/static-items.md#mutable-statics +[`unsafe` block]: block-expr.md#unsafe-blocks diff --git a/src/doc/reference/src/expressions/range-expr.md b/src/doc/reference/src/expressions/range-expr.md new file mode 100644 index 000000000..37409a4cf --- /dev/null +++ b/src/doc/reference/src/expressions/range-expr.md @@ -0,0 +1,76 @@ +# Range expressions + +> **Syntax**\ +> _RangeExpression_ :\ +>       _RangeExpr_\ +>    | _RangeFromExpr_\ +>    | _RangeToExpr_\ +>    | _RangeFullExpr_\ +>    | _RangeInclusiveExpr_\ +>    | _RangeToInclusiveExpr_ +> +> _RangeExpr_ :\ +>    [_Expression_] `..` [_Expression_] +> +> _RangeFromExpr_ :\ +>    [_Expression_] `..` +> +> _RangeToExpr_ :\ +>    `..` [_Expression_] +> +> _RangeFullExpr_ :\ +>    `..` +> +> _RangeInclusiveExpr_ :\ +>    [_Expression_] `..=` [_Expression_] +> +> _RangeToInclusiveExpr_ :\ +>    `..=` [_Expression_] + +The `..` and `..=` operators will construct an object of one of the `std::ops::Range` (or `core::ops::Range`) variants, according to the following table: + +| Production | Syntax | Type | Range | +|------------------------|---------------|------------------------------|-----------------------| +| _RangeExpr_ | start`..`end | [std::ops::Range] | start ≤ x < end | +| _RangeFromExpr_ | start`..` | [std::ops::RangeFrom] | start ≤ x | +| _RangeToExpr_ | `..`end | [std::ops::RangeTo] | x < end | +| _RangeFullExpr_ | `..` | [std::ops::RangeFull] | - | +| _RangeInclusiveExpr_ | start`..=`end | [std::ops::RangeInclusive] | start ≤ x ≤ end | +| _RangeToInclusiveExpr_ | `..=`end | [std::ops::RangeToInclusive] | x ≤ end | + +Examples: + +```rust +1..2; // std::ops::Range +3..; // std::ops::RangeFrom +..4; // std::ops::RangeTo +..; // std::ops::RangeFull +5..=6; // std::ops::RangeInclusive +..=7; // std::ops::RangeToInclusive +``` + +The following expressions are equivalent. + +```rust +let x = std::ops::Range {start: 0, end: 10}; +let y = 0..10; + +assert_eq!(x, y); +``` + +Ranges can be used in `for` loops: + +```rust +for i in 1..11 { + println!("{}", i); +} +``` + +[_Expression_]: ../expressions.md + +[std::ops::Range]: https://doc.rust-lang.org/std/ops/struct.Range.html +[std::ops::RangeFrom]: https://doc.rust-lang.org/std/ops/struct.RangeFrom.html +[std::ops::RangeTo]: https://doc.rust-lang.org/std/ops/struct.RangeTo.html +[std::ops::RangeFull]: https://doc.rust-lang.org/std/ops/struct.RangeFull.html +[std::ops::RangeInclusive]: https://doc.rust-lang.org/std/ops/struct.RangeInclusive.html +[std::ops::RangeToInclusive]: https://doc.rust-lang.org/std/ops/struct.RangeToInclusive.html diff --git a/src/doc/reference/src/expressions/return-expr.md b/src/doc/reference/src/expressions/return-expr.md new file mode 100644 index 000000000..b1b3787d8 --- /dev/null +++ b/src/doc/reference/src/expressions/return-expr.md @@ -0,0 +1,21 @@ +# `return` expressions + +> **Syntax**\ +> _ReturnExpression_ :\ +>    `return` [_Expression_]? + +Return expressions are denoted with the keyword `return`. +Evaluating a `return` expression moves its argument into the designated output location for the current function call, destroys the current function activation frame, and transfers control to the caller frame. + +An example of a `return` expression: + +```rust +fn max(a: i32, b: i32) -> i32 { + if a > b { + return a; + } + return b; +} +``` + +[_Expression_]: ../expressions.md diff --git a/src/doc/reference/src/expressions/struct-expr.md b/src/doc/reference/src/expressions/struct-expr.md new file mode 100644 index 000000000..8caeff200 --- /dev/null +++ b/src/doc/reference/src/expressions/struct-expr.md @@ -0,0 +1,142 @@ +# Struct expressions + +> **Syntax**\ +> _StructExpression_ :\ +>       _StructExprStruct_\ +>    | _StructExprTuple_\ +>    | _StructExprUnit_ +> +> _StructExprStruct_ :\ +>    [_PathInExpression_] `{` (_StructExprFields_ | _StructBase_)? `}` +> +> _StructExprFields_ :\ +>    _StructExprField_ (`,` _StructExprField_)\* (`,` _StructBase_ | `,`?) +> +> _StructExprField_ :\ +>    [_OuterAttribute_] \*\ +>    (\ +>          [IDENTIFIER]\ +>       | ([IDENTIFIER] | [TUPLE_INDEX]) `:` [_Expression_]\ +>    ) +> +> _StructBase_ :\ +>    `..` [_Expression_] +> +> _StructExprTuple_ :\ +>    [_PathInExpression_] `(`\ +>       ( [_Expression_] (`,` [_Expression_])\* `,`? )?\ +>    `)` +> +> _StructExprUnit_ : [_PathInExpression_] + +A *struct expression* creates a struct, enum, or union value. +It consists of a path to a [struct], [enum variant], or [union] item followed by the values for the fields of the item. +There are three forms of struct expressions: struct, tuple, and unit. + +The following are examples of struct expressions: + +```rust +# struct Point { x: f64, y: f64 } +# struct NothingInMe { } +# struct TuplePoint(f64, f64); +# mod game { pub struct User<'a> { pub name: &'a str, pub age: u32, pub score: usize } } +# struct Cookie; fn some_fn(t: T) {} +Point {x: 10.0, y: 20.0}; +NothingInMe {}; +TuplePoint(10.0, 20.0); +TuplePoint { 0: 10.0, 1: 20.0 }; // Results in the same value as the above line +let u = game::User {name: "Joe", age: 35, score: 100_000}; +some_fn::(Cookie); +``` + +## Field struct expression + +A struct expression with fields enclosed in curly braces allows you to specify the value for each individual field in any order. +The field name is separated from its value with a colon. + +A value of a [union] type can only be created using this syntax, and it must specify exactly one field. + +## Functional update syntax + +A struct expression that constructs a value of a struct type can terminate with the syntax `..` followed by an expression to denote a functional update. +The expression following `..` (the base) must have the same struct type as the new struct type being formed. + +The entire expression uses the given values for the fields that were specified and moves or copies the remaining fields from the base expression. +As with all struct expressions, all of the fields of the struct must be [visible], even those not explicitly named. + +```rust +# struct Point3d { x: i32, y: i32, z: i32 } +let mut base = Point3d {x: 1, y: 2, z: 3}; +let y_ref = &mut base.y; +Point3d {y: 0, z: 10, .. base}; // OK, only base.x is accessed +drop(y_ref); +``` + +Struct expressions with curly braces can't be used directly in a [loop] or [if] expression's head, or in the [scrutinee] of an [if let] or [match] expression. +However, struct expressions can be in used in these situations if they are within another expression, for example inside [parentheses]. + +The field names can be decimal integer values to specify indices for constructing tuple structs. +This can be used with base structs to fill out the remaining indices not specified: + +```rust +struct Color(u8, u8, u8); +let c1 = Color(0, 0, 0); // Typical way of creating a tuple struct. +let c2 = Color{0: 255, 1: 127, 2: 0}; // Specifying fields by index. +let c3 = Color{1: 0, ..c2}; // Fill out all other fields using a base struct. +``` + +### Struct field init shorthand + +When initializing a data structure (struct, enum, union) with named (but not numbered) fields, it is allowed to write `fieldname` as a shorthand for `fieldname: fieldname`. +This allows a compact syntax with less duplication. +For example: + +```rust +# struct Point3d { x: i32, y: i32, z: i32 } +# let x = 0; +# let y_value = 0; +# let z = 0; +Point3d { x: x, y: y_value, z: z }; +Point3d { x, y: y_value, z }; +``` + +## Tuple struct expression + +A struct expression with fields enclosed in parentheses constructs a tuple struct. +Though it is listed here as a specific expression for completeness, it is equivalent to a [call expression] to the tuple struct's constructor. For example: + +```rust +struct Position(i32, i32, i32); +Position(0, 0, 0); // Typical way of creating a tuple struct. +let c = Position; // `c` is a function that takes 3 arguments. +let pos = c(8, 6, 7); // Creates a `Position` value. +``` + +## Unit struct expression + +A unit struct expression is just the path to a unit struct item. +This refers to the unit struct's implicit constant of its value. +The unit struct value can also be constructed with a fieldless struct expression. For example: + +```rust +struct Gamma; +let a = Gamma; // Gamma unit value. +let b = Gamma{}; // Exact same value as `a`. +``` + +[_OuterAttribute_]: ../attributes.md +[IDENTIFIER]: ../identifiers.md +[TUPLE_INDEX]: ../tokens.md#tuple-index +[_Expression_]: ../expressions.md +[_PathInExpression_]: ../paths.md#paths-in-expressions +[call expression]: call-expr.md +[enum variant]: ../items/enumerations.md +[if let]: if-expr.md#if-let-expressions +[if]: if-expr.md#if-expressions +[loop]: loop-expr.md +[match]: match-expr.md +[parentheses]: grouped-expr.md +[struct]: ../items/structs.md +[union]: ../items/unions.md +[visible]: ../visibility-and-privacy.md +[scrutinee]: ../glossary.md#scrutinee diff --git a/src/doc/reference/src/expressions/tuple-expr.md b/src/doc/reference/src/expressions/tuple-expr.md new file mode 100644 index 000000000..a6ac1c962 --- /dev/null +++ b/src/doc/reference/src/expressions/tuple-expr.md @@ -0,0 +1,80 @@ +# Tuple and tuple indexing expressions + +## Tuple expressions + +> **Syntax**\ +> _TupleExpression_ :\ +>    `(` _TupleElements_? `)` +> +> _TupleElements_ :\ +>    ( [_Expression_] `,` )+ [_Expression_]? + +A *tuple expression* constructs [tuple values][tuple type]. + +The syntax for tuple expressions is a parenthesized, comma separated list of expressions, called the *tuple initializer operands*. +1-ary tuple expressions require a comma after their tuple initializer operand to be disambiguated with a [parenthetical expression]. + +Tuple expressions are a [value expression] that evaluate into a newly constructed value of a tuple type. +The number of tuple initializer operands is the arity of the constructed tuple. +Tuple expressions without any tuple initializer operands produce the unit tuple. +For other tuple expressions, the first written tuple initializer operand initializes the field `0` and subsequent operands initializes the next highest field. +For example, in the tuple expression `('a', 'b', 'c')`, `'a'` initializes the value of the field `0`, `'b'` field `1`, and `'c'` field `2`. + +Examples of tuple expressions and their types: + +| Expression | Type | +| -------------------- | ------------ | +| `()` | `()` (unit) | +| `(0.0, 4.5)` | `(f64, f64)` | +| `("x".to_string(), )` | `(String, )` | +| `("a", 4usize, true)`| `(&'static str, usize, bool)` | + +## Tuple indexing expressions + +> **Syntax**\ +> _TupleIndexingExpression_ :\ +>    [_Expression_] `.` [TUPLE_INDEX] + +A *tuple indexing expression* accesses fields of [tuples][tuple type] and [tuple structs][tuple struct]. + +The syntax for a tuple index expression is an expression, called the *tuple operand*, then a `.`, then finally a tuple index. +The syntax for the *tuple index* is a [decimal literal] with no leading zeros, underscores, or suffix. +For example `0` and `2` are valid tuple indices but not `01`, `0_`, nor `0i32`. + +The type of the tuple operand must be a [tuple type] or a [tuple struct]. +The tuple index must be a name of a field of the type of the tuple operand. + +Evaluation of tuple index expressions has no side effects beyond evaluation of its tuple operand. +As a [place expression], it evaluates to the location of the field of the tuple operand with the same name as the tuple index. + +Examples of tuple indexing expressions: + +```rust +// Indexing a tuple +let pair = ("a string", 2); +assert_eq!(pair.1, 2); + +// Indexing a tuple struct +# struct Point(f32, f32); +let point = Point(1.0, 0.0); +assert_eq!(point.0, 1.0); +assert_eq!(point.1, 0.0); +``` + +> **Note**: Unlike field access expressions, tuple index expressions can be the function operand of a [call expression] as it cannot be confused with a method call since method names cannot be numbers. + +> **Note**: Although arrays and slices also have elements, you must use an [array or slice indexing expression] or a [slice pattern] to access their elements. + +[_Expression_]: ../expressions.md +[array or slice indexing expression]: array-expr.md#array-and-slice-indexing-expressions +[call expression]: ./call-expr.md +[decimal literal]: ../tokens.md#integer-literals +[field access expressions]: ./field-expr.html#field-access-expressions +[operands]: ../expressions.md +[parenthetical expression]: grouped-expr.md +[place expression]: ../expressions.md#place-expressions-and-value-expressions +[slice pattern]: ../patterns.md#slice-patterns +[tuple type]: ../types/tuple.md +[tuple struct]: ../types/struct.md +[TUPLE_INDEX]: ../tokens.md#tuple-index +[value expression]: ../expressions.md#place-expressions-and-value-expressions diff --git a/src/doc/reference/src/expressions/underscore-expr.md b/src/doc/reference/src/expressions/underscore-expr.md new file mode 100644 index 000000000..069f227e9 --- /dev/null +++ b/src/doc/reference/src/expressions/underscore-expr.md @@ -0,0 +1,17 @@ +# `_` expressions + +> **Syntax**\ +> _UnderscoreExpression_ :\ +>    `_` + +Underscore expressions, denoted with the symbol `_`, are used to signify a +placeholder in a destructuring assignment. They may only appear in the left-hand +side of an assignment. + +An example of an `_` expression: + +```rust +let p = (1, 2); +let mut a = 0; +(_, a) = p; +``` diff --git a/src/doc/reference/src/glossary.md b/src/doc/reference/src/glossary.md new file mode 100644 index 000000000..b5074767c --- /dev/null +++ b/src/doc/reference/src/glossary.md @@ -0,0 +1,331 @@ +# Glossary + +### Abstract syntax tree + +An ‘abstract syntax tree’, or ‘AST’, is an intermediate representation of +the structure of the program when the compiler is compiling it. + +### Alignment + +The alignment of a value specifies what addresses values are preferred to +start at. Always a power of two. References to a value must be aligned. +[More][alignment]. + +### Arity + +Arity refers to the number of arguments a function or operator takes. +For some examples, `f(2, 3)` and `g(4, 6)` have arity 2, while `h(8, 2, 6)` +has arity 3. The `!` operator has arity 1. + +### Array + +An array, sometimes also called a fixed-size array or an inline array, is a value +describing a collection of elements, each selected by an index that can be computed +at run time by the program. It occupies a contiguous region of memory. + +### Associated item + +An associated item is an item that is associated with another item. Associated +items are defined in [implementations] and declared in [traits]. Only +functions, constants, and type aliases can be associated. Contrast to a [free +item]. + +### Blanket implementation + +Any implementation where a type appears [uncovered](#uncovered-type). `impl Foo +for T`, `impl Bar for T`, `impl Bar> for T`, and `impl Bar +for Vec` are considered blanket impls. However, `impl Bar> for +Vec` is not a blanket impl, as all instances of `T` which appear in this `impl` +are covered by `Vec`. + +### Bound + +Bounds are constraints on a type or trait. For example, if a bound +is placed on the argument a function takes, types passed to that function +must abide by that constraint. + +### Combinator + +Combinators are higher-order functions that apply only functions and +earlier defined combinators to provide a result from its arguments. +They can be used to manage control flow in a modular fashion. + +### Crate + +A crate is the unit of compilation and linking. There are different [types of +crates], such as libraries or executables. Crates may link and refer to other +library crates, called external crates. A crate has a self-contained tree of +[modules], starting from an unnamed root module called the crate root. [Items] +may be made visible to other crates by marking them as public in the crate +root, including through [paths] of public modules. +[More][crate]. + +### Dispatch + +Dispatch is the mechanism to determine which specific version of code is actually +run when it involves polymorphism. Two major forms of dispatch are static dispatch and +dynamic dispatch. While Rust favors static dispatch, it also supports dynamic dispatch +through a mechanism called ‘trait objects’. + +### Dynamically sized type + +A dynamically sized type (DST) is a type without a statically known size or alignment. + +### Entity + +An [*entity*] is a language construct that can be referred to in some way +within the source program, usually via a [path][paths]. Entities include +[types], [items], [generic parameters], [variable bindings], [loop labels], +[lifetimes], [fields], [attributes], and [lints]. + +### Expression + +An expression is a combination of values, constants, variables, operators +and functions that evaluate to a single value, with or without side-effects. + +For example, `2 + (3 * 4)` is an expression that returns the value 14. + +### Free item + +An [item] that is not a member of an [implementation], such as a *free +function* or a *free const*. Contrast to an [associated item]. + +### Fundamental traits + +A fundamental trait is one where adding an impl of it for an existing type is a breaking change. +The `Fn` traits and `Sized` are fundamental. + +### Fundamental type constructors + +A fundamental type constructor is a type where implementing a [blanket implementation](#blanket-implementation) over it +is a breaking change. `&`, `&mut`, `Box`, and `Pin` are fundamental. + +Any time a type `T` is considered [local](#local-type), `&T`, `&mut T`, `Box`, and `Pin` +are also considered local. Fundamental type constructors cannot [cover](#uncovered-type) other types. +Any time the term "covered type" is used, +the `T` in `&T`, `&mut T`, `Box`, and `Pin` is not considered covered. + +### Inhabited + +A type is inhabited if it has constructors and therefore can be instantiated. An inhabited type is +not "empty" in the sense that there can be values of the type. Opposite of +[Uninhabited](#uninhabited). + +### Inherent implementation + +An [implementation] that applies to a nominal type, not to a trait-type pair. +[More][inherent implementation]. + +### Inherent method + +A [method] defined in an [inherent implementation], not in a trait +implementation. + +### Initialized + +A variable is initialized if it has been assigned a value and hasn't since been +moved from. All other memory locations are assumed to be uninitialized. Only +unsafe Rust can create a memory location without initializing it. + +### Local trait + +A `trait` which was defined in the current crate. A trait definition is local +or not independent of applied type arguments. Given `trait Foo`, +`Foo` is always local, regardless of the types substituted for `T` and `U`. + +### Local type + +A `struct`, `enum`, or `union` which was defined in the current crate. +This is not affected by applied type arguments. `struct Foo` is considered local, but +`Vec` is not. `LocalType` is local. Type aliases do not +affect locality. + +### Module + +A module is a container for zero or more [items]. Modules are organized in a +tree, starting from an unnamed module at the root called the crate root or the +root module. [Paths] may be used to refer to items from other modules, which +may be restricted by [visibility rules]. +[More][modules] + +### Name + +A [*name*] is an [identifier] or [lifetime or loop label] that refers to an +[entity](#entity). A *name binding* is when an entity declaration introduces +an identifier or label associated with that entity. [Paths], +identifiers, and labels are used to refer to an entity. + +### Name resolution + +[*Name resolution*] is the compile-time process of tying [paths], +[identifiers], and [labels] to [entity](#entity) declarations. + +### Namespace + +A *namespace* is a logical grouping of declared [names](#name) based on the +kind of [entity](#entity) the name refers to. Namespaces allow the occurrence +of a name in one namespace to not conflict with the same name in another +namespace. + +Within a namespace, names are organized in a hierarchy, where each level of +the hierarchy has its own collection of named entities. + +### Nominal types + +Types that can be referred to by a path directly. Specifically [enums], +[structs], [unions], and [trait objects]. + +### Object safe traits + +[Traits] that can be used as [trait objects]. Only traits that follow specific +[rules][object safety] are object safe. + +### Path + +A [*path*] is a sequence of one or more path segments used to refer to an +[entity](#entity) in the current scope or other levels of a +[namespace](#namespace) hierarchy. + +### Prelude + +Prelude, or The Rust Prelude, is a small collection of items - mostly traits - that are +imported into every module of every crate. The traits in the prelude are pervasive. + +### Scope + +A [*scope*] is the region of source text where a named [entity](#entity) may +be referenced with that name. + +### Scrutinee + +A scrutinee is the expression that is matched on in `match` expressions and +similar pattern matching constructs. For example, in `match x { A => 1, B => 2 }`, +the expression `x` is the scrutinee. + +### Size + +The size of a value has two definitions. + +The first is that it is how much memory must be allocated to store that value. + +The second is that it is the offset in bytes between successive elements in an +array with that item type. + +It is a multiple of the alignment, including zero. The size can change +depending on compiler version (as new optimizations are made) and target +platform (similar to how `usize` varies per-platform). + +[More][alignment]. + +### Slice + +A slice is dynamically-sized view into a contiguous sequence, written as `[T]`. + +It is often seen in its borrowed forms, either mutable or shared. The shared +slice type is `&[T]`, while the mutable slice type is `&mut [T]`, where `T` represents +the element type. + +### Statement + +A statement is the smallest standalone element of a programming language +that commands a computer to perform an action. + +### String literal + +A string literal is a string stored directly in the final binary, and so will be +valid for the `'static` duration. + +Its type is `'static` duration borrowed string slice, `&'static str`. + +### String slice + +A string slice is the most primitive string type in Rust, written as `str`. It is +often seen in its borrowed forms, either mutable or shared. The shared +string slice type is `&str`, while the mutable string slice type is `&mut str`. + +Strings slices are always valid UTF-8. + +### Trait + +A trait is a language item that is used for describing the functionalities a type must provide. +It allows a type to make certain promises about its behavior. + +Generic functions and generic structs can use traits to constrain, or bound, the types they accept. + +### Turbofish + +Paths with generic parameters in expressions must prefix the opening brackets with a `::`. +Combined with the angular brackets for generics, this looks like a fish `::<>`. +As such, this syntax is colloquially referred to as turbofish syntax. + +Examples: + +```rust +let ok_num = Ok::<_, ()>(5); +let vec = [1, 2, 3].iter().map(|n| n * 2).collect::>(); +``` + +This `::` prefix is required to disambiguate generic paths with multiple comparisons in a comma-separate list. +See [the bastion of the turbofish][turbofish test] for an example where not having the prefix would be ambiguous. + +### Uncovered type + +A type which does not appear as an argument to another type. For example, +`T` is uncovered, but the `T` in `Vec` is covered. This is only relevant for +type arguments. + +### Undefined behavior + +Compile-time or run-time behavior that is not specified. This may result in, +but is not limited to: process termination or corruption; improper, incorrect, +or unintended computation; or platform-specific results. +[More][undefined-behavior]. + +### Uninhabited + +A type is uninhabited if it has no constructors and therefore can never be instantiated. An +uninhabited type is "empty" in the sense that there are no values of the type. The canonical +example of an uninhabited type is the [never type] `!`, or an enum with no variants +`enum Never { }`. Opposite of [Inhabited](#inhabited). + +[alignment]: type-layout.md#size-and-alignment +[associated item]: #associated-item +[attributes]: attributes.md +[*entity*]: names.md +[crate]: crates-and-source-files.md +[enums]: items/enumerations.md +[fields]: expressions/field-expr.md +[free item]: #free-item +[generic parameters]: items/generics.md +[identifier]: identifiers.md +[identifiers]: identifiers.md +[implementation]: items/implementations.md +[implementations]: items/implementations.md +[inherent implementation]: items/implementations.md#inherent-implementations +[item]: items.md +[items]: items.md +[labels]: tokens.md#lifetimes-and-loop-labels +[lifetime or loop label]: tokens.md#lifetimes-and-loop-labels +[lifetimes]: tokens.md#lifetimes-and-loop-labels +[lints]: attributes/diagnostics.md#lint-check-attributes +[loop labels]: tokens.md#lifetimes-and-loop-labels +[method]: items/associated-items.md#methods +[modules]: items/modules.md +[*Name resolution*]: names/name-resolution.md +[*name*]: names.md +[*namespace*]: names/namespaces.md +[never type]: types/never.md +[object safety]: items/traits.md#object-safety +[*path*]: paths.md +[Paths]: paths.md +[*scope*]: names/scopes.md +[structs]: items/structs.md +[trait objects]: types/trait-object.md +[traits]: items/traits.md +[turbofish test]: https://github.com/rust-lang/rust/blob/1.58.0/src/test/ui/parser/bastion-of-the-turbofish.rs +[types of crates]: linkage.md +[types]: types.md +[undefined-behavior]: behavior-considered-undefined.md +[unions]: items/unions.md +[variable bindings]: patterns.md +[visibility rules]: visibility-and-privacy.md diff --git a/src/doc/reference/src/identifiers.md b/src/doc/reference/src/identifiers.md new file mode 100644 index 000000000..a4e972cd3 --- /dev/null +++ b/src/doc/reference/src/identifiers.md @@ -0,0 +1,72 @@ +# Identifiers + +> **Lexer:**\ +> IDENTIFIER_OR_KEYWORD :\ +>       XID_Start XID_Continue\*\ +>    | `_` XID_Continue+ +> +> RAW_IDENTIFIER : `r#` IDENTIFIER_OR_KEYWORD *Except `crate`, `self`, `super`, `Self`* +> +> NON_KEYWORD_IDENTIFIER : IDENTIFIER_OR_KEYWORD *Except a [strict] or [reserved] keyword* +> +> IDENTIFIER :\ +> NON_KEYWORD_IDENTIFIER | RAW_IDENTIFIER + + +Identifiers follow the specification in [Unicode Standard Annex #31][UAX31] for Unicode version 13.0, with the additions described below. Some examples of identifiers: + +* `foo` +* `_identifier` +* `r#true` +* `Москва` +* `東京` + +The profile used from UAX #31 is: + +* Start := [`XID_Start`], plus the underscore character (U+005F) +* Continue := [`XID_Continue`] +* Medial := empty + +with the additional constraint that a single underscore character is not an identifier. + +> **Note**: Identifiers starting with an underscore are typically used to indicate an identifier that is intentionally unused, and will silence the unused warning in `rustc`. + +Identifiers may not be a [strict] or [reserved] keyword without the `r#` prefix described below in [raw identifiers](#raw-identifiers). + +Zero width non-joiner (ZWNJ U+200C) and zero width joiner (ZWJ U+200D) characters are not allowed in identifiers. + +Identifiers are restricted to the ASCII subset of [`XID_Start`] and [`XID_Continue`] in the following situations: + +* [`extern crate`] declarations +* External crate names referenced in a [path] +* [Module] names loaded from the filesystem without a [`path` attribute] +* [`no_mangle`] attributed items +* Item names in [external blocks] + +## Normalization + +Identifiers are normalized using Normalization Form C (NFC) as defined in [Unicode Standard Annex #15][UAX15]. Two identifiers are equal if their NFC forms are equal. + +[Procedural][proc-macro] and [declarative][mbe] macros receive normalized identifiers in their input. + +## Raw identifiers + +A raw identifier is like a normal identifier, but prefixed by `r#`. (Note that +the `r#` prefix is not included as part of the actual identifier.) +Unlike a normal identifier, a raw identifier may be any strict or reserved +keyword except the ones listed above for `RAW_IDENTIFIER`. + +[`extern crate`]: items/extern-crates.md +[`no_mangle`]: abi.md#the-no_mangle-attribute +[`path` attribute]: items/modules.md#the-path-attribute +[`XID_Continue`]: http://unicode.org/cldr/utility/list-unicodeset.jsp?a=%5B%3AXID_Continue%3A%5D&abb=on&g=&i= +[`XID_Start`]: http://unicode.org/cldr/utility/list-unicodeset.jsp?a=%5B%3AXID_Start%3A%5D&abb=on&g=&i= +[external blocks]: items/external-blocks.md +[mbe]: macros-by-example.md +[module]: items/modules.md +[path]: paths.md +[proc-macro]: procedural-macros.md +[reserved]: keywords.md#reserved-keywords +[strict]: keywords.md#strict-keywords +[UAX15]: https://www.unicode.org/reports/tr15/tr15-50.html +[UAX31]: https://www.unicode.org/reports/tr31/tr31-33.html diff --git a/src/doc/reference/src/influences.md b/src/doc/reference/src/influences.md new file mode 100644 index 000000000..3aa812abe --- /dev/null +++ b/src/doc/reference/src/influences.md @@ -0,0 +1,22 @@ +# Influences + +Rust is not a particularly original language, with design elements coming from +a wide range of sources. Some of these are listed below (including elements +that have since been removed): + +* SML, OCaml: algebraic data types, pattern matching, type inference, + semicolon statement separation +* C++: references, RAII, smart pointers, move semantics, monomorphization, + memory model +* ML Kit, Cyclone: region based memory management +* Haskell (GHC): typeclasses, type families +* Newsqueak, Alef, Limbo: channels, concurrency +* Erlang: message passing, thread failure, linked thread failure, + lightweight concurrency +* Swift: optional bindings +* Scheme: hygienic macros +* C#: attributes +* Ruby: closure syntax, block syntax +* NIL, Hermes: typestate +* [Unicode Annex #31](http://www.unicode.org/reports/tr31/): identifier and + pattern syntax diff --git a/src/doc/reference/src/inline-assembly.md b/src/doc/reference/src/inline-assembly.md new file mode 100644 index 000000000..6233475a3 --- /dev/null +++ b/src/doc/reference/src/inline-assembly.md @@ -0,0 +1,614 @@ +# Inline assembly + +Support for inline assembly is provided via the [`asm!`] and [`global_asm!`] macros. +It can be used to embed handwritten assembly in the assembly output generated by the compiler. + +[`asm!`]: ../core/arch/macro.asm.html +[`global_asm!`]: ../core/arch/macro.global_asm.html + +Support for inline assembly is stable on the following architectures: +- x86 and x86-64 +- ARM +- AArch64 +- RISC-V + +The compiler will emit an error if `asm!` is used on an unsupported target. + +## Example + +```rust +use std::arch::asm; + +// Multiply x by 6 using shifts and adds +let mut x: u64 = 4; +unsafe { + asm!( + "mov {tmp}, {x}", + "shl {tmp}, 1", + "shl {x}, 2", + "add {x}, {tmp}", + x = inout(reg) x, + tmp = out(reg) _, + ); +} +assert_eq!(x, 4 * 6); +``` + +## Syntax + +The following ABNF specifies the general syntax: + +```text +format_string := STRING_LITERAL / RAW_STRING_LITERAL +dir_spec := "in" / "out" / "lateout" / "inout" / "inlateout" +reg_spec := / "\"" "\"" +operand_expr := expr / "_" / expr "=>" expr / expr "=>" "_" +reg_operand := dir_spec "(" reg_spec ")" operand_expr +operand := reg_operand +clobber_abi := "clobber_abi(" *("," ) [","] ")" +option := "pure" / "nomem" / "readonly" / "preserves_flags" / "noreturn" / "nostack" / "att_syntax" / "raw" +options := "options(" option *("," option) [","] ")" +asm := "asm!(" format_string *("," format_string) *("," [ident "="] operand) *("," clobber_abi) *("," options) [","] ")" +global_asm := "global_asm!(" format_string *("," format_string) *("," [ident "="] operand) *("," options) [","] ")" +``` + + +## Scope + +Inline assembly can be used in one of two ways. + +With the `asm!` macro, the assembly code is emitted in a function scope and integrated into the compiler-generated assembly code of a function. +This assembly code must obey [strict rules](#rules-for-inline-assembly) to avoid undefined behavior. +Note that in some cases the compiler may choose to emit the assembly code as a separate function and generate a call to it. + +With the `global_asm!` macro, the assembly code is emitted in a global scope, outside a function. +This can be used to hand-write entire functions using assembly code, and generally provides much more freedom to use arbitrary registers and assembler directives. + +## Template string arguments + +The assembler template uses the same syntax as [format strings][format-syntax] (i.e. placeholders are specified by curly braces). +The corresponding arguments are accessed in order, by index, or by name. +However, implicit named arguments (introduced by [RFC #2795][rfc-2795]) are not supported. + +An `asm!` invocation may have one or more template string arguments; an `asm!` with multiple template string arguments is treated as if all the strings were concatenated with a `\n` between them. +The expected usage is for each template string argument to correspond to a line of assembly code. +All template string arguments must appear before any other arguments. + +As with format strings, named arguments must appear after positional arguments. +Explicit [register operands](#register-operands) must appear at the end of the operand list, after named arguments if any. + +Explicit register operands cannot be used by placeholders in the template string. +All other named and positional operands must appear at least once in the template string, otherwise a compiler error is generated. + +The exact assembly code syntax is target-specific and opaque to the compiler except for the way operands are substituted into the template string to form the code passed to the assembler. + +Currently, all supported targets follow the assembly code syntax used by LLVM's internal assembler which usually corresponds to that of the GNU assembler (GAS). +On x86, the `.intel_syntax noprefix` mode of GAS is used by default. +On ARM, the `.syntax unified` mode is used. +These targets impose an additional restriction on the assembly code: any assembler state (e.g. the current section which can be changed with `.section`) must be restored to its original value at the end of the asm string. +Assembly code that does not conform to the GAS syntax will result in assembler-specific behavior. +Further constraints on the directives used by inline assembly are indicated by [Directives Support](#directives-support). + +[format-syntax]: ../std/fmt/index.html#syntax +[rfc-2795]: https://github.com/rust-lang/rfcs/pull/2795 + +## Operand type + +Several types of operands are supported: + +* `in() ` + - `` can refer to a register class or an explicit register. + The allocated register name is substituted into the asm template string. + - The allocated register will contain the value of `` at the start of the asm code. + - The allocated register must contain the same value at the end of the asm code (except if a `lateout` is allocated to the same register). +* `out() ` + - `` can refer to a register class or an explicit register. + The allocated register name is substituted into the asm template string. + - The allocated register will contain an undefined value at the start of the asm code. + - `` must be a (possibly uninitialized) place expression, to which the contents of the allocated register are written at the end of the asm code. + - An underscore (`_`) may be specified instead of an expression, which will cause the contents of the register to be discarded at the end of the asm code (effectively acting as a clobber). +* `lateout() ` + - Identical to `out` except that the register allocator can reuse a register allocated to an `in`. + - You should only write to the register after all inputs are read, otherwise you may clobber an input. +* `inout() ` + - `` can refer to a register class or an explicit register. + The allocated register name is substituted into the asm template string. + - The allocated register will contain the value of `` at the start of the asm code. + - `` must be a mutable initialized place expression, to which the contents of the allocated register are written at the end of the asm code. +* `inout() => ` + - Same as `inout` except that the initial value of the register is taken from the value of ``. + - `` must be a (possibly uninitialized) place expression, to which the contents of the allocated register are written at the end of the asm code. + - An underscore (`_`) may be specified instead of an expression for ``, which will cause the contents of the register to be discarded at the end of the asm code (effectively acting as a clobber). + - `` and `` may have different types. +* `inlateout() ` / `inlateout() => ` + - Identical to `inout` except that the register allocator can reuse a register allocated to an `in` (this can happen if the compiler knows the `in` has the same initial value as the `inlateout`). + - You should only write to the register after all inputs are read, otherwise you may clobber an input. + +Operand expressions are evaluated from left to right, just like function call arguments. +After the `asm!` has executed, outputs are written to in left to right order. +This is significant if two outputs point to the same place: that place will contain the value of the rightmost output. + +Since `global_asm!` exists outside a function, it cannot use input/output operands. + +## Register operands + +Input and output operands can be specified either as an explicit register or as a register class from which the register allocator can select a register. +Explicit registers are specified as string literals (e.g. `"eax"`) while register classes are specified as identifiers (e.g. `reg`). + +Note that explicit registers treat register aliases (e.g. `r14` vs `lr` on ARM) and smaller views of a register (e.g. `eax` vs `rax`) as equivalent to the base register. +It is a compile-time error to use the same explicit register for two input operands or two output operands. +Additionally, it is also a compile-time error to use overlapping registers (e.g. ARM VFP) in input operands or in output operands. + +Only the following types are allowed as operands for inline assembly: +- Integers (signed and unsigned) +- Floating-point numbers +- Pointers (thin only) +- Function pointers +- SIMD vectors (structs defined with `#[repr(simd)]` and which implement `Copy`). +This includes architecture-specific vector types defined in `std::arch` such as `__m128` (x86) or `int8x16_t` (ARM). + +Here is the list of currently supported register classes: + +| Architecture | Register class | Registers | LLVM constraint code | +| ------------ | -------------- | --------- | -------------------- | +| x86 | `reg` | `ax`, `bx`, `cx`, `dx`, `si`, `di`, `bp`, `r[8-15]` (x86-64 only) | `r` | +| x86 | `reg_abcd` | `ax`, `bx`, `cx`, `dx` | `Q` | +| x86-32 | `reg_byte` | `al`, `bl`, `cl`, `dl`, `ah`, `bh`, `ch`, `dh` | `q` | +| x86-64 | `reg_byte`\* | `al`, `bl`, `cl`, `dl`, `sil`, `dil`, `bpl`, `r[8-15]b` | `q` | +| x86 | `xmm_reg` | `xmm[0-7]` (x86) `xmm[0-15]` (x86-64) | `x` | +| x86 | `ymm_reg` | `ymm[0-7]` (x86) `ymm[0-15]` (x86-64) | `x` | +| x86 | `zmm_reg` | `zmm[0-7]` (x86) `zmm[0-31]` (x86-64) | `v` | +| x86 | `kreg` | `k[1-7]` | `Yk` | +| x86 | `kreg0` | `k0` | Only clobbers | +| x86 | `x87_reg` | `st([0-7])` | Only clobbers | +| x86 | `mmx_reg` | `mm[0-7]` | Only clobbers | +| x86-64 | `tmm_reg` | `tmm[0-7]` | Only clobbers | +| AArch64 | `reg` | `x[0-30]` | `r` | +| AArch64 | `vreg` | `v[0-31]` | `w` | +| AArch64 | `vreg_low16` | `v[0-15]` | `x` | +| AArch64 | `preg` | `p[0-15]`, `ffr` | Only clobbers | +| ARM (ARM/Thumb2) | `reg` | `r[0-12]`, `r14` | `r` | +| ARM (Thumb1) | `reg` | `r[0-7]` | `r` | +| ARM | `sreg` | `s[0-31]` | `t` | +| ARM | `sreg_low16` | `s[0-15]` | `x` | +| ARM | `dreg` | `d[0-31]` | `w` | +| ARM | `dreg_low16` | `d[0-15]` | `t` | +| ARM | `dreg_low8` | `d[0-8]` | `x` | +| ARM | `qreg` | `q[0-15]` | `w` | +| ARM | `qreg_low8` | `q[0-7]` | `t` | +| ARM | `qreg_low4` | `q[0-3]` | `x` | +| RISC-V | `reg` | `x1`, `x[5-7]`, `x[9-15]`, `x[16-31]` (non-RV32E) | `r` | +| RISC-V | `freg` | `f[0-31]` | `f` | +| RISC-V | `vreg` | `v[0-31]` | Only clobbers | + +> **Notes**: +> - On x86 we treat `reg_byte` differently from `reg` because the compiler can allocate `al` and `ah` separately whereas `reg` reserves the whole register. +> +> - On x86-64 the high byte registers (e.g. `ah`) are not available in the `reg_byte` register class. +> +> - Some register classes are marked as "Only clobbers" which means that registers in these classes cannot be used for inputs or outputs, only clobbers of the form `out() _` or `lateout() _`. + +Each register class has constraints on which value types they can be used with. +This is necessary because the way a value is loaded into a register depends on its type. +For example, on big-endian systems, loading a `i32x4` and a `i8x16` into a SIMD register may result in different register contents even if the byte-wise memory representation of both values is identical. +The availability of supported types for a particular register class may depend on what target features are currently enabled. + +| Architecture | Register class | Target feature | Allowed types | +| ------------ | -------------- | -------------- | ------------- | +| x86-32 | `reg` | None | `i16`, `i32`, `f32` | +| x86-64 | `reg` | None | `i16`, `i32`, `f32`, `i64`, `f64` | +| x86 | `reg_byte` | None | `i8` | +| x86 | `xmm_reg` | `sse` | `i32`, `f32`, `i64`, `f64`,
`i8x16`, `i16x8`, `i32x4`, `i64x2`, `f32x4`, `f64x2` | +| x86 | `ymm_reg` | `avx` | `i32`, `f32`, `i64`, `f64`,
`i8x16`, `i16x8`, `i32x4`, `i64x2`, `f32x4`, `f64x2`
`i8x32`, `i16x16`, `i32x8`, `i64x4`, `f32x8`, `f64x4` | +| x86 | `zmm_reg` | `avx512f` | `i32`, `f32`, `i64`, `f64`,
`i8x16`, `i16x8`, `i32x4`, `i64x2`, `f32x4`, `f64x2`
`i8x32`, `i16x16`, `i32x8`, `i64x4`, `f32x8`, `f64x4`
`i8x64`, `i16x32`, `i32x16`, `i64x8`, `f32x16`, `f64x8` | +| x86 | `kreg` | `avx512f` | `i8`, `i16` | +| x86 | `kreg` | `avx512bw` | `i32`, `i64` | +| x86 | `mmx_reg` | N/A | Only clobbers | +| x86 | `x87_reg` | N/A | Only clobbers | +| x86 | `tmm_reg` | N/A | Only clobbers | +| AArch64 | `reg` | None | `i8`, `i16`, `i32`, `f32`, `i64`, `f64` | +| AArch64 | `vreg` | `neon` | `i8`, `i16`, `i32`, `f32`, `i64`, `f64`,
`i8x8`, `i16x4`, `i32x2`, `i64x1`, `f32x2`, `f64x1`,
`i8x16`, `i16x8`, `i32x4`, `i64x2`, `f32x4`, `f64x2` | +| AArch64 | `preg` | N/A | Only clobbers | +| ARM | `reg` | None | `i8`, `i16`, `i32`, `f32` | +| ARM | `sreg` | `vfp2` | `i32`, `f32` | +| ARM | `dreg` | `vfp2` | `i64`, `f64`, `i8x8`, `i16x4`, `i32x2`, `i64x1`, `f32x2` | +| ARM | `qreg` | `neon` | `i8x16`, `i16x8`, `i32x4`, `i64x2`, `f32x4` | +| RISC-V32 | `reg` | None | `i8`, `i16`, `i32`, `f32` | +| RISC-V64 | `reg` | None | `i8`, `i16`, `i32`, `f32`, `i64`, `f64` | +| RISC-V | `freg` | `f` | `f32` | +| RISC-V | `freg` | `d` | `f64` | +| RISC-V | `vreg` | N/A | Only clobbers | + +> **Note**: For the purposes of the above table pointers, function pointers and `isize`/`usize` are treated as the equivalent integer type (`i16`/`i32`/`i64` depending on the target). + +If a value is of a smaller size than the register it is allocated in then the upper bits of that register will have an undefined value for inputs and will be ignored for outputs. +The only exception is the `freg` register class on RISC-V where `f32` values are NaN-boxed in a `f64` as required by the RISC-V architecture. + +When separate input and output expressions are specified for an `inout` operand, both expressions must have the same type. +The only exception is if both operands are pointers or integers, in which case they are only required to have the same size. +This restriction exists because the register allocators in LLVM and GCC sometimes cannot handle tied operands with different types. + +## Register names + +Some registers have multiple names. +These are all treated by the compiler as identical to the base register name. +Here is the list of all supported register aliases: + +| Architecture | Base register | Aliases | +| ------------ | ------------- | ------- | +| x86 | `ax` | `eax`, `rax` | +| x86 | `bx` | `ebx`, `rbx` | +| x86 | `cx` | `ecx`, `rcx` | +| x86 | `dx` | `edx`, `rdx` | +| x86 | `si` | `esi`, `rsi` | +| x86 | `di` | `edi`, `rdi` | +| x86 | `bp` | `bpl`, `ebp`, `rbp` | +| x86 | `sp` | `spl`, `esp`, `rsp` | +| x86 | `ip` | `eip`, `rip` | +| x86 | `st(0)` | `st` | +| x86 | `r[8-15]` | `r[8-15]b`, `r[8-15]w`, `r[8-15]d` | +| x86 | `xmm[0-31]` | `ymm[0-31]`, `zmm[0-31]` | +| AArch64 | `x[0-30]` | `w[0-30]` | +| AArch64 | `x29` | `fp` | +| AArch64 | `x30` | `lr` | +| AArch64 | `sp` | `wsp` | +| AArch64 | `xzr` | `wzr` | +| AArch64 | `v[0-31]` | `b[0-31]`, `h[0-31]`, `s[0-31]`, `d[0-31]`, `q[0-31]` | +| ARM | `r[0-3]` | `a[1-4]` | +| ARM | `r[4-9]` | `v[1-6]` | +| ARM | `r9` | `rfp` | +| ARM | `r10` | `sl` | +| ARM | `r11` | `fp` | +| ARM | `r12` | `ip` | +| ARM | `r13` | `sp` | +| ARM | `r14` | `lr` | +| ARM | `r15` | `pc` | +| RISC-V | `x0` | `zero` | +| RISC-V | `x1` | `ra` | +| RISC-V | `x2` | `sp` | +| RISC-V | `x3` | `gp` | +| RISC-V | `x4` | `tp` | +| RISC-V | `x[5-7]` | `t[0-2]` | +| RISC-V | `x8` | `fp`, `s0` | +| RISC-V | `x9` | `s1` | +| RISC-V | `x[10-17]` | `a[0-7]` | +| RISC-V | `x[18-27]` | `s[2-11]` | +| RISC-V | `x[28-31]` | `t[3-6]` | +| RISC-V | `f[0-7]` | `ft[0-7]` | +| RISC-V | `f[8-9]` | `fs[0-1]` | +| RISC-V | `f[10-17]` | `fa[0-7]` | +| RISC-V | `f[18-27]` | `fs[2-11]` | +| RISC-V | `f[28-31]` | `ft[8-11]` | + +Some registers cannot be used for input or output operands: + +| Architecture | Unsupported register | Reason | +| ------------ | -------------------- | ------ | +| All | `sp` | The stack pointer must be restored to its original value at the end of an asm code block. | +| All | `bp` (x86), `x29` (AArch64), `x8` (RISC-V) | The frame pointer cannot be used as an input or output. | +| ARM | `r7` or `r11` | On ARM the frame pointer can be either `r7` or `r11` depending on the target. The frame pointer cannot be used as an input or output. | +| All | `si` (x86-32), `bx` (x86-64), `r6` (ARM), `x19` (AArch64), `x9` (RISC-V) | This is used internally by LLVM as a "base pointer" for functions with complex stack frames. | +| x86 | `ip` | This is the program counter, not a real register. | +| AArch64 | `xzr` | This is a constant zero register which can't be modified. | +| AArch64 | `x18` | This is an OS-reserved register on some AArch64 targets. | +| ARM | `pc` | This is the program counter, not a real register. | +| ARM | `r9` | This is an OS-reserved register on some ARM targets. | +| RISC-V | `x0` | This is a constant zero register which can't be modified. | +| RISC-V | `gp`, `tp` | These registers are reserved and cannot be used as inputs or outputs. | + +The frame pointer and base pointer registers are reserved for internal use by LLVM. While `asm!` statements cannot explicitly specify the use of reserved registers, in some cases LLVM will allocate one of these reserved registers for `reg` operands. Assembly code making use of reserved registers should be careful since `reg` operands may use the same registers. + +## Template modifiers + +The placeholders can be augmented by modifiers which are specified after the `:` in the curly braces. +These modifiers do not affect register allocation, but change the way operands are formatted when inserted into the template string. +Only one modifier is allowed per template placeholder. + +The supported modifiers are a subset of LLVM's (and GCC's) [asm template argument modifiers][llvm-argmod], but do not use the same letter codes. + +| Architecture | Register class | Modifier | Example output | LLVM modifier | +| ------------ | -------------- | -------- | -------------- | ------------- | +| x86-32 | `reg` | None | `eax` | `k` | +| x86-64 | `reg` | None | `rax` | `q` | +| x86-32 | `reg_abcd` | `l` | `al` | `b` | +| x86-64 | `reg` | `l` | `al` | `b` | +| x86 | `reg_abcd` | `h` | `ah` | `h` | +| x86 | `reg` | `x` | `ax` | `w` | +| x86 | `reg` | `e` | `eax` | `k` | +| x86-64 | `reg` | `r` | `rax` | `q` | +| x86 | `reg_byte` | None | `al` / `ah` | None | +| x86 | `xmm_reg` | None | `xmm0` | `x` | +| x86 | `ymm_reg` | None | `ymm0` | `t` | +| x86 | `zmm_reg` | None | `zmm0` | `g` | +| x86 | `*mm_reg` | `x` | `xmm0` | `x` | +| x86 | `*mm_reg` | `y` | `ymm0` | `t` | +| x86 | `*mm_reg` | `z` | `zmm0` | `g` | +| x86 | `kreg` | None | `k1` | None | +| AArch64 | `reg` | None | `x0` | `x` | +| AArch64 | `reg` | `w` | `w0` | `w` | +| AArch64 | `reg` | `x` | `x0` | `x` | +| AArch64 | `vreg` | None | `v0` | None | +| AArch64 | `vreg` | `v` | `v0` | None | +| AArch64 | `vreg` | `b` | `b0` | `b` | +| AArch64 | `vreg` | `h` | `h0` | `h` | +| AArch64 | `vreg` | `s` | `s0` | `s` | +| AArch64 | `vreg` | `d` | `d0` | `d` | +| AArch64 | `vreg` | `q` | `q0` | `q` | +| ARM | `reg` | None | `r0` | None | +| ARM | `sreg` | None | `s0` | None | +| ARM | `dreg` | None | `d0` | `P` | +| ARM | `qreg` | None | `q0` | `q` | +| ARM | `qreg` | `e` / `f` | `d0` / `d1` | `e` / `f` | +| RISC-V | `reg` | None | `x1` | None | +| RISC-V | `freg` | None | `f0` | None | + +> **Notes**: +> - on ARM `e` / `f`: this prints the low or high doubleword register name of a NEON quad (128-bit) register. +> - on x86: our behavior for `reg` with no modifiers differs from what GCC does. +> GCC will infer the modifier based on the operand value type, while we default to the full register size. +> - on x86 `xmm_reg`: the `x`, `t` and `g` LLVM modifiers are not yet implemented in LLVM (they are supported by GCC only), but this should be a simple change. + +As stated in the previous section, passing an input value smaller than the register width will result in the upper bits of the register containing undefined values. +This is not a problem if the inline asm only accesses the lower bits of the register, which can be done by using a template modifier to use a subregister name in the asm code (e.g. `ax` instead of `rax`). +Since this an easy pitfall, the compiler will suggest a template modifier to use where appropriate given the input type. +If all references to an operand already have modifiers then the warning is suppressed for that operand. + +[llvm-argmod]: http://llvm.org/docs/LangRef.html#asm-template-argument-modifiers + +## ABI clobbers + +The `clobber_abi` keyword can be used to apply a default set of clobbers to an `asm!` block. +This will automatically insert the necessary clobber constraints as needed for calling a function with a particular calling convention: if the calling convention does not fully preserve the value of a register across a call then `lateout("...") _` is implicitly added to the operands list (where the `...` is replaced by the register's name). + +`clobber_abi` may be specified any number of times. It will insert a clobber for all unique registers in the union of all specified calling conventions. + +Generic register class outputs are disallowed by the compiler when `clobber_abi` is used: all outputs must specify an explicit register. +Explicit register outputs have precedence over the implicit clobbers inserted by `clobber_abi`: a clobber will only be inserted for a register if that register is not used as an output. +The following ABIs can be used with `clobber_abi`: + +| Architecture | ABI name | Clobbered registers | +| ------------ | -------- | ------------------- | +| x86-32 | `"C"`, `"system"`, `"efiapi"`, `"cdecl"`, `"stdcall"`, `"fastcall"` | `ax`, `cx`, `dx`, `xmm[0-7]`, `mm[0-7]`, `k[0-7]`, `st([0-7])` | +| x86-64 | `"C"`, `"system"` (on Windows), `"efiapi"`, `"win64"` | `ax`, `cx`, `dx`, `r[8-11]`, `xmm[0-31]`, `mm[0-7]`, `k[0-7]`, `st([0-7])`, `tmm[0-7]` | +| x86-64 | `"C"`, `"system"` (on non-Windows), `"sysv64"` | `ax`, `cx`, `dx`, `si`, `di`, `r[8-11]`, `xmm[0-31]`, `mm[0-7]`, `k[0-7]`, `st([0-7])`, `tmm[0-7]` | +| AArch64 | `"C"`, `"system"`, `"efiapi"` | `x[0-17]`, `x18`\*, `x30`, `v[0-31]`, `p[0-15]`, `ffr` | +| ARM | `"C"`, `"system"`, `"efiapi"`, `"aapcs"` | `r[0-3]`, `r12`, `r14`, `s[0-15]`, `d[0-7]`, `d[16-31]` | +| RISC-V | `"C"`, `"system"`, `"efiapi"` | `x1`, `x[5-7]`, `x[10-17]`, `x[28-31]`, `f[0-7]`, `f[10-17]`, `f[28-31]`, `v[0-31]` | + +> Notes: +> - On AArch64 `x18` only included in the clobber list if it is not considered as a reserved register on the target. + +The list of clobbered registers for each ABI is updated in rustc as architectures gain new registers: this ensures that `asm!` clobbers will continue to be correct when LLVM starts using these new registers in its generated code. + +## Options + +Flags are used to further influence the behavior of the inline assembly block. +Currently the following options are defined: +- `pure`: The `asm!` block has no side effects, and its outputs depend only on its direct inputs (i.e. the values themselves, not what they point to) or values read from memory (unless the `nomem` options is also set). + This allows the compiler to execute the `asm!` block fewer times than specified in the program (e.g. by hoisting it out of a loop) or even eliminate it entirely if the outputs are not used. +- `nomem`: The `asm!` blocks does not read or write to any memory. + This allows the compiler to cache the values of modified global variables in registers across the `asm!` block since it knows that they are not read or written to by the `asm!`. +- `readonly`: The `asm!` block does not write to any memory. + This allows the compiler to cache the values of unmodified global variables in registers across the `asm!` block since it knows that they are not written to by the `asm!`. +- `preserves_flags`: The `asm!` block does not modify the flags register (defined in the rules below). + This allows the compiler to avoid recomputing the condition flags after the `asm!` block. +- `noreturn`: The `asm!` block never returns, and its return type is defined as `!` (never). + Behavior is undefined if execution falls through past the end of the asm code. + A `noreturn` asm block behaves just like a function which doesn't return; notably, local variables in scope are not dropped before it is invoked. +- `nostack`: The `asm!` block does not push data to the stack, or write to the stack red-zone (if supported by the target). + If this option is *not* used then the stack pointer is guaranteed to be suitably aligned (according to the target ABI) for a function call. +- `att_syntax`: This option is only valid on x86, and causes the assembler to use the `.att_syntax prefix` mode of the GNU assembler. + Register operands are substituted in with a leading `%`. +- `raw`: This causes the template string to be parsed as a raw assembly string, with no special handling for `{` and `}`. + This is primarily useful when including raw assembly code from an external file using `include_str!`. + +The compiler performs some additional checks on options: +- The `nomem` and `readonly` options are mutually exclusive: it is a compile-time error to specify both. +- The `pure` option must be combined with either the `nomem` or `readonly` options, otherwise a compile-time error is emitted. +- It is a compile-time error to specify `pure` on an asm block with no outputs or only discarded outputs (`_`). +- It is a compile-time error to specify `noreturn` on an asm block with outputs. + +`global_asm!` only supports the `att_syntax` and `raw` options. +The remaining options are not meaningful for global-scope inline assembly + +## Rules for inline assembly + +To avoid undefined behavior, these rules must be followed when using function-scope inline assembly (`asm!`): + +- Any registers not specified as inputs will contain an undefined value on entry to the asm block. + - An "undefined value" in the context of inline assembly means that the register can (non-deterministically) have any one of the possible values allowed by the architecture. + Notably it is not the same as an LLVM `undef` which can have a different value every time you read it (since such a concept does not exist in assembly code). +- Any registers not specified as outputs must have the same value upon exiting the asm block as they had on entry, otherwise behavior is undefined. + - This only applies to registers which can be specified as an input or output. + Other registers follow target-specific rules. + - Note that a `lateout` may be allocated to the same register as an `in`, in which case this rule does not apply. + Code should not rely on this however since it depends on the results of register allocation. +- Behavior is undefined if execution unwinds out of an asm block. + - This also applies if the assembly code calls a function which then unwinds. +- The set of memory locations that assembly code is allowed to read and write are the same as those allowed for an FFI function. + - Refer to the unsafe code guidelines for the exact rules. + - If the `readonly` option is set, then only memory reads are allowed. + - If the `nomem` option is set then no reads or writes to memory are allowed. + - These rules do not apply to memory which is private to the asm code, such as stack space allocated within the asm block. +- The compiler cannot assume that the instructions in the asm are the ones that will actually end up executed. + - This effectively means that the compiler must treat the `asm!` as a black box and only take the interface specification into account, not the instructions themselves. + - Runtime code patching is allowed, via target-specific mechanisms. +- Unless the `nostack` option is set, asm code is allowed to use stack space below the stack pointer. + - On entry to the asm block the stack pointer is guaranteed to be suitably aligned (according to the target ABI) for a function call. + - You are responsible for making sure you don't overflow the stack (e.g. use stack probing to ensure you hit a guard page). + - You should adjust the stack pointer when allocating stack memory as required by the target ABI. + - The stack pointer must be restored to its original value before leaving the asm block. +- If the `noreturn` option is set then behavior is undefined if execution falls through to the end of the asm block. +- If the `pure` option is set then behavior is undefined if the `asm!` has side-effects other than its direct outputs. + Behavior is also undefined if two executions of the `asm!` code with the same inputs result in different outputs. + - When used with the `nomem` option, "inputs" are just the direct inputs of the `asm!`. + - When used with the `readonly` option, "inputs" comprise the direct inputs of the `asm!` and any memory that the `asm!` block is allowed to read. +- These flags registers must be restored upon exiting the asm block if the `preserves_flags` option is set: + - x86 + - Status flags in `EFLAGS` (CF, PF, AF, ZF, SF, OF). + - Floating-point status word (all). + - Floating-point exception flags in `MXCSR` (PE, UE, OE, ZE, DE, IE). + - ARM + - Condition flags in `CPSR` (N, Z, C, V) + - Saturation flag in `CPSR` (Q) + - Greater than or equal flags in `CPSR` (GE). + - Condition flags in `FPSCR` (N, Z, C, V) + - Saturation flag in `FPSCR` (QC) + - Floating-point exception flags in `FPSCR` (IDC, IXC, UFC, OFC, DZC, IOC). + - AArch64 + - Condition flags (`NZCV` register). + - Floating-point status (`FPSR` register). + - RISC-V + - Floating-point exception flags in `fcsr` (`fflags`). + - Vector extension state (`vtype`, `vl`, `vcsr`). +- On x86, the direction flag (DF in `EFLAGS`) is clear on entry to an asm block and must be clear on exit. + - Behavior is undefined if the direction flag is set on exiting an asm block. +- On x86, the x87 floating-point register stack must remain unchanged unless all of the `st([0-7])` registers have been marked as clobbered with `out("st(0)") _, out("st(1)") _, ...`. + - If all x87 registers are clobbered then the x87 register stack is guaranteed to be empty upon entering an `asm` block. Assembly code must ensure that the x87 register stack is also empty when exiting the asm block. +- The requirement of restoring the stack pointer and non-output registers to their original value only applies when exiting an `asm!` block. + - This means that `asm!` blocks that never return (even if not marked `noreturn`) don't need to preserve these registers. + - When returning to a different `asm!` block than you entered (e.g. for context switching), these registers must contain the value they had upon entering the `asm!` block that you are *exiting*. + - You cannot exit an `asm!` block that has not been entered. + Neither can you exit an `asm!` block that has already been exited (without first entering it again). + - You are responsible for switching any target-specific state (e.g. thread-local storage, stack bounds). + - You cannot jump from an address in one `asm!` block to an address in another, even within the same function or block, without treating their contexts as potentially different and requiring context switching. You cannot assume that any particular value in those contexts (e.g. current stack pointer or temporary values below the stack pointer) will remain unchanged between the two `asm!` blocks. + - The set of memory locations that you may access is the intersection of those allowed by the `asm!` blocks you entered and exited. +- You cannot assume that two `asm!` blocks adjacent in source code, even without any other code between them, will end up in successive addresses in the binary without any other instructions between them. +- You cannot assume that an `asm!` block will appear exactly once in the output binary. + The compiler is allowed to instantiate multiple copies of the `asm!` block, for example when the function containing it is inlined in multiple places. +- On x86, inline assembly must not end with an instruction prefix (such as `LOCK`) that would apply to instructions generated by the compiler. + - The compiler is currently unable to detect this due to the way inline assembly is compiled, but may catch and reject this in the future. + +> **Note**: As a general rule, the flags covered by `preserves_flags` are those which are *not* preserved when performing a function call. + +### Directives Support + +Inline assembly supports a subset of the directives supported by both GNU AS and LLVM's internal assembler, given as follows. +The result of using other directives is assembler-specific (and may cause an error, or may be accepted as-is). + +If inline assembly includes any "stateful" directive that modifies how subsequent assembly is processed, the block must undo the effects of any such directives before the inline assembly ends. + +The following directives are guaranteed to be supported by the assembler: + +- `.2byte` +- `.4byte` +- `.8byte` +- `.align` +- `.ascii` +- `.asciz` +- `.alt_entry` +- `.balign` +- `.balignl` +- `.balignw` +- `.balign` +- `.balignl` +- `.balignw` +- `.bss` +- `.byte` +- `.comm` +- `.data` +- `.def` +- `.double` +- `.endef` +- `.equ` +- `.equiv` +- `.eqv` +- `.fill` +- `.float` +- `.globl` +- `.global` +- `.lcomm` +- `.inst` +- `.long` +- `.octa` +- `.option` +- `.private_extern` +- `.p2align` +- `.pushsection` +- `.popsection` +- `.quad` +- `.scl` +- `.section` +- `.set` +- `.short` +- `.size` +- `.skip` +- `.sleb128` +- `.space` +- `.string` +- `.text` +- `.type` +- `.uleb128` +- `.word` + + + +#### Target Specific Directive Support + +##### Dwarf Unwinding + +The following directives are supported on ELF targets that support DWARF unwind info: + + +- `.cfi_adjust_cfa_offset` +- `.cfi_def_cfa` +- `.cfi_def_cfa_offset` +- `.cfi_def_cfa_register` +- `.cfi_endproc` +- `.cfi_escape` +- `.cfi_lsda` +- `.cfi_offset` +- `.cfi_personality` +- `.cfi_register` +- `.cfi_rel_offset` +- `.cfi_remember_state` +- `.cfi_restore` +- `.cfi_restore_state` +- `.cfi_return_column` +- `.cfi_same_value` +- `.cfi_sections` +- `.cfi_signal_frame` +- `.cfi_startproc` +- `.cfi_undefined` +- `.cfi_window_save` + + +##### Structured Exception Handling + +On targets with structured exception Handling, the following additional directives are guaranteed to be supported: + +- `.seh_endproc` +- `.seh_endprologue` +- `.seh_proc` +- `.seh_pushreg` +- `.seh_savereg` +- `.seh_setframe` +- `.seh_stackalloc` + + +##### x86 (32-bit and 64-bit) + +On x86 targets, both 32-bit and 64-bit, the following additional directives are guaranteed to be supported: +- `.nops` +- `.code16` +- `.code32` +- `.code64` + + +Use of `.code16`, `.code32`, and `.code64` directives are only supported if the state is reset to the default before exiting the assembly block. +32-bit x86 uses `.code32` by default, and x86_64 uses `.code64` by default. + + + +##### ARM (32-bit) + +On ARM, the following additional directives are guaranteed to be supported: + +- `.even` +- `.fnstart` +- `.fnend` +- `.save` +- `.movsp` +- `.code` +- `.thumb` +- `.thumb_func` diff --git a/src/doc/reference/src/input-format.md b/src/doc/reference/src/input-format.md new file mode 100644 index 000000000..678902c93 --- /dev/null +++ b/src/doc/reference/src/input-format.md @@ -0,0 +1,3 @@ +# Input format + +Rust input is interpreted as a sequence of Unicode code points encoded in UTF-8. diff --git a/src/doc/reference/src/interior-mutability.md b/src/doc/reference/src/interior-mutability.md new file mode 100644 index 000000000..914600776 --- /dev/null +++ b/src/doc/reference/src/interior-mutability.md @@ -0,0 +1,29 @@ +# Interior Mutability + +Sometimes a type needs to be mutated while having multiple aliases. In Rust this +is achieved using a pattern called _interior mutability_. A type has interior +mutability if its internal state can be changed through a [shared reference] to +it. This goes against the usual [requirement][ub] that the value pointed to by a +shared reference is not mutated. + +[`std::cell::UnsafeCell`] type is the only allowed way to disable +this requirement. When `UnsafeCell` is immutably aliased, it is still safe to +mutate, or obtain a mutable reference to, the `T` it contains. As with all +other types, it is undefined behavior to have multiple `&mut UnsafeCell` +aliases. + +Other types with interior mutability can be created by using `UnsafeCell` as +a field. The standard library provides a variety of types that provide safe +interior mutability APIs. For example, [`std::cell::RefCell`] uses run-time +borrow checks to ensure the usual rules around multiple references. The +[`std::sync::atomic`] module contains types that wrap a value that is only +accessed with atomic operations, allowing the value to be shared and mutated +across threads. + +[shared reference]: types/pointer.md#shared-references- +[ub]: behavior-considered-undefined.md +[`std::cell::UnsafeCell`]: ../std/cell/struct.UnsafeCell.html +[`std::cell::RefCell`]: ../std/cell/struct.RefCell.html +[`std::sync::atomic`]: ../std/sync/atomic/index.html + + diff --git a/src/doc/reference/src/introduction.md b/src/doc/reference/src/introduction.md new file mode 100644 index 000000000..9038efd8d --- /dev/null +++ b/src/doc/reference/src/introduction.md @@ -0,0 +1,146 @@ +# Introduction + +This book is the primary reference for the Rust programming language. +It provides three kinds of material: + + - Chapters that informally describe each language construct and their use. + - Chapters that informally describe the memory model, concurrency model, runtime services, linkage model, and debugging facilities. + - Appendix chapters providing rationale and references to languages that influenced the design. + +
+ +Warning: +This book is incomplete. Documenting everything takes a while. +See the [GitHub issues] for what is not documented in this book. + +
+ +## Rust releases + +Rust has a new language release every six weeks. +The first stable release of the language was Rust 1.0.0, followed by Rust 1.1.0 and so on. +Tools (`rustc`, `cargo`, etc.) and documentation ([Standard library], this book, etc.) are released with the language release. + +The latest release of this book, matching the latest Rust version, can always be found at . +Prior versions can be found by adding the Rust version before the "reference" directory. +For example, the Reference for Rust 1.49.0 is located at . + +## What *The Reference* is not + +This book does not serve as an introduction to the language. +Background familiarity with the language is assumed. +A separate [book] is available to help acquire such background familiarity. + +This book also does not serve as a reference to the [standard library] included in the language distribution. +Those libraries are documented separately by extracting documentation attributes from their source code. +Many of the features that one might expect to be language features are library features in Rust, so what you're looking for may be there, not here. + +Similarly, this book does not usually document the specifics of `rustc` as a tool or of Cargo. +`rustc` has its own [book][rustc book]. +Cargo has a [book][cargo book] that contains a [reference][cargo reference]. +There are a few pages such as [linkage] that still describe how `rustc` works. + +This book also only serves as a reference to what is available in stable Rust. +For unstable features being worked on, see the [Unstable Book]. + +Rust compilers, including `rustc`, will perform optimizations. +The reference does not specify what optimizations are allowed or disallowed. +Instead, think of the compiled program as a black box. +You can only probe by running it, feeding it input and observing its output. +Everything that happens that way must conform to what the reference says. + +Finally, this book is not normative. +It may include details that are specific to `rustc` itself, and should not be taken as a specification for the Rust language. +We intend to produce such a book someday, and until then, the reference is the closest thing we have to one. + +## How to use this book + +This book does not assume you are reading this book sequentially. +Each chapter generally can be read standalone, but will cross-link to other chapters for facets of the language they refer to, but do not discuss. + +There are two main ways to read this document. + +The first is to answer a specific question. +If you know which chapter answers that question, you can jump to that chapter in the table of contents. +Otherwise, you can press `s` or click the magnifying glass on the top bar to search for keywords related to your question. +For example, say you wanted to know when a temporary value created in a let statement is dropped. +If you didn't already know that the [lifetime of temporaries] is defined in the [expressions chapter], you could search "temporary let" and the first search result will take you to that section. + +The second is to generally improve your knowledge of a facet of the language. +In that case, just browse the table of contents until you see something you want to know more about, and just start reading. +If a link looks interesting, click it, and read about that section. + +That said, there is no wrong way to read this book. Read it however you feel helps you best. + +### Conventions + +Like all technical books, this book has certain conventions in how it displays information. +These conventions are documented here. + +* Statements that define a term contain that term in *italics*. + Whenever that term is used outside of that chapter, it is usually a link to the section that has this definition. + + An *example term* is an example of a term being defined. + +* Differences in the language by which edition the crate is compiled under are in a blockquote that start with the words "Edition Differences:" in **bold**. + + > **Edition Differences**: In the 2015 edition, this syntax is valid that is disallowed as of the 2018 edition. + +* Notes that contain useful information about the state of the book or point out useful, but mostly out of scope, information are in blockquotes that start with the word "Note:" in **bold**. + + > **Note**: This is an example note. + +* Warnings that show unsound behavior in the language or possibly confusing interactions of language features are in a special warning box. + +
+ + Warning: This is an example warning. + +
+ +* Code snippets inline in the text are inside `` tags. + + Longer code examples are in a syntax highlighted box that has controls for copying, executing, and showing hidden lines in the top right corner. + + ```rust + # // This is a hidden line. + fn main() { + println!("This is a code example"); + } + ``` + + All examples are written for the latest edition unless otherwise stated. + +* The grammar and lexical structure is in blockquotes with either "Lexer" or "Syntax" in **bold superscript** as the first line. + + > **Syntax**\ + > _ExampleGrammar_:\ + >       `~` [_Expression_]\ + >    | `box` [_Expression_] + + See [Notation] for more detail. + +## Contributing + +We welcome contributions of all kinds. + +You can contribute to this book by opening an issue or sending a pull request to [the Rust Reference repository]. +If this book does not answer your question, and you think its answer is in scope of it, please do not hesitate to [file an issue] or ask about it in the `t-lang/doc` stream on [Zulip]. +Knowing what people use this book for the most helps direct our attention to making those sections the best that they can be. +We also want the reference to be as normative as possible, so if you see anything that is wrong or is non-normative but not specifically called out, please also [file an issue]. + +[book]: ../book/index.html +[github issues]: https://github.com/rust-lang/reference/issues +[standard library]: ../std/index.html +[the Rust Reference repository]: https://github.com/rust-lang/reference/ +[Unstable Book]: https://doc.rust-lang.org/nightly/unstable-book/ +[_Expression_]: expressions.md +[cargo book]: ../cargo/index.html +[cargo reference]: ../cargo/reference/index.html +[expressions chapter]: expressions.html +[file an issue]: https://github.com/rust-lang/reference/issues +[lifetime of temporaries]: expressions.html#temporaries +[linkage]: linkage.html +[rustc book]: ../rustc/index.html +[Notation]: notation.md +[Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/237824-t-lang.2Fdoc diff --git a/src/doc/reference/src/items.md b/src/doc/reference/src/items.md new file mode 100644 index 000000000..addbe0efd --- /dev/null +++ b/src/doc/reference/src/items.md @@ -0,0 +1,96 @@ +# Items + +> **Syntax:**\ +> _Item_:\ +>    [_OuterAttribute_]\*\ +>       _VisItem_\ +>    | _MacroItem_ +> +> _VisItem_:\ +>    [_Visibility_]?\ +>    (\ +>          [_Module_]\ +>       | [_ExternCrate_]\ +>       | [_UseDeclaration_]\ +>       | [_Function_]\ +>       | [_TypeAlias_]\ +>       | [_Struct_]\ +>       | [_Enumeration_]\ +>       | [_Union_]\ +>       | [_ConstantItem_]\ +>       | [_StaticItem_]\ +>       | [_Trait_]\ +>       | [_Implementation_]\ +>       | [_ExternBlock_]\ +>    ) +> +> _MacroItem_:\ +>       [_MacroInvocationSemi_]\ +>    | [_MacroRulesDefinition_] + + +An _item_ is a component of a crate. Items are organized within a crate by a +nested set of [modules]. Every crate has a single "outermost" anonymous module; +all further items within the crate have [paths] within the module tree of the +crate. + +Items are entirely determined at compile-time, generally remain fixed during +execution, and may reside in read-only memory. + +There are several kinds of items: + +* [modules] +* [`extern crate` declarations] +* [`use` declarations] +* [function definitions] +* [type definitions] +* [struct definitions] +* [enumeration definitions] +* [union definitions] +* [constant items] +* [static items] +* [trait definitions] +* [implementations] +* [`extern` blocks] + +Some items form an implicit scope for the declaration of sub-items. In other +words, within a function or module, declarations of items can (in many cases) +be mixed with the statements, control blocks, and similar artifacts that +otherwise compose the item body. The meaning of these scoped items is the same +as if the item was declared outside the scope — it is still a static item +— except that the item's *path name* within the module namespace is +qualified by the name of the enclosing item, or is private to the enclosing +item (in the case of functions). The grammar specifies the exact locations in +which sub-item declarations may appear. + +[_ConstantItem_]: items/constant-items.md +[_Enumeration_]: items/enumerations.md +[_ExternBlock_]: items/external-blocks.md +[_ExternCrate_]: items/extern-crates.md +[_Function_]: items/functions.md +[_Implementation_]: items/implementations.md +[_MacroInvocationSemi_]: macros.md#macro-invocation +[_MacroRulesDefinition_]: macros-by-example.md +[_Module_]: items/modules.md +[_OuterAttribute_]: attributes.md +[_StaticItem_]: items/static-items.md +[_Struct_]: items/structs.md +[_Trait_]: items/traits.md +[_TypeAlias_]: items/type-aliases.md +[_Union_]: items/unions.md +[_UseDeclaration_]: items/use-declarations.md +[_Visibility_]: visibility-and-privacy.md +[`extern crate` declarations]: items/extern-crates.md +[`extern` blocks]: items/external-blocks.md +[`use` declarations]: items/use-declarations.md +[constant items]: items/constant-items.md +[enumeration definitions]: items/enumerations.md +[function definitions]: items/functions.md +[implementations]: items/implementations.md +[modules]: items/modules.md +[paths]: paths.md +[static items]: items/static-items.md +[struct definitions]: items/structs.md +[trait definitions]: items/traits.md +[type definitions]: items/type-aliases.md +[union definitions]: items/unions.md diff --git a/src/doc/reference/src/items/associated-items.md b/src/doc/reference/src/items/associated-items.md new file mode 100644 index 000000000..f5dc31aae --- /dev/null +++ b/src/doc/reference/src/items/associated-items.md @@ -0,0 +1,397 @@ +# Associated Items + +> **Syntax**\ +> _AssociatedItem_ :\ +>    [_OuterAttribute_]\* (\ +>          [_MacroInvocationSemi_]\ +>       | ( [_Visibility_]? ( [_TypeAlias_] | [_ConstantItem_] | [_Function_] ) )\ +>    ) + +*Associated Items* are the items declared in [traits] or defined in +[implementations]. They are called this because they are defined on an associate +type — the type in the implementation. They are a subset of the kinds of +items you can declare in a module. Specifically, there are [associated +functions] (including methods), [associated types], and [associated constants]. + +[associated functions]: #associated-functions-and-methods +[associated types]: #associated-types +[associated constants]: #associated-constants + +Associated items are useful when the associated item logically is related to the +associating item. For example, the `is_some` method on `Option` is intrinsically +related to Options, so should be associated. + +Every associated item kind comes in two varieties: definitions that contain the +actual implementation and declarations that declare signatures for +definitions. + +It is the declarations that make up the contract of traits and what is available +on generic types. + +## Associated functions and methods + +*Associated functions* are [functions] associated with a type. + +An *associated function declaration* declares a signature for an associated +function definition. It is written as a function item, except the +function body is replaced with a `;`. + +The identifier is the name of the function. The generics, parameter list, +return type, and where clause of the associated function must be the same as the +associated function declarations's. + +An *associated function definition* defines a function associated with another +type. It is written the same as a [function item]. + +An example of a common associated function is a `new` function that returns +a value of the type the associated function is associated with. + +```rust +struct Struct { + field: i32 +} + +impl Struct { + fn new() -> Struct { + Struct { + field: 0i32 + } + } +} + +fn main () { + let _struct = Struct::new(); +} +``` + +When the associated function is declared on a trait, the function can also be +called with a [path] that is a path to the trait appended by the name of the +trait. When this happens, it is substituted for `<_ as Trait>::function_name`. + +```rust +trait Num { + fn from_i32(n: i32) -> Self; +} + +impl Num for f64 { + fn from_i32(n: i32) -> f64 { n as f64 } +} + +// These 4 are all equivalent in this case. +let _: f64 = Num::from_i32(42); +let _: f64 = <_ as Num>::from_i32(42); +let _: f64 = ::from_i32(42); +let _: f64 = f64::from_i32(42); +``` + +### Methods + +Associated functions whose first parameter is named `self` are called *methods* +and may be invoked using the [method call operator], for example, `x.foo()`, as +well as the usual function call notation. + +If the type of the `self` parameter is specified, it is limited to types resolving +to one generated by the following grammar (where `'lt` denotes some arbitrary +lifetime): + +```text +P = &'lt S | &'lt mut S | Box | Rc | Arc | Pin

+S = Self | P +``` + +The `Self` terminal in this grammar denotes a type resolving to the implementing type. +This can also include the contextual type alias `Self`, other type aliases, +or associated type projections resolving to the implementing type. + +```rust +# use std::rc::Rc; +# use std::sync::Arc; +# use std::pin::Pin; +// Examples of methods implemented on struct `Example`. +struct Example; +type Alias = Example; +trait Trait { type Output; } +impl Trait for Example { type Output = Example; } +impl Example { + fn by_value(self: Self) {} + fn by_ref(self: &Self) {} + fn by_ref_mut(self: &mut Self) {} + fn by_box(self: Box) {} + fn by_rc(self: Rc) {} + fn by_arc(self: Arc) {} + fn by_pin(self: Pin<&Self>) {} + fn explicit_type(self: Arc) {} + fn with_lifetime<'a>(self: &'a Self) {} + fn nested<'a>(self: &mut &'a Arc>>) {} + fn via_projection(self: ::Output) {} +} +``` + +Shorthand syntax can be used without specifying a type, which have the +following equivalents: + +Shorthand | Equivalent +----------------------|----------- +`self` | `self: Self` +`&'lifetime self` | `self: &'lifetime Self` +`&'lifetime mut self` | `self: &'lifetime mut Self` + +> **Note**: Lifetimes can be, and usually are, elided with this shorthand. + +If the `self` parameter is prefixed with `mut`, it becomes a mutable variable, +similar to regular parameters using a `mut` [identifier pattern]. For example: + +```rust +trait Changer: Sized { + fn change(mut self) {} + fn modify(mut self: Box) {} +} +``` + +As an example of methods on a trait, consider the following: + +```rust +# type Surface = i32; +# type BoundingBox = i32; +trait Shape { + fn draw(&self, surface: Surface); + fn bounding_box(&self) -> BoundingBox; +} +``` + +This defines a trait with two methods. All values that have [implementations] +of this trait while the trait is in scope can have their `draw` and +`bounding_box` methods called. + +```rust +# type Surface = i32; +# type BoundingBox = i32; +# trait Shape { +# fn draw(&self, surface: Surface); +# fn bounding_box(&self) -> BoundingBox; +# } +# +struct Circle { + // ... +} + +impl Shape for Circle { + // ... +# fn draw(&self, _: Surface) {} +# fn bounding_box(&self) -> BoundingBox { 0i32 } +} + +# impl Circle { +# fn new() -> Circle { Circle{} } +# } +# +let circle_shape = Circle::new(); +let bounding_box = circle_shape.bounding_box(); +``` + +> **Edition Differences**: In the 2015 edition, it is possible to declare trait +> methods with anonymous parameters (e.g. `fn foo(u8)`). This is deprecated and +> an error as of the 2018 edition. All parameters must have an argument name. + +#### Attributes on method parameters + +Attributes on method parameters follow the same rules and restrictions as +[regular function parameters]. + +## Associated Types + +*Associated types* are [type aliases] associated with another type. Associated +types cannot be defined in [inherent implementations] nor can they be given a +default implementation in traits. + +An *associated type declaration* declares a signature for associated type +definitions. It is written as `type`, then an [identifier], and +finally an optional list of trait bounds. + +The identifier is the name of the declared type alias. The optional trait bounds +must be fulfilled by the implementations of the type alias. +There is an implicit [`Sized`] bound on associated types that can be relaxed using the special `?Sized` bound. + +An *associated type definition* defines a type alias on another type. It is +written as `type`, then an [identifier], then an `=`, and finally a [type]. + +If a type `Item` has an associated type `Assoc` from a trait `Trait`, then +`::Assoc` is a type that is an alias of the type specified in the +associated type definition. Furthermore, if `Item` is a type parameter, then +`Item::Assoc` can be used in type parameters. + +Associated types must not include [generic parameters] or [where clauses]. + +```rust +trait AssociatedType { + // Associated type declaration + type Assoc; +} + +struct Struct; + +struct OtherStruct; + +impl AssociatedType for Struct { + // Associated type definition + type Assoc = OtherStruct; +} + +impl OtherStruct { + fn new() -> OtherStruct { + OtherStruct + } +} + +fn main() { + // Usage of the associated type to refer to OtherStruct as ::Assoc + let _other_struct: OtherStruct = ::Assoc::new(); +} +``` + +### Associated Types Container Example + +Consider the following example of a `Container` trait. Notice that the type is +available for use in the method signatures: + +```rust +trait Container { + type E; + fn empty() -> Self; + fn insert(&mut self, elem: Self::E); +} +``` + +In order for a type to implement this trait, it must not only provide +implementations for every method, but it must specify the type `E`. Here's an +implementation of `Container` for the standard library type `Vec`: + +```rust +# trait Container { +# type E; +# fn empty() -> Self; +# fn insert(&mut self, elem: Self::E); +# } +impl Container for Vec { + type E = T; + fn empty() -> Vec { Vec::new() } + fn insert(&mut self, x: T) { self.push(x); } +} +``` + +## Associated Constants + +*Associated constants* are [constants] associated with a type. + +An *associated constant declaration* declares a signature for associated +constant definitions. It is written as `const`, then an identifier, +then `:`, then a type, finished by a `;`. + +The identifier is the name of the constant used in the path. The type is the +type that the definition has to implement. + +An *associated constant definition* defines a constant associated with a +type. It is written the same as a [constant item]. + +Associated constant definitions undergo [constant evaluation] only when +referenced. Further, definitions that include [generic parameters] are +evaluated after monomorphization. + +```rust,compile_fail +struct Struct; +struct GenericStruct; + +impl Struct { + // Definition not immediately evaluated + const PANIC: () = panic!("compile-time panic"); +} + +impl GenericStruct { + // Definition not immediately evaluated + const NON_ZERO: () = if ID == 0 { + panic!("contradiction") + }; +} + +fn main() { + // Referencing Struct::PANIC causes compilation error + let _ = Struct::PANIC; + + // Fine, ID is not 0 + let _ = GenericStruct::<1>::NON_ZERO; + + // Compilation error from evaluating NON_ZERO with ID=0 + let _ = GenericStruct::<0>::NON_ZERO; +} +``` + +### Associated Constants Examples + +A basic example: + +```rust +trait ConstantId { + const ID: i32; +} + +struct Struct; + +impl ConstantId for Struct { + const ID: i32 = 1; +} + +fn main() { + assert_eq!(1, Struct::ID); +} +``` + +Using default values: + +```rust +trait ConstantIdDefault { + const ID: i32 = 1; +} + +struct Struct; +struct OtherStruct; + +impl ConstantIdDefault for Struct {} + +impl ConstantIdDefault for OtherStruct { + const ID: i32 = 5; +} + +fn main() { + assert_eq!(1, Struct::ID); + assert_eq!(5, OtherStruct::ID); +} +``` + +[_ConstantItem_]: constant-items.md +[_Function_]: functions.md +[_MacroInvocationSemi_]: ../macros.md#macro-invocation +[_OuterAttribute_]: ../attributes.md +[_TypeAlias_]: type-aliases.md +[_Visibility_]: ../visibility-and-privacy.md +[`Arc`]: ../special-types-and-traits.md#arct +[`Box`]: ../special-types-and-traits.md#boxt +[`Pin

`]: ../special-types-and-traits.md#pinp +[`Rc`]: ../special-types-and-traits.md#rct +[`Sized`]: ../special-types-and-traits.md#sized +[traits]: traits.md +[type aliases]: type-aliases.md +[inherent implementations]: implementations.md#inherent-implementations +[identifier]: ../identifiers.md +[identifier pattern]: ../patterns.md#identifier-patterns +[implementations]: implementations.md +[type]: ../types.md#type-expressions +[constants]: constant-items.md +[constant item]: constant-items.md +[functions]: functions.md +[function item]: ../types/function-item.md +[method call operator]: ../expressions/method-call-expr.md +[path]: ../paths.md +[regular function parameters]: functions.md#attributes-on-function-parameters +[generic parameters]: generics.md +[where clauses]: generics.md#where-clauses +[constant evaluation]: ../const_eval.md diff --git a/src/doc/reference/src/items/constant-items.md b/src/doc/reference/src/items/constant-items.md new file mode 100644 index 000000000..bf315932f --- /dev/null +++ b/src/doc/reference/src/items/constant-items.md @@ -0,0 +1,101 @@ +# Constant items + +> **Syntax**\ +> _ConstantItem_ :\ +>    `const` ( [IDENTIFIER] | `_` ) `:` [_Type_] ( `=` [_Expression_] )? `;` + +A *constant item* is an optionally named _[constant value]_ which is not associated +with a specific memory location in the program. Constants are essentially inlined +wherever they are used, meaning that they are copied directly into the relevant +context when used. This includes usage of constants from external crates, and +non-[`Copy`] types. References to the same constant are not necessarily +guaranteed to refer to the same memory address. + +Constants must be explicitly typed. The type must have a `'static` lifetime: any +references in the initializer must have `'static` lifetimes. + +Constants may refer to the address of other constants, in which case the +address will have elided lifetimes where applicable, otherwise – in most cases +– defaulting to the `static` lifetime. (See [static lifetime +elision].) The compiler is, however, still at liberty to translate the constant +many times, so the address referred to may not be stable. + +```rust +const BIT1: u32 = 1 << 0; +const BIT2: u32 = 1 << 1; + +const BITS: [u32; 2] = [BIT1, BIT2]; +const STRING: &'static str = "bitstring"; + +struct BitsNStrings<'a> { + mybits: [u32; 2], + mystring: &'a str, +} + +const BITS_N_STRINGS: BitsNStrings<'static> = BitsNStrings { + mybits: BITS, + mystring: STRING, +}; +``` + +The constant expression may only be omitted in a [trait definition]. + +## Constants with Destructors + +Constants can contain destructors. Destructors are run when the value goes out +of scope. + +```rust +struct TypeWithDestructor(i32); + +impl Drop for TypeWithDestructor { + fn drop(&mut self) { + println!("Dropped. Held {}.", self.0); + } +} + +const ZERO_WITH_DESTRUCTOR: TypeWithDestructor = TypeWithDestructor(0); + +fn create_and_drop_zero_with_destructor() { + let x = ZERO_WITH_DESTRUCTOR; + // x gets dropped at end of function, calling drop. + // prints "Dropped. Held 0.". +} +``` + +## Unnamed constant + +Unlike an [associated constant], a [free] constant may be unnamed by using +an underscore instead of the name. For example: + +```rust +const _: () = { struct _SameNameTwice; }; + +// OK although it is the same name as above: +const _: () = { struct _SameNameTwice; }; +``` + +As with [underscore imports], macros may safely emit the same unnamed constant in +the same scope more than once. For example, the following should not produce an error: + +```rust +macro_rules! m { + ($item: item) => { $item $item } +} + +m!(const _: () = ();); +// This expands to: +// const _: () = (); +// const _: () = (); +``` + +[associated constant]: ../items/associated-items.md#associated-constants +[constant value]: ../const_eval.md#constant-expressions +[free]: ../glossary.md#free-item +[static lifetime elision]: ../lifetime-elision.md#static-lifetime-elision +[trait definition]: traits.md +[IDENTIFIER]: ../identifiers.md +[underscore imports]: use-declarations.md#underscore-imports +[_Type_]: ../types.md#type-expressions +[_Expression_]: ../expressions.md +[`Copy`]: ../special-types-and-traits.md#copy diff --git a/src/doc/reference/src/items/enumerations.md b/src/doc/reference/src/items/enumerations.md new file mode 100644 index 000000000..28d3ba873 --- /dev/null +++ b/src/doc/reference/src/items/enumerations.md @@ -0,0 +1,188 @@ +# Enumerations + +> **Syntax**\ +> _Enumeration_ :\ +>    `enum` +> [IDENTIFIER]  +> [_GenericParams_]? +> [_WhereClause_]? +> `{` _EnumItems_? `}` +> +> _EnumItems_ :\ +>    _EnumItem_ ( `,` _EnumItem_ )\* `,`? +> +> _EnumItem_ :\ +>    _OuterAttribute_\* [_Visibility_]?\ +>    [IDENTIFIER] ( _EnumItemTuple_ | _EnumItemStruct_ +> | _EnumItemDiscriminant_ )? +> +> _EnumItemTuple_ :\ +>    `(` [_TupleFields_]? `)` +> +> _EnumItemStruct_ :\ +>    `{` [_StructFields_]? `}` +> +> _EnumItemDiscriminant_ :\ +>    `=` [_Expression_] + +An *enumeration*, also referred to as an *enum*, is a simultaneous definition of a +nominal [enumerated type] as well as a set of *constructors*, that can be used +to create or pattern-match values of the corresponding enumerated type. + +Enumerations are declared with the keyword `enum`. + +An example of an `enum` item and its use: + +```rust +enum Animal { + Dog, + Cat, +} + +let mut a: Animal = Animal::Dog; +a = Animal::Cat; +``` + +Enum constructors can have either named or unnamed fields: + +```rust +enum Animal { + Dog(String, f64), + Cat { name: String, weight: f64 }, +} + +let mut a: Animal = Animal::Dog("Cocoa".to_string(), 37.2); +a = Animal::Cat { name: "Spotty".to_string(), weight: 2.7 }; +``` + +In this example, `Cat` is a _struct-like enum variant_, whereas `Dog` is simply +called an enum variant. Each enum instance has a _discriminant_ which is an +integer associated to it that is used to determine which variant it holds. An +opaque reference to this discriminant can be obtained with the +[`mem::discriminant`] function. + +## Custom Discriminant Values for Fieldless Enumerations + +If there is no data attached to *any* of the variants of an enumeration, +then the discriminant can be directly chosen and accessed. + +These enumerations can be cast to integer types with the `as` operator by a +[numeric cast]. The enumeration can optionally specify which integer each +discriminant gets by following the variant name with `=` followed by a [constant +expression]. If the first variant in the declaration is unspecified, then it is +set to zero. For every other unspecified discriminant, it is set to one higher +than the previous variant in the declaration. + +```rust +enum Foo { + Bar, // 0 + Baz = 123, // 123 + Quux, // 124 +} + +let baz_discriminant = Foo::Baz as u32; +assert_eq!(baz_discriminant, 123); +``` + +Under the [default representation], the specified discriminant is interpreted as +an `isize` value although the compiler is allowed to use a smaller type in the +actual memory layout. The size and thus acceptable values can be changed by +using a [primitive representation] or the [`C` representation]. + +It is an error when two variants share the same discriminant. + +```rust,compile_fail +enum SharedDiscriminantError { + SharedA = 1, + SharedB = 1 +} + +enum SharedDiscriminantError2 { + Zero, // 0 + One, // 1 + OneToo = 1 // 1 (collision with previous!) +} +``` + +It is also an error to have an unspecified discriminant where the previous +discriminant is the maximum value for the size of the discriminant. + +```rust,compile_fail +#[repr(u8)] +enum OverflowingDiscriminantError { + Max = 255, + MaxPlusOne // Would be 256, but that overflows the enum. +} + +#[repr(u8)] +enum OverflowingDiscriminantError2 { + MaxMinusOne = 254, // 254 + Max, // 255 + MaxPlusOne // Would be 256, but that overflows the enum. +} +``` + +## Zero-variant Enums + +Enums with zero variants are known as *zero-variant enums*. As they have +no valid values, they cannot be instantiated. + +```rust +enum ZeroVariants {} +``` + +Zero-variant enums are equivalent to the [never type], but they cannot be +coerced into other types. + +```rust,compile_fail +# enum ZeroVariants {} +let x: ZeroVariants = panic!(); +let y: u32 = x; // mismatched type error +``` + +## Variant visibility + +Enum variants syntactically allow a [_Visibility_] annotation, but this is +rejected when the enum is validated. This allows items to be parsed with a +unified syntax across different contexts where they are used. + +```rust +macro_rules! mac_variant { + ($vis:vis $name:ident) => { + enum $name { + $vis Unit, + + $vis Tuple(u8, u16), + + $vis Struct { f: u8 }, + } + } +} + +// Empty `vis` is allowed. +mac_variant! { E } + +// This is allowed, since it is removed before being validated. +#[cfg(FALSE)] +enum E { + pub U, + pub(crate) T(u8), + pub(super) T { f: String } +} +``` + +[IDENTIFIER]: ../identifiers.md +[_GenericParams_]: generics.md +[_WhereClause_]: generics.md#where-clauses +[_Expression_]: ../expressions.md +[_TupleFields_]: structs.md +[_StructFields_]: structs.md +[_Visibility_]: ../visibility-and-privacy.md +[enumerated type]: ../types/enum.md +[`mem::discriminant`]: ../../std/mem/fn.discriminant.html +[never type]: ../types/never.md +[numeric cast]: ../expressions/operator-expr.md#semantics +[constant expression]: ../const_eval.md#constant-expressions +[default representation]: ../type-layout.md#the-default-representation +[primitive representation]: ../type-layout.md#primitive-representations +[`C` representation]: ../type-layout.md#the-c-representation diff --git a/src/doc/reference/src/items/extern-crates.md b/src/doc/reference/src/items/extern-crates.md new file mode 100644 index 000000000..f4dc735b0 --- /dev/null +++ b/src/doc/reference/src/items/extern-crates.md @@ -0,0 +1,94 @@ +# Extern crate declarations + +> **Syntax:**\ +> _ExternCrate_ :\ +>    `extern` `crate` _CrateRef_ _AsClause_? `;` +> +> _CrateRef_ :\ +>    [IDENTIFIER] | `self` +> +> _AsClause_ :\ +>    `as` ( [IDENTIFIER] | `_` ) + +An _`extern crate` declaration_ specifies a dependency on an external crate. +The external crate is then bound into the declaring scope as the [identifier] +provided in the `extern crate` declaration. Additionally, if the `extern +crate` appears in the crate root, then the crate name is also added to the +[extern prelude], making it automatically in scope in all modules. The `as` +clause can be used to bind the imported crate to a different name. + +The external crate is resolved to a specific `soname` at compile time, and a +runtime linkage requirement to that `soname` is passed to the linker for +loading at runtime. The `soname` is resolved at compile time by scanning the +compiler's library path and matching the optional `crateid` provided against +the `crateid` attributes that were declared on the external crate when it was +compiled. If no `crateid` is provided, a default `name` attribute is assumed, +equal to the [identifier] given in the `extern crate` declaration. + +The `self` crate may be imported which creates a binding to the current crate. +In this case the `as` clause must be used to specify the name to bind it to. + +Three examples of `extern crate` declarations: + + +```rust,ignore +extern crate pcre; + +extern crate std; // equivalent to: extern crate std as std; + +extern crate std as ruststd; // linking to 'std' under another name +``` + +When naming Rust crates, hyphens are disallowed. However, Cargo packages may +make use of them. In such case, when `Cargo.toml` doesn't specify a crate name, +Cargo will transparently replace `-` with `_` (Refer to [RFC 940] for more +details). + +Here is an example: + + +```rust,ignore +// Importing the Cargo package hello-world +extern crate hello_world; // hyphen replaced with an underscore +``` + +## Extern Prelude + +This section has been moved to [Preludes — Extern Prelude](../names/preludes.md#extern-prelude). + + +## Underscore Imports + +An external crate dependency can be declared without binding its name in scope +by using an underscore with the form `extern crate foo as _`. This may be +useful for crates that only need to be linked, but are never referenced, and +will avoid being reported as unused. + +The [`macro_use` attribute] works as usual and imports the macro names +into the [`macro_use` prelude]. + +## The `no_link` attribute + +The *`no_link` attribute* may be specified on an `extern crate` item to +prevent linking the crate into the output. This is commonly used to load a +crate to access only its macros. + +[IDENTIFIER]: ../identifiers.md +[RFC 940]: https://github.com/rust-lang/rfcs/blob/master/text/0940-hyphens-considered-harmful.md +[`macro_use` attribute]: ../macros-by-example.md#the-macro_use-attribute +[extern prelude]: ../names/preludes.md#extern-prelude +[`macro_use` prelude]: ../names/preludes.md#macro_use-prelude + + diff --git a/src/doc/reference/src/items/external-blocks.md b/src/doc/reference/src/items/external-blocks.md new file mode 100644 index 000000000..e768a1502 --- /dev/null +++ b/src/doc/reference/src/items/external-blocks.md @@ -0,0 +1,235 @@ +# External blocks + +> **Syntax**\ +> _ExternBlock_ :\ +>    `unsafe`? `extern` [_Abi_]? `{`\ +>       [_InnerAttribute_]\*\ +>       _ExternalItem_\*\ +>    `}` +> +> _ExternalItem_ :\ +>    [_OuterAttribute_]\* (\ +>          [_MacroInvocationSemi_]\ +>       | ( [_Visibility_]? ( [_StaticItem_] | [_Function_] ) )\ +>    ) + +External blocks provide _declarations_ of items that are not _defined_ in the +current crate and are the basis of Rust's foreign function interface. These are +akin to unchecked imports. + +Two kinds of item _declarations_ are allowed in external blocks: [functions] and +[statics]. Calling functions or accessing statics that are declared in external +blocks is only allowed in an `unsafe` context. + +The `unsafe` keyword is syntactically allowed to appear before the `extern` +keyword, but it is rejected at a semantic level. This allows macros to consume +the syntax and make use of the `unsafe` keyword, before removing it from the +token stream. + +## Functions + +Functions within external blocks are declared in the same way as other Rust +functions, with the exception that they must not have a body and are instead +terminated by a semicolon. Patterns are not allowed in parameters, only +[IDENTIFIER] or `_` may be used. Function qualifiers (`const`, `async`, +`unsafe`, and `extern`) are not allowed. + +Functions within external blocks may be called by Rust code, just like +functions defined in Rust. The Rust compiler automatically translates between +the Rust ABI and the foreign ABI. + +A function declared in an extern block is implicitly `unsafe`. When coerced to +a function pointer, a function declared in an extern block has type `unsafe +extern "abi" for<'l1, ..., 'lm> fn(A1, ..., An) -> R`, where `'l1`, ... `'lm` +are its lifetime parameters, `A1`, ..., `An` are the declared types of its +parameters and `R` is the declared return type. + +## Statics + +Statics within external blocks are declared in the same way as [statics] outside of external blocks, +except that they do not have an expression initializing their value. +It is `unsafe` to access a static item declared in an extern block, whether or +not it's mutable, because there is nothing guaranteeing that the bit pattern at the static's +memory is valid for the type it is declared with, since some arbitrary (e.g. C) code is in charge +of initializing the static. + +Extern statics can be either immutable or mutable just like [statics] outside of external blocks. +An immutable static *must* be initialized before any Rust code is executed. It is not enough for +the static to be initialized before Rust code reads from it. + +## ABI + +By default external blocks assume that the library they are calling uses the +standard C ABI on the specific platform. Other ABIs may be specified using an +`abi` string, as shown here: + +```rust +// Interface to the Windows API +extern "stdcall" { } +``` + +There are three ABI strings which are cross-platform, and which all compilers +are guaranteed to support: + +* `extern "Rust"` -- The default ABI when you write a normal `fn foo()` in any + Rust code. +* `extern "C"` -- This is the same as `extern fn foo()`; whatever the default + your C compiler supports. +* `extern "system"` -- Usually the same as `extern "C"`, except on Win32, in + which case it's `"stdcall"`, or what you should use to link to the Windows + API itself + +There are also some platform-specific ABI strings: + +* `extern "cdecl"` -- The default for x86\_32 C code. +* `extern "stdcall"` -- The default for the Win32 API on x86\_32. +* `extern "win64"` -- The default for C code on x86\_64 Windows. +* `extern "sysv64"` -- The default for C code on non-Windows x86\_64. +* `extern "aapcs"` -- The default for ARM. +* `extern "fastcall"` -- The `fastcall` ABI -- corresponds to MSVC's + `__fastcall` and GCC and clang's `__attribute__((fastcall))` +* `extern "vectorcall"` -- The `vectorcall` ABI -- corresponds to MSVC's + `__vectorcall` and clang's `__attribute__((vectorcall))` + +## Variadic functions + +Functions within external blocks may be variadic by specifying `...` as the +last argument. There must be at least one parameter before the variadic +parameter. The variadic parameter may optionally be specified with an +identifier. + +```rust +extern "C" { + fn foo(x: i32, ...); + fn with_name(format: *const u8, args: ...); +} +``` + +## Attributes on extern blocks + +The following [attributes] control the behavior of external blocks. + +### The `link` attribute + +The *`link` attribute* specifies the name of a native library that the +compiler should link with for the items within an `extern` block. It uses the +[_MetaListNameValueStr_] syntax to specify its inputs. The `name` key is the +name of the native library to link. The `kind` key is an optional value which +specifies the kind of library with the following possible values: + +- `dylib` — Indicates a dynamic library. This is the default if `kind` is not + specified. +- `static` — Indicates a static library. +- `framework` — Indicates a macOS framework. This is only valid for macOS + targets. + +The `name` key must be included if `kind` is specified. + +The optional `modifiers` argument is a way to specify linking modifiers for the +library to link. +Modifiers are specified as a comma-delimited string with each modifier prefixed +with either a `+` or `-` to indicate that the modifier is enabled or disabled, +respectively. +Specifying multiple `modifiers` arguments in a single `link` attribute, +or multiple identical modifiers in the same `modifiers` argument is not currently supported. \ +Example: `#[link(name = "mylib", kind = "static", modifiers = "+whole-archive")`. + +The `wasm_import_module` key may be used to specify the [WebAssembly module] +name for the items within an `extern` block when importing symbols from the +host environment. The default module name is `env` if `wasm_import_module` is +not specified. + + +```rust,ignore +#[link(name = "crypto")] +extern { + // … +} + +#[link(name = "CoreFoundation", kind = "framework")] +extern { + // … +} + +#[link(wasm_import_module = "foo")] +extern { + // … +} +``` + +It is valid to add the `link` attribute on an empty extern block. You can use +this to satisfy the linking requirements of extern blocks elsewhere in your +code (including upstream crates) instead of adding the attribute to each extern +block. + +#### Linking modifiers: `bundle` + +This modifier is only compatible with the `static` linking kind. +Using any other kind will result in a compiler error. + +When building a rlib or staticlib `+bundle` means that the native static library +will be packed into the rlib or staticlib archive, and then retrieved from there +during linking of the final binary. + +When building a rlib `-bundle` means that the native static library is registered as a dependency +of that rlib "by name", and object files from it are included only during linking of the final +binary, the file search by that name is also performed during final linking. \ +When building a staticlib `-bundle` means that the native static library is simply not included +into the archive and some higher level build system will need to add it later during linking of +the final binary. + +This modifier has no effect when building other targets like executables or dynamic libraries. + +The default for this modifier is `+bundle`. + +More implementation details about this modifier can be found in +[`bundle` documentation for rustc]. + +#### Linking modifiers: `whole-archive` + +This modifier is only compatible with the `static` linking kind. +Using any other kind will result in a compiler error. + +`+whole-archive` means that the static library is linked as a whole archive +without throwing any object files away. + +The default for this modifier is `-whole-archive`. + +More implementation details about this modifier can be found in +[`whole-archive` documentation for rustc]. + +### The `link_name` attribute + +The `link_name` attribute may be specified on declarations inside an `extern` +block to indicate the symbol to import for the given function or static. It +uses the [_MetaNameValueStr_] syntax to specify the name of the symbol. + +```rust +extern { + #[link_name = "actual_symbol_name"] + fn name_in_rust(); +} +``` + +### Attributes on function parameters + +Attributes on extern function parameters follow the same rules and +restrictions as [regular function parameters]. + +[IDENTIFIER]: ../identifiers.md +[WebAssembly module]: https://webassembly.github.io/spec/core/syntax/modules.html +[functions]: functions.md +[statics]: static-items.md +[_Abi_]: functions.md +[_Function_]: functions.md +[_InnerAttribute_]: ../attributes.md +[_MacroInvocationSemi_]: ../macros.md#macro-invocation +[_MetaListNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[_MetaNameValueStr_]: ../attributes.md#meta-item-attribute-syntax +[_OuterAttribute_]: ../attributes.md +[_StaticItem_]: static-items.md +[_Visibility_]: ../visibility-and-privacy.md +[attributes]: ../attributes.md +[regular function parameters]: functions.md#attributes-on-function-parameters +[`bundle` documentation for rustc]: ../../rustc/command-line-arguments.html#linking-modifiers-bundle +[`whole-archive` documentation for rustc]: ../../rustc/command-line-arguments.html#linking-modifiers-whole-archive diff --git a/src/doc/reference/src/items/functions.md b/src/doc/reference/src/items/functions.md new file mode 100644 index 000000000..325588a53 --- /dev/null +++ b/src/doc/reference/src/items/functions.md @@ -0,0 +1,415 @@ +# Functions + +> **Syntax**\ +> _Function_ :\ +>    _FunctionQualifiers_ `fn` [IDENTIFIER] [_GenericParams_]?\ +>       `(` _FunctionParameters_? `)`\ +>       _FunctionReturnType_? [_WhereClause_]?\ +>       ( [_BlockExpression_] | `;` ) +> +> _FunctionQualifiers_ :\ +>    `const`? `async`[^async-edition]? `unsafe`? (`extern` _Abi_?)? +> +> _Abi_ :\ +>    [STRING_LITERAL] | [RAW_STRING_LITERAL] +> +> _FunctionParameters_ :\ +>       _SelfParam_ `,`?\ +>    | (_SelfParam_ `,`)? _FunctionParam_ (`,` _FunctionParam_)\* `,`? +> +> _SelfParam_ :\ +>    [_OuterAttribute_]\* ( _ShorthandSelf_ | _TypedSelf_ ) +> +> _ShorthandSelf_ :\ +>    (`&` | `&` [_Lifetime_])? `mut`? `self` +> +> _TypedSelf_ :\ +>    `mut`? `self` `:` [_Type_] +> +> _FunctionParam_ :\ +>    [_OuterAttribute_]\* ( +> _FunctionParamPattern_ | `...` | [_Type_] [^fn-param-2015] +> ) +> +> _FunctionParamPattern_ :\ +>    [_PatternNoTopAlt_] `:` ( [_Type_] | `...` ) +> +> _FunctionReturnType_ :\ +>    `->` [_Type_] +> +> [^async-edition]: The `async` qualifier is not allowed in the 2015 edition. +> +> [^fn-param-2015]: Function parameters with only a type are only allowed +> in an associated function of a [trait item] in the 2015 edition. + +A _function_ consists of a [block], along with a name, a set of parameters, and an output type. +Other than a name, all these are optional. +Functions are declared with the keyword `fn`. +Functions may declare a set of *input* [*variables*][variables] as parameters, through which the caller passes arguments into the function, and the *output* [*type*][type] of the value the function will return to its caller on completion. +If the output type is not explicitly stated, it is the [unit type]. + +When referred to, a _function_ yields a first-class *value* of the corresponding zero-sized [*function item type*], which when called evaluates to a direct call to the function. + +For example, this is a simple function: +```rust +fn answer_to_life_the_universe_and_everything() -> i32 { + return 42; +} +``` + +## Function parameters + +As with `let` bindings, function parameters are irrefutable [patterns], so any +pattern that is valid in a let binding is also valid as a parameter: + +```rust +fn first((value, _): (i32, i32)) -> i32 { value } +``` + +If the first parameter is a _SelfParam_, this indicates that the function is a +[method]. Functions with a self parameter may only appear as an [associated +function] in a [trait] or [implementation]. + +A parameter with the `...` token indicates a [variadic function], and may only +be used as the last parameter of an [external block] function. The variadic +parameter may have an optional identifier, such as `args: ...`. + +## Function body + +The block of a function is conceptually wrapped in a block that binds the +argument patterns and then `return`s the value of the function's block. This +means that the tail expression of the block, if evaluated, ends up being +returned to the caller. As usual, an explicit return expression within +the body of the function will short-cut that implicit return, if reached. + +For example, the function above behaves as if it was written as: + + +```rust,ignore +// argument_0 is the actual first argument passed from the caller +let (value, _) = argument_0; +return { + value +}; +``` + +Functions without a body block are terminated with a semicolon. This form +may only appear in a [trait] or [external block]. + +## Generic functions + +A _generic function_ allows one or more _parameterized types_ to appear in its +signature. Each type parameter must be explicitly declared in an +angle-bracket-enclosed and comma-separated list, following the function name. + +```rust +// foo is generic over A and B + +fn foo(x: A, y: B) { +# } +``` + +Inside the function signature and body, the name of the type parameter can be +used as a type name. [Trait] bounds can be specified for type +parameters to allow methods with that trait to be called on values of that +type. This is specified using the `where` syntax: + +```rust +# use std::fmt::Debug; +fn foo(x: T) where T: Debug { +# } +``` + +When a generic function is referenced, its type is instantiated based on the +context of the reference. For example, calling the `foo` function here: + +```rust +use std::fmt::Debug; + +fn foo(x: &[T]) where T: Debug { + // details elided +} + +foo(&[1, 2]); +``` + +will instantiate type parameter `T` with `i32`. + +The type parameters can also be explicitly supplied in a trailing [path] +component after the function name. This might be necessary if there is not +sufficient context to determine the type parameters. For example, +`mem::size_of::() == 4`. + +## Extern function qualifier + +The `extern` function qualifier allows providing function _definitions_ that can +be called with a particular ABI: + + +```rust,ignore +extern "ABI" fn foo() { /* ... */ } +``` + +These are often used in combination with [external block] items which provide +function _declarations_ that can be used to call functions without providing +their _definition_: + + +```rust,ignore +extern "ABI" { + fn foo(); /* no body */ +} +unsafe { foo() } +``` + +When `"extern" Abi?*` is omitted from `FunctionQualifiers` in function items, +the ABI `"Rust"` is assigned. For example: + +```rust +fn foo() {} +``` + +is equivalent to: + +```rust +extern "Rust" fn foo() {} +``` + +Functions can be called by foreign code, and using an ABI that +differs from Rust allows, for example, to provide functions that can be +called from other programming languages like C: + +```rust +// Declares a function with the "C" ABI +extern "C" fn new_i32() -> i32 { 0 } + +// Declares a function with the "stdcall" ABI +# #[cfg(target_arch = "x86_64")] +extern "stdcall" fn new_i32_stdcall() -> i32 { 0 } +``` + +Just as with [external block], when the `extern` keyword is used and the `"ABI"` +is omitted, the ABI used defaults to `"C"`. That is, this: + +```rust +extern fn new_i32() -> i32 { 0 } +let fptr: extern fn() -> i32 = new_i32; +``` + +is equivalent to: + +```rust +extern "C" fn new_i32() -> i32 { 0 } +let fptr: extern "C" fn() -> i32 = new_i32; +``` + +Functions with an ABI that differs from `"Rust"` do not support unwinding in the +exact same way that Rust does. Therefore, unwinding past the end of functions +with such ABIs causes the process to abort. + +> **Note**: The LLVM backend of the `rustc` implementation +aborts the process by executing an illegal instruction. + +## Const functions + +Functions qualified with the `const` keyword are [const functions], as are +[tuple struct] and [tuple variant] constructors. _Const functions_ can be +called from within [const contexts]. + +Const functions may use the [`extern`] function qualifier, but only with the `"Rust"` and `"C"` ABIs. + +Const functions are not allowed to be [async](#async-functions). + +## Async functions + +Functions may be qualified as async, and this can also be combined with the +`unsafe` qualifier: + +```rust +async fn regular_example() { } +async unsafe fn unsafe_example() { } +``` + +Async functions do no work when called: instead, they +capture their arguments into a future. When polled, that future will +execute the function's body. + +An async function is roughly equivalent to a function +that returns [`impl Future`] and with an [`async move` block][async-blocks] as +its body: + +```rust +// Source +async fn example(x: &str) -> usize { + x.len() +} +``` + +is roughly equivalent to: + +```rust +# use std::future::Future; +// Desugared +fn example<'a>(x: &'a str) -> impl Future + 'a { + async move { x.len() } +} +``` + +The actual desugaring is more complex: + +- The return type in the desugaring is assumed to capture all lifetime + parameters from the `async fn` declaration. This can be seen in the + desugared example above, which explicitly outlives, and hence + captures, `'a`. +- The [`async move` block][async-blocks] in the body captures all function + parameters, including those that are unused or bound to a `_` + pattern. This ensures that function parameters are dropped in the + same order as they would be if the function were not async, except + that the drop occurs when the returned future has been fully + awaited. + +For more information on the effect of async, see [`async` blocks][async-blocks]. + +[async-blocks]: ../expressions/block-expr.md#async-blocks +[`impl Future`]: ../types/impl-trait.md + +> **Edition differences**: Async functions are only available beginning with +> Rust 2018. + +### Combining `async` and `unsafe` + +It is legal to declare a function that is both async and unsafe. The +resulting function is unsafe to call and (like any async function) +returns a future. This future is just an ordinary future and thus an +`unsafe` context is not required to "await" it: + +```rust +// Returns a future that, when awaited, dereferences `x`. +// +// Soundness condition: `x` must be safe to dereference until +// the resulting future is complete. +async unsafe fn unsafe_example(x: *const i32) -> i32 { + *x +} + +async fn safe_example() { + // An `unsafe` block is required to invoke the function initially: + let p = 22; + let future = unsafe { unsafe_example(&p) }; + + // But no `unsafe` block required here. This will + // read the value of `p`: + let q = future.await; +} +``` + +Note that this behavior is a consequence of the desugaring to a +function that returns an `impl Future` -- in this case, the function +we desugar to is an `unsafe` function, but the return value remains +the same. + +Unsafe is used on an async function in precisely the same way that it +is used on other functions: it indicates that the function imposes +some additional obligations on its caller to ensure soundness. As in any +other unsafe function, these conditions may extend beyond the initial +call itself -- in the snippet above, for example, the `unsafe_example` +function took a pointer `x` as argument, and then (when awaited) +dereferenced that pointer. This implies that `x` would have to be +valid until the future is finished executing, and it is the caller's +responsibility to ensure that. + +## Attributes on functions + +[Outer attributes][attributes] are allowed on functions. [Inner +attributes][attributes] are allowed directly after the `{` inside its [block]. + +This example shows an inner attribute on a function. The function is documented +with just the word "Example". + +```rust +fn documented() { + #![doc = "Example"] +} +``` + +> Note: Except for lints, it is idiomatic to only use outer attributes on +> function items. + +The attributes that have meaning on a function are [`cfg`], [`cfg_attr`], [`deprecated`], +[`doc`], [`export_name`], [`link_section`], [`no_mangle`], [the lint check +attributes], [`must_use`], [the procedural macro attributes], [the testing +attributes], and [the optimization hint attributes]. Functions also accept +attributes macros. + +## Attributes on function parameters + +[Outer attributes][attributes] are allowed on function parameters and the +permitted [built-in attributes] are restricted to `cfg`, `cfg_attr`, `allow`, +`warn`, `deny`, and `forbid`. + +```rust +fn len( + #[cfg(windows)] slice: &[u16], + #[cfg(not(windows))] slice: &[u8], +) -> usize { + slice.len() +} +``` + +Inert helper attributes used by procedural macro attributes applied to items are also +allowed but be careful to not include these inert attributes in your final `TokenStream`. + +For example, the following code defines an inert `some_inert_attribute` attribute that +is not formally defined anywhere and the `some_proc_macro_attribute` procedural macro is +responsible for detecting its presence and removing it from the output token stream. + + +```rust,ignore +#[some_proc_macro_attribute] +fn foo_oof(#[some_inert_attribute] arg: u8) { +} +``` + +[IDENTIFIER]: ../identifiers.md +[RAW_STRING_LITERAL]: ../tokens.md#raw-string-literals +[STRING_LITERAL]: ../tokens.md#string-literals +[_BlockExpression_]: ../expressions/block-expr.md +[_GenericParams_]: generics.md +[_Lifetime_]: ../trait-bounds.md +[_PatternNoTopAlt_]: ../patterns.md +[_Type_]: ../types.md#type-expressions +[_WhereClause_]: generics.md#where-clauses +[_OuterAttribute_]: ../attributes.md +[const contexts]: ../const_eval.md#const-context +[const functions]: ../const_eval.md#const-functions +[tuple struct]: structs.md +[tuple variant]: enumerations.md +[`extern`]: #extern-function-qualifier +[external block]: external-blocks.md +[path]: ../paths.md +[block]: ../expressions/block-expr.md +[variables]: ../variables.md +[type]: ../types.md#type-expressions +[unit type]: ../types/tuple.md +[*function item type*]: ../types/function-item.md +[Trait]: traits.md +[attributes]: ../attributes.md +[`cfg`]: ../conditional-compilation.md#the-cfg-attribute +[`cfg_attr`]: ../conditional-compilation.md#the-cfg_attr-attribute +[the lint check attributes]: ../attributes/diagnostics.md#lint-check-attributes +[the procedural macro attributes]: ../procedural-macros.md +[the testing attributes]: ../attributes/testing.md +[the optimization hint attributes]: ../attributes/codegen.md#optimization-hints +[`deprecated`]: ../attributes/diagnostics.md#the-deprecated-attribute +[`doc`]: ../../rustdoc/the-doc-attribute.html +[`must_use`]: ../attributes/diagnostics.md#the-must_use-attribute +[patterns]: ../patterns.md +[`export_name`]: ../abi.md#the-export_name-attribute +[`link_section`]: ../abi.md#the-link_section-attribute +[`no_mangle`]: ../abi.md#the-no_mangle-attribute +[built-in attributes]: ../attributes.html#built-in-attributes-index +[trait item]: traits.md +[method]: associated-items.md#methods +[associated function]: associated-items.md#associated-functions-and-methods +[implementation]: implementations.md +[variadic function]: external-blocks.md#variadic-functions diff --git a/src/doc/reference/src/items/generics.md b/src/doc/reference/src/items/generics.md new file mode 100644 index 000000000..5ffcd1580 --- /dev/null +++ b/src/doc/reference/src/items/generics.md @@ -0,0 +1,305 @@ +# Generic parameters + +> **Syntax**\ +> _GenericParams_ :\ +>       `<` `>`\ +>    | `<` (_GenericParam_ `,`)\* _GenericParam_ `,`? `>` +> +> _GenericParam_ :\ +>    [_OuterAttribute_]\* ( _LifetimeParam_ | _TypeParam_ | _ConstParam_ ) +> +> _LifetimeParam_ :\ +>    [LIFETIME_OR_LABEL] ( `:` [_LifetimeBounds_] )? +> +> _TypeParam_ :\ +>    [IDENTIFIER]( `:` [_TypeParamBounds_]? )? ( `=` [_Type_] )? +> +> _ConstParam_:\ +>    `const` [IDENTIFIER] `:` [_Type_] ( `=` _[Block][block]_ | [IDENTIFIER] | -?[LITERAL] )? + +[Functions], [type aliases], [structs], [enumerations], [unions], [traits], and +[implementations] may be *parameterized* by types, constants, and lifetimes. These +parameters are listed in angle brackets (`<...>`), +usually immediately after the name of the item and before its definition. For +implementations, which don't have a name, they come directly after `impl`. +The order of generic parameters is restricted to lifetime parameters and then type and const parameters intermixed. + +Some examples of items with type, const, and lifetime parameters: + +```rust +fn foo<'a, T>() {} +trait A {} +struct Ref<'a, T> where T: 'a { r: &'a T } +struct InnerArray([T; N]); +struct EitherOrderWorks(U); +``` + +Generic parameters are in scope within the item definition where they are +declared. They are not in scope for items declared within the body of a +function as described in [item declarations]. + +[References], [raw pointers], [arrays], [slices], [tuples], and +[function pointers] have lifetime or type parameters as well, but are not +referred to with path syntax. + +### Const generics + +*Const generic parameters* allow items to be generic over constant values. The +const identifier introduces a name for the constant parameter, and all +instances of the item must be instantiated with a value of the given type. + + + +The only allowed types of const parameters are `u8`, `u16`, `u32`, `u64`, `u128`, `usize` +`i8`, `i16`, `i32`, `i64`, `i128`, `isize`, `char` and `bool`. + +Const parameters can be used anywhere a [const item] can be used, with the +exception that when used in a [type] or [array repeat expression], it must be +standalone (as described below). That is, they are allowed in the following +places: + +1. As an applied const to any type which forms a part of the signature of the + item in question. +2. As part of a const expression used to define an [associated const], or as a + parameter to an [associated type]. +3. As a value in any runtime expression in the body of any functions in the + item. +4. As a parameter to any type used in the body of any functions in the item. +5. As a part of the type of any fields in the item. + +```rust +// Examples where const generic parameters can be used. + +// Used in the signature of the item itself. +fn foo(arr: [i32; N]) { + // Used as a type within a function body. + let x: [i32; N]; + // Used as an expression. + println!("{}", N * 2); +} + +// Used as a field of a struct. +struct Foo([i32; N]); + +impl Foo { + // Used as an associated constant. + const CONST: usize = N * 4; +} + +trait Trait { + type Output; +} + +impl Trait for Foo { + // Used as an associated type. + type Output = [i32; N]; +} +``` + +```rust,compile_fail +// Examples where const generic parameters cannot be used. +fn foo() { + // Cannot use in item definitions within a function body. + const BAD_CONST: [usize; N] = [1; N]; + static BAD_STATIC: [usize; N] = [1; N]; + fn inner(bad_arg: [usize; N]) { + let bad_value = N * 2; + } + type BadAlias = [usize; N]; + struct BadStruct([usize; N]); +} +``` + +As a further restriction, const parameters may only appear as a standalone +argument inside of a [type] or [array repeat expression]. In those contexts, +they may only be used as a single segment [path expression], possibly inside a +[block] (such as `N` or `{N}`). That is, they cannot be combined with other +expressions. + +```rust,compile_fail +// Examples where const parameters may not be used. + +// Not allowed to combine in other expressions in types, such as the +// arithmetic expression in the return type here. +fn bad_function() -> [u8; {N + 1}] { + // Similarly not allowed for array repeat expressions. + [1; {N + 1}] +} +``` + +A const argument in a [path] specifies the const value to use for that item. +The argument must be a [const expression] of the type ascribed to the const +parameter. The const expression must be a [block expression][block] +(surrounded with braces) unless it is a single path segment (an [IDENTIFIER]) +or a [literal] (with a possibly leading `-` token). + +> **Note**: This syntactic restriction is necessary to avoid requiring +> infinite lookahead when parsing an expression inside of a type. + +```rust +fn double() { + println!("doubled: {}", N * 2); +} + +const SOME_CONST: i32 = 12; + +fn example() { + // Example usage of a const argument. + double::<9>(); + double::<-123>(); + double::<{7 + 8}>(); + double::(); + double::<{ SOME_CONST + 5 }>(); +} +``` + +When there is ambiguity if a generic argument could be resolved as either a +type or const argument, it is always resolved as a type. Placing the argument +in a block expression can force it to be interpreted as a const argument. + + + +```rust,compile_fail +type N = u32; +struct Foo; +// The following is an error, because `N` is interpreted as the type alias `N`. +fn foo() -> Foo { todo!() } // ERROR +// Can be fixed by wrapping in braces to force it to be interpreted as the `N` +// const parameter: +fn bar() -> Foo<{ N }> { todo!() } // ok +``` + +Unlike type and lifetime parameters, const parameters can be declared without +being used inside of a parameterized item, with the exception of +implementations as described in [generic implementations]: + +```rust,compile_fail +// ok +struct Foo; +enum Bar { A, B } + +// ERROR: unused parameter +struct Baz; +struct Biz<'a>; +struct Unconstrained; +impl Unconstrained {} +``` + +When resolving a trait bound obligation, the exhaustiveness of all +implementations of const parameters is not considered when determining if the +bound is satisfied. For example, in the following, even though all possible +const values for the `bool` type are implemented, it is still an error that +the trait bound is not satisfied: + +```rust,compile_fail +struct Foo; +trait Bar {} +impl Bar for Foo {} +impl Bar for Foo {} + +fn needs_bar(_: impl Bar) {} +fn generic() { + let v = Foo::; + needs_bar(v); // ERROR: trait bound `Foo: Bar` is not satisfied +} +``` + + +## Where clauses + +> **Syntax**\ +> _WhereClause_ :\ +>    `where` ( _WhereClauseItem_ `,` )\* _WhereClauseItem_ ? +> +> _WhereClauseItem_ :\ +>       _LifetimeWhereClauseItem_\ +>    | _TypeBoundWhereClauseItem_ +> +> _LifetimeWhereClauseItem_ :\ +>    [_Lifetime_] `:` [_LifetimeBounds_] +> +> _TypeBoundWhereClauseItem_ :\ +>    [_ForLifetimes_]? [_Type_] `:` [_TypeParamBounds_]? + +*Where clauses* provide another way to specify bounds on type and lifetime +parameters as well as a way to specify bounds on types that aren't type +parameters. + +The `for` keyword can be used to introduce [higher-ranked lifetimes]. It only +allows [_LifetimeParam_] parameters. + +```rust +struct A +where + T: Iterator, // Could use A instead + T::Item: Copy, // Bound on an associated type + String: PartialEq, // Bound on `String`, using the type parameter + i32: Default, // Allowed, but not useful +{ + f: T, +} +``` + +## Attributes + +Generic lifetime and type parameters allow [attributes] on them. There are no +built-in attributes that do anything in this position, although custom derive +attributes may give meaning to it. + +This example shows using a custom derive attribute to modify the meaning of a +generic parameter. + + +```rust,ignore +// Assume that the derive for MyFlexibleClone declared `my_flexible_clone` as +// an attribute it understands. +#[derive(MyFlexibleClone)] +struct Foo<#[my_flexible_clone(unbounded)] H> { + a: *const H +} +``` + +[IDENTIFIER]: ../identifiers.md +[LIFETIME_OR_LABEL]: ../tokens.md#lifetimes-and-loop-labels + +[_ForLifetimes_]: ../trait-bounds.md#higher-ranked-trait-bounds +[_LifetimeParam_]: #generic-parameters +[_LifetimeBounds_]: ../trait-bounds.md +[_Lifetime_]: ../trait-bounds.md +[_OuterAttribute_]: ../attributes.md +[_Type_]: ../types.md#type-expressions +[_TypeParamBounds_]: ../trait-bounds.md + +[array repeat expression]: ../expressions/array-expr.md +[arrays]: ../types/array.md +[slices]: ../types/slice.md +[associated const]: associated-items.md#associated-constants +[associated type]: associated-items.md#associated-types +[block]: ../expressions/block-expr.md +[const contexts]: ../const_eval.md#const-context +[const expression]: ../const_eval.md#constant-expressions +[const item]: constant-items.md +[enumerations]: enumerations.md +[functions]: functions.md +[function pointers]: ../types/function-pointer.md +[generic implementations]: implementations.md#generic-implementations +[higher-ranked lifetimes]: ../trait-bounds.md#higher-ranked-trait-bounds +[implementations]: implementations.md +[item declarations]: ../statements.md#item-declarations +[item]: ../items.md +[literal]: ../expressions/literal-expr.md +[path]: ../paths.md +[path expression]: ../expressions/path-expr.md +[raw pointers]: ../types/pointer.md#raw-pointers-const-and-mut +[references]: ../types/pointer.md#shared-references- +[structs]: structs.md +[tuples]: ../types/tuple.md +[trait object]: ../types/trait-object.md +[traits]: traits.md +[type aliases]: type-aliases.md +[type]: ../types.md +[unions]: unions.md +[attributes]: ../attributes.md diff --git a/src/doc/reference/src/items/implementations.md b/src/doc/reference/src/items/implementations.md new file mode 100644 index 000000000..ee651cee5 --- /dev/null +++ b/src/doc/reference/src/items/implementations.md @@ -0,0 +1,295 @@ +# Implementations + +> **Syntax**\ +> _Implementation_ :\ +>    _InherentImpl_ | _TraitImpl_ +> +> _InherentImpl_ :\ +>    `impl` [_GenericParams_]? [_Type_] [_WhereClause_]? `{`\ +>       [_InnerAttribute_]\*\ +>       [_AssociatedItem_]\*\ +>    `}` +> +> _TraitImpl_ :\ +>    `unsafe`? `impl` [_GenericParams_]? `!`? +> [_TypePath_] `for` [_Type_]\ +>    [_WhereClause_]?\ +>    `{`\ +>       [_InnerAttribute_]\*\ +>       [_AssociatedItem_]\*\ +>    `}` + +An _implementation_ is an item that associates items with an _implementing type_. +Implementations are defined with the keyword `impl` and contain functions +that belong to an instance of the type that is being implemented or to the +type statically. + +There are two types of implementations: + +- inherent implementations +- [trait] implementations + +## Inherent Implementations + +An inherent implementation is defined as the sequence of the `impl` keyword, +generic type declarations, a path to a nominal type, a where clause, and a +bracketed set of associable items. + +The nominal type is called the _implementing type_ and the associable items are +the _associated items_ to the implementing type. + +Inherent implementations associate the contained items to the +implementing type. Inherent implementations can contain [associated +functions] (including [methods]) and [associated constants]. They cannot +contain associated type aliases. + +The [path] to an associated item is any path to the implementing type, +followed by the associated item's identifier as the final path +component. + +A type can also have multiple inherent implementations. An implementing type +must be defined within the same crate as the original type definition. + +``` rust +pub mod color { + pub struct Color(pub u8, pub u8, pub u8); + + impl Color { + pub const WHITE: Color = Color(255, 255, 255); + } +} + +mod values { + use super::color::Color; + impl Color { + pub fn red() -> Color { + Color(255, 0, 0) + } + } +} + +pub use self::color::Color; +fn main() { + // Actual path to the implementing type and impl in the same module. + color::Color::WHITE; + + // Impl blocks in different modules are still accessed through a path to the type. + color::Color::red(); + + // Re-exported paths to the implementing type also work. + Color::red(); + + // Does not work, because use in `values` is not pub. + // values::Color::red(); +} +``` + +## Trait Implementations + +A _trait implementation_ is defined like an inherent implementation except that +the optional generic type declarations are followed by a [trait], followed +by the keyword `for`, followed by a path to a nominal type. + + + +The trait is known as the _implemented trait_. The implementing type +implements the implemented trait. + +A trait implementation must define all non-default associated items declared +by the implemented trait, may redefine default associated items defined by the +implemented trait, and cannot define any other items. + +The path to the associated items is `<` followed by a path to the implementing +type followed by `as` followed by a path to the trait followed by `>` as a path +component followed by the associated item's path component. + +[Unsafe traits] require the trait implementation to begin with the `unsafe` +keyword. + +```rust +# #[derive(Copy, Clone)] +# struct Point {x: f64, y: f64}; +# type Surface = i32; +# struct BoundingBox {x: f64, y: f64, width: f64, height: f64}; +# trait Shape { fn draw(&self, s: Surface); fn bounding_box(&self) -> BoundingBox; } +# fn do_draw_circle(s: Surface, c: Circle) { } +struct Circle { + radius: f64, + center: Point, +} + +impl Copy for Circle {} + +impl Clone for Circle { + fn clone(&self) -> Circle { *self } +} + +impl Shape for Circle { + fn draw(&self, s: Surface) { do_draw_circle(s, *self); } + fn bounding_box(&self) -> BoundingBox { + let r = self.radius; + BoundingBox { + x: self.center.x - r, + y: self.center.y - r, + width: 2.0 * r, + height: 2.0 * r, + } + } +} +``` + +### Trait Implementation Coherence + +A trait implementation is considered incoherent if either the orphan rules check fails +or there are overlapping implementation instances. + +Two trait implementations overlap when there is a non-empty intersection of the +traits the implementation is for, the implementations can be instantiated with +the same type. + +#### Orphan rules + +Given `impl Trait for T0`, an `impl` is valid only if at +least one of the following is true: + +- `Trait` is a [local trait] +- All of + - At least one of the types `T0..=Tn` must be a [local type]. Let `Ti` be the + first such type. + - No [uncovered type] parameters `P1..=Pn` may appear in `T0..Ti` (excluding + `Ti`) + +Only the appearance of *uncovered* type parameters is restricted. +Note that for the purposes of coherence, [fundamental types] are +special. The `T` in `Box` is not considered covered, and `Box` +is considered local. + + +## Generic Implementations + +An implementation can take [generic parameters], which can be used in the rest +of the implementation. Implementation parameters are written directly after the +`impl` keyword. + +```rust +# trait Seq { fn dummy(&self, _: T) { } } +impl Seq for Vec { + /* ... */ +} +impl Seq for u32 { + /* Treat the integer as a sequence of bits */ +} +``` + +Generic parameters *constrain* an implementation if the parameter appears at +least once in one of: + +* The implemented trait, if it has one +* The implementing type +* As an [associated type] in the [bounds] of a type that contains another + parameter that constrains the implementation + +Type and const parameters must always constrain the implementation. Lifetimes +must constrain the implementation if the lifetime is used in an associated type. + +Examples of constraining situations: + +```rust +# trait Trait{} +# trait GenericTrait {} +# trait HasAssocType { type Ty; } +# struct Struct; +# struct GenericStruct(T); +# struct ConstGenericStruct([(); N]); +// T constrains by being an argument to GenericTrait. +impl GenericTrait for i32 { /* ... */ } + +// T constrains by being an arguement to GenericStruct +impl Trait for GenericStruct { /* ... */ } + +// Likewise, N constrains by being an argument to ConstGenericStruct +impl Trait for ConstGenericStruct { /* ... */ } + +// T constrains by being in an associated type in a bound for type `U` which is +// itself a generic parameter constraining the trait. +impl GenericTrait for u32 where U: HasAssocType { /* ... */ } + +// Like previous, except the type is `(U, isize)`. `U` appears inside the type +// that includes `T`, and is not the type itself. +impl GenericStruct where (U, isize): HasAssocType { /* ... */ } +``` + +Examples of non-constraining situations: + +```rust,compile_fail +// The rest of these are errors, since they have type or const parameters that +// do not constrain. + +// T does not constrain since it does not appear at all. +impl Struct { /* ... */ } + +// N does not constrain for the same reason. +impl Struct { /* ... */ } + +// Usage of T inside the implementation does not constrain the impl. +impl Struct { + fn uses_t(t: &T) { /* ... */ } +} + +// T is used as an associated type in the bounds for U, but U does not constrain. +impl Struct where U: HasAssocType { /* ... */ } + +// T is used in the bounds, but not as an associated type, so it does not constrain. +impl GenericTrait for u32 where U: GenericTrait {} +``` + +Example of an allowed unconstraining lifetime parameter: + +```rust +# struct Struct; +impl<'a> Struct {} +``` + +Example of a disallowed unconstraining lifetime parameter: + +```rust,compile_fail +# struct Struct; +# trait HasAssocType { type Ty; } +impl<'a> HasAssocType for Struct { + type Ty = &'a Struct; +} +``` + +## Attributes on Implementations + +Implementations may contain outer [attributes] before the `impl` keyword and +inner [attributes] inside the brackets that contain the associated items. Inner +attributes must come before any associated items. The attributes that have +meaning here are [`cfg`], [`deprecated`], [`doc`], and [the lint check +attributes]. + +[_AssociatedItem_]: associated-items.md +[_GenericParams_]: generics.md +[_InnerAttribute_]: ../attributes.md +[_TypePath_]: ../paths.md#paths-in-types +[_Type_]: ../types.md#type-expressions +[_WhereClause_]: generics.md#where-clauses +[trait]: traits.md +[associated constants]: associated-items.md#associated-constants +[associated functions]: associated-items.md#associated-functions-and-methods +[associated type]: associated-items.md#associated-types +[attributes]: ../attributes.md +[bounds]: ../trait-bounds.md +[`cfg`]: ../conditional-compilation.md +[`deprecated`]: ../attributes/diagnostics.md#the-deprecated-attribute +[`doc`]: ../../rustdoc/the-doc-attribute.html +[generic parameters]: generics.md +[methods]: associated-items.md#methods +[path]: ../paths.md +[the lint check attributes]: ../attributes/diagnostics.md#lint-check-attributes +[Unsafe traits]: traits.md#unsafe-traits +[local trait]: ../glossary.md#local-trait +[local type]: ../glossary.md#local-type +[fundamental types]: ../glossary.md#fundamental-type-constructors +[uncovered type]: ../glossary.md#uncovered-type diff --git a/src/doc/reference/src/items/modules.md b/src/doc/reference/src/items/modules.md new file mode 100644 index 000000000..2a0ad55c5 --- /dev/null +++ b/src/doc/reference/src/items/modules.md @@ -0,0 +1,166 @@ +# Modules + +> **Syntax:**\ +> _Module_ :\ +>       `unsafe`? `mod` [IDENTIFIER] `;`\ +>    | `unsafe`? `mod` [IDENTIFIER] `{`\ +>         [_InnerAttribute_]\*\ +>         [_Item_]\*\ +>       `}` + +A module is a container for zero or more [items]. + +A _module item_ is a module, surrounded in braces, named, and prefixed with the +keyword `mod`. A module item introduces a new, named module into the tree of +modules making up a crate. Modules can nest arbitrarily. + +An example of a module: + +```rust +mod math { + type Complex = (f64, f64); + fn sin(f: f64) -> f64 { + /* ... */ +# unimplemented!(); + } + fn cos(f: f64) -> f64 { + /* ... */ +# unimplemented!(); + } + fn tan(f: f64) -> f64 { + /* ... */ +# unimplemented!(); + } +} +``` + +Modules and types share the same namespace. Declaring a named type with the +same name as a module in scope is forbidden: that is, a type definition, trait, +struct, enumeration, union, type parameter or crate can't shadow the name of a +module in scope, or vice versa. Items brought into scope with `use` also have +this restriction. + +The `unsafe` keyword is syntactically allowed to appear before the `mod` +keyword, but it is rejected at a semantic level. This allows macros to consume +the syntax and make use of the `unsafe` keyword, before removing it from the +token stream. + +## Module Source Filenames + +A module without a body is loaded from an external file. When the module does +not have a `path` attribute, the path to the file mirrors the logical [module +path]. Ancestor module path components are directories, and the module's +contents are in a file with the name of the module plus the `.rs` extension. +For example, the following module structure can have this corresponding +filesystem structure: + +Module Path | Filesystem Path | File Contents +------------------------- | --------------- | ------------- +`crate` | `lib.rs` | `mod util;` +`crate::util` | `util.rs` | `mod config;` +`crate::util::config` | `util/config.rs` | + +Module filenames may also be the name of the module as a directory with the +contents in a file named `mod.rs` within that directory. The above example can +alternately be expressed with `crate::util`'s contents in a file named +`util/mod.rs`. It is not allowed to have both `util.rs` and `util/mod.rs`. + +> **Note**: Prior to `rustc` 1.30, using `mod.rs` files was the way to load +> a module with nested children. It is encouraged to use the new naming +> convention as it is more consistent, and avoids having many files named +> `mod.rs` within a project. + +### The `path` attribute + +The directories and files used for loading external file modules can be +influenced with the `path` attribute. + +For `path` attributes on modules not inside inline module blocks, the file +path is relative to the directory the source file is located. For example, the +following code snippet would use the paths shown based on where it is located: + + +```rust,ignore +#[path = "foo.rs"] +mod c; +``` + +Source File | `c`'s File Location | `c`'s Module Path +-------------- | ------------------- | ---------------------- +`src/a/b.rs` | `src/a/foo.rs` | `crate::a::b::c` +`src/a/mod.rs` | `src/a/foo.rs` | `crate::a::c` + +For `path` attributes inside inline module blocks, the relative location of +the file path depends on the kind of source file the `path` attribute is +located in. "mod-rs" source files are root modules (such as `lib.rs` or +`main.rs`) and modules with files named `mod.rs`. "non-mod-rs" source files +are all other module files. Paths for `path` attributes inside inline module +blocks in a mod-rs file are relative to the directory of the mod-rs file +including the inline module components as directories. For non-mod-rs files, +it is the same except the path starts with a directory with the name of the +non-mod-rs module. For example, the following code snippet would use the paths +shown based on where it is located: + + +```rust,ignore +mod inline { + #[path = "other.rs"] + mod inner; +} +``` + +Source File | `inner`'s File Location | `inner`'s Module Path +-------------- | --------------------------| ---------------------------- +`src/a/b.rs` | `src/a/b/inline/other.rs` | `crate::a::b::inline::inner` +`src/a/mod.rs` | `src/a/inline/other.rs` | `crate::a::inline::inner` + +An example of combining the above rules of `path` attributes on inline modules +and nested modules within (applies to both mod-rs and non-mod-rs files): + + +```rust,ignore +#[path = "thread_files"] +mod thread { + // Load the `local_data` module from `thread_files/tls.rs` relative to + // this source file's directory. + #[path = "tls.rs"] + mod local_data; +} +``` + +## Attributes on Modules + +Modules, like all items, accept outer attributes. They also accept inner +attributes: either after `{` for a module with a body, or at the beginning of the +source file, after the optional BOM and shebang. + +The built-in attributes that have meaning on a module are [`cfg`], +[`deprecated`], [`doc`], [the lint check attributes], [`path`], and +[`no_implicit_prelude`]. Modules also accept macro attributes. + +[_InnerAttribute_]: ../attributes.md +[_Item_]: ../items.md +[`cfg`]: ../conditional-compilation.md +[`deprecated`]: ../attributes/diagnostics.md#the-deprecated-attribute +[`doc`]: ../../rustdoc/the-doc-attribute.html +[`no_implicit_prelude`]: ../names/preludes.md#the-no_implicit_prelude-attribute +[`path`]: #the-path-attribute +[IDENTIFIER]: ../identifiers.md +[attribute]: ../attributes.md +[items]: ../items.md +[module path]: ../paths.md +[the lint check attributes]: ../attributes/diagnostics.md#lint-check-attributes + + diff --git a/src/doc/reference/src/items/static-items.md b/src/doc/reference/src/items/static-items.md new file mode 100644 index 000000000..e543b4fa6 --- /dev/null +++ b/src/doc/reference/src/items/static-items.md @@ -0,0 +1,131 @@ +# Static items + +> **Syntax**\ +> _StaticItem_ :\ +>    `static` `mut`? [IDENTIFIER] `:` [_Type_] +> ( `=` [_Expression_] )? `;` + +A *static item* is similar to a [constant], except that it represents a precise +memory location in the program. All references to the static refer to the same +memory location. Static items have the `static` lifetime, which outlives all +other lifetimes in a Rust program. Static items do not call [`drop`] at the +end of the program. + +The static initializer is a [constant expression] evaluated at compile time. +Static initializers may refer to other statics. + +Non-`mut` static items that contain a type that is not [interior mutable] may +be placed in read-only memory. + +All access to a static is safe, but there are a number of restrictions on +statics: + +* The type must have the `Sync` trait bound to allow thread-safe access. +* Constants cannot refer to statics. + +The initializer expression must be omitted in an [external block], and must be +provided for free static items. + +## Statics & generics + +A static item defined in a generic scope (for example in a blanket or default +implementation) will result in exactly one static item being defined, as if +the static definition was pulled out of the current scope into the module. +There will *not* be one item per monomorphization. + +This code: + +```rust +use std::sync::atomic::{AtomicUsize, Ordering}; + +trait Tr { + fn default_impl() { + static COUNTER: AtomicUsize = AtomicUsize::new(0); + println!("default_impl: counter was {}", COUNTER.fetch_add(1, Ordering::Relaxed)); + } + + fn blanket_impl(); +} + +struct Ty1 {} +struct Ty2 {} + +impl Tr for T { + fn blanket_impl() { + static COUNTER: AtomicUsize = AtomicUsize::new(0); + println!("blanket_impl: counter was {}", COUNTER.fetch_add(1, Ordering::Relaxed)); + } +} + +fn main() { + ::default_impl(); + ::default_impl(); + ::blanket_impl(); + ::blanket_impl(); +} +``` + +prints + +```text +default_impl: counter was 0 +default_impl: counter was 1 +blanket_impl: counter was 0 +blanket_impl: counter was 1 +``` + +## Mutable statics + +If a static item is declared with the `mut` keyword, then it is allowed to be +modified by the program. One of Rust's goals is to make concurrency bugs hard +to run into, and this is obviously a very large source of race conditions or +other bugs. For this reason, an `unsafe` block is required when either reading +or writing a mutable static variable. Care should be taken to ensure that +modifications to a mutable static are safe with respect to other threads +running in the same process. + +Mutable statics are still very useful, however. They can be used with C +libraries and can also be bound from C libraries in an `extern` block. + +```rust +# fn atomic_add(_: &mut u32, _: u32) -> u32 { 2 } + +static mut LEVELS: u32 = 0; + +// This violates the idea of no shared state, and this doesn't internally +// protect against races, so this function is `unsafe` +unsafe fn bump_levels_unsafe1() -> u32 { + let ret = LEVELS; + LEVELS += 1; + return ret; +} + +// Assuming that we have an atomic_add function which returns the old value, +// this function is "safe" but the meaning of the return value may not be what +// callers expect, so it's still marked as `unsafe` +unsafe fn bump_levels_unsafe2() -> u32 { + return atomic_add(&mut LEVELS, 1); +} +``` + +Mutable statics have the same restrictions as normal statics, except that the +type does not have to implement the `Sync` trait. + +## Using Statics or Consts + +It can be confusing whether or not you should use a constant item or a static +item. Constants should, in general, be preferred over statics unless one of the +following are true: + +* Large amounts of data are being stored +* The single-address property of statics is required. +* Interior mutability is required. + +[constant]: constant-items.md +[`drop`]: ../destructors.md +[constant expression]: ../const_eval.md#constant-expressions +[external block]: external-blocks.md +[interior mutable]: ../interior-mutability.md +[IDENTIFIER]: ../identifiers.md +[_Type_]: ../types.md#type-expressions +[_Expression_]: ../expressions.md diff --git a/src/doc/reference/src/items/structs.md b/src/doc/reference/src/items/structs.md new file mode 100644 index 000000000..9523e7bfb --- /dev/null +++ b/src/doc/reference/src/items/structs.md @@ -0,0 +1,88 @@ +# Structs + +> **Syntax**\ +> _Struct_ :\ +>       _StructStruct_\ +>    | _TupleStruct_ +> +> _StructStruct_ :\ +>    `struct` +> [IDENTIFIER]  +> [_GenericParams_]? +> [_WhereClause_]? +> ( `{` _StructFields_? `}` | `;` ) +> +> _TupleStruct_ :\ +>    `struct` +> [IDENTIFIER]  +> [_GenericParams_]? +> `(` _TupleFields_? `)` +> [_WhereClause_]? +> `;` +> +> _StructFields_ :\ +>    _StructField_ (`,` _StructField_)\* `,`? +> +> _StructField_ :\ +>    [_OuterAttribute_]\*\ +>    [_Visibility_]?\ +>    [IDENTIFIER] `:` [_Type_] +> +> _TupleFields_ :\ +>    _TupleField_ (`,` _TupleField_)\* `,`? +> +> _TupleField_ :\ +>    [_OuterAttribute_]\*\ +>    [_Visibility_]?\ +>    [_Type_] + +A _struct_ is a nominal [struct type] defined with the keyword `struct`. + +An example of a `struct` item and its use: + +```rust +struct Point {x: i32, y: i32} +let p = Point {x: 10, y: 11}; +let px: i32 = p.x; +``` + +A _tuple struct_ is a nominal [tuple type], also defined with the keyword +`struct`. For example: + +[struct type]: ../types/struct.md +[tuple type]: ../types/tuple.md + +```rust +struct Point(i32, i32); +let p = Point(10, 11); +let px: i32 = match p { Point(x, _) => x }; +``` + +A _unit-like struct_ is a struct without any fields, defined by leaving off the +list of fields entirely. Such a struct implicitly defines a constant of its +type with the same name. For example: + +```rust +struct Cookie; +let c = [Cookie, Cookie {}, Cookie, Cookie {}]; +``` + +is equivalent to + +```rust +struct Cookie {} +const Cookie: Cookie = Cookie {}; +let c = [Cookie, Cookie {}, Cookie, Cookie {}]; +``` + +The precise memory layout of a struct is not specified. One can specify a +particular layout using the [`repr` attribute]. + +[`repr` attribute]: ../type-layout.md#representations + +[_OuterAttribute_]: ../attributes.md +[IDENTIFIER]: ../identifiers.md +[_GenericParams_]: generics.md +[_WhereClause_]: generics.md#where-clauses +[_Visibility_]: ../visibility-and-privacy.md +[_Type_]: ../types.md#type-expressions diff --git a/src/doc/reference/src/items/traits.md b/src/doc/reference/src/items/traits.md new file mode 100644 index 000000000..26870a0fc --- /dev/null +++ b/src/doc/reference/src/items/traits.md @@ -0,0 +1,343 @@ +# Traits + +> **Syntax**\ +> _Trait_ :\ +>    `unsafe`? `trait` [IDENTIFIER]  +> [_GenericParams_]? +> ( `:` [_TypeParamBounds_]? )? +> [_WhereClause_]? `{`\ +>      [_InnerAttribute_]\*\ +>      [_AssociatedItem_]\*\ +>    `}` + +A _trait_ describes an abstract interface that types can implement. This +interface consists of [associated items], which come in three varieties: + +- [functions](associated-items.md#associated-functions-and-methods) +- [types](associated-items.md#associated-types) +- [constants](associated-items.md#associated-constants) + +All traits define an implicit type parameter `Self` that refers to "the type +that is implementing this interface". Traits may also contain additional type +parameters. These type parameters, including `Self`, may be constrained by +other traits and so forth [as usual][generics]. + +Traits are implemented for specific types through separate [implementations]. + +Trait functions may omit the function body by replacing it with a semicolon. +This indicates that the implementation must define the function. If the trait +function defines a body, this definition acts as a default for any +implementation which does not override it. Similarly, associated constants may +omit the equals sign and expression to indicate implementations must define +the constant value. Associated types must never define the type, the type may +only be specified in an implementation. + +```rust +// Examples of associated trait items with and without definitions. +trait Example { + const CONST_NO_DEFAULT: i32; + const CONST_WITH_DEFAULT: i32 = 99; + type TypeNoDefault; + fn method_without_default(&self); + fn method_with_default(&self) {} +} +``` + +Trait functions are not allowed to be [`async`] or [`const`]. + +## Trait bounds + +Generic items may use traits as [bounds] on their type parameters. + +## Generic Traits + +Type parameters can be specified for a trait to make it generic. These appear +after the trait name, using the same syntax used in [generic functions]. + +```rust +trait Seq { + fn len(&self) -> u32; + fn elt_at(&self, n: u32) -> T; + fn iter(&self, f: F) where F: Fn(T); +} +``` + +## Object Safety + +Object safe traits can be the base trait of a [trait object]. A trait is +*object safe* if it has the following qualities (defined in [RFC 255]): + +* All [supertraits] must also be object safe. +* `Sized` must not be a [supertrait][supertraits]. In other words, it must not require `Self: Sized`. +* It must not have any associated constants. +* All associated functions must either be dispatchable from a trait object or be explicitly non-dispatchable: + * Dispatchable functions require: + * Not have any type parameters (although lifetime parameters are allowed), + * Be a [method] that does not use `Self` except in the type of the receiver. + * Have a receiver with one of the following types: + * `&Self` (i.e. `&self`) + * `&mut Self` (i.e `&mut self`) + * [`Box`] + * [`Rc`] + * [`Arc`] + * [`Pin

`] where `P` is one of the types above + * Does not have a `where Self: Sized` bound (receiver type of `Self` (i.e. `self`) implies this). + * Explicitly non-dispatchable functions require: + * Have a `where Self: Sized` bound (receiver type of `Self` (i.e. `self`) implies this). + +```rust +# use std::rc::Rc; +# use std::sync::Arc; +# use std::pin::Pin; +// Examples of object safe methods. +trait TraitMethods { + fn by_ref(self: &Self) {} + fn by_ref_mut(self: &mut Self) {} + fn by_box(self: Box) {} + fn by_rc(self: Rc) {} + fn by_arc(self: Arc) {} + fn by_pin(self: Pin<&Self>) {} + fn with_lifetime<'a>(self: &'a Self) {} + fn nested_pin(self: Pin>) {} +} +# struct S; +# impl TraitMethods for S {} +# let t: Box = Box::new(S); +``` + +```rust,compile_fail +// This trait is object-safe, but these methods cannot be dispatched on a trait object. +trait NonDispatchable { + // Non-methods cannot be dispatched. + fn foo() where Self: Sized {} + // Self type isn't known until runtime. + fn returns(&self) -> Self where Self: Sized; + // `other` may be a different concrete type of the receiver. + fn param(&self, other: Self) where Self: Sized {} + // Generics are not compatible with vtables. + fn typed(&self, x: T) where Self: Sized {} +} + +struct S; +impl NonDispatchable for S { + fn returns(&self) -> Self where Self: Sized { S } +} +let obj: Box = Box::new(S); +obj.returns(); // ERROR: cannot call with Self return +obj.param(S); // ERROR: cannot call with Self parameter +obj.typed(1); // ERROR: cannot call with generic type +``` + +```rust,compile_fail +# use std::rc::Rc; +// Examples of non-object safe traits. +trait NotObjectSafe { + const CONST: i32 = 1; // ERROR: cannot have associated const + + fn foo() {} // ERROR: associated function without Sized + fn returns(&self) -> Self; // ERROR: Self in return type + fn typed(&self, x: T) {} // ERROR: has generic type parameters + fn nested(self: Rc>) {} // ERROR: nested receiver not yet supported +} + +struct S; +impl NotObjectSafe for S { + fn returns(&self) -> Self { S } +} +let obj: Box = Box::new(S); // ERROR +``` + +```rust,compile_fail +// Self: Sized traits are not object-safe. +trait TraitWithSize where Self: Sized {} + +struct S; +impl TraitWithSize for S {} +let obj: Box = Box::new(S); // ERROR +``` + +```rust,compile_fail +// Not object safe if `Self` is a type argument. +trait Super {} +trait WithSelf: Super where Self: Sized {} + +struct S; +impl Super for S {} +impl WithSelf for S {} +let obj: Box = Box::new(S); // ERROR: cannot use `Self` type parameter +``` + +## Supertraits + +**Supertraits** are traits that are required to be implemented for a type to +implement a specific trait. Furthermore, anywhere a [generic][generics] or [trait object] +is bounded by a trait, it has access to the associated items of its supertraits. + +Supertraits are declared by trait bounds on the `Self` type of a trait and +transitively the supertraits of the traits declared in those trait bounds. It is +an error for a trait to be its own supertrait. + +The trait with a supertrait is called a **subtrait** of its supertrait. + +The following is an example of declaring `Shape` to be a supertrait of `Circle`. + +```rust +trait Shape { fn area(&self) -> f64; } +trait Circle : Shape { fn radius(&self) -> f64; } +``` + +And the following is the same example, except using [where clauses]. + +```rust +trait Shape { fn area(&self) -> f64; } +trait Circle where Self: Shape { fn radius(&self) -> f64; } +``` + +This next example gives `radius` a default implementation using the `area` +function from `Shape`. + +```rust +# trait Shape { fn area(&self) -> f64; } +trait Circle where Self: Shape { + fn radius(&self) -> f64 { + // A = pi * r^2 + // so algebraically, + // r = sqrt(A / pi) + (self.area() /std::f64::consts::PI).sqrt() + } +} +``` + +This next example calls a supertrait method on a generic parameter. + +```rust +# trait Shape { fn area(&self) -> f64; } +# trait Circle : Shape { fn radius(&self) -> f64; } +fn print_area_and_radius(c: C) { + // Here we call the area method from the supertrait `Shape` of `Circle`. + println!("Area: {}", c.area()); + println!("Radius: {}", c.radius()); +} +``` + +Similarly, here is an example of calling supertrait methods on trait objects. + +```rust +# trait Shape { fn area(&self) -> f64; } +# trait Circle : Shape { fn radius(&self) -> f64; } +# struct UnitCircle; +# impl Shape for UnitCircle { fn area(&self) -> f64 { std::f64::consts::PI } } +# impl Circle for UnitCircle { fn radius(&self) -> f64 { 1.0 } } +# let circle = UnitCircle; +let circle = Box::new(circle) as Box; +let nonsense = circle.radius() * circle.area(); +``` + +## Unsafe traits + +Traits items that begin with the `unsafe` keyword indicate that *implementing* the +trait may be [unsafe]. It is safe to use a correctly implemented unsafe trait. +The [trait implementation] must also begin with the `unsafe` keyword. + +[`Sync`] and [`Send`] are examples of unsafe traits. + +## Parameter patterns + +Function or method declarations without a body only allow [IDENTIFIER] or +`_` [wild card][WildcardPattern] patterns. `mut` [IDENTIFIER] is currently +allowed, but it is deprecated and will become a hard error in the future. + + +In the 2015 edition, the pattern for a trait function or method parameter is +optional: + +```rust,edition2015 +// 2015 Edition +trait T { + fn f(i32); // Parameter identifiers are not required. +} +``` + +The kinds of patterns for parameters is limited to one of the following: + +* [IDENTIFIER] +* `mut` [IDENTIFIER] +* [`_`][WildcardPattern] +* `&` [IDENTIFIER] +* `&&` [IDENTIFIER] + +Beginning in the 2018 edition, function or method parameter patterns are no +longer optional. Also, all irrefutable patterns are allowed as long as there +is a body. Without a body, the limitations listed above are still in effect. + +```rust +trait T { + fn f1((a, b): (i32, i32)) {} + fn f2(_: (i32, i32)); // Cannot use tuple pattern without a body. +} +``` + +## Item visibility + +Trait items syntactically allow a [_Visibility_] annotation, but this is +rejected when the trait is validated. This allows items to be parsed with a +unified syntax across different contexts where they are used. As an example, +an empty `vis` macro fragment specifier can be used for trait items, where the +macro rule may be used in other situations where visibility is allowed. + +```rust +macro_rules! create_method { + ($vis:vis $name:ident) => { + $vis fn $name(&self) {} + }; +} + +trait T1 { + // Empty `vis` is allowed. + create_method! { method_of_t1 } +} + +struct S; + +impl S { + // Visibility is allowed here. + create_method! { pub method_of_s } +} + +impl T1 for S {} + +fn main() { + let s = S; + s.method_of_t1(); + s.method_of_s(); +} +``` + +[IDENTIFIER]: ../identifiers.md +[WildcardPattern]: ../patterns.md#wildcard-pattern +[_AssociatedItem_]: associated-items.md +[_GenericParams_]: generics.md +[_InnerAttribute_]: ../attributes.md +[_TypeParamBounds_]: ../trait-bounds.md +[_Visibility_]: ../visibility-and-privacy.md +[_WhereClause_]: generics.md#where-clauses +[bounds]: ../trait-bounds.md +[trait object]: ../types/trait-object.md +[RFC 255]: https://github.com/rust-lang/rfcs/blob/master/text/0255-object-safety.md +[associated items]: associated-items.md +[method]: associated-items.md#methods +[supertraits]: #supertraits +[implementations]: implementations.md +[generics]: generics.md +[where clauses]: generics.md#where-clauses +[generic functions]: functions.md#generic-functions +[unsafe]: ../unsafety.md +[trait implementation]: implementations.md#trait-implementations +[`Send`]: ../special-types-and-traits.md#send +[`Sync`]: ../special-types-and-traits.md#sync +[`Arc`]: ../special-types-and-traits.md#arct +[`Box`]: ../special-types-and-traits.md#boxt +[`Pin

`]: ../special-types-and-traits.md#pinp +[`Rc`]: ../special-types-and-traits.md#rct +[`async`]: functions.md#async-functions +[`const`]: functions.md#const-functions diff --git a/src/doc/reference/src/items/type-aliases.md b/src/doc/reference/src/items/type-aliases.md new file mode 100644 index 000000000..ff0cc75f7 --- /dev/null +++ b/src/doc/reference/src/items/type-aliases.md @@ -0,0 +1,47 @@ +# Type aliases + +> **Syntax**\ +> _TypeAlias_ :\ +>    `type` [IDENTIFIER] [_GenericParams_]? +> ( `:` [_TypeParamBounds_] )? +> [_WhereClause_]? ( `=` [_Type_] )? `;` + +A _type alias_ defines a new name for an existing [type]. Type aliases are +declared with the keyword `type`. Every value has a single, specific type, but +may implement several different traits, or be compatible with several different +type constraints. + +For example, the following defines the type `Point` as a synonym for the type +`(u8, u8)`, the type of pairs of unsigned 8 bit integers: + +```rust +type Point = (u8, u8); +let p: Point = (41, 68); +``` + +A type alias to a tuple-struct or unit-struct cannot be used to qualify that type's constructor: + +```rust,compile_fail +struct MyStruct(u32); + +use MyStruct as UseAlias; +type TypeAlias = MyStruct; + +let _ = UseAlias(5); // OK +let _ = TypeAlias(5); // Doesn't work +``` + +A type alias without the [_Type_] specification may only appear as an +[associated type] in a [trait]. + +A type alias with [_TypeParamBounds_] may only specified when used as +an [associated type] in a [trait]. + +[IDENTIFIER]: ../identifiers.md +[_GenericParams_]: generics.md +[_TypeParamBounds_]: ../trait-bounds.md +[_WhereClause_]: generics.md#where-clauses +[_Type_]: ../types.md#type-expressions +[associated type]: associated-items.md#associated-types +[trait]: traits.md +[type]: ../types.md diff --git a/src/doc/reference/src/items/unions.md b/src/doc/reference/src/items/unions.md new file mode 100644 index 000000000..325b22717 --- /dev/null +++ b/src/doc/reference/src/items/unions.md @@ -0,0 +1,180 @@ +# Unions + +> **Syntax**\ +> _Union_ :\ +>    `union` [IDENTIFIER] [_GenericParams_]? [_WhereClause_]? +> `{`[_StructFields_] `}` + +A union declaration uses the same syntax as a struct declaration, except with +`union` in place of `struct`. + +```rust +#[repr(C)] +union MyUnion { + f1: u32, + f2: f32, +} +``` + +The key property of unions is that all fields of a union share common storage. +As a result, writes to one field of a union can overwrite its other fields, and +size of a union is determined by the size of its largest field. + +Union field types are restricted to the following subset of types: +- `Copy` types +- References (`&T` and `&mut T` for arbitrary `T`) +- `ManuallyDrop` (for arbitrary `T`) +- Tuples and arrays containing only allowed union field types + +This restriction ensures, in particular, that union fields never need to be +dropped. Like for structs and enums, it is possible to `impl Drop` for a union +to manually define what happens when it gets dropped. + +## Initialization of a union + +A value of a union type can be created using the same syntax that is used for +struct types, except that it must specify exactly one field: + +```rust +# union MyUnion { f1: u32, f2: f32 } +# +let u = MyUnion { f1: 1 }; +``` + +The expression above creates a value of type `MyUnion` and initializes the +storage using field `f1`. The union can be accessed using the same syntax as +struct fields: + +```rust +# union MyUnion { f1: u32, f2: f32 } +# +# let u = MyUnion { f1: 1 }; +let f = unsafe { u.f1 }; +``` + +## Reading and writing union fields + +Unions have no notion of an "active field". Instead, every union access just +interprets the storage at the type of the field used for the access. Reading a +union field reads the bits of the union at the field's type. Fields might have a +non-zero offset (except when [the C representation] is used); in that case the +bits starting at the offset of the fields are read. It is the programmer's +responsibility to make sure that the data is valid at the field's type. Failing +to do so results in [undefined behavior]. For example, reading the value `3` +through of a field of the [boolean type] is undefined behavior. Effectively, +writing to and then reading from a union with [the C representation] is +analogous to a [`transmute`] from the type used for writing to the type used for +reading. + +Consequently, all reads of union fields have to be placed in `unsafe` blocks: + +```rust +# union MyUnion { f1: u32, f2: f32 } +# let u = MyUnion { f1: 1 }; +# +unsafe { + let f = u.f1; +} +``` + +Commonly, code using unions will provide safe wrappers around unsafe union +field accesses. + +In contrast, writes to union fields are safe, since they just overwrite +arbitrary data, but cannot cause undefined behavior. (Note that union field +types can never have drop glue, so a union field write will never implicitly +drop anything.) + +## Pattern matching on unions + +Another way to access union fields is to use pattern matching. Pattern matching +on union fields uses the same syntax as struct patterns, except that the pattern +must specify exactly one field. Since pattern matching is like reading the union +with a particular field, it has to be placed in `unsafe` blocks as well. + +```rust +# union MyUnion { f1: u32, f2: f32 } +# +fn f(u: MyUnion) { + unsafe { + match u { + MyUnion { f1: 10 } => { println!("ten"); } + MyUnion { f2 } => { println!("{}", f2); } + } + } +} +``` + +Pattern matching may match a union as a field of a larger structure. In +particular, when using a Rust union to implement a C tagged union via FFI, this +allows matching on the tag and the corresponding field simultaneously: + +```rust +#[repr(u32)] +enum Tag { I, F } + +#[repr(C)] +union U { + i: i32, + f: f32, +} + +#[repr(C)] +struct Value { + tag: Tag, + u: U, +} + +fn is_zero(v: Value) -> bool { + unsafe { + match v { + Value { tag: Tag::I, u: U { i: 0 } } => true, + Value { tag: Tag::F, u: U { f: num } } if num == 0.0 => true, + _ => false, + } + } +} +``` + +## References to union fields + +Since union fields share common storage, gaining write access to one field of a +union can give write access to all its remaining fields. Borrow checking rules +have to be adjusted to account for this fact. As a result, if one field of a +union is borrowed, all its remaining fields are borrowed as well for the same +lifetime. + +```rust,compile_fail +# union MyUnion { f1: u32, f2: f32 } +// ERROR: cannot borrow `u` (via `u.f2`) as mutable more than once at a time +fn test() { + let mut u = MyUnion { f1: 1 }; + unsafe { + let b1 = &mut u.f1; +// ---- first mutable borrow occurs here (via `u.f1`) + let b2 = &mut u.f2; +// ^^^^ second mutable borrow occurs here (via `u.f2`) + *b1 = 5; + } +// - first borrow ends here + assert_eq!(unsafe { u.f1 }, 5); +} +``` + +As you could see, in many aspects (except for layouts, safety, and ownership) +unions behave exactly like structs, largely as a consequence of inheriting +their syntactic shape from structs. This is also true for many unmentioned +aspects of Rust language (such as privacy, name resolution, type inference, +generics, trait implementations, inherent implementations, coherence, pattern +checking, etc etc etc). + +[IDENTIFIER]: ../identifiers.md +[_GenericParams_]: generics.md +[_WhereClause_]: generics.md#where-clauses +[_StructFields_]: structs.md +[`transmute`]: ../../std/mem/fn.transmute.html +[`Copy`]: ../../std/marker/trait.Copy.html +[boolean type]: ../types/boolean.md +[ManuallyDrop]: ../../std/mem/struct.ManuallyDrop.html +[the C representation]: ../type-layout.md#reprc-unions +[undefined behavior]: ../behavior-considered-undefined.html diff --git a/src/doc/reference/src/items/use-declarations.md b/src/doc/reference/src/items/use-declarations.md new file mode 100644 index 000000000..e2e202776 --- /dev/null +++ b/src/doc/reference/src/items/use-declarations.md @@ -0,0 +1,208 @@ +# Use declarations + +> **Syntax:**\ +> _UseDeclaration_ :\ +>    `use` _UseTree_ `;` +> +> _UseTree_ :\ +>       ([_SimplePath_]? `::`)? `*`\ +>    | ([_SimplePath_]? `::`)? `{` (_UseTree_ ( `,` _UseTree_ )\* `,`?)? `}`\ +>    | [_SimplePath_] ( `as` ( [IDENTIFIER] | `_` ) )? + +A _use declaration_ creates one or more local name bindings synonymous with +some other [path]. Usually a `use` declaration is used to shorten the path +required to refer to a module item. These declarations may appear in [modules] +and [blocks], usually at the top. + +[path]: ../paths.md +[modules]: modules.md +[blocks]: ../expressions/block-expr.md + +Use declarations support a number of convenient shortcuts: + +* Simultaneously binding a list of paths with a common prefix, using the + glob-like brace syntax `use a::b::{c, d, e::f, g::h::i};` +* Simultaneously binding a list of paths with a common prefix and their common + parent module, using the `self` keyword, such as `use a::b::{self, c, d::e};` +* Rebinding the target name as a new local name, using the syntax `use p::q::r + as x;`. This can also be used with the last two features: + `use a::b::{self as ab, c as abc}`. +* Binding all paths matching a given prefix, using the asterisk wildcard syntax + `use a::b::*;`. +* Nesting groups of the previous features multiple times, such as + `use a::b::{self as ab, c, d::{*, e::f}};` + +An example of `use` declarations: + +```rust +use std::collections::hash_map::{self, HashMap}; + +fn foo(_: T){} +fn bar(map1: HashMap, map2: hash_map::HashMap){} + +fn main() { + // use declarations can also exist inside of functions + use std::option::Option::{Some, None}; + + // Equivalent to 'foo(vec![std::option::Option::Some(1.0f64), + // std::option::Option::None]);' + foo(vec![Some(1.0f64), None]); + + // Both `hash_map` and `HashMap` are in scope. + let map1 = HashMap::new(); + let map2 = hash_map::HashMap::new(); + bar(map1, map2); +} +``` + +## `use` Visibility + +Like items, `use` declarations are private to the containing module, by +default. Also like items, a `use` declaration can be public, if qualified by +the `pub` keyword. Such a `use` declaration serves to _re-export_ a name. A +public `use` declaration can therefore _redirect_ some public name to a +different target definition: even a definition with a private canonical path, +inside a different module. If a sequence of such redirections form a cycle or +cannot be resolved unambiguously, they represent a compile-time error. + +An example of re-exporting: + +```rust +mod quux { + pub use self::foo::{bar, baz}; + pub mod foo { + pub fn bar() {} + pub fn baz() {} + } +} + +fn main() { + quux::bar(); + quux::baz(); +} +``` + +In this example, the module `quux` re-exports two public names defined in +`foo`. + +## `use` Paths + +> **Note**: This section is incomplete. + +Some examples of what will and will not work for `use` items: + + +```rust +# #![allow(unused_imports)] +use std::path::{self, Path, PathBuf}; // good: std is a crate name +use crate::foo::baz::foobaz; // good: foo is at the root of the crate + +mod foo { + + pub mod example { + pub mod iter {} + } + + use crate::foo::example::iter; // good: foo is at crate root +// use example::iter; // bad in 2015 edition: relative paths are not allowed without `self`; good in 2018 edition + use self::baz::foobaz; // good: self refers to module 'foo' + use crate::foo::bar::foobar; // good: foo is at crate root + + pub mod bar { + pub fn foobar() { } + } + + pub mod baz { + use super::bar::foobar; // good: super refers to module 'foo' + pub fn foobaz() { } + } +} + +fn main() {} +``` + +> **Edition Differences**: In the 2015 edition, `use` paths also allow +> accessing items in the crate root. Using the example above, the following +> `use` paths work in 2015 but not 2018: +> +> ```rust,edition2015 +> # mod foo { +> # pub mod example { pub mod iter {} } +> # pub mod baz { pub fn foobaz() {} } +> # } +> use foo::example::iter; +> use ::foo::baz::foobaz; +> # fn main() {} +> ``` +> +> The 2015 edition does not allow use declarations to reference the [extern prelude]. +> Thus [`extern crate`] declarations are still required in 2015 to +> reference an external crate in a use declaration. Beginning with the 2018 +> edition, use declarations can specify an external crate dependency the same +> way `extern crate` can. +> +> In the 2018 edition, if an in-scope item has the same name as an external +> crate, then `use` of that crate name requires a leading `::` to +> unambiguously select the crate name. This is to retain compatibility with +> potential future changes. +> +> ```rust +> // use std::fs; // Error, this is ambiguous. +> use ::std::fs; // Imports from the `std` crate, not the module below. +> use self::std::fs as self_fs; // Imports the module below. +> +> mod std { +> pub mod fs {} +> } +> # fn main() {} +> ``` + +## Underscore Imports + +Items can be imported without binding to a name by using an underscore with +the form `use path as _`. This is particularly useful to import a trait so +that its methods may be used without importing the trait's symbol, for example +if the trait's symbol may conflict with another symbol. Another example is to +link an external crate without importing its name. + +Asterisk glob imports will import items imported with `_` in their unnameable +form. + +```rust +mod foo { + pub trait Zoo { + fn zoo(&self) {} + } + + impl Zoo for T {} +} + +use self::foo::Zoo as _; +struct Zoo; // Underscore import avoids name conflict with this item. + +fn main() { + let z = Zoo; + z.zoo(); +} +``` + +The unique, unnameable symbols are created after macro expansion so that +macros may safely emit multiple references to `_` imports. For example, the +following should not produce an error: + +```rust +macro_rules! m { + ($item: item) => { $item $item } +} + +m!(use std as _;); +// This expands to: +// use std as _; +// use std as _; +``` + +[IDENTIFIER]: ../identifiers.md +[_SimplePath_]: ../paths.md#simple-paths +[`extern crate`]: extern-crates.md +[extern prelude]: ../names/preludes.md#extern-prelude +[path qualifiers]: ../paths.md#path-qualifiers diff --git a/src/doc/reference/src/keywords.md b/src/doc/reference/src/keywords.md new file mode 100644 index 000000000..67f1089d8 --- /dev/null +++ b/src/doc/reference/src/keywords.md @@ -0,0 +1,132 @@ +# Keywords + +Rust divides keywords into three categories: + +* [strict](#strict-keywords) +* [reserved](#reserved-keywords) +* [weak](#weak-keywords) + +## Strict keywords + +These keywords can only be used in their correct contexts. They cannot +be used as the names of: + +* [Items] +* [Variables] and function parameters +* Fields and [variants] +* [Type parameters] +* Lifetime parameters or [loop labels] +* [Macros] or [attributes] +* [Macro placeholders] +* [Crates] + +> **Lexer:**\ +> KW_AS : `as`\ +> KW_BREAK : `break`\ +> KW_CONST : `const`\ +> KW_CONTINUE : `continue`\ +> KW_CRATE : `crate`\ +> KW_ELSE : `else`\ +> KW_ENUM : `enum`\ +> KW_EXTERN : `extern`\ +> KW_FALSE : `false`\ +> KW_FN : `fn`\ +> KW_FOR : `for`\ +> KW_IF : `if`\ +> KW_IMPL : `impl`\ +> KW_IN : `in`\ +> KW_LET : `let`\ +> KW_LOOP : `loop`\ +> KW_MATCH : `match`\ +> KW_MOD : `mod`\ +> KW_MOVE : `move`\ +> KW_MUT : `mut`\ +> KW_PUB : `pub`\ +> KW_REF : `ref`\ +> KW_RETURN : `return`\ +> KW_SELFVALUE : `self`\ +> KW_SELFTYPE : `Self`\ +> KW_STATIC : `static`\ +> KW_STRUCT : `struct`\ +> KW_SUPER : `super`\ +> KW_TRAIT : `trait`\ +> KW_TRUE : `true`\ +> KW_TYPE : `type`\ +> KW_UNSAFE : `unsafe`\ +> KW_USE : `use`\ +> KW_WHERE : `where`\ +> KW_WHILE : `while` + +The following keywords were added beginning in the 2018 edition. + +> **Lexer 2018+**\ +> KW_ASYNC : `async`\ +> KW_AWAIT : `await`\ +> KW_DYN : `dyn` + +## Reserved keywords + +These keywords aren't used yet, but they are reserved for future use. They have +the same restrictions as strict keywords. The reasoning behind this is to make +current programs forward compatible with future versions of Rust by forbidding +them to use these keywords. + +> **Lexer**\ +> KW_ABSTRACT : `abstract`\ +> KW_BECOME : `become`\ +> KW_BOX : `box`\ +> KW_DO : `do`\ +> KW_FINAL : `final`\ +> KW_MACRO : `macro`\ +> KW_OVERRIDE : `override`\ +> KW_PRIV : `priv`\ +> KW_TYPEOF : `typeof`\ +> KW_UNSIZED : `unsized`\ +> KW_VIRTUAL : `virtual`\ +> KW_YIELD : `yield` + +The following keywords are reserved beginning in the 2018 edition. + +> **Lexer 2018+**\ +> KW_TRY : `try` + +## Weak keywords + +These keywords have special meaning only in certain contexts. For example, it +is possible to declare a variable or method with the name `union`. + +* `macro_rules` is used to create custom [macros]. +* `union` is used to declare a [union] and is only a keyword when used in a + union declaration. +* `'static` is used for the static lifetime and cannot be used as a [generic + lifetime parameter] or [loop label] + + ```compile_fail + // error[E0262]: invalid lifetime parameter name: `'static` + fn invalid_lifetime_parameter<'static>(s: &'static str) -> &'static str { s } + ``` +* In the 2015 edition, [`dyn`] is a keyword when used in a type position + followed by a path that does not start with `::`. + + Beginning in the 2018 edition, `dyn` has been promoted to a strict keyword. + +> **Lexer**\ +> KW_UNION : `union`\ +> KW_STATICLIFETIME : `'static` +> +> **Lexer 2015**\ +> KW_DYN : `dyn` + +[items]: items.md +[Variables]: variables.md +[Type parameters]: types/parameters.md +[loop labels]: expressions/loop-expr.md#loop-labels +[Macros]: macros.md +[attributes]: attributes.md +[Macro placeholders]: macros-by-example.md +[Crates]: crates-and-source-files.md +[union]: items/unions.md +[variants]: items/enumerations.md +[`dyn`]: types/trait-object.md +[loop label]: expressions/loop-expr.md#loop-labels +[generic lifetime parameter]: items/generics.md diff --git a/src/doc/reference/src/lexical-structure.md b/src/doc/reference/src/lexical-structure.md new file mode 100644 index 000000000..5e1388e0d --- /dev/null +++ b/src/doc/reference/src/lexical-structure.md @@ -0,0 +1 @@ +# Lexical structure diff --git a/src/doc/reference/src/lifetime-elision.md b/src/doc/reference/src/lifetime-elision.md new file mode 100644 index 000000000..e8a20e2e8 --- /dev/null +++ b/src/doc/reference/src/lifetime-elision.md @@ -0,0 +1,212 @@ +# Lifetime elision + +Rust has rules that allow lifetimes to be elided in various places where the +compiler can infer a sensible default choice. + +## Lifetime elision in functions + +In order to make common patterns more ergonomic, lifetime arguments can be +*elided* in [function item], [function pointer], and [closure trait] signatures. +The following rules are used to infer lifetime parameters for elided lifetimes. +It is an error to elide lifetime parameters that cannot be inferred. The +placeholder lifetime, `'_`, can also be used to have a lifetime inferred in the +same way. For lifetimes in paths, using `'_` is preferred. Trait object +lifetimes follow different rules discussed +[below](#default-trait-object-lifetimes). + +* Each elided lifetime in the parameters becomes a distinct lifetime parameter. +* If there is exactly one lifetime used in the parameters (elided or not), that + lifetime is assigned to *all* elided output lifetimes. + +In method signatures there is another rule + +* If the receiver has type `&Self` or `&mut Self`, then the lifetime of that + reference to `Self` is assigned to all elided output lifetime parameters. + +Examples: + +```rust +# trait T {} +# trait ToCStr {} +# struct Thing<'a> {f: &'a i32} +# struct Command; +# +# trait Example { +fn print1(s: &str); // elided +fn print2(s: &'_ str); // also elided +fn print3<'a>(s: &'a str); // expanded + +fn debug1(lvl: usize, s: &str); // elided +fn debug2<'a>(lvl: usize, s: &'a str); // expanded + +fn substr1(s: &str, until: usize) -> &str; // elided +fn substr2<'a>(s: &'a str, until: usize) -> &'a str; // expanded + +fn get_mut1(&mut self) -> &mut dyn T; // elided +fn get_mut2<'a>(&'a mut self) -> &'a mut dyn T; // expanded + +fn args1(&mut self, args: &[T]) -> &mut Command; // elided +fn args2<'a, 'b, T: ToCStr>(&'a mut self, args: &'b [T]) -> &'a mut Command; // expanded + +fn new1(buf: &mut [u8]) -> Thing<'_>; // elided - preferred +fn new2(buf: &mut [u8]) -> Thing; // elided +fn new3<'a>(buf: &'a mut [u8]) -> Thing<'a>; // expanded +# } + +type FunPtr1 = fn(&str) -> &str; // elided +type FunPtr2 = for<'a> fn(&'a str) -> &'a str; // expanded + +type FunTrait1 = dyn Fn(&str) -> &str; // elided +type FunTrait2 = dyn for<'a> Fn(&'a str) -> &'a str; // expanded +``` + +```rust,compile_fail +// The following examples show situations where it is not allowed to elide the +// lifetime parameter. + +# trait Example { +// Cannot infer, because there are no parameters to infer from. +fn get_str() -> &str; // ILLEGAL + +// Cannot infer, ambiguous if it is borrowed from the first or second parameter. +fn frob(s: &str, t: &str) -> &str; // ILLEGAL +# } +``` + +## Default trait object lifetimes + +The assumed lifetime of references held by a [trait object] is called its +_default object lifetime bound_. These were defined in [RFC 599] and amended in +[RFC 1156]. + +These default object lifetime bounds are used instead of the lifetime parameter +elision rules defined above when the lifetime bound is omitted entirely. If +`'_` is used as the lifetime bound then the bound follows the usual elision +rules. + +If the trait object is used as a type argument of a generic type then the +containing type is first used to try to infer a bound. + +* If there is a unique bound from the containing type then that is the default +* If there is more than one bound from the containing type then an explicit + bound must be specified + +If neither of those rules apply, then the bounds on the trait are used: + +* If the trait is defined with a single lifetime _bound_ then that bound is + used. +* If `'static` is used for any lifetime bound then `'static` is used. +* If the trait has no lifetime bounds, then the lifetime is inferred in + expressions and is `'static` outside of expressions. + +```rust +// For the following trait... +trait Foo { } + +// These two are the same because Box has no lifetime bound on T +type T1 = Box; +type T2 = Box; + +// ...and so are these: +impl dyn Foo {} +impl dyn Foo + 'static {} + +// ...so are these, because &'a T requires T: 'a +type T3<'a> = &'a dyn Foo; +type T4<'a> = &'a (dyn Foo + 'a); + +// std::cell::Ref<'a, T> also requires T: 'a, so these are the same +type T5<'a> = std::cell::Ref<'a, dyn Foo>; +type T6<'a> = std::cell::Ref<'a, dyn Foo + 'a>; +``` + +```rust,compile_fail +// This is an example of an error. +# trait Foo { } +struct TwoBounds<'a, 'b, T: ?Sized + 'a + 'b> { + f1: &'a i32, + f2: &'b i32, + f3: T, +} +type T7<'a, 'b> = TwoBounds<'a, 'b, dyn Foo>; +// ^^^^^^^ +// Error: the lifetime bound for this object type cannot be deduced from context +``` + +Note that the innermost object sets the bound, so `&'a Box` is still +`&'a Box`. + +```rust +// For the following trait... +trait Bar<'a>: 'a { } + +// ...these two are the same: +type T1<'a> = Box>; +type T2<'a> = Box + 'a>; + +// ...and so are these: +impl<'a> dyn Bar<'a> {} +impl<'a> dyn Bar<'a> + 'a {} +``` + +## `'static` lifetime elision + +Both [constant] and [static] declarations of reference types have *implicit* +`'static` lifetimes unless an explicit lifetime is specified. As such, the +constant declarations involving `'static` above may be written without the +lifetimes. + +```rust +// STRING: &'static str +const STRING: &str = "bitstring"; + +struct BitsNStrings<'a> { + mybits: [u32; 2], + mystring: &'a str, +} + +// BITS_N_STRINGS: BitsNStrings<'static> +const BITS_N_STRINGS: BitsNStrings<'_> = BitsNStrings { + mybits: [1, 2], + mystring: STRING, +}; +``` + +Note that if the `static` or `const` items include function or closure +references, which themselves include references, the compiler will first try +the standard elision rules. If it is unable to resolve the lifetimes by its +usual rules, then it will error. By way of example: + +```rust +# struct Foo; +# struct Bar; +# struct Baz; +# fn somefunc(a: &Foo, b: &Bar, c: &Baz) -> usize {42} +// Resolved as `fn<'a>(&'a str) -> &'a str`. +const RESOLVED_SINGLE: fn(&str) -> &str = |x| x; + +// Resolved as `Fn<'a, 'b, 'c>(&'a Foo, &'b Bar, &'c Baz) -> usize`. +const RESOLVED_MULTIPLE: &dyn Fn(&Foo, &Bar, &Baz) -> usize = &somefunc; +``` + +```rust,compile_fail +# struct Foo; +# struct Bar; +# struct Baz; +# fn somefunc<'a,'b>(a: &'a Foo, b: &'b Bar) -> &'a Baz {unimplemented!()} +// There is insufficient information to bound the return reference lifetime +// relative to the argument lifetimes, so this is an error. +const RESOLVED_STATIC: &dyn Fn(&Foo, &Bar) -> &Baz = &somefunc; +// ^ +// this function's return type contains a borrowed value, but the signature +// does not say whether it is borrowed from argument 1 or argument 2 +``` + +[closure trait]: types/closure.md +[constant]: items/constant-items.md +[function item]: types/function-item.md +[function pointer]: types/function-pointer.md +[RFC 599]: https://github.com/rust-lang/rfcs/blob/master/text/0599-default-object-bound.md +[RFC 1156]: https://github.com/rust-lang/rfcs/blob/master/text/1156-adjust-default-object-bounds.md +[static]: items/static-items.md +[trait object]: types/trait-object.md diff --git a/src/doc/reference/src/linkage.md b/src/doc/reference/src/linkage.md new file mode 100644 index 000000000..b15200511 --- /dev/null +++ b/src/doc/reference/src/linkage.md @@ -0,0 +1,216 @@ +# Linkage + +> Note: This section is described more in terms of the compiler than of +> the language. + +The compiler supports various methods to link crates together both +statically and dynamically. This section will explore the various methods to +link crates together, and more information about native libraries can be +found in the [FFI section of the book][ffi]. + +[ffi]: ../book/ch19-01-unsafe-rust.html#using-extern-functions-to-call-external-code + +In one session of compilation, the compiler can generate multiple artifacts +through the usage of either command line flags or the `crate_type` attribute. +If one or more command line flags are specified, all `crate_type` attributes will +be ignored in favor of only building the artifacts specified by command line. + +* `--crate-type=bin`, `#![crate_type = "bin"]` - A runnable executable will be + produced. This requires that there is a `main` function in the crate which + will be run when the program begins executing. This will link in all Rust and + native dependencies, producing a single distributable binary. + This is the default crate type. + +* `--crate-type=lib`, `#![crate_type = "lib"]` - A Rust library will be produced. + This is an ambiguous concept as to what exactly is produced because a library + can manifest itself in several forms. The purpose of this generic `lib` option + is to generate the "compiler recommended" style of library. The output library + will always be usable by rustc, but the actual type of library may change from + time-to-time. The remaining output types are all different flavors of + libraries, and the `lib` type can be seen as an alias for one of them (but the + actual one is compiler-defined). + +* `--crate-type=dylib`, `#![crate_type = "dylib"]` - A dynamic Rust library will + be produced. This is different from the `lib` output type in that this forces + dynamic library generation. The resulting dynamic library can be used as a + dependency for other libraries and/or executables. This output type will + create `*.so` files on Linux, `*.dylib` files on macOS, and `*.dll` files on + Windows. + +* `--crate-type=staticlib`, `#![crate_type = "staticlib"]` - A static system + library will be produced. This is different from other library outputs in that + the compiler will never attempt to link to `staticlib` outputs. The + purpose of this output type is to create a static library containing all of + the local crate's code along with all upstream dependencies. This output type + will create `*.a` files on Linux, macOS and Windows (MinGW), and `*.lib` files + on Windows (MSVC). This format is recommended for use in situations such as + linking Rust code into an existing non-Rust application + because it will not have dynamic dependencies on other Rust code. + +* `--crate-type=cdylib`, `#![crate_type = "cdylib"]` - A dynamic system + library will be produced. This is used when compiling + a dynamic library to be loaded from another language. This output type will + create `*.so` files on Linux, `*.dylib` files on macOS, and `*.dll` files on + Windows. + +* `--crate-type=rlib`, `#![crate_type = "rlib"]` - A "Rust library" file will be + produced. This is used as an intermediate artifact and can be thought of as a + "static Rust library". These `rlib` files, unlike `staticlib` files, are + interpreted by the compiler in future linkage. This essentially means + that `rustc` will look for metadata in `rlib` files like it looks for metadata + in dynamic libraries. This form of output is used to produce statically linked + executables as well as `staticlib` outputs. + +* `--crate-type=proc-macro`, `#![crate_type = "proc-macro"]` - The output + produced is not specified, but if a `-L` path is provided to it then the + compiler will recognize the output artifacts as a macro and it can be loaded + for a program. Crates compiled with this crate type must only export + [procedural macros]. The compiler will automatically set the `proc_macro` + [configuration option]. The crates are always compiled with the same target + that the compiler itself was built with. For example, if you are executing + the compiler from Linux with an `x86_64` CPU, the target will be + `x86_64-unknown-linux-gnu` even if the crate is a dependency of another crate + being built for a different target. + +Note that these outputs are stackable in the sense that if multiple are +specified, then the compiler will produce each form of output at once without +having to recompile. However, this only applies for outputs specified by the +same method. If only `crate_type` attributes are specified, then they will all +be built, but if one or more `--crate-type` command line flags are specified, +then only those outputs will be built. + +With all these different kinds of outputs, if crate A depends on crate B, then +the compiler could find B in various different forms throughout the system. The +only forms looked for by the compiler, however, are the `rlib` format and the +dynamic library format. With these two options for a dependent library, the +compiler must at some point make a choice between these two formats. With this +in mind, the compiler follows these rules when determining what format of +dependencies will be used: + +1. If a static library is being produced, all upstream dependencies are + required to be available in `rlib` formats. This requirement stems from the + reason that a dynamic library cannot be converted into a static format. + + Note that it is impossible to link in native dynamic dependencies to a static + library, and in this case warnings will be printed about all unlinked native + dynamic dependencies. + +2. If an `rlib` file is being produced, then there are no restrictions on what + format the upstream dependencies are available in. It is simply required that + all upstream dependencies be available for reading metadata from. + + The reason for this is that `rlib` files do not contain any of their upstream + dependencies. It wouldn't be very efficient for all `rlib` files to contain a + copy of `libstd.rlib`! + +3. If an executable is being produced and the `-C prefer-dynamic` flag is not + specified, then dependencies are first attempted to be found in the `rlib` + format. If some dependencies are not available in an rlib format, then + dynamic linking is attempted (see below). + +4. If a dynamic library or an executable that is being dynamically linked is + being produced, then the compiler will attempt to reconcile the available + dependencies in either the rlib or dylib format to create a final product. + + A major goal of the compiler is to ensure that a library never appears more + than once in any artifact. For example, if dynamic libraries B and C were + each statically linked to library A, then a crate could not link to B and C + together because there would be two copies of A. The compiler allows mixing + the rlib and dylib formats, but this restriction must be satisfied. + + The compiler currently implements no method of hinting what format a library + should be linked with. When dynamically linking, the compiler will attempt to + maximize dynamic dependencies while still allowing some dependencies to be + linked in via an rlib. + + For most situations, having all libraries available as a dylib is recommended + if dynamically linking. For other situations, the compiler will emit a + warning if it is unable to determine which formats to link each library with. + +In general, `--crate-type=bin` or `--crate-type=lib` should be sufficient for +all compilation needs, and the other options are just available if more +fine-grained control is desired over the output format of a crate. + +## Static and dynamic C runtimes + +The standard library in general strives to support both statically linked and +dynamically linked C runtimes for targets as appropriate. For example the +`x86_64-pc-windows-msvc` and `x86_64-unknown-linux-musl` targets typically come +with both runtimes and the user selects which one they'd like. All targets in +the compiler have a default mode of linking to the C runtime. Typically targets +are linked dynamically by default, but there are exceptions which are static by +default such as: + +* `arm-unknown-linux-musleabi` +* `arm-unknown-linux-musleabihf` +* `armv7-unknown-linux-musleabihf` +* `i686-unknown-linux-musl` +* `x86_64-unknown-linux-musl` + +The linkage of the C runtime is configured to respect the `crt-static` target +feature. These target features are typically configured from the command line +via flags to the compiler itself. For example to enable a static runtime you +would execute: + +```sh +rustc -C target-feature=+crt-static foo.rs +``` + +whereas to link dynamically to the C runtime you would execute: + +```sh +rustc -C target-feature=-crt-static foo.rs +``` + +Targets which do not support switching between linkage of the C runtime will +ignore this flag. It's recommended to inspect the resulting binary to ensure +that it's linked as you would expect after the compiler succeeds. + +Crates may also learn about how the C runtime is being linked. Code on MSVC, for +example, needs to be compiled differently (e.g. with `/MT` or `/MD`) depending +on the runtime being linked. This is exported currently through the +[`cfg` attribute `target_feature` option]: + +```rust +#[cfg(target_feature = "crt-static")] +fn foo() { + println!("the C runtime should be statically linked"); +} + +#[cfg(not(target_feature = "crt-static"))] +fn foo() { + println!("the C runtime should be dynamically linked"); +} +``` + +Also note that Cargo build scripts can learn about this feature through +[environment variables][cargo]. In a build script you can detect the linkage +via: + +```rust +use std::env; + +fn main() { + let linkage = env::var("CARGO_CFG_TARGET_FEATURE").unwrap_or(String::new()); + + if linkage.contains("crt-static") { + println!("the C runtime will be statically linked"); + } else { + println!("the C runtime will be dynamically linked"); + } +} +``` + +[cargo]: ../cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts + +To use this feature locally, you typically will use the `RUSTFLAGS` environment +variable to specify flags to the compiler through Cargo. For example to compile +a statically linked binary on MSVC you would execute: + +```sh +RUSTFLAGS='-C target-feature=+crt-static' cargo build --target x86_64-pc-windows-msvc +``` + +[`cfg` attribute `target_feature` option]: conditional-compilation.md#target_feature +[configuration option]: conditional-compilation.md +[procedural macros]: procedural-macros.md diff --git a/src/doc/reference/src/macro-ambiguity.md b/src/doc/reference/src/macro-ambiguity.md new file mode 100644 index 000000000..01ae288a3 --- /dev/null +++ b/src/doc/reference/src/macro-ambiguity.md @@ -0,0 +1,377 @@ +# Appendix: Macro Follow-Set Ambiguity Formal Specification + +This page documents the formal specification of the follow rules for [Macros +By Example]. They were originally specified in [RFC 550], from which the bulk +of this text is copied, and expanded upon in subsequent RFCs. + +## Definitions & Conventions + + - `macro`: anything invokable as `foo!(...)` in source code. + - `MBE`: macro-by-example, a macro defined by `macro_rules`. + - `matcher`: the left-hand-side of a rule in a `macro_rules` invocation, or a + subportion thereof. + - `macro parser`: the bit of code in the Rust parser that will parse the + input using a grammar derived from all of the matchers. + - `fragment`: The class of Rust syntax that a given matcher will accept (or + "match"). + - `repetition` : a fragment that follows a regular repeating pattern + - `NT`: non-terminal, the various "meta-variables" or repetition matchers + that can appear in a matcher, specified in MBE syntax with a leading `$` + character. + - `simple NT`: a "meta-variable" non-terminal (further discussion below). + - `complex NT`: a repetition matching non-terminal, specified via repetition + operators (`*`, `+`, `?`). + - `token`: an atomic element of a matcher; i.e. identifiers, operators, + open/close delimiters, *and* simple NT's. + - `token tree`: a tree structure formed from tokens (the leaves), complex + NT's, and finite sequences of token trees. + - `delimiter token`: a token that is meant to divide the end of one fragment + and the start of the next fragment. + - `separator token`: an optional delimiter token in an complex NT that + separates each pair of elements in the matched repetition. + - `separated complex NT`: a complex NT that has its own separator token. + - `delimited sequence`: a sequence of token trees with appropriate open- and + close-delimiters at the start and end of the sequence. + - `empty fragment`: The class of invisible Rust syntax that separates tokens, + i.e. whitespace, or (in some lexical contexts), the empty token sequence. + - `fragment specifier`: The identifier in a simple NT that specifies which + fragment the NT accepts. + - `language`: a context-free language. + +Example: + +```rust,compile_fail +macro_rules! i_am_an_mbe { + (start $foo:expr $($i:ident),* end) => ($foo) +} +``` + +`(start $foo:expr $($i:ident),* end)` is a matcher. The whole matcher is a +delimited sequence (with open- and close-delimiters `(` and `)`), and `$foo` +and `$i` are simple NT's with `expr` and `ident` as their respective fragment +specifiers. + +`$(i:ident),*` is *also* an NT; it is a complex NT that matches a +comma-separated repetition of identifiers. The `,` is the separator token for +the complex NT; it occurs in between each pair of elements (if any) of the +matched fragment. + +Another example of a complex NT is `$(hi $e:expr ;)+`, which matches any +fragment of the form `hi ; hi ; ...` where `hi ;` occurs at +least once. Note that this complex NT does not have a dedicated separator +token. + +(Note that Rust's parser ensures that delimited sequences always occur with +proper nesting of token tree structure and correct matching of open- and +close-delimiters.) + +We will tend to use the variable "M" to stand for a matcher, variables "t" and +"u" for arbitrary individual tokens, and the variables "tt" and "uu" for +arbitrary token trees. (The use of "tt" does present potential ambiguity with +its additional role as a fragment specifier; but it will be clear from context +which interpretation is meant.) + +"SEP" will range over separator tokens, "OP" over the repetition operators +`*`, `+`, and `?`, "OPEN"/"CLOSE" over matching token pairs surrounding a +delimited sequence (e.g. `[` and `]`). + +Greek letters "α" "β" "γ" "δ" stand for potentially empty token-tree sequences. +(However, the Greek letter "ε" (epsilon) has a special role in the presentation +and does not stand for a token-tree sequence.) + + * This Greek letter convention is usually just employed when the presence of + a sequence is a technical detail; in particular, when we wish to *emphasize* + that we are operating on a sequence of token-trees, we will use the notation + "tt ..." for the sequence, not a Greek letter. + +Note that a matcher is merely a token tree. A "simple NT", as mentioned above, +is an meta-variable NT; thus it is a non-repetition. For example, `$foo:ty` is +a simple NT but `$($foo:ty)+` is a complex NT. + +Note also that in the context of this formalism, the term "token" generally +*includes* simple NTs. + +Finally, it is useful for the reader to keep in mind that according to the +definitions of this formalism, no simple NT matches the empty fragment, and +likewise no token matches the empty fragment of Rust syntax. (Thus, the *only* +NT that can match the empty fragment is a complex NT.) This is not actually +true, because the `vis` matcher can match an empty fragment. Thus, for the +purposes of the formalism, we will treat `$v:vis` as actually being +`$($v:vis)?`, with a requirement that the matcher match an empty fragment. + +### The Matcher Invariants + +To be valid, a matcher must meet the following three invariants. The definitions +of FIRST and FOLLOW are described later. + +1. For any two successive token tree sequences in a matcher `M` (i.e. `M = ... + tt uu ...`) with `uu ...` nonempty, we must have FOLLOW(`... tt`) ∪ {ε} ⊇ + FIRST(`uu ...`). +1. For any separated complex NT in a matcher, `M = ... $(tt ...) SEP OP ...`, + we must have `SEP` ∈ FOLLOW(`tt ...`). +1. For an unseparated complex NT in a matcher, `M = ... $(tt ...) OP ...`, if + OP = `*` or `+`, we must have FOLLOW(`tt ...`) ⊇ FIRST(`tt ...`). + +The first invariant says that whatever actual token that comes after a matcher, +if any, must be somewhere in the predetermined follow set. This ensures that a +legal macro definition will continue to assign the same determination as to +where `... tt` ends and `uu ...` begins, even as new syntactic forms are added +to the language. + +The second invariant says that a separated complex NT must use a separator token +that is part of the predetermined follow set for the internal contents of the +NT. This ensures that a legal macro definition will continue to parse an input +fragment into the same delimited sequence of `tt ...`'s, even as new syntactic +forms are added to the language. + +The third invariant says that when we have a complex NT that can match two or +more copies of the same thing with no separation in between, it must be +permissible for them to be placed next to each other as per the first invariant. +This invariant also requires they be nonempty, which eliminates a possible +ambiguity. + +**NOTE: The third invariant is currently unenforced due to historical oversight +and significant reliance on the behaviour. It is currently undecided what to do +about this going forward. Macros that do not respect the behaviour may become +invalid in a future edition of Rust. See the [tracking issue].** + +### FIRST and FOLLOW, informally + +A given matcher M maps to three sets: FIRST(M), LAST(M) and FOLLOW(M). + +Each of the three sets is made up of tokens. FIRST(M) and LAST(M) may also +contain a distinguished non-token element ε ("epsilon"), which indicates that M +can match the empty fragment. (But FOLLOW(M) is always just a set of tokens.) + +Informally: + + * FIRST(M): collects the tokens potentially used first when matching a + fragment to M. + + * LAST(M): collects the tokens potentially used last when matching a fragment + to M. + + * FOLLOW(M): the set of tokens allowed to follow immediately after some + fragment matched by M. + + In other words: t ∈ FOLLOW(M) if and only if there exists (potentially + empty) token sequences α, β, γ, δ where: + + * M matches β, + + * t matches γ, and + + * The concatenation α β γ δ is a parseable Rust program. + +We use the shorthand ANYTOKEN to denote the set of all tokens (including simple +NTs). For example, if any token is legal after a matcher M, then FOLLOW(M) = +ANYTOKEN. + +(To review one's understanding of the above informal descriptions, the reader +at this point may want to jump ahead to the [examples of +FIRST/LAST](#examples-of-first-and-last) before reading their formal +definitions.) + +### FIRST, LAST + +Below are formal inductive definitions for FIRST and LAST. + +"A ∪ B" denotes set union, "A ∩ B" denotes set intersection, and "A \ B" +denotes set difference (i.e. all elements of A that are not present in B). + +#### FIRST + +FIRST(M) is defined by case analysis on the sequence M and the structure of its +first token-tree (if any): + + * if M is the empty sequence, then FIRST(M) = { ε }, + + * if M starts with a token t, then FIRST(M) = { t }, + + (Note: this covers the case where M starts with a delimited token-tree + sequence, `M = OPEN tt ... CLOSE ...`, in which case `t = OPEN` and thus + FIRST(M) = { `OPEN` }.) + + (Note: this critically relies on the property that no simple NT matches the + empty fragment.) + + * Otherwise, M is a token-tree sequence starting with a complex NT: `M = $( tt + ... ) OP α`, or `M = $( tt ... ) SEP OP α`, (where `α` is the (potentially + empty) sequence of token trees for the rest of the matcher). + + * Let SEP\_SET(M) = { SEP } if SEP is present and ε ∈ FIRST(`tt ...`); + otherwise SEP\_SET(M) = {}. + + * Let ALPHA\_SET(M) = FIRST(`α`) if OP = `*` or `?` and ALPHA\_SET(M) = {} if + OP = `+`. + * FIRST(M) = (FIRST(`tt ...`) \\ {ε}) ∪ SEP\_SET(M) ∪ ALPHA\_SET(M). + +The definition for complex NTs deserves some justification. SEP\_SET(M) defines +the possibility that the separator could be a valid first token for M, which +happens when there is a separator defined and the repeated fragment could be +empty. ALPHA\_SET(M) defines the possibility that the complex NT could be empty, +meaning that M's valid first tokens are those of the following token-tree +sequences `α`. This occurs when either `*` or `?` is used, in which case there +could be zero repetitions. In theory, this could also occur if `+` was used with +a potentially-empty repeating fragment, but this is forbidden by the third +invariant. + +From there, clearly FIRST(M) can include any token from SEP\_SET(M) or +ALPHA\_SET(M), and if the complex NT match is nonempty, then any token starting +FIRST(`tt ...`) could work too. The last piece to consider is ε. SEP\_SET(M) and +FIRST(`tt ...`) \ {ε} cannot contain ε, but ALPHA\_SET(M) could. Hence, this +definition allows M to accept ε if and only if ε ∈ ALPHA\_SET(M) does. This is +correct because for M to accept ε in the complex NT case, both the complex NT +and α must accept it. If OP = `+`, meaning that the complex NT cannot be empty, +then by definition ε ∉ ALPHA\_SET(M). Otherwise, the complex NT can accept zero +repetitions, and then ALPHA\_SET(M) = FOLLOW(`α`). So this definition is correct +with respect to \varepsilon as well. + +#### LAST + +LAST(M), defined by case analysis on M itself (a sequence of token-trees): + + * if M is the empty sequence, then LAST(M) = { ε } + + * if M is a singleton token t, then LAST(M) = { t } + + * if M is the singleton complex NT repeating zero or more times, `M = $( tt + ... ) *`, or `M = $( tt ... ) SEP *` + + * Let sep_set = { SEP } if SEP present; otherwise sep_set = {}. + + * if ε ∈ LAST(`tt ...`) then LAST(M) = LAST(`tt ...`) ∪ sep_set + + * otherwise, the sequence `tt ...` must be non-empty; LAST(M) = LAST(`tt + ...`) ∪ {ε}. + + * if M is the singleton complex NT repeating one or more times, `M = $( tt ... + ) +`, or `M = $( tt ... ) SEP +` + + * Let sep_set = { SEP } if SEP present; otherwise sep_set = {}. + + * if ε ∈ LAST(`tt ...`) then LAST(M) = LAST(`tt ...`) ∪ sep_set + + * otherwise, the sequence `tt ...` must be non-empty; LAST(M) = LAST(`tt + ...`) + + * if M is the singleton complex NT repeating zero or one time, `M = $( tt ...) + ?`, then LAST(M) = LAST(`tt ...`) ∪ {ε}. + + * if M is a delimited token-tree sequence `OPEN tt ... CLOSE`, then LAST(M) = + { `CLOSE` }. + + * if M is a non-empty sequence of token-trees `tt uu ...`, + + * If ε ∈ LAST(`uu ...`), then LAST(M) = LAST(`tt`) ∪ (LAST(`uu ...`) \ { ε }). + + * Otherwise, the sequence `uu ...` must be non-empty; then LAST(M) = + LAST(`uu ...`). + +### Examples of FIRST and LAST + +Below are some examples of FIRST and LAST. +(Note in particular how the special ε element is introduced and +eliminated based on the interaction between the pieces of the input.) + +Our first example is presented in a tree structure to elaborate on how +the analysis of the matcher composes. (Some of the simpler subtrees +have been elided.) + +```text +INPUT: $( $d:ident $e:expr );* $( $( h )* );* $( f ; )+ g + ~~~~~~~~ ~~~~~~~ ~ + | | | +FIRST: { $d:ident } { $e:expr } { h } + + +INPUT: $( $d:ident $e:expr );* $( $( h )* );* $( f ; )+ + ~~~~~~~~~~~~~~~~~~ ~~~~~~~ ~~~ + | | | +FIRST: { $d:ident } { h, ε } { f } + +INPUT: $( $d:ident $e:expr );* $( $( h )* );* $( f ; )+ g + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~ ~~~~~~~~~ ~ + | | | | +FIRST: { $d:ident, ε } { h, ε, ; } { f } { g } + + +INPUT: $( $d:ident $e:expr );* $( $( h )* );* $( f ; )+ g + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + | +FIRST: { $d:ident, h, ;, f } +``` + +Thus: + + * FIRST(`$($d:ident $e:expr );* $( $(h)* );* $( f ;)+ g`) = { `$d:ident`, `h`, `;`, `f` } + +Note however that: + + * FIRST(`$($d:ident $e:expr );* $( $(h)* );* $($( f ;)+ g)*`) = { `$d:ident`, `h`, `;`, `f`, ε } + +Here are similar examples but now for LAST. + + * LAST(`$d:ident $e:expr`) = { `$e:expr` } + * LAST(`$( $d:ident $e:expr );*`) = { `$e:expr`, ε } + * LAST(`$( $d:ident $e:expr );* $(h)*`) = { `$e:expr`, ε, `h` } + * LAST(`$( $d:ident $e:expr );* $(h)* $( f ;)+`) = { `;` } + * LAST(`$( $d:ident $e:expr );* $(h)* $( f ;)+ g`) = { `g` } + +### FOLLOW(M) + +Finally, the definition for FOLLOW(M) is built up as follows. pat, expr, etc. +represent simple nonterminals with the given fragment specifier. + + * FOLLOW(pat) = {`=>`, `,`, `=`, `|`, `if`, `in`}`. + + * FOLLOW(expr) = FOLLOW(stmt) = {`=>`, `,`, `;`}`. + + * FOLLOW(ty) = FOLLOW(path) = {`{`, `[`, `,`, `=>`, `:`, `=`, `>`, `>>`, `;`, + `|`, `as`, `where`, block nonterminals}. + + * FOLLOW(vis) = {`,`l any keyword or identifier except a non-raw `priv`; any + token that can begin a type; ident, ty, and path nonterminals}. + + * FOLLOW(t) = ANYTOKEN for any other simple token, including block, ident, + tt, item, lifetime, literal and meta simple nonterminals, and all terminals. + + * FOLLOW(M), for any other M, is defined as the intersection, as t ranges over + (LAST(M) \ {ε}), of FOLLOW(t). + +The tokens that can begin a type are, as of this writing, {`(`, `[`, `!`, `*`, +`&`, `&&`, `?`, lifetimes, `>`, `>>`, `::`, any non-keyword identifier, `super`, +`self`, `Self`, `extern`, `crate`, `$crate`, `_`, `for`, `impl`, `fn`, `unsafe`, +`typeof`, `dyn`}, although this list may not be complete because people won't +always remember to update the appendix when new ones are added. + +Examples of FOLLOW for complex M: + + * FOLLOW(`$( $d:ident $e:expr )*`) = FOLLOW(`$e:expr`) + * FOLLOW(`$( $d:ident $e:expr )* $(;)*`) = FOLLOW(`$e:expr`) ∩ ANYTOKEN = FOLLOW(`$e:expr`) + * FOLLOW(`$( $d:ident $e:expr )* $(;)* $( f |)+`) = ANYTOKEN + +### Examples of valid and invalid matchers + +With the above specification in hand, we can present arguments for +why particular matchers are legal and others are not. + + * `($ty:ty < foo ,)` : illegal, because FIRST(`< foo ,`) = { `<` } ⊈ FOLLOW(`ty`) + + * `($ty:ty , foo <)` : legal, because FIRST(`, foo <`) = { `,` } is ⊆ FOLLOW(`ty`). + + * `($pa:pat $pb:pat $ty:ty ,)` : illegal, because FIRST(`$pb:pat $ty:ty ,`) = { `$pb:pat` } ⊈ FOLLOW(`pat`), and also FIRST(`$ty:ty ,`) = { `$ty:ty` } ⊈ FOLLOW(`pat`). + + * `( $($a:tt $b:tt)* ; )` : legal, because FIRST(`$b:tt`) = { `$b:tt` } is ⊆ FOLLOW(`tt`) = ANYTOKEN, as is FIRST(`;`) = { `;` }. + + * `( $($t:tt),* , $(t:tt),* )` : legal, (though any attempt to actually use this macro will signal a local ambiguity error during expansion). + + * `($ty:ty $(; not sep)* -)` : illegal, because FIRST(`$(; not sep)* -`) = { `;`, `-` } is not in FOLLOW(`ty`). + + * `($($ty:ty)-+)` : illegal, because separator `-` is not in FOLLOW(`ty`). + + * `($($e:expr)*)` : illegal, because expr NTs are not in FOLLOW(expr NT). + +[Macros by Example]: macros-by-example.md +[RFC 550]: https://github.com/rust-lang/rfcs/blob/master/text/0550-macro-future-proofing.md +[tracking issue]: https://github.com/rust-lang/rust/issues/56575 diff --git a/src/doc/reference/src/macros-by-example.md b/src/doc/reference/src/macros-by-example.md new file mode 100644 index 000000000..2c49300cd --- /dev/null +++ b/src/doc/reference/src/macros-by-example.md @@ -0,0 +1,519 @@ +# Macros By Example + +> **Syntax**\ +> _MacroRulesDefinition_ :\ +>    `macro_rules` `!` [IDENTIFIER] _MacroRulesDef_ +> +> _MacroRulesDef_ :\ +>       `(` _MacroRules_ `)` `;`\ +>    | `[` _MacroRules_ `]` `;`\ +>    | `{` _MacroRules_ `}` +> +> _MacroRules_ :\ +>    _MacroRule_ ( `;` _MacroRule_ )\* `;`? +> +> _MacroRule_ :\ +>    _MacroMatcher_ `=>` _MacroTranscriber_ +> +> _MacroMatcher_ :\ +>       `(` _MacroMatch_\* `)`\ +>    | `[` _MacroMatch_\* `]`\ +>    | `{` _MacroMatch_\* `}` +> +> _MacroMatch_ :\ +>       [_Token_]_except `$` and [delimiters]_\ +>    | _MacroMatcher_\ +>    | `$` ( [IDENTIFIER_OR_KEYWORD] _except `crate`_ | [RAW_IDENTIFIER] | `_` ) `:` _MacroFragSpec_\ +>    | `$` `(` _MacroMatch_+ `)` _MacroRepSep_? _MacroRepOp_ +> +> _MacroFragSpec_ :\ +>       `block` | `expr` | `ident` | `item` | `lifetime` | `literal`\ +>    | `meta` | `pat` | `pat_param` | `path` | `stmt` | `tt` | `ty` | `vis` +> +> _MacroRepSep_ :\ +>    [_Token_]_except [delimiters] and MacroRepOp_ +> +> _MacroRepOp_ :\ +>    `*` | `+` | `?` +> +> _MacroTranscriber_ :\ +>    [_DelimTokenTree_] + +`macro_rules` allows users to define syntax extension in a declarative way. We +call such extensions "macros by example" or simply "macros". + +Each macro by example has a name, and one or more _rules_. Each rule has two +parts: a _matcher_, describing the syntax that it matches, and a _transcriber_, +describing the syntax that will replace a successfully matched invocation. Both +the matcher and the transcriber must be surrounded by delimiters. Macros can +expand to expressions, statements, items (including traits, impls, and foreign +items), types, or patterns. + +## Transcribing + +When a macro is invoked, the macro expander looks up macro invocations by name, +and tries each macro rule in turn. It transcribes the first successful match; if +this results in an error, then future matches are not tried. When matching, no +lookahead is performed; if the compiler cannot unambiguously determine how to +parse the macro invocation one token at a time, then it is an error. In the +following example, the compiler does not look ahead past the identifier to see +if the following token is a `)`, even though that would allow it to parse the +invocation unambiguously: + +```rust,compile_fail +macro_rules! ambiguity { + ($($i:ident)* $j:ident) => { }; +} + +ambiguity!(error); // Error: local ambiguity +``` + +In both the matcher and the transcriber, the `$` token is used to invoke special +behaviours from the macro engine (described below in [Metavariables] and +[Repetitions]). Tokens that aren't part of such an invocation are matched and +transcribed literally, with one exception. The exception is that the outer +delimiters for the matcher will match any pair of delimiters. Thus, for +instance, the matcher `(())` will match `{()}` but not `{{}}`. The character +`$` cannot be matched or transcribed literally. + +When forwarding a matched fragment to another macro-by-example, matchers in +the second macro will see an opaque AST of the fragment type. The second macro +can't use literal tokens to match the fragments in the matcher, only a +fragment specifier of the same type. The `ident`, `lifetime`, and `tt` +fragment types are an exception, and *can* be matched by literal tokens. The +following illustrates this restriction: + +```rust,compile_fail +macro_rules! foo { + ($l:expr) => { bar!($l); } +// ERROR: ^^ no rules expected this token in macro call +} + +macro_rules! bar { + (3) => {} +} + +foo!(3); +``` + +The following illustrates how tokens can be directly matched after matching a +`tt` fragment: + +```rust +// compiles OK +macro_rules! foo { + ($l:tt) => { bar!($l); } +} + +macro_rules! bar { + (3) => {} +} + +foo!(3); +``` + +## Metavariables + +In the matcher, `$` _name_ `:` _fragment-specifier_ matches a Rust syntax +fragment of the kind specified and binds it to the metavariable `$`_name_. Valid +fragment specifiers are: + + * `item`: an [_Item_] + * `block`: a [_BlockExpression_] + * `stmt`: a [_Statement_] without the trailing semicolon (except for item + statements that require semicolons) + * `pat_param`: a [_PatternNoTopAlt_] + * `pat`: at least any [_PatternNoTopAlt_], and possibly more depending on edition + * `expr`: an [_Expression_] + * `ty`: a [_Type_] + * `ident`: an [IDENTIFIER_OR_KEYWORD] or [RAW_IDENTIFIER] + * `path`: a [_TypePath_] style path + * `tt`: a [_TokenTree_] (a single [token] or tokens in matching delimiters `()`, `[]`, or `{}`) + * `meta`: an [_Attr_], the contents of an attribute + * `lifetime`: a [LIFETIME_TOKEN] + * `vis`: a possibly empty [_Visibility_] qualifier + * `literal`: matches `-`?[_LiteralExpression_] + +In the transcriber, metavariables are referred to simply by `$`_name_, since +the fragment kind is specified in the matcher. Metavariables are replaced with +the syntax element that matched them. The keyword metavariable `$crate` can be +used to refer to the current crate; see [Hygiene] below. Metavariables can be +transcribed more than once or not at all. + +For reasons of backwards compatibility, though `_` [is also an +expression][_UnderscoreExpression_], a standalone underscore is not matched by +the `expr` fragment specifier. However, `_` is matched by the `expr` fragment +specifier when it appears as a subexpression. + +> **Edition Differences**: Starting with the 2021 edition, `pat` fragment-specifiers match top-level or-patterns (that is, they accept [_Pattern_]). +> +> Before the 2021 edition, they match exactly the same fragments as `pat_param` (that is, they accept [_PatternNoTopAlt_]). +> +> The relevant edition is the one in effect for the `macro_rules!` definition. + +## Repetitions + +In both the matcher and transcriber, repetitions are indicated by placing the +tokens to be repeated inside `$(`…`)`, followed by a repetition operator, +optionally with a separator token between. The separator token can be any token +other than a delimiter or one of the repetition operators, but `;` and `,` are +the most common. For instance, `$( $i:ident ),*` represents any number of +identifiers separated by commas. Nested repetitions are permitted. + +The repetition operators are: + +- `*` — indicates any number of repetitions. +- `+` — indicates any number but at least one. +- `?` — indicates an optional fragment with zero or one occurrences. + +Since `?` represents at most one occurrence, it cannot be used with a +separator. + +The repeated fragment both matches and transcribes to the specified number of +the fragment, separated by the separator token. Metavariables are matched to +every repetition of their corresponding fragment. For instance, the `$( $i:ident +),*` example above matches `$i` to all of the identifiers in the list. + +During transcription, additional restrictions apply to repetitions so that the +compiler knows how to expand them properly: + +1. A metavariable must appear in exactly the same number, kind, and nesting + order of repetitions in the transcriber as it did in the matcher. So for the + matcher `$( $i:ident ),*`, the transcribers `=> { $i }`, + `=> { $( $( $i)* )* }`, and `=> { $( $i )+ }` are all illegal, but + `=> { $( $i );* }` is correct and replaces a comma-separated list of + identifiers with a semicolon-separated list. +2. Each repetition in the transcriber must contain at least one metavariable to + decide how many times to expand it. If multiple metavariables appear in the + same repetition, they must be bound to the same number of fragments. For + instance, `( $( $i:ident ),* ; $( $j:ident ),* ) => (( $( ($i,$j) ),* ))` must + bind the same number of `$i` fragments as `$j` fragments. This means that + invoking the macro with `(a, b, c; d, e, f)` is legal and expands to + `((a,d), (b,e), (c,f))`, but `(a, b, c; d, e)` is illegal because it does + not have the same number. This requirement applies to every layer of nested + repetitions. + +## Scoping, Exporting, and Importing + +For historical reasons, the scoping of macros by example does not work entirely +like items. Macros have two forms of scope: textual scope, and path-based scope. +Textual scope is based on the order that things appear in source files, or even +across multiple files, and is the default scoping. It is explained further below. +Path-based scope works exactly the same way that item scoping does. The scoping, +exporting, and importing of macros is controlled largely by attributes. + +When a macro is invoked by an unqualified identifier (not part of a multi-part +path), it is first looked up in textual scoping. If this does not yield any +results, then it is looked up in path-based scoping. If the macro's name is +qualified with a path, then it is only looked up in path-based scoping. + + +```rust,ignore +use lazy_static::lazy_static; // Path-based import. + +macro_rules! lazy_static { // Textual definition. + (lazy) => {}; +} + +lazy_static!{lazy} // Textual lookup finds our macro first. +self::lazy_static!{} // Path-based lookup ignores our macro, finds imported one. +``` + +### Textual Scope + +Textual scope is based largely on the order that things appear in source files, +and works similarly to the scope of local variables declared with `let` except +it also applies at the module level. When `macro_rules!` is used to define a +macro, the macro enters the scope after the definition (note that it can still +be used recursively, since names are looked up from the invocation site), up +until its surrounding scope, typically a module, is closed. This can enter child +modules and even span across multiple files: + + +```rust,ignore +//// src/lib.rs +mod has_macro { + // m!{} // Error: m is not in scope. + + macro_rules! m { + () => {}; + } + m!{} // OK: appears after declaration of m. + + mod uses_macro; +} + +// m!{} // Error: m is not in scope. + +//// src/has_macro/uses_macro.rs + +m!{} // OK: appears after declaration of m in src/lib.rs +``` + +It is not an error to define a macro multiple times; the most recent declaration +will shadow the previous one unless it has gone out of scope. + +```rust +macro_rules! m { + (1) => {}; +} + +m!(1); + +mod inner { + m!(1); + + macro_rules! m { + (2) => {}; + } + // m!(1); // Error: no rule matches '1' + m!(2); + + macro_rules! m { + (3) => {}; + } + m!(3); +} + +m!(1); +``` + +Macros can be declared and used locally inside functions as well, and work +similarly: + +```rust +fn foo() { + // m!(); // Error: m is not in scope. + macro_rules! m { + () => {}; + } + m!(); +} + + +// m!(); // Error: m is not in scope. +``` + +### The `macro_use` attribute + +The *`macro_use` attribute* has two purposes. First, it can be used to make a +module's macro scope not end when the module is closed, by applying it to a +module: + +```rust +#[macro_use] +mod inner { + macro_rules! m { + () => {}; + } +} + +m!(); +``` + +Second, it can be used to import macros from another crate, by attaching it to +an `extern crate` declaration appearing in the crate's root module. Macros +imported this way are imported into the [`macro_use` prelude], not textually, +which means that they can be shadowed by any other name. While macros imported +by `#[macro_use]` can be used before the import statement, in case of a +conflict, the last macro imported wins. Optionally, a list of macros to import +can be specified using the [_MetaListIdents_] syntax; this is not supported +when `#[macro_use]` is applied to a module. + + +```rust,ignore +#[macro_use(lazy_static)] // Or #[macro_use] to import all macros. +extern crate lazy_static; + +lazy_static!{} +// self::lazy_static!{} // Error: lazy_static is not defined in `self` +``` + +Macros to be imported with `#[macro_use]` must be exported with +`#[macro_export]`, which is described below. + +### Path-Based Scope + +By default, a macro has no path-based scope. However, if it has the +`#[macro_export]` attribute, then it is declared in the crate root scope and can +be referred to normally as such: + +```rust +self::m!(); +m!(); // OK: Path-based lookup finds m in the current module. + +mod inner { + super::m!(); + crate::m!(); +} + +mod mac { + #[macro_export] + macro_rules! m { + () => {}; + } +} +``` + +Macros labeled with `#[macro_export]` are always `pub` and can be referred to +by other crates, either by path or by `#[macro_use]` as described above. + +## Hygiene + +By default, all identifiers referred to in a macro are expanded as-is, and are +looked up at the macro's invocation site. This can lead to issues if a macro +refers to an item or macro which isn't in scope at the invocation site. To +alleviate this, the `$crate` metavariable can be used at the start of a path to +force lookup to occur inside the crate defining the macro. + + +```rust,ignore +//// Definitions in the `helper_macro` crate. +#[macro_export] +macro_rules! helped { + // () => { helper!() } // This might lead to an error due to 'helper' not being in scope. + () => { $crate::helper!() } +} + +#[macro_export] +macro_rules! helper { + () => { () } +} + +//// Usage in another crate. +// Note that `helper_macro::helper` is not imported! +use helper_macro::helped; + +fn unit() { + helped!(); +} +``` + +Note that, because `$crate` refers to the current crate, it must be used with a +fully qualified module path when referring to non-macro items: + +```rust +pub mod inner { + #[macro_export] + macro_rules! call_foo { + () => { $crate::inner::foo() }; + } + + pub fn foo() {} +} +``` + +Additionally, even though `$crate` allows a macro to refer to items within its +own crate when expanding, its use has no effect on visibility. An item or macro +referred to must still be visible from the invocation site. In the following +example, any attempt to invoke `call_foo!()` from outside its crate will fail +because `foo()` is not public. + +```rust +#[macro_export] +macro_rules! call_foo { + () => { $crate::foo() }; +} + +fn foo() {} +``` + +> **Version & Edition Differences**: Prior to Rust 1.30, `$crate` and +> `local_inner_macros` (below) were unsupported. They were added alongside +> path-based imports of macros (described above), to ensure that helper macros +> did not need to be manually imported by users of a macro-exporting crate. +> Crates written for earlier versions of Rust that use helper macros need to be +> modified to use `$crate` or `local_inner_macros` to work well with path-based +> imports. + +When a macro is exported, the `#[macro_export]` attribute can have the +`local_inner_macros` keyword added to automatically prefix all contained macro +invocations with `$crate::`. This is intended primarily as a tool to migrate +code written before `$crate` was added to the language to work with Rust 2018's +path-based imports of macros. Its use is discouraged in new code. + +```rust +#[macro_export(local_inner_macros)] +macro_rules! helped { + () => { helper!() } // Automatically converted to $crate::helper!(). +} + +#[macro_export] +macro_rules! helper { + () => { () } +} +``` + +## Follow-set Ambiguity Restrictions + +The parser used by the macro system is reasonably powerful, but it is limited in +order to prevent ambiguity in current or future versions of the language. In +particular, in addition to the rule about ambiguous expansions, a nonterminal +matched by a metavariable must be followed by a token which has been decided can +be safely used after that kind of match. + +As an example, a macro matcher like `$i:expr [ , ]` could in theory be accepted +in Rust today, since `[,]` cannot be part of a legal expression and therefore +the parse would always be unambiguous. However, because `[` can start trailing +expressions, `[` is not a character which can safely be ruled out as coming +after an expression. If `[,]` were accepted in a later version of Rust, this +matcher would become ambiguous or would misparse, breaking working code. +Matchers like `$i:expr,` or `$i:expr;` would be legal, however, because `,` and +`;` are legal expression separators. The specific rules are: + + * `expr` and `stmt` may only be followed by one of: `=>`, `,`, or `;`. + * `pat_param` may only be followed by one of: `=>`, `,`, `=`, `|`, `if`, or `in`. + * `pat` may only be followed by one of: `=>`, `,`, `=`, `if`, or `in`. + * `path` and `ty` may only be followed by one of: `=>`, `,`, `=`, `|`, `;`, + `:`, `>`, `>>`, `[`, `{`, `as`, `where`, or a macro variable of `block` + fragment specifier. + * `vis` may only be followed by one of: `,`, an identifier other than a + non-raw `priv`, any token that can begin a type, or a metavariable with a + `ident`, `ty`, or `path` fragment specifier. + * All other fragment specifiers have no restrictions. + +> **Edition Differences**: Before the 2021 edition, `pat` may also be followed by `|`. + +When repetitions are involved, then the rules apply to every possible number of +expansions, taking separators into account. This means: + + * If the repetition includes a separator, that separator must be able to + follow the contents of the repetition. + * If the repetition can repeat multiple times (`*` or `+`), then the contents + must be able to follow themselves. + * The contents of the repetition must be able to follow whatever comes + before, and whatever comes after must be able to follow the contents of the + repetition. + * If the repetition can match zero times (`*` or `?`), then whatever comes + after must be able to follow whatever comes before. + + +For more detail, see the [formal specification]. + +[Hygiene]: #hygiene +[IDENTIFIER]: identifiers.md +[IDENTIFIER_OR_KEYWORD]: identifiers.md +[RAW_IDENTIFIER]: identifiers.md +[LIFETIME_TOKEN]: tokens.md#lifetimes-and-loop-labels +[Metavariables]: #metavariables +[Repetitions]: #repetitions +[_Attr_]: attributes.md +[_BlockExpression_]: expressions/block-expr.md +[_DelimTokenTree_]: macros.md +[_Expression_]: expressions.md +[_Item_]: items.md +[_LiteralExpression_]: expressions/literal-expr.md +[_MetaListIdents_]: attributes.md#meta-item-attribute-syntax +[_Pattern_]: patterns.md +[_PatternNoTopAlt_]: patterns.md +[_Statement_]: statements.md +[_TokenTree_]: macros.md#macro-invocation +[_Token_]: tokens.md +[delimiters]: tokens.md#delimiters +[_TypePath_]: paths.md#paths-in-types +[_Type_]: types.md#type-expressions +[_UnderscoreExpression_]: expressions/underscore-expr.md +[_Visibility_]: visibility-and-privacy.md +[formal specification]: macro-ambiguity.md +[token]: tokens.md +[`macro_use` prelude]: names/preludes.md#macro_use-prelude diff --git a/src/doc/reference/src/macros.md b/src/doc/reference/src/macros.md new file mode 100644 index 000000000..719b9afbc --- /dev/null +++ b/src/doc/reference/src/macros.md @@ -0,0 +1,104 @@ +# Macros + +The functionality and syntax of Rust can be extended with custom definitions +called macros. They are given names, and invoked through a consistent +syntax: `some_extension!(...)`. + +There are two ways to define new macros: + +* [Macros by Example] define new syntax in a higher-level, declarative way. +* [Procedural Macros] define function-like macros, custom derives, and custom + attributes using functions that operate on input tokens. + +## Macro Invocation + +> **Syntax**\ +> _MacroInvocation_ :\ +>    [_SimplePath_] `!` _DelimTokenTree_ +> +> _DelimTokenTree_ :\ +>       `(` _TokenTree_\* `)`\ +>    | `[` _TokenTree_\* `]`\ +>    | `{` _TokenTree_\* `}` +> +> _TokenTree_ :\ +>    [_Token_]_except [delimiters]_ | _DelimTokenTree_ +> +> _MacroInvocationSemi_ :\ +>       [_SimplePath_] `!` `(` _TokenTree_\* `)` `;`\ +>    | [_SimplePath_] `!` `[` _TokenTree_\* `]` `;`\ +>    | [_SimplePath_] `!` `{` _TokenTree_\* `}` + +A macro invocation expands a macro at compile time and replaces the +invocation with the result of the macro. Macros may be invoked in the +following situations: + +* [Expressions] and [statements] +* [Patterns] +* [Types] +* [Items] including [associated items] +* [`macro_rules`] transcribers +* [External blocks] + +When used as an item or a statement, the _MacroInvocationSemi_ form is used +where a semicolon is required at the end when not using curly braces. +[Visibility qualifiers] are never allowed before a macro invocation or +[`macro_rules`] definition. + +```rust +// Used as an expression. +let x = vec![1,2,3]; + +// Used as a statement. +println!("Hello!"); + +// Used in a pattern. +macro_rules! pat { + ($i:ident) => (Some($i)) +} + +if let pat!(x) = Some(1) { + assert_eq!(x, 1); +} + +// Used in a type. +macro_rules! Tuple { + { $A:ty, $B:ty } => { ($A, $B) }; +} + +type N2 = Tuple!(i32, i32); + +// Used as an item. +# use std::cell::RefCell; +thread_local!(static FOO: RefCell = RefCell::new(1)); + +// Used as an associated item. +macro_rules! const_maker { + ($t:ty, $v:tt) => { const CONST: $t = $v; }; +} +trait T { + const_maker!{i32, 7} +} + +// Macro calls within macros. +macro_rules! example { + () => { println!("Macro call in a macro!") }; +} +// Outer macro `example` is expanded, then inner macro `println` is expanded. +example!(); +``` + +[Macros by Example]: macros-by-example.md +[Procedural Macros]: procedural-macros.md +[_SimplePath_]: paths.md#simple-paths +[_Token_]: tokens.md +[associated items]: items/associated-items.md +[delimiters]: tokens.md#delimiters +[expressions]: expressions.md +[items]: items.md +[`macro_rules`]: macros-by-example.md +[patterns]: patterns.md +[statements]: statements.md +[types]: types.md +[visibility qualifiers]: visibility-and-privacy.md +[External blocks]: items/external-blocks.md diff --git a/src/doc/reference/src/memory-allocation-and-lifetime.md b/src/doc/reference/src/memory-allocation-and-lifetime.md new file mode 100644 index 000000000..7a5bfc12c --- /dev/null +++ b/src/doc/reference/src/memory-allocation-and-lifetime.md @@ -0,0 +1,13 @@ +# Memory allocation and lifetime + +The _items_ of a program are those functions, modules, and types that have their +value calculated at compile-time and stored uniquely in the memory image of the +rust process. Items are neither dynamically allocated nor freed. + +The _heap_ is a general term that describes boxes. The lifetime of an +allocation in the heap depends on the lifetime of the box values pointing to +it. Since box values may themselves be passed in and out of frames, or stored +in the heap, heap allocations may outlive the frame they are allocated within. +An allocation in the heap is guaranteed to reside at a single location in the +heap for the whole lifetime of the allocation - it will never be relocated as +a result of moving a box value. diff --git a/src/doc/reference/src/memory-model.md b/src/doc/reference/src/memory-model.md new file mode 100644 index 000000000..404240db8 --- /dev/null +++ b/src/doc/reference/src/memory-model.md @@ -0,0 +1,5 @@ +# Memory model + +Rust does not yet have a defined memory model. Various academics and industry professionals +are working on various proposals, but for now, this is an under-defined place +in the language. diff --git a/src/doc/reference/src/names.md b/src/doc/reference/src/names.md new file mode 100644 index 000000000..fd8f50cd0 --- /dev/null +++ b/src/doc/reference/src/names.md @@ -0,0 +1,143 @@ +# Names + +An *entity* is a language construct that can be referred to in some way within +the source program, usually via a [path]. Entities include [types], [items], +[generic parameters], [variable bindings], [loop labels], [lifetimes], +[fields], [attributes], and [lints]. + +A *declaration* is a syntactical construct that can introduce a *name* to +refer to an entity. Entity names are valid within a [*scope*] — a region of +source text where that name may be referenced. + +Some entities are [explicitly declared](#explicitly-declared-entities) in the +source code, and some are [implicitly declared](#implicitly-declared-entities) +as part of the language or compiler extensions. + +[*Paths*] are used to refer to an entity, possibly in another scope. Lifetimes +and loop labels use a [dedicated syntax][lifetimes-and-loop-labels] using a +leading quote. + +Names are segregated into different [*namespaces*], allowing entities in +different namespaces to share the same name without conflict. + +[*Name resolution*] is the compile-time process of tying paths, identifiers, +and labels to entity declarations. + +Access to certain names may be restricted based on their [*visibility*]. + +## Explicitly declared entities + +Entities that explicitly introduce a name in the source code are: + +* [Items]: + * [Module declarations] + * [External crate declarations] + * [Use declarations] + * [Function declarations] and [function parameters] + * [Type aliases] + * [struct], [union], [enum], enum variant declarations, and their named + fields + * [Constant item declarations] + * [Static item declarations] + * [Trait item declarations] and their [associated items] + * [External block items] + * [`macro_rules` declarations] and [matcher metavariables] + * [Implementation] associated items +* [Expressions]: + * [Closure] parameters + * [`while let`] pattern bindings + * [`for`] pattern bindings + * [`if let`] pattern bindings + * [`match`] pattern bindings + * [Loop labels] +* [Generic parameters] +* [Higher ranked trait bounds] +* [`let` statement] pattern bindings +* The [`macro_use` attribute] can introduce macro names from another crate +* The [`macro_export` attribute] can introduce an alias for the macro into the crate root + +Additionally, [macro invocations] and [attributes] can introduce names by +expanding to one of the above items. + +## Implicitly declared entities + +The following entities are implicitly defined by the language, or are +introduced by compiler options and extensions: + +* [Language prelude]: + * [Boolean type] — `bool` + * [Textual types] — `char` and `str` + * [Integer types] — `i8`, `i16`, `i32`, `i64`, `i128`, `u8`, `u16`, `u32`, `u64`, `u128` + * [Machine-dependent integer types] — `usize` and `isize` + * [floating-point types] — `f32` and `f64` +* [Built-in attributes] +* [Standard library prelude] items, attributes, and macros +* [Standard library][extern-prelude] crates in the root module +* [External crates][extern-prelude] linked by the compiler +* [Tool attributes] +* [Lints] and [tool lint attributes] +* [Derive helper attributes] are valid within an item without being explicitly imported +* The [`'static`] lifetime + +Additionally, the crate root module does not have a name, but can be referred +to with certain [path qualifiers] or aliases. + + +[*Name resolution*]: names/name-resolution.md +[*namespaces*]: names/namespaces.md +[*paths*]: paths.md +[*scope*]: names/scopes.md +[*visibility*]: visibility-and-privacy.md +[`'static`]: keywords.md#weak-keywords +[`for`]: expressions/loop-expr.md#iterator-loops +[`if let`]: expressions/if-expr.md#if-let-expressions +[`let` statement]: statements.md#let-statements +[`macro_export` attribute]: macros-by-example.md#path-based-scope +[`macro_rules` declarations]: macros-by-example.md +[`macro_use` attribute]: macros-by-example.md#the-macro_use-attribute +[`match`]: expressions/match-expr.md +[`while let`]: expressions/loop-expr.md#predicate-pattern-loops +[associated items]: items/associated-items.md +[attributes]: attributes.md +[Boolean type]: types/boolean.md +[Built-in attributes]: attributes.md#built-in-attributes-index +[Closure]: expressions/closure-expr.md +[Constant item declarations]: items/constant-items.md +[Derive helper attributes]: procedural-macros.md#derive-macro-helper-attributes +[enum]: items/enumerations.md +[Expressions]: expressions.md +[extern-prelude]: names/preludes.md#extern-prelude +[External block items]: items/external-blocks.md +[External crate declarations]: items/extern-crates.md +[fields]: expressions/field-expr.md +[floating-point types]: types/numeric.md#floating-point-types +[Function declarations]: items/functions.md +[function parameters]: items/functions.md#function-parameters +[Generic parameters]: items/generics.md +[Higher ranked trait bounds]: trait-bounds.md#higher-ranked-trait-bounds +[Implementation]: items/implementations.md +[Integer types]: types/numeric.md#integer-types +[Items]: items.md +[Language prelude]: names/preludes.md#language-prelude +[lifetimes-and-loop-labels]: tokens.md#lifetimes-and-loop-labels +[lifetimes]: tokens.md#lifetimes-and-loop-labels +[Lints]: attributes/diagnostics.md#lint-check-attributes +[Loop labels]: expressions/loop-expr.md#loop-labels +[Machine-dependent integer types]: types/numeric.md#machine-dependent-integer-types +[macro invocations]: macros.md#macro-invocation +[matcher metavariables]: macros-by-example.md#metavariables +[Module declarations]: items/modules.md +[path]: paths.md +[path qualifiers]: paths.md#path-qualifiers +[Standard library prelude]: names/preludes.md#standard-library-prelude +[Static item declarations]: items/static-items.md +[struct]: items/structs.md +[Textual types]: types/textual.md +[Tool attributes]: attributes.md#tool-attributes +[tool lint attributes]: attributes/diagnostics.md#tool-lint-attributes +[Trait item declarations]: items/traits.md +[Type aliases]: items/type-aliases.md +[types]: types.md +[union]: items/unions.md +[Use declarations]: items/use-declarations.md +[variable bindings]: patterns.md diff --git a/src/doc/reference/src/names/name-resolution.md b/src/doc/reference/src/names/name-resolution.md new file mode 100644 index 000000000..0f70697a6 --- /dev/null +++ b/src/doc/reference/src/names/name-resolution.md @@ -0,0 +1,3 @@ +# Name resolution + +> **Note**: This is a placeholder for future expansion. diff --git a/src/doc/reference/src/names/namespaces.md b/src/doc/reference/src/names/namespaces.md new file mode 100644 index 000000000..14811697c --- /dev/null +++ b/src/doc/reference/src/names/namespaces.md @@ -0,0 +1,168 @@ +# Namespaces + +A *namespace* is a logical grouping of declared [names]. Names are segregated +into separate namespaces based on the kind of entity the name refers to. +Namespaces allow the occurrence of a name in one namespace to not conflict +with the same name in another namespace. + +Within a namespace, names are organized in a hierarchy, where each level of +the hierarchy has its own collection of named entities. + +There are several different namespaces that each contain different kinds of +entities. The usage of a name will look for the declaration of that name in +different namespaces, based on the context, as described in the [name +resolution] chapter. + +The following is a list of namespaces, with their corresponding entities: + +* Type Namespace + * [Module declarations] + * [External crate declarations] + * [External crate prelude] items + * [Struct], [union], [enum], enum variant declarations + * [Trait item declarations] + * [Type aliases] + * [Associated type declarations] + * Built-in types: [boolean], [numeric], and [textual] + * [Generic type parameters] + * [`Self` type] + * [Tool attribute modules] +* Value Namespace + * [Function declarations] + * [Constant item declarations] + * [Static item declarations] + * [Struct constructors] + * [Enum variant constructors] + * [`Self` constructors] + * [Generic const parameters] + * [Associated const declarations] + * [Associated function declarations] + * Local bindings — [`let`], [`if let`], [`while let`], [`for`], [`match`] + arms, [function parameters], [closure parameters] + * Captured [closure] variables +* Macro Namespace + * [`macro_rules` declarations] + * [Built-in attributes] + * [Tool attributes] + * [Function-like procedural macros] + * [Derive macros] + * [Derive macro helpers] + * [Attribute macros] +* Lifetime Namespace + * [Generic lifetime parameters] +* Label Namespace + * [Loop labels] + +An example of how overlapping names in different namespaces can be used unambiguously: + +```rust +// Foo introduces a type in the type namespace and a constructor in the value +// namespace. +struct Foo(u32); + +// The `Foo` macro is declared in the macro namespace. +macro_rules! Foo { + () => {}; +} + +// `Foo` in the `f` parameter type refers to `Foo` in the type namespace. +// `'Foo` introduces a new lifetime in the lifetime namespace. +fn example<'Foo>(f: Foo) { + // `Foo` refers to the `Foo` constructor in the value namespace. + let ctor = Foo; + // `Foo` refers to the `Foo` macro in the macro namespace. + Foo!{} + // `'Foo` introduces a label in the label namespace. + 'Foo: loop { + // `'Foo` refers to the `'Foo` lifetime parameter, and `Foo` + // refers to the type namespace. + let x: &'Foo Foo; + // `'Foo` refers to the label. + break 'Foo; + } +} +``` + +## Named entities without a namespace + +The following entities have explicit names, but the names are not a part of +any specific namespace. + +### Fields + +Even though struct, enum, and union fields are named, the named fields do not +live in an explicit namespace. They can only be accessed via a [field +expression], which only inspects the field names of the specific type being +accessed. + +### Use declarations + +A [use declaration] has named aliases that it imports into scope, but the +`use` item itself does not belong to a specific namespace. Instead, it can +introduce aliases into multiple namespaces, depending on the item kind being +imported. + + + +## Sub-namespaces + +The macro namespace is split into two sub-namespaces: one for [bang-style macros] and one for [attributes]. +When an attribute is resolved, any bang-style macros in scope will be ignored. +And conversely resolving a bang-style macro will ignore attribute macros in scope. +This prevents one style from shadowing another. + +For example, the [`cfg` attribute] and the [`cfg` macro] are two different entities with the same name in the macro namespace, but they can still be used in their respective context. + +It is still an error for a [`use` import] to shadow another macro, regardless of their sub-namespaces. + +[`cfg` attribute]: ../conditional-compilation.md#the-cfg-attribute +[`cfg` macro]: ../conditional-compilation.md#the-cfg-macro +[`for`]: ../expressions/loop-expr.md#iterator-loops +[`if let`]: ../expressions/if-expr.md#if-let-expressions +[`let`]: ../statements.md#let-statements +[`macro_rules` declarations]: ../macros-by-example.md +[`match`]: ../expressions/match-expr.md +[`Self` constructors]: ../paths.md#self-1 +[`Self` type]: ../paths.md#self-1 +[`use` import]: ../items/use-declarations.md +[`while let`]: ../expressions/loop-expr.md#predicate-pattern-loops +[Associated const declarations]: ../items/associated-items.md#associated-constants +[Associated function declarations]: ../items/associated-items.md#associated-functions-and-methods +[Associated type declarations]: ../items/associated-items.md#associated-types +[Attribute macros]: ../procedural-macros.md#attribute-macros +[attributes]: ../attributes.md +[bang-style macros]: ../macros.md +[boolean]: ../types/boolean.md +[Built-in attributes]: ../attributes.md#built-in-attributes-index +[closure parameters]: ../expressions/closure-expr.md +[closure]: ../expressions/closure-expr.md +[Constant item declarations]: ../items/constant-items.md +[Derive macro helpers]: ../procedural-macros.md#derive-macro-helper-attributes +[Derive macros]: ../procedural-macros.md#derive-macros +[entity]: ../glossary.md#entity +[Enum variant constructors]: ../items/enumerations.md +[enum]: ../items/enumerations.md +[External crate declarations]: ../items/extern-crates.md +[External crate prelude]: preludes.md#extern-prelude +[field expression]: ../expressions/field-expr.md +[Function declarations]: ../items/functions.md +[function parameters]: ../items/functions.md#function-parameters +[Function-like procedural macros]: ../procedural-macros.md#function-like-procedural-macros +[Generic const parameters]: ../items/generics.md#const-generics +[Generic lifetime parameters]: ../items/generics.md +[Generic type parameters]: ../items/generics.md +[Loop labels]: ../expressions/loop-expr.md#loop-labels +[Module declarations]: ../items/modules.md +[name resolution]: name-resolution.md +[names]: ../names.md +[numeric]: ../types/numeric.md +[Static item declarations]: ../items/static-items.md +[Struct constructors]: ../items/structs.md +[Struct]: ../items/structs.md +[textual]: ../types/textual.md +[Tool attribute modules]: ../attributes.md#tool-attributes +[Tool attributes]: ../attributes.md#tool-attributes +[Trait item declarations]: ../items/traits.md +[Type aliases]: ../items/type-aliases.md +[union]: ../items/unions.md +[use declaration]: ../items/use-declarations.md diff --git a/src/doc/reference/src/names/preludes.md b/src/doc/reference/src/names/preludes.md new file mode 100644 index 000000000..00a112948 --- /dev/null +++ b/src/doc/reference/src/names/preludes.md @@ -0,0 +1,173 @@ +# Preludes + +A *prelude* is a collection of names that are automatically brought into scope +of every module in a crate. + +These prelude names are not part of the module itself: they are implicitly +queried during [name resolution]. For example, even though something like +[`Box`] is in scope in every module, you cannot refer to it as `self::Box` +because it is not a member of the current module. + +There are several different preludes: + +- [Standard library prelude] +- [Extern prelude] +- [Language prelude] +- [`macro_use` prelude] +- [Tool prelude] + +## Standard library prelude + +Each crate has a standard library prelude, which consists of the names from a single standard library module. +The module used depends on the crate's edition, and on whether the [`no_std` attribute] is applied to the crate: + +Edition | `no_std` not applied | `no_std` applied +--------| --------------------------- | ---------------------------- +2015 | [`std::prelude::rust_2015`] | [`core::prelude::rust_2015`] +2018 | [`std::prelude::rust_2018`] | [`core::prelude::rust_2018`] +2021 | [`std::prelude::rust_2021`] | [`core::prelude::rust_2021`] + + +> **Note**: +> +> [`std::prelude::rust_2015`] and [`std::prelude::rust_2018`] have the same contents as [`std::prelude::v1`]. +> +> [`core::prelude::rust_2015`] and [`core::prelude::rust_2018`] have the same contents as [`core::prelude::v1`]. + +## Extern prelude + +External crates imported with [`extern crate`] in the root module or provided +to the compiler (as with the `--extern` flag with `rustc`) are added to the +*extern prelude*. If imported with an alias such as `extern crate orig_name as +new_name`, then the symbol `new_name` is instead added to the prelude. + +The [`core`] crate is always added to the extern prelude. The [`std`] crate is +added as long as the [`no_std` attribute] is not specified in the crate root. + +> **Edition Differences**: In the 2015 edition, crates in the extern prelude +> cannot be referenced via [use declarations], so it is generally standard +> practice to include `extern crate` declarations to bring them into scope. +> +> Beginning in the 2018 edition, [use declarations] can reference crates in +> the extern prelude, so it is considered unidiomatic to use `extern crate`. + +> **Note**: Additional crates that ship with `rustc`, such as [`alloc`], and +> [`test`], are not automatically included with the `--extern` flag when using +> Cargo. They must be brought into scope with an `extern crate` declaration, +> even in the 2018 edition. +> +> ```rust +> extern crate alloc; +> use alloc::rc::Rc; +> ``` +> +> Cargo does bring in `proc_macro` to the extern prelude for proc-macro crates +> only. + + + +### The `no_std` attribute + +By default, the standard library is automatically included in the crate root +module. The [`std`] crate is added to the root, along with an implicit +[`macro_use` attribute] pulling in all macros exported from `std` into the +[`macro_use` prelude]. Both [`core`] and [`std`] are added to the [extern +prelude]. + +The *`no_std` [attribute]* may be applied at the crate level to prevent the +[`std`] crate from being automatically added into scope. It does three things: + +* Prevents `std` from being added to the [extern prelude](#extern-prelude). +* Affects which module is used to make up the [standard library prelude] (as described above). +* Injects the [`core`] crate into the crate root instead of [`std`], and pulls + in all macros exported from `core` in the [`macro_use` prelude]. + +> **Note**: Using the core prelude over the standard prelude is useful when +> either the crate is targeting a platform that does not support the standard +> library or is purposefully not using the capabilities of the standard +> library. Those capabilities are mainly dynamic memory allocation (e.g. `Box` +> and `Vec`) and file and network capabilities (e.g. `std::fs` and `std::io`). + +

+ +Warning: Using `no_std` does not prevent the standard library from being +linked in. It is still valid to put `extern crate std;` into the crate and +dependencies can also link it in. + +
+ +## Language prelude + +The language prelude includes names of types and attributes that are built-in +to the language. The language prelude is always in scope. It includes the following: + +* [Type namespace] + * [Boolean type] — `bool` + * [Textual types] — `char` and `str` + * [Integer types] — `i8`, `i16`, `i32`, `i64`, `i128`, `u8`, `u16`, `u32`, `u64`, `u128` + * [Machine-dependent integer types] — `usize` and `isize` + * [floating-point types] — `f32` and `f64` +* [Macro namespace] + * [Built-in attributes] + +## `macro_use` prelude + +The `macro_use` prelude includes macros from external crates that were +imported by the [`macro_use` attribute] applied to an [`extern crate`]. + +## Tool prelude + +The tool prelude includes tool names for external tools in the [type +namespace]. See the [tool attributes] section for more details. + +## The `no_implicit_prelude` attribute + +The *`no_implicit_prelude` [attribute]* may be applied at the crate level or +on a module to indicate that it should not automatically bring the [standard +library prelude], [extern prelude], or [tool prelude] into scope for that +module or any of its descendants. + +This attribute does not affect the [language prelude]. + +> **Edition Differences**: In the 2015 edition, the `no_implicit_prelude` +> attribute does not affect the [`macro_use` prelude], and all macros exported +> from the standard library are still included in the `macro_use` prelude. +> Starting in the 2018 edition, it will remove the `macro_use` prelude. + +[`alloc`]: ../../alloc/index.html +[`Box`]: ../../std/boxed/struct.Box.html +[`core::prelude::v1`]: ../../core/prelude/v1/index.html +[`core::prelude::rust_2015`]: ../../core/prelude/rust_2015/index.html +[`core::prelude::rust_2018`]: ../../core/prelude/rust_2018/index.html +[`core::prelude::rust_2021`]: ../../core/prelude/rust_2021/index.html +[`core`]: ../../core/index.html +[`extern crate`]: ../items/extern-crates.md +[`macro_use` attribute]: ../macros-by-example.md#the-macro_use-attribute +[`macro_use` prelude]: #macro_use-prelude +[`no_std` attribute]: #the-no_std-attribute +[`no_std` attribute]: #the-no_std-attribute +[`std::prelude::v1`]: ../../std/prelude/v1/index.html +[`std::prelude::rust_2015`]: ../../std/prelude/rust_2015/index.html +[`std::prelude::rust_2018`]: ../../std/prelude/rust_2018/index.html +[`std::prelude::rust_2021`]: ../../std/prelude/rust_2021/index.html +[`std`]: ../../std/index.html +[`test`]: ../../test/index.html +[attribute]: ../attributes.md +[Boolean type]: ../types/boolean.md +[Built-in attributes]: ../attributes.md#built-in-attributes-index +[extern prelude]: #extern-prelude +[floating-point types]: ../types/numeric.md#floating-point-types +[Integer types]: ../types/numeric.md#integer-types +[Language prelude]: #language-prelude +[Machine-dependent integer types]: ../types/numeric.md#machine-dependent-integer-types +[Macro namespace]: namespaces.md +[name resolution]: name-resolution.md +[Standard library prelude]: #standard-library-prelude +[Textual types]: ../types/textual.md +[tool attributes]: ../attributes.md#tool-attributes +[Tool prelude]: #tool-prelude +[Type namespace]: namespaces.md +[use declarations]: ../items/use-declarations.md diff --git a/src/doc/reference/src/names/scopes.md b/src/doc/reference/src/names/scopes.md new file mode 100644 index 000000000..288781bd3 --- /dev/null +++ b/src/doc/reference/src/names/scopes.md @@ -0,0 +1,3 @@ +# Scopes + +> **Note**: This is a placeholder for future expansion. diff --git a/src/doc/reference/src/notation.md b/src/doc/reference/src/notation.md new file mode 100644 index 000000000..cb3d8f606 --- /dev/null +++ b/src/doc/reference/src/notation.md @@ -0,0 +1,41 @@ +# Notation + +## Grammar + +The following notations are used by the *Lexer* and *Syntax* grammar snippets: + +| Notation | Examples | Meaning | +|-------------------|-------------------------------|-------------------------------------------| +| CAPITAL | KW_IF, INTEGER_LITERAL | A token produced by the lexer | +| _ItalicCamelCase_ | _LetStatement_, _Item_ | A syntactical production | +| `string` | `x`, `while`, `*` | The exact character(s) | +| \\x | \\n, \\r, \\t, \\0 | The character represented by this escape | +| x? | `pub`? | An optional item | +| x\* | _OuterAttribute_\* | 0 or more of x | +| x+ | _MacroMatch_+ | 1 or more of x | +| xa..b | HEX_DIGIT1..6 | a to b repetitions of x | +| \| | `u8` \| `u16`, Block \| Item | Either one or another | +| \[ ] | \[`b` `B`] | Any of the characters listed | +| \[ - ] | \[`a`-`z`] | Any of the characters in the range | +| ~\[ ] | ~\[`b` `B`] | Any characters, except those listed | +| ~`string` | ~`\n`, ~`*/` | Any characters, except this sequence | +| ( ) | (`,` _Parameter_)? | Groups items | + +## String table productions + +Some rules in the grammar — notably [unary operators], [binary +operators], and [keywords] — are given in a simplified form: as a listing +of printable strings. These cases form a subset of the rules regarding the +[token][tokens] rule, and are assumed to be the result of a lexical-analysis +phase feeding the parser, driven by a DFA, operating over the disjunction of all such string table +entries. + +When such a string in `monospace` font occurs inside the grammar, +it is an implicit reference to a single member of such a string table +production. See [tokens] for more information. + +[binary operators]: expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[keywords]: keywords.md +[tokens]: tokens.md +[unary operators]: expressions/operator-expr.md#borrow-operators diff --git a/src/doc/reference/src/paths.md b/src/doc/reference/src/paths.md new file mode 100644 index 000000000..cb6b24aa0 --- /dev/null +++ b/src/doc/reference/src/paths.md @@ -0,0 +1,404 @@ +# Paths + +A *path* is a sequence of one or more path segments _logically_ separated by +a namespace qualifier (`::`). If a path +consists of only one segment, it refers to either an [item] or a [variable] in +a local control scope. If a path has multiple segments, it always refers to an +item. + +Two examples of simple paths consisting of only identifier segments: + + +```rust,ignore +x; +x::y::z; +``` + +## Types of paths + +### Simple Paths + +> **Syntax**\ +> _SimplePath_ :\ +>    `::`? _SimplePathSegment_ (`::` _SimplePathSegment_)\* +> +> _SimplePathSegment_ :\ +>    [IDENTIFIER] | `super` | `self` | `crate` | `$crate` + +Simple paths are used in [visibility] markers, [attributes], [macros], and [`use`] items. +Examples: + +```rust +use std::io::{self, Write}; +mod m { + #[clippy::cyclomatic_complexity = "0"] + pub (in super) fn f1() {} +} +``` + +### Paths in expressions + +> **Syntax**\ +> _PathInExpression_ :\ +>    `::`? _PathExprSegment_ (`::` _PathExprSegment_)\* +> +> _PathExprSegment_ :\ +>    _PathIdentSegment_ (`::` _GenericArgs_)? +> +> _PathIdentSegment_ :\ +>    [IDENTIFIER] | `super` | `self` | `Self` | `crate` | `$crate` +> +> _GenericArgs_ :\ +>       `<` `>`\ +>    | `<` ( _GenericArg_ `,` )\* _GenericArg_ `,`? `>` +> +> _GenericArg_ :\ +>    [_Lifetime_] | [_Type_] | _GenericArgsConst_ | _GenericArgsBinding_ +> +> _GenericArgsConst_ :\ +>       [_BlockExpression_]\ +>    | [_LiteralExpression_]\ +>    | `-` [_LiteralExpression_]\ +>    | [_SimplePathSegment_] +> +> _GenericArgsBinding_ :\ +>    [IDENTIFIER] `=` [_Type_] + +Paths in expressions allow for paths with generic arguments to be specified. They are +used in various places in [expressions] and [patterns]. + +The `::` token is required before the opening `<` for generic arguments to avoid +ambiguity with the less-than operator. This is colloquially known as "turbofish" syntax. + +```rust +(0..10).collect::>(); +Vec::::with_capacity(1024); +``` + +The order of generic arguments is restricted to lifetime arguments, then type +arguments, then const arguments, then equality constraints. + +Const arguments must be surrounded by braces unless they are a +[literal] or a single segment path. + +The synthetic type parameters corresponding to `impl Trait` types are implicit, +and these cannot be explicitly specified. + +## Qualified paths + +> **Syntax**\ +> _QualifiedPathInExpression_ :\ +>    _QualifiedPathType_ (`::` _PathExprSegment_)+ +> +> _QualifiedPathType_ :\ +>    `<` [_Type_] (`as` _TypePath_)? `>` +> +> _QualifiedPathInType_ :\ +>    _QualifiedPathType_ (`::` _TypePathSegment_)+ + +Fully qualified paths allow for disambiguating the path for [trait implementations] and +for specifying [canonical paths](#canonical-paths). When used in a type specification, it +supports using the type syntax specified below. + +```rust +struct S; +impl S { + fn f() { println!("S"); } +} +trait T1 { + fn f() { println!("T1 f"); } +} +impl T1 for S {} +trait T2 { + fn f() { println!("T2 f"); } +} +impl T2 for S {} +S::f(); // Calls the inherent impl. +::f(); // Calls the T1 trait function. +::f(); // Calls the T2 trait function. +``` + +### Paths in types + +> **Syntax**\ +> _TypePath_ :\ +>    `::`? _TypePathSegment_ (`::` _TypePathSegment_)\* +> +> _TypePathSegment_ :\ +>    _PathIdentSegment_ `::`? ([_GenericArgs_] | _TypePathFn_)? +> +> _TypePathFn_ :\ +> `(` _TypePathFnInputs_? `)` (`->` [_Type_])? +> +> _TypePathFnInputs_ :\ +> [_Type_] (`,` [_Type_])\* `,`? + +Type paths are used within type definitions, trait bounds, type parameter bounds, +and qualified paths. + +Although the `::` token is allowed before the generics arguments, it is not required +because there is no ambiguity like there is in _PathInExpression_. + +```rust +# mod ops { +# pub struct Range {f1: T} +# pub trait Index {} +# pub struct Example<'a> {f1: &'a i32} +# } +# struct S; +impl ops::Index> for S { /*...*/ } +fn i<'a>() -> impl Iterator> { + // ... +# const EXAMPLE: Vec> = Vec::new(); +# EXAMPLE.into_iter() +} +type G = std::boxed::Box isize>; +``` + +## Path qualifiers + +Paths can be denoted with various leading qualifiers to change the meaning of +how it is resolved. + +### `::` + +Paths starting with `::` are considered to be *global paths* where the segments of the path +start being resolved from a place which differs based on edition. Each identifier in +the path must resolve to an item. + +> **Edition Differences**: In the 2015 Edition, identifiers resolve from the "crate root" +> (`crate::` in the 2018 edition), which contains a variety of different items, including +> external crates, default crates such as `std` or `core`, and items in the top level of +> the crate (including `use` imports). +> +> Beginning with the 2018 Edition, paths starting with `::` resolve from +> crates in the [extern prelude]. That is, they must be followed by the name of a crate. + +```rust +pub fn foo() { + // In the 2018 edition, this accesses `std` via the extern prelude. + // In the 2015 edition, this accesses `std` via the crate root. + let now = ::std::time::Instant::now(); + println!("{:?}", now); +} +``` + +```rust,edition2015 +// 2015 Edition +mod a { + pub fn foo() {} +} +mod b { + pub fn foo() { + ::a::foo(); // call `a`'s foo function + // In Rust 2018, `::a` would be interpreted as the crate `a`. + } +} +# fn main() {} +``` + +### `self` + +`self` resolves the path relative to the current module. `self` can only be used as the +first segment, without a preceding `::`. + +```rust +fn foo() {} +fn bar() { + self::foo(); +} +# fn main() {} +``` + +### `Self` + +`Self`, with a capital "S", is used to refer to the implementing type within +[traits] and [implementations]. + +`Self` can only be used as the first segment, without a preceding `::`. + +```rust +trait T { + type Item; + const C: i32; + // `Self` will be whatever type that implements `T`. + fn new() -> Self; + // `Self::Item` will be the type alias in the implementation. + fn f(&self) -> Self::Item; +} +struct S; +impl T for S { + type Item = i32; + const C: i32 = 9; + fn new() -> Self { // `Self` is the type `S`. + S + } + fn f(&self) -> Self::Item { // `Self::Item` is the type `i32`. + Self::C // `Self::C` is the constant value `9`. + } +} +``` + +### `super` + +`super` in a path resolves to the parent module. It may only be used in leading +segments of the path, possibly after an initial `self` segment. + +```rust +mod a { + pub fn foo() {} +} +mod b { + pub fn foo() { + super::a::foo(); // call a's foo function + } +} +# fn main() {} +``` + +`super` may be repeated several times after the first `super` or `self` to refer to +ancestor modules. + +```rust +mod a { + fn foo() {} + + mod b { + mod c { + fn foo() { + super::super::foo(); // call a's foo function + self::super::super::foo(); // call a's foo function + } + } + } +} +# fn main() {} +``` + +### `crate` + +`crate` resolves the path relative to the current crate. `crate` can only be used as the +first segment, without a preceding `::`. + +```rust +fn foo() {} +mod a { + fn bar() { + crate::foo(); + } +} +# fn main() {} +``` + +### `$crate` + +`$crate` is only used within [macro transcribers], and can only be used as the first +segment, without a preceding `::`. `$crate` will expand to a path to access items from the +top level of the crate where the macro is defined, regardless of which crate the macro is +invoked. + +```rust +pub fn increment(x: u32) -> u32 { + x + 1 +} + +#[macro_export] +macro_rules! inc { + ($x:expr) => ( $crate::increment($x) ) +} +# fn main() { } +``` + +## Canonical paths + +Items defined in a module or implementation have a *canonical path* that +corresponds to where within its crate it is defined. All other paths to these +items are aliases. The canonical path is defined as a *path prefix* appended by +the path segment the item itself defines. + +[Implementations] and [use declarations] do not have canonical paths, although +the items that implementations define do have them. Items defined in +block expressions do not have canonical paths. Items defined in a module that +does not have a canonical path do not have a canonical path. Associated items +defined in an implementation that refers to an item without a canonical path, +e.g. as the implementing type, the trait being implemented, a type parameter or +bound on a type parameter, do not have canonical paths. + +The path prefix for modules is the canonical path to that module. For bare +implementations, it is the canonical path of the item being implemented +surrounded by angle (`<>`) brackets. For +[trait implementations], it is the canonical path of the item being implemented +followed by `as` followed by the canonical path to the trait all surrounded in +angle (`<>`) brackets. + +The canonical path is only meaningful within a given crate. There is no global +namespace across crates; an item's canonical path merely identifies it within +the crate. + +```rust +// Comments show the canonical path of the item. + +mod a { // crate::a + pub struct Struct; // crate::a::Struct + + pub trait Trait { // crate::a::Trait + fn f(&self); // crate::a::Trait::f + } + + impl Trait for Struct { + fn f(&self) {} // ::f + } + + impl Struct { + fn g(&self) {} // ::g + } +} + +mod without { // crate::without + fn canonicals() { // crate::without::canonicals + struct OtherStruct; // None + + trait OtherTrait { // None + fn g(&self); // None + } + + impl OtherTrait for OtherStruct { + fn g(&self) {} // None + } + + impl OtherTrait for crate::a::Struct { + fn g(&self) {} // None + } + + impl crate::a::Trait for OtherStruct { + fn f(&self) {} // None + } + } +} + +# fn main() {} +``` + +[_BlockExpression_]: expressions/block-expr.md +[_Expression_]: expressions.md +[_GenericArgs_]: #paths-in-expressions +[_Lifetime_]: trait-bounds.md +[_LiteralExpression_]: expressions/literal-expr.md +[_SimplePathSegment_]: #simple-paths +[_Type_]: types.md#type-expressions +[literal]: expressions/literal-expr.md +[item]: items.md +[variable]: variables.md +[implementations]: items/implementations.md +[use declarations]: items/use-declarations.md +[IDENTIFIER]: identifiers.md +[`use`]: items/use-declarations.md +[attributes]: attributes.md +[expressions]: expressions.md +[extern prelude]: names/preludes.md#extern-prelude +[macro transcribers]: macros-by-example.md +[macros]: macros-by-example.md +[patterns]: patterns.md +[trait implementations]: items/implementations.md#trait-implementations +[traits]: items/traits.md +[visibility]: visibility-and-privacy.md diff --git a/src/doc/reference/src/patterns.md b/src/doc/reference/src/patterns.md new file mode 100644 index 000000000..5c81ecd87 --- /dev/null +++ b/src/doc/reference/src/patterns.md @@ -0,0 +1,873 @@ +# Patterns + +> **Syntax**\ +> _Pattern_ :\ +>       `|`? _PatternNoTopAlt_ ( `|` _PatternNoTopAlt_ )\* +> +> _PatternNoTopAlt_ :\ +>       _PatternWithoutRange_\ +>    | [_RangePattern_] +> +> _PatternWithoutRange_ :\ +>       [_LiteralPattern_]\ +>    | [_IdentifierPattern_]\ +>    | [_WildcardPattern_]\ +>    | [_RestPattern_]\ +>    | [_ReferencePattern_]\ +>    | [_StructPattern_]\ +>    | [_TupleStructPattern_]\ +>    | [_TuplePattern_]\ +>    | [_GroupedPattern_]\ +>    | [_SlicePattern_]\ +>    | [_PathPattern_]\ +>    | [_MacroInvocation_] + +Patterns are used to match values against structures and to, +optionally, bind variables to values inside these structures. They are also +used in variable declarations and parameters for functions and closures. + +The pattern in the following example does four things: + +* Tests if `person` has the `car` field filled with something. +* Tests if the person's `age` field is between 13 and 19, and binds its value to + the `person_age` variable. +* Binds a reference to the `name` field to the variable `person_name`. +* Ignores the rest of the fields of `person`. The remaining fields can have any value and + are not bound to any variables. + +```rust +# struct Car; +# struct Computer; +# struct Person { +# name: String, +# car: Option, +# computer: Option, +# age: u8, +# } +# let person = Person { +# name: String::from("John"), +# car: Some(Car), +# computer: None, +# age: 15, +# }; +if let + Person { + car: Some(_), + age: person_age @ 13..=19, + name: ref person_name, + .. + } = person +{ + println!("{} has a car and is {} years old.", person_name, person_age); +} +``` + +Patterns are used in: + +* [`let` declarations](statements.md#let-statements) +* [Function](items/functions.md) and [closure](expressions/closure-expr.md) + parameters +* [`match` expressions](expressions/match-expr.md) +* [`if let` expressions](expressions/if-expr.md) +* [`while let` expressions](expressions/loop-expr.md#predicate-pattern-loops) +* [`for` expressions](expressions/loop-expr.md#iterator-loops) + +## Destructuring + +Patterns can be used to *destructure* [structs], [enums], and [tuples]. +Destructuring breaks up a value into its component pieces. The syntax used is +almost the same as when creating such values. In a pattern whose [scrutinee] +expression has a `struct`, `enum` or `tuple` type, a placeholder (`_`) stands +in for a *single* data field, whereas a wildcard `..` stands in for *all* the +remaining fields of a particular variant. When destructuring a data structure +with named (but not numbered) fields, it is allowed to write `fieldname` as a +shorthand for `fieldname: fieldname`. + +```rust +# enum Message { +# Quit, +# WriteString(String), +# Move { x: i32, y: i32 }, +# ChangeColor(u8, u8, u8), +# } +# let message = Message::Quit; +match message { + Message::Quit => println!("Quit"), + Message::WriteString(write) => println!("{}", &write), + Message::Move{ x, y: 0 } => println!("move {} horizontally", x), + Message::Move{ .. } => println!("other move"), + Message::ChangeColor { 0: red, 1: green, 2: _ } => { + println!("color change, red: {}, green: {}", red, green); + } +}; +``` + +## Refutability + +A pattern is said to be *refutable* when it has the possibility of not being matched +by the value it is being matched against. *Irrefutable* patterns, on the other hand, +always match the value they are being matched against. Examples: + +```rust +let (x, y) = (1, 2); // "(x, y)" is an irrefutable pattern + +if let (a, 3) = (1, 2) { // "(a, 3)" is refutable, and will not match + panic!("Shouldn't reach here"); +} else if let (a, 4) = (3, 4) { // "(a, 4)" is refutable, and will match + println!("Matched ({}, 4)", a); +} +``` + +## Literal patterns + +> **Syntax**\ +> _LiteralPattern_ :\ +>       `true` | `false`\ +>    | [CHAR_LITERAL]\ +>    | [BYTE_LITERAL]\ +>    | [STRING_LITERAL]\ +>    | [RAW_STRING_LITERAL]\ +>    | [BYTE_STRING_LITERAL]\ +>    | [RAW_BYTE_STRING_LITERAL]\ +>    | `-`? [INTEGER_LITERAL]\ +>    | `-`? [FLOAT_LITERAL] + +[CHAR_LITERAL]: tokens.md#character-literals +[BYTE_LITERAL]: tokens.md#byte-literals +[STRING_LITERAL]: tokens.md#string-literals +[RAW_STRING_LITERAL]: tokens.md#raw-string-literals +[BYTE_STRING_LITERAL]: tokens.md#byte-string-literals +[RAW_BYTE_STRING_LITERAL]: tokens.md#raw-byte-string-literals +[INTEGER_LITERAL]: tokens.md#integer-literals +[FLOAT_LITERAL]: tokens.md#floating-point-literals + +_Literal patterns_ match exactly the same value as what is created by the +literal. Since negative numbers are not [literals], literal patterns also +accept an optional minus sign before the literal, which acts like the negation +operator. + +
+ +Floating-point literals are currently accepted, but due to the complexity of comparing +them, they are going to be forbidden on literal patterns in a future version of Rust (see +[issue #41620](https://github.com/rust-lang/rust/issues/41620)). + +
+ +Literal patterns are always refutable. + +Examples: + +```rust +for i in -2..5 { + match i { + -1 => println!("It's minus one"), + 1 => println!("It's a one"), + 2|4 => println!("It's either a two or a four"), + _ => println!("Matched none of the arms"), + } +} +``` + +## Identifier patterns + +> **Syntax**\ +> _IdentifierPattern_ :\ +>       `ref`? `mut`? [IDENTIFIER] (`@` [_PatternNoTopAlt_] ) ? + +Identifier patterns bind the value they match to a variable. The identifier +must be unique within the pattern. The variable will shadow any variables of +the same name in scope. The scope of the new binding depends on the context of +where the pattern is used (such as a `let` binding or a `match` arm). + +Patterns that consist of only an identifier, possibly with a `mut`, match any value and +bind it to that identifier. This is the most commonly used pattern in variable +declarations and parameters for functions and closures. + +```rust +let mut variable = 10; +fn sum(x: i32, y: i32) -> i32 { +# x + y +# } +``` + +To bind the matched value of a pattern to a variable, use the syntax `variable @ +subpattern`. For example, the following binds the value 2 to `e` (not the +entire range: the range here is a range subpattern). + +```rust +let x = 2; + +match x { + e @ 1 ..= 5 => println!("got a range element {}", e), + _ => println!("anything"), +} +``` + +By default, identifier patterns bind a variable to a copy of or move from the +matched value depending on whether the matched value implements [`Copy`]. +This can be changed to bind to a reference by using the `ref` keyword, +or to a mutable reference using `ref mut`. For example: + +```rust +# let a = Some(10); +match a { + None => (), + Some(value) => (), +} + +match a { + None => (), + Some(ref value) => (), +} +``` + +In the first match expression, the value is copied (or moved). In the second match, +a reference to the same memory location is bound to the variable value. This syntax is +needed because in destructuring subpatterns the `&` operator can't be applied to +the value's fields. For example, the following is not valid: + +```rust,compile_fail +# struct Person { +# name: String, +# age: u8, +# } +# let value = Person { name: String::from("John"), age: 23 }; +if let Person { name: &person_name, age: 18..=150 } = value { } +``` + +To make it valid, write the following: + +```rust +# struct Person { +# name: String, +# age: u8, +# } +# let value = Person { name: String::from("John"), age: 23 }; +if let Person {name: ref person_name, age: 18..=150 } = value { } +``` + +Thus, `ref` is not something that is being matched against. Its objective is +exclusively to make the matched binding a reference, instead of potentially +copying or moving what was matched. + +[Path patterns](#path-patterns) take precedence over identifier patterns. It is an error +if `ref` or `ref mut` is specified and the identifier shadows a constant. + +Identifier patterns are irrefutable if the `@` subpattern is irrefutable or +the subpattern is not specified. + +### Binding modes + +To service better ergonomics, patterns operate in different *binding modes* in +order to make it easier to bind references to values. When a reference value is matched by +a non-reference pattern, it will be automatically treated as a `ref` or `ref mut` binding. +Example: + +```rust +let x: &Option = &Some(3); +if let Some(y) = x { + // y was converted to `ref y` and its type is &i32 +} +``` + +*Non-reference patterns* include all patterns except bindings, [wildcard +patterns](#wildcard-pattern) (`_`), [`const` patterns](#path-patterns) of reference types, +and [reference patterns](#reference-patterns). + +If a binding pattern does not explicitly have `ref`, `ref mut`, or `mut`, then it uses the +*default binding mode* to determine how the variable is bound. The default binding +mode starts in "move" mode which uses move semantics. When matching a pattern, the +compiler starts from the outside of the pattern and works inwards. Each time a reference +is matched using a non-reference pattern, it will automatically dereference the value and +update the default binding mode. References will set the default binding mode to `ref`. +Mutable references will set the mode to `ref mut` unless the mode is already `ref` in +which case it remains `ref`. If the automatically dereferenced value is still a reference, +it is dereferenced and this process repeats. + +Move bindings and reference bindings can be mixed together in the same pattern, doing so will +result in partial move of the object bound to and the object cannot be used afterwards. +This applies only if the type cannot be copied. + +In the example below, `name` is moved out of `person`, trying to use `person` as a whole or +`person.name` would result in an error because of *partial move*. + +Example: + +```rust +# struct Person { +# name: String, +# age: u8, +# } +# let person = Person{ name: String::from("John"), age: 23 }; +// `name` is moved from person and `age` referenced +let Person { name, ref age } = person; +``` + +## Wildcard pattern + +> **Syntax**\ +> _WildcardPattern_ :\ +>    `_` + +The _wildcard pattern_ (an underscore symbol) matches any value. It is used to ignore values when they don't +matter. Inside other patterns it matches a single data field (as opposed to the `..` +which matches the remaining fields). Unlike identifier patterns, it does not copy, move +or borrow the value it matches. + +Examples: + +```rust +# let x = 20; +let (a, _) = (10, x); // the x is always matched by _ +# assert_eq!(a, 10); + +// ignore a function/closure param +let real_part = |a: f64, _: f64| { a }; + +// ignore a field from a struct +# struct RGBA { +# r: f32, +# g: f32, +# b: f32, +# a: f32, +# } +# let color = RGBA{r: 0.4, g: 0.1, b: 0.9, a: 0.5}; +let RGBA{r: red, g: green, b: blue, a: _} = color; +# assert_eq!(color.r, red); +# assert_eq!(color.g, green); +# assert_eq!(color.b, blue); + +// accept any Some, with any value +# let x = Some(10); +if let Some(_) = x {} +``` + +The wildcard pattern is always irrefutable. + +## Rest patterns + +> **Syntax**\ +> _RestPattern_ :\ +>    `..` + +The _rest pattern_ (the `..` token) acts as a variable-length pattern which +matches zero or more elements that haven't been matched already before and +after. It may only be used in [tuple](#tuple-patterns), [tuple +struct](#tuple-struct-patterns), and [slice](#slice-patterns) patterns, and +may only appear once as one of the elements in those patterns. It is also +allowed in an [identifier pattern](#identifier-patterns) for [slice +patterns](#slice-patterns) only. + +The rest pattern is always irrefutable. + +Examples: + +```rust +# let words = vec!["a", "b", "c"]; +# let slice = &words[..]; +match slice { + [] => println!("slice is empty"), + [one] => println!("single element {}", one), + [head, tail @ ..] => println!("head={} tail={:?}", head, tail), +} + +match slice { + // Ignore everything but the last element, which must be "!". + [.., "!"] => println!("!!!"), + + // `start` is a slice of everything except the last element, which must be "z". + [start @ .., "z"] => println!("starts with: {:?}", start), + + // `end` is a slice of everything but the first element, which must be "a". + ["a", end @ ..] => println!("ends with: {:?}", end), + + // 'whole' is the entire slice and `last` is the final element + whole @ [.., last] => println!("the last element of {:?} is {}", whole, last), + + rest => println!("{:?}", rest), +} + +if let [.., penultimate, _] = slice { + println!("next to last is {}", penultimate); +} + +# let tuple = (1, 2, 3, 4, 5); +// Rest patterns may also be used in tuple and tuple struct patterns. +match tuple { + (1, .., y, z) => println!("y={} z={}", y, z), + (.., 5) => println!("tail must be 5"), + (..) => println!("matches everything else"), +} +``` + +## Range patterns + +> **Syntax**\ +> _RangePattern_ :\ +>       _InclusiveRangePattern_\ +>    | _HalfOpenRangePattern_\ +>    | _ObsoleteRangePattern_ +> +> _InclusiveRangePattern_ :\ +>       _RangePatternBound_ `..=` _RangePatternBound_ +> +> _HalfOpenRangePattern_ :\ +>    | _RangePatternBound_ `..` +> +> _ObsoleteRangePattern_ :\ +>    _RangePatternBound_ `...` _RangePatternBound_ +> +> _RangePatternBound_ :\ +>       [CHAR_LITERAL]\ +>    | [BYTE_LITERAL]\ +>    | `-`? [INTEGER_LITERAL]\ +>    | `-`? [FLOAT_LITERAL]\ +>    | [_PathExpression_] + +Range patterns match values within the range defined by their bounds. A range pattern may be +closed or half-open. A range pattern is closed if it has both a lower and an upper bound, and +it matches all the values between and including both of its bounds. A range pattern that is +half-open is written with a lower bound but not an upper bound, and matches any value equal to +or greater than the specified lower bound. + +For example, a pattern `'m'..='p'` will match only the values `'m'`, `'n'`, `'o'`, and `'p'`. For an integer the +pattern `1..` will match 9, or 9001, or 9007199254740991 (if it is of an appropriate size), but +not 0, and not negative numbers for signed integers. The bounds can be literals or paths that point +to constant values. + +A half-open range pattern in the style `a..` cannot be used to match within the context of a slice. + +A pattern `a..=b` must always have a ≤ b. It is an error to have a range pattern +`10..=0`, for example. + +Range patterns only work on scalar types. The accepted types are: + +* Integer types (u8, i8, u16, i16, usize, isize, etc.). +* Character types (char). +* Floating point types (f32 and f64). This is being deprecated and will not be available + in a future version of Rust (see + [issue #41620](https://github.com/rust-lang/rust/issues/41620)). + +Examples: + +```rust +# let c = 'f'; +let valid_variable = match c { + 'a'..='z' => true, + 'A'..='Z' => true, + 'α'..='ω' => true, + _ => false, +}; + +# let ph = 10; +println!("{}", match ph { + 0..=6 => "acid", + 7 => "neutral", + 8..=14 => "base", + _ => unreachable!(), +}); + +# let uint: u32 = 5; +match uint { + 0 => "zero!", + 1.. => "positive number!", +}; + +// using paths to constants: +# const TROPOSPHERE_MIN : u8 = 6; +# const TROPOSPHERE_MAX : u8 = 20; +# +# const STRATOSPHERE_MIN : u8 = TROPOSPHERE_MAX + 1; +# const STRATOSPHERE_MAX : u8 = 50; +# +# const MESOSPHERE_MIN : u8 = STRATOSPHERE_MAX + 1; +# const MESOSPHERE_MAX : u8 = 85; +# +# let altitude = 70; +# +println!("{}", match altitude { + TROPOSPHERE_MIN..=TROPOSPHERE_MAX => "troposphere", + STRATOSPHERE_MIN..=STRATOSPHERE_MAX => "stratosphere", + MESOSPHERE_MIN..=MESOSPHERE_MAX => "mesosphere", + _ => "outer space, maybe", +}); + +# pub mod binary { +# pub const MEGA : u64 = 1024*1024; +# pub const GIGA : u64 = 1024*1024*1024; +# } +# let n_items = 20_832_425; +# let bytes_per_item = 12; +if let size @ binary::MEGA..=binary::GIGA = n_items * bytes_per_item { + println!("It fits and occupies {} bytes", size); +} + +# trait MaxValue { +# const MAX: u64; +# } +# impl MaxValue for u8 { +# const MAX: u64 = (1 << 8) - 1; +# } +# impl MaxValue for u16 { +# const MAX: u64 = (1 << 16) - 1; +# } +# impl MaxValue for u32 { +# const MAX: u64 = (1 << 32) - 1; +# } +// using qualified paths: +println!("{}", match 0xfacade { + 0 ..= ::MAX => "fits in a u8", + 0 ..= ::MAX => "fits in a u16", + 0 ..= ::MAX => "fits in a u32", + _ => "too big", +}); +``` + +Range patterns for (non-`usize` and -`isize`) integer and `char` types are irrefutable +when they span the entire set of possible values of a type. For example, `0u8..=255u8` +is irrefutable. The range of values for an integer type is the closed range from its +minimum to maximum value. The range of values for a `char` type are precisely those +ranges containing all Unicode Scalar Values: `'\u{0000}'..='\u{D7FF}'` and +`'\u{E000}'..='\u{10FFFF}'`. + +> **Edition Differences**: Before the 2021 edition, closed range patterns may also be written using `...` as an alternative to `..=`, with the same meaning. + +## Reference patterns + +> **Syntax**\ +> _ReferencePattern_ :\ +>    (`&`|`&&`) `mut`? [_PatternWithoutRange_] + +Reference patterns dereference the pointers that are being matched +and, thus, borrow them. + +For example, these two matches on `x: &i32` are equivalent: + +```rust +let int_reference = &3; + +let a = match *int_reference { 0 => "zero", _ => "some" }; +let b = match int_reference { &0 => "zero", _ => "some" }; + +assert_eq!(a, b); +``` + +The grammar production for reference patterns has to match the token `&&` to match a +reference to a reference because it is a token by itself, not two `&` tokens. + +Adding the `mut` keyword dereferences a mutable reference. The mutability must match the +mutability of the reference. + +Reference patterns are always irrefutable. + +## Struct patterns + +> **Syntax**\ +> _StructPattern_ :\ +>    [_PathInExpression_] `{`\ +>       _StructPatternElements_ ?\ +>    `}` +> +> _StructPatternElements_ :\ +>       _StructPatternFields_ (`,` | `,` _StructPatternEtCetera_)?\ +>    | _StructPatternEtCetera_ +> +> _StructPatternFields_ :\ +>    _StructPatternField_ (`,` _StructPatternField_) \* +> +> _StructPatternField_ :\ +>    [_OuterAttribute_] \*\ +>    (\ +>          [TUPLE_INDEX] `:` [_Pattern_]\ +>       | [IDENTIFIER] `:` [_Pattern_]\ +>       | `ref`? `mut`? [IDENTIFIER]\ +>    ) +> +> _StructPatternEtCetera_ :\ +>    [_OuterAttribute_] \*\ +>    `..` + +[_OuterAttribute_]: attributes.md +[TUPLE_INDEX]: tokens.md#tuple-index + +Struct patterns match struct values that match all criteria defined by its subpatterns. +They are also used to [destructure](#destructuring) a struct. + +On a struct pattern, the fields are referenced by name, index (in the case of tuple +structs) or ignored by use of `..`: + +```rust +# struct Point { +# x: u32, +# y: u32, +# } +# let s = Point {x: 1, y: 1}; +# +match s { + Point {x: 10, y: 20} => (), + Point {y: 10, x: 20} => (), // order doesn't matter + Point {x: 10, ..} => (), + Point {..} => (), +} + +# struct PointTuple ( +# u32, +# u32, +# ); +# let t = PointTuple(1, 2); +# +match t { + PointTuple {0: 10, 1: 20} => (), + PointTuple {1: 10, 0: 20} => (), // order doesn't matter + PointTuple {0: 10, ..} => (), + PointTuple {..} => (), +} +``` + +If `..` is not used, it is required to match all fields: + +```rust +# struct Struct { +# a: i32, +# b: char, +# c: bool, +# } +# let mut struct_value = Struct{a: 10, b: 'X', c: false}; +# +match struct_value { + Struct{a: 10, b: 'X', c: false} => (), + Struct{a: 10, b: 'X', ref c} => (), + Struct{a: 10, b: 'X', ref mut c} => (), + Struct{a: 10, b: 'X', c: _} => (), + Struct{a: _, b: _, c: _} => (), +} +``` + +The `ref` and/or `mut` _IDENTIFIER_ syntax matches any value and binds it to +a variable with the same name as the given field. + +```rust +# struct Struct { +# a: i32, +# b: char, +# c: bool, +# } +# let struct_value = Struct{a: 10, b: 'X', c: false}; +# +let Struct{a: x, b: y, c: z} = struct_value; // destructure all fields +``` + +A struct pattern is refutable when one of its subpatterns is refutable. + +## Tuple struct patterns + +> **Syntax**\ +> _TupleStructPattern_ :\ +>    [_PathInExpression_] `(` _TupleStructItems_? `)` +> +> _TupleStructItems_ :\ +>    [_Pattern_] ( `,` [_Pattern_] )\* `,`? + +Tuple struct patterns match tuple struct and enum values that match all criteria defined +by its subpatterns. They are also used to [destructure](#destructuring) a tuple struct or +enum value. + +A tuple struct pattern is refutable when one of its subpatterns is refutable. + +## Tuple patterns + +> **Syntax**\ +> _TuplePattern_ :\ +>    `(` _TuplePatternItems_? `)` +> +> _TuplePatternItems_ :\ +>       [_Pattern_] `,`\ +>    | [_RestPattern_]\ +>    | [_Pattern_] (`,` [_Pattern_])+ `,`? + +Tuple patterns match tuple values that match all criteria defined by its subpatterns. +They are also used to [destructure](#destructuring) a tuple. + +The form `(..)` with a single [_RestPattern_] is a special form that does not +require a comma, and matches a tuple of any size. + +The tuple pattern is refutable when one of its subpatterns is refutable. + +An example of using tuple patterns: + +```rust +let pair = (10, "ten"); +let (a, b) = pair; + +assert_eq!(a, 10); +assert_eq!(b, "ten"); +``` + +## Grouped patterns + +> **Syntax**\ +> _GroupedPattern_ :\ +>    `(` [_Pattern_] `)` + +Enclosing a pattern in parentheses can be used to explicitly control the +precedence of compound patterns. For example, a reference pattern next to a +range pattern such as `&0..=5` is ambiguous and is not allowed, but can be +expressed with parentheses. + +```rust +let int_reference = &3; +match int_reference { + &(0..=5) => (), + _ => (), +} +``` + +## Slice patterns + +> **Syntax**\ +> _SlicePattern_ :\ +>    `[` _SlicePatternItems_? `]` +> +> _SlicePatternItems_ :\ +>    [_Pattern_] \(`,` [_Pattern_])\* `,`? + +Slice patterns can match both arrays of fixed size and slices of dynamic size. +```rust +// Fixed size +let arr = [1, 2, 3]; +match arr { + [1, _, _] => "starts with one", + [a, b, c] => "starts with something else", +}; +``` +```rust +// Dynamic size +let v = vec![1, 2, 3]; +match v[..] { + [a, b] => { /* this arm will not apply because the length doesn't match */ } + [a, b, c] => { /* this arm will apply */ } + _ => { /* this wildcard is required, since the length is not known statically */ } +}; +``` + +Slice patterns are irrefutable when matching an array as long as each element +is irrefutable. When matching a slice, it is irrefutable only in the form with +a single `..` [rest pattern](#rest-patterns) or [identifier +pattern](#identifier-patterns) with the `..` rest pattern as a subpattern. + +Within a slice, a half-open range pattern like `a..` must be enclosed in parentheses, +as in `(a..)`, to clarify it is intended to match a single value. +A future version of Rust may give the non-parenthesized version an alternate meaning. + +## Path patterns + +> **Syntax**\ +> _PathPattern_ :\ +>       [_PathExpression_] + +_Path patterns_ are patterns that refer either to constant values or +to structs or enum variants that have no fields. + +Unqualified path patterns can refer to: + +* enum variants +* structs +* constants +* associated constants + +Qualified path patterns can only refer to associated constants. + +Constants cannot be a union type. Struct and enum constants must have +`#[derive(PartialEq, Eq)]` (not merely implemented). + +Path patterns are irrefutable when they refer to structs or an enum variant when the enum +has only one variant or a constant whose type is irrefutable. They are refutable when they +refer to refutable constants or enum variants for enums with multiple variants. + +## Or-patterns + +_Or-patterns_ are patterns that match on one of two or more sub-patterns (e.g. +`A | B | C`). They can nest arbitrarily. Syntactically, or-patterns are allowed +in any of the places where other patterns are allowed (represented by the +_Pattern_ production), with the exceptions of `let`-bindings and function and +closure arguments (represented by the _PatternNoTopAlt_ production). + +### Static semantics + +1. Given a pattern `p | q` at some depth for some arbitrary patterns `p` and `q`, + the pattern is considered ill-formed if: + + + the type inferred for `p` does not unify with the type inferred for `q`, or + + the same set of bindings are not introduced in `p` and `q`, or + + the type of any two bindings with the same name in `p` and `q` do not unify + with respect to types or binding modes. + + Unification of types is in all instances aforementioned exact and + implicit [type coercions] do not apply. + +2. When type checking an expression `match e_s { a_1 => e_1, ... a_n => e_n }`, + for each match arm `a_i` which contains a pattern of form `p_i | q_i`, + the pattern `p_i | q_i` is considered ill formed if, + at the depth `d` where it exists the fragment of `e_s` at depth `d`, + the type of the expression fragment does not unify with `p_i | q_i`. + +3. With respect to exhaustiveness checking, a pattern `p | q` is + considered to cover `p` as well as `q`. For some constructor `c(x, ..)` + the distributive law applies such that `c(p | q, ..rest)` covers the same + set of value as `c(p, ..rest) | c(q, ..rest)` does. This can be applied + recursively until there are no more nested patterns of form `p | q` other + than those that exist at the top level. + + Note that by *"constructor"* we do not refer to tuple struct patterns, + but rather we refer to a pattern for any product type. + This includes enum variants, tuple structs, structs with named fields, + arrays, tuples, and slices. + +### Dynamic semantics + +1. The dynamic semantics of pattern matching a scrutinee expression `e_s` + against a pattern `c(p | q, ..rest)` at depth `d` where `c` is some constructor, + `p` and `q` are arbitrary patterns, and `rest` is optionally any remaining + potential factors in `c`, is defined as being the same as that of + `c(p, ..rest) | c(q, ..rest)`. + +### Precedence with other undelimited patterns + +As shown elsewhere in this chapter, there are several types of patterns that +are syntactically undelimited, including identifier patterns, reference +patterns, and or-patterns. Or-patterns always have the lowest-precedence. This +allows us to reserve syntactic space for a possible future type ascription +feature and also to reduce ambiguity. For example, `x @ A(..) | B(..)` will +result in an error that `x` is not bound in all patterns, `&A(x) | B(x)` will +result in a type mismatch between `x` in the different subpatterns. + +[_GroupedPattern_]: #grouped-patterns +[_IdentifierPattern_]: #identifier-patterns +[_LiteralPattern_]: #literal-patterns +[_MacroInvocation_]: macros.md#macro-invocation +[_ObsoleteRangePattern_]: #range-patterns +[_PathInExpression_]: paths.md#paths-in-expressions +[_PathExpression_]: expressions/path-expr.md +[_PathPattern_]: #path-patterns +[_Pattern_]: #patterns +[_PatternNoTopAlt_]: #patterns +[_PatternWithoutRange_]: #patterns +[_QualifiedPathInExpression_]: paths.md#qualified-paths +[_RangePattern_]: #range-patterns +[_ReferencePattern_]: #reference-patterns +[_RestPattern_]: #rest-patterns +[_SlicePattern_]: #slice-patterns +[_StructPattern_]: #struct-patterns +[_TuplePattern_]: #tuple-patterns +[_TupleStructPattern_]: #tuple-struct-patterns +[_WildcardPattern_]: #wildcard-pattern + +[`Copy`]: special-types-and-traits.md#copy +[IDENTIFIER]: identifiers.md +[enums]: items/enumerations.md +[literals]: expressions/literal-expr.md +[structs]: items/structs.md +[tuples]: types/tuple.md +[scrutinee]: glossary.md#scrutinee +[type coercions]: type-coercions.md diff --git a/src/doc/reference/src/procedural-macros.md b/src/doc/reference/src/procedural-macros.md new file mode 100644 index 000000000..31f029a63 --- /dev/null +++ b/src/doc/reference/src/procedural-macros.md @@ -0,0 +1,367 @@ +## Procedural Macros + +*Procedural macros* allow creating syntax extensions as execution of a function. +Procedural macros come in one of three flavors: + +* [Function-like macros] - `custom!(...)` +* [Derive macros] - `#[derive(CustomDerive)]` +* [Attribute macros] - `#[CustomAttribute]` + +Procedural macros allow you to run code at compile time that operates over Rust +syntax, both consuming and producing Rust syntax. You can sort of think of +procedural macros as functions from an AST to another AST. + +Procedural macros must be defined in a crate with the [crate type] of +`proc-macro`. + +> **Note**: When using Cargo, Procedural macro crates are defined with the +> `proc-macro` key in your manifest: +> +> ```toml +> [lib] +> proc-macro = true +> ``` + +As functions, they must either return syntax, panic, or loop endlessly. Returned +syntax either replaces or adds the syntax depending on the kind of procedural +macro. Panics are caught by the compiler and are turned into a compiler error. +Endless loops are not caught by the compiler which hangs the compiler. + +Procedural macros run during compilation, and thus have the same resources that +the compiler has. For example, standard input, error, and output are the same +that the compiler has access to. Similarly, file access is the same. Because +of this, procedural macros have the same security concerns that [Cargo's +build scripts] have. + +Procedural macros have two ways of reporting errors. The first is to panic. The +second is to emit a [`compile_error`] macro invocation. + +### The `proc_macro` crate + +Procedural macro crates almost always will link to the compiler-provided +[`proc_macro` crate]. The `proc_macro` crate provides types required for +writing procedural macros and facilities to make it easier. + +This crate primarily contains a [`TokenStream`] type. Procedural macros operate +over *token streams* instead of AST nodes, which is a far more stable interface +over time for both the compiler and for procedural macros to target. A +*token stream* is roughly equivalent to `Vec` where a `TokenTree` +can roughly be thought of as lexical token. For example `foo` is an `Ident` +token, `.` is a `Punct` token, and `1.2` is a `Literal` token. The `TokenStream` +type, unlike `Vec`, is cheap to clone. + +All tokens have an associated `Span`. A `Span` is an opaque value that cannot +be modified but can be manufactured. `Span`s represent an extent of source +code within a program and are primarily used for error reporting. While you +cannot modify a `Span` itself, you can always change the `Span` *associated* +with any token, such as through getting a `Span` from another token. + +### Procedural macro hygiene + +Procedural macros are *unhygienic*. This means they behave as if the output +token stream was simply written inline to the code it's next to. This means that +it's affected by external items and also affects external imports. + +Macro authors need to be careful to ensure their macros work in as many contexts +as possible given this limitation. This often includes using absolute paths to +items in libraries (for example, `::std::option::Option` instead of `Option`) or +by ensuring that generated functions have names that are unlikely to clash with +other functions (like `__internal_foo` instead of `foo`). + +### Function-like procedural macros + +*Function-like procedural macros* are procedural macros that are invoked using +the macro invocation operator (`!`). + +These macros are defined by a [public] [function] with the `proc_macro` +[attribute] and a signature of `(TokenStream) -> TokenStream`. The input +[`TokenStream`] is what is inside the delimiters of the macro invocation and the +output [`TokenStream`] replaces the entire macro invocation. + +For example, the following macro definition ignores its input and outputs a +function `answer` into its scope. + + +```rust,ignore +# #![crate_type = "proc-macro"] +extern crate proc_macro; +use proc_macro::TokenStream; + +#[proc_macro] +pub fn make_answer(_item: TokenStream) -> TokenStream { + "fn answer() -> u32 { 42 }".parse().unwrap() +} +``` + +And then we use it in a binary crate to print "42" to standard output. + + +```rust,ignore +extern crate proc_macro_examples; +use proc_macro_examples::make_answer; + +make_answer!(); + +fn main() { + println!("{}", answer()); +} +``` + +Function-like procedural macros may be invoked in any macro invocation +position, which includes [statements], [expressions], [patterns], [type +expressions], [item] positions, including items in [`extern` blocks], inherent +and trait [implementations], and [trait definitions]. + +### Derive macros + +*Derive macros* define new inputs for the [`derive` attribute]. These macros +can create new [items] given the token stream of a [struct], [enum], or [union]. +They can also define [derive macro helper attributes]. + +Custom derive macros are defined by a [public] [function] with the +`proc_macro_derive` attribute and a signature of `(TokenStream) -> TokenStream`. + +The input [`TokenStream`] is the token stream of the item that has the `derive` +attribute on it. The output [`TokenStream`] must be a set of items that are +then appended to the [module] or [block] that the item from the input +[`TokenStream`] is in. + +The following is an example of a derive macro. Instead of doing anything +useful with its input, it just appends a function `answer`. + + +```rust,ignore +# #![crate_type = "proc-macro"] +extern crate proc_macro; +use proc_macro::TokenStream; + +#[proc_macro_derive(AnswerFn)] +pub fn derive_answer_fn(_item: TokenStream) -> TokenStream { + "fn answer() -> u32 { 42 }".parse().unwrap() +} +``` + +And then using said derive macro: + + +```rust,ignore +extern crate proc_macro_examples; +use proc_macro_examples::AnswerFn; + +#[derive(AnswerFn)] +struct Struct; + +fn main() { + assert_eq!(42, answer()); +} +``` + +#### Derive macro helper attributes + +Derive macros can add additional [attributes] into the scope of the [item] +they are on. Said attributes are called *derive macro helper attributes*. These +attributes are [inert], and their only purpose is to be fed into the derive +macro that defined them. That said, they can be seen by all macros. + +The way to define helper attributes is to put an `attributes` key in the +`proc_macro_derive` macro with a comma separated list of identifiers that are +the names of the helper attributes. + +For example, the following derive macro defines a helper attribute +`helper`, but ultimately doesn't do anything with it. + + +```rust,ignore +# #![crate_type="proc-macro"] +# extern crate proc_macro; +# use proc_macro::TokenStream; + +#[proc_macro_derive(HelperAttr, attributes(helper))] +pub fn derive_helper_attr(_item: TokenStream) -> TokenStream { + TokenStream::new() +} +``` + +And then usage on the derive macro on a struct: + + +```rust,ignore +#[derive(HelperAttr)] +struct Struct { + #[helper] field: () +} +``` + +### Attribute macros + +*Attribute macros* define new [outer attributes][attributes] which can be +attached to [items], including items in [`extern` blocks], inherent and trait +[implementations], and [trait definitions]. + +Attribute macros are defined by a [public] [function] with the +`proc_macro_attribute` [attribute] that has a signature of `(TokenStream, +TokenStream) -> TokenStream`. The first [`TokenStream`] is the delimited token +tree following the attribute's name, not including the outer delimiters. If +the attribute is written as a bare attribute name, the attribute +[`TokenStream`] is empty. The second [`TokenStream`] is the rest of the [item] +including other [attributes] on the [item]. The returned [`TokenStream`] +replaces the [item] with an arbitrary number of [items]. + +For example, this attribute macro takes the input stream and returns it as is, +effectively being the no-op of attributes. + + +```rust,ignore +# #![crate_type = "proc-macro"] +# extern crate proc_macro; +# use proc_macro::TokenStream; + +#[proc_macro_attribute] +pub fn return_as_is(_attr: TokenStream, item: TokenStream) -> TokenStream { + item +} +``` + +This following example shows the stringified [`TokenStream`s] that the attribute +macros see. The output will show in the output of the compiler. The output is +shown in the comments after the function prefixed with "out:". + + +```rust,ignore +// my-macro/src/lib.rs +# extern crate proc_macro; +# use proc_macro::TokenStream; + +#[proc_macro_attribute] +pub fn show_streams(attr: TokenStream, item: TokenStream) -> TokenStream { + println!("attr: \"{}\"", attr.to_string()); + println!("item: \"{}\"", item.to_string()); + item +} +``` + + +```rust,ignore +// src/lib.rs +extern crate my_macro; + +use my_macro::show_streams; + +// Example: Basic function +#[show_streams] +fn invoke1() {} +// out: attr: "" +// out: item: "fn invoke1() { }" + +// Example: Attribute with input +#[show_streams(bar)] +fn invoke2() {} +// out: attr: "bar" +// out: item: "fn invoke2() {}" + +// Example: Multiple tokens in the input +#[show_streams(multiple => tokens)] +fn invoke3() {} +// out: attr: "multiple => tokens" +// out: item: "fn invoke3() {}" + +// Example: +#[show_streams { delimiters }] +fn invoke4() {} +// out: attr: "delimiters" +// out: item: "fn invoke4() {}" +``` + +### Declarative macro tokens and procedural macro tokens + +Declarative `macro_rules` macros and procedural macros use similar, but +different definitions for tokens (or rather [`TokenTree`s].) + +Token trees in `macro_rules` (corresponding to `tt` matchers) are defined as +- Delimited groups (`(...)`, `{...}`, etc) +- All operators supported by the language, both single-character and + multi-character ones (`+`, `+=`). + - Note that this set doesn't include the single quote `'`. +- Literals (`"string"`, `1`, etc) + - Note that negation (e.g. `-1`) is never a part of such literal tokens, + but a separate operator token. +- Identifiers, including keywords (`ident`, `r#ident`, `fn`) +- Lifetimes (`'ident`) +- Metavariable substitutions in `macro_rules` (e.g. `$my_expr` in + `macro_rules! mac { ($my_expr: expr) => { $my_expr } }` after the `mac`'s + expansion, which will be considered a single token tree regardless of the + passed expression) + +Token trees in procedural macros are defined as +- Delimited groups (`(...)`, `{...}`, etc) +- All punctuation characters used in operators supported by the language (`+`, + but not `+=`), and also the single quote `'` character (typically used in + lifetimes, see below for lifetime splitting and joining behavior) +- Literals (`"string"`, `1`, etc) + - Negation (e.g. `-1`) is supported as a part of integer + and floating point literals. +- Identifiers, including keywords (`ident`, `r#ident`, `fn`) + +Mismatches between these two definitions are accounted for when token streams +are passed to and from procedural macros. \ +Note that the conversions below may happen lazily, so they might not happen if +the tokens are not actually inspected. + +When passed to a proc-macro +- All multi-character operators are broken into single characters. +- Lifetimes are broken into a `'` character and an identifier. +- All metavariable substitutions are represented as their underlying token + streams. + - Such token streams may be wrapped into delimited groups ([`Group`]) with + implicit delimiters ([`Delimiter::None`]) when it's necessary for + preserving parsing priorities. + - `tt` and `ident` substitutions are never wrapped into such groups and + always represented as their underlying token trees. + +When emitted from a proc macro +- Punctuation characters are glued into multi-character operators + when applicable. +- Single quotes `'` joined with identifiers are glued into lifetimes. +- Negative literals are converted into two tokens (the `-` and the literal) + possibly wrapped into a delimited group ([`Group`]) with implicit delimiters + ([`Delimiter::None`]) when it's necessary for preserving parsing priorities. + +Note that neither declarative nor procedural macros support doc comment tokens +(e.g. `/// Doc`), so they are always converted to token streams representing +their equivalent `#[doc = r"str"]` attributes when passed to macros. + +[Attribute macros]: #attribute-macros +[Cargo's build scripts]: ../cargo/reference/build-scripts.html +[Derive macros]: #derive-macros +[Function-like macros]: #function-like-procedural-macros +[`Delimiter::None`]: ../proc_macro/enum.Delimiter.html#variant.None +[`Group`]: ../proc_macro/struct.Group.html +[`TokenStream`]: ../proc_macro/struct.TokenStream.html +[`TokenStream`s]: ../proc_macro/struct.TokenStream.html +[`TokenTree`s]: ../proc_macro/enum.TokenTree.html +[`compile_error`]: ../std/macro.compile_error.html +[`derive` attribute]: attributes/derive.md +[`extern` blocks]: items/external-blocks.md +[`macro_rules`]: macros-by-example.md +[`proc_macro` crate]: ../proc_macro/index.html +[attribute]: attributes.md +[attributes]: attributes.md +[block]: expressions/block-expr.md +[crate type]: linkage.md +[derive macro helper attributes]: #derive-macro-helper-attributes +[enum]: items/enumerations.md +[expressions]: expressions.md +[function]: items/functions.md +[implementations]: items/implementations.md +[inert]: attributes.md#active-and-inert-attributes +[item]: items.md +[items]: items.md +[module]: items/modules.md +[patterns]: patterns.md +[public]: visibility-and-privacy.md +[statements]: statements.md +[struct]: items/structs.md +[trait definitions]: items/traits.md +[type expressions]: types.md#type-expressions +[type]: types.md +[union]: items/unions.md diff --git a/src/doc/reference/src/runtime.md b/src/doc/reference/src/runtime.md new file mode 100644 index 000000000..a281d50fb --- /dev/null +++ b/src/doc/reference/src/runtime.md @@ -0,0 +1,85 @@ +# The Rust runtime + +This section documents features that define some aspects of the Rust runtime. + +## The `panic_handler` attribute + +The *`panic_handler` attribute* can only be applied to a function with signature +`fn(&PanicInfo) -> !`. The function marked with this [attribute] defines the behavior of panics. The +[`PanicInfo`] struct contains information about the location of the panic. There must be a single +`panic_handler` function in the dependency graph of a binary, dylib or cdylib crate. + +Below is shown a `panic_handler` function that logs the panic message and then halts the +thread. + + +```rust,ignore +#![no_std] + +use core::fmt::{self, Write}; +use core::panic::PanicInfo; + +struct Sink { + // .. +# _0: (), +} +# +# impl Sink { +# fn new() -> Sink { Sink { _0: () }} +# } +# +# impl fmt::Write for Sink { +# fn write_str(&mut self, _: &str) -> fmt::Result { Ok(()) } +# } + +#[panic_handler] +fn panic(info: &PanicInfo) -> ! { + let mut sink = Sink::new(); + + // logs "panicked at '$reason', src/main.rs:27:4" to some `sink` + let _ = writeln!(sink, "{}", info); + + loop {} +} +``` + +### Standard behavior + +The standard library provides an implementation of `panic_handler` that +defaults to unwinding the stack but that can be [changed to abort the +process][abort]. The standard library's panic behavior can be modified at +runtime with the [set_hook] function. + +## The `global_allocator` attribute + +The *`global_allocator` attribute* is used on a [static item] implementing the +[`GlobalAlloc`] trait to set the global allocator. + +## The `windows_subsystem` attribute + +The *`windows_subsystem` attribute* may be applied at the crate level to set +the [subsystem] when linking on a Windows target. It uses the +[_MetaNameValueStr_] syntax to specify the subsystem with a value of either +`console` or `windows`. This attribute is ignored on non-Windows targets, and +for non-`bin` [crate types]. + +The "console" subsystem is the default. If a console process is run from an +existing console then it will be attached to that console, otherwise a new +console window will be created. + +The "windows" subsystem is commonly used by GUI applications that do not want to +display a console window on startup. It will run detached from any existing console. + +```rust +#![windows_subsystem = "windows"] +``` + +[_MetaNameValueStr_]: attributes.md#meta-item-attribute-syntax +[`GlobalAlloc`]: ../alloc/alloc/trait.GlobalAlloc.html +[`PanicInfo`]: ../core/panic/struct.PanicInfo.html +[abort]: ../book/ch09-01-unrecoverable-errors-with-panic.html +[attribute]: attributes.md +[crate types]: linkage.md +[set_hook]: ../std/panic/fn.set_hook.html +[static item]: items/static-items.md +[subsystem]: https://msdn.microsoft.com/en-us/library/fcc1zstk.aspx diff --git a/src/doc/reference/src/special-types-and-traits.md b/src/doc/reference/src/special-types-and-traits.md new file mode 100644 index 000000000..ca53b3c9a --- /dev/null +++ b/src/doc/reference/src/special-types-and-traits.md @@ -0,0 +1,188 @@ +# Special types and traits + +Certain types and traits that exist in [the standard library] are known to the +Rust compiler. This chapter documents the special features of these types and +traits. + +## `Box` + +[`Box`] has a few special features that Rust doesn't currently allow for user +defined types. + +* The [dereference operator] for `Box` produces a place which can be moved + from. This means that the `*` operator and the destructor of `Box` are + built-in to the language. +* [Methods] can take `Box` as a receiver. +* A trait may be implemented for `Box` in the same crate as `T`, which the + [orphan rules] prevent for other generic types. + +## `Rc` + +[Methods] can take [`Rc`] as a receiver. + +## `Arc` + +[Methods] can take [`Arc`] as a receiver. + +## `Pin

` + +[Methods] can take [`Pin

`] as a receiver. + +## `UnsafeCell` + +[`std::cell::UnsafeCell`] is used for [interior mutability]. It ensures that +the compiler doesn't perform optimisations that are incorrect for such types. +It also ensures that [`static` items] which have a type with interior +mutability aren't placed in memory marked as read only. + +## `PhantomData` + +[`std::marker::PhantomData`] is a zero-sized, minimum alignment, type that +is considered to own a `T` for the purposes of [variance], [drop check], and +[auto traits](#auto-traits). + +## Operator Traits + +The traits in [`std::ops`] and [`std::cmp`] are used to overload [operators], +[indexing expressions], and [call expressions]. + +## `Deref` and `DerefMut` + +As well as overloading the unary `*` operator, [`Deref`] and [`DerefMut`] are +also used in [method resolution] and [deref coercions]. + +## `Drop` + +The [`Drop`] trait provides a [destructor], to be run whenever a value of this +type is to be destroyed. + +## `Copy` + +The [`Copy`] trait changes the semantics of a type implementing it. Values +whose type implements `Copy` are copied rather than moved upon assignment. + +`Copy` can only be implemented for types which do not implement `Drop`, and whose fields are all `Copy`. +For enums, this means all fields of all variants have to be `Copy`. +For unions, this means all variants have to be `Copy`. + +`Copy` is implemented by the compiler for + +* [Tuples] of `Copy` types +* [Function pointers] +* [Function items] +* [Closures] that capture no values or that only capture values of `Copy` types + +## `Clone` + +The [`Clone`] trait is a supertrait of `Copy`, so it also needs compiler +generated implementations. It is implemented by the compiler for the following +types: + +* Types with a built-in `Copy` implementation (see above) +* [Tuples] of `Clone` types + +## `Send` + +The [`Send`] trait indicates that a value of this type is safe to send from one +thread to another. + +## `Sync` + +The [`Sync`] trait indicates that a value of this type is safe to share between +multiple threads. This trait must be implemented for all types used in +immutable [`static` items]. + +## `Termination` + +The [`Termination`] trait indicates the acceptable return types for the [main function] and [test functions]. + +## Auto traits + +The [`Send`], [`Sync`], [`Unpin`], [`UnwindSafe`], and [`RefUnwindSafe`] traits are _auto +traits_. Auto traits have special properties. + +If no explicit implementation or negative implementation is written out for an +auto trait for a given type, then the compiler implements it automatically +according to the following rules: + +* `&T`, `&mut T`, `*const T`, `*mut T`, `[T; n]`, and `[T]` implement the trait + if `T` does. +* Function item types and function pointers automatically implement the trait. +* Structs, enums, unions, and tuples implement the trait if all of their fields + do. +* Closures implement the trait if the types of all of their captures do. A + closure that captures a `T` by shared reference and a `U` by value implements + any auto traits that both `&T` and `U` do. + +For generic types (counting the built-in types above as generic over `T`), if a +generic implementation is available, then the compiler does not automatically +implement it for types that could use the implementation except that they do not +meet the requisite trait bounds. For instance, the standard library implements +`Send` for all `&T` where `T` is `Sync`; this means that the compiler will not +implement `Send` for `&T` if `T` is `Send` but not `Sync`. + +Auto traits can also have negative implementations, shown as `impl !AutoTrait +for T` in the standard library documentation, that override the automatic +implementations. For example `*mut T` has a negative implementation of `Send`, +and so `*mut T` is not `Send`, even if `T` is. There is currently no stable way +to specify additional negative implementations; they exist only in the standard +library. + +Auto traits may be added as an additional bound to any [trait object], even +though normally only one trait is allowed. For instance, `Box` is a valid type. + +## `Sized` + +The [`Sized`] trait indicates that the size of this type is known at compile-time; that is, it's not a [dynamically sized type]. +[Type parameters] are `Sized` by default, as are [associated types]. +`Sized` is always implemented automatically by the compiler, not by [implementation items]. +These implicit `Sized` bounds may be relaxed by using the special `?Sized` bound. + +[`Arc`]: ../std/sync/struct.Arc.html +[`Box`]: ../std/boxed/struct.Box.html +[`Clone`]: ../std/clone/trait.Clone.html +[`Copy`]: ../std/marker/trait.Copy.html +[`Deref`]: ../std/ops/trait.Deref.html +[`DerefMut`]: ../std/ops/trait.DerefMut.html +[`Drop`]: ../std/ops/trait.Drop.html +[`Pin

+ +Warning: This pseudocode uses a naive algorithm that ignores overflow issues for +the sake of clarity. To perform memory layout computations in actual code, use +[`Layout`]. + +
+ +> Note: This algorithm can produce zero-sized structs. In C, an empty struct +> declaration like `struct Foo { }` is illegal. However, both gcc and clang +> support options to enable such structs, and assign them size zero. C++, in +> contrast, gives empty structs a size of 1, unless they are inherited from or +> they are fields that have the `[[no_unique_address]]` attribute, in which +> case they do not increase the overall size of the struct. + +#### `#[repr(C)]` Unions + +A union declared with `#[repr(C)]` will have the same size and alignment as an +equivalent C union declaration in the C language for the target platform. +The union will have a size of the maximum size of all of its fields rounded to +its alignment, and an alignment of the maximum alignment of all of its fields. +These maximums may come from different fields. + +```rust +#[repr(C)] +union Union { + f1: u16, + f2: [u8; 4], +} + +assert_eq!(std::mem::size_of::(), 4); // From f2 +assert_eq!(std::mem::align_of::(), 2); // From f1 + +#[repr(C)] +union SizeRoundedUp { + a: u32, + b: [u16; 3], +} + +assert_eq!(std::mem::size_of::(), 8); // Size of 6 from b, + // rounded up to 8 from + // alignment of a. +assert_eq!(std::mem::align_of::(), 4); // From a +``` + +#### `#[repr(C)]` Field-less Enums + +For [field-less enums], the `C` representation has the size and alignment of +the default `enum` size and alignment for the target platform's C ABI. + +> Note: The enum representation in C is implementation defined, so this is +> really a "best guess". In particular, this may be incorrect when the C code +> of interest is compiled with certain flags. + +
+ +Warning: There are crucial differences between an `enum` in the C language and +Rust's [field-less enums] with this representation. An `enum` in C is +mostly a `typedef` plus some named constants; in other words, an object of an +`enum` type can hold any integer value. For example, this is often used for +bitflags in `C`. In contrast, Rust’s [field-less enums] can only legally hold +the discriminant values, everything else is [undefined behavior]. Therefore, +using a field-less enum in FFI to model a C `enum` is often wrong. + +
+ +#### `#[repr(C)]` Enums With Fields + +The representation of a `repr(C)` enum with fields is a `repr(C)` struct with +two fields, also called a "tagged union" in C: + +- a `repr(C)` version of the enum with all fields removed ("the tag") +- a `repr(C)` union of `repr(C)` structs for the fields of each variant that had + them ("the payload") + +> Note: Due to the representation of `repr(C)` structs and unions, if a variant +> has a single field there is no difference between putting that field directly +> in the union or wrapping it in a struct; any system which wishes to manipulate +> such an `enum`'s representation may therefore use whichever form is more +> convenient or consistent for them. + +```rust +// This Enum has the same representation as ... +#[repr(C)] +enum MyEnum { + A(u32), + B(f32, u64), + C { x: u32, y: u8 }, + D, + } + +// ... this struct. +#[repr(C)] +struct MyEnumRepr { + tag: MyEnumDiscriminant, + payload: MyEnumFields, +} + +// This is the discriminant enum. +#[repr(C)] +enum MyEnumDiscriminant { A, B, C, D } + +// This is the variant union. +#[repr(C)] +union MyEnumFields { + A: MyAFields, + B: MyBFields, + C: MyCFields, + D: MyDFields, +} + +#[repr(C)] +#[derive(Copy, Clone)] +struct MyAFields(u32); + +#[repr(C)] +#[derive(Copy, Clone)] +struct MyBFields(f32, u64); + +#[repr(C)] +#[derive(Copy, Clone)] +struct MyCFields { x: u32, y: u8 } + +// This struct could be omitted (it is a zero-sized type), and it must be in +// C/C++ headers. +#[repr(C)] +#[derive(Copy, Clone)] +struct MyDFields; +``` + +> Note: `union`s with non-`Copy` fields are unstable, see [55149]. + +### Primitive representations + +The *primitive representations* are the representations with the same names as +the primitive integer types. That is: `u8`, `u16`, `u32`, `u64`, `u128`, +`usize`, `i8`, `i16`, `i32`, `i64`, `i128`, and `isize`. + +Primitive representations can only be applied to enumerations and have +different behavior whether the enum has fields or no fields. It is an error +for [zero-variant enums] to have a primitive representation. Combining +two primitive representations together is an error. + +#### Primitive Representation of Field-less Enums + +For [field-less enums], primitive representations set the size and alignment to +be the same as the primitive type of the same name. For example, a field-less +enum with a `u8` representation can only have discriminants between 0 and 255 +inclusive. + +#### Primitive Representation of Enums With Fields + +The representation of a primitive representation enum is a `repr(C)` union of +`repr(C)` structs for each variant with a field. The first field of each struct +in the union is the primitive representation version of the enum with all fields +removed ("the tag") and the remaining fields are the fields of that variant. + +> Note: This representation is unchanged if the tag is given its own member in +> the union, should that make manipulation more clear for you (although to +> follow the C++ standard the tag member should be wrapped in a `struct`). + +```rust +// This enum has the same representation as ... +#[repr(u8)] +enum MyEnum { + A(u32), + B(f32, u64), + C { x: u32, y: u8 }, + D, + } + +// ... this union. +#[repr(C)] +union MyEnumRepr { + A: MyVariantA, + B: MyVariantB, + C: MyVariantC, + D: MyVariantD, +} + +// This is the discriminant enum. +#[repr(u8)] +#[derive(Copy, Clone)] +enum MyEnumDiscriminant { A, B, C, D } + +#[repr(C)] +#[derive(Clone, Copy)] +struct MyVariantA(MyEnumDiscriminant, u32); + +#[repr(C)] +#[derive(Clone, Copy)] +struct MyVariantB(MyEnumDiscriminant, f32, u64); + +#[repr(C)] +#[derive(Clone, Copy)] +struct MyVariantC { tag: MyEnumDiscriminant, x: u32, y: u8 } + +#[repr(C)] +#[derive(Clone, Copy)] +struct MyVariantD(MyEnumDiscriminant); +``` + +> Note: `union`s with non-`Copy` fields are unstable, see [55149]. + +#### Combining primitive representations of enums with fields and `#[repr(C)]` + +For enums with fields, it is also possible to combine `repr(C)` and a +primitive representation (e.g., `repr(C, u8)`). This modifies the [`repr(C)`] by +changing the representation of the discriminant enum to the chosen primitive +instead. So, if you chose the `u8` representation, then the discriminant enum +would have a size and alignment of 1 byte. + +The discriminant enum from the example [earlier][`repr(C)`] then becomes: + +```rust +#[repr(C, u8)] // `u8` was added +enum MyEnum { + A(u32), + B(f32, u64), + C { x: u32, y: u8 }, + D, + } + +// ... + +#[repr(u8)] // So `u8` is used here instead of `C` +enum MyEnumDiscriminant { A, B, C, D } + +// ... +``` + +For example, with a `repr(C, u8)` enum it is not possible to have 257 unique +discriminants ("tags") whereas the same enum with only a `repr(C)` attribute +will compile without any problems. + +Using a primitive representation in addition to `repr(C)` can change the size of +an enum from the `repr(C)` form: + +```rust +#[repr(C)] +enum EnumC { + Variant0(u8), + Variant1, +} + +#[repr(C, u8)] +enum Enum8 { + Variant0(u8), + Variant1, +} + +#[repr(C, u16)] +enum Enum16 { + Variant0(u8), + Variant1, +} + +// The size of the C representation is platform dependant +assert_eq!(std::mem::size_of::(), 8); +// One byte for the discriminant and one byte for the value in Enum8::Variant0 +assert_eq!(std::mem::size_of::(), 2); +// Two bytes for the discriminant and one byte for the value in Enum16::Variant0 +// plus one byte of padding. +assert_eq!(std::mem::size_of::(), 4); +``` + +[`repr(C)`]: #reprc-enums-with-fields + +### The alignment modifiers + +The `align` and `packed` modifiers can be used to respectively raise or lower +the alignment of `struct`s and `union`s. `packed` may also alter the padding +between fields (although it will not alter the padding inside of any field). + +The alignment is specified as an integer parameter in the form of +`#[repr(align(x))]` or `#[repr(packed(x))]`. The alignment value must be a +power of two from 1 up to 229. For `packed`, if no value is given, +as in `#[repr(packed)]`, then the value is 1. + +For `align`, if the specified alignment is less than the alignment of the type +without the `align` modifier, then the alignment is unaffected. + +For `packed`, if the specified alignment is greater than the type's alignment +without the `packed` modifier, then the alignment and layout is unaffected. +The alignments of each field, for the purpose of positioning fields, is the +smaller of the specified alignment and the alignment of the field's type. +Inter-field padding is guaranteed to be the minimum required in order to +satisfy each field's (possibly altered) alignment (although note that, on its +own, `packed` does not provide any guarantee about field ordering). An +important consequence of these rules is that a type with `#[repr(packed(1))]` +(or `#[repr(packed)]`) will have no inter-field padding. + +The `align` and `packed` modifiers cannot be applied on the same type and a +`packed` type cannot transitively contain another `align`ed type. `align` and +`packed` may only be applied to the [default] and [`C`] representations. + +The `align` modifier can also be applied on an `enum`. +When it is, the effect on the `enum`'s alignment is the same as if the `enum` +was wrapped in a newtype `struct` with the same `align` modifier. + +
+ +***Warning:*** Dereferencing an unaligned pointer is [undefined behavior] and +it is possible to [safely create unaligned pointers to `packed` fields][27060]. +Like all ways to create undefined behavior in safe Rust, this is a bug. + +
+ +### The `transparent` Representation + +The `transparent` representation can only be used on a [`struct`][structs] +or an [`enum`][enumerations] with a single variant that has: + +- a single field with non-zero size, and +- any number of fields with size 0 and alignment 1 (e.g. [`PhantomData`]). + +Structs and enums with this representation have the same layout and ABI +as the single non-zero sized field. + +This is different than the `C` representation because +a struct with the `C` representation will always have the ABI of a `C` `struct` +while, for example, a struct with the `transparent` representation with a +primitive field will have the ABI of the primitive field. + +Because this representation delegates type layout to another type, it cannot be +used with any other representation. + +[`align_of_val`]: ../std/mem/fn.align_of_val.html +[`size_of_val`]: ../std/mem/fn.size_of_val.html +[`align_of`]: ../std/mem/fn.align_of.html +[`size_of`]: ../std/mem/fn.size_of.html +[`Sized`]: ../std/marker/trait.Sized.html +[`Copy`]: ../std/marker/trait.Copy.html +[dynamically sized types]: dynamically-sized-types.md +[field-less enums]: items/enumerations.md#custom-discriminant-values-for-fieldless-enumerations +[enumerations]: items/enumerations.md +[zero-variant enums]: items/enumerations.md#zero-variant-enums +[undefined behavior]: behavior-considered-undefined.md +[27060]: https://github.com/rust-lang/rust/issues/27060 +[55149]: https://github.com/rust-lang/rust/issues/55149 +[`PhantomData`]: special-types-and-traits.md#phantomdatat +[Default]: #the-default-representation +[`C`]: #the-c-representation +[primitive representations]: #primitive-representations +[structs]: items/structs.md +[`transparent`]: #the-transparent-representation +[`Layout`]: ../std/alloc/struct.Layout.html diff --git a/src/doc/reference/src/type-system.md b/src/doc/reference/src/type-system.md new file mode 100644 index 000000000..bed7f128e --- /dev/null +++ b/src/doc/reference/src/type-system.md @@ -0,0 +1 @@ +# Type system diff --git a/src/doc/reference/src/types-redirect.html b/src/doc/reference/src/types-redirect.html new file mode 100644 index 000000000..26d5410a7 --- /dev/null +++ b/src/doc/reference/src/types-redirect.html @@ -0,0 +1,43 @@ + diff --git a/src/doc/reference/src/types.md b/src/doc/reference/src/types.md new file mode 100644 index 000000000..aed10fd0f --- /dev/null +++ b/src/doc/reference/src/types.md @@ -0,0 +1,175 @@ +{{#include types-redirect.html}} +# Types + +Every variable, item, and value in a Rust program has a type. The _type_ of a +*value* defines the interpretation of the memory holding it and the operations +that may be performed on the value. + +Built-in types are tightly integrated into the language, in nontrivial ways +that are not possible to emulate in user-defined types. User-defined types have +limited capabilities. + +The list of types is: + +* Primitive types: + * [Boolean] — `bool` + * [Numeric] — integer and float + * [Textual] — `char` and `str` + * [Never] — `!` — a type with no values +* Sequence types: + * [Tuple] + * [Array] + * [Slice] +* User-defined types: + * [Struct] + * [Enum] + * [Union] +* Function types: + * [Functions] + * [Closures] +* Pointer types: + * [References] + * [Raw pointers] + * [Function pointers] +* Trait types: + * [Trait objects] + * [Impl trait] + +## Type expressions + +> **Syntax**\ +> _Type_ :\ +>       _TypeNoBounds_\ +>    | [_ImplTraitType_]\ +>    | [_TraitObjectType_] +> +> _TypeNoBounds_ :\ +>       [_ParenthesizedType_]\ +>    | [_ImplTraitTypeOneBound_]\ +>    | [_TraitObjectTypeOneBound_]\ +>    | [_TypePath_]\ +>    | [_TupleType_]\ +>    | [_NeverType_]\ +>    | [_RawPointerType_]\ +>    | [_ReferenceType_]\ +>    | [_ArrayType_]\ +>    | [_SliceType_]\ +>    | [_InferredType_]\ +>    | [_QualifiedPathInType_]\ +>    | [_BareFunctionType_]\ +>    | [_MacroInvocation_] + +A _type expression_ as defined in the _Type_ grammar rule above is the syntax +for referring to a type. It may refer to: + +* Sequence types ([tuple], [array], [slice]). +* [Type paths] which can reference: + * Primitive types ([boolean], [numeric], [textual]). + * Paths to an [item] ([struct], [enum], [union], [type alias], [trait]). + * [`Self` path] where `Self` is the implementing type. + * Generic [type parameters]. +* Pointer types ([reference], [raw pointer], [function pointer]). +* The [inferred type] which asks the compiler to determine the type. +* [Parentheses] which are used for disambiguation. +* Trait types: [Trait objects] and [impl trait]. +* The [never] type. +* [Macros] which expand to a type expression. + +### Parenthesized types + +> _ParenthesizedType_ :\ +>    `(` [_Type_] `)` + +In some situations the combination of types may be ambiguous. Use parentheses +around a type to avoid ambiguity. For example, the `+` operator for [type +boundaries] within a [reference type] is unclear where the +boundary applies, so the use of parentheses is required. Grammar rules that +require this disambiguation use the [_TypeNoBounds_] rule instead of +[_Type_]. + +```rust +# use std::any::Any; +type T<'a> = &'a (dyn Any + Send); +``` + +## Recursive types + +Nominal types — [structs], [enumerations], and [unions] — may be +recursive. That is, each `enum` variant or `struct` or `union` field may +refer, directly or indirectly, to the enclosing `enum` or `struct` type +itself. Such recursion has restrictions: + +* Recursive types must include a nominal type in the recursion (not mere [type + aliases], or other structural types such as [arrays] or [tuples]). So `type + Rec = &'static [Rec]` is not allowed. +* The size of a recursive type must be finite; in other words the recursive + fields of the type must be [pointer types]. + +An example of a *recursive* type and its use: + +```rust +enum List { + Nil, + Cons(T, Box>) +} + +let a: List = List::Cons(7, Box::new(List::Cons(13, Box::new(List::Nil)))); +``` + +[_ArrayType_]: types/array.md +[_BareFunctionType_]: types/function-pointer.md +[_ImplTraitTypeOneBound_]: types/impl-trait.md +[_ImplTraitType_]: types/impl-trait.md +[_InferredType_]: types/inferred.md +[_MacroInvocation_]: macros.md#macro-invocation +[_NeverType_]: types/never.md +[_ParenthesizedType_]: types.md#parenthesized-types +[_QualifiedPathInType_]: paths.md#qualified-paths +[_RawPointerType_]: types/pointer.md#raw-pointers-const-and-mut +[_ReferenceType_]: types/pointer.md#shared-references- +[_SliceType_]: types/slice.md +[_TraitObjectTypeOneBound_]: types/trait-object.md +[_TraitObjectType_]: types/trait-object.md +[_TupleType_]: types/tuple.md#tuple-types +[_TypeNoBounds_]: types.md#type-expressions +[_TypePath_]: paths.md#paths-in-types +[_Type_]: types.md#type-expressions + +[Array]: types/array.md +[Boolean]: types/boolean.md +[Closures]: types/closure.md +[Enum]: types/enum.md +[Function pointers]: types/function-pointer.md +[Functions]: types/function-item.md +[Impl trait]: types/impl-trait.md +[Macros]: macros.md +[Numeric]: types/numeric.md +[Parentheses]: #parenthesized-types +[Raw pointers]: types/pointer.md#raw-pointers-const-and-mut +[References]: types/pointer.md#shared-references- +[Slice]: types/slice.md +[Struct]: types/struct.md +[Textual]: types/textual.md +[Trait objects]: types/trait-object.md +[Tuple]: types/tuple.md +[Type paths]: paths.md#paths-in-types +[Union]: types/union.md +[`Self` path]: paths.md#self-1 +[arrays]: types/array.md +[enumerations]: types/enum.md +[function pointer]: types/function-pointer.md +[inferred type]: types/inferred.md +[item]: items.md +[never]: types/never.md +[pointer types]: types/pointer.md +[raw pointer]: types/pointer.md#raw-pointers-const-and-mut +[reference type]: types/pointer.md#shared-references- +[reference]: types/pointer.md#shared-references- +[structs]: types/struct.md +[trait]: types/trait-object.md +[tuples]: types/tuple.md +[type alias]: items/type-aliases.md +[type aliases]: items/type-aliases.md +[type boundaries]: trait-bounds.md +[type parameters]: types/parameters.md +[unions]: types/union.md diff --git a/src/doc/reference/src/types/array.md b/src/doc/reference/src/types/array.md new file mode 100644 index 000000000..88ea8634c --- /dev/null +++ b/src/doc/reference/src/types/array.md @@ -0,0 +1,31 @@ +# Array types + +> **Syntax**\ +> _ArrayType_ :\ +>    `[` [_Type_] `;` [_Expression_] `]` + +An array is a fixed-size sequence of `N` elements of type `T`. The array type +is written as `[T; N]`. The size is a [constant expression] that evaluates to a +[`usize`]. + +Examples: + +```rust +// A stack-allocated array +let array: [i32; 3] = [1, 2, 3]; + +// A heap-allocated array, coerced to a slice +let boxed_array: Box<[i32]> = Box::new([1, 2, 3]); +``` + +All elements of arrays are always initialized, and access to an array is +always bounds-checked in safe methods and operators. + +> Note: The [`Vec`] standard library type provides a heap-allocated resizable +> array type. + +[_Expression_]: ../expressions.md +[_Type_]: ../types.md#type-expressions +[`Vec`]: ../../std/vec/struct.Vec.html +[`usize`]: numeric.md#machine-dependent-integer-types +[constant expression]: ../const_eval.md#constant-expressions diff --git a/src/doc/reference/src/types/boolean.md b/src/doc/reference/src/types/boolean.md new file mode 100644 index 000000000..d8984025f --- /dev/null +++ b/src/doc/reference/src/types/boolean.md @@ -0,0 +1,118 @@ +# Boolean type + +```rust +let b: bool = true; +``` + +The *boolean type* or *bool* is a primitive data type that can take on one of +two values, called *true* and *false*. + +Values of this type may be created using a [literal expression] using the +keywords `true` and `false` corresponding to the value of the same name. + +This type is a part of the [language prelude] with the [name] `bool`. + +An object with the boolean type has a [size and alignment] of 1 each. The +value false has the bit pattern `0x00` and the value true has the bit pattern +`0x01`. It is [undefined behavior] for an object with the boolean type to have +any other bit pattern. + +The boolean type is the type of many operands in various [expressions]: + +* The condition operand in [if expressions] and [while expressions] +* The operands in [lazy boolean operator expressions][lazy] + +> **Note**: The boolean type acts similarly to but is not an [enumerated type]. +In practice, this mostly means that constructors are not associated to the type +(e.g. `bool::true`). + +Like all primitives, the boolean type [implements][p-impl] the +[traits][p-traits] [`Clone`][p-clone], [`Copy`][p-copy], [`Sized`][p-sized], +[`Send`][p-send], and [`Sync`][p-sync]. + +> **Note**: See the [standard library docs][std] for library operations. + +## Operations on boolean values + + When using certain operator expressions with a +boolean type for its operands, they evaluate using the rules of [boolean logic]. + +### Logical not + +| `b` | [`!b`][op-not] | +|- | - | +| `true` | `false` | +| `false` | `true` | + +### Logical or + +| `a` | `b` | [a | b][op-or] | +|- | - | - | +| `true` | `true` | `true` | +| `true` | `false` | `true` | +| `false` | `true` | `true` | +| `false` | `false` | `false` | + +### Logical and + +| `a` | `b` | [`a & b`][op-and] | +|- | - | - | +| `true` | `true` | `true` | +| `true` | `false` | `false` | +| `false` | `true` | `false` | +| `false` | `false` | `false` | + +### Logical xor + +| `a` | `b` | [`a ^ b`][op-xor] | +|- | - | - | +| `true` | `true` | `false` | +| `true` | `false` | `true` | +| `false` | `true` | `true` | +| `false` | `false` | `false` | + +### Comparisons + +| `a` | `b` | [`a == b`][op-compare] | +|- | - | - | +| `true` | `true` | `true` | +| `true` | `false` | `false` | +| `false` | `true` | `false` | +| `false` | `false` | `true` | + +| `a` | `b` | [`a > b`][op-compare] | +|- | - | - | +| `true` | `true` | `false` | +| `true` | `false` | `true` | +| `false` | `true` | `false` | +| `false` | `false` | `false` | + +* `a != b` is the same as `!(a == b)` +* `a >= b` is the same as `a == b | a > b` +* `a < b` is the same as `!(a >= b)` +* `a <= b` is the same as `a == b | a < b` + +[boolean logic]: https://en.wikipedia.org/wiki/Boolean_algebra +[enumerated type]: enum.md +[expressions]: ../expressions.md +[if expressions]: ../expressions/if-expr.md#if-expressions +[language prelude]: ../names/preludes.md#language-prelude +[lazy]: ../expressions/operator-expr.md#lazy-boolean-operators +[literal expression]: ../expressions/literal-expr.md +[name]: ../names.md +[op-and]: ../expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[op-compare]: ../expressions/operator-expr.md#comparison-operators +[op-not]: ../expressions/operator-expr.md#negation-operators +[op-or]: ../expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[op-xor]: ../expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[p-clone]: ../special-types-and-traits.md#clone +[p-copy]: ../special-types-and-traits.md#copy +[p-impl]: ../items/implementations.md +[p-send]: ../special-types-and-traits.md#send +[p-sized]: ../special-types-and-traits.md#sized +[p-sync]: ../special-types-and-traits.md#sync +[p-traits]: ../items/traits.md +[size and alignment]: ../type-layout.md#size-and-alignment +[std]: ../../std/primitive.bool.html +[undefined behavior]: ../behavior-considered-undefined.md +[while expressions]: ../expressions/loop-expr.md#predicate-loops diff --git a/src/doc/reference/src/types/closure.md b/src/doc/reference/src/types/closure.md new file mode 100644 index 000000000..eecdb038f --- /dev/null +++ b/src/doc/reference/src/types/closure.md @@ -0,0 +1,180 @@ +# Closure types + +A [closure expression] produces a closure value with a unique, anonymous type +that cannot be written out. A closure type is approximately equivalent to a +struct which contains the captured variables. For instance, the following +closure: + +```rust +fn f String> (g: F) { + println!("{}", g()); +} + +let mut s = String::from("foo"); +let t = String::from("bar"); + +f(|| { + s += &t; + s +}); +// Prints "foobar". +``` + +generates a closure type roughly like the following: + + +```rust,ignore +struct Closure<'a> { + s : String, + t : &'a String, +} + +impl<'a> FnOnce<()> for Closure<'a> { + type Output = String; + fn call_once(self) -> String { + self.s += &*self.t; + self.s + } +} +``` + +so that the call to `f` works as if it were: + + +```rust,ignore +f(Closure{s: s, t: &t}); +``` + +## Capture modes + +The compiler prefers to capture a closed-over variable by immutable borrow, +followed by unique immutable borrow (see below), by mutable borrow, and finally +by move. It will pick the first choice of these that is compatible with how the +captured variable is used inside the closure body. The compiler does not take +surrounding code into account, such as the lifetimes of involved variables, or +of the closure itself. + +If the `move` keyword is used, then all captures are by move or, for `Copy` +types, by copy, regardless of whether a borrow would work. The `move` keyword is +usually used to allow the closure to outlive the captured values, such as if the +closure is being returned or used to spawn a new thread. + +Composite types such as structs, tuples, and enums are always captured entirely, +not by individual fields. It may be necessary to borrow into a local variable in +order to capture a single field: + +```rust +# use std::collections::HashSet; +# +struct SetVec { + set: HashSet, + vec: Vec +} + +impl SetVec { + fn populate(&mut self) { + let vec = &mut self.vec; + self.set.iter().for_each(|&n| { + vec.push(n); + }) + } +} +``` + +If, instead, the closure were to use `self.vec` directly, then it would attempt +to capture `self` by mutable reference. But since `self.set` is already +borrowed to iterate over, the code would not compile. + +## Unique immutable borrows in captures + +Captures can occur by a special kind of borrow called a _unique immutable +borrow_, which cannot be used anywhere else in the language and cannot be +written out explicitly. It occurs when modifying the referent of a mutable +reference, as in the following example: + +```rust +let mut b = false; +let x = &mut b; +{ + let mut c = || { *x = true; }; + // The following line is an error: + // let y = &x; + c(); +} +let z = &x; +``` + +In this case, borrowing `x` mutably is not possible, because `x` is not `mut`. +But at the same time, borrowing `x` immutably would make the assignment illegal, +because a `& &mut` reference might not be unique, so it cannot safely be used to +modify a value. So a unique immutable borrow is used: it borrows `x` immutably, +but like a mutable borrow, it must be unique. In the above example, uncommenting +the declaration of `y` will produce an error because it would violate the +uniqueness of the closure's borrow of `x`; the declaration of z is valid because +the closure's lifetime has expired at the end of the block, releasing the borrow. + +## Call traits and coercions + +Closure types all implement [`FnOnce`], indicating that they can be called once +by consuming ownership of the closure. Additionally, some closures implement +more specific call traits: + +* A closure which does not move out of any captured variables implements + [`FnMut`], indicating that it can be called by mutable reference. + +* A closure which does not mutate or move out of any captured variables + implements [`Fn`], indicating that it can be called by shared reference. + +> Note: `move` closures may still implement [`Fn`] or [`FnMut`], even though +> they capture variables by move. This is because the traits implemented by a +> closure type are determined by what the closure does with captured values, +> not how it captures them. + +*Non-capturing closures* are closures that don't capture anything from their +environment. They can be coerced to function pointers (e.g., `fn()`) +with the matching signature. + +```rust +let add = |x, y| x + y; + +let mut x = add(5,7); + +type Binop = fn(i32, i32) -> i32; +let bo: Binop = add; +x = bo(5,7); +``` + +## Other traits + +All closure types implement [`Sized`]. Additionally, closure types implement the +following traits if allowed to do so by the types of the captures it stores: + +* [`Clone`] +* [`Copy`] +* [`Sync`] +* [`Send`] + +The rules for [`Send`] and [`Sync`] match those for normal struct types, while +[`Clone`] and [`Copy`] behave as if [derived]. For [`Clone`], the order of +cloning of the captured variables is left unspecified. + +Because captures are often by reference, the following general rules arise: + +* A closure is [`Sync`] if all captured variables are [`Sync`]. +* A closure is [`Send`] if all variables captured by non-unique immutable + reference are [`Sync`], and all values captured by unique immutable or mutable + reference, copy, or move are [`Send`]. +* A closure is [`Clone`] or [`Copy`] if it does not capture any values by + unique immutable or mutable reference, and if all values it captures by copy + or move are [`Clone`] or [`Copy`], respectively. + +[`Clone`]: ../special-types-and-traits.md#clone +[`Copy`]: ../special-types-and-traits.md#copy +[`FnMut`]: ../../std/ops/trait.FnMut.html +[`FnOnce`]: ../../std/ops/trait.FnOnce.html +[`Fn`]: ../../std/ops/trait.Fn.html +[`Send`]: ../special-types-and-traits.md#send +[`Sized`]: ../special-types-and-traits.md#sized +[`Sync`]: ../special-types-and-traits.md#sync +[closure expression]: ../expressions/closure-expr.md +[derived]: ../attributes/derive.md diff --git a/src/doc/reference/src/types/enum.md b/src/doc/reference/src/types/enum.md new file mode 100644 index 000000000..8f81fb1a5 --- /dev/null +++ b/src/doc/reference/src/types/enum.md @@ -0,0 +1,22 @@ +# Enumerated types + +An *enumerated type* is a nominal, heterogeneous disjoint union type, denoted +by the name of an [`enum` item]. [^enumtype] + +An [`enum` item] declares both the type and a number of *variants*, each of +which is independently named and has the syntax of a struct, tuple struct or +unit-like struct. + +New instances of an `enum` can be constructed with a [struct expression]. + +Any `enum` value consumes as much memory as the largest variant for its +corresponding `enum` type, as well as the size needed to store a discriminant. + +Enum types cannot be denoted *structurally* as types, but must be denoted by +named reference to an [`enum` item]. + +[^enumtype]: The `enum` type is analogous to a `data` constructor declaration in + ML, or a *pick ADT* in Limbo. + +[`enum` item]: ../items/enumerations.md +[struct expression]: ../expressions/struct-expr.md diff --git a/src/doc/reference/src/types/function-item.md b/src/doc/reference/src/types/function-item.md new file mode 100644 index 000000000..c8088e48c --- /dev/null +++ b/src/doc/reference/src/types/function-item.md @@ -0,0 +1,57 @@ +# Function item types + +When referred to, a function item, or the constructor of a tuple-like struct or +enum variant, yields a zero-sized value of its _function item type_. That type +explicitly identifies the function - its name, its type arguments, and its +early-bound lifetime arguments (but not its late-bound lifetime arguments, +which are only assigned when the function is called) - so the value does not +need to contain an actual function pointer, and no indirection is needed when +the function is called. + +There is no syntax that directly refers to a function item type, but the +compiler will display the type as something like `fn(u32) -> i32 {fn_name}` in +error messages. + +Because the function item type explicitly identifies the function, the item +types of different functions - different items, or the same item with different +generics - are distinct, and mixing them will create a type error: + +```rust,compile_fail,E0308 +fn foo() { } +let x = &mut foo::; +*x = foo::; //~ ERROR mismatched types +``` + +However, there is a [coercion] from function items to [function pointers] with +the same signature, which is triggered not only when a function item is used +when a function pointer is directly expected, but also when different function +item types with the same signature meet in different arms of the same `if` or +`match`: + +```rust +# let want_i32 = false; +# fn foo() { } + +// `foo_ptr_1` has function pointer type `fn()` here +let foo_ptr_1: fn() = foo::; + +// ... and so does `foo_ptr_2` - this type-checks. +let foo_ptr_2 = if want_i32 { + foo:: +} else { + foo:: +}; +``` + +All function items implement [`Fn`], [`FnMut`], [`FnOnce`], [`Copy`], +[`Clone`], [`Send`], and [`Sync`]. + +[`Clone`]: ../special-types-and-traits.md#clone +[`Copy`]: ../special-types-and-traits.md#copy +[`FnMut`]: ../../std/ops/trait.FnMut.html +[`FnOnce`]: ../../std/ops/trait.FnOnce.html +[`Fn`]: ../../std/ops/trait.Fn.html +[`Send`]: ../special-types-and-traits.md#send +[`Sync`]: ../special-types-and-traits.md#sync +[coercion]: ../type-coercions.md +[function pointers]: function-pointer.md diff --git a/src/doc/reference/src/types/function-pointer.md b/src/doc/reference/src/types/function-pointer.md new file mode 100644 index 000000000..a51f76135 --- /dev/null +++ b/src/doc/reference/src/types/function-pointer.md @@ -0,0 +1,66 @@ +# Function pointer types + +> **Syntax**\ +> _BareFunctionType_ :\ +>    [_ForLifetimes_]? _FunctionTypeQualifiers_ `fn`\ +>       `(` _FunctionParametersMaybeNamedVariadic_? `)` _BareFunctionReturnType_? +> +> _FunctionTypeQualifiers_:\ +>    `unsafe`? (`extern` [_Abi_]?)? +> +> _BareFunctionReturnType_:\ +>    `->` [_TypeNoBounds_] +> +> _FunctionParametersMaybeNamedVariadic_ :\ +>    _MaybeNamedFunctionParameters_ | _MaybeNamedFunctionParametersVariadic_ +> +> _MaybeNamedFunctionParameters_ :\ +>    _MaybeNamedParam_ ( `,` _MaybeNamedParam_ )\* `,`? +> +> _MaybeNamedParam_ :\ +>    [_OuterAttribute_]\* ( ( [IDENTIFIER] | `_` ) `:` )? [_Type_] +> +> _MaybeNamedFunctionParametersVariadic_ :\ +>    ( _MaybeNamedParam_ `,` )\* _MaybeNamedParam_ `,` [_OuterAttribute_]\* `...` + +Function pointer types, written using the `fn` keyword, refer to a function +whose identity is not necessarily known at compile-time. They can be created +via a coercion from both [function items] and non-capturing [closures]. + +The `unsafe` qualifier indicates that the type's value is an [unsafe +function], and the `extern` qualifier indicates it is an [extern function]. + +Variadic parameters can only be specified with [`extern`] function types with +the `"C"` or `"cdecl"` calling convention. + +An example where `Binop` is defined as a function pointer type: + +```rust +fn add(x: i32, y: i32) -> i32 { + x + y +} + +let mut x = add(5,7); + +type Binop = fn(i32, i32) -> i32; +let bo: Binop = add; +x = bo(5,7); +``` + +## Attributes on function pointer parameters + +Attributes on function pointer parameters follow the same rules and +restrictions as [regular function parameters]. + +[IDENTIFIER]: ../identifiers.md +[_Abi_]: ../items/functions.md +[_ForLifetimes_]: ../trait-bounds.md#higher-ranked-trait-bounds +[_TypeNoBounds_]: ../types.md#type-expressions +[_Type_]: ../types.md#type-expressions +[_OuterAttribute_]: ../attributes.md +[`extern`]: ../items/external-blocks.md +[closures]: closure.md +[extern function]: ../items/functions.md#extern-function-qualifier +[function items]: function-item.md +[unsafe function]: ../unsafe-functions.md +[regular function parameters]: ../items/functions.md#attributes-on-function-parameters diff --git a/src/doc/reference/src/types/impl-trait.md b/src/doc/reference/src/types/impl-trait.md new file mode 100644 index 000000000..413f999f8 --- /dev/null +++ b/src/doc/reference/src/types/impl-trait.md @@ -0,0 +1,124 @@ +# Impl trait + +> **Syntax**\ +> _ImplTraitType_ : `impl` [_TypeParamBounds_] +> +> _ImplTraitTypeOneBound_ : `impl` [_TraitBound_] + +`impl Trait` provides ways to specify unnamed but concrete types that +implement a specific trait. +It can appear in two sorts of places: argument position (where it can act as an anonymous type parameter to functions), and return position (where it can act as an abstract return type). + +```rust +trait Trait {} +# impl Trait for () {} + +// argument position: anonymous type parameter +fn foo(arg: impl Trait) { +} + +// return position: abstract return type +fn bar() -> impl Trait { +} +``` +## Anonymous type parameters + +> Note: This is often called "impl Trait in argument position". +(The term "parameter" is more correct here, but "impl Trait in argument position" is the phrasing used during the development of this feature, and it remains in parts of the implementation.) + +Functions can use `impl` followed by a set of trait bounds to declare a parameter as having an anonymous type. +The caller must provide a type that satisfies the bounds declared by the anonymous type parameter, and the function can only use the methods available through the trait bounds of the anonymous type parameter. + +For example, these two forms are almost equivalent: + +```rust,ignore +trait Trait {} + +// generic type parameter +fn foo(arg: T) { +} + +// impl Trait in argument position +fn foo(arg: impl Trait) { +} +``` + +That is, `impl Trait` in argument position is syntactic sugar for a generic type parameter like ``, except that the type is anonymous and doesn't appear in the [_GenericParams_] list. + +> **Note:** +> For function parameters, generic type parameters and `impl Trait` are not exactly equivalent. +> With a generic parameter such as ``, the caller has the option to explicitly specify the generic argument for `T` at the call site using [_GenericArgs_], for example, `foo::(1)`. +> If `impl Trait` is the type of *any* function parameter, then the caller can't ever provide any generic arguments when calling that function. +This includes generic arguments for the return type or any const generics. +> +> Therefore, changing the function signature from either one to the other can constitute a breaking change for the callers of a function. + +## Abstract return types + +> Note: This is often called "impl Trait in return position". + +Functions can use `impl Trait` to return an abstract return type. +These types stand in for another concrete type where the caller may only use the methods declared by the specified `Trait`. +Each possible return value from the function must resolve to the same concrete type. + +`impl Trait` in return position allows a function to return an unboxed abstract type. +This is particularly useful with [closures] and iterators. +For example, closures have a unique, un-writable type. +Previously, the only way to return a closure from a function was to use a [trait object]: + +```rust +fn returns_closure() -> Box i32> { + Box::new(|x| x + 1) +} +``` + +This could incur performance penalties from heap allocation and dynamic dispatch. +It wasn't possible to fully specify the type of the closure, only to use the `Fn` trait. +That means that the trait object is necessary. +However, with `impl Trait`, it is possible to write this more simply: + +```rust +fn returns_closure() -> impl Fn(i32) -> i32 { + |x| x + 1 +} +``` + +which also avoids the drawbacks of using a boxed trait object. + +Similarly, the concrete types of iterators could become very complex, incorporating the types of all previous iterators in a chain. +Returning `impl Iterator` means that a function only exposes the `Iterator` trait as a bound on its return type, instead of explicitly specifying all of the other iterator types involved. + +### Differences between generics and `impl Trait` in return position + +In argument position, `impl Trait` is very similar in semantics to a generic type parameter. +However, there are significant differences between the two in return position. +With `impl Trait`, unlike with a generic type parameter, the function chooses the return type, and the caller cannot choose the return type. + +The function: + +```rust,ignore +fn foo() -> T { +``` + +allows the caller to determine the return type, `T`, and the function returns that type. + +The function: + +```rust,ignore +fn foo() -> impl Trait { +``` + +doesn't allow the caller to determine the return type. +Instead, the function chooses the return type, but only promises that it will implement `Trait`. + +## Limitations + +`impl Trait` can only appear as a parameter or return type of a free or inherent function. +It cannot appear inside implementations of traits, nor can it be the type of a let binding or appear inside a type alias. + +[closures]: closure.md +[_GenericArgs_]: ../paths.md#paths-in-expressions +[_GenericParams_]: ../items/generics.md +[_TraitBound_]: ../trait-bounds.md +[trait object]: trait-object.md +[_TypeParamBounds_]: ../trait-bounds.md diff --git a/src/doc/reference/src/types/inferred.md b/src/doc/reference/src/types/inferred.md new file mode 100644 index 000000000..c33ebd91c --- /dev/null +++ b/src/doc/reference/src/types/inferred.md @@ -0,0 +1,18 @@ +# Inferred type + +> **Syntax**\ +> _InferredType_ : `_` + +The inferred type asks the compiler to infer the type if possible based on the +surrounding information available. It cannot be used in item signatures. It is +often used in generic arguments: + +```rust +let x: Vec<_> = (0..10).collect(); +``` + + diff --git a/src/doc/reference/src/types/never.md b/src/doc/reference/src/types/never.md new file mode 100644 index 000000000..e32674272 --- /dev/null +++ b/src/doc/reference/src/types/never.md @@ -0,0 +1,22 @@ +# Never type + +> **Syntax**\ +> _NeverType_ : `!` + +The never type `!` is a type with no values, representing the result of +computations that never complete. Expressions of type `!` can be coerced into +any other type. + + +```rust,ignore +let x: ! = panic!(); +// Can be coerced into any type. +let y: u32 = x; +``` + +**NB.** The never type was expected to be stabilized in 1.41, but due +to some last minute regressions detected the stabilization was +temporarily reverted. The `!` type can only appear in function return +types presently. See [the tracking +issue](https://github.com/rust-lang/rust/issues/35121) for more +details. diff --git a/src/doc/reference/src/types/numeric.md b/src/doc/reference/src/types/numeric.md new file mode 100644 index 000000000..8ab53a792 --- /dev/null +++ b/src/doc/reference/src/types/numeric.md @@ -0,0 +1,47 @@ +# Numeric types + +## Integer types + +The unsigned integer types consist of: + +Type | Minimum | Maximum +-------|---------|------------------- +`u8` | 0 | 28-1 +`u16` | 0 | 216-1 +`u32` | 0 | 232-1 +`u64` | 0 | 264-1 +`u128` | 0 | 2128-1 + +The signed two's complement integer types consist of: + +Type | Minimum | Maximum +-------|--------------------|------------------- +`i8` | -(27) | 27-1 +`i16` | -(215) | 215-1 +`i32` | -(231) | 231-1 +`i64` | -(263) | 263-1 +`i128` | -(2127) | 2127-1 + + +## Floating-point types + +The IEEE 754-2008 "binary32" and "binary64" floating-point types are `f32` and +`f64`, respectively. + +## Machine-dependent integer types + +The `usize` type is an unsigned integer type with the same number of bits as the +platform's pointer type. It can represent every memory address in the process. + +The `isize` type is a signed integer type with the same number of bits as the +platform's pointer type. The theoretical upper bound on object and array size +is the maximum `isize` value. This ensures that `isize` can be used to calculate +differences between pointers into an object or array and can address every byte +within an object along with one byte past the end. + +`usize` and `isize` are at least 16-bits wide. + +> **Note**: Many pieces of Rust code may assume that pointers, `usize`, and +> `isize` are either 32-bit or 64-bit. As a consequence, 16-bit +> pointer support is limited and may require explicit care and acknowledgment +> from a library to support. diff --git a/src/doc/reference/src/types/parameters.md b/src/doc/reference/src/types/parameters.md new file mode 100644 index 000000000..7b9e7e64e --- /dev/null +++ b/src/doc/reference/src/types/parameters.md @@ -0,0 +1,19 @@ +# Type parameters + +Within the body of an item that has type parameter declarations, the names of +its type parameters are types: + +```rust +fn to_vec(xs: &[A]) -> Vec { + if xs.is_empty() { + return vec![]; + } + let first: A = xs[0].clone(); + let mut rest: Vec = to_vec(&xs[1..]); + rest.insert(0, first); + rest +} +``` + +Here, `first` has type `A`, referring to `to_vec`'s `A` type parameter; and +`rest` has type `Vec`, a vector with element type `A`. diff --git a/src/doc/reference/src/types/pointer.md b/src/doc/reference/src/types/pointer.md new file mode 100644 index 000000000..9c8d80f39 --- /dev/null +++ b/src/doc/reference/src/types/pointer.md @@ -0,0 +1,60 @@ +# Pointer types + +All pointers are explicit first-class values. +They can be moved or copied, stored into data structs, and returned from functions. + +## References (`&` and `&mut`) + +> **Syntax**\ +> _ReferenceType_ :\ +>    `&` [_Lifetime_]? `mut`? [_TypeNoBounds_] + +### Shared references (`&`) + +These point to memory _owned by some other value_. +When a shared reference to a value is created it prevents direct mutation of the value. +[Interior mutability] provides an exception for this in certain circumstances. +As the name suggests, any number of shared references to a value may exist. +A shared reference type is written `&type`, or `&'a type` when you need to specify an explicit lifetime. +Copying a reference is a "shallow" operation: +it involves only copying the pointer itself, that is, pointers are `Copy`. +Releasing a reference has no effect on the value it points to, but referencing of a [temporary value] will keep it alive during the scope of the reference itself. + +### Mutable references (`&mut`) + +These also point to memory owned by some other value. +A mutable reference type is written `&mut type` or `&'a mut type`. +A mutable reference (that hasn't been borrowed) is the only way to access the value it points to, so is not `Copy`. + +## Raw pointers (`*const` and `*mut`) + +> **Syntax**\ +> _RawPointerType_ :\ +>    `*` ( `mut` | `const` ) [_TypeNoBounds_] + +Raw pointers are pointers without safety or liveness guarantees. +Raw pointers are written as `*const T` or `*mut T`. +For example `*const i32` means a raw pointer to a 32-bit integer. +Copying or dropping a raw pointer has no effect on the lifecycle of any other value. +Dereferencing a raw pointer is an [`unsafe` operation]. +This can also be used to convert a raw pointer to a reference by reborrowing it (`&*` or `&mut *`). +Raw pointers are generally discouraged; +they exist to support interoperability with foreign code, and writing performance-critical or low-level functions. + +When comparing raw pointers they are compared by their address, rather than by what they point to. +When comparing raw pointers to [dynamically sized types] they also have their additional data compared. + +Raw pointers can be created directly using [`core::ptr::addr_of!`] for `*const` pointers and [`core::ptr::addr_of_mut!`] for `*mut` pointers. + +## Smart Pointers + +The standard library contains additional 'smart pointer' types beyond references and raw pointers. + +[`core::ptr::addr_of!`]: ../../core/ptr/macro.addr_of.html +[`core::ptr::addr_of_mut!`]: ../../core/ptr/macro.addr_of_mut.html +[Interior mutability]: ../interior-mutability.md +[_Lifetime_]: ../trait-bounds.md +[_TypeNoBounds_]: ../types.md#type-expressions +[`unsafe` operation]: ../unsafety.md +[dynamically sized types]: ../dynamically-sized-types.md +[temporary value]: ../expressions.md#temporaries diff --git a/src/doc/reference/src/types/slice.md b/src/doc/reference/src/types/slice.md new file mode 100644 index 000000000..6ba5e7d21 --- /dev/null +++ b/src/doc/reference/src/types/slice.md @@ -0,0 +1,31 @@ +# Slice types + +> **Syntax**\ +> _SliceType_ :\ +>    `[` [_Type_] `]` + +A slice is a [dynamically sized type] representing a 'view' into a sequence of +elements of type `T`. The slice type is written as `[T]`. + +Slice types are generally used through pointer types. For example: + +* `&[T]`: a 'shared slice', often just called a 'slice'. It doesn't own the + data it points to; it borrows it. +* `&mut [T]`: a 'mutable slice'. It mutably borrows the data it points to. +* `Box<[T]>`: a 'boxed slice' + +Examples: + +```rust +// A heap-allocated array, coerced to a slice +let boxed_array: Box<[i32]> = Box::new([1, 2, 3]); + +// A (shared) slice into an array +let slice: &[i32] = &boxed_array[..]; +``` + +All elements of slices are always initialized, and access to a slice is always +bounds-checked in safe methods and operators. + +[_Type_]: ../types.md#type-expressions +[dynamically sized type]: ../dynamically-sized-types.md diff --git a/src/doc/reference/src/types/struct.md b/src/doc/reference/src/types/struct.md new file mode 100644 index 000000000..1f20dbb3c --- /dev/null +++ b/src/doc/reference/src/types/struct.md @@ -0,0 +1,29 @@ +# Struct types + +A `struct` *type* is a heterogeneous product of other types, called the +*fields* of the type.[^structtype] + +New instances of a `struct` can be constructed with a [struct expression]. + +The memory layout of a `struct` is undefined by default to allow for compiler +optimizations like field reordering, but it can be fixed with the +[`repr` attribute]. In either case, fields may be given in any order in a +corresponding struct *expression*; the resulting `struct` value will always +have the same memory layout. + +The fields of a `struct` may be qualified by [visibility modifiers], to allow +access to data in a struct outside a module. + +A _tuple struct_ type is just like a struct type, except that the fields are +anonymous. + +A _unit-like struct_ type is like a struct type, except that it has no fields. +The one value constructed by the associated [struct expression] is the only +value that inhabits such a type. + +[^structtype]: `struct` types are analogous to `struct` types in C, the + *record* types of the ML family, or the *struct* types of the Lisp family. + +[`repr` attribute]: ../type-layout.md#representations +[struct expression]: ../expressions/struct-expr.md +[visibility modifiers]: ../visibility-and-privacy.md diff --git a/src/doc/reference/src/types/textual.md b/src/doc/reference/src/types/textual.md new file mode 100644 index 000000000..7f3899d70 --- /dev/null +++ b/src/doc/reference/src/types/textual.md @@ -0,0 +1,22 @@ +# Textual types + +The types `char` and `str` hold textual data. + +A value of type `char` is a [Unicode scalar value] (i.e. a code point that is +not a surrogate), represented as a 32-bit unsigned word in the 0x0000 to 0xD7FF +or 0xE000 to 0x10FFFF range. It is immediate [Undefined Behavior] to create a +`char` that falls outside this range. A `[char]` is effectively a UCS-4 / UTF-32 +string of length 1. + +A value of type `str` is represented the same way as `[u8]`, it is a slice of +8-bit unsigned bytes. However, the Rust standard library makes extra assumptions +about `str`: methods working on `str` assume and ensure that the data in there +is valid UTF-8. Calling a `str` method with a non-UTF-8 buffer can cause +[Undefined Behavior] now or in the future. + +Since `str` is a [dynamically sized type], it can only be instantiated through a +pointer type, such as `&str`. + +[Unicode scalar value]: http://www.unicode.org/glossary/#unicode_scalar_value +[Undefined Behavior]: ../behavior-considered-undefined.md +[dynamically sized type]: ../dynamically-sized-types.md diff --git a/src/doc/reference/src/types/trait-object.md b/src/doc/reference/src/types/trait-object.md new file mode 100644 index 000000000..3526b7add --- /dev/null +++ b/src/doc/reference/src/types/trait-object.md @@ -0,0 +1,107 @@ +# Trait objects + +> **Syntax**\ +> _TraitObjectType_ :\ +>    `dyn`? [_TypeParamBounds_] +> +> _TraitObjectTypeOneBound_ :\ +>    `dyn`? [_TraitBound_] + +A *trait object* is an opaque value of another type that implements a set of +traits. The set of traits is made up of an [object safe] *base trait* plus any +number of [auto traits]. + +Trait objects implement the base trait, its auto traits, and any [supertraits] +of the base trait. + +Trait objects are written as the keyword `dyn` followed by a set of trait +bounds, but with the following restrictions on the trait bounds. All traits +except the first trait must be auto traits, there may not be more than one +lifetime, and opt-out bounds (e.g. `?Sized`) are not allowed. Furthermore, +paths to traits may be parenthesized. + +For example, given a trait `Trait`, the following are all trait objects: + +* `dyn Trait` +* `dyn Trait + Send` +* `dyn Trait + Send + Sync` +* `dyn Trait + 'static` +* `dyn Trait + Send + 'static` +* `dyn Trait +` +* `dyn 'static + Trait`. +* `dyn (Trait)` + +> **Edition Differences**: Before the 2021 edition, the `dyn` keyword may be +> omitted. +> +> Note: For clarity, it is recommended to always use the `dyn` keyword on your +> trait objects unless your codebase supports compiling with Rust 1.26 or lower. + +> **Edition Differences**: In the 2015 edition, if the first bound of the +> trait object is a path that starts with `::`, then the `dyn` will be treated +> as a part of the path. The first path can be put in parenthesis to get +> around this. As such, if you want a trait object with the trait +> `::your_module::Trait`, you should write it as `dyn (::your_module::Trait)`. +> +> Beginning in the 2018 edition, `dyn` is a true keyword and is not allowed in +> paths, so the parentheses are not necessary. + +Two trait object types alias each other if the base traits alias each other and +if the sets of auto traits are the same and the lifetime bounds are the same. +For example, `dyn Trait + Send + UnwindSafe` is the same as +`dyn Trait + UnwindSafe + Send`. + +Due to the opaqueness of which concrete type the value is of, trait objects are +[dynamically sized types]. Like all +DSTs, trait objects are used +behind some type of pointer; for example `&dyn SomeTrait` or +`Box`. Each instance of a pointer to a trait object includes: + + - a pointer to an instance of a type `T` that implements `SomeTrait` + - a _virtual method table_, often just called a _vtable_, which contains, for + each method of `SomeTrait` and its [supertraits] that `T` implements, a + pointer to `T`'s implementation (i.e. a function pointer). + +The purpose of trait objects is to permit "late binding" of methods. Calling a +method on a trait object results in virtual dispatch at runtime: that is, a +function pointer is loaded from the trait object vtable and invoked indirectly. +The actual implementation for each vtable entry can vary on an object-by-object +basis. + +An example of a trait object: + +```rust +trait Printable { + fn stringify(&self) -> String; +} + +impl Printable for i32 { + fn stringify(&self) -> String { self.to_string() } +} + +fn print(a: Box) { + println!("{}", a.stringify()); +} + +fn main() { + print(Box::new(10) as Box); +} +``` + +In this example, the trait `Printable` occurs as a trait object in both the +type signature of `print`, and the cast expression in `main`. + +## Trait Object Lifetime Bounds + +Since a trait object can contain references, the lifetimes of those references +need to be expressed as part of the trait object. This lifetime is written as +`Trait + 'a`. There are [defaults] that allow this lifetime to usually be +inferred with a sensible choice. + +[_TraitBound_]: ../trait-bounds.md +[_TypeParamBounds_]: ../trait-bounds.md +[auto traits]: ../special-types-and-traits.md#auto-traits +[defaults]: ../lifetime-elision.md#default-trait-object-lifetimes +[dynamically sized types]: ../dynamically-sized-types.md +[object safe]: ../items/traits.md#object-safety +[supertraits]: ../items/traits.md#supertraits diff --git a/src/doc/reference/src/types/tuple.md b/src/doc/reference/src/types/tuple.md new file mode 100644 index 000000000..df21e1cdf --- /dev/null +++ b/src/doc/reference/src/types/tuple.md @@ -0,0 +1,47 @@ +# Tuple types + +> **Syntax**\ +> _TupleType_ :\ +>       `(` `)`\ +>    | `(` ( [_Type_] `,` )+ [_Type_]? `)` + +*Tuple types* are a family of structural types[^1] for heterogeneous lists of other types. + +The syntax for a tuple type is a parenthesized, comma-separated list of types. +1-ary tuples require a comma after their element type to be disambiguated with a [parenthesized type]. + +A tuple type has a number of fields equal to the length of the list of types. +This number of fields determines the *arity* of the tuple. +A tuple with `n` fields is called an *n-ary tuple*. +For example, a tuple with 2 fields is a 2-ary tuple. + +Fields of tuples are named using increasing numeric names matching their position in the list of types. +The first field is `0`. +The second field is `1`. +And so on. +The type of each field is the type of the same position in the tuple's list of types. + +For convenience and historical reasons, the tuple type with no fields (`()`) is often called *unit* or *the unit type*. +Its one value is also called *unit* or *the unit value*. + +Some examples of tuple types: + +* `()` (unit) +* `(f64, f64)` +* `(String, i32)` +* `(i32, String)` (different type from the previous example) +* `(i32, f64, Vec, Option)` + +Values of this type are constructed using a [tuple expression]. +Furthermore, various expressions will produce the unit value if there is no other meaningful value for it to evaluate to. +Tuple fields can be accessed by either a [tuple index expression] or [pattern matching]. + +[^1]: Structural types are always equivalent if their internal types are equivalent. + For a nominal version of tuples, see [tuple structs]. + +[_Type_]: ../types.md#type-expressions +[parenthesized type]: ../types.md#parenthesized-types +[pattern matching]: ../patterns.md#tuple-patterns +[tuple expression]: ../expressions/tuple-expr.md#tuple-expressions +[tuple index expression]: ../expressions/tuple-expr.md#tuple-indexing-expressions +[tuple structs]: ./struct.md diff --git a/src/doc/reference/src/types/union.md b/src/doc/reference/src/types/union.md new file mode 100644 index 000000000..326e720c6 --- /dev/null +++ b/src/doc/reference/src/types/union.md @@ -0,0 +1,19 @@ +# Union types + +A *union type* is a nominal, heterogeneous C-like union, denoted by the name of +a [`union` item][item]. + +Unions have no notion of an "active field". Instead, every union access +transmutes parts of the content of the union to the type of the accessed field. +Since transmutes can cause unexpected or undefined behaviour, `unsafe` is +required to read from a union field. Union field types are also restricted to a +subset of types which ensures that they never need dropping. See the [item] +documentation for further details. + +The memory layout of a `union` is undefined by default (in particular, fields do +*not* have to be at offset 0), but the `#[repr(...)]` attribute can be used to +fix a layout. + +[`Copy`]: ../special-types-and-traits.md#copy +[`ManuallyDrop`]: ../../std/mem/struct.ManuallyDrop.html +[item]: ../items/unions.md diff --git a/src/doc/reference/src/unsafe-blocks.md b/src/doc/reference/src/unsafe-blocks.md new file mode 100644 index 000000000..754278445 --- /dev/null +++ b/src/doc/reference/src/unsafe-blocks.md @@ -0,0 +1,22 @@ +# Unsafe blocks + +A block of code can be prefixed with the `unsafe` keyword, to permit calling +`unsafe` functions or dereferencing raw pointers within a safe function. + +When a programmer has sufficient conviction that a sequence of potentially +unsafe operations is actually safe, they can encapsulate that sequence (taken +as a whole) within an `unsafe` block. The compiler will consider uses of such +code safe, in the surrounding context. + +Unsafe blocks are used to wrap foreign libraries, make direct use of hardware +or implement features not directly present in the language. For example, Rust +provides the language features necessary to implement memory-safe concurrency +in the language but the implementation of threads and message passing is in the +standard library. + +Rust's type system is a conservative approximation of the dynamic safety +requirements, so in some cases there is a performance cost to using safe code. +For example, a doubly-linked list is not a tree structure and can only be +represented with reference-counted pointers in safe code. By using `unsafe` +blocks to represent the reverse links as raw pointers, it can be implemented +with only boxes. diff --git a/src/doc/reference/src/unsafe-functions.md b/src/doc/reference/src/unsafe-functions.md new file mode 100644 index 000000000..7a5064c08 --- /dev/null +++ b/src/doc/reference/src/unsafe-functions.md @@ -0,0 +1,5 @@ +# Unsafe functions + +Unsafe functions are functions that are not safe in all contexts and/or for all +possible inputs. Such a function must be prefixed with the keyword `unsafe` and +can only be called from an `unsafe` block or another `unsafe` function. diff --git a/src/doc/reference/src/unsafety.md b/src/doc/reference/src/unsafety.md new file mode 100644 index 000000000..915fa5b03 --- /dev/null +++ b/src/doc/reference/src/unsafety.md @@ -0,0 +1,19 @@ +# Unsafety + +Unsafe operations are those that can potentially violate the memory-safety +guarantees of Rust's static semantics. + +The following language level features cannot be used in the safe subset of +Rust: + +- Dereferencing a [raw pointer]. +- Reading or writing a [mutable] or [external] static variable. +- Accessing a field of a [`union`], other than to assign to it. +- Calling an unsafe function (including an intrinsic or foreign function). +- Implementing an [unsafe trait]. + +[`union`]: items/unions.md +[mutable]: items/static-items.md#mutable-statics +[external]: items/external-blocks.md +[raw pointer]: types/pointer.md +[unsafe trait]: items/traits.md#unsafe-traits diff --git a/src/doc/reference/src/variables.md b/src/doc/reference/src/variables.md new file mode 100644 index 000000000..5e5ec1bc1 --- /dev/null +++ b/src/doc/reference/src/variables.md @@ -0,0 +1,45 @@ +# Variables + +A _variable_ is a component of a stack frame, either a named function parameter, +an anonymous [temporary](expressions.md#temporaries), or a named local +variable. + +A _local variable_ (or *stack-local* allocation) holds a value directly, +allocated within the stack's memory. The value is a part of the stack frame. + +Local variables are immutable unless declared otherwise. For example: +`let mut x = ...`. + +Function parameters are immutable unless declared with `mut`. The `mut` keyword +applies only to the following parameter. For example: `|mut x, y|` and +`fn f(mut x: Box, y: Box)` declare one mutable variable `x` and one +immutable variable `y`. + +Local variables are not initialized when allocated. Instead, the entire frame +worth of local variables are allocated, on frame-entry, in an uninitialized +state. Subsequent statements within a function may or may not initialize the +local variables. Local variables can be used only after they have been +initialized through all reachable control flow paths. + +In this next example, `init_after_if` is initialized after the [`if` expression] +while `uninit_after_if` is not because it is not initialized in the `else` case. + +```rust +# fn random_bool() -> bool { true } +fn initialization_example() { + let init_after_if: (); + let uninit_after_if: (); + + if random_bool() { + init_after_if = (); + uninit_after_if = (); + } else { + init_after_if = (); + } + + init_after_if; // ok + // uninit_after_if; // err: use of possibly uninitialized `uninit_after_if` +} +``` + +[`if` expression]: expressions/if-expr.md#if-expressions diff --git a/src/doc/reference/src/visibility-and-privacy.md b/src/doc/reference/src/visibility-and-privacy.md new file mode 100644 index 000000000..df9f05ad8 --- /dev/null +++ b/src/doc/reference/src/visibility-and-privacy.md @@ -0,0 +1,245 @@ +# Visibility and Privacy + +> **Syntax**\ +> _Visibility_ :\ +>       `pub`\ +>    | `pub` `(` `crate` `)`\ +>    | `pub` `(` `self` `)`\ +>    | `pub` `(` `super` `)`\ +>    | `pub` `(` `in` [_SimplePath_] `)` + +These two terms are often used interchangeably, and what they are attempting to +convey is the answer to the question "Can this item be used at this location?" + +Rust's name resolution operates on a global hierarchy of namespaces. Each level +in the hierarchy can be thought of as some item. The items are one of those +mentioned above, but also include external crates. Declaring or defining a new +module can be thought of as inserting a new tree into the hierarchy at the +location of the definition. + +To control whether interfaces can be used across modules, Rust checks each use +of an item to see whether it should be allowed or not. This is where privacy +warnings are generated, or otherwise "you used a private item of another module +and weren't allowed to." + +By default, everything is *private*, with two exceptions: Associated +items in a `pub` Trait are public by default; Enum variants +in a `pub` enum are also public by default. When an item is declared as `pub`, +it can be thought of as being accessible to the outside world. For example: + +```rust +# fn main() {} +// Declare a private struct +struct Foo; + +// Declare a public struct with a private field +pub struct Bar { + field: i32, +} + +// Declare a public enum with two public variants +pub enum State { + PubliclyAccessibleState, + PubliclyAccessibleState2, +} +``` + +With the notion of an item being either public or private, Rust allows item +accesses in two cases: + +1. If an item is public, then it can be accessed externally from some module + `m` if you can access all the item's ancestor modules from `m`. You can + also potentially be able to name the item through re-exports. See below. +2. If an item is private, it may be accessed by the current module and its + descendants. + +These two cases are surprisingly powerful for creating module hierarchies +exposing public APIs while hiding internal implementation details. To help +explain, here's a few use cases and what they would entail: + +* A library developer needs to expose functionality to crates which link + against their library. As a consequence of the first case, this means that + anything which is usable externally must be `pub` from the root down to the + destination item. Any private item in the chain will disallow external + accesses. + +* A crate needs a global available "helper module" to itself, but it doesn't + want to expose the helper module as a public API. To accomplish this, the + root of the crate's hierarchy would have a private module which then + internally has a "public API". Because the entire crate is a descendant of + the root, then the entire local crate can access this private module through + the second case. + +* When writing unit tests for a module, it's often a common idiom to have an + immediate child of the module to-be-tested named `mod test`. This module + could access any items of the parent module through the second case, meaning + that internal implementation details could also be seamlessly tested from the + child module. + +In the second case, it mentions that a private item "can be accessed" by the +current module and its descendants, but the exact meaning of accessing an item +depends on what the item is. Accessing a module, for example, would mean +looking inside of it (to import more items). On the other hand, accessing a +function would mean that it is invoked. Additionally, path expressions and +import statements are considered to access an item in the sense that the +import/expression is only valid if the destination is in the current visibility +scope. + +Here's an example of a program which exemplifies the three cases outlined +above: + +```rust +// This module is private, meaning that no external crate can access this +// module. Because it is private at the root of this current crate, however, any +// module in the crate may access any publicly visible item in this module. +mod crate_helper_module { + + // This function can be used by anything in the current crate + pub fn crate_helper() {} + + // This function *cannot* be used by anything else in the crate. It is not + // publicly visible outside of the `crate_helper_module`, so only this + // current module and its descendants may access it. + fn implementation_detail() {} +} + +// This function is "public to the root" meaning that it's available to external +// crates linking against this one. +pub fn public_api() {} + +// Similarly to 'public_api', this module is public so external crates may look +// inside of it. +pub mod submodule { + use crate::crate_helper_module; + + pub fn my_method() { + // Any item in the local crate may invoke the helper module's public + // interface through a combination of the two rules above. + crate_helper_module::crate_helper(); + } + + // This function is hidden to any module which is not a descendant of + // `submodule` + fn my_implementation() {} + + #[cfg(test)] + mod test { + + #[test] + fn test_my_implementation() { + // Because this module is a descendant of `submodule`, it's allowed + // to access private items inside of `submodule` without a privacy + // violation. + super::my_implementation(); + } + } +} + +# fn main() {} +``` + +For a Rust program to pass the privacy checking pass, all paths must be valid +accesses given the two rules above. This includes all use statements, +expressions, types, etc. + +## `pub(in path)`, `pub(crate)`, `pub(super)`, and `pub(self)` + +In addition to public and private, Rust allows users to declare an item as +visible only within a given scope. The rules for `pub` restrictions are as +follows: +- `pub(in path)` makes an item visible within the provided `path`. `path` must +be an ancestor module of the item whose visibility is being declared. +- `pub(crate)` makes an item visible within the current crate. +- `pub(super)` makes an item visible to the parent module. This is equivalent + to `pub(in super)`. +- `pub(self)` makes an item visible to the current module. This is equivalent +to `pub(in self)` or not using `pub` at all. + +> **Edition Differences**: Starting with the 2018 edition, paths for +> `pub(in path)` must start with `crate`, `self`, or `super`. The 2015 edition +> may also use paths starting with `::` or modules from the crate root. + +Here's an example: + +```rust,edition2015 +pub mod outer_mod { + pub mod inner_mod { + // This function is visible within `outer_mod` + pub(in crate::outer_mod) fn outer_mod_visible_fn() {} + // Same as above, this is only valid in the 2015 edition. + pub(in outer_mod) fn outer_mod_visible_fn_2015() {} + + // This function is visible to the entire crate + pub(crate) fn crate_visible_fn() {} + + // This function is visible within `outer_mod` + pub(super) fn super_mod_visible_fn() { + // This function is visible since we're in the same `mod` + inner_mod_visible_fn(); + } + + // This function is visible only within `inner_mod`, + // which is the same as leaving it private. + pub(self) fn inner_mod_visible_fn() {} + } + pub fn foo() { + inner_mod::outer_mod_visible_fn(); + inner_mod::crate_visible_fn(); + inner_mod::super_mod_visible_fn(); + + // This function is no longer visible since we're outside of `inner_mod` + // Error! `inner_mod_visible_fn` is private + //inner_mod::inner_mod_visible_fn(); + } +} + +fn bar() { + // This function is still visible since we're in the same crate + outer_mod::inner_mod::crate_visible_fn(); + + // This function is no longer visible since we're outside of `outer_mod` + // Error! `super_mod_visible_fn` is private + //outer_mod::inner_mod::super_mod_visible_fn(); + + // This function is no longer visible since we're outside of `outer_mod` + // Error! `outer_mod_visible_fn` is private + //outer_mod::inner_mod::outer_mod_visible_fn(); + + outer_mod::foo(); +} + +fn main() { bar() } +``` + +> **Note:** This syntax only adds another restriction to the visibility of an +> item. It does not guarantee that the item is visible within all parts of the +> specified scope. To access an item, all of its parent items up to the +> current scope must still be visible as well. + +## Re-exporting and Visibility + +Rust allows publicly re-exporting items through a `pub use` directive. Because +this is a public directive, this allows the item to be used in the current +module through the rules above. It essentially allows public access into the +re-exported item. For example, this program is valid: + +```rust +pub use self::implementation::api; + +mod implementation { + pub mod api { + pub fn f() {} + } +} + +# fn main() {} +``` + +This means that any external crate referencing `implementation::api::f` would +receive a privacy violation, while the path `api::f` would be allowed. + +When re-exporting a private item, it can be thought of as allowing the "privacy +chain" being short-circuited through the reexport instead of passing through +the namespace hierarchy as it normally would. + +[_SimplePath_]: paths.md#simple-paths diff --git a/src/doc/reference/src/whitespace.md b/src/doc/reference/src/whitespace.md new file mode 100644 index 000000000..a93bdcbdb --- /dev/null +++ b/src/doc/reference/src/whitespace.md @@ -0,0 +1,24 @@ +# Whitespace + +Whitespace is any non-empty string containing only characters that have the +[`Pattern_White_Space`] Unicode property, namely: + +- `U+0009` (horizontal tab, `'\t'`) +- `U+000A` (line feed, `'\n'`) +- `U+000B` (vertical tab) +- `U+000C` (form feed) +- `U+000D` (carriage return, `'\r'`) +- `U+0020` (space, `' '`) +- `U+0085` (next line) +- `U+200E` (left-to-right mark) +- `U+200F` (right-to-left mark) +- `U+2028` (line separator) +- `U+2029` (paragraph separator) + +Rust is a "free-form" language, meaning that all forms of whitespace serve only +to separate _tokens_ in the grammar, and have no semantic significance. + +A Rust program has identical meaning if each whitespace element is replaced +with any other legal whitespace element, such as a single space character. + +[`Pattern_White_Space`]: https://www.unicode.org/reports/tr31/ diff --git a/src/doc/reference/style-check/Cargo.lock b/src/doc/reference/style-check/Cargo.lock new file mode 100644 index 000000000..1b6229001 --- /dev/null +++ b/src/doc/reference/style-check/Cargo.lock @@ -0,0 +1,62 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +[[package]] +name = "bitflags" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693" + +[[package]] +name = "getopts" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "14dbbfd5c71d70241ecf9e6f13737f7b5ce823821063188d7e46c41d371eebd5" +dependencies = [ + "unicode-width", +] + +[[package]] +name = "memchr" +version = "2.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3728d817d99e5ac407411fa471ff9800a778d88a24685968b36824eaf4bee400" + +[[package]] +name = "pulldown-cmark" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ffade02495f22453cd593159ea2f59827aae7f53fa8323f756799b670881dcf8" +dependencies = [ + "bitflags", + "getopts", + "memchr", + "unicase", +] + +[[package]] +name = "style-check" +version = "0.1.0" +dependencies = [ + "pulldown-cmark", +] + +[[package]] +name = "unicase" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50f37be617794602aabbeee0be4f259dc1778fabe05e2d67ee8f79326d5cb4f6" +dependencies = [ + "version_check", +] + +[[package]] +name = "unicode-width" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9337591893a19b88d8d87f2cec1e73fad5cdfd10e5a6f349f498ad6ea2ffb1e3" + +[[package]] +name = "version_check" +version = "0.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5a972e5669d67ba988ce3dc826706fb0a8b01471c088cb0b6110b805cc36aed" diff --git a/src/doc/reference/style-check/Cargo.toml b/src/doc/reference/style-check/Cargo.toml new file mode 100644 index 000000000..d592f65d0 --- /dev/null +++ b/src/doc/reference/style-check/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "style-check" +version = "0.1.0" +authors = ["steveklabnik "] +edition = "2021" + +[dependencies] +pulldown-cmark = "0.8" diff --git a/src/doc/reference/style-check/src/main.rs b/src/doc/reference/style-check/src/main.rs new file mode 100644 index 000000000..2589cd620 --- /dev/null +++ b/src/doc/reference/style-check/src/main.rs @@ -0,0 +1,131 @@ +use std::env; +use std::error::Error; +use std::fs; +use std::path::Path; + +macro_rules! style_error { + ($bad:expr, $path:expr, $($arg:tt)*) => { + *$bad = true; + eprint!("error in {}: ", $path.display()); + eprintln!("{}", format_args!($($arg)*)); + }; +} + +fn main() { + let arg = env::args().nth(1).unwrap_or_else(|| { + eprintln!("Please pass a src directory as the first argument"); + std::process::exit(1); + }); + + let mut bad = false; + if let Err(e) = check_directory(&Path::new(&arg), &mut bad) { + eprintln!("error: {}", e); + std::process::exit(1); + } + if bad { + eprintln!("some style checks failed"); + std::process::exit(1); + } + eprintln!("passed!"); +} + +fn check_directory(dir: &Path, bad: &mut bool) -> Result<(), Box> { + for entry in fs::read_dir(dir)? { + let entry = entry?; + let path = entry.path(); + + if path.is_dir() { + check_directory(&path, bad)?; + continue; + } + + if !matches!( + path.extension().and_then(|p| p.to_str()), + Some("md") | Some("html") + ) { + // This may be extended in the future if other file types are needed. + style_error!(bad, path, "expected only md or html in src"); + } + + let contents = fs::read_to_string(&path)?; + if contents.contains("#![feature") { + style_error!(bad, path, "#![feature] attributes are not allowed"); + } + if contents.contains('\r') { + style_error!( + bad, + path, + "CR characters not allowed, must use LF line endings" + ); + } + if contents.contains('\t') { + style_error!(bad, path, "tab characters not allowed, use spaces"); + } + if !contents.ends_with('\n') { + style_error!(bad, path, "file must end with a newline"); + } + for line in contents.lines() { + if line.ends_with(' ') { + style_error!(bad, path, "lines must not end with spaces"); + } + } + cmark_check(&path, bad, &contents)?; + } + Ok(()) +} + +fn cmark_check(path: &Path, bad: &mut bool, contents: &str) -> Result<(), Box> { + use pulldown_cmark::{BrokenLink, CodeBlockKind, Event, Options, Parser, Tag}; + + macro_rules! cmark_error { + ($bad:expr, $path:expr, $range:expr, $($arg:tt)*) => { + *$bad = true; + let lineno = contents[..$range.start].chars().filter(|&ch| ch == '\n').count() + 1; + eprint!("error in {} (line {}): ", $path.display(), lineno); + eprintln!("{}", format_args!($($arg)*)); + } + } + + let options = Options::all(); + // Can't use `bad` because it would get captured in closure. + let mut link_err = false; + let mut cb = |link: BrokenLink<'_>| { + cmark_error!( + &mut link_err, + path, + link.span, + "broken {:?} link (reference `{}`)", + link.link_type, + link.reference + ); + None + }; + let parser = Parser::new_with_broken_link_callback(contents, options, Some(&mut cb)); + + for (event, range) in parser.into_offset_iter() { + match event { + Event::Start(Tag::CodeBlock(CodeBlockKind::Indented)) => { + cmark_error!( + bad, + path, + range, + "indented code blocks should use triple backtick-style \ + with a language identifier" + ); + } + Event::Start(Tag::CodeBlock(CodeBlockKind::Fenced(languages))) => { + if languages.is_empty() { + cmark_error!( + bad, + path, + range, + "code block should include an explicit language", + ); + } + } + _ => {} + } + } + *bad |= link_err; + Ok(()) +} diff --git a/src/doc/reference/theme/reference.css b/src/doc/reference/theme/reference.css new file mode 100644 index 000000000..02e5f63df --- /dev/null +++ b/src/doc/reference/theme/reference.css @@ -0,0 +1,53 @@ +/* +.parenthetical class used to keep e.g. "less-than symbol (<)" from wrapping +the end parenthesis onto its own line. Use in a span between the last word and +the parenthetical. So for this example, you'd use +```less-than symbol (`<`)``` +*/ +.parenthetical { + white-space: nowrap; +} + +/* +Warnings and notes: + +Write the
s on their own line. E.g. + +
+ +Warning: This is bad! + +
+*/ +main .warning p { + padding: 10px 20px; + margin: 20px 0; +} + +main .warning p::before { + content: "⚠️ "; +} + +.light main .warning p, +.rust main .warning p { + border: 2px solid red; + background: #ffcece; +} + +.rust main .warning p { + /* overrides previous declaration */ + border-color: #961717; +} + +.coal main .warning p, +.navy main .warning p, +.ayu main .warning p { + background: #542626; +} + +/* Make the links higher contrast on dark themes */ +.coal main .warning p a, +.navy main .warning p a, +.ayu main .warning p a { + color: #80d0d0; +} diff --git a/src/doc/reference/triagebot.toml b/src/doc/reference/triagebot.toml new file mode 100644 index 000000000..4059f9190 --- /dev/null +++ b/src/doc/reference/triagebot.toml @@ -0,0 +1,6 @@ +[relabel] +allow-unauthenticated = [ + "S-*", "A-*", "New Content", "Language Cleanup", "Easy", "Formatting", "Enhancement", "Bug", +] + +[assign] -- cgit v1.2.3

`]: ../std/pin/struct.Pin.html +[`Rc`]: ../std/rc/struct.Rc.html +[`RefUnwindSafe`]: ../std/panic/trait.RefUnwindSafe.html +[`Send`]: ../std/marker/trait.Send.html +[`Sized`]: ../std/marker/trait.Sized.html +[`std::cell::UnsafeCell`]: ../std/cell/struct.UnsafeCell.html +[`std::cmp`]: ../std/cmp/index.html +[`std::marker::PhantomData`]: ../std/marker/struct.PhantomData.html +[`std::ops`]: ../std/ops/index.html +[`Termination`]: ../std/process/trait.Termination.html +[`UnwindSafe`]: ../std/panic/trait.UnwindSafe.html +[`Sync`]: ../std/marker/trait.Sync.html +[`Unpin`]: ../std/marker/trait.Unpin.html + +[Arrays]: types/array.md +[associated types]: items/associated-items.md#associated-types +[call expressions]: expressions/call-expr.md +[deref coercions]: type-coercions.md#coercion-types +[dereference operator]: expressions/operator-expr.md#the-dereference-operator +[destructor]: destructors.md +[drop check]: ../nomicon/dropck.html +[dynamically sized type]: dynamically-sized-types.md +[Function pointers]: types/function-pointer.md +[Function items]: types/function-item.md +[implementation items]: items/implementations.md +[indexing expressions]: expressions/array-expr.md#array-and-slice-indexing-expressions +[interior mutability]: interior-mutability.md +[main function]: crates-and-source-files.md#main-functions +[Methods]: items/associated-items.md#associated-functions-and-methods +[method resolution]: expressions/method-call-expr.md +[operators]: expressions/operator-expr.md +[orphan rules]: items/implementations.md#trait-implementation-coherence +[`static` items]: items/static-items.md +[test functions]: attributes/testing.md#the-test-attribute +[the standard library]: ../std/index.html +[trait object]: types/trait-object.md +[Tuples]: types/tuple.md +[Type parameters]: types/parameters.md +[variance]: subtyping.md#variance +[Closures]: types/closure.md diff --git a/src/doc/reference/src/statements-and-expressions.md b/src/doc/reference/src/statements-and-expressions.md new file mode 100644 index 000000000..b093972a9 --- /dev/null +++ b/src/doc/reference/src/statements-and-expressions.md @@ -0,0 +1,11 @@ +# Statements and expressions + +Rust is _primarily_ an expression language. This means that most forms of +value-producing or effect-causing evaluation are directed by the uniform syntax +category of _expressions_. Each kind of expression can typically _nest_ within +each other kind of expression, and rules for evaluation of expressions involve +specifying both the value produced by the expression and the order in which its +sub-expressions are themselves evaluated. + +In contrast, statements serve _mostly_ to contain and explicitly +sequence expression evaluation. diff --git a/src/doc/reference/src/statements.md b/src/doc/reference/src/statements.md new file mode 100644 index 000000000..8d9c21d7d --- /dev/null +++ b/src/doc/reference/src/statements.md @@ -0,0 +1,138 @@ +# Statements + +> **Syntax**\ +> _Statement_ :\ +>       `;`\ +>    | [_Item_]\ +>    | [_LetStatement_]\ +>    | [_ExpressionStatement_]\ +>    | [_MacroInvocationSemi_] + + +A *statement* is a component of a [block], which is in turn a component of an +outer [expression] or [function]. + +Rust has two kinds of statement: [declaration +statements](#declaration-statements) and [expression +statements](#expression-statements). + +## Declaration statements + +A *declaration statement* is one that introduces one or more *names* into the +enclosing statement block. The declared names may denote new variables or new +[items][item]. + +The two kinds of declaration statements are item declarations and `let` +statements. + +### Item declarations + +An *item declaration statement* has a syntactic form identical to an +[item declaration][item] within a [module]. Declaring an item within a statement +block restricts its scope to the block containing the statement. The item is not +given a [canonical path] nor are any sub-items it may declare. The exception to +this is that associated items defined by [implementations] are still accessible +in outer scopes as long as the item and, if applicable, trait are accessible. +It is otherwise identical in meaning to declaring the item inside a module. + +There is no implicit capture of the containing function's generic parameters, +parameters, and local variables. For example, `inner` may not access +`outer_var`. + +```rust +fn outer() { + let outer_var = true; + + fn inner() { /* outer_var is not in scope here */ } + + inner(); +} +``` + +### `let` statements + +> **Syntax**\ +> _LetStatement_ :\ +>    [_OuterAttribute_]\* `let` [_PatternNoTopAlt_] +> ( `:` [_Type_] )? (`=` [_Expression_] )? `;` + +A *`let` statement* introduces a new set of [variables], given by an +irrefutable [pattern]. The pattern is followed optionally by a type +annotation and then optionally by an initializer expression. When no +type annotation is given, the compiler will infer the type, or signal +an error if insufficient type information is available for definite +inference. Any variables introduced by a variable declaration are visible +from the point of declaration until the end of the enclosing block scope, +except when they are shadowed by another variable declaration. + +## Expression statements + +> **Syntax**\ +> _ExpressionStatement_ :\ +>       [_ExpressionWithoutBlock_][expression] `;`\ +>    | [_ExpressionWithBlock_][expression] `;`? + +An *expression statement* is one that evaluates an [expression] and ignores its +result. As a rule, an expression statement's purpose is to trigger the effects +of evaluating its expression. + +An expression that consists of only a [block expression][block] or control flow +expression, if used in a context where a statement is permitted, can omit the +trailing semicolon. This can cause an ambiguity between it being parsed as a +standalone statement and as a part of another expression; in this case, it is +parsed as a statement. The type of [_ExpressionWithBlock_][expression] +expressions when used as statements must be the unit type. + +```rust +# let mut v = vec![1, 2, 3]; +v.pop(); // Ignore the element returned from pop +if v.is_empty() { + v.push(5); +} else { + v.remove(0); +} // Semicolon can be omitted. +[1]; // Separate expression statement, not an indexing expression. +``` + +When the trailing semicolon is omitted, the result must be type `()`. + +```rust +// bad: the block's type is i32, not () +// Error: expected `()` because of default return type +// if true { +// 1 +// } + +// good: the block's type is i32 +if true { + 1 +} else { + 2 +}; +``` + +## Attributes on Statements + +Statements accept [outer attributes]. The attributes that have meaning on a +statement are [`cfg`], and [the lint check attributes]. + +[block]: expressions/block-expr.md +[expression]: expressions.md +[function]: items/functions.md +[item]: items.md +[module]: items/modules.md +[canonical path]: paths.md#canonical-paths +[implementations]: items/implementations.md +[variables]: variables.md +[outer attributes]: attributes.md +[`cfg`]: conditional-compilation.md +[the lint check attributes]: attributes/diagnostics.md#lint-check-attributes +[pattern]: patterns.md +[_ExpressionStatement_]: #expression-statements +[_Expression_]: expressions.md +[_Item_]: items.md +[_LetStatement_]: #let-statements +[_MacroInvocationSemi_]: macros.md#macro-invocation +[_OuterAttribute_]: attributes.md +[_PatternNoTopAlt_]: patterns.md +[_Type_]: types.md diff --git a/src/doc/reference/src/subtyping.md b/src/doc/reference/src/subtyping.md new file mode 100644 index 000000000..b31e25d8a --- /dev/null +++ b/src/doc/reference/src/subtyping.md @@ -0,0 +1,114 @@ +# Subtyping and Variance + +Subtyping is implicit and can occur at any stage in type checking or +inference. Subtyping is restricted to two cases: +variance with respect to lifetimes and between types with higher ranked +lifetimes. If we were to erase lifetimes from types, then the only subtyping +would be due to type equality. + +Consider the following example: string literals always have `'static` +lifetime. Nevertheless, we can assign `s` to `t`: + +```rust +fn bar<'a>() { + let s: &'static str = "hi"; + let t: &'a str = s; +} +``` + +Since `'static` outlives the lifetime parameter `'a`, `&'static str` is a +subtype of `&'a str`. + +[Higher-ranked] [function pointers] and [trait objects] have another +subtype relation. They are subtypes of types that are given by substitutions of +the higher-ranked lifetimes. Some examples: + +```rust +// Here 'a is substituted for 'static +let subtype: &(for<'a> fn(&'a i32) -> &'a i32) = &((|x| x) as fn(&_) -> &_); +let supertype: &(fn(&'static i32) -> &'static i32) = subtype; + +// This works similarly for trait objects +let subtype: &(dyn for<'a> Fn(&'a i32) -> &'a i32) = &|x| x; +let supertype: &(dyn Fn(&'static i32) -> &'static i32) = subtype; + +// We can also substitute one higher-ranked lifetime for another +let subtype: &(for<'a, 'b> fn(&'a i32, &'b i32))= &((|x, y| {}) as fn(&_, &_)); +let supertype: &for<'c> fn(&'c i32, &'c i32) = subtype; +``` + +## Variance + +Variance is a property that generic types have with respect to their arguments. +A generic type's *variance* in a parameter is how the subtyping of the +parameter affects the subtyping of the type. + +* `F` is *covariant* over `T` if `T` being a subtype of `U` implies that + `F` is a subtype of `F` (subtyping "passes through") +* `F` is *contravariant* over `T` if `T` being a subtype of `U` implies that + `F` is a subtype of `F` +* `F` is *invariant* over `T` otherwise (no subtyping relation can be + derived) + +Variance of types is automatically determined as follows + +| Type | Variance in `'a` | Variance in `T` | +|-------------------------------|-------------------|-------------------| +| `&'a T` | covariant | covariant | +| `&'a mut T` | covariant | invariant | +| `*const T` | | covariant | +| `*mut T` | | invariant | +| `[T]` and `[T; n]` | | covariant | +| `fn() -> T` | | covariant | +| `fn(T) -> ()` | | contravariant | +| `std::cell::UnsafeCell` | | invariant | +| `std::marker::PhantomData` | | covariant | +| `dyn Trait + 'a` | covariant | invariant | + +The variance of other `struct`, `enum`, and `union` types is decided by +looking at the variance of the types of their fields. If the parameter is used +in positions with different variances then the parameter is invariant. For +example the following struct is covariant in `'a` and `T` and invariant in `'b`, `'c`, +and `U`. + +```rust +use std::cell::UnsafeCell; +struct Variance<'a, 'b, 'c, T, U: 'a> { + x: &'a U, // This makes `Variance` covariant in 'a, and would + // make it covariant in U, but U is used later + y: *const T, // Covariant in T + z: UnsafeCell<&'b f64>, // Invariant in 'b + w: *mut U, // Invariant in U, makes the whole struct invariant + + f: fn(&'c ()) -> &'c () // Both co- and contravariant, makes 'c invariant + // in the struct. +} +``` + +When used outside of an `struct`, `enum`, or `union`, the variance for parameters is checked at each location separately. + +```rust +# use std::cell::UnsafeCell; +fn generic_tuple<'short, 'long: 'short>( + // 'long is used inside of a tuple in both a co- and invariant position. + x: (&'long u32, UnsafeCell<&'long u32>), +) { + // As the variance at these positions is computed separately, + // we can freely shrink 'long in the covariant position. + let _: (&'short u32, UnsafeCell<&'long u32>) = x; +} + +fn takes_fn_ptr<'short, 'middle: 'short>( + // 'middle is used in both a co- and contravariant position. + f: fn(&'middle ()) -> &'middle (), +) { + // As the variance at these positions is computed separately, + // we can freely shrink 'middle in the covariant position + // and extend it in the contravariant position. + let _: fn(&'static ()) -> &'short () = f; +} +``` + +[function pointers]: types/function-pointer.md +[Higher-ranked]: ../nomicon/hrtb.html +[trait objects]: types/trait-object.md diff --git a/src/doc/reference/src/tokens.md b/src/doc/reference/src/tokens.md new file mode 100644 index 000000000..197c20147 --- /dev/null +++ b/src/doc/reference/src/tokens.md @@ -0,0 +1,741 @@ +# Tokens + +Tokens are primitive productions in the grammar defined by regular +(non-recursive) languages. Rust source input can be broken down +into the following kinds of tokens: + +* [Keywords] +* [Identifiers][identifier] +* [Literals](#literals) +* [Lifetimes](#lifetimes-and-loop-labels) +* [Punctuation](#punctuation) +* [Delimiters](#delimiters) + +Within this documentation's grammar, "simple" tokens are given in [string +table production] form, and appear in `monospace` font. + +[string table production]: notation.md#string-table-productions + +## Literals + +Literals are tokens used in [literal expressions]. + +### Examples + +#### Characters and strings + +| | Example | `#` sets\* | Characters | Escapes | +|----------------------------------------------|-----------------|------------|-------------|---------------------| +| [Character](#character-literals) | `'H'` | 0 | All Unicode | [Quote](#quote-escapes) & [ASCII](#ascii-escapes) & [Unicode](#unicode-escapes) | +| [String](#string-literals) | `"hello"` | 0 | All Unicode | [Quote](#quote-escapes) & [ASCII](#ascii-escapes) & [Unicode](#unicode-escapes) | +| [Raw string](#raw-string-literals) | `r#"hello"#` | <256 | All Unicode | `N/A` | +| [Byte](#byte-literals) | `b'H'` | 0 | All ASCII | [Quote](#quote-escapes) & [Byte](#byte-escapes) | +| [Byte string](#byte-string-literals) | `b"hello"` | 0 | All ASCII | [Quote](#quote-escapes) & [Byte](#byte-escapes) | +| [Raw byte string](#raw-byte-string-literals) | `br#"hello"#` | <256 | All ASCII | `N/A` | + +\* The number of `#`s on each side of the same literal must be equivalent. + +#### ASCII escapes + +| | Name | +|---|------| +| `\x41` | 7-bit character code (exactly 2 digits, up to 0x7F) | +| `\n` | Newline | +| `\r` | Carriage return | +| `\t` | Tab | +| `\\` | Backslash | +| `\0` | Null | + +#### Byte escapes + +| | Name | +|---|------| +| `\x7F` | 8-bit character code (exactly 2 digits) | +| `\n` | Newline | +| `\r` | Carriage return | +| `\t` | Tab | +| `\\` | Backslash | +| `\0` | Null | + +#### Unicode escapes + +| | Name | +|---|------| +| `\u{7FFF}` | 24-bit Unicode character code (up to 6 digits) | + +#### Quote escapes + +| | Name | +|---|------| +| `\'` | Single quote | +| `\"` | Double quote | + +#### Numbers + +| [Number literals](#number-literals)`*` | Example | Exponentiation | Suffixes | +|----------------------------------------|---------|----------------|----------| +| Decimal integer | `98_222` | `N/A` | Integer suffixes | +| Hex integer | `0xff` | `N/A` | Integer suffixes | +| Octal integer | `0o77` | `N/A` | Integer suffixes | +| Binary integer | `0b1111_0000` | `N/A` | Integer suffixes | +| Floating-point | `123.0E+77` | `Optional` | Floating-point suffixes | + +`*` All number literals allow `_` as a visual separator: `1_234.0E+18f64` + +#### Suffixes + +A suffix is a sequence of characters following the primary part of a literal (without intervening whitespace), of the same form as a non-raw identifier or keyword. + +Any kind of literal (string, integer, etc) with any suffix is valid as a token, +and can be passed to a macro without producing an error. +The macro itself will decide how to interpret such a token and whether to produce an error or not. + +```rust +macro_rules! blackhole { ($tt:tt) => () } + +blackhole!("string"suffix); // OK +``` + +However, suffixes on literal tokens parsed as Rust code are restricted. +Any suffixes are rejected on non-numeric literal tokens, +and numeric literal tokens are accepted only with suffixes from the list below. + +| Integer | Floating-point | +|---------|----------------| +| `u8`, `i8`, `u16`, `i16`, `u32`, `i32`, `u64`, `i64`, `u128`, `i128`, `usize`, `isize` | `f32`, `f64` | + +### Character and string literals + +#### Character literals + +> **Lexer**\ +> CHAR_LITERAL :\ +>    `'` ( ~\[`'` `\` \\n \\r \\t] | QUOTE_ESCAPE | ASCII_ESCAPE | UNICODE_ESCAPE ) `'` +> +> QUOTE_ESCAPE :\ +>    `\'` | `\"` +> +> ASCII_ESCAPE :\ +>       `\x` OCT_DIGIT HEX_DIGIT\ +>    | `\n` | `\r` | `\t` | `\\` | `\0` +> +> UNICODE_ESCAPE :\ +>    `\u{` ( HEX_DIGIT `_`\* )1..6 `}` + +A _character literal_ is a single Unicode character enclosed within two +`U+0027` (single-quote) characters, with the exception of `U+0027` itself, +which must be _escaped_ by a preceding `U+005C` character (`\`). + +#### String literals + +> **Lexer**\ +> STRING_LITERAL :\ +>    `"` (\ +>       ~\[`"` `\` _IsolatedCR_]\ +>       | QUOTE_ESCAPE\ +>       | ASCII_ESCAPE\ +>       | UNICODE_ESCAPE\ +>       | STRING_CONTINUE\ +>    )\* `"` +> +> STRING_CONTINUE :\ +>    `\` _followed by_ \\n + +A _string literal_ is a sequence of any Unicode characters enclosed within two +`U+0022` (double-quote) characters, with the exception of `U+0022` itself, +which must be _escaped_ by a preceding `U+005C` character (`\`). + +Line-breaks are allowed in string literals. A line-break is either a newline +(`U+000A`) or a pair of carriage return and newline (`U+000D`, `U+000A`). Both +byte sequences are normally translated to `U+000A`, but as a special exception, +when an unescaped `U+005C` character (`\`) occurs immediately before a line +break, then the line break character(s), and all immediately following +` ` (`U+0020`), `\t` (`U+0009`), `\n` (`U+000A`) and `\r` (`U+0000D`) characters +are ignored. Thus `a`, `b` and `c` are equal: + +```rust +let a = "foobar"; +let b = "foo\ + bar"; +let c = "foo\ + + bar"; + +assert_eq!(a, b); +assert_eq!(b, c); +``` + +> Note: Rust skipping additional newlines (like in example `c`) is potentially confusing and +> unexpected. This behavior may be adjusted in the future. Until a decision is made, it is +> recommended to avoid relying on this, i.e. skipping multiple newlines with line continuations. +> See [this issue](https://github.com/rust-lang/reference/pull/1042) for more information. + +#### Character escapes + +Some additional _escapes_ are available in either character or non-raw string +literals. An escape starts with a `U+005C` (`\`) and continues with one of the +following forms: + +* A _7-bit code point escape_ starts with `U+0078` (`x`) and is + followed by exactly two _hex digits_ with value up to `0x7F`. It denotes the + ASCII character with value equal to the provided hex value. Higher values are + not permitted because it is ambiguous whether they mean Unicode code points or + byte values. +* A _24-bit code point escape_ starts with `U+0075` (`u`) and is followed + by up to six _hex digits_ surrounded by braces `U+007B` (`{`) and `U+007D` + (`}`). It denotes the Unicode code point equal to the provided hex value. +* A _whitespace escape_ is one of the characters `U+006E` (`n`), `U+0072` + (`r`), or `U+0074` (`t`), denoting the Unicode values `U+000A` (LF), + `U+000D` (CR) or `U+0009` (HT) respectively. +* The _null escape_ is the character `U+0030` (`0`) and denotes the Unicode + value `U+0000` (NUL). +* The _backslash escape_ is the character `U+005C` (`\`) which must be + escaped in order to denote itself. + +#### Raw string literals + +> **Lexer**\ +> RAW_STRING_LITERAL :\ +>    `r` RAW_STRING_CONTENT +> +> RAW_STRING_CONTENT :\ +>       `"` ( ~ _IsolatedCR_ )* (non-greedy) `"`\ +>    | `#` RAW_STRING_CONTENT `#` + +Raw string literals do not process any escapes. They start with the character +`U+0072` (`r`), followed by fewer than 256 of the character `U+0023` (`#`) and a +`U+0022` (double-quote) character. The _raw string body_ can contain any sequence +of Unicode characters and is terminated only by another `U+0022` (double-quote) +character, followed by the same number of `U+0023` (`#`) characters that preceded +the opening `U+0022` (double-quote) character. + +All Unicode characters contained in the raw string body represent themselves, +the characters `U+0022` (double-quote) (except when followed by at least as +many `U+0023` (`#`) characters as were used to start the raw string literal) or +`U+005C` (`\`) do not have any special meaning. + +Examples for string literals: + +```rust +"foo"; r"foo"; // foo +"\"foo\""; r#""foo""#; // "foo" + +"foo #\"# bar"; +r##"foo #"# bar"##; // foo #"# bar + +"\x52"; "R"; r"R"; // R +"\\x52"; r"\x52"; // \x52 +``` + +### Byte and byte string literals + +#### Byte literals + +> **Lexer**\ +> BYTE_LITERAL :\ +>    `b'` ( ASCII_FOR_CHAR | BYTE_ESCAPE ) `'` +> +> ASCII_FOR_CHAR :\ +>    _any ASCII (i.e. 0x00 to 0x7F), except_ `'`, `\`, \\n, \\r or \\t +> +> BYTE_ESCAPE :\ +>       `\x` HEX_DIGIT HEX_DIGIT\ +>    | `\n` | `\r` | `\t` | `\\` | `\0` | `\'` | `\"` + +A _byte literal_ is a single ASCII character (in the `U+0000` to `U+007F` +range) or a single _escape_ preceded by the characters `U+0062` (`b`) and +`U+0027` (single-quote), and followed by the character `U+0027`. If the character +`U+0027` is present within the literal, it must be _escaped_ by a preceding +`U+005C` (`\`) character. It is equivalent to a `u8` unsigned 8-bit integer +_number literal_. + +#### Byte string literals + +> **Lexer**\ +> BYTE_STRING_LITERAL :\ +>    `b"` ( ASCII_FOR_STRING | BYTE_ESCAPE | STRING_CONTINUE )\* `"` +> +> ASCII_FOR_STRING :\ +>    _any ASCII (i.e 0x00 to 0x7F), except_ `"`, `\` _and IsolatedCR_ + +A non-raw _byte string literal_ is a sequence of ASCII characters and _escapes_, +preceded by the characters `U+0062` (`b`) and `U+0022` (double-quote), and +followed by the character `U+0022`. If the character `U+0022` is present within +the literal, it must be _escaped_ by a preceding `U+005C` (`\`) character. +Alternatively, a byte string literal can be a _raw byte string literal_, defined +below. The type of a byte string literal of length `n` is `&'static [u8; n]`. + +Some additional _escapes_ are available in either byte or non-raw byte string +literals. An escape starts with a `U+005C` (`\`) and continues with one of the +following forms: + +* A _byte escape_ escape starts with `U+0078` (`x`) and is + followed by exactly two _hex digits_. It denotes the byte + equal to the provided hex value. +* A _whitespace escape_ is one of the characters `U+006E` (`n`), `U+0072` + (`r`), or `U+0074` (`t`), denoting the bytes values `0x0A` (ASCII LF), + `0x0D` (ASCII CR) or `0x09` (ASCII HT) respectively. +* The _null escape_ is the character `U+0030` (`0`) and denotes the byte + value `0x00` (ASCII NUL). +* The _backslash escape_ is the character `U+005C` (`\`) which must be + escaped in order to denote its ASCII encoding `0x5C`. + +#### Raw byte string literals + +> **Lexer**\ +> RAW_BYTE_STRING_LITERAL :\ +>    `br` RAW_BYTE_STRING_CONTENT +> +> RAW_BYTE_STRING_CONTENT :\ +>       `"` ASCII* (non-greedy) `"`\ +>    | `#` RAW_BYTE_STRING_CONTENT `#` +> +> ASCII :\ +>    _any ASCII (i.e. 0x00 to 0x7F)_ + +Raw byte string literals do not process any escapes. They start with the +character `U+0062` (`b`), followed by `U+0072` (`r`), followed by fewer than 256 +of the character `U+0023` (`#`), and a `U+0022` (double-quote) character. The +_raw string body_ can contain any sequence of ASCII characters and is terminated +only by another `U+0022` (double-quote) character, followed by the same number of +`U+0023` (`#`) characters that preceded the opening `U+0022` (double-quote) +character. A raw byte string literal can not contain any non-ASCII byte. + +All characters contained in the raw string body represent their ASCII encoding, +the characters `U+0022` (double-quote) (except when followed by at least as +many `U+0023` (`#`) characters as were used to start the raw string literal) or +`U+005C` (`\`) do not have any special meaning. + +Examples for byte string literals: + +```rust +b"foo"; br"foo"; // foo +b"\"foo\""; br#""foo""#; // "foo" + +b"foo #\"# bar"; +br##"foo #"# bar"##; // foo #"# bar + +b"\x52"; b"R"; br"R"; // R +b"\\x52"; br"\x52"; // \x52 +``` + +### Number literals + +A _number literal_ is either an _integer literal_ or a _floating-point +literal_. The grammar for recognizing the two kinds of literals is mixed. + +#### Integer literals + +> **Lexer**\ +> INTEGER_LITERAL :\ +>    ( DEC_LITERAL | BIN_LITERAL | OCT_LITERAL | HEX_LITERAL ) +> INTEGER_SUFFIX? +> +> DEC_LITERAL :\ +>    DEC_DIGIT (DEC_DIGIT|`_`)\* +> +> BIN_LITERAL :\ +>    `0b` (BIN_DIGIT|`_`)\* BIN_DIGIT (BIN_DIGIT|`_`)\* +> +> OCT_LITERAL :\ +>    `0o` (OCT_DIGIT|`_`)\* OCT_DIGIT (OCT_DIGIT|`_`)\* +> +> HEX_LITERAL :\ +>    `0x` (HEX_DIGIT|`_`)\* HEX_DIGIT (HEX_DIGIT|`_`)\* +> +> BIN_DIGIT : \[`0`-`1`] +> +> OCT_DIGIT : \[`0`-`7`] +> +> DEC_DIGIT : \[`0`-`9`] +> +> HEX_DIGIT : \[`0`-`9` `a`-`f` `A`-`F`] +> +> INTEGER_SUFFIX :\ +>       `u8` | `u16` | `u32` | `u64` | `u128` | `usize`\ +>    | `i8` | `i16` | `i32` | `i64` | `i128` | `isize` + +An _integer literal_ has one of four forms: + +* A _decimal literal_ starts with a *decimal digit* and continues with any + mixture of *decimal digits* and _underscores_. +* A _hex literal_ starts with the character sequence `U+0030` `U+0078` + (`0x`) and continues as any mixture (with at least one digit) of hex digits + and underscores. +* An _octal literal_ starts with the character sequence `U+0030` `U+006F` + (`0o`) and continues as any mixture (with at least one digit) of octal digits + and underscores. +* A _binary literal_ starts with the character sequence `U+0030` `U+0062` + (`0b`) and continues as any mixture (with at least one digit) of binary digits + and underscores. + +Like any literal, an integer literal may be followed (immediately, without any spaces) by an _integer suffix_, which must be the name of one of the [primitive integer types][numeric types]: +`u8`, `i8`, `u16`, `i16`, `u32`, `i32`, `u64`, `i64`, `u128`, `i128`, `usize`, or `isize`. +See [literal expressions] for the effect of these suffixes. + +Examples of integer literals of various forms: + +```rust +# #![allow(overflowing_literals)] +123; +123i32; +123u32; +123_u32; + +0xff; +0xff_u8; +0x01_f32; // integer 7986, not floating-point 1.0 +0x01_e3; // integer 483, not floating-point 1000.0 + +0o70; +0o70_i16; + +0b1111_1111_1001_0000; +0b1111_1111_1001_0000i64; +0b________1; + +0usize; + +// These are too big for their type, but are still valid tokens + +128_i8; +256_u8; + +``` + +Note that `-1i8`, for example, is analyzed as two tokens: `-` followed by `1i8`. + +Examples of invalid integer literals: + +```rust,compile_fail +// uses numbers of the wrong base + +0b0102; +0o0581; + +// bin, hex, and octal literals must have at least one digit + +0b_; +0b____; +``` + +#### Tuple index + +> **Lexer**\ +> TUPLE_INDEX: \ +>    INTEGER_LITERAL + +A tuple index is used to refer to the fields of [tuples], [tuple structs], and +[tuple variants]. + +Tuple indices are compared with the literal token directly. Tuple indices +start with `0` and each successive index increments the value by `1` as a +decimal value. Thus, only decimal values will match, and the value must not +have any extra `0` prefix characters. + +```rust,compile_fail +let example = ("dog", "cat", "horse"); +let dog = example.0; +let cat = example.1; +// The following examples are invalid. +let cat = example.01; // ERROR no field named `01` +let horse = example.0b10; // ERROR no field named `0b10` +``` + +> **Note**: The tuple index may include an `INTEGER_SUFFIX`, but this is not +> intended to be valid, and may be removed in a future version. See +> for more information. + +#### Floating-point literals + +> **Lexer**\ +> FLOAT_LITERAL :\ +>       DEC_LITERAL `.` +> _(not immediately followed by `.`, `_` or an XID_Start character)_\ +>    | DEC_LITERAL FLOAT_EXPONENT\ +>    | DEC_LITERAL `.` DEC_LITERAL FLOAT_EXPONENT?\ +>    | DEC_LITERAL (`.` DEC_LITERAL)? +> FLOAT_EXPONENT? FLOAT_SUFFIX +> +> FLOAT_EXPONENT :\ +>    (`e`|`E`) (`+`|`-`)? +> (DEC_DIGIT|`_`)\* DEC_DIGIT (DEC_DIGIT|`_`)\* +> +> FLOAT_SUFFIX :\ +>    `f32` | `f64` + +A _floating-point literal_ has one of three forms: + +* A _decimal literal_ followed by a period character `U+002E` (`.`). This is + optionally followed by another decimal literal, with an optional _exponent_. +* A single _decimal literal_ followed by an _exponent_. +* A single _decimal literal_ (in which case a suffix is required). + +Like integer literals, a floating-point literal may be followed by a +suffix, so long as the pre-suffix part does not end with `U+002E` (`.`). +There are two valid _floating-point suffixes_: `f32` and `f64` (the names of the 32-bit and 64-bit [primitive floating-point types][floating-point types]). +See [literal expressions] for the effect of these suffixes. + +Examples of floating-point literals of various forms: + +```rust +123.0f64; +0.1f64; +0.1f32; +12E+99_f64; +5f32; +let x: f64 = 2.; +``` + +This last example is different because it is not possible to use the suffix +syntax with a floating point literal ending in a period. `2.f64` would attempt +to call a method named `f64` on `2`. + +Note that `-1.0`, for example, is analyzed as two tokens: `-` followed by `1.0`. + +#### Number pseudoliterals + +> **Lexer**\ +> NUMBER_PSEUDOLITERAL :\ +>       DEC_LITERAL ( . DEC_LITERAL )? FLOAT_EXPONENT\ +>          ( NUMBER_PSEUDOLITERAL_SUFFIX | INTEGER_SUFFIX )\ +>    | DEC_LITERAL . DEC_LITERAL\ +>          ( NUMBER_PSEUDOLITERAL_SUFFIX_NO_E | INTEGER SUFFIX )\ +>    | DEC_LITERAL NUMBER_PSEUDOLITERAL_SUFFIX_NO_E\ +>    | ( BIN_LITERAL | OCT_LITERAL | HEX_LITERAL )\ +>          ( NUMBER_PSEUDOLITERAL_SUFFIX_NO_E | FLOAT_SUFFIX ) +> +> NUMBER_PSEUDOLITERAL_SUFFIX :\ +>    IDENTIFIER_OR_KEYWORD _not matching INTEGER_SUFFIX or FLOAT_SUFFIX_ +> +> NUMBER_PSEUDOLITERAL_SUFFIX_NO_E :\ +>    NUMBER_PSEUDOLITERAL_SUFFIX _not beginning with `e` or `E`_ + +Tokenization of numeric literals allows arbitrary suffixes as described in the grammar above. +These values generate valid tokens, but are not valid [literal expressions], so are usually an error except as macro arguments. + +Examples of such tokens: +```rust,compile_fail +0invalidSuffix; +123AFB43; +0b010a; +0xAB_CD_EF_GH; +2.0f80; +2e5f80; +2e5e6; +2.0e5e6; +1.3e10u64; +0b1111_f32; +``` + +#### Reserved forms similar to number literals + +> **Lexer**\ +> RESERVED_NUMBER :\ +>       BIN_LITERAL \[`2`-`9`​]\ +>    | OCT_LITERAL \[`8`-`9`​]\ +>    | ( BIN_LITERAL | OCT_LITERAL | HEX_LITERAL ) `.` \ +>          _(not immediately followed by `.`, `_` or an XID_Start character)_\ +>    | ( BIN_LITERAL | OCT_LITERAL ) `e`\ +>    | `0b` `_`\* _end of input or not BIN_DIGIT_\ +>    | `0o` `_`\* _end of input or not OCT_DIGIT_\ +>    | `0x` `_`\* _end of input or not HEX_DIGIT_\ +>    | DEC_LITERAL ( . DEC_LITERAL)? (`e`|`E`) (`+`|`-`)? _end of input or not DEC_DIGIT_ + +The following lexical forms similar to number literals are _reserved forms_. +Due to the possible ambiguity these raise, they are rejected by the tokenizer instead of being interpreted as separate tokens. + +* An unsuffixed binary or octal literal followed, without intervening whitespace, by a decimal digit out of the range for its radix. + +* An unsuffixed binary, octal, or hexadecimal literal followed, without intervening whitespace, by a period character (with the same restrictions on what follows the period as for floating-point literals). + +* An unsuffixed binary or octal literal followed, without intervening whitespace, by the character `e`. + +* Input which begins with one of the radix prefixes but is not a valid binary, octal, or hexadecimal literal (because it contains no digits). + +* Input which has the form of a floating-point literal with no digits in the exponent. + +Examples of reserved forms: + +```rust,compile_fail +0b0102; // this is not `0b010` followed by `2` +0o1279; // this is not `0o127` followed by `9` +0x80.0; // this is not `0x80` followed by `.` and `0` +0b101e; // this is not a pseudoliteral, or `0b101` followed by `e` +0b; // this is not a pseudoliteral, or `0` followed by `b` +0b_; // this is not a pseudoliteral, or `0` followed by `b_` +2e; // this is not a pseudoliteral, or `2` followed by `e` +2.0e; // this is not a pseudoliteral, or `2.0` followed by `e` +2em; // this is not a pseudoliteral, or `2` followed by `em` +2.0em; // this is not a pseudoliteral, or `2.0` followed by `em` +``` + +## Lifetimes and loop labels + +> **Lexer**\ +> LIFETIME_TOKEN :\ +>       `'` [IDENTIFIER_OR_KEYWORD][identifier]\ +>    | `'_` +> +> LIFETIME_OR_LABEL :\ +>       `'` [NON_KEYWORD_IDENTIFIER][identifier] + +Lifetime parameters and [loop labels] use LIFETIME_OR_LABEL tokens. Any +LIFETIME_TOKEN will be accepted by the lexer, and for example, can be used in +macros. + +## Punctuation + +Punctuation symbol tokens are listed here for completeness. Their individual +usages and meanings are defined in the linked pages. + +| Symbol | Name | Usage | +|--------|-------------|-------| +| `+` | Plus | [Addition][arith], [Trait Bounds], [Macro Kleene Matcher][macros] +| `-` | Minus | [Subtraction][arith], [Negation] +| `*` | Star | [Multiplication][arith], [Dereference], [Raw Pointers], [Macro Kleene Matcher][macros], [Use wildcards] +| `/` | Slash | [Division][arith] +| `%` | Percent | [Remainder][arith] +| `^` | Caret | [Bitwise and Logical XOR][arith] +| `!` | Not | [Bitwise and Logical NOT][negation], [Macro Calls][macros], [Inner Attributes][attributes], [Never Type], [Negative impls] +| `&` | And | [Bitwise and Logical AND][arith], [Borrow], [References], [Reference patterns] +| \| | Or | [Bitwise and Logical OR][arith], [Closures], Patterns in [match], [if let], and [while let] +| `&&` | AndAnd | [Lazy AND][lazy-bool], [Borrow], [References], [Reference patterns] +| \|\| | OrOr | [Lazy OR][lazy-bool], [Closures] +| `<<` | Shl | [Shift Left][arith], [Nested Generics][generics] +| `>>` | Shr | [Shift Right][arith], [Nested Generics][generics] +| `+=` | PlusEq | [Addition assignment][compound] +| `-=` | MinusEq | [Subtraction assignment][compound] +| `*=` | StarEq | [Multiplication assignment][compound] +| `/=` | SlashEq | [Division assignment][compound] +| `%=` | PercentEq | [Remainder assignment][compound] +| `^=` | CaretEq | [Bitwise XOR assignment][compound] +| `&=` | AndEq | [Bitwise And assignment][compound] +| \|= | OrEq | [Bitwise Or assignment][compound] +| `<<=` | ShlEq | [Shift Left assignment][compound] +| `>>=` | ShrEq | [Shift Right assignment][compound], [Nested Generics][generics] +| `=` | Eq | [Assignment], [Attributes], Various type definitions +| `==` | EqEq | [Equal][comparison] +| `!=` | Ne | [Not Equal][comparison] +| `>` | Gt | [Greater than][comparison], [Generics], [Paths] +| `<` | Lt | [Less than][comparison], [Generics], [Paths] +| `>=` | Ge | [Greater than or equal to][comparison], [Generics] +| `<=` | Le | [Less than or equal to][comparison] +| `@` | At | [Subpattern binding] +| `_` | Underscore | [Wildcard patterns], [Inferred types], Unnamed items in [constants], [extern crates], [use declarations], and [destructuring assignment] +| `.` | Dot | [Field access][field], [Tuple index] +| `..` | DotDot | [Range][range], [Struct expressions], [Patterns], [Range Patterns][rangepat] +| `...` | DotDotDot | [Variadic functions][extern], [Range patterns] +| `..=` | DotDotEq | [Inclusive Range][range], [Range patterns] +| `,` | Comma | Various separators +| `;` | Semi | Terminator for various items and statements, [Array types] +| `:` | Colon | Various separators +| `::` | PathSep | [Path separator][paths] +| `->` | RArrow | [Function return type][functions], [Closure return type][closures], [Function pointer type] +| `=>` | FatArrow | [Match arms][match], [Macros] +| `#` | Pound | [Attributes] +| `$` | Dollar | [Macros] +| `?` | Question | [Question mark operator][question], [Questionably sized][sized], [Macro Kleene Matcher][macros] +| `~` | Tilde | The tilde operator has been unused since before Rust 1.0, but its token may still be used + +## Delimiters + +Bracket punctuation is used in various parts of the grammar. An open bracket +must always be paired with a close bracket. Brackets and the tokens within +them are referred to as "token trees" in [macros]. The three types of brackets are: + +| Bracket | Type | +|---------|-----------------| +| `{` `}` | Curly braces | +| `[` `]` | Square brackets | +| `(` `)` | Parentheses | + +## Reserved prefixes + +> **Lexer 2021+**\ +> RESERVED_TOKEN_DOUBLE_QUOTE : ( IDENTIFIER_OR_KEYWORD _Except `b` or `r` or `br`_ | `_` ) `"`\ +> RESERVED_TOKEN_SINGLE_QUOTE : ( IDENTIFIER_OR_KEYWORD _Except `b`_ | `_` ) `'`\ +> RESERVED_TOKEN_POUND : ( IDENTIFIER_OR_KEYWORD _Except `r` or `br`_ | `_` ) `#` + +Some lexical forms known as _reserved prefixes_ are reserved for future use. + +Source input which would otherwise be lexically interpreted as a non-raw identifier (or a keyword or `_`) which is immediately followed by a `#`, `'`, or `"` character (without intervening whitespace) is identified as a reserved prefix. + +Note that raw identifiers, raw string literals, and raw byte string literals may contain a `#` character but are not interpreted as containing a reserved prefix. + +Similarly the `r`, `b`, and `br` prefixes used in raw string literals, byte literals, byte string literals, and raw byte string literals are not interpreted as reserved prefixes. + +> **Edition Differences**: Starting with the 2021 edition, reserved prefixes are reported as an error by the lexer (in particular, they cannot be passed to macros). +> +> Before the 2021 edition, a reserved prefixes are accepted by the lexer and interpreted as multiple tokens (for example, one token for the identifier or keyword, followed by a `#` token). +> +> Examples accepted in all editions: +> ```rust +> macro_rules! lexes {($($_:tt)*) => {}} +> lexes!{a #foo} +> lexes!{continue 'foo} +> lexes!{match "..." {}} +> lexes!{r#let#foo} // three tokens: r#let # foo +> ``` +> +> Examples accepted before the 2021 edition but rejected later: +> ```rust,edition2018 +> macro_rules! lexes {($($_:tt)*) => {}} +> lexes!{a#foo} +> lexes!{continue'foo} +> lexes!{match"..." {}} +> ``` + +[Inferred types]: types/inferred.md +[Range patterns]: patterns.md#range-patterns +[Reference patterns]: patterns.md#reference-patterns +[Subpattern binding]: patterns.md#identifier-patterns +[Wildcard patterns]: patterns.md#wildcard-pattern +[arith]: expressions/operator-expr.md#arithmetic-and-logical-binary-operators +[array types]: types/array.md +[assignment]: expressions/operator-expr.md#assignment-expressions +[attributes]: attributes.md +[borrow]: expressions/operator-expr.md#borrow-operators +[closures]: expressions/closure-expr.md +[comparison]: expressions/operator-expr.md#comparison-operators +[compound]: expressions/operator-expr.md#compound-assignment-expressions +[constants]: items/constant-items.md +[dereference]: expressions/operator-expr.md#the-dereference-operator +[destructuring assignment]: expressions/underscore-expr.md +[extern crates]: items/extern-crates.md +[extern]: items/external-blocks.md +[field]: expressions/field-expr.md +[floating-point types]: types/numeric.md#floating-point-types +[function pointer type]: types/function-pointer.md +[functions]: items/functions.md +[generics]: items/generics.md +[identifier]: identifiers.md +[if let]: expressions/if-expr.md#if-let-expressions +[keywords]: keywords.md +[lazy-bool]: expressions/operator-expr.md#lazy-boolean-operators +[literal expressions]: expressions/literal-expr.md +[loop labels]: expressions/loop-expr.md +[macros]: macros-by-example.md +[match]: expressions/match-expr.md +[negation]: expressions/operator-expr.md#negation-operators +[negative impls]: items/implementations.md +[never type]: types/never.md +[numeric types]: types/numeric.md +[paths]: paths.md +[patterns]: patterns.md +[question]: expressions/operator-expr.md#the-question-mark-operator +[range]: expressions/range-expr.md +[rangepat]: patterns.md#range-patterns +[raw pointers]: types/pointer.md#raw-pointers-const-and-mut +[references]: types/pointer.md +[sized]: trait-bounds.md#sized +[struct expressions]: expressions/struct-expr.md +[trait bounds]: trait-bounds.md +[tuple index]: expressions/tuple-expr.md#tuple-indexing-expressions +[tuple structs]: items/structs.md +[tuple variants]: items/enumerations.md +[tuples]: types/tuple.md +[unary minus operator]: expressions/operator-expr.md#negation-operators +[use declarations]: items/use-declarations.md +[use wildcards]: items/use-declarations.md +[while let]: expressions/loop-expr.md#predicate-pattern-loops diff --git a/src/doc/reference/src/trait-bounds.md b/src/doc/reference/src/trait-bounds.md new file mode 100644 index 000000000..f284ca4eb --- /dev/null +++ b/src/doc/reference/src/trait-bounds.md @@ -0,0 +1,176 @@ +# Trait and lifetime bounds + +> **Syntax**\ +> _TypeParamBounds_ :\ +>    _TypeParamBound_ ( `+` _TypeParamBound_ )\* `+`? +> +> _TypeParamBound_ :\ +>       _Lifetime_ | _TraitBound_ +> +> _TraitBound_ :\ +>       `?`? +> [_ForLifetimes_](#higher-ranked-trait-bounds)? [_TypePath_]\ +>    | `(` `?`? +> [_ForLifetimes_](#higher-ranked-trait-bounds)? [_TypePath_] `)` +> +> _LifetimeBounds_ :\ +>    ( _Lifetime_ `+` )\* _Lifetime_? +> +> _Lifetime_ :\ +>       [LIFETIME_OR_LABEL]\ +>    | `'static`\ +>    | `'_` + +[Trait] and lifetime bounds provide a way for [generic items][generic] to +restrict which types and lifetimes are used as their parameters. Bounds can be +provided on any type in a [where clause]. There are also shorter forms for +certain common cases: + +* Bounds written after declaring a [generic parameter][generic]: + `fn f() {}` is the same as `fn f where A: Copy () {}`. +* In trait declarations as [supertraits]: `trait Circle : Shape {}` is + equivalent to `trait Circle where Self : Shape {}`. +* In trait declarations as bounds on [associated types]: + `trait A { type B: Copy; }` is equivalent to + `trait A where Self::B: Copy { type B; }`. + +Bounds on an item must be satisfied when using the item. When type checking and +borrow checking a generic item, the bounds can be used to determine that a +trait is implemented for a type. For example, given `Ty: Trait` + +* In the body of a generic function, methods from `Trait` can be called on `Ty` + values. Likewise associated constants on the `Trait` can be used. +* Associated types from `Trait` can be used. +* Generic functions and types with a `T: Trait` bounds can be used with `Ty` + being used for `T`. + +```rust +# type Surface = i32; +trait Shape { + fn draw(&self, surface: Surface); + fn name() -> &'static str; +} + +fn draw_twice(surface: Surface, sh: T) { + sh.draw(surface); // Can call method because T: Shape + sh.draw(surface); +} + +fn copy_and_draw_twice(surface: Surface, sh: T) where T: Shape { + let shape_copy = sh; // doesn't move sh because T: Copy + draw_twice(surface, sh); // Can use generic function because T: Shape +} + +struct Figure(S, S); + +fn name_figure( + figure: Figure, // Type Figure is well-formed because U: Shape +) { + println!( + "Figure of two {}", + U::name(), // Can use associated function + ); +} +``` + +Bounds that don't use the item's parameters or [higher-ranked lifetimes] are checked when the item is defined. +It is an error for such a bound to be false. + +[`Copy`], [`Clone`], and [`Sized`] bounds are also checked for certain generic types when using the item, even if the use does not provide a concrete type. +It is an error to have `Copy` or `Clone` as a bound on a mutable reference, [trait object], or [slice]. +It is an error to have `Sized` as a bound on a trait object or slice. + +```rust,compile_fail +struct A<'a, T> +where + i32: Default, // Allowed, but not useful + i32: Iterator, // Error: `i32` is not an iterator + &'a mut T: Copy, // (at use) Error: the trait bound is not satisfied + [T]: Sized, // (at use) Error: size cannot be known at compilation +{ + f: &'a T, +} +struct UsesA<'a, T>(A<'a, T>); +``` + +Trait and lifetime bounds are also used to name [trait objects]. + +## `?Sized` + +`?` is only used to relax the implicit [`Sized`] trait bound for [type parameters] or [associated types]. +`?Sized` may not be used as a bound for other types. + +## Lifetime bounds + +Lifetime bounds can be applied to types or to other lifetimes. +The bound `'a: 'b` is usually read as `'a` *outlives* `'b`. +`'a: 'b` means that `'a` lasts at least as long as `'b`, so a reference `&'a ()` is valid whenever `&'b ()` is valid. + +```rust +fn f<'a, 'b>(x: &'a i32, mut y: &'b i32) where 'a: 'b { + y = x; // &'a i32 is a subtype of &'b i32 because 'a: 'b + let r: &'b &'a i32 = &&0; // &'b &'a i32 is well formed because 'a: 'b +} +``` + +`T: 'a` means that all lifetime parameters of `T` outlive `'a`. +For example, if `'a` is an unconstrained lifetime parameter, then `i32: 'static` and `&'static str: 'a` are satisfied, but `Vec<&'a ()>: 'static` is not. + +## Higher-ranked trait bounds + +> _ForLifetimes_ :\ +>    `for` [_GenericParams_] + +Type bounds may be *higher ranked* over lifetimes. These bounds specify a bound +that is true *for all* lifetimes. For example, a bound such as `for<'a> &'a T: +PartialEq` would require an implementation like + +```rust +# struct T; +impl<'a> PartialEq for &'a T { + // ... +# fn eq(&self, other: &i32) -> bool {true} +} +``` + +and could then be used to compare a `&'a T` with any lifetime to an `i32`. + +Only a higher-ranked bound can be used here, because the lifetime of the reference is shorter than any possible lifetime parameter on the function: + +```rust +fn call_on_ref_zero(f: F) where for<'a> F: Fn(&'a i32) { + let zero = 0; + f(&zero); +} +``` + +Higher-ranked lifetimes may also be specified just before the trait: the only +difference is the scope of the lifetime parameter, which extends only to the +end of the following trait instead of the whole bound. This function is +equivalent to the last one. + +```rust +fn call_on_ref_zero(f: F) where F: for<'a> Fn(&'a i32) { + let zero = 0; + f(&zero); +} +``` + +[LIFETIME_OR_LABEL]: tokens.md#lifetimes-and-loop-labels +[_GenericParams_]: items/generics.md +[_TypePath_]: paths.md#paths-in-types +[`Clone`]: special-types-and-traits.md#clone +[`Copy`]: special-types-and-traits.md#copy +[`Sized`]: special-types-and-traits.md#sized + +[arrays]: types/array.md +[associated types]: items/associated-items.md#associated-types +[supertraits]: items/traits.md#supertraits +[generic]: items/generics.md +[higher-ranked lifetimes]: #higher-ranked-trait-bounds +[slice]: types/slice.md +[Trait]: items/traits.md#trait-bounds +[trait object]: types/trait-object.md +[trait objects]: types/trait-object.md +[type parameters]: types/parameters.md +[where clause]: items/generics.md#where-clauses diff --git a/src/doc/reference/src/type-coercions.md b/src/doc/reference/src/type-coercions.md new file mode 100644 index 000000000..45d81d386 --- /dev/null +++ b/src/doc/reference/src/type-coercions.md @@ -0,0 +1,275 @@ +# Type coercions + +**Type coercions** are implicit operations that change the type of a value. +They happen automatically at specific locations and are highly restricted in +what types actually coerce. + +Any conversions allowed by coercion can also be explicitly performed by the +[type cast operator], `as`. + +Coercions are originally defined in [RFC 401] and expanded upon in [RFC 1558]. + +## Coercion sites + +A coercion can only occur at certain coercion sites in a program; these are +typically places where the desired type is explicit or can be derived by +propagation from explicit types (without type inference). Possible coercion +sites are: + +* `let` statements where an explicit type is given. + + For example, `&mut 42` is coerced to have type `&i8` in the following: + + ```rust + let _: &i8 = &mut 42; + ``` + +* `static` and `const` item declarations (similar to `let` statements). + +* Arguments for function calls + + The value being coerced is the actual parameter, and it is coerced to + the type of the formal parameter. + + For example, `&mut 42` is coerced to have type `&i8` in the following: + + ```rust + fn bar(_: &i8) { } + + fn main() { + bar(&mut 42); + } + ``` + + For method calls, the receiver (`self` parameter) can only take advantage + of [unsized coercions](#unsized-coercions). + +* Instantiations of struct, union, or enum variant fields + + For example, `&mut 42` is coerced to have type `&i8` in the following: + + ```rust + struct Foo<'a> { x: &'a i8 } + + fn main() { + Foo { x: &mut 42 }; + } + ``` + +* Function results—either the final line of a block if it is not + semicolon-terminated or any expression in a `return` statement + + For example, `x` is coerced to have type `&dyn Display` in the following: + + ```rust + use std::fmt::Display; + fn foo(x: &u32) -> &dyn Display { + x + } + ``` + +If the expression in one of these coercion sites is a coercion-propagating +expression, then the relevant sub-expressions in that expression are also +coercion sites. Propagation recurses from these new coercion sites. +Propagating expressions and their relevant sub-expressions are: + +* Array literals, where the array has type `[U; n]`. Each sub-expression in +the array literal is a coercion site for coercion to type `U`. + +* Array literals with repeating syntax, where the array has type `[U; n]`. The +repeated sub-expression is a coercion site for coercion to type `U`. + +* Tuples, where a tuple is a coercion site to type `(U_0, U_1, ..., U_n)`. +Each sub-expression is a coercion site to the respective type, e.g. the +zeroth sub-expression is a coercion site to type `U_0`. + +* Parenthesized sub-expressions (`(e)`): if the expression has type `U`, then +the sub-expression is a coercion site to `U`. + +* Blocks: if a block has type `U`, then the last expression in the block (if +it is not semicolon-terminated) is a coercion site to `U`. This includes +blocks which are part of control flow statements, such as `if`/`else`, if +the block has a known type. + +## Coercion types + +Coercion is allowed between the following types: + +* `T` to `U` if `T` is a [subtype] of `U` (*reflexive case*) + +* `T_1` to `T_3` where `T_1` coerces to `T_2` and `T_2` coerces to `T_3` +(*transitive case*) + + Note that this is not fully supported yet. + +* `&mut T` to `&T` + +* `*mut T` to `*const T` + +* `&T` to `*const T` + +* `&mut T` to `*mut T` + +* `&T` or `&mut T` to `&U` if `T` implements `Deref`. For example: + + ```rust + use std::ops::Deref; + + struct CharContainer { + value: char, + } + + impl Deref for CharContainer { + type Target = char; + + fn deref<'a>(&'a self) -> &'a char { + &self.value + } + } + + fn foo(arg: &char) {} + + fn main() { + let x = &mut CharContainer { value: 'y' }; + foo(x); //&mut CharContainer is coerced to &char. + } + ``` + +* `&mut T` to `&mut U` if `T` implements `DerefMut`. + +* TyCtor(`T`) to TyCtor(`U`), where TyCtor(`T`) is one of + - `&T` + - `&mut T` + - `*const T` + - `*mut T` + - `Box` + + and where `U` can be obtained from `T` by [unsized coercion](#unsized-coercions). + + + +* Function item types to `fn` pointers + +* Non capturing closures to `fn` pointers + +* `!` to any `T` + +### Unsized Coercions + +The following coercions are called `unsized coercions`, since they +relate to converting sized types to unsized types, and are permitted in a few +cases where other coercions are not, as described above. They can still happen +anywhere else a coercion can occur. + +Two traits, [`Unsize`] and [`CoerceUnsized`], are used +to assist in this process and expose it for library use. The following +coercions are built-ins and, if `T` can be coerced to `U` with one of them, then +an implementation of `Unsize` for `T` will be provided: + +* `[T; n]` to `[T]`. + +* `T` to `dyn U`, when `T` implements `U + Sized`, and `U` is [object safe]. + +* `Foo<..., T, ...>` to `Foo<..., U, ...>`, when: + * `Foo` is a struct. + * `T` implements `Unsize`. + * The last field of `Foo` has a type involving `T`. + * If that field has type `Bar`, then `Bar` implements `Unsized>`. + * T is not part of the type of any other fields. + +Additionally, a type `Foo` can implement `CoerceUnsized>` when `T` +implements `Unsize` or `CoerceUnsized>`. This allows it to provide a +unsized coercion to `Foo`. + +> Note: While the definition of the unsized coercions and their implementation +> has been stabilized, the traits themselves are not yet stable and therefore +> can't be used directly in stable Rust. + +## Least upper bound coercions + +In some contexts, the compiler must coerce together multiple types to try and +find the most general type. This is called a "Least Upper Bound" coercion. +LUB coercion is used and only used in the following situations: + ++ To find the common type for a series of if branches. ++ To find the common type for a series of match arms. ++ To find the common type for array elements. ++ To find the type for the return type of a closure with multiple return statements. ++ To check the type for the return type of a function with multiple return statements. + +In each such case, there are a set of types `T0..Tn` to be mutually coerced +to some target type `T_t`, which is unknown to start. Computing the LUB +coercion is done iteratively. The target type `T_t` begins as the type `T0`. +For each new type `Ti`, we consider whether + ++ If `Ti` can be coerced to the current target type `T_t`, then no change is made. ++ Otherwise, check whether `T_t` can be coerced to `Ti`; if so, the `T_t` is +changed to `Ti`. (This check is also conditioned on whether all of the source +expressions considered thus far have implicit coercions.) ++ If not, try to compute a mutual supertype of `T_t` and `Ti`, which will become the new target type. + +### Examples: + +```rust +# let (a, b, c) = (0, 1, 2); +// For if branches +let bar = if true { + a +} else if false { + b +} else { + c +}; + +// For match arms +let baw = match 42 { + 0 => a, + 1 => b, + _ => c, +}; + +// For array elements +let bax = [a, b, c]; + +// For closure with multiple return statements +let clo = || { + if true { + a + } else if false { + b + } else { + c + } +}; +let baz = clo(); + +// For type checking of function with multiple return statements +fn foo() -> i32 { + let (a, b, c) = (0, 1, 2); + match 42 { + 0 => a, + 1 => b, + _ => c, + } +} +``` + +In these examples, types of the `ba*` are found by LUB coercion. And the +compiler checks whether LUB coercion result of `a`, `b`, `c` is `i32` in the +processing of the function `foo`. + +### Caveat + +This description is obviously informal. Making it more precise is expected to +proceed as part of a general effort to specify the Rust type checker more +precisely. + +[RFC 401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md +[RFC 1558]: https://github.com/rust-lang/rfcs/blob/master/text/1558-closure-to-fn-coercion.md +[subtype]: subtyping.md +[object safe]: items/traits.md#object-safety +[type cast operator]: expressions/operator-expr.md#type-cast-expressions +[`Unsize`]: ../std/marker/trait.Unsize.html +[`CoerceUnsized`]: ../std/ops/trait.CoerceUnsized.html diff --git a/src/doc/reference/src/type-layout.md b/src/doc/reference/src/type-layout.md new file mode 100644 index 000000000..ce9296662 --- /dev/null +++ b/src/doc/reference/src/type-layout.md @@ -0,0 +1,578 @@ +# Type Layout + +The layout of a type is its size, alignment, and the relative offsets of its +fields. For enums, how the discriminant is laid out and interpreted is also part +of type layout. + +Type layout can be changed with each compilation. Instead of trying to document +exactly what is done, we only document what is guaranteed today. + +## Size and Alignment + +All values have an alignment and size. + +The *alignment* of a value specifies what addresses are valid to store the value +at. A value of alignment `n` must only be stored at an address that is a +multiple of n. For example, a value with an alignment of 2 must be stored at an +even address, while a value with an alignment of 1 can be stored at any address. +Alignment is measured in bytes, and must be at least 1, and always a power of 2. +The alignment of a value can be checked with the [`align_of_val`] function. + +The *size* of a value is the offset in bytes between successive elements in an +array with that item type including alignment padding. The size of a value is +always a multiple of its alignment. The size of a value can be checked with the +[`size_of_val`] function. + +Types where all values have the same size and alignment, and both are known at +compile time, implement the [`Sized`] trait and can be checked with the +[`size_of`] and [`align_of`] functions. Types that are not [`Sized`] are known +as [dynamically sized types]. Since all values of a `Sized` type share the same +size and alignment, we refer to those shared values as the size of the type and +the alignment of the type respectively. + +## Primitive Data Layout + +The size of most primitives is given in this table. + +| Type | `size_of::()`| +|-- |-- | +| `bool` | 1 | +| `u8` / `i8` | 1 | +| `u16` / `i16` | 2 | +| `u32` / `i32` | 4 | +| `u64` / `i64` | 8 | +| `u128` / `i128` | 16 | +| `f32` | 4 | +| `f64` | 8 | +| `char` | 4 | + +`usize` and `isize` have a size big enough to contain every address on the +target platform. For example, on a 32 bit target, this is 4 bytes and on a 64 +bit target, this is 8 bytes. + +Most primitives are generally aligned to their size, although this is +platform-specific behavior. In particular, on x86 u64 and f64 are only +aligned to 32 bits. + +## Pointers and References Layout + +Pointers and references have the same layout. Mutability of the pointer or +reference does not change the layout. + +Pointers to sized types have the same size and alignment as `usize`. + +Pointers to unsized types are sized. The size and alignment is guaranteed to be +at least equal to the size and alignment of a pointer. + +> Note: Though you should not rely on this, all pointers to +> DSTs are currently twice the +> size of the size of `usize` and have the same alignment. + +## Array Layout + +An array of `[T; N]` has a size of `size_of::() * N` and the same alignment +of `T`. Arrays are laid out so that the zero-based `nth` element of the array +is offset from the start of the array by `n * size_of::()` bytes. + +## Slice Layout + +Slices have the same layout as the section of the array they slice. + +> Note: This is about the raw `[T]` type, not pointers (`&[T]`, `Box<[T]>`, +> etc.) to slices. + +## `str` Layout +String slices are a UTF-8 representation of characters that have the same layout as slices of type `[u8]`. + +## Tuple Layout + +Tuples do not have any guarantees about their layout. + +The exception to this is the unit tuple (`()`) which is guaranteed as a +zero-sized type to have a size of 0 and an alignment of 1. + +## Trait Object Layout + +Trait objects have the same layout as the value the trait object is of. + +> Note: This is about the raw trait object types, not pointers (`&dyn Trait`, +> `Box`, etc.) to trait objects. + +## Closure Layout + +Closures have no layout guarantees. + +## Representations + +All user-defined composite types (`struct`s, `enum`s, and `union`s) have a +*representation* that specifies what the layout is for the type. The possible +representations for a type are: + +- [Default] +- [`C`] +- The [primitive representations] +- [`transparent`] + +The representation of a type can be changed by applying the `repr` attribute +to it. The following example shows a struct with a `C` representation. + +```rust +#[repr(C)] +struct ThreeInts { + first: i16, + second: i8, + third: i32 +} +``` + +The alignment may be raised or lowered with the `align` and `packed` modifiers +respectively. They alter the representation specified in the attribute. +If no representation is specified, the default one is altered. + +```rust +// Default representation, alignment lowered to 2. +#[repr(packed(2))] +struct PackedStruct { + first: i16, + second: i8, + third: i32 +} + +// C representation, alignment raised to 8 +#[repr(C, align(8))] +struct AlignedStruct { + first: i16, + second: i8, + third: i32 +} +``` + +> Note: As a consequence of the representation being an attribute on the item, +> the representation does not depend on generic parameters. Any two types with +> the same name have the same representation. For example, `Foo` and +> `Foo` both have the same representation. + +The representation of a type can change the padding between fields, but does +not change the layout of the fields themselves. For example, a struct with a +`C` representation that contains a struct `Inner` with the default +representation will not change the layout of `Inner`. + +### The Default Representation + +Nominal types without a `repr` attribute have the default representation. +Informally, this representation is also called the `rust` representation. + +There are no guarantees of data layout made by this representation. + +### The `C` Representation + +The `C` representation is designed for dual purposes. One purpose is for +creating types that are interoperable with the C Language. The second purpose is +to create types that you can soundly perform operations on that rely on data +layout such as reinterpreting values as a different type. + +Because of this dual purpose, it is possible to create types that are not useful +for interfacing with the C programming language. + +This representation can be applied to structs, unions, and enums. The exception +is [zero-variant enums] for which the `C` representation is an error. + +#### `#[repr(C)]` Structs + +The alignment of the struct is the alignment of the most-aligned field in it. + +The size and offset of fields is determined by the following algorithm. + +Start with a current offset of 0 bytes. + +For each field in declaration order in the struct, first determine the size and +alignment of the field. If the current offset is not a multiple of the field's +alignment, then add padding bytes to the current offset until it is a multiple +of the field's alignment. The offset for the field is what the current offset +is now. Then increase the current offset by the size of the field. + +Finally, the size of the struct is the current offset rounded up to the nearest +multiple of the struct's alignment. + +Here is this algorithm described in pseudocode. + + +```rust,ignore +/// Returns the amount of padding needed after `offset` to ensure that the +/// following address will be aligned to `alignment`. +fn padding_needed_for(offset: usize, alignment: usize) -> usize { + let misalignment = offset % alignment; + if misalignment > 0 { + // round up to next multiple of `alignment` + alignment - misalignment + } else { + // already a multiple of `alignment` + 0 + } +} + +struct.alignment = struct.fields().map(|field| field.alignment).max(); + +let current_offset = 0; + +for field in struct.fields_in_declaration_order() { + // Increase the current offset so that it's a multiple of the alignment + // of this field. For the first field, this will always be zero. + // The skipped bytes are called padding bytes. + current_offset += padding_needed_for(current_offset, field.alignment); + + struct[field].offset = current_offset; + + current_offset += field.size; +} + +struct.size = current_offset + padding_needed_for(current_offset, struct.alignment); +``` + +