The following list contains keywords that are reserved for current or future
+use by the Rust language. As such, they cannot be used as identifiers (except
+as raw identifiers as we’ll discuss in the “Raw
+Identifiers” section). Identifiers are names
+of functions, variables, parameters, struct fields, modules, crates, constants,
+macros, static values, attributes, types, traits, or lifetimes.
Raw identifiers are the syntax that lets you use keywords where they wouldn’t
+normally be allowed. You use a raw identifier by prefixing a keyword with r#.
+
For example, match is a keyword. If you try to compile the following function
+that uses match as its name:
The error shows that you can’t use the keyword match as the function
+identifier. To use match as a function name, you need to use the raw
+identifier syntax, like this:
This code will compile without any errors. Note the r# prefix on the function
+name in its definition as well as where the function is called in main.
+
Raw identifiers allow you to use any word you choose as an identifier, even if
+that word happens to be a reserved keyword. This gives us more freedom to
+choose identifier names, as well as lets us integrate with programs written in
+a language where these words aren’t keywords. In addition, raw identifiers
+allow you to use libraries written in a different Rust edition than your crate
+uses. For example, try isn’t a keyword in the 2015 edition but is in the 2018
+edition. If you depend on a library that’s written using the 2015 edition and
+has a try function, you’ll need to use the raw identifier syntax, r#try in
+this case, to call that function from your 2018 edition code. See Appendix
+E for more information on editions.
This appendix contains a glossary of Rust’s syntax, including operators and
+other symbols that appear by themselves or in the context of paths, generics,
+trait bounds, macros, attributes, comments, tuples, and brackets.
Table B-1 contains the operators in Rust, an example of how the operator would
+appear in context, a short explanation, and whether that operator is
+overloadable. If an operator is overloadable, the relevant trait to use to
+overload that operator is listed.
+
Table B-1: Operators
+
Operator
Example
Explanation
Overloadable?
+
!
ident!(...), ident!{...}, ident![...]
Macro expansion
+
!
!expr
Bitwise or logical complement
Not
+
!=
expr != expr
Nonequality comparison
PartialEq
+
%
expr % expr
Arithmetic remainder
Rem
+
%=
var %= expr
Arithmetic remainder and assignment
RemAssign
+
&
&expr, &mut expr
Borrow
+
&
&type, &mut type, &'a type, &'a mut type
Borrowed pointer type
+
&
expr & expr
Bitwise AND
BitAnd
+
&=
var &= expr
Bitwise AND and assignment
BitAndAssign
+
&&
expr && expr
Short-circuiting logical AND
+
*
expr * expr
Arithmetic multiplication
Mul
+
*=
var *= expr
Arithmetic multiplication and assignment
MulAssign
+
*
*expr
Dereference
Deref
+
*
*const type, *mut type
Raw pointer
+
+
trait + trait, 'a + trait
Compound type constraint
+
+
expr + expr
Arithmetic addition
Add
+
+=
var += expr
Arithmetic addition and assignment
AddAssign
+
,
expr, expr
Argument and element separator
+
-
- expr
Arithmetic negation
Neg
+
-
expr - expr
Arithmetic subtraction
Sub
+
-=
var -= expr
Arithmetic subtraction and assignment
SubAssign
+
->
fn(...) -> type, |…| -> type
Function and closure return type
+
.
expr.ident
Member access
+
..
.., expr.., ..expr, expr..expr
Right-exclusive range literal
PartialOrd
+
..=
..=expr, expr..=expr
Right-inclusive range literal
PartialOrd
+
..
..expr
Struct literal update syntax
+
..
variant(x, ..), struct_type { x, .. }
“And the rest” pattern binding
+
...
expr...expr
(Deprecated, use ..= instead) In a pattern: inclusive range pattern
In various places in the book, we’ve discussed the derive attribute, which
+you can apply to a struct or enum definition. The derive attribute generates
+code that will implement a trait with its own default implementation on the
+type you’ve annotated with the derive syntax.
+
In this appendix, we provide a reference of all the traits in the standard
+library that you can use with derive. Each section covers:
+
+
What operators and methods deriving this trait will enable
+
What the implementation of the trait provided by derive does
+
What implementing the trait signifies about the type
+
The conditions in which you’re allowed or not allowed to implement the trait
+
Examples of operations that require the trait
+
+
If you want different behavior from that provided by the derive attribute,
+consult the standard library documentation
+for each trait for details of how to manually implement them.
+
These traits listed here are the only ones defined by the standard library that
+can be implemented on your types using derive. Other traits defined in the
+standard library don’t have sensible default behavior, so it’s up to you to
+implement them in the way that makes sense for what you’re trying to accomplish.
+
An example of a trait that can’t be derived is Display, which handles
+formatting for end users. You should always consider the appropriate way to
+display a type to an end user. What parts of the type should an end user be
+allowed to see? What parts would they find relevant? What format of the data
+would be most relevant to them? The Rust compiler doesn’t have this insight, so
+it can’t provide appropriate default behavior for you.
+
The list of derivable traits provided in this appendix is not comprehensive:
+libraries can implement derive for their own traits, making the list of
+traits you can use derive with truly open-ended. Implementing derive
+involves using a procedural macro, which is covered in the
+“Macros” section of Chapter 19.
The Debug trait enables debug formatting in format strings, which you
+indicate by adding :? within {} placeholders.
+
The Debug trait allows you to print instances of a type for debugging
+purposes, so you and other programmers using your type can inspect an instance
+at a particular point in a program’s execution.
+
The Debug trait is required, for example, in using the assert_eq! macro.
+This macro prints the values of instances given as arguments if the equality
+assertion fails so programmers can see why the two instances weren’t equal.
The PartialEq trait allows you to compare instances of a type to check for
+equality and enables use of the == and != operators.
+
Deriving PartialEq implements the eq method. When PartialEq is derived on
+structs, two instances are equal only if all fields are equal, and the
+instances are not equal if any fields are not equal. When derived on enums,
+each variant is equal to itself and not equal to the other variants.
+
The PartialEq trait is required, for example, with the use of the
+assert_eq! macro, which needs to be able to compare two instances of a type
+for equality.
+
The Eq trait has no methods. Its purpose is to signal that for every value of
+the annotated type, the value is equal to itself. The Eq trait can only be
+applied to types that also implement PartialEq, although not all types that
+implement PartialEq can implement Eq. One example of this is floating point
+number types: the implementation of floating point numbers states that two
+instances of the not-a-number (NaN) value are not equal to each other.
+
An example of when Eq is required is for keys in a HashMap<K, V> so the
+HashMap<K, V> can tell whether two keys are the same.
The PartialOrd trait allows you to compare instances of a type for sorting
+purposes. A type that implements PartialOrd can be used with the <, >,
+<=, and >= operators. You can only apply the PartialOrd trait to types
+that also implement PartialEq.
+
Deriving PartialOrd implements the partial_cmp method, which returns an
+Option<Ordering> that will be None when the values given don’t produce an
+ordering. An example of a value that doesn’t produce an ordering, even though
+most values of that type can be compared, is the not-a-number (NaN) floating
+point value. Calling partial_cmp with any floating point number and the NaN
+floating point value will return None.
+
When derived on structs, PartialOrd compares two instances by comparing the
+value in each field in the order in which the fields appear in the struct
+definition. When derived on enums, variants of the enum declared earlier in the
+enum definition are considered less than the variants listed later.
+
The PartialOrd trait is required, for example, for the gen_range method
+from the rand crate that generates a random value in the range specified by a
+range expression.
+
The Ord trait allows you to know that for any two values of the annotated
+type, a valid ordering will exist. The Ord trait implements the cmp method,
+which returns an Ordering rather than an Option<Ordering> because a valid
+ordering will always be possible. You can only apply the Ord trait to types
+that also implement PartialOrd and Eq (and Eq requires PartialEq). When
+derived on structs and enums, cmp behaves the same way as the derived
+implementation for partial_cmp does with PartialOrd.
+
An example of when Ord is required is when storing values in a BTreeSet<T>,
+a data structure that stores data based on the sort order of the values.
The Clone trait allows you to explicitly create a deep copy of a value, and
+the duplication process might involve running arbitrary code and copying heap
+data. See the “Ways Variables and Data Interact:
+Clone” section in
+Chapter 4 for more information on Clone.
+
Deriving Clone implements the clone method, which when implemented for the
+whole type, calls clone on each of the parts of the type. This means all the
+fields or values in the type must also implement Clone to derive Clone.
+
An example of when Clone is required is when calling the to_vec method on a
+slice. The slice doesn’t own the type instances it contains, but the vector
+returned from to_vec will need to own its instances, so to_vec calls
+clone on each item. Thus, the type stored in the slice must implement Clone.
+
The Copy trait allows you to duplicate a value by only copying bits stored on
+the stack; no arbitrary code is necessary. See the “Stack-Only Data:
+Copy” section in Chapter 4 for more
+information on Copy.
+
The Copy trait doesn’t define any methods to prevent programmers from
+overloading those methods and violating the assumption that no arbitrary code
+is being run. That way, all programmers can assume that copying a value will be
+very fast.
+
You can derive Copy on any type whose parts all implement Copy. A type that
+implements Copy must also implement Clone, because a type that implements
+Copy has a trivial implementation of Clone that performs the same task as
+Copy.
+
The Copy trait is rarely required; types that implement Copy have
+optimizations available, meaning you don’t have to call clone, which makes
+the code more concise.
+
Everything possible with Copy you can also accomplish with Clone, but the
+code might be slower or have to use clone in places.
The Hash trait allows you to take an instance of a type of arbitrary size and
+map that instance to a value of fixed size using a hash function. Deriving
+Hash implements the hash method. The derived implementation of the hash
+method combines the result of calling hash on each of the parts of the type,
+meaning all fields or values must also implement Hash to derive Hash.
+
An example of when Hash is required is in storing keys in a HashMap<K, V>
+to store data efficiently.
The Default trait allows you to create a default value for a type. Deriving
+Default implements the default function. The derived implementation of the
+default function calls the default function on each part of the type,
+meaning all fields or values in the type must also implement Default to
+derive Default.
+
The Default::default function is commonly used in combination with the struct
+update syntax discussed in the “Creating Instances From Other Instances With
+Struct Update
+Syntax”
+section in Chapter 5. You can customize a few fields of a struct and then
+set and use a default value for the rest of the fields by using
+..Default::default().
+
The Default trait is required when you use the method unwrap_or_default on
+Option<T> instances, for example. If the Option<T> is None, the method
+unwrap_or_default will return the result of Default::default for the type
+T stored in the Option<T>.
In this appendix, we talk about some useful development tools that the Rust
+project provides. We’ll look at automatic formatting, quick ways to apply
+warning fixes, a linter, and integrating with IDEs.
The rustfmt tool reformats your code according to the community code style.
+Many collaborative projects use rustfmt to prevent arguments about which
+style to use when writing Rust: everyone formats their code using the tool.
+
To install rustfmt, enter the following:
+
$ rustup component add rustfmt
+
+
This command gives you rustfmt and cargo-fmt, similar to how Rust gives you
+both rustc and cargo. To format any Cargo project, enter the following:
+
$ cargo fmt
+
+
Running this command reformats all the Rust code in the current crate. This
+should only change the code style, not the code semantics. For more information
+on rustfmt, see its documentation.
The rustfix tool is included with Rust installations and can automatically fix
+compiler warnings that have a clear way to correct the problem that’s likely
+what you want. It’s likely you’ve seen compiler warnings before. For example,
+consider this code:
+
Filename: src/main.rs
+
fn do_something() {}
+
+fn main() {
+ for i in 0..100 {
+ do_something();
+ }
+}
+
Here, we’re calling the do_something function 100 times, but we never use the
+variable i in the body of the for loop. Rust warns us about that:
+
$ cargo build
+ Compiling myprogram v0.1.0 (file:///projects/myprogram)
+warning: unused variable: `i`
+ --> src/main.rs:4:9
+ |
+4 | for i in 0..100 {
+ | ^ help: consider using `_i` instead
+ |
+ = note: #[warn(unused_variables)] on by default
+
+ Finished dev [unoptimized + debuginfo] target(s) in 0.50s
+
+
The warning suggests that we use _i as a name instead: the underscore
+indicates that we intend for this variable to be unused. We can automatically
+apply that suggestion using the rustfix tool by running the command cargo fix:
The Clippy tool is a collection of lints to analyze your code so you can catch
+common mistakes and improve your Rust code.
+
To install Clippy, enter the following:
+
$ rustup component add clippy
+
+
To run Clippy’s lints on any Cargo project, enter the following:
+
$ cargo clippy
+
+
For example, say you write a program that uses an approximation of a
+mathematical constant, such as pi, as this program does:
+
Filename: src/main.rs
+
fn main() {
+ let x = 3.1415;
+ let r = 8.0;
+ println!("the area of the circle is {}", x * r * r);
+}
+
Running cargo clippy on this project results in this error:
+
error: approximate value of `f{32, 64}::consts::PI` found
+ --> src/main.rs:2:13
+ |
+2 | let x = 3.1415;
+ | ^^^^^^
+ |
+ = note: `#[deny(clippy::approx_constant)]` on by default
+ = help: consider using the constant directly
+ = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#approx_constant
+
+
This error lets you know that Rust already has a more precise PI constant
+defined, and that your program would be more correct if you used the constant
+instead. You would then change your code to use the PI constant. The
+following code doesn’t result in any errors or warnings from Clippy:
+
Filename: src/main.rs
+
fn main() {
+ let x = std::f64::consts::PI;
+ let r = 8.0;
+ println!("the area of the circle is {}", x * r * r);
+}
To help IDE integration, the Rust community recommends using
+rust-analyzer. This tool is a set of
+compiler-centric utilities that speaks the Language Server Protocol, which is a specification for IDEs and programming languages to
+communicate with each other. Different clients can use rust-analyzer, such as
+the Rust analyzer plug-in for Visual Studio Code.
+
Visit the rust-analyzer project’s home page
+for installation instructions, then install the language server support in your
+particular IDE. Your IDE will gain abilities such as autocompletion, jump to
+definition, and inline errors.
In Chapter 1, you saw that cargo new adds a bit of metadata to your
+Cargo.toml file about an edition. This appendix talks about what that means!
+
The Rust language and compiler have a six-week release cycle, meaning users get
+a constant stream of new features. Other programming languages release larger
+changes less often; Rust releases smaller updates more frequently. After a
+while, all of these tiny changes add up. But from release to release, it can be
+difficult to look back and say, “Wow, between Rust 1.10 and Rust 1.31, Rust has
+changed a lot!”
+
Every two or three years, the Rust team produces a new Rust edition. Each
+edition brings together the features that have landed into a clear package with
+fully updated documentation and tooling. New editions ship as part of the usual
+six-week release process.
+
Editions serve different purposes for different people:
+
+
For active Rust users, a new edition brings together incremental changes into
+an easy-to-understand package.
+
For non-users, a new edition signals that some major advancements have
+landed, which might make Rust worth another look.
+
For those developing Rust, a new edition provides a rallying point for the
+project as a whole.
+
+
At the time of this writing, three Rust editions are available: Rust 2015, Rust
+2018, and Rust 2021. This book is written using Rust 2021 edition idioms.
+
The edition key in Cargo.toml indicates which edition the compiler should
+use for your code. If the key doesn’t exist, Rust uses 2015 as the edition
+value for backward compatibility reasons.
+
Each project can opt in to an edition other than the default 2015 edition.
+Editions can contain incompatible changes, such as including a new keyword that
+conflicts with identifiers in code. However, unless you opt in to those
+changes, your code will continue to compile even as you upgrade the Rust
+compiler version you use.
+
All Rust compiler versions support any edition that existed prior to that
+compiler’s release, and they can link crates of any supported editions
+together. Edition changes only affect the way the compiler initially parses
+code. Therefore, if you’re using Rust 2015 and one of your dependencies uses
+Rust 2018, your project will compile and be able to use that dependency. The
+opposite situation, where your project uses Rust 2018 and a dependency uses
+Rust 2015, works as well.
+
To be clear: most features will be available on all editions. Developers using
+any Rust edition will continue to see improvements as new stable releases are
+made. However, in some cases, mainly when new keywords are added, some new
+features might only be available in later editions. You will need to switch
+editions if you want to take advantage of such features.
+
For more details, the Edition
+Guide is a complete book
+about editions that enumerates the differences between editions and explains
+how to automatically upgrade your code to a new edition via cargo fix.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/appendix-06-translation.html b/appendix-06-translation.html
new file mode 100644
index 0000000000..b46f7d57bb
--- /dev/null
+++ b/appendix-06-translation.html
@@ -0,0 +1,262 @@
+
+
+
+
+
+ F - Translations of the Book - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
As a language, Rust cares a lot about the stability of your code. We want
+Rust to be a rock-solid foundation you can build on, and if things were
+constantly changing, that would be impossible. At the same time, if we can’t
+experiment with new features, we may not find out important flaws until after
+their release, when we can no longer change things.
+
Our solution to this problem is what we call “stability without stagnation”,
+and our guiding principle is this: you should never have to fear upgrading to a
+new version of stable Rust. Each upgrade should be painless, but should also
+bring you new features, fewer bugs, and faster compile times.
Rust development operates on a train schedule. That is, all development is
+done on the master branch of the Rust repository. Releases follow a software
+release train model, which has been used by Cisco IOS and other software
+projects. There are three release channels for Rust:
+
+
Nightly
+
Beta
+
Stable
+
+
Most Rust developers primarily use the stable channel, but those who want to
+try out experimental new features may use nightly or beta.
+
Here’s an example of how the development and release process works: let’s
+assume that the Rust team is working on the release of Rust 1.5. That release
+happened in December of 2015, but it will provide us with realistic version
+numbers. A new feature is added to Rust: a new commit lands on the master
+branch. Each night, a new nightly version of Rust is produced. Every day is a
+release day, and these releases are created by our release infrastructure
+automatically. So as time passes, our releases look like this, once a night:
+
nightly: * - - * - - *
+
+
Every six weeks, it’s time to prepare a new release! The beta branch of the
+Rust repository branches off from the master branch used by nightly. Now,
+there are two releases:
+
nightly: * - - * - - *
+ |
+beta: *
+
+
Most Rust users do not use beta releases actively, but test against beta in
+their CI system to help Rust discover possible regressions. In the meantime,
+there’s still a nightly release every night:
+
nightly: * - - * - - * - - * - - *
+ |
+beta: *
+
+
Let’s say a regression is found. Good thing we had some time to test the beta
+release before the regression snuck into a stable release! The fix is applied
+to master, so that nightly is fixed, and then the fix is backported to the
+beta branch, and a new release of beta is produced:
Hooray! Rust 1.5 is done! However, we’ve forgotten one thing: because the six
+weeks have gone by, we also need a new beta of the next version of Rust, 1.6.
+So after stable branches off of beta, the next version of beta branches
+off of nightly again:
This is called the “train model” because every six weeks, a release “leaves the
+station”, but still has to take a journey through the beta channel before it
+arrives as a stable release.
+
Rust releases every six weeks, like clockwork. If you know the date of one Rust
+release, you can know the date of the next one: it’s six weeks later. A nice
+aspect of having releases scheduled every six weeks is that the next train is
+coming soon. If a feature happens to miss a particular release, there’s no need
+to worry: another one is happening in a short time! This helps reduce pressure
+to sneak possibly unpolished features in close to the release deadline.
+
Thanks to this process, you can always check out the next build of Rust and
+verify for yourself that it’s easy to upgrade to: if a beta release doesn’t
+work as expected, you can report it to the team and get it fixed before the
+next stable release happens! Breakage in a beta release is relatively rare, but
+rustc is still a piece of software, and bugs do exist.
The Rust project supports the most recent stable version. When a new stable
+version is released, the old version reaches its end of life (EOL). This means
+each version is supported for six weeks.
There’s one more catch with this release model: unstable features. Rust uses a
+technique called “feature flags” to determine what features are enabled in a
+given release. If a new feature is under active development, it lands on
+master, and therefore, in nightly, but behind a feature flag. If you, as a
+user, wish to try out the work-in-progress feature, you can, but you must be
+using a nightly release of Rust and annotate your source code with the
+appropriate flag to opt in.
+
If you’re using a beta or stable release of Rust, you can’t use any feature
+flags. This is the key that allows us to get practical use with new features
+before we declare them stable forever. Those who wish to opt into the bleeding
+edge can do so, and those who want a rock-solid experience can stick with
+stable and know that their code won’t break. Stability without stagnation.
+
This book only contains information about stable features, as in-progress
+features are still changing, and surely they’ll be different between when this
+book was written and when they get enabled in stable builds. You can find
+documentation for nightly-only features online.
Rustup makes it easy to change between different release channels of Rust, on a
+global or per-project basis. By default, you’ll have stable Rust installed. To
+install nightly, for example:
+
$ rustup toolchain install nightly
+
+
You can see all of the toolchains (releases of Rust and associated
+components) you have installed with rustup as well. Here’s an example on one
+of your authors’ Windows computer:
+
> rustup toolchain list
+stable-x86_64-pc-windows-msvc (default)
+beta-x86_64-pc-windows-msvc
+nightly-x86_64-pc-windows-msvc
+
+
As you can see, the stable toolchain is the default. Most Rust users use stable
+most of the time. You might want to use stable most of the time, but use
+nightly on a specific project, because you care about a cutting-edge feature.
+To do so, you can use rustup override in that project’s directory to set the
+nightly toolchain as the one rustup should use when you’re in that directory:
+
$ cd ~/projects/needs-nightly
+$ rustup override set nightly
+
+
Now, every time you call rustc or cargo inside of
+~/projects/needs-nightly, rustup will make sure that you are using nightly
+Rust, rather than your default of stable Rust. This comes in handy when you
+have a lot of Rust projects!
So how do you learn about these new features? Rust’s development model follows
+a Request For Comments (RFC) process. If you’d like an improvement in Rust,
+you can write up a proposal, called an RFC.
+
Anyone can write RFCs to improve Rust, and the proposals are reviewed and
+discussed by the Rust team, which is comprised of many topic subteams. There’s
+a full list of the teams on Rust’s
+website, which includes teams for
+each area of the project: language design, compiler implementation,
+infrastructure, documentation, and more. The appropriate team reads the
+proposal and the comments, writes some comments of their own, and eventually,
+there’s consensus to accept or reject the feature.
+
If the feature is accepted, an issue is opened on the Rust repository, and
+someone can implement it. The person who implements it very well may not be the
+person who proposed the feature in the first place! When the implementation is
+ready, it lands on the master branch behind a feature gate, as we discussed
+in the “Unstable Features” section.
+
After some time, once Rust developers who use nightly releases have been able
+to try out the new feature, team members will discuss the feature, how it’s
+worked out on nightly, and decide if it should make it into stable Rust or not.
+If the decision is to move forward, the feature gate is removed, and the
+feature is now considered stable! It rides the trains into a new stable release
+of Rust.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ayu-highlight.css b/ayu-highlight.css
new file mode 100644
index 0000000000..32c9432224
--- /dev/null
+++ b/ayu-highlight.css
@@ -0,0 +1,78 @@
+/*
+Based off of the Ayu theme
+Original by Dempfi (https://github.com/dempfi/ayu)
+*/
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #191f26;
+ color: #e6e1cf;
+}
+
+.hljs-comment,
+.hljs-quote {
+ color: #5c6773;
+ font-style: italic;
+}
+
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-attr,
+.hljs-regexp,
+.hljs-link,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #ff7733;
+}
+
+.hljs-number,
+.hljs-meta,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #ffee99;
+}
+
+.hljs-string,
+.hljs-bullet {
+ color: #b8cc52;
+}
+
+.hljs-title,
+.hljs-built_in,
+.hljs-section {
+ color: #ffb454;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-symbol {
+ color: #ff7733;
+}
+
+.hljs-name {
+ color: #36a3d9;
+}
+
+.hljs-tag {
+ color: #00568d;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #91b362;
+}
+
+.hljs-deletion {
+ color: #d96c75;
+}
diff --git a/book.js b/book.js
new file mode 100644
index 0000000000..aa12e7eccf
--- /dev/null
+++ b/book.js
@@ -0,0 +1,697 @@
+"use strict";
+
+// Fix back button cache problem
+window.onunload = function () { };
+
+// Global variable, shared between modules
+function playground_text(playground, hidden = true) {
+ let code_block = playground.querySelector("code");
+
+ if (window.ace && code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ return editor.getValue();
+ } else if (hidden) {
+ return code_block.textContent;
+ } else {
+ return code_block.innerText;
+ }
+}
+
+(function codeSnippets() {
+ function fetch_with_timeout(url, options, timeout = 6000) {
+ return Promise.race([
+ fetch(url, options),
+ new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), timeout))
+ ]);
+ }
+
+ var playgrounds = Array.from(document.querySelectorAll(".playground"));
+ if (playgrounds.length > 0) {
+ fetch_with_timeout("https://play.rust-lang.org/meta/crates", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ })
+ .then(response => response.json())
+ .then(response => {
+ // get list of crates available in the rust playground
+ let playground_crates = response.crates.map(item => item["id"]);
+ playgrounds.forEach(block => handle_crate_list_update(block, playground_crates));
+ });
+ }
+
+ function handle_crate_list_update(playground_block, playground_crates) {
+ // update the play buttons after receiving the response
+ update_play_button(playground_block, playground_crates);
+
+ // and install on change listener to dynamically update ACE editors
+ if (window.ace) {
+ let code_block = playground_block.querySelector("code");
+ if (code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ editor.addEventListener("change", function (e) {
+ update_play_button(playground_block, playground_crates);
+ });
+ // add Ctrl-Enter command to execute rust code
+ editor.commands.addCommand({
+ name: "run",
+ bindKey: {
+ win: "Ctrl-Enter",
+ mac: "Ctrl-Enter"
+ },
+ exec: _editor => run_rust_code(playground_block)
+ });
+ }
+ }
+ }
+
+ // updates the visibility of play button based on `no_run` class and
+ // used crates vs ones available on https://play.rust-lang.org
+ function update_play_button(pre_block, playground_crates) {
+ var play_button = pre_block.querySelector(".play-button");
+
+ // skip if code is `no_run`
+ if (pre_block.querySelector('code').classList.contains("no_run")) {
+ play_button.classList.add("hidden");
+ return;
+ }
+
+ // get list of `extern crate`'s from snippet
+ var txt = playground_text(pre_block);
+ var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
+ var snippet_crates = [];
+ var item;
+ while (item = re.exec(txt)) {
+ snippet_crates.push(item[1]);
+ }
+
+ // check if all used crates are available on play.rust-lang.org
+ var all_available = snippet_crates.every(function (elem) {
+ return playground_crates.indexOf(elem) > -1;
+ });
+
+ if (all_available) {
+ play_button.classList.remove("hidden");
+ } else {
+ play_button.classList.add("hidden");
+ }
+ }
+
+ function run_rust_code(code_block) {
+ var result_block = code_block.querySelector(".result");
+ if (!result_block) {
+ result_block = document.createElement('code');
+ result_block.className = 'result hljs language-bash';
+
+ code_block.append(result_block);
+ }
+
+ let text = playground_text(code_block);
+ let classes = code_block.querySelector('code').classList;
+ let edition = "2015";
+ if(classes.contains("edition2018")) {
+ edition = "2018";
+ } else if(classes.contains("edition2021")) {
+ edition = "2021";
+ }
+ var params = {
+ version: "stable",
+ optimize: "0",
+ code: text,
+ edition: edition
+ };
+
+ if (text.indexOf("#![feature") !== -1) {
+ params.version = "nightly";
+ }
+
+ result_block.innerText = "Running...";
+
+ fetch_with_timeout("https://play.rust-lang.org/evaluate.json", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ body: JSON.stringify(params)
+ })
+ .then(response => response.json())
+ .then(response => {
+ if (response.result.trim() === '') {
+ result_block.innerText = "No output";
+ result_block.classList.add("result-no-output");
+ } else {
+ result_block.innerText = response.result;
+ result_block.classList.remove("result-no-output");
+ }
+ })
+ .catch(error => result_block.innerText = "Playground Communication: " + error.message);
+ }
+
+ // Syntax highlighting Configuration
+ hljs.configure({
+ tabReplace: ' ', // 4 spaces
+ languages: [], // Languages used for auto-detection
+ });
+
+ let code_nodes = Array
+ .from(document.querySelectorAll('code'))
+ // Don't highlight `inline code` blocks in headers.
+ .filter(function (node) {return !node.parentElement.classList.contains("header"); });
+
+ if (window.ace) {
+ // language-rust class needs to be removed for editable
+ // blocks or highlightjs will capture events
+ code_nodes
+ .filter(function (node) {return node.classList.contains("editable"); })
+ .forEach(function (block) { block.classList.remove('language-rust'); });
+
+ code_nodes
+ .filter(function (node) {return !node.classList.contains("editable"); })
+ .forEach(function (block) { hljs.highlightBlock(block); });
+ } else {
+ code_nodes.forEach(function (block) { hljs.highlightBlock(block); });
+ }
+
+ // Adding the hljs class gives code blocks the color css
+ // even if highlighting doesn't apply
+ code_nodes.forEach(function (block) { block.classList.add('hljs'); });
+
+ Array.from(document.querySelectorAll("code.hljs")).forEach(function (block) {
+
+ var lines = Array.from(block.querySelectorAll('.boring'));
+ // If no lines were hidden, return
+ if (!lines.length) { return; }
+ block.classList.add("hide-boring");
+
+ var buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ buttons.innerHTML = "";
+
+ // add expand button
+ var pre_block = block.parentNode;
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+
+ pre_block.querySelector('.buttons').addEventListener('click', function (e) {
+ if (e.target.classList.contains('fa-eye')) {
+ e.target.classList.remove('fa-eye');
+ e.target.classList.add('fa-eye-slash');
+ e.target.title = 'Hide lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.remove('hide-boring');
+ } else if (e.target.classList.contains('fa-eye-slash')) {
+ e.target.classList.remove('fa-eye-slash');
+ e.target.classList.add('fa-eye');
+ e.target.title = 'Show hidden lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.add('hide-boring');
+ }
+ });
+ });
+
+ if (window.playground_copyable) {
+ Array.from(document.querySelectorAll('pre code')).forEach(function (block) {
+ var pre_block = block.parentNode;
+ if (!pre_block.classList.contains('playground')) {
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var clipButton = document.createElement('button');
+ clipButton.className = 'fa fa-copy clip-button';
+ clipButton.title = 'Copy to clipboard';
+ clipButton.setAttribute('aria-label', clipButton.title);
+ clipButton.innerHTML = '';
+
+ buttons.insertBefore(clipButton, buttons.firstChild);
+ }
+ });
+ }
+
+ // Process playground code blocks
+ Array.from(document.querySelectorAll(".playground")).forEach(function (pre_block) {
+ // Add play button
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var runCodeButton = document.createElement('button');
+ runCodeButton.className = 'fa fa-play play-button';
+ runCodeButton.hidden = true;
+ runCodeButton.title = 'Run this code';
+ runCodeButton.setAttribute('aria-label', runCodeButton.title);
+
+ buttons.insertBefore(runCodeButton, buttons.firstChild);
+ runCodeButton.addEventListener('click', function (e) {
+ run_rust_code(pre_block);
+ });
+
+ if (window.playground_copyable) {
+ var copyCodeClipboardButton = document.createElement('button');
+ copyCodeClipboardButton.className = 'fa fa-copy clip-button';
+ copyCodeClipboardButton.innerHTML = '';
+ copyCodeClipboardButton.title = 'Copy to clipboard';
+ copyCodeClipboardButton.setAttribute('aria-label', copyCodeClipboardButton.title);
+
+ buttons.insertBefore(copyCodeClipboardButton, buttons.firstChild);
+ }
+
+ let code_block = pre_block.querySelector("code");
+ if (window.ace && code_block.classList.contains("editable")) {
+ var undoChangesButton = document.createElement('button');
+ undoChangesButton.className = 'fa fa-history reset-button';
+ undoChangesButton.title = 'Undo changes';
+ undoChangesButton.setAttribute('aria-label', undoChangesButton.title);
+
+ buttons.insertBefore(undoChangesButton, buttons.firstChild);
+
+ undoChangesButton.addEventListener('click', function () {
+ let editor = window.ace.edit(code_block);
+ editor.setValue(editor.originalCode);
+ editor.clearSelection();
+ });
+ }
+ });
+})();
+
+(function themes() {
+ var html = document.querySelector('html');
+ var themeToggleButton = document.getElementById('theme-toggle');
+ var themePopup = document.getElementById('theme-list');
+ var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
+ var stylesheets = {
+ ayuHighlight: document.querySelector("[href$='ayu-highlight.css']"),
+ tomorrowNight: document.querySelector("[href$='tomorrow-night.css']"),
+ highlight: document.querySelector("[href$='highlight.css']"),
+ };
+
+ function showThemes() {
+ themePopup.style.display = 'block';
+ themeToggleButton.setAttribute('aria-expanded', true);
+ themePopup.querySelector("button#" + get_theme()).focus();
+ }
+
+ function updateThemeSelected() {
+ themePopup.querySelectorAll('.theme-selected').forEach(function (el) {
+ el.classList.remove('theme-selected');
+ });
+ themePopup.querySelector("button#" + get_theme()).classList.add('theme-selected');
+ }
+
+ function hideThemes() {
+ themePopup.style.display = 'none';
+ themeToggleButton.setAttribute('aria-expanded', false);
+ themeToggleButton.focus();
+ }
+
+ function get_theme() {
+ var theme;
+ try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
+ if (theme === null || theme === undefined) {
+ return default_theme;
+ } else {
+ return theme;
+ }
+ }
+
+ function set_theme(theme, store = true) {
+ let ace_theme;
+
+ if (theme == 'coal' || theme == 'navy') {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = false;
+ stylesheets.highlight.disabled = true;
+
+ ace_theme = "ace/theme/tomorrow_night";
+ } else if (theme == 'ayu') {
+ stylesheets.ayuHighlight.disabled = false;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = true;
+ ace_theme = "ace/theme/tomorrow_night";
+ } else {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = false;
+ ace_theme = "ace/theme/dawn";
+ }
+
+ setTimeout(function () {
+ themeColorMetaTag.content = getComputedStyle(document.documentElement).backgroundColor;
+ }, 1);
+
+ if (window.ace && window.editors) {
+ window.editors.forEach(function (editor) {
+ editor.setTheme(ace_theme);
+ });
+ }
+
+ var previousTheme = get_theme();
+
+ if (store) {
+ try { localStorage.setItem('mdbook-theme', theme); } catch (e) { }
+ }
+
+ html.classList.remove(previousTheme);
+ html.classList.add(theme);
+ updateThemeSelected();
+ }
+
+ // Set theme
+ var theme = get_theme();
+
+ set_theme(theme, false);
+
+ themeToggleButton.addEventListener('click', function () {
+ if (themePopup.style.display === 'block') {
+ hideThemes();
+ } else {
+ showThemes();
+ }
+ });
+
+ themePopup.addEventListener('click', function (e) {
+ var theme;
+ if (e.target.className === "theme") {
+ theme = e.target.id;
+ } else if (e.target.parentElement.className === "theme") {
+ theme = e.target.parentElement.id;
+ } else {
+ return;
+ }
+ set_theme(theme);
+ });
+
+ themePopup.addEventListener('focusout', function(e) {
+ // e.relatedTarget is null in Safari and Firefox on macOS (see workaround below)
+ if (!!e.relatedTarget && !themeToggleButton.contains(e.relatedTarget) && !themePopup.contains(e.relatedTarget)) {
+ hideThemes();
+ }
+ });
+
+ // Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
+ document.addEventListener('click', function(e) {
+ if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
+ hideThemes();
+ }
+ });
+
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (!themePopup.contains(e.target)) { return; }
+
+ switch (e.key) {
+ case 'Escape':
+ e.preventDefault();
+ hideThemes();
+ break;
+ case 'ArrowUp':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.previousElementSibling) {
+ li.previousElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'ArrowDown':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.nextElementSibling) {
+ li.nextElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'Home':
+ e.preventDefault();
+ themePopup.querySelector('li:first-child button').focus();
+ break;
+ case 'End':
+ e.preventDefault();
+ themePopup.querySelector('li:last-child button').focus();
+ break;
+ }
+ });
+})();
+
+(function sidebar() {
+ var body = document.querySelector("body");
+ var sidebar = document.getElementById("sidebar");
+ var sidebarLinks = document.querySelectorAll('#sidebar a');
+ var sidebarToggleButton = document.getElementById("sidebar-toggle");
+ var sidebarResizeHandle = document.getElementById("sidebar-resize-handle");
+ var firstContact = null;
+
+ function showSidebar() {
+ body.classList.remove('sidebar-hidden')
+ body.classList.add('sidebar-visible');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', 0);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', true);
+ sidebar.setAttribute('aria-hidden', false);
+ try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
+ }
+
+
+ var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
+
+ function toggleSection(ev) {
+ ev.currentTarget.parentElement.classList.toggle('expanded');
+ }
+
+ Array.from(sidebarAnchorToggles).forEach(function (el) {
+ el.addEventListener('click', toggleSection);
+ });
+
+ function hideSidebar() {
+ body.classList.remove('sidebar-visible')
+ body.classList.add('sidebar-hidden');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', -1);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', false);
+ sidebar.setAttribute('aria-hidden', true);
+ try { localStorage.setItem('mdbook-sidebar', 'hidden'); } catch (e) { }
+ }
+
+ // Toggle sidebar
+ sidebarToggleButton.addEventListener('click', function sidebarToggle() {
+ if (body.classList.contains("sidebar-hidden")) {
+ var current_width = parseInt(
+ document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
+ if (current_width < 150) {
+ document.documentElement.style.setProperty('--sidebar-width', '150px');
+ }
+ showSidebar();
+ } else if (body.classList.contains("sidebar-visible")) {
+ hideSidebar();
+ } else {
+ if (getComputedStyle(sidebar)['transform'] === 'none') {
+ hideSidebar();
+ } else {
+ showSidebar();
+ }
+ }
+ });
+
+ sidebarResizeHandle.addEventListener('mousedown', initResize, false);
+
+ function initResize(e) {
+ window.addEventListener('mousemove', resize, false);
+ window.addEventListener('mouseup', stopResize, false);
+ body.classList.add('sidebar-resizing');
+ }
+ function resize(e) {
+ var pos = (e.clientX - sidebar.offsetLeft);
+ if (pos < 20) {
+ hideSidebar();
+ } else {
+ if (body.classList.contains("sidebar-hidden")) {
+ showSidebar();
+ }
+ pos = Math.min(pos, window.innerWidth - 100);
+ document.documentElement.style.setProperty('--sidebar-width', pos + 'px');
+ }
+ }
+ //on mouseup remove windows functions mousemove & mouseup
+ function stopResize(e) {
+ body.classList.remove('sidebar-resizing');
+ window.removeEventListener('mousemove', resize, false);
+ window.removeEventListener('mouseup', stopResize, false);
+ }
+
+ document.addEventListener('touchstart', function (e) {
+ firstContact = {
+ x: e.touches[0].clientX,
+ time: Date.now()
+ };
+ }, { passive: true });
+
+ document.addEventListener('touchmove', function (e) {
+ if (!firstContact)
+ return;
+
+ var curX = e.touches[0].clientX;
+ var xDiff = curX - firstContact.x,
+ tDiff = Date.now() - firstContact.time;
+
+ if (tDiff < 250 && Math.abs(xDiff) >= 150) {
+ if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
+ showSidebar();
+ else if (xDiff < 0 && curX < 300)
+ hideSidebar();
+
+ firstContact = null;
+ }
+ }, { passive: true });
+})();
+
+(function chapterNavigation() {
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (window.search && window.search.hasFocus()) { return; }
+ var html = document.querySelector('html');
+
+ function next() {
+ var nextButton = document.querySelector('.nav-chapters.next');
+ if (nextButton) {
+ window.location.href = nextButton.href;
+ }
+ }
+ function prev() {
+ var previousButton = document.querySelector('.nav-chapters.previous');
+ if (previousButton) {
+ window.location.href = previousButton.href;
+ }
+ }
+ switch (e.key) {
+ case 'ArrowRight':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ prev();
+ } else {
+ next();
+ }
+ break;
+ case 'ArrowLeft':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ next();
+ } else {
+ prev();
+ }
+ break;
+ }
+ });
+})();
+
+(function clipboard() {
+ var clipButtons = document.querySelectorAll('.clip-button');
+
+ function hideTooltip(elem) {
+ elem.firstChild.innerText = "";
+ elem.className = 'fa fa-copy clip-button';
+ }
+
+ function showTooltip(elem, msg) {
+ elem.firstChild.innerText = msg;
+ elem.className = 'fa fa-copy tooltipped';
+ }
+
+ var clipboardSnippets = new ClipboardJS('.clip-button', {
+ text: function (trigger) {
+ hideTooltip(trigger);
+ let playground = trigger.closest("pre");
+ return playground_text(playground, false);
+ }
+ });
+
+ Array.from(clipButtons).forEach(function (clipButton) {
+ clipButton.addEventListener('mouseout', function (e) {
+ hideTooltip(e.currentTarget);
+ });
+ });
+
+ clipboardSnippets.on('success', function (e) {
+ e.clearSelection();
+ showTooltip(e.trigger, "Copied!");
+ });
+
+ clipboardSnippets.on('error', function (e) {
+ showTooltip(e.trigger, "Clipboard error!");
+ });
+})();
+
+(function scrollToTop () {
+ var menuTitle = document.querySelector('.menu-title');
+
+ menuTitle.addEventListener('click', function () {
+ document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
+ });
+})();
+
+(function controllMenu() {
+ var menu = document.getElementById('menu-bar');
+
+ (function controllPosition() {
+ var scrollTop = document.scrollingElement.scrollTop;
+ var prevScrollTop = scrollTop;
+ var minMenuY = -menu.clientHeight - 50;
+ // When the script loads, the page can be at any scroll (e.g. if you reforesh it).
+ menu.style.top = scrollTop + 'px';
+ // Same as parseInt(menu.style.top.slice(0, -2), but faster
+ var topCache = menu.style.top.slice(0, -2);
+ menu.classList.remove('sticky');
+ var stickyCache = false; // Same as menu.classList.contains('sticky'), but faster
+ document.addEventListener('scroll', function () {
+ scrollTop = Math.max(document.scrollingElement.scrollTop, 0);
+ // `null` means that it doesn't need to be updated
+ var nextSticky = null;
+ var nextTop = null;
+ var scrollDown = scrollTop > prevScrollTop;
+ var menuPosAbsoluteY = topCache - scrollTop;
+ if (scrollDown) {
+ nextSticky = false;
+ if (menuPosAbsoluteY > 0) {
+ nextTop = prevScrollTop;
+ }
+ } else {
+ if (menuPosAbsoluteY > 0) {
+ nextSticky = true;
+ } else if (menuPosAbsoluteY < minMenuY) {
+ nextTop = prevScrollTop + minMenuY;
+ }
+ }
+ if (nextSticky === true && stickyCache === false) {
+ menu.classList.add('sticky');
+ stickyCache = true;
+ } else if (nextSticky === false && stickyCache === true) {
+ menu.classList.remove('sticky');
+ stickyCache = false;
+ }
+ if (nextTop !== null) {
+ menu.style.top = nextTop + 'px';
+ topCache = nextTop;
+ }
+ prevScrollTop = scrollTop;
+ }, { passive: true });
+ })();
+ (function controllBorder() {
+ function updateBorder() {
+ if (menu.offsetTop === 0) {
+ menu.classList.remove('bordered');
+ } else {
+ menu.classList.add('bordered');
+ }
+ }
+ updateBorder();
+ document.addEventListener('scroll', updateBorder, { passive: true });
+ })();
+})();
diff --git a/ch00-00-introduction.html b/ch00-00-introduction.html
new file mode 100644
index 0000000000..3b41fb14f8
--- /dev/null
+++ b/ch00-00-introduction.html
@@ -0,0 +1,389 @@
+
+
+
+
+
+ Introduction - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Welcome to The Rust Programming Language, an introductory book about Rust.
+The Rust programming language helps you write faster, more reliable software.
+High-level ergonomics and low-level control are often at odds in programming
+language design; Rust challenges that conflict. Through balancing powerful
+technical capacity and a great developer experience, Rust gives you the option
+to control low-level details (such as memory usage) without all the hassle
+traditionally associated with such control.
Rust is proving to be a productive tool for collaborating among large teams of
+developers with varying levels of systems programming knowledge. Low-level code
+is prone to various subtle bugs, which in most other languages can be caught
+only through extensive testing and careful code review by experienced
+developers. In Rust, the compiler plays a gatekeeper role by refusing to
+compile code with these elusive bugs, including concurrency bugs. By working
+alongside the compiler, the team can spend their time focusing on the program’s
+logic rather than chasing down bugs.
+
Rust also brings contemporary developer tools to the systems programming world:
+
+
Cargo, the included dependency manager and build tool, makes adding,
+compiling, and managing dependencies painless and consistent across the Rust
+ecosystem.
+
The Rustfmt formatting tool ensures a consistent coding style across
+developers.
+
The rust-analyzer powers Integrated Development Environment (IDE)
+integration for code completion and inline error messages.
+
+
By using these and other tools in the Rust ecosystem, developers can be
+productive while writing systems-level code.
Rust is for students and those who are interested in learning about systems
+concepts. Using Rust, many people have learned about topics like operating
+systems development. The community is very welcoming and happy to answer
+student questions. Through efforts such as this book, the Rust teams want to
+make systems concepts more accessible to more people, especially those new to
+programming.
Hundreds of companies, large and small, use Rust in production for a variety of
+tasks, including command line tools, web services, DevOps tooling, embedded
+devices, audio and video analysis and transcoding, cryptocurrencies,
+bioinformatics, search engines, Internet of Things applications, machine
+learning, and even major parts of the Firefox web browser.
Rust is for people who want to build the Rust programming language, community,
+developer tools, and libraries. We’d love to have you contribute to the Rust
+language.
Rust is for people who crave speed and stability in a language. By speed, we
+mean both how quickly Rust code can run and the speed at which Rust lets you
+write programs. The Rust compiler’s checks ensure stability through feature
+additions and refactoring. This is in contrast to the brittle legacy code in
+languages without these checks, which developers are often afraid to modify. By
+striving for zero-cost abstractions, higher-level features that compile to
+lower-level code as fast as code written manually, Rust endeavors to make safe
+code be fast code as well.
+
The Rust language hopes to support many other users as well; those mentioned
+here are merely some of the biggest stakeholders. Overall, Rust’s greatest
+ambition is to eliminate the trade-offs that programmers have accepted for
+decades by providing safety and productivity, speed and ergonomics. Give
+Rust a try and see if its choices work for you.
This book assumes that you’ve written code in another programming language but
+doesn’t make any assumptions about which one. We’ve tried to make the material
+broadly accessible to those from a wide variety of programming backgrounds. We
+don’t spend a lot of time talking about what programming is or how to think
+about it. If you’re entirely new to programming, you would be better served by
+reading a book that specifically provides an introduction to programming.
In general, this book assumes that you’re reading it in sequence from front to
+back. Later chapters build on concepts in earlier chapters, and earlier
+chapters might not delve into details on a particular topic but will revisit
+the topic in a later chapter.
+
You’ll find two kinds of chapters in this book: concept chapters and project
+chapters. In concept chapters, you’ll learn about an aspect of Rust. In project
+chapters, we’ll build small programs together, applying what you’ve learned so
+far. Chapters 2, 12, and 20 are project chapters; the rest are concept chapters.
+
Chapter 1 explains how to install Rust, how to write a “Hello, world!” program,
+and how to use Cargo, Rust’s package manager and build tool. Chapter 2 is a
+hands-on introduction to writing a program in Rust, having you build up a
+number guessing game. Here we cover concepts at a high level, and later
+chapters will provide additional detail. If you want to get your hands dirty
+right away, Chapter 2 is the place for that. Chapter 3 covers Rust features
+that are similar to those of other programming languages, and in Chapter 4
+you’ll learn about Rust’s ownership system. If you’re a particularly meticulous
+learner who prefers to learn every detail before moving on to the next, you
+might want to skip Chapter 2 and go straight to Chapter 3, returning to Chapter
+2 when you’d like to work on a project applying the details you’ve learned.
+
Chapter 5 discusses structs and methods, and Chapter 6 covers enums, match
+expressions, and the if let control flow construct. You’ll use structs and
+enums to make custom types in Rust.
+
In Chapter 7, you’ll learn about Rust’s module system and about privacy rules
+for organizing your code and its public Application Programming Interface
+(API). Chapter 8 discusses some common collection data structures that the
+standard library provides, such as vectors, strings, and hash maps. Chapter 9
+explores Rust’s error-handling philosophy and techniques.
+
Chapter 10 digs into generics, traits, and lifetimes, which give you the power
+to define code that applies to multiple types. Chapter 11 is all about testing,
+which even with Rust’s safety guarantees is necessary to ensure your program’s
+logic is correct. In Chapter 12, we’ll build our own implementation of a subset
+of functionality from the grep command line tool that searches for text
+within files. For this, we’ll use many of the concepts we discussed in the
+previous chapters.
+
Chapter 13 explores closures and iterators: features of Rust that come from
+functional programming languages. In Chapter 14, we’ll examine Cargo in more
+depth and talk about best practices for sharing your libraries with others.
+Chapter 15 discusses smart pointers that the standard library provides and the
+traits that enable their functionality.
+
In Chapter 16, we’ll walk through different models of concurrent programming
+and talk about how Rust helps you to program in multiple threads fearlessly.
+Chapter 17 looks at how Rust idioms compare to object-oriented programming
+principles you might be familiar with.
+
Chapter 18 is a reference on patterns and pattern matching, which are powerful
+ways of expressing ideas throughout Rust programs. Chapter 19 contains a
+smorgasbord of advanced topics of interest, including unsafe Rust, macros, and
+more about lifetimes, traits, types, functions, and closures.
+
In Chapter 20, we’ll complete a project in which we’ll implement a low-level
+multithreaded web server!
+
Finally, some appendices contain useful information about the language in a
+more reference-like format. Appendix A covers Rust’s keywords, Appendix B
+covers Rust’s operators and symbols, Appendix C covers derivable traits
+provided by the standard library, Appendix D covers some useful development
+tools, and Appendix E explains Rust editions. In Appendix F, you can find
+translations of the book, and in Appendix G we’ll cover how Rust is made and
+what nightly Rust is.
+
There is no wrong way to read this book: if you want to skip ahead, go for it!
+You might have to jump back to earlier chapters if you experience any
+confusion. But do whatever works for you.
+
+
An important part of the process of learning Rust is learning how to read the
+error messages the compiler displays: these will guide you toward working code.
+As such, we’ll provide many examples that don’t compile along with the error
+message the compiler will show you in each situation. Know that if you enter
+and run a random example, it may not compile! Make sure you read the
+surrounding text to see whether the example you’re trying to run is meant to
+error. Ferris will also help you distinguish code that isn’t meant to work:
+
Ferris
Meaning
+
This code does not compile!
+
This code panics!
+
This code does not produce the desired behavior.
+
+
+
In most situations, we’ll lead you to the correct version of any code that
+doesn’t compile.
The first step is to install Rust. We’ll download Rust through rustup, a
+command line tool for managing Rust versions and associated tools. You’ll need
+an internet connection for the download.
The following steps install the latest stable version of the Rust compiler.
+Rust’s stability guarantees ensure that all the examples in the book that
+compile will continue to compile with newer Rust versions. The output might
+differ slightly between versions because Rust often improves error messages and
+warnings. In other words, any newer, stable version of Rust you install using
+these steps should work as expected with the content of this book.
In this chapter and throughout the book, we’ll show some commands used in the
+terminal. Lines that you should enter in a terminal all start with $. You
+don’t need to type the $ character; it’s the command line prompt shown to
+indicate the start of each command. Lines that don’t start with $ typically
+show the output of the previous command. Additionally, PowerShell-specific
+examples will use > rather than $.
If you’re using Linux or macOS, open a terminal and enter the following command:
+
$ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
+
+
The command downloads a script and starts the installation of the rustup
+tool, which installs the latest stable version of Rust. You might be prompted
+for your password. If the install is successful, the following line will appear:
+
Rust is installed now. Great!
+
+
You will also need a linker, which is a program that Rust uses to join its
+compiled outputs into one file. It is likely you already have one. If you get
+linker errors, you should install a C compiler, which will typically include a
+linker. A C compiler is also useful because some common Rust packages depend on
+C code and will need a C compiler.
+
On macOS, you can get a C compiler by running:
+
$ xcode-select --install
+
+
Linux users should generally install GCC or Clang, according to their
+distribution’s documentation. For example, if you use Ubuntu, you can install
+the build-essential package.
To check whether you have Rust installed correctly, open a shell and enter this
+line:
+
$ rustc --version
+
+
You should see the version number, commit hash, and commit date for the latest
+stable version that has been released, in the following format:
+
rustc x.y.z (abcabcabc yyyy-mm-dd)
+
+
If you see this information, you have installed Rust successfully! If you don’t
+see this information, check that Rust is in your %PATH% system variable as
+follows.
+
In Windows CMD, use:
+
> echo %PATH%
+
+
In PowerShell, use:
+
> echo $env:Path
+
+
In Linux and macOS, use:
+
$ echo $PATH
+
+
If that’s all correct and Rust still isn’t working, there are a number of
+places you can get help. Find out how to get in touch with other Rustaceans (a
+silly nickname we call ourselves) on the community page.
The installation of Rust also includes a local copy of the documentation so
+that you can read it offline. Run rustup doc to open the local documentation
+in your browser.
+
Any time a type or function is provided by the standard library and you’re not
+sure what it does or how to use it, use the application programming interface
+(API) documentation to find out!
Now that you’ve installed Rust, it’s time to write your first Rust program.
+It’s traditional when learning a new language to write a little program that
+prints the text Hello, world! to the screen, so we’ll do the same here!
+
+
Note: This book assumes basic familiarity with the command line. Rust makes
+no specific demands about your editing or tooling or where your code lives, so
+if you prefer to use an integrated development environment (IDE) instead of
+the command line, feel free to use your favorite IDE. Many IDEs now have some
+degree of Rust support; check the IDE’s documentation for details. The Rust
+team has been focusing on enabling great IDE support via rust-analyzer. See
+Appendix D for more details.
You’ll start by making a directory to store your Rust code. It doesn’t matter
+to Rust where your code lives, but for the exercises and projects in this book,
+we suggest making a projects directory in your home directory and keeping all
+your projects there.
+
Open a terminal and enter the following commands to make a projects directory
+and a directory for the “Hello, world!” project within the projects directory.
+
For Linux, macOS, and PowerShell on Windows, enter this:
+
$ mkdir ~/projects
+$ cd ~/projects
+$ mkdir hello_world
+$ cd hello_world
+
+
For Windows CMD, enter this:
+
> mkdir "%USERPROFILE%\projects"
+> cd /d "%USERPROFILE%\projects"
+> mkdir hello_world
+> cd hello_world
+
Next, make a new source file and call it main.rs. Rust files always end with
+the .rs extension. If you’re using more than one word in your filename, the
+convention is to use an underscore to separate them. For example, use
+hello_world.rs rather than helloworld.rs.
+
Now open the main.rs file you just created and enter the code in Listing 1-1.
+
+Filename: main.rs
+
fn main() {
+ println!("Hello, world!");
+}
+Listing 1-1: A program that prints Hello, world!
+
+
Save the file and go back to your terminal window in the
+~/projects/hello_world directory. On Linux or macOS, enter the following
+commands to compile and run the file:
+
$ rustc main.rs
+$ ./main
+Hello, world!
+
+
On Windows, enter the command .\main.exe instead of ./main:
+
> rustc main.rs
+> .\main.exe
+Hello, world!
+
+
Regardless of your operating system, the string Hello, world! should print to
+the terminal. If you don’t see this output, refer back to the
+“Troubleshooting” part of the Installation
+section for ways to get help.
+
If Hello, world! did print, congratulations! You’ve officially written a Rust
+program. That makes you a Rust programmer—welcome!
Let’s review this “Hello, world!” program in detail. Here’s the first piece of
+the puzzle:
+
fn main() {
+
+}
+
These lines define a function named main. The main function is special: it
+is always the first code that runs in every executable Rust program. Here, the
+first line declares a function named main that has no parameters and returns
+nothing. If there were parameters, they would go inside the parentheses ().
+
The function body is wrapped in {}. Rust requires curly brackets around all
+function bodies. It’s good style to place the opening curly bracket on the same
+line as the function declaration, adding one space in between.
+
+
Note: If you want to stick to a standard style across Rust projects, you can
+use an automatic formatter tool called rustfmt to format your code in a
+particular style (more on rustfmt in
+Appendix D). The Rust team has included this tool
+with the standard Rust distribution, as rustc is, so it should already be
+installed on your computer!
+
+
The body of the main function holds the following code:
This line does all the work in this little program: it prints text to the
+screen. There are four important details to notice here.
+
First, Rust style is to indent with four spaces, not a tab.
+
Second, println! calls a Rust macro. If it had called a function instead, it
+would be entered as println (without the !). We’ll discuss Rust macros in
+more detail in Chapter 19. For now, you just need to know that using a !
+means that you’re calling a macro instead of a normal function and that macros
+don’t always follow the same rules as functions.
+
Third, you see the "Hello, world!" string. We pass this string as an argument
+to println!, and the string is printed to the screen.
+
Fourth, we end the line with a semicolon (;), which indicates that this
+expression is over and the next one is ready to begin. Most lines of Rust code
+end with a semicolon.
You’ve just run a newly created program, so let’s examine each step in the
+process.
+
Before running a Rust program, you must compile it using the Rust compiler by
+entering the rustc command and passing it the name of your source file, like
+this:
+
$ rustc main.rs
+
+
If you have a C or C++ background, you’ll notice that this is similar to gcc
+or clang. After compiling successfully, Rust outputs a binary executable.
+
On Linux, macOS, and PowerShell on Windows, you can see the executable by
+entering the ls command in your shell:
+
$ ls
+main main.rs
+
+
On Linux and macOS, you’ll see two files. With PowerShell on Windows, you’ll
+see the same three files that you would see using CMD. With CMD on Windows, you
+would enter the following:
+
> dir /B %= the /B option says to only show the file names =%
+main.exe
+main.pdb
+main.rs
+
+
This shows the source code file with the .rs extension, the executable file
+(main.exe on Windows, but main on all other platforms), and, when using
+Windows, a file containing debugging information with the .pdb extension.
+From here, you run the main or main.exe file, like this:
+
$ ./main # or .\main.exe on Windows
+
+
If your main.rs is your “Hello, world!” program, this line prints Hello, world! to your terminal.
+
If you’re more familiar with a dynamic language, such as Ruby, Python, or
+JavaScript, you might not be used to compiling and running a program as
+separate steps. Rust is an ahead-of-time compiled language, meaning you can
+compile a program and give the executable to someone else, and they can run it
+even without having Rust installed. If you give someone a .rb, .py, or
+.js file, they need to have a Ruby, Python, or JavaScript implementation
+installed (respectively). But in those languages, you only need one command to
+compile and run your program. Everything is a trade-off in language design.
+
Just compiling with rustc is fine for simple programs, but as your project
+grows, you’ll want to manage all the options and make it easy to share your
+code. Next, we’ll introduce you to the Cargo tool, which will help you write
+real-world Rust programs.
Cargo is Rust’s build system and package manager. Most Rustaceans use this tool
+to manage their Rust projects because Cargo handles a lot of tasks for you,
+such as building your code, downloading the libraries your code depends on, and
+building those libraries. (We call the libraries that your code needs
+dependencies.)
+
The simplest Rust programs, like the one we’ve written so far, don’t have any
+dependencies. If we had built the “Hello, world!” project with Cargo, it would
+only use the part of Cargo that handles building your code. As you write more
+complex Rust programs, you’ll add dependencies, and if you start a project
+using Cargo, adding dependencies will be much easier to do.
+
Because the vast majority of Rust projects use Cargo, the rest of this book
+assumes that you’re using Cargo too. Cargo comes installed with Rust if you
+used the official installers discussed in the
+“Installation” section. If you installed Rust
+through some other means, check whether Cargo is installed by entering the
+following in your terminal:
+
$ cargo --version
+
+
If you see a version number, you have it! If you see an error, such as command not found, look at the documentation for your method of installation to
+determine how to install Cargo separately.
Let’s create a new project using Cargo and look at how it differs from our
+original “Hello, world!” project. Navigate back to your projects directory
+(or wherever you decided to store your code). Then, on any operating system,
+run the following:
+
$ cargo new hello_cargo
+$ cd hello_cargo
+
+
The first command creates a new directory and project called hello_cargo.
+We’ve named our project hello_cargo, and Cargo creates its files in a
+directory of the same name.
+
Go into the hello_cargo directory and list the files. You’ll see that Cargo
+has generated two files and one directory for us: a Cargo.toml file and a
+src directory with a main.rs file inside.
+
It has also initialized a new Git repository along with a .gitignore file.
+Git files won’t be generated if you run cargo new within an existing Git
+repository; you can override this behavior by using cargo new --vcs=git.
+
+
Note: Git is a common version control system. You can change cargo new to
+use a different version control system or no version control system by using
+the --vcs flag. Run cargo new --help to see the available options.
+
+
Open Cargo.toml in your text editor of choice. It should look similar to the
+code in Listing 1-2.
+
+Filename: Cargo.toml
+
[package]
+name = "hello_cargo"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+Listing 1-2: Contents of Cargo.toml generated by cargo new
+
+
This file is in the TOML (Tom’s Obvious, Minimal
+Language) format, which is Cargo’s configuration format.
+
The first line, [package], is a section heading that indicates that the
+following statements are configuring a package. As we add more information to
+this file, we’ll add other sections.
+
The next three lines set the configuration information Cargo needs to compile
+your program: the name, the version, and the edition of Rust to use. We’ll talk
+about the edition key in Appendix E.
+
The last line, [dependencies], is the start of a section for you to list any
+of your project’s dependencies. In Rust, packages of code are referred to as
+crates. We won’t need any other crates for this project, but we will in the
+first project in Chapter 2, so we’ll use this dependencies section then.
+
Now open src/main.rs and take a look:
+
Filename: src/main.rs
+
fn main() {
+ println!("Hello, world!");
+}
+
Cargo has generated a “Hello, world!” program for you, just like the one we
+wrote in Listing 1-1! So far, the differences between our project and the
+project Cargo generated are that Cargo placed the code in the src directory
+and we have a Cargo.toml configuration file in the top directory.
+
Cargo expects your source files to live inside the src directory. The
+top-level project directory is just for README files, license information,
+configuration files, and anything else not related to your code. Using Cargo
+helps you organize your projects. There’s a place for everything, and
+everything is in its place.
+
If you started a project that doesn’t use Cargo, as we did with the “Hello,
+world!” project, you can convert it to a project that does use Cargo. Move the
+project code into the src directory and create an appropriate Cargo.toml
+file.
Now let’s look at what’s different when we build and run the “Hello, world!”
+program with Cargo! From your hello_cargo directory, build your project by
+entering the following command:
+
$ cargo build
+ Compiling hello_cargo v0.1.0 (file:///projects/hello_cargo)
+ Finished dev [unoptimized + debuginfo] target(s) in 2.85 secs
+
+
This command creates an executable file in target/debug/hello_cargo (or
+target\debug\hello_cargo.exe on Windows) rather than in your current
+directory. Because the default build is a debug build, Cargo puts the binary in
+a directory named debug. You can run the executable with this command:
+
$ ./target/debug/hello_cargo # or .\target\debug\hello_cargo.exe on Windows
+Hello, world!
+
+
If all goes well, Hello, world! should print to the terminal. Running cargo build for the first time also causes Cargo to create a new file at the top
+level: Cargo.lock. This file keeps track of the exact versions of
+dependencies in your project. This project doesn’t have dependencies, so the
+file is a bit sparse. You won’t ever need to change this file manually; Cargo
+manages its contents for you.
+
We just built a project with cargo build and ran it with
+./target/debug/hello_cargo, but we can also use cargo run to compile the
+code and then run the resultant executable all in one command:
+
$ cargo run
+ Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
+ Running `target/debug/hello_cargo`
+Hello, world!
+
+
Using cargo run is more convenient than having to remember to run cargo build and then use the whole path to the binary, so most developers use cargo run.
+
Notice that this time we didn’t see output indicating that Cargo was compiling
+hello_cargo. Cargo figured out that the files hadn’t changed, so it didn’t
+rebuild but just ran the binary. If you had modified your source code, Cargo
+would have rebuilt the project before running it, and you would have seen this
+output:
+
$ cargo run
+ Compiling hello_cargo v0.1.0 (file:///projects/hello_cargo)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.33 secs
+ Running `target/debug/hello_cargo`
+Hello, world!
+
+
Cargo also provides a command called cargo check. This command quickly checks
+your code to make sure it compiles but doesn’t produce an executable:
+
$ cargo check
+ Checking hello_cargo v0.1.0 (file:///projects/hello_cargo)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.32 secs
+
+
Why would you not want an executable? Often, cargo check is much faster than
+cargo build because it skips the step of producing an executable. If you’re
+continually checking your work while writing the code, using cargo check will
+speed up the process of letting you know if your project is still compiling! As
+such, many Rustaceans run cargo check periodically as they write their
+program to make sure it compiles. Then they run cargo build when they’re
+ready to use the executable.
+
Let’s recap what we’ve learned so far about Cargo:
+
+
We can create a project using cargo new.
+
We can build a project using cargo build.
+
We can build and run a project in one step using cargo run.
+
We can build a project without producing a binary to check for errors using
+cargo check.
+
Instead of saving the result of the build in the same directory as our code,
+Cargo stores it in the target/debug directory.
+
+
An additional advantage of using Cargo is that the commands are the same no
+matter which operating system you’re working on. So, at this point, we’ll no
+longer provide specific instructions for Linux and macOS versus Windows.
When your project is finally ready for release, you can use cargo build --release to compile it with optimizations. This command will create an
+executable in target/release instead of target/debug. The optimizations
+make your Rust code run faster, but turning them on lengthens the time it takes
+for your program to compile. This is why there are two different profiles: one
+for development, when you want to rebuild quickly and often, and another for
+building the final program you’ll give to a user that won’t be rebuilt
+repeatedly and that will run as fast as possible. If you’re benchmarking your
+code’s running time, be sure to run cargo build --release and benchmark with
+the executable in target/release.
With simple projects, Cargo doesn’t provide a lot of value over just using
+rustc, but it will prove its worth as your programs become more intricate.
+Once programs grow to multiple files or need a dependency, it’s much easier to
+let Cargo coordinate the build.
+
Even though the hello_cargo project is simple, it now uses much of the real
+tooling you’ll use in the rest of your Rust career. In fact, to work on any
+existing projects, you can use the following commands to check out the code
+using Git, change to that project’s directory, and build:
You’re already off to a great start on your Rust journey! In this chapter,
+you’ve learned how to:
+
+
Install the latest stable version of Rust using rustup
+
Update to a newer Rust version
+
Open locally installed documentation
+
Write and run a “Hello, world!” program using rustc directly
+
Create and run a new project using the conventions of Cargo
+
+
This is a great time to build a more substantial program to get used to reading
+and writing Rust code. So, in Chapter 2, we’ll build a guessing game program.
+If you would rather start by learning how common programming concepts work in
+Rust, see Chapter 3 and then return to Chapter 2.
Let’s jump into Rust by working through a hands-on project together! This
+chapter introduces you to a few common Rust concepts by showing you how to use
+them in a real program. You’ll learn about let, match, methods, associated
+functions, external crates, and more! In the following chapters, we’ll explore
+these ideas in more detail. In this chapter, you’ll just practice the
+fundamentals.
+
We’ll implement a classic beginner programming problem: a guessing game. Here’s
+how it works: the program will generate a random integer between 1 and 100. It
+will then prompt the player to enter a guess. After a guess is entered, the
+program will indicate whether the guess is too low or too high. If the guess is
+correct, the game will print a congratulatory message and exit.
To set up a new project, go to the projects directory that you created in
+Chapter 1 and make a new project using Cargo, like so:
+
$ cargo new guessing_game
+$ cd guessing_game
+
+
The first command, cargo new, takes the name of the project (guessing_game)
+as the first argument. The second command changes to the new project’s
+directory.
+
Look at the generated Cargo.toml file:
+
+
Filename: Cargo.toml
+
[package]
+name = "guessing_game"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+
As you saw in Chapter 1, cargo new generates a “Hello, world!” program for
+you. Check out the src/main.rs file:
+
Filename: src/main.rs
+
fn main() {
+ println!("Hello, world!");
+}
+
Now let’s compile this “Hello, world!” program and run it in the same step
+using the cargo run command:
The run command comes in handy when you need to rapidly iterate on a project,
+as we’ll do in this game, quickly testing each iteration before moving on to
+the next one.
+
Reopen the src/main.rs file. You’ll be writing all the code in this file.
The first part of the guessing game program will ask for user input, process
+that input, and check that the input is in the expected form. To start, we’ll
+allow the player to input a guess. Enter the code in Listing 2-1 into
+src/main.rs.
+
+Filename: src/main.rs
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+Listing 2-1: Code that gets a guess from the user and prints it
+
+
This code contains a lot of information, so let’s go over it line by line. To
+obtain user input and then print the result as output, we need to bring the
+io input/output library into scope. The io library comes from the standard
+library, known as std:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
By default, Rust has a set of items defined in the standard library that it
+brings into the scope of every program. This set is called the prelude, and
+you can see everything in it in the standard library documentation.
+
If a type you want to use isn’t in the prelude, you have to bring that type
+into scope explicitly with a use statement. Using the std::io library
+provides you with a number of useful features, including the ability to accept
+user input.
+
As you saw in Chapter 1, the main function is the entry point into the
+program:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
The fn syntax declares a new function; the parentheses, (), indicate there
+are no parameters; and the curly bracket, {, starts the body of the function.
+
As you also learned in Chapter 1, println! is a macro that prints a string to
+the screen:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
This code is printing a prompt stating what the game is and requesting input
+from the user.
Next, we’ll create a variable to store the user input, like this:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
Now the program is getting interesting! There’s a lot going on in this little
+line. We use the let statement to create the variable. Here’s another example:
+
let apples = 5;
+
This line creates a new variable named apples and binds it to the value 5. In
+Rust, variables are immutable by default, meaning once we give the variable a
+value, the value won’t change. We’ll be discussing this concept in detail in
+the “Variables and Mutability”
+section in Chapter 3. To make a variable mutable, we add mut before the
+variable name:
+
let apples = 5; // immutable
+let mut bananas = 5; // mutable
+
+
Note: The // syntax starts a comment that continues until the end of the
+line. Rust ignores everything in comments. We’ll discuss comments in more
+detail in Chapter 3.
+
+
Returning to the guessing game program, you now know that let mut guess will
+introduce a mutable variable named guess. The equal sign (=) tells Rust we
+want to bind something to the variable now. On the right of the equal sign is
+the value that guess is bound to, which is the result of calling
+String::new, a function that returns a new instance of a String.
+String is a string type provided by the standard
+library that is a growable, UTF-8 encoded bit of text.
+
The :: syntax in the ::new line indicates that new is an associated
+function of the String type. An associated function is a function that’s
+implemented on a type, in this case String. This new function creates a
+new, empty string. You’ll find a new function on many types because it’s a
+common name for a function that makes a new value of some kind.
+
In full, the let mut guess = String::new(); line has created a mutable
+variable that is currently bound to a new, empty instance of a String. Whew!
Recall that we included the input/output functionality from the standard
+library with use std::io; on the first line of the program. Now we’ll call
+the stdin function from the io module, which will allow us to handle user
+input:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
If we hadn’t imported the io library with use std::io; at the beginning of
+the program, we could still use the function by writing this function call as
+std::io::stdin. The stdin function returns an instance of
+std::io::Stdin, which is a type that represents a
+handle to the standard input for your terminal.
+
Next, the line .read_line(&mut guess) calls the read_line method on the standard input handle to get input from the user.
+We’re also passing &mut guess as the argument to read_line to tell it what
+string to store the user input in. The full job of read_line is to take
+whatever the user types into standard input and append that into a string
+(without overwriting its contents), so we therefore pass that string as an
+argument. The string argument needs to be mutable so the method can change the
+string’s content.
+
The & indicates that this argument is a reference, which gives you a way to
+let multiple parts of your code access one piece of data without needing to
+copy that data into memory multiple times. References are a complex feature,
+and one of Rust’s major advantages is how safe and easy it is to use
+references. You don’t need to know a lot of those details to finish this
+program. For now, all you need to know is that, like variables, references are
+immutable by default. Hence, you need to write &mut guess rather than
+&guess to make it mutable. (Chapter 4 will explain references more
+thoroughly.)
We’re still working on this line of code. We’re now discussing a third line of
+text, but note that it’s still part of a single logical line of code. The next
+part is this method:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
We could have written this code as:
+
io::stdin().read_line(&mut guess).expect("Failed to read line");
+
However, one long line is difficult to read, so it’s best to divide it. It’s
+often wise to introduce a newline and other whitespace to help break up long
+lines when you call a method with the .method_name() syntax. Now let’s
+discuss what this line does.
+
As mentioned earlier, read_line puts whatever the user enters into the string
+we pass to it, but it also returns a Result value. Result is an enumeration, often called an enum,
+which is a type that can be in one of multiple possible states. We call each
+possible state a variant.
+
Chapter 6 will cover enums in more detail. The purpose
+of these Result types is to encode error-handling information.
+
Result’s variants are Ok and Err. The Ok variant indicates the
+operation was successful, and inside Ok is the successfully generated value.
+The Err variant means the operation failed, and Err contains information
+about how or why the operation failed.
+
Values of the Result type, like values of any type, have methods defined on
+them. An instance of Result has an expect method
+that you can call. If this instance of Result is an Err value, expect
+will cause the program to crash and display the message that you passed as an
+argument to expect. If the read_line method returns an Err, it would
+likely be the result of an error coming from the underlying operating system.
+If this instance of Result is an Ok value, expect will take the return
+value that Ok is holding and return just that value to you so you can use it.
+In this case, that value is the number of bytes in the user’s input.
+
If you don’t call expect, the program will compile, but you’ll get a warning:
+
$ cargo build
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+warning: unused `Result` that must be used
+ --> src/main.rs:10:5
+ |
+10 | io::stdin().read_line(&mut guess);
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: this `Result` may be an `Err` variant, which should be handled
+ = note: `#[warn(unused_must_use)]` on by default
+help: use `let _ = ...` to ignore the resulting value
+ |
+10 | let _ = io::stdin().read_line(&mut guess);
+ | +++++++
+
+warning: `guessing_game` (bin "guessing_game") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.59s
+
+
Rust warns that you haven’t used the Result value returned from read_line,
+indicating that the program hasn’t handled a possible error.
+
The right way to suppress the warning is to actually write error-handling code,
+but in our case we just want to crash this program when a problem occurs, so we
+can use expect. You’ll learn about recovering from errors in Chapter
+9.
Aside from the closing curly bracket, there’s only one more line to discuss in
+the code so far:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
This line prints the string that now contains the user’s input. The {} set of
+curly brackets is a placeholder: think of {} as little crab pincers that hold
+a value in place. When printing the value of a variable, the variable name can
+go inside the curly brackets. When printing the result of evaluating an
+expression, place empty curly brackets in the format string, then follow the
+format string with a comma-separated list of expressions to print in each empty
+curly bracket placeholder in the same order. Printing a variable and the result
+of an expression in one call to println! would look like this:
+
#![allow(unused)]
+fn main() {
+let x = 5;
+let y = 10;
+
+println!("x = {x} and y + 2 = {}", y + 2);
+}
Next, we need to generate a secret number that the user will try to guess. The
+secret number should be different every time so the game is fun to play more
+than once. We’ll use a random number between 1 and 100 so the game isn’t too
+difficult. Rust doesn’t yet include random number functionality in its standard
+library. However, the Rust team does provide a rand crate with
+said functionality.
Remember that a crate is a collection of Rust source code files. The project
+we’ve been building is a binary crate, which is an executable. The rand
+crate is a library crate, which contains code that is intended to be used in
+other programs and can’t be executed on its own.
+
Cargo’s coordination of external crates is where Cargo really shines. Before we
+can write code that uses rand, we need to modify the Cargo.toml file to
+include the rand crate as a dependency. Open that file now and add the
+following line to the bottom, beneath the [dependencies] section header that
+Cargo created for you. Be sure to specify rand exactly as we have here, with
+this version number, or the code examples in this tutorial may not work:
+
+
Filename: Cargo.toml
+
[dependencies]
+rand = "0.8.5"
+
+
In the Cargo.toml file, everything that follows a header is part of that
+section that continues until another section starts. In [dependencies] you
+tell Cargo which external crates your project depends on and which versions of
+those crates you require. In this case, we specify the rand crate with the
+semantic version specifier 0.8.5. Cargo understands Semantic
+Versioning (sometimes called SemVer), which is a
+standard for writing version numbers. The specifier 0.8.5 is actually
+shorthand for ^0.8.5, which means any version that is at least 0.8.5 but
+below 0.9.0.
+
Cargo considers these versions to have public APIs compatible with version
+0.8.5, and this specification ensures you’ll get the latest patch release that
+will still compile with the code in this chapter. Any version 0.9.0 or greater
+is not guaranteed to have the same API as what the following examples use.
+
Now, without changing any of the code, let’s build the project, as shown in
+Listing 2-2.
+Listing 2-2: The output from running cargo build after adding the rand crate as a dependency
+
+
You may see different version numbers (but they will all be compatible with the
+code, thanks to SemVer!) and different lines (depending on the operating
+system), and the lines may be in a different order.
+
When we include an external dependency, Cargo fetches the latest versions of
+everything that dependency needs from the registry, which is a copy of data
+from Crates.io. Crates.io is where people in the Rust ecosystem
+post their open source Rust projects for others to use.
+
After updating the registry, Cargo checks the [dependencies] section and
+downloads any crates listed that aren’t already downloaded. In this case,
+although we only listed rand as a dependency, Cargo also grabbed other crates
+that rand depends on to work. After downloading the crates, Rust compiles
+them and then compiles the project with the dependencies available.
+
If you immediately run cargo build again without making any changes, you
+won’t get any output aside from the Finished line. Cargo knows it has already
+downloaded and compiled the dependencies, and you haven’t changed anything
+about them in your Cargo.toml file. Cargo also knows that you haven’t changed
+anything about your code, so it doesn’t recompile that either. With nothing to
+do, it simply exits.
+
If you open the src/main.rs file, make a trivial change, and then save it and
+build again, you’ll only see two lines of output:
+
+
$ cargo build
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 2.53 secs
+
+
These lines show that Cargo only updates the build with your tiny change to the
+src/main.rs file. Your dependencies haven’t changed, so Cargo knows it can
+reuse what it has already downloaded and compiled for those.
Cargo has a mechanism that ensures you can rebuild the same artifact every time
+you or anyone else builds your code: Cargo will use only the versions of the
+dependencies you specified until you indicate otherwise. For example, say that
+next week version 0.8.6 of the rand crate comes out, and that version
+contains an important bug fix, but it also contains a regression that will
+break your code. To handle this, Rust creates the Cargo.lock file the first
+time you run cargo build, so we now have this in the guessing_game
+directory.
+
When you build a project for the first time, Cargo figures out all the versions
+of the dependencies that fit the criteria and then writes them to the
+Cargo.lock file. When you build your project in the future, Cargo will see
+that the Cargo.lock file exists and will use the versions specified there
+rather than doing all the work of figuring out versions again. This lets you
+have a reproducible build automatically. In other words, your project will
+remain at 0.8.5 until you explicitly upgrade, thanks to the Cargo.lock file.
+Because the Cargo.lock file is important for reproducible builds, it’s often
+checked into source control with the rest of the code in your project.
When you do want to update a crate, Cargo provides the command update,
+which will ignore the Cargo.lock file and figure out all the latest versions
+that fit your specifications in Cargo.toml. Cargo will then write those
+versions to the Cargo.lock file. In this case, Cargo will only look for
+versions greater than 0.8.5 and less than 0.9.0. If the rand crate has
+released the two new versions 0.8.6 and 0.9.0, you would see the following if
+you ran cargo update:
Cargo ignores the 0.9.0 release. At this point, you would also notice a change
+in your Cargo.lock file noting that the version of the rand crate you are
+now using is 0.8.6. To use rand version 0.9.0 or any version in the 0.9.x
+series, you’d have to update the Cargo.toml file to look like this instead:
+
[dependencies]
+rand = "0.9.0"
+
+
The next time you run cargo build, Cargo will update the registry of crates
+available and reevaluate your rand requirements according to the new version
+you have specified.
+
There’s a lot more to say about Cargo and its
+ecosystem, which we’ll discuss in Chapter 14, but
+for now, that’s all you need to know. Cargo makes it very easy to reuse
+libraries, so Rustaceans are able to write smaller projects that are assembled
+from a number of packages.
Let’s start using rand to generate a number to guess. The next step is to
+update src/main.rs, as shown in Listing 2-3.
+
+Filename: src/main.rs
+
use std::io;
+use rand::Rng;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+}
+Listing 2-3: Adding code to generate a random number
+
+
First we add the line use rand::Rng;. The Rng trait defines methods that
+random number generators implement, and this trait must be in scope for us to
+use those methods. Chapter 10 will cover traits in detail.
+
Next, we’re adding two lines in the middle. In the first line, we call the
+rand::thread_rng function that gives us the particular random number
+generator we’re going to use: one that is local to the current thread of
+execution and is seeded by the operating system. Then we call the gen_range
+method on the random number generator. This method is defined by the Rng
+trait that we brought into scope with the use rand::Rng; statement. The
+gen_range method takes a range expression as an argument and generates a
+random number in the range. The kind of range expression we’re using here takes
+the form start..=end and is inclusive on the lower and upper bounds, so we
+need to specify 1..=100 to request a number between 1 and 100.
+
+
Note: You won’t just know which traits to use and which methods and functions
+to call from a crate, so each crate has documentation with instructions for
+using it. Another neat feature of Cargo is that running the cargo doc --open command will build documentation provided by all your dependencies
+locally and open it in your browser. If you’re interested in other
+functionality in the rand crate, for example, run cargo doc --open and
+click rand in the sidebar on the left.
+
+
The second new line prints the secret number. This is useful while we’re
+developing the program to be able to test it, but we’ll delete it from the
+final version. It’s not much of a game if the program prints the answer as soon
+as it starts!
+
Try running the program a few times:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 2.53s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 7
+Please input your guess.
+4
+You guessed: 4
+
+$ cargo run
+ Finished dev [unoptimized + debuginfo] target(s) in 0.02s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 83
+Please input your guess.
+5
+You guessed: 5
+
+
You should get different random numbers, and they should all be numbers between
+1 and 100. Great job!
Now that we have user input and a random number, we can compare them. That step
+is shown in Listing 2-4. Note that this code won’t compile just yet, as we will
+explain.
+
+Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ // --snip--
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+Listing 2-4: Handling the possible return values of comparing two numbers
+
+
First we add another use statement, bringing a type called
+std::cmp::Ordering into scope from the standard library. The Ordering type
+is another enum and has the variants Less, Greater, and Equal. These are
+the three outcomes that are possible when you compare two values.
+
Then we add five new lines at the bottom that use the Ordering type. The
+cmp method compares two values and can be called on anything that can be
+compared. It takes a reference to whatever you want to compare with: here it’s
+comparing guess to secret_number. Then it returns a variant of the
+Ordering enum we brought into scope with the use statement. We use a
+match expression to decide what to do next based on
+which variant of Ordering was returned from the call to cmp with the values
+in guess and secret_number.
+
A match expression is made up of arms. An arm consists of a pattern to
+match against, and the code that should be run if the value given to match
+fits that arm’s pattern. Rust takes the value given to match and looks
+through each arm’s pattern in turn. Patterns and the match construct are
+powerful Rust features: they let you express a variety of situations your code
+might encounter and they make sure you handle them all. These features will be
+covered in detail in Chapter 6 and Chapter 18, respectively.
+
Let’s walk through an example with the match expression we use here. Say that
+the user has guessed 50 and the randomly generated secret number this time is
+38.
+
When the code compares 50 to 38, the cmp method will return
+Ordering::Greater because 50 is greater than 38. The match expression gets
+the Ordering::Greater value and starts checking each arm’s pattern. It looks
+at the first arm’s pattern, Ordering::Less, and sees that the value
+Ordering::Greater does not match Ordering::Less, so it ignores the code in
+that arm and moves to the next arm. The next arm’s pattern is
+Ordering::Greater, which does match Ordering::Greater! The associated
+code in that arm will execute and print Too big! to the screen. The match
+expression ends after the first successful match, so it won’t look at the last
+arm in this scenario.
+
However, the code in Listing 2-4 won’t compile yet. Let’s try it:
+
+
$ cargo build
+ Compiling libc v0.2.86
+ Compiling getrandom v0.2.2
+ Compiling cfg-if v1.0.0
+ Compiling ppv-lite86 v0.2.10
+ Compiling rand_core v0.6.2
+ Compiling rand_chacha v0.3.0
+ Compiling rand v0.8.5
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+error[E0308]: mismatched types
+ --> src/main.rs:22:21
+ |
+22 | match guess.cmp(&secret_number) {
+ | --- ^^^^^^^^^^^^^^ expected `&String`, found `&{integer}`
+ | |
+ | arguments to this method are incorrect
+ |
+ = note: expected reference `&String`
+ found reference `&{integer}`
+note: method defined here
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/cmp.rs:836:8
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `guessing_game` (bin "guessing_game") due to 1 previous error
+
+
The core of the error states that there are mismatched types. Rust has a
+strong, static type system. However, it also has type inference. When we wrote
+let mut guess = String::new(), Rust was able to infer that guess should be
+a String and didn’t make us write the type. The secret_number, on the other
+hand, is a number type. A few of Rust’s number types can have a value between 1
+and 100: i32, a 32-bit number; u32, an unsigned 32-bit number; i64, a
+64-bit number; as well as others. Unless otherwise specified, Rust defaults to
+an i32, which is the type of secret_number unless you add type information
+elsewhere that would cause Rust to infer a different numerical type. The reason
+for the error is that Rust cannot compare a string and a number type.
+
Ultimately, we want to convert the String the program reads as input into a
+number type so we can compare it numerically to the secret number. We do so by
+adding this line to the main function body:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ // --snip--
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+
The line is:
+
let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
We create a variable named guess. But wait, doesn’t the program already have
+a variable named guess? It does, but helpfully Rust allows us to shadow the
+previous value of guess with a new one. Shadowing lets us reuse the guess
+variable name rather than forcing us to create two unique variables, such as
+guess_str and guess, for example. We’ll cover this in more detail in
+Chapter 3, but for now, know that this feature is
+often used when you want to convert a value from one type to another type.
+
We bind this new variable to the expression guess.trim().parse(). The guess
+in the expression refers to the original guess variable that contained the
+input as a string. The trim method on a String instance will eliminate any
+whitespace at the beginning and end, which we must do to be able to compare the
+string to the u32, which can only contain numerical data. The user must press
+enter to satisfy read_line and input their guess, which adds a
+newline character to the string. For example, if the user types 5 and
+presses enter, guess looks like this: 5\n. The \n represents
+“newline.” (On Windows, pressing enter results in a carriage return
+and a newline, \r\n.) The trim method eliminates \n or \r\n, resulting
+in just 5.
+
The parse method on strings converts a string to
+another type. Here, we use it to convert from a string to a number. We need to
+tell Rust the exact number type we want by using let guess: u32. The colon
+(:) after guess tells Rust we’ll annotate the variable’s type. Rust has a
+few built-in number types; the u32 seen here is an unsigned, 32-bit integer.
+It’s a good default choice for a small positive number. You’ll learn about
+other number types in Chapter 3.
+
Additionally, the u32 annotation in this example program and the comparison
+with secret_number means Rust will infer that secret_number should be a
+u32 as well. So now the comparison will be between two values of the same
+type!
+
The parse method will only work on characters that can logically be converted
+into numbers and so can easily cause errors. If, for example, the string
+contained A👍%, there would be no way to convert that to a number. Because it
+might fail, the parse method returns a Result type, much as the read_line
+method does (discussed earlier in “Handling Potential Failure with
+Result”). We’ll treat
+this Result the same way by using the expect method again. If parse
+returns an ErrResult variant because it couldn’t create a number from the
+string, the expect call will crash the game and print the message we give it.
+If parse can successfully convert the string to a number, it will return the
+Ok variant of Result, and expect will return the number that we want from
+the Ok value.
+
Let’s run the program now:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.43s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 58
+Please input your guess.
+ 76
+You guessed: 76
+Too big!
+
+
Nice! Even though spaces were added before the guess, the program still figured
+out that the user guessed 76. Run the program a few times to verify the
+different behavior with different kinds of input: guess the number correctly,
+guess a number that is too high, and guess a number that is too low.
+
We have most of the game working now, but the user can make only one guess.
+Let’s change that by adding a loop!
The loop keyword creates an infinite loop. We’ll add a loop to give users
+more chances at guessing the number:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ // --snip--
+
+ println!("The secret number is: {secret_number}");
+
+ loop {
+ println!("Please input your guess.");
+
+ // --snip--
+
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+ }
+}
+
As you can see, we’ve moved everything from the guess input prompt onward into
+a loop. Be sure to indent the lines inside the loop another four spaces each
+and run the program again. The program will now ask for another guess forever,
+which actually introduces a new problem. It doesn’t seem like the user can quit!
+
The user could always interrupt the program by using the keyboard shortcut
+ctrl-c. But there’s another way to escape this insatiable
+monster, as mentioned in the parse discussion in “Comparing the Guess to the
+Secret Number”: if
+the user enters a non-number answer, the program will crash. We can take
+advantage of that to allow the user to quit, as shown here:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 1.50s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 59
+Please input your guess.
+45
+You guessed: 45
+Too small!
+Please input your guess.
+60
+You guessed: 60
+Too big!
+Please input your guess.
+59
+You guessed: 59
+You win!
+Please input your guess.
+quit
+thread 'main' panicked at 'Please type a number!: ParseIntError { kind: InvalidDigit }', src/main.rs:28:47
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
Typing quit will quit the game, but as you’ll notice, so will entering any
+other non-number input. This is suboptimal, to say the least; we want the game
+to also stop when the correct number is guessed.
Let’s program the game to quit when the user wins by adding a break statement:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ loop {
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ // --snip--
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => {
+ println!("You win!");
+ break;
+ }
+ }
+ }
+}
+
Adding the break line after You win! makes the program exit the loop when
+the user guesses the secret number correctly. Exiting the loop also means
+exiting the program, because the loop is the last part of main.
To further refine the game’s behavior, rather than crashing the program when
+the user inputs a non-number, let’s make the game ignore a non-number so the
+user can continue guessing. We can do that by altering the line where guess
+is converted from a String to a u32, as shown in Listing 2-5.
+Listing 2-5: Ignoring a non-number guess and asking for another guess instead of crashing the program
+
+
We switch from an expect call to a match expression to move from crashing
+on an error to handling the error. Remember that parse returns a Result
+type and Result is an enum that has the variants Ok and Err. We’re using
+a match expression here, as we did with the Ordering result of the cmp
+method.
+
If parse is able to successfully turn the string into a number, it will
+return an Ok value that contains the resultant number. That Ok value will
+match the first arm’s pattern, and the match expression will just return the
+num value that parse produced and put inside the Ok value. That number
+will end up right where we want it in the new guess variable we’re creating.
+
If parse is not able to turn the string into a number, it will return an
+Err value that contains more information about the error. The Err value
+does not match the Ok(num) pattern in the first match arm, but it does
+match the Err(_) pattern in the second arm. The underscore, _, is a
+catchall value; in this example, we’re saying we want to match all Err
+values, no matter what information they have inside them. So the program will
+execute the second arm’s code, continue, which tells the program to go to the
+next iteration of the loop and ask for another guess. So, effectively, the
+program ignores all errors that parse might encounter!
+
Now everything in the program should work as expected. Let’s try it:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 4.45s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 61
+Please input your guess.
+10
+You guessed: 10
+Too small!
+Please input your guess.
+99
+You guessed: 99
+Too big!
+Please input your guess.
+foo
+Please input your guess.
+61
+You guessed: 61
+You win!
+
+
Awesome! With one tiny final tweak, we will finish the guessing game. Recall
+that the program is still printing the secret number. That worked well for
+testing, but it ruins the game. Let’s delete the println! that outputs the
+secret number. Listing 2-6 shows the final code.
This project was a hands-on way to introduce you to many new Rust concepts:
+let, match, functions, the use of external crates, and more. In the next
+few chapters, you’ll learn about these concepts in more detail. Chapter 3
+covers concepts that most programming languages have, such as variables, data
+types, and functions, and shows how to use them in Rust. Chapter 4 explores
+ownership, a feature that makes Rust different from other languages. Chapter 5
+discusses structs and method syntax, and Chapter 6 explains how enums work.
This chapter covers concepts that appear in almost every programming language
+and how they work in Rust. Many programming languages have much in common at
+their core. None of the concepts presented in this chapter are unique to Rust,
+but we’ll discuss them in the context of Rust and explain the conventions
+around using these concepts.
+
Specifically, you’ll learn about variables, basic types, functions, comments,
+and control flow. These foundations will be in every Rust program, and learning
+them early will give you a strong core to start from.
The Rust language has a set of keywords that are reserved for use by the
+language only, much as in other languages. Keep in mind that you cannot use
+these words as names of variables or functions. Most of the keywords have
+special meanings, and you’ll be using them to do various tasks in your Rust
+programs; a few have no current functionality associated with them but have
+been reserved for functionality that might be added to Rust in the future. You
+can find a list of the keywords in Appendix A.
As mentioned in the “Storing Values with
+Variables” section, by default,
+variables are immutable. This is one of many nudges Rust gives you to write
+your code in a way that takes advantage of the safety and easy concurrency that
+Rust offers. However, you still have the option to make your variables mutable.
+Let’s explore how and why Rust encourages you to favor immutability and why
+sometimes you might want to opt out.
+
When a variable is immutable, once a value is bound to a name, you can’t change
+that value. To illustrate this, generate a new project called variables in
+your projects directory by using cargo new variables.
+
Then, in your new variables directory, open src/main.rs and replace its
+code with the following code, which won’t compile just yet:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+ println!("The value of x is: {x}");
+ x = 6;
+ println!("The value of x is: {x}");
+}
+
Save and run the program using cargo run. You should receive an error message
+regarding an immutability error, as shown in this output:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+error[E0384]: cannot assign twice to immutable variable `x`
+ --> src/main.rs:4:5
+ |
+2 | let x = 5;
+ | -
+ | |
+ | first assignment to `x`
+ | help: consider making this binding mutable: `mut x`
+3 | println!("The value of x is: {x}");
+4 | x = 6;
+ | ^^^^^ cannot assign twice to immutable variable
+
+For more information about this error, try `rustc --explain E0384`.
+error: could not compile `variables` (bin "variables") due to 1 previous error
+
+
This example shows how the compiler helps you find errors in your programs.
+Compiler errors can be frustrating, but really they only mean your program
+isn’t safely doing what you want it to do yet; they do not mean that you’re
+not a good programmer! Experienced Rustaceans still get compiler errors.
+
You received the error message cannot assign twice to immutable variable `x` because you tried to assign a second value to the immutable x variable.
+
It’s important that we get compile-time errors when we attempt to change a
+value that’s designated as immutable because this very situation can lead to
+bugs. If one part of our code operates on the assumption that a value will
+never change and another part of our code changes that value, it’s possible
+that the first part of the code won’t do what it was designed to do. The cause
+of this kind of bug can be difficult to track down after the fact, especially
+when the second piece of code changes the value only sometimes. The Rust
+compiler guarantees that when you state that a value won’t change, it really
+won’t change, so you don’t have to keep track of it yourself. Your code is thus
+easier to reason through.
+
But mutability can be very useful, and can make code more convenient to write.
+Although variables are immutable by default, you can make them mutable by
+adding mut in front of the variable name as you did in Chapter
+2. Adding mut also conveys
+intent to future readers of the code by indicating that other parts of the code
+will be changing this variable’s value.
+
For example, let’s change src/main.rs to the following:
+
Filename: src/main.rs
+
fn main() {
+ let mut x = 5;
+ println!("The value of x is: {x}");
+ x = 6;
+ println!("The value of x is: {x}");
+}
+
When we run the program now, we get this:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.30s
+ Running `target/debug/variables`
+The value of x is: 5
+The value of x is: 6
+
+
We’re allowed to change the value bound to x from 5 to 6 when mut is
+used. Ultimately, deciding whether to use mutability or not is up to you and
+depends on what you think is clearest in that particular situation.
Like immutable variables, constants are values that are bound to a name and
+are not allowed to change, but there are a few differences between constants
+and variables.
+
First, you aren’t allowed to use mut with constants. Constants aren’t just
+immutable by default—they’re always immutable. You declare constants using the
+const keyword instead of the let keyword, and the type of the value must
+be annotated. We’ll cover types and type annotations in the next section,
+“Data Types”, so don’t worry about the details
+right now. Just know that you must always annotate the type.
+
Constants can be declared in any scope, including the global scope, which makes
+them useful for values that many parts of code need to know about.
+
The last difference is that constants may be set only to a constant expression,
+not the result of a value that could only be computed at runtime.
The constant’s name is THREE_HOURS_IN_SECONDS and its value is set to the
+result of multiplying 60 (the number of seconds in a minute) by 60 (the number
+of minutes in an hour) by 3 (the number of hours we want to count in this
+program). Rust’s naming convention for constants is to use all uppercase with
+underscores between words. The compiler is able to evaluate a limited set of
+operations at compile time, which lets us choose to write out this value in a
+way that’s easier to understand and verify, rather than setting this constant
+to the value 10,800. See the Rust Reference’s section on constant
+evaluation for more information on what operations can be used
+when declaring constants.
+
Constants are valid for the entire time a program runs, within the scope in
+which they were declared. This property makes constants useful for values in
+your application domain that multiple parts of the program might need to know
+about, such as the maximum number of points any player of a game is allowed to
+earn, or the speed of light.
+
Naming hardcoded values used throughout your program as constants is useful in
+conveying the meaning of that value to future maintainers of the code. It also
+helps to have only one place in your code you would need to change if the
+hardcoded value needed to be updated in the future.
As you saw in the guessing game tutorial in Chapter
+2, you can declare a
+new variable with the same name as a previous variable. Rustaceans say that the
+first variable is shadowed by the second, which means that the second
+variable is what the compiler will see when you use the name of the variable.
+In effect, the second variable overshadows the first, taking any uses of the
+variable name to itself until either it itself is shadowed or the scope ends.
+We can shadow a variable by using the same variable’s name and repeating the
+use of the let keyword as follows:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+
+ let x = x + 1;
+
+ {
+ let x = x * 2;
+ println!("The value of x in the inner scope is: {x}");
+ }
+
+ println!("The value of x is: {x}");
+}
+
This program first binds x to a value of 5. Then it creates a new variable
+x by repeating let x =, taking the original value and adding 1 so the
+value of x is then 6. Then, within an inner scope created with the curly
+brackets, the third let statement also shadows x and creates a new
+variable, multiplying the previous value by 2 to give x a value of 12.
+When that scope is over, the inner shadowing ends and x returns to being 6.
+When we run this program, it will output the following:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/variables`
+The value of x in the inner scope is: 12
+The value of x is: 6
+
+
Shadowing is different from marking a variable as mut because we’ll get a
+compile-time error if we accidentally try to reassign to this variable without
+using the let keyword. By using let, we can perform a few transformations
+on a value but have the variable be immutable after those transformations have
+been completed.
+
The other difference between mut and shadowing is that because we’re
+effectively creating a new variable when we use the let keyword again, we can
+change the type of the value but reuse the same name. For example, say our
+program asks a user to show how many spaces they want between some text by
+inputting space characters, and then we want to store that input as a number:
+
fn main() {
+ let spaces = " ";
+ let spaces = spaces.len();
+}
+
The first spaces variable is a string type and the second spaces variable
+is a number type. Shadowing thus spares us from having to come up with
+different names, such as spaces_str and spaces_num; instead, we can reuse
+the simpler spaces name. However, if we try to use mut for this, as shown
+here, we’ll get a compile-time error:
The error says we’re not allowed to mutate a variable’s type:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+error[E0308]: mismatched types
+ --> src/main.rs:3:14
+ |
+2 | let mut spaces = " ";
+ | ----- expected due to this value
+3 | spaces = spaces.len();
+ | ^^^^^^^^^^^^ expected `&str`, found `usize`
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `variables` (bin "variables") due to 1 previous error
+
+
Now that we’ve explored how variables work, let’s look at more data types they
+can have.
Every value in Rust is of a certain data type, which tells Rust what kind of
+data is being specified so it knows how to work with that data. We’ll look at
+two data type subsets: scalar and compound.
+
Keep in mind that Rust is a statically typed language, which means that it
+must know the types of all variables at compile time. The compiler can usually
+infer what type we want to use based on the value and how we use it. In cases
+when many types are possible, such as when we converted a String to a numeric
+type using parse in the “Comparing the Guess to the Secret
+Number” section in
+Chapter 2, we must add a type annotation, like this:
If we don’t add the : u32 type annotation shown in the preceding code, Rust
+will display the following error, which means the compiler needs more
+information from us to know which type we want to use:
+
$ cargo build
+ Compiling no_type_annotations v0.1.0 (file:///projects/no_type_annotations)
+error[E0284]: type annotations needed
+ --> src/main.rs:2:9
+ |
+2 | let guess = "42".parse().expect("Not a number!");
+ | ^^^^^ ----- type must be known at this point
+ |
+ = note: cannot satisfy `<_ as FromStr>::Err == _`
+help: consider giving `guess` an explicit type
+ |
+2 | let guess: /* Type */ = "42".parse().expect("Not a number!");
+ | ++++++++++++
+
+For more information about this error, try `rustc --explain E0284`.
+error: could not compile `no_type_annotations` (bin "no_type_annotations") due to 1 previous error
+
+
You’ll see different type annotations for other data types.
A scalar type represents a single value. Rust has four primary scalar types:
+integers, floating-point numbers, Booleans, and characters. You may recognize
+these from other programming languages. Let’s jump into how they work in Rust.
An integer is a number without a fractional component. We used one integer
+type in Chapter 2, the u32 type. This type declaration indicates that the
+value it’s associated with should be an unsigned integer (signed integer types
+start with i instead of u) that takes up 32 bits of space. Table 3-1 shows
+the built-in integer types in Rust. We can use any of these variants to declare
+the type of an integer value.
+
Table 3-1: Integer Types in Rust
+
Length
Signed
Unsigned
+
8-bit
i8
u8
+
16-bit
i16
u16
+
32-bit
i32
u32
+
64-bit
i64
u64
+
128-bit
i128
u128
+
arch
isize
usize
+
+
+
Each variant can be either signed or unsigned and has an explicit size.
+Signed and unsigned refer to whether it’s possible for the number to be
+negative—in other words, whether the number needs to have a sign with it
+(signed) or whether it will only ever be positive and can therefore be
+represented without a sign (unsigned). It’s like writing numbers on paper: when
+the sign matters, a number is shown with a plus sign or a minus sign; however,
+when it’s safe to assume the number is positive, it’s shown with no sign.
+Signed numbers are stored using two’s complement representation.
+
Each signed variant can store numbers from -(2n - 1) to 2n -
+1 - 1 inclusive, where n is the number of bits that variant uses. So an
+i8 can store numbers from -(27) to 27 - 1, which equals
+-128 to 127. Unsigned variants can store numbers from 0 to 2n - 1,
+so a u8 can store numbers from 0 to 28 - 1, which equals 0 to 255.
+
Additionally, the isize and usize types depend on the architecture of the
+computer your program is running on, which is denoted in the table as “arch”:
+64 bits if you’re on a 64-bit architecture and 32 bits if you’re on a 32-bit
+architecture.
+
You can write integer literals in any of the forms shown in Table 3-2. Note
+that number literals that can be multiple numeric types allow a type suffix,
+such as 57u8, to designate the type. Number literals can also use _ as a
+visual separator to make the number easier to read, such as 1_000, which will
+have the same value as if you had specified 1000.
+
Table 3-2: Integer Literals in Rust
+
Number literals
Example
+
Decimal
98_222
+
Hex
0xff
+
Octal
0o77
+
Binary
0b1111_0000
+
Byte (u8 only)
b'A'
+
+
+
So how do you know which type of integer to use? If you’re unsure, Rust’s
+defaults are generally good places to start: integer types default to i32.
+The primary situation in which you’d use isize or usize is when indexing
+some sort of collection.
Let’s say you have a variable of type u8 that can hold values between 0 and
+255. If you try to change the variable to a value outside that range, such as
+256, integer overflow will occur, which can result in one of two behaviors.
+When you’re compiling in debug mode, Rust includes checks for integer overflow
+that cause your program to panic at runtime if this behavior occurs. Rust
+uses the term panicking when a program exits with an error; we’ll discuss
+panics in more depth in the “Unrecoverable Errors with
+panic!” section in Chapter
+9.
+
When you’re compiling in release mode with the --release flag, Rust does
+not include checks for integer overflow that cause panics. Instead, if
+overflow occurs, Rust performs two’s complement wrapping. In short, values
+greater than the maximum value the type can hold “wrap around” to the minimum
+of the values the type can hold. In the case of a u8, the value 256 becomes
+0, the value 257 becomes 1, and so on. The program won’t panic, but the
+variable will have a value that probably isn’t what you were expecting it to
+have. Relying on integer overflow’s wrapping behavior is considered an error.
+
To explicitly handle the possibility of overflow, you can use these families
+of methods provided by the standard library for primitive numeric types:
+
+
Wrap in all modes with the wrapping_* methods, such as wrapping_add.
+
Return the None value if there is overflow with the checked_* methods.
+
Return the value and a boolean indicating whether there was overflow with
+the overflowing_* methods.
+
Saturate at the value’s minimum or maximum values with the saturating_*
+methods.
Rust also has two primitive types for floating-point numbers, which are
+numbers with decimal points. Rust’s floating-point types are f32 and f64,
+which are 32 bits and 64 bits in size, respectively. The default type is f64
+because on modern CPUs, it’s roughly the same speed as f32 but is capable of
+more precision. All floating-point types are signed.
+
Here’s an example that shows floating-point numbers in action:
+
Filename: src/main.rs
+
fn main() {
+ let x = 2.0; // f64
+
+ let y: f32 = 3.0; // f32
+}
+
Floating-point numbers are represented according to the IEEE-754 standard. The
+f32 type is a single-precision float, and f64 has double precision.
Rust supports the basic mathematical operations you’d expect for all the number
+types: addition, subtraction, multiplication, division, and remainder. Integer
+division truncates toward zero to the nearest integer. The following code shows
+how you’d use each numeric operation in a let statement:
+
Filename: src/main.rs
+
fn main() {
+ // addition
+ let sum = 5 + 10;
+
+ // subtraction
+ let difference = 95.5 - 4.3;
+
+ // multiplication
+ let product = 4 * 30;
+
+ // division
+ let quotient = 56.7 / 32.2;
+ let truncated = -5 / 3; // Results in -1
+
+ // remainder
+ let remainder = 43 % 5;
+}
+
Each expression in these statements uses a mathematical operator and evaluates
+to a single value, which is then bound to a variable. Appendix
+B contains a list of all operators that Rust
+provides.
As in most other programming languages, a Boolean type in Rust has two possible
+values: true and false. Booleans are one byte in size. The Boolean type in
+Rust is specified using bool. For example:
+
Filename: src/main.rs
+
fn main() {
+ let t = true;
+
+ let f: bool = false; // with explicit type annotation
+}
+
The main way to use Boolean values is through conditionals, such as an if
+expression. We’ll cover how if expressions work in Rust in the “Control
+Flow” section.
Rust’s char type is the language’s most primitive alphabetic type. Here are
+some examples of declaring char values:
+
Filename: src/main.rs
+
fn main() {
+ let c = 'z';
+ let z: char = 'ℤ'; // with explicit type annotation
+ let heart_eyed_cat = '😻';
+}
+
Note that we specify char literals with single quotes, as opposed to string
+literals, which use double quotes. Rust’s char type is four bytes in size and
+represents a Unicode Scalar Value, which means it can represent a lot more than
+just ASCII. Accented letters; Chinese, Japanese, and Korean characters; emoji;
+and zero-width spaces are all valid char values in Rust. Unicode Scalar
+Values range from U+0000 to U+D7FF and U+E000 to U+10FFFF inclusive.
+However, a “character” isn’t really a concept in Unicode, so your human
+intuition for what a “character” is may not match up with what a char is in
+Rust. We’ll discuss this topic in detail in “Storing UTF-8 Encoded Text with
+Strings” in Chapter 8.
A tuple is a general way of grouping together a number of values with a
+variety of types into one compound type. Tuples have a fixed length: once
+declared, they cannot grow or shrink in size.
+
We create a tuple by writing a comma-separated list of values inside
+parentheses. Each position in the tuple has a type, and the types of the
+different values in the tuple don’t have to be the same. We’ve added optional
+type annotations in this example:
The variable tup binds to the entire tuple because a tuple is considered a
+single compound element. To get the individual values out of a tuple, we can
+use pattern matching to destructure a tuple value, like this:
+
Filename: src/main.rs
+
fn main() {
+ let tup = (500, 6.4, 1);
+
+ let (x, y, z) = tup;
+
+ println!("The value of y is: {y}");
+}
+
This program first creates a tuple and binds it to the variable tup. It then
+uses a pattern with let to take tup and turn it into three separate
+variables, x, y, and z. This is called destructuring because it breaks
+the single tuple into three parts. Finally, the program prints the value of
+y, which is 6.4.
+
We can also access a tuple element directly by using a period (.) followed by
+the index of the value we want to access. For example:
+
Filename: src/main.rs
+
fn main() {
+ let x: (i32, f64, u8) = (500, 6.4, 1);
+
+ let five_hundred = x.0;
+
+ let six_point_four = x.1;
+
+ let one = x.2;
+}
+
This program creates the tuple x and then accesses each element of the tuple
+using their respective indices. As with most programming languages, the first
+index in a tuple is 0.
+
The tuple without any values has a special name, unit. This value and its
+corresponding type are both written () and represent an empty value or an
+empty return type. Expressions implicitly return the unit value if they don’t
+return any other value.
Another way to have a collection of multiple values is with an array. Unlike
+a tuple, every element of an array must have the same type. Unlike arrays in
+some other languages, arrays in Rust have a fixed length.
+
We write the values in an array as a comma-separated list inside square
+brackets:
+
Filename: src/main.rs
+
fn main() {
+ let a = [1, 2, 3, 4, 5];
+}
+
Arrays are useful when you want your data allocated on the stack rather than
+the heap (we will discuss the stack and the heap more in Chapter
+4) or when you want to ensure you always have a
+fixed number of elements. An array isn’t as flexible as the vector type,
+though. A vector is a similar collection type provided by the standard
+library that is allowed to grow or shrink in size. If you’re unsure whether
+to use an array or a vector, chances are you should use a vector. Chapter
+8 discusses vectors in more detail.
+
However, arrays are more useful when you know the number of elements will not
+need to change. For example, if you were using the names of the month in a
+program, you would probably use an array rather than a vector because you know
+it will always contain 12 elements:
Here, i32 is the type of each element. After the semicolon, the number 5
+indicates the array contains five elements.
+
You can also initialize an array to contain the same value for each element by
+specifying the initial value, followed by a semicolon, and then the length of
+the array in square brackets, as shown here:
+
#![allow(unused)]
+fn main() {
+let a = [3; 5];
+}
+
The array named a will contain 5 elements that will all be set to the value
+3 initially. This is the same as writing let a = [3, 3, 3, 3, 3]; but in a
+more concise way.
An array is a single chunk of memory of a known, fixed size that can be
+allocated on the stack. You can access elements of an array using indexing,
+like this:
+
Filename: src/main.rs
+
fn main() {
+ let a = [1, 2, 3, 4, 5];
+
+ let first = a[0];
+ let second = a[1];
+}
+
In this example, the variable named first will get the value 1 because that
+is the value at index [0] in the array. The variable named second will get
+the value 2 from index [1] in the array.
Let’s see what happens if you try to access an element of an array that is past
+the end of the array. Say you run this code, similar to the guessing game in
+Chapter 2, to get an array index from the user:
+
Filename: src/main.rs
+
use std::io;
+
+fn main() {
+ let a = [1, 2, 3, 4, 5];
+
+ println!("Please enter an array index.");
+
+ let mut index = String::new();
+
+ io::stdin()
+ .read_line(&mut index)
+ .expect("Failed to read line");
+
+ let index: usize = index
+ .trim()
+ .parse()
+ .expect("Index entered was not a number");
+
+ let element = a[index];
+
+ println!("The value of the element at index {index} is: {element}");
+}
+
This code compiles successfully. If you run this code using cargo run and
+enter 0, 1, 2, 3, or 4, the program will print out the corresponding
+value at that index in the array. If you instead enter a number past the end of
+the array, such as 10, you’ll see output like this:
+
+
thread 'main' panicked at src/main.rs:19:19:
+index out of bounds: the len is 5 but the index is 10
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
The program resulted in a runtime error at the point of using an invalid
+value in the indexing operation. The program exited with an error message and
+didn’t execute the final println! statement. When you attempt to access an
+element using indexing, Rust will check that the index you’ve specified is less
+than the array length. If the index is greater than or equal to the length,
+Rust will panic. This check has to happen at runtime, especially in this case,
+because the compiler can’t possibly know what value a user will enter when they
+run the code later.
+
This is an example of Rust’s memory safety principles in action. In many
+low-level languages, this kind of check is not done, and when you provide an
+incorrect index, invalid memory can be accessed. Rust protects you against this
+kind of error by immediately exiting instead of allowing the memory access and
+continuing. Chapter 9 discusses more of Rust’s error handling and how you can
+write readable, safe code that neither panics nor allows invalid memory access.
Functions are prevalent in Rust code. You’ve already seen one of the most
+important functions in the language: the main function, which is the entry
+point of many programs. You’ve also seen the fn keyword, which allows you to
+declare new functions.
+
Rust code uses snake case as the conventional style for function and variable
+names, in which all letters are lowercase and underscores separate words.
+Here’s a program that contains an example function definition:
We define a function in Rust by entering fn followed by a function name and a
+set of parentheses. The curly brackets tell the compiler where the function
+body begins and ends.
+
We can call any function we’ve defined by entering its name followed by a set
+of parentheses. Because another_function is defined in the program, it can be
+called from inside the main function. Note that we defined another_function
+after the main function in the source code; we could have defined it before
+as well. Rust doesn’t care where you define your functions, only that they’re
+defined somewhere in a scope that can be seen by the caller.
+
Let’s start a new binary project named functions to explore functions
+further. Place the another_function example in src/main.rs and run it. You
+should see the following output:
The lines execute in the order in which they appear in the main function.
+First the “Hello, world!” message prints, and then another_function is called
+and its message is printed.
We can define functions to have parameters, which are special variables that
+are part of a function’s signature. When a function has parameters, you can
+provide it with concrete values for those parameters. Technically, the concrete
+values are called arguments, but in casual conversation, people tend to use
+the words parameter and argument interchangeably for either the variables
+in a function’s definition or the concrete values passed in when you call a
+function.
+
In this version of another_function we add a parameter:
+
Filename: src/main.rs
+
fn main() {
+ another_function(5);
+}
+
+fn another_function(x: i32) {
+ println!("The value of x is: {x}");
+}
+
Try running this program; you should get the following output:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.21s
+ Running `target/debug/functions`
+The value of x is: 5
+
+
The declaration of another_function has one parameter named x. The type of
+x is specified as i32. When we pass 5 in to another_function, the
+println! macro puts 5 where the pair of curly brackets containing x was
+in the format string.
+
In function signatures, you must declare the type of each parameter. This is
+a deliberate decision in Rust’s design: requiring type annotations in function
+definitions means the compiler almost never needs you to use them elsewhere in
+the code to figure out what type you mean. The compiler is also able to give
+more helpful error messages if it knows what types the function expects.
+
When defining multiple parameters, separate the parameter declarations with
+commas, like this:
This example creates a function named print_labeled_measurement with two
+parameters. The first parameter is named value and is an i32. The second is
+named unit_label and is type char. The function then prints text containing
+both the value and the unit_label.
+
Let’s try running this code. Replace the program currently in your functions
+project’s src/main.rs file with the preceding example and run it using cargo run:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/functions`
+The measurement is: 5h
+
+
Because we called the function with 5 as the value for value and 'h' as
+the value for unit_label, the program output contains those values.
Function bodies are made up of a series of statements optionally ending in an
+expression. So far, the functions we’ve covered haven’t included an ending
+expression, but you have seen an expression as part of a statement. Because
+Rust is an expression-based language, this is an important distinction to
+understand. Other languages don’t have the same distinctions, so let’s look at
+what statements and expressions are and how their differences affect the bodies
+of functions.
+
+
Statements are instructions that perform some action and do not return
+a value.
+
Expressions evaluate to a resultant value. Let’s look at some examples.
+
+
We’ve actually already used statements and expressions. Creating a variable and
+assigning a value to it with the let keyword is a statement. In Listing 3-1,
+let y = 6; is a statement.
+
+Filename: src/main.rs
+
fn main() {
+ let y = 6;
+}
+Listing 3-1: A main function declaration containing one statement
+
+
Function definitions are also statements; the entire preceding example is a
+statement in itself.
+
Statements do not return values. Therefore, you can’t assign a let statement
+to another variable, as the following code tries to do; you’ll get an error:
+
Filename: src/main.rs
+
fn main() {
+ let x = (let y = 6);
+}
+
When you run this program, the error you’ll get looks like this:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+error: expected expression, found `let` statement
+ --> src/main.rs:2:14
+ |
+2 | let x = (let y = 6);
+ | ^^^
+ |
+ = note: only supported directly in conditions of `if` and `while` expressions
+
+warning: unnecessary parentheses around assigned value
+ --> src/main.rs:2:13
+ |
+2 | let x = (let y = 6);
+ | ^ ^
+ |
+ = note: `#[warn(unused_parens)]` on by default
+help: remove these parentheses
+ |
+2 - let x = (let y = 6);
+2 + let x = let y = 6;
+ |
+
+warning: `functions` (bin "functions") generated 1 warning
+error: could not compile `functions` (bin "functions") due to 1 previous error; 1 warning emitted
+
+
The let y = 6 statement does not return a value, so there isn’t anything for
+x to bind to. This is different from what happens in other languages, such as
+C and Ruby, where the assignment returns the value of the assignment. In those
+languages, you can write x = y = 6 and have both x and y have the value
+6; that is not the case in Rust.
+
Expressions evaluate to a value and make up most of the rest of the code that
+you’ll write in Rust. Consider a math operation, such as 5 + 6, which is an
+expression that evaluates to the value 11. Expressions can be part of
+statements: in Listing 3-1, the 6 in the statement let y = 6; is an
+expression that evaluates to the value 6. Calling a function is an
+expression. Calling a macro is an expression. A new scope block created with
+curly brackets is an expression, for example:
+
Filename: src/main.rs
+
fn main() {
+ let y = {
+ let x = 3;
+ x + 1
+ };
+
+ println!("The value of y is: {y}");
+}
+
This expression:
+
{
+ let x = 3;
+ x + 1
+}
+
is a block that, in this case, evaluates to 4. That value gets bound to y
+as part of the let statement. Note that the x + 1 line doesn’t have a
+semicolon at the end, which is unlike most of the lines you’ve seen so far.
+Expressions do not include ending semicolons. If you add a semicolon to the end
+of an expression, you turn it into a statement, and it will then not return a
+value. Keep this in mind as you explore function return values and expressions
+next.
Functions can return values to the code that calls them. We don’t name return
+values, but we must declare their type after an arrow (->). In Rust, the
+return value of the function is synonymous with the value of the final
+expression in the block of the body of a function. You can return early from a
+function by using the return keyword and specifying a value, but most
+functions return the last expression implicitly. Here’s an example of a
+function that returns a value:
+
Filename: src/main.rs
+
fn five() -> i32 {
+ 5
+}
+
+fn main() {
+ let x = five();
+
+ println!("The value of x is: {x}");
+}
+
There are no function calls, macros, or even let statements in the five
+function—just the number 5 by itself. That’s a perfectly valid function in
+Rust. Note that the function’s return type is specified too, as -> i32. Try
+running this code; the output should look like this:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.30s
+ Running `target/debug/functions`
+The value of x is: 5
+
+
The 5 in five is the function’s return value, which is why the return type
+is i32. Let’s examine this in more detail. There are two important bits:
+first, the line let x = five(); shows that we’re using the return value of a
+function to initialize a variable. Because the function five returns a 5,
+that line is the same as the following:
+
#![allow(unused)]
+fn main() {
+let x = 5;
+}
+
Second, the five function has no parameters and defines the type of the
+return value, but the body of the function is a lonely 5 with no semicolon
+because it’s an expression whose value we want to return.
+
Let’s look at another example:
+
Filename: src/main.rs
+
fn main() {
+ let x = plus_one(5);
+
+ println!("The value of x is: {x}");
+}
+
+fn plus_one(x: i32) -> i32 {
+ x + 1
+}
+
Running this code will print The value of x is: 6. But if we place a
+semicolon at the end of the line containing x + 1, changing it from an
+expression to a statement, we’ll get an error:
+
Filename: src/main.rs
+
fn main() {
+ let x = plus_one(5);
+
+ println!("The value of x is: {x}");
+}
+
+fn plus_one(x: i32) -> i32 {
+ x + 1;
+}
+
Compiling this code produces an error, as follows:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+error[E0308]: mismatched types
+ --> src/main.rs:7:24
+ |
+7 | fn plus_one(x: i32) -> i32 {
+ | -------- ^^^ expected `i32`, found `()`
+ | |
+ | implicitly returns `()` as its body has no tail or `return` expression
+8 | x + 1;
+ | - help: remove this semicolon to return this value
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `functions` (bin "functions") due to 1 previous error
+
+
The main error message, mismatched types, reveals the core issue with this
+code. The definition of the function plus_one says that it will return an
+i32, but statements don’t evaluate to a value, which is expressed by (),
+the unit type. Therefore, nothing is returned, which contradicts the function
+definition and results in an error. In this output, Rust provides a message to
+possibly help rectify this issue: it suggests removing the semicolon, which
+would fix the error.
All programmers strive to make their code easy to understand, but sometimes
+extra explanation is warranted. In these cases, programmers leave comments in
+their source code that the compiler will ignore but people reading the source
+code may find useful.
+
Here’s a simple comment:
+
#![allow(unused)]
+fn main() {
+// hello, world
+}
+
In Rust, the idiomatic comment style starts a comment with two slashes, and the
+comment continues until the end of the line. For comments that extend beyond a
+single line, you’ll need to include // on each line, like this:
+
#![allow(unused)]
+fn main() {
+// So we’re doing something complicated here, long enough that we need
+// multiple lines of comments to do it! Whew! Hopefully, this comment will
+// explain what’s going on.
+}
+
Comments can also be placed at the end of lines containing code:
The ability to run some code depending on whether a condition is true and to
+run some code repeatedly while a condition is true are basic building blocks
+in most programming languages. The most common constructs that let you control
+the flow of execution of Rust code are if expressions and loops.
An if expression allows you to branch your code depending on conditions. You
+provide a condition and then state, “If this condition is met, run this block
+of code. If the condition is not met, do not run this block of code.”
+
Create a new project called branches in your projects directory to explore
+the if expression. In the src/main.rs file, input the following:
+
Filename: src/main.rs
+
fn main() {
+ let number = 3;
+
+ if number < 5 {
+ println!("condition was true");
+ } else {
+ println!("condition was false");
+ }
+}
+
All if expressions start with the keyword if, followed by a condition. In
+this case, the condition checks whether or not the variable number has a
+value less than 5. We place the block of code to execute if the condition is
+true immediately after the condition inside curly brackets. Blocks of code
+associated with the conditions in if expressions are sometimes called arms,
+just like the arms in match expressions that we discussed in the “Comparing
+the Guess to the Secret Number” section of Chapter 2.
+
Optionally, we can also include an else expression, which we chose to do
+here, to give the program an alternative block of code to execute should the
+condition evaluate to false. If you don’t provide an else expression and
+the condition is false, the program will just skip the if block and move on
+to the next bit of code.
+
Try running this code; you should see the following output:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/branches`
+condition was true
+
+
Let’s try changing the value of number to a value that makes the condition
+false to see what happens:
+
fn main() {
+ let number = 7;
+
+ if number < 5 {
+ println!("condition was true");
+ } else {
+ println!("condition was false");
+ }
+}
+
Run the program again, and look at the output:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/branches`
+condition was false
+
+
It’s also worth noting that the condition in this code must be a bool. If
+the condition isn’t a bool, we’ll get an error. For example, try running the
+following code:
+
Filename: src/main.rs
+
fn main() {
+ let number = 3;
+
+ if number {
+ println!("number was three");
+ }
+}
+
The if condition evaluates to a value of 3 this time, and Rust throws an
+error:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+error[E0308]: mismatched types
+ --> src/main.rs:4:8
+ |
+4 | if number {
+ | ^^^^^^ expected `bool`, found integer
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `branches` (bin "branches") due to 1 previous error
+
+
The error indicates that Rust expected a bool but got an integer. Unlike
+languages such as Ruby and JavaScript, Rust will not automatically try to
+convert non-Boolean types to a Boolean. You must be explicit and always provide
+if with a Boolean as its condition. If we want the if code block to run
+only when a number is not equal to 0, for example, we can change the if
+expression to the following:
+
Filename: src/main.rs
+
fn main() {
+ let number = 3;
+
+ if number != 0 {
+ println!("number was something other than zero");
+ }
+}
+
Running this code will print number was something other than zero.
You can use multiple conditions by combining if and else in an else if
+expression. For example:
+
Filename: src/main.rs
+
fn main() {
+ let number = 6;
+
+ if number % 4 == 0 {
+ println!("number is divisible by 4");
+ } else if number % 3 == 0 {
+ println!("number is divisible by 3");
+ } else if number % 2 == 0 {
+ println!("number is divisible by 2");
+ } else {
+ println!("number is not divisible by 4, 3, or 2");
+ }
+}
+
This program has four possible paths it can take. After running it, you should
+see the following output:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/branches`
+number is divisible by 3
+
+
When this program executes, it checks each if expression in turn and executes
+the first body for which the condition evaluates to true. Note that even
+though 6 is divisible by 2, we don’t see the output number is divisible by 2,
+nor do we see the number is not divisible by 4, 3, or 2 text from the else
+block. That’s because Rust only executes the block for the first true
+condition, and once it finds one, it doesn’t even check the rest.
+
Using too many else if expressions can clutter your code, so if you have more
+than one, you might want to refactor your code. Chapter 6 describes a powerful
+Rust branching construct called match for these cases.
Because if is an expression, we can use it on the right side of a let
+statement to assign the outcome to a variable, as in Listing 3-2.
+
+Filename: src/main.rs
+
fn main() {
+ let condition = true;
+ let number = if condition { 5 } else { 6 };
+
+ println!("The value of number is: {number}");
+}
+Listing 3-2: Assigning the result of an if expression to a variable
+
+
The number variable will be bound to a value based on the outcome of the if
+expression. Run this code to see what happens:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.30s
+ Running `target/debug/branches`
+The value of number is: 5
+
+
Remember that blocks of code evaluate to the last expression in them, and
+numbers by themselves are also expressions. In this case, the value of the
+whole if expression depends on which block of code executes. This means the
+values that have the potential to be results from each arm of the if must be
+the same type; in Listing 3-2, the results of both the if arm and the else
+arm were i32 integers. If the types are mismatched, as in the following
+example, we’ll get an error:
+
Filename: src/main.rs
+
fn main() {
+ let condition = true;
+
+ let number = if condition { 5 } else { "six" };
+
+ println!("The value of number is: {number}");
+}
+
When we try to compile this code, we’ll get an error. The if and else arms
+have value types that are incompatible, and Rust indicates exactly where to
+find the problem in the program:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+error[E0308]: `if` and `else` have incompatible types
+ --> src/main.rs:4:44
+ |
+4 | let number = if condition { 5 } else { "six" };
+ | - ^^^^^ expected integer, found `&str`
+ | |
+ | expected because of this
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `branches` (bin "branches") due to 1 previous error
+
+
The expression in the if block evaluates to an integer, and the expression in
+the else block evaluates to a string. This won’t work because variables must
+have a single type, and Rust needs to know at compile time what type the
+number variable is, definitively. Knowing the type of number lets the
+compiler verify the type is valid everywhere we use number. Rust wouldn’t be
+able to do that if the type of number was only determined at runtime; the
+compiler would be more complex and would make fewer guarantees about the code
+if it had to keep track of multiple hypothetical types for any variable.
It’s often useful to execute a block of code more than once. For this task,
+Rust provides several loops, which will run through the code inside the loop
+body to the end and then start immediately back at the beginning. To experiment
+with loops, let’s make a new project called loops.
+
Rust has three kinds of loops: loop, while, and for. Let’s try each one.
The loop keyword tells Rust to execute a block of code over and over again
+forever or until you explicitly tell it to stop.
+
As an example, change the src/main.rs file in your loops directory to look
+like this:
+
Filename: src/main.rs
+
fn main() {
+ loop {
+ println!("again!");
+ }
+}
+
When we run this program, we’ll see again! printed over and over continuously
+until we stop the program manually. Most terminals support the keyboard shortcut
+ctrl-c to interrupt a program that is stuck in a continual
+loop. Give it a try:
+
+
$ cargo run
+ Compiling loops v0.1.0 (file:///projects/loops)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.29s
+ Running `target/debug/loops`
+again!
+again!
+again!
+again!
+^Cagain!
+
+
The symbol ^C represents where you pressed ctrl-c. You
+may or may not see the word again! printed after the ^C, depending on where
+the code was in the loop when it received the interrupt signal.
+
Fortunately, Rust also provides a way to break out of a loop using code. You
+can place the break keyword within the loop to tell the program when to stop
+executing the loop. Recall that we did this in the guessing game in the
+“Quitting After a Correct Guess” section of Chapter 2 to exit the program when the user won the game by
+guessing the correct number.
+
We also used continue in the guessing game, which in a loop tells the program
+to skip over any remaining code in this iteration of the loop and go to the
+next iteration.
One of the uses of a loop is to retry an operation you know might fail, such
+as checking whether a thread has completed its job. You might also need to pass
+the result of that operation out of the loop to the rest of your code. To do
+this, you can add the value you want returned after the break expression you
+use to stop the loop; that value will be returned out of the loop so you can
+use it, as shown here:
+
fn main() {
+ let mut counter = 0;
+
+ let result = loop {
+ counter += 1;
+
+ if counter == 10 {
+ break counter * 2;
+ }
+ };
+
+ println!("The result is {result}");
+}
+
Before the loop, we declare a variable named counter and initialize it to
+0. Then we declare a variable named result to hold the value returned from
+the loop. On every iteration of the loop, we add 1 to the counter variable,
+and then check whether the counter is equal to 10. When it is, we use the
+break keyword with the value counter * 2. After the loop, we use a
+semicolon to end the statement that assigns the value to result. Finally, we
+print the value in result, which in this case is 20.
+
You can also return from inside a loop. While break only exits the current
+loop, return always exits the current function.
If you have loops within loops, break and continue apply to the innermost
+loop at that point. You can optionally specify a loop label on a loop that
+you can then use with break or continue to specify that those keywords
+apply to the labeled loop instead of the innermost loop. Loop labels must begin
+with a single quote. Here’s an example with two nested loops:
The outer loop has the label 'counting_up, and it will count up from 0 to 2.
+The inner loop without a label counts down from 10 to 9. The first break that
+doesn’t specify a label will exit the inner loop only. The break 'counting_up; statement will exit the outer loop. This code prints:
A program will often need to evaluate a condition within a loop. While the
+condition is true, the loop runs. When the condition ceases to be true, the
+program calls break, stopping the loop. It’s possible to implement behavior
+like this using a combination of loop, if, else, and break; you could
+try that now in a program, if you’d like. However, this pattern is so common
+that Rust has a built-in language construct for it, called a while loop. In
+Listing 3-3, we use while to loop the program three times, counting down each
+time, and then, after the loop, print a message and exit.
+
+Filename: src/main.rs
+
fn main() {
+ let mut number = 3;
+
+ while number != 0 {
+ println!("{number}!");
+
+ number -= 1;
+ }
+
+ println!("LIFTOFF!!!");
+}
+Listing 3-3: Using a while loop to run code while a condition holds true
+
+
This construct eliminates a lot of nesting that would be necessary if you used
+loop, if, else, and break, and it’s clearer. While a condition
+evaluates to true, the code runs; otherwise, it exits the loop.
You can also use the while construct to loop over the elements of a
+collection, such as an array. For example, the loop in Listing 3-4 prints each
+element in the array a.
+
+Filename: src/main.rs
+
fn main() {
+ let a = [10, 20, 30, 40, 50];
+ let mut index = 0;
+
+ while index < 5 {
+ println!("the value is: {}", a[index]);
+
+ index += 1;
+ }
+}
+Listing 3-4: Looping through each element of a collection using a while loop
+
+
Here, the code counts up through the elements in the array. It starts at index
+0, and then loops until it reaches the final index in the array (that is,
+when index < 5 is no longer true). Running this code will print every
+element in the array:
+
$ cargo run
+ Compiling loops v0.1.0 (file:///projects/loops)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.32s
+ Running `target/debug/loops`
+the value is: 10
+the value is: 20
+the value is: 30
+the value is: 40
+the value is: 50
+
+
All five array values appear in the terminal, as expected. Even though index
+will reach a value of 5 at some point, the loop stops executing before trying
+to fetch a sixth value from the array.
+
However, this approach is error prone; we could cause the program to panic if
+the index value or test condition is incorrect. For example, if you changed the
+definition of the a array to have four elements but forgot to update the
+condition to while index < 4, the code would panic. It’s also slow, because
+the compiler adds runtime code to perform the conditional check of whether the
+index is within the bounds of the array on every iteration through the loop.
+
As a more concise alternative, you can use a for loop and execute some code
+for each item in a collection. A for loop looks like the code in Listing 3-5.
+
+Filename: src/main.rs
+
fn main() {
+ let a = [10, 20, 30, 40, 50];
+
+ for element in a {
+ println!("the value is: {element}");
+ }
+}
+Listing 3-5: Looping through each element of a collection using a for loop
+
+
When we run this code, we’ll see the same output as in Listing 3-4. More
+importantly, we’ve now increased the safety of the code and eliminated the
+chance of bugs that might result from going beyond the end of the array or not
+going far enough and missing some items.
+
Using the for loop, you wouldn’t need to remember to change any other code if
+you changed the number of values in the array, as you would with the method
+used in Listing 3-4.
+
The safety and conciseness of for loops make them the most commonly used loop
+construct in Rust. Even in situations in which you want to run some code a
+certain number of times, as in the countdown example that used a while loop
+in Listing 3-3, most Rustaceans would use a for loop. The way to do that
+would be to use a Range, provided by the standard library, which generates
+all numbers in sequence starting from one number and ending before another
+number.
+
Here’s what the countdown would look like using a for loop and another method
+we’ve not yet talked about, rev, to reverse the range:
+
Filename: src/main.rs
+
fn main() {
+ for number in (1..4).rev() {
+ println!("{number}!");
+ }
+ println!("LIFTOFF!!!");
+}
You made it! This was a sizable chapter: you learned about variables, scalar
+and compound data types, functions, comments, if expressions, and loops! To
+practice with the concepts discussed in this chapter, try building programs to
+do the following:
+
+
Convert temperatures between Fahrenheit and Celsius.
+
Generate the nth Fibonacci number.
+
Print the lyrics to the Christmas carol “The Twelve Days of Christmas,”
+taking advantage of the repetition in the song.
+
+
When you’re ready to move on, we’ll talk about a concept in Rust that doesn’t
+commonly exist in other programming languages: ownership.
Ownership is Rust’s most unique feature and has deep implications for the rest
+of the language. It enables Rust to make memory safety guarantees without
+needing a garbage collector, so it’s important to understand how ownership
+works. In this chapter, we’ll talk about ownership as well as several related
+features: borrowing, slices, and how Rust lays data out in memory.
Ownership is a set of rules that govern how a Rust program manages memory.
+All programs have to manage the way they use a computer’s memory while running.
+Some languages have garbage collection that regularly looks for no-longer-used
+memory as the program runs; in other languages, the programmer must explicitly
+allocate and free the memory. Rust uses a third approach: memory is managed
+through a system of ownership with a set of rules that the compiler checks. If
+any of the rules are violated, the program won’t compile. None of the features
+of ownership will slow down your program while it’s running.
+
Because ownership is a new concept for many programmers, it does take some time
+to get used to. The good news is that the more experienced you become with Rust
+and the rules of the ownership system, the easier you’ll find it to naturally
+develop code that is safe and efficient. Keep at it!
+
When you understand ownership, you’ll have a solid foundation for understanding
+the features that make Rust unique. In this chapter, you’ll learn ownership by
+working through some examples that focus on a very common data structure:
+strings.
Many programming languages don’t require you to think about the stack and the
+heap very often. But in a systems programming language like Rust, whether a
+value is on the stack or the heap affects how the language behaves and why
+you have to make certain decisions. Parts of ownership will be described in
+relation to the stack and the heap later in this chapter, so here is a brief
+explanation in preparation.
+
Both the stack and the heap are parts of memory available to your code to use
+at runtime, but they are structured in different ways. The stack stores
+values in the order it gets them and removes the values in the opposite
+order. This is referred to as last in, first out. Think of a stack of
+plates: when you add more plates, you put them on top of the pile, and when
+you need a plate, you take one off the top. Adding or removing plates from
+the middle or bottom wouldn’t work as well! Adding data is called pushing
+onto the stack, and removing data is called popping off the stack. All
+data stored on the stack must have a known, fixed size. Data with an unknown
+size at compile time or a size that might change must be stored on the heap
+instead.
+
The heap is less organized: when you put data on the heap, you request a
+certain amount of space. The memory allocator finds an empty spot in the heap
+that is big enough, marks it as being in use, and returns a pointer, which
+is the address of that location. This process is called allocating on the
+heap and is sometimes abbreviated as just allocating (pushing values onto
+the stack is not considered allocating). Because the pointer to the heap is a
+known, fixed size, you can store the pointer on the stack, but when you want
+the actual data, you must follow the pointer. Think of being seated at a
+restaurant. When you enter, you state the number of people in your group, and
+the host finds an empty table that fits everyone and leads you there. If
+someone in your group comes late, they can ask where you’ve been seated to
+find you.
+
Pushing to the stack is faster than allocating on the heap because the
+allocator never has to search for a place to store new data; that location is
+always at the top of the stack. Comparatively, allocating space on the heap
+requires more work because the allocator must first find a big enough space
+to hold the data and then perform bookkeeping to prepare for the next
+allocation.
+
Accessing data in the heap is slower than accessing data on the stack because
+you have to follow a pointer to get there. Contemporary processors are faster
+if they jump around less in memory. Continuing the analogy, consider a server
+at a restaurant taking orders from many tables. It’s most efficient to get
+all the orders at one table before moving on to the next table. Taking an
+order from table A, then an order from table B, then one from A again, and
+then one from B again would be a much slower process. By the same token, a
+processor can do its job better if it works on data that’s close to other
+data (as it is on the stack) rather than farther away (as it can be on the
+heap).
+
When your code calls a function, the values passed into the function
+(including, potentially, pointers to data on the heap) and the function’s
+local variables get pushed onto the stack. When the function is over, those
+values get popped off the stack.
+
Keeping track of what parts of code are using what data on the heap,
+minimizing the amount of duplicate data on the heap, and cleaning up unused
+data on the heap so you don’t run out of space are all problems that ownership
+addresses. Once you understand ownership, you won’t need to think about the
+stack and the heap very often, but knowing that the main purpose of ownership
+is to manage heap data can help explain why it works the way it does.
Now that we’re past basic Rust syntax, we won’t include all the fn main() {
+code in examples, so if you’re following along, make sure to put the following
+examples inside a main function manually. As a result, our examples will be a
+bit more concise, letting us focus on the actual details rather than
+boilerplate code.
+
As a first example of ownership, we’ll look at the scope of some variables. A
+scope is the range within a program for which an item is valid. Take the
+following variable:
+
#![allow(unused)]
+fn main() {
+let s = "hello";
+}
+
The variable s refers to a string literal, where the value of the string is
+hardcoded into the text of our program. The variable is valid from the point at
+which it’s declared until the end of the current scope. Listing 4-1 shows a
+program with comments annotating where the variable s would be valid.
+
fn main() {
+ { // s is not valid here, it’s not yet declared
+ let s = "hello"; // s is valid from this point forward
+
+ // do stuff with s
+ } // this scope is now over, and s is no longer valid
+}
+
Listing 4-1: A variable and the scope in which it is
+valid
+
In other words, there are two important points in time here:
+
+
When s comes into scope, it is valid.
+
It remains valid until it goes out of scope.
+
+
At this point, the relationship between scopes and when variables are valid is
+similar to that in other programming languages. Now we’ll build on top of this
+understanding by introducing the String type.
To illustrate the rules of ownership, we need a data type that is more complex
+than those we covered in the “Data Types” section
+of Chapter 3. The types covered previously are of a known size, can be stored
+on the stack and popped off the stack when their scope is over, and can be
+quickly and trivially copied to make a new, independent instance if another
+part of code needs to use the same value in a different scope. But we want to
+look at data that is stored on the heap and explore how Rust knows when to
+clean up that data, and the String type is a great example.
+
We’ll concentrate on the parts of String that relate to ownership. These
+aspects also apply to other complex data types, whether they are provided by
+the standard library or created by you. We’ll discuss String in more depth in
+Chapter 8.
+
We’ve already seen string literals, where a string value is hardcoded into our
+program. String literals are convenient, but they aren’t suitable for every
+situation in which we may want to use text. One reason is that they’re
+immutable. Another is that not every string value can be known when we write
+our code: for example, what if we want to take user input and store it? For
+these situations, Rust has a second string type, String. This type manages
+data allocated on the heap and as such is able to store an amount of text that
+is unknown to us at compile time. You can create a String from a string
+literal using the from function, like so:
+
#![allow(unused)]
+fn main() {
+let s = String::from("hello");
+}
+
The double colon :: operator allows us to namespace this particular from
+function under the String type rather than using some sort of name like
+string_from. We’ll discuss this syntax more in the “Method
+Syntax” section of Chapter 5, and when we talk
+about namespacing with modules in “Paths for Referring to an Item in the
+Module Tree” in Chapter 7.
+
This kind of string can be mutated:
+
fn main() {
+ let mut s = String::from("hello");
+
+ s.push_str(", world!"); // push_str() appends a literal to a String
+
+ println!("{s}"); // This will print `hello, world!`
+}
+
So, what’s the difference here? Why can String be mutated but literals
+cannot? The difference is in how these two types deal with memory.
In the case of a string literal, we know the contents at compile time, so the
+text is hardcoded directly into the final executable. This is why string
+literals are fast and efficient. But these properties only come from the string
+literal’s immutability. Unfortunately, we can’t put a blob of memory into the
+binary for each piece of text whose size is unknown at compile time and whose
+size might change while running the program.
+
With the String type, in order to support a mutable, growable piece of text,
+we need to allocate an amount of memory on the heap, unknown at compile time,
+to hold the contents. This means:
+
+
The memory must be requested from the memory allocator at runtime.
+
We need a way of returning this memory to the allocator when we’re done with
+our String.
+
+
That first part is done by us: when we call String::from, its implementation
+requests the memory it needs. This is pretty much universal in programming
+languages.
+
However, the second part is different. In languages with a garbage collector
+(GC), the GC keeps track of and cleans up memory that isn’t being used
+anymore, and we don’t need to think about it. In most languages without a GC,
+it’s our responsibility to identify when memory is no longer being used and to
+call code to explicitly free it, just as we did to request it. Doing this
+correctly has historically been a difficult programming problem. If we forget,
+we’ll waste memory. If we do it too early, we’ll have an invalid variable. If
+we do it twice, that’s a bug too. We need to pair exactly one allocate with
+exactly one free.
+
Rust takes a different path: the memory is automatically returned once the
+variable that owns it goes out of scope. Here’s a version of our scope example
+from Listing 4-1 using a String instead of a string literal:
+
fn main() {
+ {
+ let s = String::from("hello"); // s is valid from this point forward
+
+ // do stuff with s
+ } // this scope is now over, and s is no
+ // longer valid
+}
+
There is a natural point at which we can return the memory our String needs
+to the allocator: when s goes out of scope. When a variable goes out of
+scope, Rust calls a special function for us. This function is called
+drop, and it’s where the author of String can put
+the code to return the memory. Rust calls drop automatically at the closing
+curly bracket.
+
+
Note: In C++, this pattern of deallocating resources at the end of an item’s
+lifetime is sometimes called Resource Acquisition Is Initialization (RAII).
+The drop function in Rust will be familiar to you if you’ve used RAII
+patterns.
+
+
This pattern has a profound impact on the way Rust code is written. It may seem
+simple right now, but the behavior of code can be unexpected in more
+complicated situations when we want to have multiple variables use the data
+we’ve allocated on the heap. Let’s explore some of those situations now.
Multiple variables can interact with the same data in different ways in Rust.
+Let’s look at an example using an integer in Listing 4-2.
+
fn main() {
+ let x = 5;
+ let y = x;
+}
+
Listing 4-2: Assigning the integer value of variable x
+to y
+
We can probably guess what this is doing: “bind the value 5 to x; then make
+a copy of the value in x and bind it to y.” We now have two variables, x
+and y, and both equal 5. This is indeed what is happening, because integers
+are simple values with a known, fixed size, and these two 5 values are pushed
+onto the stack.
+
Now let’s look at the String version:
+
fn main() {
+ let s1 = String::from("hello");
+ let s2 = s1;
+}
+
This looks very similar, so we might assume that the way it works would be the
+same: that is, the second line would make a copy of the value in s1 and bind
+it to s2. But this isn’t quite what happens.
+
Take a look at Figure 4-1 to see what is happening to String under the
+covers. A String is made up of three parts, shown on the left: a pointer to
+the memory that holds the contents of the string, a length, and a capacity.
+This group of data is stored on the stack. On the right is the memory on the
+heap that holds the contents.
+
+
Figure 4-1: Representation in memory of a String
+holding the value "hello" bound to s1
+
The length is how much memory, in bytes, the contents of the String are
+currently using. The capacity is the total amount of memory, in bytes, that the
+String has received from the allocator. The difference between length and
+capacity matters, but not in this context, so for now, it’s fine to ignore the
+capacity.
+
When we assign s1 to s2, the String data is copied, meaning we copy the
+pointer, the length, and the capacity that are on the stack. We do not copy the
+data on the heap that the pointer refers to. In other words, the data
+representation in memory looks like Figure 4-2.
+
+
Figure 4-2: Representation in memory of the variable s2
+that has a copy of the pointer, length, and capacity of s1
+
The representation does not look like Figure 4-3, which is what memory would
+look like if Rust instead copied the heap data as well. If Rust did this, the
+operation s2 = s1 could be very expensive in terms of runtime performance if
+the data on the heap were large.
+
+
Figure 4-3: Another possibility for what s2 = s1 might
+do if Rust copied the heap data as well
+
Earlier, we said that when a variable goes out of scope, Rust automatically
+calls the drop function and cleans up the heap memory for that variable. But
+Figure 4-2 shows both data pointers pointing to the same location. This is a
+problem: when s2 and s1 go out of scope, they will both try to free the
+same memory. This is known as a double free error and is one of the memory
+safety bugs we mentioned previously. Freeing memory twice can lead to memory
+corruption, which can potentially lead to security vulnerabilities.
+
To ensure memory safety, after the line let s2 = s1;, Rust considers s1 as
+no longer valid. Therefore, Rust doesn’t need to free anything when s1 goes
+out of scope. Check out what happens when you try to use s1 after s2 is
+created; it won’t work:
+
fn main() {
+ let s1 = String::from("hello");
+ let s2 = s1;
+
+ println!("{s1}, world!");
+}
+
You’ll get an error like this because Rust prevents you from using the
+invalidated reference:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0382]: borrow of moved value: `s1`
+ --> src/main.rs:5:15
+ |
+2 | let s1 = String::from("hello");
+ | -- move occurs because `s1` has type `String`, which does not implement the `Copy` trait
+3 | let s2 = s1;
+ | -- value moved here
+4 |
+5 | println!("{s1}, world!");
+ | ^^^^ value borrowed here after move
+ |
+ = note: this error originates in the macro `$crate::format_args_nl` which comes from the expansion of the macro `println` (in Nightly builds, run with -Z macro-backtrace for more info)
+help: consider cloning the value if the performance cost is acceptable
+ |
+3 | let s2 = s1.clone();
+ | ++++++++
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
If you’ve heard the terms shallow copy and deep copy while working with
+other languages, the concept of copying the pointer, length, and capacity
+without copying the data probably sounds like making a shallow copy. But
+because Rust also invalidates the first variable, instead of being called a
+shallow copy, it’s known as a move. In this example, we would say that s1
+was moved into s2. So, what actually happens is shown in Figure 4-4.
+
+
Figure 4-4: Representation in memory after s1 has been
+invalidated
+
That solves our problem! With only s2 valid, when it goes out of scope it
+alone will free the memory, and we’re done.
+
In addition, there’s a design choice that’s implied by this: Rust will never
+automatically create “deep” copies of your data. Therefore, any automatic
+copying can be assumed to be inexpensive in terms of runtime performance.
If we do want to deeply copy the heap data of the String, not just the
+stack data, we can use a common method called clone. We’ll discuss method
+syntax in Chapter 5, but because methods are a common feature in many
+programming languages, you’ve probably seen them before.
This works just fine and explicitly produces the behavior shown in Figure 4-3,
+where the heap data does get copied.
+
When you see a call to clone, you know that some arbitrary code is being
+executed and that code may be expensive. It’s a visual indicator that something
+different is going on.
There’s another wrinkle we haven’t talked about yet. This code using
+integers—part of which was shown in Listing 4-2—works and is valid:
+
fn main() {
+ let x = 5;
+ let y = x;
+
+ println!("x = {x}, y = {y}");
+}
+
But this code seems to contradict what we just learned: we don’t have a call to
+clone, but x is still valid and wasn’t moved into y.
+
The reason is that types such as integers that have a known size at compile
+time are stored entirely on the stack, so copies of the actual values are quick
+to make. That means there’s no reason we would want to prevent x from being
+valid after we create the variable y. In other words, there’s no difference
+between deep and shallow copying here, so calling clone wouldn’t do anything
+different from the usual shallow copying, and we can leave it out.
+
Rust has a special annotation called the Copy trait that we can place on
+types that are stored on the stack, as integers are (we’ll talk more about
+traits in Chapter 10). If a type implements the Copy
+trait, variables that use it do not move, but rather are trivially copied,
+making them still valid after assignment to another variable.
+
Rust won’t let us annotate a type with Copy if the type, or any of its parts,
+has implemented the Drop trait. If the type needs something special to happen
+when the value goes out of scope and we add the Copy annotation to that type,
+we’ll get a compile-time error. To learn about how to add the Copy annotation
+to your type to implement the trait, see “Derivable
+Traits” in Appendix C.
+
So, what types implement the Copy trait? You can check the documentation for
+the given type to be sure, but as a general rule, any group of simple scalar
+values can implement Copy, and nothing that requires allocation or is some
+form of resource can implement Copy. Here are some of the types that
+implement Copy:
+
+
All the integer types, such as u32.
+
The Boolean type, bool, with values true and false.
+
All the floating-point types, such as f64.
+
The character type, char.
+
Tuples, if they only contain types that also implement Copy. For example,
+(i32, i32) implements Copy, but (i32, String) does not.
The mechanics of passing a value to a function are similar to those when
+assigning a value to a variable. Passing a variable to a function will move or
+copy, just as assignment does. Listing 4-3 has an example with some annotations
+showing where variables go into and out of scope.
+
Filename: src/main.rs
+
fn main() {
+ let s = String::from("hello"); // s comes into scope
+
+ takes_ownership(s); // s's value moves into the function...
+ // ... and so is no longer valid here
+
+ let x = 5; // x comes into scope
+
+ makes_copy(x); // x would move into the function,
+ // but i32 is Copy, so it's okay to still
+ // use x afterward
+
+} // Here, x goes out of scope, then s. But because s's value was moved, nothing
+ // special happens.
+
+fn takes_ownership(some_string: String) { // some_string comes into scope
+ println!("{some_string}");
+} // Here, some_string goes out of scope and `drop` is called. The backing
+ // memory is freed.
+
+fn makes_copy(some_integer: i32) { // some_integer comes into scope
+ println!("{some_integer}");
+} // Here, some_integer goes out of scope. Nothing special happens.
+
Listing 4-3: Functions with ownership and scope
+annotated
+
If we tried to use s after the call to takes_ownership, Rust would throw a
+compile-time error. These static checks protect us from mistakes. Try adding
+code to main that uses s and x to see where you can use them and where
+the ownership rules prevent you from doing so.
Returning values can also transfer ownership. Listing 4-4 shows an example of a
+function that returns some value, with similar annotations as those in Listing
+4-3.
+
Filename: src/main.rs
+
fn main() {
+ let s1 = gives_ownership(); // gives_ownership moves its return
+ // value into s1
+
+ let s2 = String::from("hello"); // s2 comes into scope
+
+ let s3 = takes_and_gives_back(s2); // s2 is moved into
+ // takes_and_gives_back, which also
+ // moves its return value into s3
+} // Here, s3 goes out of scope and is dropped. s2 was moved, so nothing
+ // happens. s1 goes out of scope and is dropped.
+
+fn gives_ownership() -> String { // gives_ownership will move its
+ // return value into the function
+ // that calls it
+
+ let some_string = String::from("yours"); // some_string comes into scope
+
+ some_string // some_string is returned and
+ // moves out to the calling
+ // function
+}
+
+// This function takes a String and returns one
+fn takes_and_gives_back(a_string: String) -> String { // a_string comes into
+ // scope
+
+ a_string // a_string is returned and moves out to the calling function
+}
+
Listing 4-4: Transferring ownership of return
+values
+
The ownership of a variable follows the same pattern every time: assigning a
+value to another variable moves it. When a variable that includes data on the
+heap goes out of scope, the value will be cleaned up by drop unless ownership
+of the data has been moved to another variable.
+
While this works, taking ownership and then returning ownership with every
+function is a bit tedious. What if we want to let a function use a value but
+not take ownership? It’s quite annoying that anything we pass in also needs to
+be passed back if we want to use it again, in addition to any data resulting
+from the body of the function that we might want to return as well.
+
Rust does let us return multiple values using a tuple, as shown in Listing 4-5.
+
Filename: src/main.rs
+
fn main() {
+ let s1 = String::from("hello");
+
+ let (s2, len) = calculate_length(s1);
+
+ println!("The length of '{s2}' is {len}.");
+}
+
+fn calculate_length(s: String) -> (String, usize) {
+ let length = s.len(); // len() returns the length of a String
+
+ (s, length)
+}
+
Listing 4-5: Returning ownership of parameters
+
But this is too much ceremony and a lot of work for a concept that should be
+common. Luckily for us, Rust has a feature for using a value without
+transferring ownership, called references.
The issue with the tuple code in Listing 4-5 is that we have to return the
+String to the calling function so we can still use the String after the
+call to calculate_length, because the String was moved into
+calculate_length. Instead, we can provide a reference to the String value.
+A reference is like a pointer in that it’s an address we can follow to access
+the data stored at that address; that data is owned by some other variable.
+Unlike a pointer, a reference is guaranteed to point to a valid value of a
+particular type for the life of that reference.
+
Here is how you would define and use a calculate_length function that has a
+reference to an object as a parameter instead of taking ownership of the value:
+
Filename: src/main.rs
+
fn main() {
+ let s1 = String::from("hello");
+
+ let len = calculate_length(&s1);
+
+ println!("The length of '{s1}' is {len}.");
+}
+
+fn calculate_length(s: &String) -> usize {
+ s.len()
+}
+
First, notice that all the tuple code in the variable declaration and the
+function return value is gone. Second, note that we pass &s1 into
+calculate_length and, in its definition, we take &String rather than
+String. These ampersands represent references, and they allow you to refer
+to some value without taking ownership of it. Figure 4-5 depicts this concept.
+
+
Figure 4-5: A diagram of &String s pointing at String s1
+
+
Note: The opposite of referencing by using & is dereferencing, which is
+accomplished with the dereference operator, *. We’ll see some uses of the
+dereference operator in Chapter 8 and discuss details of dereferencing in
+Chapter 15.
+
+
Let’s take a closer look at the function call here:
+
fn main() {
+ let s1 = String::from("hello");
+
+ let len = calculate_length(&s1);
+
+ println!("The length of '{s1}' is {len}.");
+}
+
+fn calculate_length(s: &String) -> usize {
+ s.len()
+}
+
The &s1 syntax lets us create a reference that refers to the value of s1
+but does not own it. Because it does not own it, the value it points to will
+not be dropped when the reference stops being used.
+
Likewise, the signature of the function uses & to indicate that the type of
+the parameter s is a reference. Let’s add some explanatory annotations:
+
fn main() {
+ let s1 = String::from("hello");
+
+ let len = calculate_length(&s1);
+
+ println!("The length of '{s1}' is {len}.");
+}
+
+fn calculate_length(s: &String) -> usize { // s is a reference to a String
+ s.len()
+} // Here, s goes out of scope. But because it does not have ownership of what
+ // it refers to, it is not dropped.
+
The scope in which the variable s is valid is the same as any function
+parameter’s scope, but the value pointed to by the reference is not dropped
+when s stops being used, because s doesn’t have ownership. When functions
+have references as parameters instead of the actual values, we won’t need to
+return the values in order to give back ownership, because we never had
+ownership.
+
We call the action of creating a reference borrowing. As in real life, if a
+person owns something, you can borrow it from them. When you’re done, you have
+to give it back. You don’t own it.
+
So, what happens if we try to modify something we’re borrowing? Try the code in
+Listing 4-6. Spoiler alert: it doesn’t work!
Listing 4-6: Attempting to modify a borrowed value
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0596]: cannot borrow `*some_string` as mutable, as it is behind a `&` reference
+ --> src/main.rs:8:5
+ |
+8 | some_string.push_str(", world");
+ | ^^^^^^^^^^^ `some_string` is a `&` reference, so the data it refers to cannot be borrowed as mutable
+ |
+help: consider changing this to be a mutable reference
+ |
+7 | fn change(some_string: &mut String) {
+ | +++
+
+For more information about this error, try `rustc --explain E0596`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
Just as variables are immutable by default, so are references. We’re not
+allowed to modify something we have a reference to.
First we change s to be mut. Then we create a mutable reference with &mut s where we call the change function, and update the function signature to
+accept a mutable reference with some_string: &mut String. This makes it very
+clear that the change function will mutate the value it borrows.
+
Mutable references have one big restriction: if you have a mutable reference to
+a value, you can have no other references to that value. This code that
+attempts to create two mutable references to s will fail:
+
Filename: src/main.rs
+
fn main() {
+ let mut s = String::from("hello");
+
+ let r1 = &mut s;
+ let r2 = &mut s;
+
+ println!("{}, {}", r1, r2);
+}
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0499]: cannot borrow `s` as mutable more than once at a time
+ --> src/main.rs:5:14
+ |
+4 | let r1 = &mut s;
+ | ------ first mutable borrow occurs here
+5 | let r2 = &mut s;
+ | ^^^^^^ second mutable borrow occurs here
+6 |
+7 | println!("{}, {}", r1, r2);
+ | -- first borrow later used here
+
+For more information about this error, try `rustc --explain E0499`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
This error says that this code is invalid because we cannot borrow s as
+mutable more than once at a time. The first mutable borrow is in r1 and must
+last until it’s used in the println!, but between the creation of that
+mutable reference and its usage, we tried to create another mutable reference
+in r2 that borrows the same data as r1.
+
The restriction preventing multiple mutable references to the same data at the
+same time allows for mutation but in a very controlled fashion. It’s something
+that new Rustaceans struggle with because most languages let you mutate
+whenever you’d like. The benefit of having this restriction is that Rust can
+prevent data races at compile time. A data race is similar to a race
+condition and happens when these three behaviors occur:
+
+
Two or more pointers access the same data at the same time.
+
At least one of the pointers is being used to write to the data.
+
There’s no mechanism being used to synchronize access to the data.
+
+
Data races cause undefined behavior and can be difficult to diagnose and fix
+when you’re trying to track them down at runtime; Rust prevents this problem by
+refusing to compile code with data races!
+
As always, we can use curly brackets to create a new scope, allowing for
+multiple mutable references, just not simultaneous ones:
+
fn main() {
+ let mut s = String::from("hello");
+
+ {
+ let r1 = &mut s;
+ } // r1 goes out of scope here, so we can make a new reference with no problems.
+
+ let r2 = &mut s;
+}
+
Rust enforces a similar rule for combining mutable and immutable references.
+This code results in an error:
+
fn main() {
+ let mut s = String::from("hello");
+
+ let r1 = &s; // no problem
+ let r2 = &s; // no problem
+ let r3 = &mut s; // BIG PROBLEM
+
+ println!("{}, {}, and {}", r1, r2, r3);
+}
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0502]: cannot borrow `s` as mutable because it is also borrowed as immutable
+ --> src/main.rs:6:14
+ |
+4 | let r1 = &s; // no problem
+ | -- immutable borrow occurs here
+5 | let r2 = &s; // no problem
+6 | let r3 = &mut s; // BIG PROBLEM
+ | ^^^^^^ mutable borrow occurs here
+7 |
+8 | println!("{}, {}, and {}", r1, r2, r3);
+ | -- immutable borrow later used here
+
+For more information about this error, try `rustc --explain E0502`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
Whew! We also cannot have a mutable reference while we have an immutable one
+to the same value.
+
Users of an immutable reference don’t expect the value to suddenly change out
+from under them! However, multiple immutable references are allowed because no
+one who is just reading the data has the ability to affect anyone else’s
+reading of the data.
+
Note that a reference’s scope starts from where it is introduced and continues
+through the last time that reference is used. For instance, this code will
+compile because the last usage of the immutable references, the println!,
+occurs before the mutable reference is introduced:
+
fn main() {
+ let mut s = String::from("hello");
+
+ let r1 = &s; // no problem
+ let r2 = &s; // no problem
+ println!("{r1} and {r2}");
+ // variables r1 and r2 will not be used after this point
+
+ let r3 = &mut s; // no problem
+ println!("{r3}");
+}
+
The scopes of the immutable references r1 and r2 end after the println!
+where they are last used, which is before the mutable reference r3 is
+created. These scopes don’t overlap, so this code is allowed: the compiler can
+tell that the reference is no longer being used at a point before the end of
+the scope.
+
Even though borrowing errors may be frustrating at times, remember that it’s
+the Rust compiler pointing out a potential bug early (at compile time rather
+than at runtime) and showing you exactly where the problem is. Then you don’t
+have to track down why your data isn’t what you thought it was.
In languages with pointers, it’s easy to erroneously create a dangling
+pointer—a pointer that references a location in memory that may have been
+given to someone else—by freeing some memory while preserving a pointer to that
+memory. In Rust, by contrast, the compiler guarantees that references will
+never be dangling references: if you have a reference to some data, the
+compiler will ensure that the data will not go out of scope before the
+reference to the data does.
+
Let’s try to create a dangling reference to see how Rust prevents them with a
+compile-time error:
+
Filename: src/main.rs
+
fn main() {
+ let reference_to_nothing = dangle();
+}
+
+fn dangle() -> &String {
+ let s = String::from("hello");
+
+ &s
+}
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:5:16
+ |
+5 | fn dangle() -> &String {
+ | ^ expected named lifetime parameter
+ |
+ = help: this function's return type contains a borrowed value, but there is no value for it to be borrowed from
+help: consider using the `'static` lifetime, but this is uncommon unless you're returning a borrowed value from a `const` or a `static`
+ |
+5 | fn dangle() -> &'static String {
+ | +++++++
+help: instead, you are more likely to want to return an owned value
+ |
+5 - fn dangle() -> &String {
+5 + fn dangle() -> String {
+ |
+
+error[E0515]: cannot return reference to local variable `s`
+ --> src/main.rs:8:5
+ |
+8 | &s
+ | ^^ returns a reference to data owned by the current function
+
+Some errors have detailed explanations: E0106, E0515.
+For more information about an error, try `rustc --explain E0106`.
+error: could not compile `ownership` (bin "ownership") due to 2 previous errors
+
+
This error message refers to a feature we haven’t covered yet: lifetimes. We’ll
+discuss lifetimes in detail in Chapter 10. But, if you disregard the parts
+about lifetimes, the message does contain the key to why this code is a problem:
+
this function's return type contains a borrowed value, but there is no value
+for it to be borrowed from
+
+
Let’s take a closer look at exactly what’s happening at each stage of our
+dangle code:
+
Filename: src/main.rs
+
fn main() {
+ let reference_to_nothing = dangle();
+}
+
+fn dangle() -> &String { // dangle returns a reference to a String
+
+ let s = String::from("hello"); // s is a new String
+
+ &s // we return a reference to the String, s
+} // Here, s goes out of scope, and is dropped. Its memory goes away.
+ // Danger!
+
Because s is created inside dangle, when the code of dangle is finished,
+s will be deallocated. But we tried to return a reference to it. That means
+this reference would be pointing to an invalid String. That’s no good! Rust
+won’t let us do this.
+
The solution here is to return the String directly:
+
fn main() {
+ let string = no_dangle();
+}
+
+fn no_dangle() -> String {
+ let s = String::from("hello");
+
+ s
+}
+
This works without any problems. Ownership is moved out, and nothing is
+deallocated.
Slices let you reference a contiguous sequence of elements in a
+collection rather than the whole collection. A
+slice is a kind of reference, so it does not have ownership.
+
Here’s a small programming problem: write a function that takes a string of
+words separated by spaces and returns the first word it finds in that string.
+If the function doesn’t find a space in the string, the whole string must be
+one word, so the entire string should be returned.
+
Let’s work through how we’d write the signature of this function without using
+slices, to understand the problem that slices will solve:
+
fn first_word(s: &String) -> ?
+
The first_word function has a &String as a parameter. We don’t want
+ownership, so this is fine. But what should we return? We don’t really have a
+way to talk about part of a string. However, we could return the index of the
+end of the word, indicated by a space. Let’s try that, as shown in Listing 4-7.
+
Filename: src/main.rs
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
Listing 4-7: The first_word function that returns a
+byte index value into the String parameter
+
Because we need to go through the String element by element and check whether
+a value is a space, we’ll convert our String to an array of bytes using the
+as_bytes method.
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
Next, we create an iterator over the array of bytes using the iter method:
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
We’ll discuss iterators in more detail in Chapter 13.
+For now, know that iter is a method that returns each element in a collection
+and that enumerate wraps the result of iter and returns each element as
+part of a tuple instead. The first element of the tuple returned from
+enumerate is the index, and the second element is a reference to the element.
+This is a bit more convenient than calculating the index ourselves.
+
Because the enumerate method returns a tuple, we can use patterns to
+destructure that tuple. We’ll be discussing patterns more in Chapter
+6. In the for loop, we specify a pattern that has i
+for the index in the tuple and &item for the single byte in the tuple.
+Because we get a reference to the element from .iter().enumerate(), we use
+& in the pattern.
+
Inside the for loop, we search for the byte that represents the space by
+using the byte literal syntax. If we find a space, we return the position.
+Otherwise, we return the length of the string by using s.len().
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
We now have a way to find out the index of the end of the first word in the
+string, but there’s a problem. We’re returning a usize on its own, but it’s
+only a meaningful number in the context of the &String. In other words,
+because it’s a separate value from the String, there’s no guarantee that it
+will still be valid in the future. Consider the program in Listing 4-8 that
+uses the first_word function from Listing 4-7.
+
Filename: src/main.rs
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {
+ let mut s = String::from("hello world");
+
+ let word = first_word(&s); // word will get the value 5
+
+ s.clear(); // this empties the String, making it equal to ""
+
+ // word still has the value 5 here, but there's no more string that
+ // we could meaningfully use the value 5 with. word is now totally invalid!
+}
+
Listing 4-8: Storing the result from calling the
+first_word function and then changing the String contents
+
This program compiles without any errors and would also do so if we used word
+after calling s.clear(). Because word isn’t connected to the state of s
+at all, word still contains the value 5. We could use that value 5 with
+the variable s to try to extract the first word out, but this would be a bug
+because the contents of s have changed since we saved 5 in word.
+
Having to worry about the index in word getting out of sync with the data in
+s is tedious and error prone! Managing these indices is even more brittle if
+we write a second_word function. Its signature would have to look like this:
+
fn second_word(s: &String) -> (usize, usize) {
+
Now we’re tracking a starting and an ending index, and we have even more
+values that were calculated from data in a particular state but aren’t tied to
+that state at all. We have three unrelated variables floating around that need
+to be kept in sync.
+
Luckily, Rust has a solution to this problem: string slices.
A string slice is a reference to part of a String, and it looks like this:
+
fn main() {
+ let s = String::from("hello world");
+
+ let hello = &s[0..5];
+ let world = &s[6..11];
+}
+
Rather than a reference to the entire String, hello is a reference to a
+portion of the String, specified in the extra [0..5] bit. We create slices
+using a range within brackets by specifying [starting_index..ending_index],
+where starting_index is the first position in the slice and ending_index is
+one more than the last position in the slice. Internally, the slice data
+structure stores the starting position and the length of the slice, which
+corresponds to ending_index minus starting_index. So, in the case of let world = &s[6..11];, world would be a slice that contains a pointer to the
+byte at index 6 of s with a length value of 5.
+
Figure 4-6 shows this in a diagram.
+
+
Figure 4-6: String slice referring to part of a
+String
+
With Rust’s .. range syntax, if you want to start at index 0, you can drop
+the value before the two periods. In other words, these are equal:
Note: String slice range indices must occur at valid UTF-8 character
+boundaries. If you attempt to create a string slice in the middle of a
+multibyte character, your program will exit with an error. For the purposes
+of introducing string slices, we are assuming ASCII only in this section; a
+more thorough discussion of UTF-8 handling is in the “Storing UTF-8 Encoded
+Text with Strings” section of Chapter 8.
+
+
With all this information in mind, let’s rewrite first_word to return a
+slice. The type that signifies “string slice” is written as &str:
+
Filename: src/main.rs
+
fn first_word(s: &String) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {}
+
We get the index for the end of the word the same way we did in Listing 4-7, by
+looking for the first occurrence of a space. When we find a space, we return a
+string slice using the start of the string and the index of the space as the
+starting and ending indices.
+
Now when we call first_word, we get back a single value that is tied to the
+underlying data. The value is made up of a reference to the starting point of
+the slice and the number of elements in the slice.
+
Returning a slice would also work for a second_word function:
+
fn second_word(s: &String) -> &str {
+
We now have a straightforward API that’s much harder to mess up because the
+compiler will ensure the references into the String remain valid. Remember
+the bug in the program in Listing 4-8, when we got the index to the end of the
+first word but then cleared the string so our index was invalid? That code was
+logically incorrect but didn’t show any immediate errors. The problems would
+show up later if we kept trying to use the first word index with an emptied
+string. Slices make this bug impossible and let us know we have a problem with
+our code much sooner. Using the slice version of first_word will throw a
+compile-time error:
+
Filename: src/main.rs
+
fn first_word(s: &String) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let mut s = String::from("hello world");
+
+ let word = first_word(&s);
+
+ s.clear(); // error!
+
+ println!("the first word is: {word}");
+}
+
Here’s the compiler error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0502]: cannot borrow `s` as mutable because it is also borrowed as immutable
+ --> src/main.rs:18:5
+ |
+16 | let word = first_word(&s);
+ | -- immutable borrow occurs here
+17 |
+18 | s.clear(); // error!
+ | ^^^^^^^^^ mutable borrow occurs here
+19 |
+20 | println!("the first word is: {word}");
+ | ------ immutable borrow later used here
+
+For more information about this error, try `rustc --explain E0502`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
Recall from the borrowing rules that if we have an immutable reference to
+something, we cannot also take a mutable reference. Because clear needs to
+truncate the String, it needs to get a mutable reference. The println!
+after the call to clear uses the reference in word, so the immutable
+reference must still be active at that point. Rust disallows the mutable
+reference in clear and the immutable reference in word from existing at the
+same time, and compilation fails. Not only has Rust made our API easier to use,
+but it has also eliminated an entire class of errors at compile time!
Recall that we talked about string literals being stored inside the binary. Now
+that we know about slices, we can properly understand string literals:
+
#![allow(unused)]
+fn main() {
+let s = "Hello, world!";
+}
+
The type of s here is &str: it’s a slice pointing to that specific point of
+the binary. This is also why string literals are immutable; &str is an
+immutable reference.
Knowing that you can take slices of literals and String values leads us to
+one more improvement on first_word, and that’s its signature:
+
fn first_word(s: &String) -> &str {
+
A more experienced Rustacean would write the signature shown in Listing 4-9
+instead because it allows us to use the same function on both &String values
+and &str values.
+
fn first_word(s: &str) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let my_string = String::from("hello world");
+
+ // `first_word` works on slices of `String`s, whether partial or whole
+ let word = first_word(&my_string[0..6]);
+ let word = first_word(&my_string[..]);
+ // `first_word` also works on references to `String`s, which are equivalent
+ // to whole slices of `String`s
+ let word = first_word(&my_string);
+
+ let my_string_literal = "hello world";
+
+ // `first_word` works on slices of string literals, whether partial or whole
+ let word = first_word(&my_string_literal[0..6]);
+ let word = first_word(&my_string_literal[..]);
+
+ // Because string literals *are* string slices already,
+ // this works too, without the slice syntax!
+ let word = first_word(my_string_literal);
+}
+
Listing 4-9: Improving the first_word function by using
+a string slice for the type of the s parameter
+
If we have a string slice, we can pass that directly. If we have a String, we
+can pass a slice of the String or a reference to the String. This
+flexibility takes advantage of deref coercions, a feature we will cover in the
+“Implicit Deref Coercions with Functions and
+Methods” section of Chapter 15.
+
Defining a function to take a string slice instead of a reference to a String
+makes our API more general and useful without losing any functionality:
+
Filename: src/main.rs
+
fn first_word(s: &str) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let my_string = String::from("hello world");
+
+ // `first_word` works on slices of `String`s, whether partial or whole
+ let word = first_word(&my_string[0..6]);
+ let word = first_word(&my_string[..]);
+ // `first_word` also works on references to `String`s, which are equivalent
+ // to whole slices of `String`s
+ let word = first_word(&my_string);
+
+ let my_string_literal = "hello world";
+
+ // `first_word` works on slices of string literals, whether partial or whole
+ let word = first_word(&my_string_literal[0..6]);
+ let word = first_word(&my_string_literal[..]);
+
+ // Because string literals *are* string slices already,
+ // this works too, without the slice syntax!
+ let word = first_word(my_string_literal);
+}
This slice has the type &[i32]. It works the same way as string slices do, by
+storing a reference to the first element and a length. You’ll use this kind of
+slice for all sorts of other collections. We’ll discuss these collections in
+detail when we talk about vectors in Chapter 8.
The concepts of ownership, borrowing, and slices ensure memory safety in Rust
+programs at compile time. The Rust language gives you control over your memory
+usage in the same way as other systems programming languages, but having the
+owner of data automatically clean up that data when the owner goes out of scope
+means you don’t have to write and debug extra code to get this control.
+
Ownership affects how lots of other parts of Rust work, so we’ll talk about
+these concepts further throughout the rest of the book. Let’s move on to
+Chapter 5 and look at grouping pieces of data together in a struct.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch05-00-structs.html b/ch05-00-structs.html
new file mode 100644
index 0000000000..32983ac89e
--- /dev/null
+++ b/ch05-00-structs.html
@@ -0,0 +1,247 @@
+
+
+
+
+
+ Using Structs to Structure Related Data - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A struct, or structure, is a custom data type that lets you package
+together and name multiple related values that make up a meaningful group. If
+you’re familiar with an object-oriented language, a struct is like an
+object’s data attributes. In this chapter, we’ll compare and contrast tuples
+with structs to build on what you already know and demonstrate when structs are
+a better way to group data.
+
We’ll demonstrate how to define and instantiate structs. We’ll discuss how to
+define associated functions, especially the kind of associated functions called
+methods, to specify behavior associated with a struct type. Structs and enums
+(discussed in Chapter 6) are the building blocks for creating new types in your
+program’s domain to take full advantage of Rust’s compile-time type checking.
Structs are similar to tuples, discussed in “The Tuple Type” section, in that both hold multiple related values. Like tuples, the
+pieces of a struct can be different types. Unlike with tuples, in a struct
+you’ll name each piece of data so it’s clear what the values mean. Adding these
+names means that structs are more flexible than tuples: you don’t have to rely
+on the order of the data to specify or access the values of an instance.
+
To define a struct, we enter the keyword struct and name the entire struct. A
+struct’s name should describe the significance of the pieces of data being
+grouped together. Then, inside curly brackets, we define the names and types of
+the pieces of data, which we call fields. For example, Listing 5-1 shows a
+struct that stores information about a user account.
To use a struct after we’ve defined it, we create an instance of that struct
+by specifying concrete values for each of the fields. We create an instance by
+stating the name of the struct and then add curly brackets containing key:
+value pairs, where the keys are the names of the fields and the values are the
+data we want to store in those fields. We don’t have to specify the fields in
+the same order in which we declared them in the struct. In other words, the
+struct definition is like a general template for the type, and instances fill
+in that template with particular data to create values of the type. For
+example, we can declare a particular user as shown in Listing 5-2.
Listing 5-2: Creating an instance of the User
+struct
+
To get a specific value from a struct, we use dot notation. For example, to
+access this user’s email address, we use user1.email. If the instance is
+mutable, we can change a value by using the dot notation and assigning into a
+particular field. Listing 5-3 shows how to change the value in the email
+field of a mutable User instance.
Listing 5-3: Changing the value in the email field of a
+User instance
+
Note that the entire instance must be mutable; Rust doesn’t allow us to mark
+only certain fields as mutable. As with any expression, we can construct a new
+instance of the struct as the last expression in the function body to
+implicitly return that new instance.
+
Listing 5-4 shows a build_user function that returns a User instance with
+the given email and username. The active field gets the value of true, and
+the sign_in_count gets a value of 1.
Listing 5-4: A build_user function that takes an email
+and username and returns a User instance
+
It makes sense to name the function parameters with the same name as the struct
+fields, but having to repeat the email and username field names and
+variables is a bit tedious. If the struct had more fields, repeating each name
+would get even more annoying. Luckily, there’s a convenient shorthand!
Because the parameter names and the struct field names are exactly the same in
+Listing 5-4, we can use the field init shorthand syntax to rewrite
+build_user so it behaves exactly the same but doesn’t have the repetition of
+username and email, as shown in Listing 5-5.
Listing 5-5: A build_user function that uses field init
+shorthand because the username and email parameters have the same name as
+struct fields
+
Here, we’re creating a new instance of the User struct, which has a field
+named email. We want to set the email field’s value to the value in the
+email parameter of the build_user function. Because the email field and
+the email parameter have the same name, we only need to write email rather
+than email: email.
It’s often useful to create a new instance of a struct that includes most of
+the values from another instance, but changes some. You can do this using
+struct update syntax.
+
First, in Listing 5-6 we show how to create a new User instance in user2
+regularly, without the update syntax. We set a new value for email but
+otherwise use the same values from user1 that we created in Listing 5-2.
Listing 5-6: Creating a new User instance using all but one of
+the values from user1
+
Using struct update syntax, we can achieve the same effect with less code, as
+shown in Listing 5-7. The syntax .. specifies that the remaining fields not
+explicitly set should have the same value as the fields in the given instance.
Listing 5-7: Using struct update syntax to set a new
+email value for a User instance but to use the rest of the values from
+user1
+
The code in Listing 5-7 also creates an instance in user2 that has a
+different value for email but has the same values for the username,
+active, and sign_in_count fields from user1. The ..user1 must come last
+to specify that any remaining fields should get their values from the
+corresponding fields in user1, but we can choose to specify values for as
+many fields as we want in any order, regardless of the order of the fields in
+the struct’s definition.
+
Note that the struct update syntax uses = like an assignment; this is because
+it moves the data, just as we saw in the “Variables and Data Interacting with
+Move” section. In this example, we can no longer use
+user1 as a whole after creating user2 because the String in the
+username field of user1 was moved into user2. If we had given user2 new
+String values for both email and username, and thus only used the
+active and sign_in_count values from user1, then user1 would still be
+valid after creating user2. Both active and sign_in_count are types that
+implement the Copy trait, so the behavior we discussed in the “Stack-Only
+Data: Copy” section would apply.
Rust also supports structs that look similar to tuples, called tuple structs.
+Tuple structs have the added meaning the struct name provides but don’t have
+names associated with their fields; rather, they just have the types of the
+fields. Tuple structs are useful when you want to give the whole tuple a name
+and make the tuple a different type from other tuples, and when naming each
+field as in a regular struct would be verbose or redundant.
+
To define a tuple struct, start with the struct keyword and the struct name
+followed by the types in the tuple. For example, here we define and use two
+tuple structs named Color and Point:
+
Filename: src/main.rs
+
struct Color(i32, i32, i32);
+struct Point(i32, i32, i32);
+
+fn main() {
+ let black = Color(0, 0, 0);
+ let origin = Point(0, 0, 0);
+}
+
Note that the black and origin values are different types because they’re
+instances of different tuple structs. Each struct you define is its own type,
+even though the fields within the struct might have the same types. For
+example, a function that takes a parameter of type Color cannot take a
+Point as an argument, even though both types are made up of three i32
+values. Otherwise, tuple struct instances are similar to tuples in that you can
+destructure them into their individual pieces, and you can use a . followed
+by the index to access an individual value.
You can also define structs that don’t have any fields! These are called
+unit-like structs because they behave similarly to (), the unit type that
+we mentioned in “The Tuple Type” section. Unit-like
+structs can be useful when you need to implement a trait on some type but don’t
+have any data that you want to store in the type itself. We’ll discuss traits
+in Chapter 10. Here’s an example of declaring and instantiating a unit struct
+named AlwaysEqual:
To define AlwaysEqual, we use the struct keyword, the name we want, and
+then a semicolon. No need for curly brackets or parentheses! Then we can get an
+instance of AlwaysEqual in the subject variable in a similar way: using the
+name we defined, without any curly brackets or parentheses. Imagine that later
+we’ll implement behavior for this type such that every instance of
+AlwaysEqual is always equal to every instance of any other type, perhaps to
+have a known result for testing purposes. We wouldn’t need any data to
+implement that behavior! You’ll see in Chapter 10 how to define traits and
+implement them on any type, including unit-like structs.
In the User struct definition in Listing 5-1, we used the owned String
+type rather than the &str string slice type. This is a deliberate choice
+because we want each instance of this struct to own all of its data and for
+that data to be valid for as long as the entire struct is valid.
+
It’s also possible for structs to store references to data owned by something
+else, but to do so requires the use of lifetimes, a Rust feature that we’ll
+discuss in Chapter 10. Lifetimes ensure that the data referenced by a struct
+is valid for as long as the struct is. Let’s say you try to store a reference
+in a struct without specifying lifetimes, like the following; this won’t work:
The compiler will complain that it needs lifetime specifiers:
+
$ cargo run
+ Compiling structs v0.1.0 (file:///projects/structs)
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:3:15
+ |
+3 | username: &str,
+ | ^ expected named lifetime parameter
+ |
+help: consider introducing a named lifetime parameter
+ |
+1 ~ struct User<'a> {
+2 | active: bool,
+3 ~ username: &'a str,
+ |
+
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:4:12
+ |
+4 | email: &str,
+ | ^ expected named lifetime parameter
+ |
+help: consider introducing a named lifetime parameter
+ |
+1 ~ struct User<'a> {
+2 | active: bool,
+3 | username: &str,
+4 ~ email: &'a str,
+ |
+
+For more information about this error, try `rustc --explain E0106`.
+error: could not compile `structs` (bin "structs") due to 2 previous errors
+
+
In Chapter 10, we’ll discuss how to fix these errors so you can store
+references in structs, but for now, we’ll fix errors like these using owned
+types like String instead of references like &str.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch05-02-example-structs.html b/ch05-02-example-structs.html
new file mode 100644
index 0000000000..8f2e0a8df4
--- /dev/null
+++ b/ch05-02-example-structs.html
@@ -0,0 +1,515 @@
+
+
+
+
+
+ An Example Program Using Structs - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
To understand when we might want to use structs, let’s write a program that
+calculates the area of a rectangle. We’ll start by using single variables, and
+then refactor the program until we’re using structs instead.
+
Let’s make a new binary project with Cargo called rectangles that will take
+the width and height of a rectangle specified in pixels and calculate the area
+of the rectangle. Listing 5-8 shows a short program with one way of doing
+exactly that in our project’s src/main.rs.
+
Filename: src/main.rs
+
fn main() {
+ let width1 = 30;
+ let height1 = 50;
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(width1, height1)
+ );
+}
+
+fn area(width: u32, height: u32) -> u32 {
+ width * height
+}
+
Listing 5-8: Calculating the area of a rectangle
+specified by separate width and height variables
+
Now, run this program using cargo run:
+
$ cargo run
+ Compiling rectangles v0.1.0 (file:///projects/rectangles)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.42s
+ Running `target/debug/rectangles`
+The area of the rectangle is 1500 square pixels.
+
+
This code succeeds in figuring out the area of the rectangle by calling the
+area function with each dimension, but we can do more to make this code clear
+and readable.
+
The issue with this code is evident in the signature of area:
+
fn main() {
+ let width1 = 30;
+ let height1 = 50;
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(width1, height1)
+ );
+}
+
+fn area(width: u32, height: u32) -> u32 {
+ width * height
+}
+
The area function is supposed to calculate the area of one rectangle, but the
+function we wrote has two parameters, and it’s not clear anywhere in our
+program that the parameters are related. It would be more readable and more
+manageable to group width and height together. We’ve already discussed one way
+we might do that in “The Tuple Type” section
+of Chapter 3: by using tuples.
Listing 5-9 shows another version of our program that uses tuples.
+
Filename: src/main.rs
+
fn main() {
+ let rect1 = (30, 50);
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(rect1)
+ );
+}
+
+fn area(dimensions: (u32, u32)) -> u32 {
+ dimensions.0 * dimensions.1
+}
+
Listing 5-9: Specifying the width and height of the
+rectangle with a tuple
+
In one way, this program is better. Tuples let us add a bit of structure, and
+we’re now passing just one argument. But in another way, this version is less
+clear: tuples don’t name their elements, so we have to index into the parts of
+the tuple, making our calculation less obvious.
+
Mixing up the width and height wouldn’t matter for the area calculation, but if
+we want to draw the rectangle on the screen, it would matter! We would have to
+keep in mind that width is the tuple index 0 and height is the tuple
+index 1. This would be even harder for someone else to figure out and keep in
+mind if they were to use our code. Because we haven’t conveyed the meaning of
+our data in our code, it’s now easier to introduce errors.
We use structs to add meaning by labeling the data. We can transform the tuple
+we’re using into a struct with a name for the whole as well as names for the
+parts, as shown in Listing 5-10.
+
Filename: src/main.rs
+
struct Rectangle {
+ width: u32,
+ height: u32,
+}
+
+fn main() {
+ let rect1 = Rectangle {
+ width: 30,
+ height: 50,
+ };
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(&rect1)
+ );
+}
+
+fn area(rectangle: &Rectangle) -> u32 {
+ rectangle.width * rectangle.height
+}
+
Listing 5-10: Defining a Rectangle struct
+
Here we’ve defined a struct and named it Rectangle. Inside the curly
+brackets, we defined the fields as width and height, both of which have
+type u32. Then, in main, we created a particular instance of Rectangle
+that has a width of 30 and a height of 50.
+
Our area function is now defined with one parameter, which we’ve named
+rectangle, whose type is an immutable borrow of a struct Rectangle
+instance. As mentioned in Chapter 4, we want to borrow the struct rather than
+take ownership of it. This way, main retains its ownership and can continue
+using rect1, which is the reason we use the & in the function signature and
+where we call the function.
+
The area function accesses the width and height fields of the Rectangle
+instance (note that accessing fields of a borrowed struct instance does not
+move the field values, which is why you often see borrows of structs). Our
+function signature for area now says exactly what we mean: calculate the area
+of Rectangle, using its width and height fields. This conveys that the
+width and height are related to each other, and it gives descriptive names to
+the values rather than using the tuple index values of 0 and 1. This is a
+win for clarity.
It’d be useful to be able to print an instance of Rectangle while we’re
+debugging our program and see the values for all its fields. Listing 5-11 tries
+using the println! macro as we have used in
+previous chapters. This won’t work, however.
The println! macro can do many kinds of formatting, and by default, the curly
+brackets tell println! to use formatting known as Display: output intended
+for direct end user consumption. The primitive types we’ve seen so far
+implement Display by default because there’s only one way you’d want to show
+a 1 or any other primitive type to a user. But with structs, the way
+println! should format the output is less clear because there are more
+display possibilities: Do you want commas or not? Do you want to print the
+curly brackets? Should all the fields be shown? Due to this ambiguity, Rust
+doesn’t try to guess what we want, and structs don’t have a provided
+implementation of Display to use with println! and the {} placeholder.
+
If we continue reading the errors, we’ll find this helpful note:
+
= help: the trait `std::fmt::Display` is not implemented for `Rectangle`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+
+
Let’s try it! The println! macro call will now look like println!("rect1 is {rect1:?}");. Putting the specifier :? inside the curly brackets tells
+println! we want to use an output format called Debug. The Debug trait
+enables us to print our struct in a way that is useful for developers so we can
+see its value while we’re debugging our code.
+
Compile the code with this change. Drat! We still get an error:
= help: the trait `Debug` is not implemented for `Rectangle`
+ = note: add `#[derive(Debug)]` to `Rectangle` or manually `impl Debug for Rectangle`
+
+
Rust does include functionality to print out debugging information, but we
+have to explicitly opt in to make that functionality available for our struct.
+To do that, we add the outer attribute #[derive(Debug)] just before the
+struct definition, as shown in Listing 5-12.
Nice! It’s not the prettiest output, but it shows the values of all the fields
+for this instance, which would definitely help during debugging. When we have
+larger structs, it’s useful to have output that’s a bit easier to read; in
+those cases, we can use {:#?} instead of {:?} in the println! string. In
+this example, using the {:#?} style will output the following:
Another way to print out a value using the Debug format is to use the dbg!
+macro, which takes ownership of an expression (as opposed
+to println!, which takes a reference), prints the file and line number of
+where that dbg! macro call occurs in your code along with the resultant value
+of that expression, and returns ownership of the value.
We can put dbg! around the expression 30 * scale and, because dbg!
+returns ownership of the expression’s value, the width field will get the
+same value as if we didn’t have the dbg! call there. We don’t want dbg! to
+take ownership of rect1, so we use a reference to rect1 in the next call.
+Here’s what the output of this example looks like:
We can see the first bit of output came from src/main.rs line 10 where we’re
+debugging the expression 30 * scale, and its resultant value is 60 (the
+Debug formatting implemented for integers is to print only their value). The
+dbg! call on line 14 of src/main.rs outputs the value of &rect1, which is
+the Rectangle struct. This output uses the pretty Debug formatting of the
+Rectangle type. The dbg! macro can be really helpful when you’re trying to
+figure out what your code is doing!
+
In addition to the Debug trait, Rust has provided a number of traits for us
+to use with the derive attribute that can add useful behavior to our custom
+types. Those traits and their behaviors are listed in Appendix C. We’ll cover how to implement these traits with custom behavior as
+well as how to create your own traits in Chapter 10. There are also many
+attributes other than derive; for more information, see the “Attributes”
+section of the Rust Reference.
+
Our area function is very specific: it only computes the area of rectangles.
+It would be helpful to tie this behavior more closely to our Rectangle struct
+because it won’t work with any other type. Let’s look at how we can continue to
+refactor this code by turning the area function into an areamethod
+defined on our Rectangle type.
Methods are similar to functions: we declare them with the fn keyword and a
+name, they can have parameters and a return value, and they contain some code
+that’s run when the method is called from somewhere else. Unlike functions,
+methods are defined within the context of a struct (or an enum or a trait
+object, which we cover in Chapter 6 and Chapter
+17, respectively), and their first parameter is
+always self, which represents the instance of the struct the method is being
+called on.
Let’s change the area function that has a Rectangle instance as a parameter
+and instead make an area method defined on the Rectangle struct, as shown
+in Listing 5-13.
Listing 5-13: Defining an area method on the
+Rectangle struct
+
To define the function within the context of Rectangle, we start an impl
+(implementation) block for Rectangle. Everything within this impl block
+will be associated with the Rectangle type. Then we move the area function
+within the impl curly brackets and change the first (and in this case, only)
+parameter to be self in the signature and everywhere within the body. In
+main, where we called the area function and passed rect1 as an argument,
+we can instead use method syntax to call the area method on our Rectangle
+instance. The method syntax goes after an instance: we add a dot followed by
+the method name, parentheses, and any arguments.
+
In the signature for area, we use &self instead of rectangle: &Rectangle.
+The &self is actually short for self: &Self. Within an impl block, the
+type Self is an alias for the type that the impl block is for. Methods must
+have a parameter named self of type Self for their first parameter, so Rust
+lets you abbreviate this with only the name self in the first parameter spot.
+Note that we still need to use the & in front of the self shorthand to
+indicate that this method borrows the Self instance, just as we did in
+rectangle: &Rectangle. Methods can take ownership of self, borrow self
+immutably, as we’ve done here, or borrow self mutably, just as they can any
+other parameter.
+
We chose &self here for the same reason we used &Rectangle in the function
+version: we don’t want to take ownership, and we just want to read the data in
+the struct, not write to it. If we wanted to change the instance that we’ve
+called the method on as part of what the method does, we’d use &mut self as
+the first parameter. Having a method that takes ownership of the instance by
+using just self as the first parameter is rare; this technique is usually
+used when the method transforms self into something else and you want to
+prevent the caller from using the original instance after the transformation.
+
The main reason for using methods instead of functions, in addition to
+providing method syntax and not having to repeat the type of self in every
+method’s signature, is for organization. We’ve put all the things we can do
+with an instance of a type in one impl block rather than making future users
+of our code search for capabilities of Rectangle in various places in the
+library we provide.
+
Note that we can choose to give a method the same name as one of the struct’s
+fields. For example, we can define a method on Rectangle that is also named
+width:
Here, we’re choosing to make the width method return true if the value in
+the instance’s width field is greater than 0 and false if the value is
+0: we can use a field within a method of the same name for any purpose. In
+main, when we follow rect1.width with parentheses, Rust knows we mean the
+method width. When we don’t use parentheses, Rust knows we mean the field
+width.
+
Often, but not always, when we give a method the same name as a field we want
+it to only return the value in the field and do nothing else. Methods like this
+are called getters, and Rust does not implement them automatically for struct
+fields as some other languages do. Getters are useful because you can make the
+field private but the method public, and thus enable read-only access to that
+field as part of the type’s public API. We will discuss what public and private
+are and how to designate a field or method as public or private in Chapter
+7.
In C and C++, two different operators are used for calling methods: you use
+. if you’re calling a method on the object directly and -> if you’re
+calling the method on a pointer to the object and need to dereference the
+pointer first. In other words, if object is a pointer,
+object->something() is similar to (*object).something().
+
Rust doesn’t have an equivalent to the -> operator; instead, Rust has a
+feature called automatic referencing and dereferencing. Calling methods is
+one of the few places in Rust that has this behavior.
+
Here’s how it works: when you call a method with object.something(), Rust
+automatically adds in &, &mut, or * so object matches the signature of
+the method. In other words, the following are the same:
The first one looks much cleaner. This automatic referencing behavior works
+because methods have a clear receiver—the type of self. Given the receiver
+and name of a method, Rust can figure out definitively whether the method is
+reading (&self), mutating (&mut self), or consuming (self). The fact
+that Rust makes borrowing implicit for method receivers is a big part of
+making ownership ergonomic in practice.
Let’s practice using methods by implementing a second method on the Rectangle
+struct. This time we want an instance of Rectangle to take another instance
+of Rectangle and return true if the second Rectangle can fit completely
+within self (the first Rectangle); otherwise, it should return false.
+That is, once we’ve defined the can_hold method, we want to be able to write
+the program shown in Listing 5-14.
Listing 5-14: Using the as-yet-unwritten can_hold
+method
+
The expected output would look like the following because both dimensions of
+rect2 are smaller than the dimensions of rect1, but rect3 is wider than
+rect1:
+
Can rect1 hold rect2? true
+Can rect1 hold rect3? false
+
+
We know we want to define a method, so it will be within the impl Rectangle
+block. The method name will be can_hold, and it will take an immutable borrow
+of another Rectangle as a parameter. We can tell what the type of the
+parameter will be by looking at the code that calls the method:
+rect1.can_hold(&rect2) passes in &rect2, which is an immutable borrow to
+rect2, an instance of Rectangle. This makes sense because we only need to
+read rect2 (rather than write, which would mean we’d need a mutable borrow),
+and we want main to retain ownership of rect2 so we can use it again after
+calling the can_hold method. The return value of can_hold will be a
+Boolean, and the implementation will check whether the width and height of
+self are greater than the width and height of the other Rectangle,
+respectively. Let’s add the new can_hold method to the impl block from
+Listing 5-13, shown in Listing 5-15.
Listing 5-15: Implementing the can_hold method on
+Rectangle that takes another Rectangle instance as a parameter
+
When we run this code with the main function in Listing 5-14, we’ll get our
+desired output. Methods can take multiple parameters that we add to the
+signature after the self parameter, and those parameters work just like
+parameters in functions.
All functions defined within an impl block are called associated functions
+because they’re associated with the type named after the impl. We can define
+associated functions that don’t have self as their first parameter (and thus
+are not methods) because they don’t need an instance of the type to work with.
+We’ve already used one function like this: the String::from function that’s
+defined on the String type.
+
Associated functions that aren’t methods are often used for constructors that
+will return a new instance of the struct. These are often called new, but
+new isn’t a special name and isn’t built into the language. For example, we
+could choose to provide an associated function named square that would have
+one dimension parameter and use that as both width and height, thus making it
+easier to create a square Rectangle rather than having to specify the same
+value twice:
The Self keywords in the return type and in the body of the function are
+aliases for the type that appears after the impl keyword, which in this case
+is Rectangle.
+
To call this associated function, we use the :: syntax with the struct name;
+let sq = Rectangle::square(3); is an example. This function is namespaced by
+the struct: the :: syntax is used for both associated functions and
+namespaces created by modules. We’ll discuss modules in Chapter
+7.
Each struct is allowed to have multiple impl blocks. For example, Listing
+5-15 is equivalent to the code shown in Listing 5-16, which has each method in
+its own impl block.
Listing 5-16: Rewriting Listing 5-15 using multiple impl
+blocks
+
There’s no reason to separate these methods into multiple impl blocks here,
+but this is valid syntax. We’ll see a case in which multiple impl blocks are
+useful in Chapter 10, where we discuss generic types and traits.
Structs let you create custom types that are meaningful for your domain. By
+using structs, you can keep associated pieces of data connected to each other
+and name each piece to make your code clear. In impl blocks, you can define
+functions that are associated with your type, and methods are a kind of
+associated function that let you specify the behavior that instances of your
+structs have.
+
But structs aren’t the only way you can create custom types: let’s turn to
+Rust’s enum feature to add another tool to your toolbox.
In this chapter, we’ll look at enumerations, also referred to as enums.
+Enums allow you to define a type by enumerating its possible variants. First
+we’ll define and use an enum to show how an enum can encode meaning along with
+data. Next, we’ll explore a particularly useful enum, called Option, which
+expresses that a value can be either something or nothing. Then we’ll look at
+how pattern matching in the match expression makes it easy to run different
+code for different values of an enum. Finally, we’ll cover how the if let
+construct is another convenient and concise idiom available to handle enums in
+your code.
Where structs give you a way of grouping together related fields and data, like
+a Rectangle with its width and height, enums give you a way of saying a
+value is one of a possible set of values. For example, we may want to say that
+Rectangle is one of a set of possible shapes that also includes Circle and
+Triangle. To do this, Rust allows us to encode these possibilities as an enum.
+
Let’s look at a situation we might want to express in code and see why enums
+are useful and more appropriate than structs in this case. Say we need to work
+with IP addresses. Currently, two major standards are used for IP addresses:
+version four and version six. Because these are the only possibilities for an
+IP address that our program will come across, we can enumerate all possible
+variants, which is where enumeration gets its name.
+
Any IP address can be either a version four or a version six address, but not
+both at the same time. That property of IP addresses makes the enum data
+structure appropriate because an enum value can only be one of its variants.
+Both version four and version six addresses are still fundamentally IP
+addresses, so they should be treated as the same type when the code is handling
+situations that apply to any kind of IP address.
+
We can express this concept in code by defining an IpAddrKind enumeration and
+listing the possible kinds an IP address can be, V4 and V6. These are the
+variants of the enum:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
IpAddrKind is now a custom data type that we can use elsewhere in our code.
We can create instances of each of the two variants of IpAddrKind like this:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
Note that the variants of the enum are namespaced under its identifier, and we
+use a double colon to separate the two. This is useful because now both values
+IpAddrKind::V4 and IpAddrKind::V6 are of the same type: IpAddrKind. We
+can then, for instance, define a function that takes any IpAddrKind:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
And we can call this function with either variant:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
Using enums has even more advantages. Thinking more about our IP address type,
+at the moment we don’t have a way to store the actual IP address data; we
+only know what kind it is. Given that you just learned about structs in
+Chapter 5, you might be tempted to tackle this problem with structs as shown in
+Listing 6-1.
Listing 6-1: Storing the data and IpAddrKind variant of
+an IP address using a struct
+
Here, we’ve defined a struct IpAddr that has two fields: a kind field that
+is of type IpAddrKind (the enum we defined previously) and an address field
+of type String. We have two instances of this struct. The first is home,
+and it has the value IpAddrKind::V4 as its kind with associated address
+data of 127.0.0.1. The second instance is loopback. It has the other
+variant of IpAddrKind as its kind value, V6, and has address ::1
+associated with it. We’ve used a struct to bundle the kind and address
+values together, so now the variant is associated with the value.
+
However, representing the same concept using just an enum is more concise:
+rather than an enum inside a struct, we can put data directly into each enum
+variant. This new definition of the IpAddr enum says that both V4 and V6
+variants will have associated String values:
+
fn main() {
+ enum IpAddr {
+ V4(String),
+ V6(String),
+ }
+
+ let home = IpAddr::V4(String::from("127.0.0.1"));
+
+ let loopback = IpAddr::V6(String::from("::1"));
+}
+
We attach data to each variant of the enum directly, so there is no need for an
+extra struct. Here, it’s also easier to see another detail of how enums work:
+the name of each enum variant that we define also becomes a function that
+constructs an instance of the enum. That is, IpAddr::V4() is a function call
+that takes a String argument and returns an instance of the IpAddr type. We
+automatically get this constructor function defined as a result of defining the
+enum.
+
There’s another advantage to using an enum rather than a struct: each variant
+can have different types and amounts of associated data. Version four IP
+addresses will always have four numeric components that will have values
+between 0 and 255. If we wanted to store V4 addresses as four u8 values but
+still express V6 addresses as one String value, we wouldn’t be able to with
+a struct. Enums handle this case with ease:
We’ve shown several different ways to define data structures to store version
+four and version six IP addresses. However, as it turns out, wanting to store
+IP addresses and encode which kind they are is so common that the standard
+library has a definition we can use! Let’s look at how
+the standard library defines IpAddr: it has the exact enum and variants that
+we’ve defined and used, but it embeds the address data inside the variants in
+the form of two different structs, which are defined differently for each
+variant:
This code illustrates that you can put any kind of data inside an enum variant:
+strings, numeric types, or structs, for example. You can even include another
+enum! Also, standard library types are often not much more complicated than
+what you might come up with.
+
Note that even though the standard library contains a definition for IpAddr,
+we can still create and use our own definition without conflict because we
+haven’t brought the standard library’s definition into our scope. We’ll talk
+more about bringing types into scope in Chapter 7.
+
Let’s look at another example of an enum in Listing 6-2: this one has a wide
+variety of types embedded in its variants.
Listing 6-2: A Message enum whose variants each store
+different amounts and types of values
+
This enum has four variants with different types:
+
+
Quit has no data associated with it at all.
+
Move has named fields, like a struct does.
+
Write includes a single String.
+
ChangeColor includes three i32 values.
+
+
Defining an enum with variants such as the ones in Listing 6-2 is similar to
+defining different kinds of struct definitions, except the enum doesn’t use the
+struct keyword and all the variants are grouped together under the Message
+type. The following structs could hold the same data that the preceding enum
+variants hold:
But if we used the different structs, each of which has its own type, we
+couldn’t as easily define a function to take any of these kinds of messages as
+we could with the Message enum defined in Listing 6-2, which is a single type.
+
There is one more similarity between enums and structs: just as we’re able to
+define methods on structs using impl, we’re also able to define methods on
+enums. Here’s a method named call that we could define on our Message enum:
+
fn main() {
+ enum Message {
+ Quit,
+ Move { x: i32, y: i32 },
+ Write(String),
+ ChangeColor(i32, i32, i32),
+ }
+
+ impl Message {
+ fn call(&self) {
+ // method body would be defined here
+ }
+ }
+
+ let m = Message::Write(String::from("hello"));
+ m.call();
+}
+
The body of the method would use self to get the value that we called the
+method on. In this example, we’ve created a variable m that has the value
+Message::Write(String::from("hello")), and that is what self will be in the
+body of the call method when m.call() runs.
+
Let’s look at another enum in the standard library that is very common and
+useful: Option.
This section explores a case study of Option, which is another enum defined
+by the standard library. The Option type encodes the very common scenario in
+which a value could be something or it could be nothing.
+
For example, if you request the first item in a non-empty list, you would get
+a value. If you request the first item in an empty list, you would get nothing.
+Expressing this concept in terms of the type system means the compiler can
+check whether you’ve handled all the cases you should be handling; this
+functionality can prevent bugs that are extremely common in other programming
+languages.
+
Programming language design is often thought of in terms of which features you
+include, but the features you exclude are important too. Rust doesn’t have the
+null feature that many other languages have. Null is a value that means there
+is no value there. In languages with null, variables can always be in one of
+two states: null or not-null.
+
In his 2009 presentation “Null References: The Billion Dollar Mistake,” Tony
+Hoare, the inventor of null, has this to say:
+
+
I call it my billion-dollar mistake. At that time, I was designing the first
+comprehensive type system for references in an object-oriented language. My
+goal was to ensure that all use of references should be absolutely safe, with
+checking performed automatically by the compiler. But I couldn’t resist the
+temptation to put in a null reference, simply because it was so easy to
+implement. This has led to innumerable errors, vulnerabilities, and system
+crashes, which have probably caused a billion dollars of pain and damage in
+the last forty years.
+
+
The problem with null values is that if you try to use a null value as a
+not-null value, you’ll get an error of some kind. Because this null or not-null
+property is pervasive, it’s extremely easy to make this kind of error.
+
However, the concept that null is trying to express is still a useful one: a
+null is a value that is currently invalid or absent for some reason.
+
The problem isn’t really with the concept but with the particular
+implementation. As such, Rust does not have nulls, but it does have an enum
+that can encode the concept of a value being present or absent. This enum is
+Option<T>, and it is defined by the standard library
+as follows:
The Option<T> enum is so useful that it’s even included in the prelude; you
+don’t need to bring it into scope explicitly. Its variants are also included in
+the prelude: you can use Some and None directly without the Option::
+prefix. The Option<T> enum is still just a regular enum, and Some(T) and
+None are still variants of type Option<T>.
+
The <T> syntax is a feature of Rust we haven’t talked about yet. It’s a
+generic type parameter, and we’ll cover generics in more detail in Chapter 10.
+For now, all you need to know is that <T> means that the Some variant of
+the Option enum can hold one piece of data of any type, and that each
+concrete type that gets used in place of T makes the overall Option<T> type
+a different type. Here are some examples of using Option values to hold
+number types and string types:
+
fn main() {
+ let some_number = Some(5);
+ let some_char = Some('e');
+
+ let absent_number: Option<i32> = None;
+}
+
The type of some_number is Option<i32>. The type of some_char is
+Option<char>, which is a different type. Rust can infer these types because
+we’ve specified a value inside the Some variant. For absent_number, Rust
+requires us to annotate the overall Option type: the compiler can’t infer the
+type that the corresponding Some variant will hold by looking only at a
+None value. Here, we tell Rust that we mean for absent_number to be of type
+Option<i32>.
+
When we have a Some value, we know that a value is present and the value is
+held within the Some. When we have a None value, in some sense it means the
+same thing as null: we don’t have a valid value. So why is having Option<T>
+any better than having null?
+
In short, because Option<T> and T (where T can be any type) are different
+types, the compiler won’t let us use an Option<T> value as if it were
+definitely a valid value. For example, this code won’t compile, because it’s
+trying to add an i8 to an Option<i8>:
+
fn main() {
+ let x: i8 = 5;
+ let y: Option<i8> = Some(5);
+
+ let sum = x + y;
+}
+
If we run this code, we get an error message like this one:
+
$ cargo run
+ Compiling enums v0.1.0 (file:///projects/enums)
+error[E0277]: cannot add `Option<i8>` to `i8`
+ --> src/main.rs:5:17
+ |
+5 | let sum = x + y;
+ | ^ no implementation for `i8 + Option<i8>`
+ |
+ = help: the trait `Add<Option<i8>>` is not implemented for `i8`
+ = help: the following other types implement trait `Add<Rhs>`:
+ <i8 as Add>
+ <i8 as Add<&i8>>
+ <&'a i8 as Add<i8>>
+ <&i8 as Add<&i8>>
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `enums` (bin "enums") due to 1 previous error
+
+
Intense! In effect, this error message means that Rust doesn’t understand how
+to add an i8 and an Option<i8>, because they’re different types. When we
+have a value of a type like i8 in Rust, the compiler will ensure that we
+always have a valid value. We can proceed confidently without having to check
+for null before using that value. Only when we have an Option<i8> (or
+whatever type of value we’re working with) do we have to worry about possibly
+not having a value, and the compiler will make sure we handle that case before
+using the value.
+
In other words, you have to convert an Option<T> to a T before you can
+perform T operations with it. Generally, this helps catch one of the most
+common issues with null: assuming that something isn’t null when it actually is.
+
Eliminating the risk of incorrectly assuming a not-null value helps you to be
+more confident in your code. In order to have a value that can possibly be
+null, you must explicitly opt in by making the type of that value Option<T>.
+Then, when you use that value, you are required to explicitly handle the case
+when the value is null. Everywhere that a value has a type that isn’t an
+Option<T>, you can safely assume that the value isn’t null. This was a
+deliberate design decision for Rust to limit null’s pervasiveness and increase
+the safety of Rust code.
+
So how do you get the T value out of a Some variant when you have a value
+of type Option<T> so that you can use that value? The Option<T> enum has a
+large number of methods that are useful in a variety of situations; you can
+check them out in its documentation. Becoming familiar
+with the methods on Option<T> will be extremely useful in your journey with
+Rust.
+
In general, in order to use an Option<T> value, you want to have code that
+will handle each variant. You want some code that will run only when you have a
+Some(T) value, and this code is allowed to use the inner T. You want some
+other code to run only if you have a None value, and that code doesn’t have a
+T value available. The match expression is a control flow construct that
+does just this when used with enums: it will run different code depending on
+which variant of the enum it has, and that code can use the data inside the
+matching value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch06-02-match.html b/ch06-02-match.html
new file mode 100644
index 0000000000..35d0ac3808
--- /dev/null
+++ b/ch06-02-match.html
@@ -0,0 +1,591 @@
+
+
+
+
+
+ The match Control Flow Construct - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Rust has an extremely powerful control flow construct called match that
+allows you to compare a value against a series of patterns and then execute
+code based on which pattern matches. Patterns can be made up of literal values,
+variable names, wildcards, and many other things; Chapter
+18 covers all the different kinds of patterns
+and what they do. The power of match comes from the expressiveness of the
+patterns and the fact that the compiler confirms that all possible cases are
+handled.
+
Think of a match expression as being like a coin-sorting machine: coins slide
+down a track with variously sized holes along it, and each coin falls through
+the first hole it encounters that it fits into. In the same way, values go
+through each pattern in a match, and at the first pattern the value “fits,”
+the value falls into the associated code block to be used during execution.
+
Speaking of coins, let’s use them as an example using match! We can write a
+function that takes an unknown US coin and, in a similar way as the counting
+machine, determines which coin it is and returns its value in cents, as shown
+in Listing 6-3.
Listing 6-3: An enum and a match expression that has
+the variants of the enum as its patterns
+
Let’s break down the match in the value_in_cents function. First we list
+the match keyword followed by an expression, which in this case is the value
+coin. This seems very similar to a conditional expression used with if, but
+there’s a big difference: with if, the condition needs to evaluate to a
+Boolean value, but here it can be any type. The type of coin in this example
+is the Coin enum that we defined on the first line.
+
Next are the match arms. An arm has two parts: a pattern and some code. The
+first arm here has a pattern that is the value Coin::Penny and then the =>
+operator that separates the pattern and the code to run. The code in this case
+is just the value 1. Each arm is separated from the next with a comma.
+
When the match expression executes, it compares the resultant value against
+the pattern of each arm, in order. If a pattern matches the value, the code
+associated with that pattern is executed. If that pattern doesn’t match the
+value, execution continues to the next arm, much as in a coin-sorting machine.
+We can have as many arms as we need: in Listing 6-3, our match has four arms.
+
The code associated with each arm is an expression, and the resultant value of
+the expression in the matching arm is the value that gets returned for the
+entire match expression.
+
We don’t typically use curly brackets if the match arm code is short, as it is
+in Listing 6-3 where each arm just returns a value. If you want to run multiple
+lines of code in a match arm, you must use curly brackets, and the comma
+following the arm is then optional. For example, the following code prints
+“Lucky penny!” every time the method is called with a Coin::Penny, but still
+returns the last value of the block, 1:
Another useful feature of match arms is that they can bind to the parts of the
+values that match the pattern. This is how we can extract values out of enum
+variants.
+
As an example, let’s change one of our enum variants to hold data inside it.
+From 1999 through 2008, the United States minted quarters with different
+designs for each of the 50 states on one side. No other coins got state
+designs, so only quarters have this extra value. We can add this information to
+our enum by changing the Quarter variant to include a UsState value
+stored inside it, which we’ve done in Listing 6-4.
+
#[derive(Debug)] // so we can inspect the state in a minute
+enum UsState {
+ Alabama,
+ Alaska,
+ // --snip--
+}
+
+enum Coin {
+ Penny,
+ Nickel,
+ Dime,
+ Quarter(UsState),
+}
+
+fn main() {}
+
Listing 6-4: A Coin enum in which the Quarter variant
+also holds a UsState value
+
Let’s imagine that a friend is trying to collect all 50 state quarters. While
+we sort our loose change by coin type, we’ll also call out the name of the
+state associated with each quarter so that if it’s one our friend doesn’t have,
+they can add it to their collection.
+
In the match expression for this code, we add a variable called state to the
+pattern that matches values of the variant Coin::Quarter. When a
+Coin::Quarter matches, the state variable will bind to the value of that
+quarter’s state. Then we can use state in the code for that arm, like so:
If we were to call value_in_cents(Coin::Quarter(UsState::Alaska)), coin
+would be Coin::Quarter(UsState::Alaska). When we compare that value with each
+of the match arms, none of them match until we reach Coin::Quarter(state). At
+that point, the binding for state will be the value UsState::Alaska. We can
+then use that binding in the println! expression, thus getting the inner
+state value out of the Coin enum variant for Quarter.
In the previous section, we wanted to get the inner T value out of the Some
+case when using Option<T>; we can also handle Option<T> using match, as
+we did with the Coin enum! Instead of comparing coins, we’ll compare the
+variants of Option<T>, but the way the match expression works remains the
+same.
+
Let’s say we want to write a function that takes an Option<i32> and, if
+there’s a value inside, adds 1 to that value. If there isn’t a value inside,
+the function should return the None value and not attempt to perform any
+operations.
+
This function is very easy to write, thanks to match, and will look like
+Listing 6-5.
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
Listing 6-5: A function that uses a match expression on
+an Option<i32>
+
Let’s examine the first execution of plus_one in more detail. When we call
+plus_one(five), the variable x in the body of plus_one will have the
+value Some(5). We then compare that against each match arm:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
The Some(5) value doesn’t match the pattern None, so we continue to the
+next arm:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
Does Some(5) match Some(i)? It does! We have the same variant. The i
+binds to the value contained in Some, so i takes the value 5. The code in
+the match arm is then executed, so we add 1 to the value of i and create a
+new Some value with our total 6 inside.
+
Now let’s consider the second call of plus_one in Listing 6-5, where x is
+None. We enter the match and compare to the first arm:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
It matches! There’s no value to add to, so the program stops and returns the
+None value on the right side of =>. Because the first arm matched, no other
+arms are compared.
+
Combining match and enums is useful in many situations. You’ll see this
+pattern a lot in Rust code: match against an enum, bind a variable to the
+data inside, and then execute code based on it. It’s a bit tricky at first, but
+once you get used to it, you’ll wish you had it in all languages. It’s
+consistently a user favorite.
There’s one other aspect of match we need to discuss: the arms’ patterns must
+cover all possibilities. Consider this version of our plus_one function,
+which has a bug and won’t compile:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
We didn’t handle the None case, so this code will cause a bug. Luckily, it’s
+a bug Rust knows how to catch. If we try to compile this code, we’ll get this
+error:
+
$ cargo run
+ Compiling enums v0.1.0 (file:///projects/enums)
+error[E0004]: non-exhaustive patterns: `None` not covered
+ --> src/main.rs:3:15
+ |
+3 | match x {
+ | ^ pattern `None` not covered
+ |
+note: `Option<i32>` defined here
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/option.rs:572:1
+ ::: /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/option.rs:576:5
+ |
+ = note: not covered
+ = note: the matched value is of type `Option<i32>`
+help: ensure that all possible cases are being handled by adding a match arm with a wildcard pattern or an explicit pattern as shown
+ |
+4 ~ Some(i) => Some(i + 1),
+5 ~ None => todo!(),
+ |
+
+For more information about this error, try `rustc --explain E0004`.
+error: could not compile `enums` (bin "enums") due to 1 previous error
+
+
Rust knows that we didn’t cover every possible case, and even knows which
+pattern we forgot! Matches in Rust are exhaustive: we must exhaust every last
+possibility in order for the code to be valid. Especially in the case of
+Option<T>, when Rust prevents us from forgetting to explicitly handle the
+None case, it protects us from assuming that we have a value when we might
+have null, thus making the billion-dollar mistake discussed earlier impossible.
Using enums, we can also take special actions for a few particular values, but
+for all other values take one default action. Imagine we’re implementing a game
+where, if you roll a 3 on a dice roll, your player doesn’t move, but instead
+gets a new fancy hat. If you roll a 7, your player loses a fancy hat. For all
+other values, your player moves that number of spaces on the game board. Here’s
+a match that implements that logic, with the result of the dice roll
+hardcoded rather than a random value, and all other logic represented by
+functions without bodies because actually implementing them is out of scope for
+this example:
For the first two arms, the patterns are the literal values 3 and 7. For
+the last arm that covers every other possible value, the pattern is the
+variable we’ve chosen to name other. The code that runs for the other arm
+uses the variable by passing it to the move_player function.
+
This code compiles, even though we haven’t listed all the possible values a
+u8 can have, because the last pattern will match all values not specifically
+listed. This catch-all pattern meets the requirement that match must be
+exhaustive. Note that we have to put the catch-all arm last because the
+patterns are evaluated in order. If we put the catch-all arm earlier, the other
+arms would never run, so Rust will warn us if we add arms after a catch-all!
+
Rust also has a pattern we can use when we want a catch-all but don’t want to
+use the value in the catch-all pattern: _ is a special pattern that matches
+any value and does not bind to that value. This tells Rust we aren’t going to
+use the value, so Rust won’t warn us about an unused variable.
+
Let’s change the rules of the game: now, if you roll anything other than a 3 or
+a 7, you must roll again. We no longer need to use the catch-all value, so we
+can change our code to use _ instead of the variable named other:
This example also meets the exhaustiveness requirement because we’re explicitly
+ignoring all other values in the last arm; we haven’t forgotten anything.
+
Finally, we’ll change the rules of the game one more time so that nothing else
+happens on your turn if you roll anything other than a 3 or a 7. We can express
+that by using the unit value (the empty tuple type we mentioned in “The Tuple
+Type” section) as the code that goes with the _ arm:
Here, we’re telling Rust explicitly that we aren’t going to use any other value
+that doesn’t match a pattern in an earlier arm, and we don’t want to run any
+code in this case.
+
There’s more about patterns and matching that we’ll cover in Chapter
+18. For now, we’re going to move on to the
+if let syntax, which can be useful in situations where the match expression
+is a bit wordy.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch06-03-if-let.html b/ch06-03-if-let.html
new file mode 100644
index 0000000000..8af8b0241b
--- /dev/null
+++ b/ch06-03-if-let.html
@@ -0,0 +1,344 @@
+
+
+
+
+
+ Concise Control Flow with if let - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The if let syntax lets you combine if and let into a less verbose way to
+handle values that match one pattern while ignoring the rest. Consider the
+program in Listing 6-6 that matches on an Option<u8> value in the
+config_max variable but only wants to execute code if the value is the Some
+variant.
+
fn main() {
+ let config_max = Some(3u8);
+ match config_max {
+ Some(max) => println!("The maximum is configured to be {max}"),
+ _ => (),
+ }
+}
+
Listing 6-6: A match that only cares about executing
+code when the value is Some
+
If the value is Some, we print out the value in the Some variant by binding
+the value to the variable max in the pattern. We don’t want to do anything
+with the None value. To satisfy the match expression, we have to add _ => () after processing just one variant, which is annoying boilerplate code to
+add.
+
Instead, we could write this in a shorter way using if let. The following
+code behaves the same as the match in Listing 6-6:
+
fn main() {
+ let config_max = Some(3u8);
+ if let Some(max) = config_max {
+ println!("The maximum is configured to be {max}");
+ }
+}
+
The syntax if let takes a pattern and an expression separated by an equal
+sign. It works the same way as a match, where the expression is given to the
+match and the pattern is its first arm. In this case, the pattern is
+Some(max), and the max binds to the value inside the Some. We can then
+use max in the body of the if let block in the same way we used max in
+the corresponding match arm. The code in the if let block isn’t run if the
+value doesn’t match the pattern.
+
Using if let means less typing, less indentation, and less boilerplate code.
+However, you lose the exhaustive checking that match enforces. Choosing
+between match and if let depends on what you’re doing in your particular
+situation and whether gaining conciseness is an appropriate trade-off for
+losing exhaustive checking.
+
In other words, you can think of if let as syntax sugar for a match that
+runs code when the value matches one pattern and then ignores all other values.
+
We can include an else with an if let. The block of code that goes with the
+else is the same as the block of code that would go with the _ case in the
+match expression that is equivalent to the if let and else. Recall the
+Coin enum definition in Listing 6-4, where the Quarter variant also held a
+UsState value. If we wanted to count all non-quarter coins we see while also
+announcing the state of the quarters, we could do that with a match
+expression, like this:
If you have a situation in which your program has logic that is too verbose to
+express using a match, remember that if let is in your Rust toolbox as well.
We’ve now covered how to use enums to create custom types that can be one of a
+set of enumerated values. We’ve shown how the standard library’s Option<T>
+type helps you use the type system to prevent errors. When enum values have
+data inside them, you can use match or if let to extract and use those
+values, depending on how many cases you need to handle.
+
Your Rust programs can now express concepts in your domain using structs and
+enums. Creating custom types to use in your API ensures type safety: the
+compiler will make certain your functions only get values of the type each
+function expects.
+
In order to provide a well-organized API to your users that is straightforward
+to use and only exposes exactly what your users will need, let’s now turn to
+Rust’s modules.
As you write large programs, organizing your code will become increasingly
+important. By grouping related functionality and separating code with distinct
+features, you’ll clarify where to find code that implements a particular
+feature and where to go to change how a feature works.
+
The programs we’ve written so far have been in one module in one file. As a
+project grows, you should organize code by splitting it into multiple modules
+and then multiple files. A package can contain multiple binary crates and
+optionally one library crate. As a package grows, you can extract parts into
+separate crates that become external dependencies. This chapter covers all
+these techniques. For very large projects comprising a set of interrelated
+packages that evolve together, Cargo provides workspaces, which we’ll cover
+in the “Cargo Workspaces” section in Chapter 14.
+
We’ll also discuss encapsulating implementation details, which lets you reuse
+code at a higher level: once you’ve implemented an operation, other code can
+call your code via its public interface without having to know how the
+implementation works. The way you write code defines which parts are public for
+other code to use and which parts are private implementation details that you
+reserve the right to change. This is another way to limit the amount of detail
+you have to keep in your head.
+
A related concept is scope: the nested context in which code is written has a
+set of names that are defined as “in scope.” When reading, writing, and
+compiling code, programmers and compilers need to know whether a particular
+name at a particular spot refers to a variable, function, struct, enum, module,
+constant, or other item and what that item means. You can create scopes and
+change which names are in or out of scope. You can’t have two items with the
+same name in the same scope; tools are available to resolve name conflicts.
+
Rust has a number of features that allow you to manage your code’s
+organization, including which details are exposed, which details are private,
+and what names are in each scope in your programs. These features, sometimes
+collectively referred to as the module system, include:
+
+
Packages: A Cargo feature that lets you build, test, and share crates
+
Crates: A tree of modules that produces a library or executable
+
Modules and use: Let you control the organization, scope, and
+privacy of paths
+
Paths: A way of naming an item, such as a struct, function, or module
+
+
In this chapter, we’ll cover all these features, discuss how they interact, and
+explain how to use them to manage scope. By the end, you should have a solid
+understanding of the module system and be able to work with scopes like a pro!
The first parts of the module system we’ll cover are packages and crates.
+
A crate is the smallest amount of code that the Rust compiler considers at a
+time. Even if you run rustc rather than cargo and pass a single source code
+file (as we did all the way back in the “Writing and Running a Rust Program”
+section of Chapter 1), the compiler considers that file to be a crate. Crates
+can contain modules, and the modules may be defined in other files that get
+compiled with the crate, as we’ll see in the coming sections.
+
A crate can come in one of two forms: a binary crate or a library crate.
+Binary crates are programs you can compile to an executable that you can run,
+such as a command-line program or a server. Each must have a function called
+main that defines what happens when the executable runs. All the crates we’ve
+created so far have been binary crates.
+
Library crates don’t have a main function, and they don’t compile to an
+executable. Instead, they define functionality intended to be shared with
+multiple projects. For example, the rand crate we used in Chapter
+2 provides functionality that generates random numbers.
+Most of the time when Rustaceans say “crate”, they mean library crate, and they
+use “crate” interchangeably with the general programming concept of a “library“.
+
The crate root is a source file that the Rust compiler starts from and makes
+up the root module of your crate (we’ll explain modules in depth in the
+“Defining Modules to Control Scope and Privacy”
+section).
+
A package is a bundle of one or more crates that provides a set of
+functionality. A package contains a Cargo.toml file that describes how to
+build those crates. Cargo is actually a package that contains the binary crate
+for the command-line tool you’ve been using to build your code. The Cargo
+package also contains a library crate that the binary crate depends on. Other
+projects can depend on the Cargo library crate to use the same logic the Cargo
+command-line tool uses.
+
A crate can come in one of two forms: a binary crate or a library crate. A
+package can contain as many binary crates as you like, but at most only one
+library crate. A package must contain at least one crate, whether that’s a
+library or binary crate.
+
Let’s walk through what happens when we create a package. First we enter the
+command cargo new my-project:
+
$ cargo new my-project
+ Created binary (application) `my-project` package
+$ ls my-project
+Cargo.toml
+src
+$ ls my-project/src
+main.rs
+
+
After we run cargo new my-project, we use ls to see what Cargo creates. In
+the project directory, there’s a Cargo.toml file, giving us a package.
+There’s also a src directory that contains main.rs. Open Cargo.toml in
+your text editor, and note there’s no mention of src/main.rs. Cargo follows a
+convention that src/main.rs is the crate root of a binary crate with the same
+name as the package. Likewise, Cargo knows that if the package directory
+contains src/lib.rs, the package contains a library crate with the same name
+as the package, and src/lib.rs is its crate root. Cargo passes the crate root
+files to rustc to build the library or binary.
+
Here, we have a package that only contains src/main.rs, meaning it only
+contains a binary crate named my-project. If a package contains src/main.rs
+and src/lib.rs, it has two crates: a binary and a library, both with the same
+name as the package. A package can have multiple binary crates by placing files
+in the src/bin directory: each file will be a separate binary crate.
In this section, we’ll talk about modules and other parts of the module system,
+namely paths, which allow you to name items; the use keyword that brings a
+path into scope; and the pub keyword to make items public. We’ll also discuss
+the as keyword, external packages, and the glob operator.
Before we get to the details of modules and paths, here we provide a quick
+reference on how modules, paths, the use keyword, and the pub keyword work
+in the compiler, and how most developers organize their code. We’ll be going
+through examples of each of these rules throughout this chapter, but this is a
+great place to refer to as a reminder of how modules work.
+
+
Start from the crate root: When compiling a crate, the compiler first
+looks in the crate root file (usually src/lib.rs for a library crate or
+src/main.rs for a binary crate) for code to compile.
+
Declaring modules: In the crate root file, you can declare new modules;
+say you declare a “garden” module with mod garden;. The compiler will look
+for the module’s code in these places:
+
+
Inline, within curly brackets that replace the semicolon following mod garden
+
In the file src/garden.rs
+
In the file src/garden/mod.rs
+
+
+
Declaring submodules: In any file other than the crate root, you can
+declare submodules. For example, you might declare mod vegetables; in
+src/garden.rs. The compiler will look for the submodule’s code within the
+directory named for the parent module in these places:
+
+
Inline, directly following mod vegetables, within curly brackets instead
+of the semicolon
+
In the file src/garden/vegetables.rs
+
In the file src/garden/vegetables/mod.rs
+
+
+
Paths to code in modules: Once a module is part of your crate, you can
+refer to code in that module from anywhere else in that same crate, as long
+as the privacy rules allow, using the path to the code. For example, an
+Asparagus type in the garden vegetables module would be found at
+crate::garden::vegetables::Asparagus.
+
Private vs. public: Code within a module is private from its parent
+modules by default. To make a module public, declare it with pub mod
+instead of mod. To make items within a public module public as well, use
+pub before their declarations.
+
The use keyword: Within a scope, the use keyword creates shortcuts to
+items to reduce repetition of long paths. In any scope that can refer to
+crate::garden::vegetables::Asparagus, you can create a shortcut with use crate::garden::vegetables::Asparagus; and from then on you only need to
+write Asparagus to make use of that type in the scope.
+
+
Here, we create a binary crate named backyard that illustrates these rules.
+The crate’s directory, also named backyard, contains these files and
+directories:
Modules let us organize code within a crate for readability and easy reuse.
+Modules also allow us to control the privacy of items because code within a
+module is private by default. Private items are internal implementation details
+not available for outside use. We can choose to make modules and the items
+within them public, which exposes them to allow external code to use and depend
+on them.
+
As an example, let’s write a library crate that provides the functionality of a
+restaurant. We’ll define the signatures of functions but leave their bodies
+empty to concentrate on the organization of the code rather than the
+implementation of a restaurant.
+
In the restaurant industry, some parts of a restaurant are referred to as
+front of house and others as back of house. Front of house is where
+customers are; this encompasses where the hosts seat customers, servers take
+orders and payment, and bartenders make drinks. Back of house is where the
+chefs and cooks work in the kitchen, dishwashers clean up, and managers do
+administrative work.
+
To structure our crate in this way, we can organize its functions into nested
+modules. Create a new library named restaurant by running cargo new restaurant --lib. Then enter the code in Listing 7-1 into src/lib.rs to
+define some modules and function signatures; this code is the front of house
+section.
Listing 7-1: A front_of_house module containing other
+modules that then contain functions
+
We define a module with the mod keyword followed by the name of the module
+(in this case, front_of_house). The body of the module then goes inside curly
+brackets. Inside modules, we can place other modules, as in this case with the
+modules hosting and serving. Modules can also hold definitions for other
+items, such as structs, enums, constants, traits, and—as in Listing
+7-1—functions.
+
By using modules, we can group related definitions together and name why
+they’re related. Programmers using this code can navigate the code based on the
+groups rather than having to read through all the definitions, making it easier
+to find the definitions relevant to them. Programmers adding new functionality
+to this code would know where to place the code to keep the program organized.
+
Earlier, we mentioned that src/main.rs and src/lib.rs are called crate
+roots. The reason for their name is that the contents of either of these two
+files form a module named crate at the root of the crate’s module structure,
+known as the module tree.
+
Listing 7-2 shows the module tree for the structure in Listing 7-1.
Listing 7-2: The module tree for the code in Listing
+7-1
+
This tree shows how some of the modules nest inside other modules; for example,
+hosting nests inside front_of_house. The tree also shows that some modules
+are siblings, meaning they’re defined in the same module; hosting and
+serving are siblings defined within front_of_house. If module A is
+contained inside module B, we say that module A is the child of module B and
+that module B is the parent of module A. Notice that the entire module tree
+is rooted under the implicit module named crate.
+
The module tree might remind you of the filesystem’s directory tree on your
+computer; this is a very apt comparison! Just like directories in a filesystem,
+you use modules to organize your code. And just like files in a directory, we
+need a way to find our modules.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html b/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html
new file mode 100644
index 0000000000..615982c9a3
--- /dev/null
+++ b/ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html
@@ -0,0 +1,597 @@
+
+
+
+
+
+ Paths for Referring to an Item in the Module Tree - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
To show Rust where to find an item in a module tree, we use a path in the same
+way we use a path when navigating a filesystem. To call a function, we need to
+know its path.
+
A path can take two forms:
+
+
An absolute path is the full path starting from a crate root; for code
+from an external crate, the absolute path begins with the crate name, and for
+code from the current crate, it starts with the literal crate.
+
A relative path starts from the current module and uses self, super, or
+an identifier in the current module.
+
+
Both absolute and relative paths are followed by one or more identifiers
+separated by double colons (::).
+
Returning to Listing 7-1, say we want to call the add_to_waitlist function.
+This is the same as asking: what’s the path of the add_to_waitlist function?
+Listing 7-3 contains Listing 7-1 with some of the modules and functions
+removed.
+
We’ll show two ways to call the add_to_waitlist function from a new function,
+eat_at_restaurant, defined in the crate root. These paths are correct, but
+there’s another problem remaining that will prevent this example from compiling
+as is. We’ll explain why in a bit.
+
The eat_at_restaurant function is part of our library crate’s public API, so
+we mark it with the pub keyword. In the “Exposing Paths with the pub
+Keyword” section, we’ll go into more detail about pub.
Listing 7-3: Calling the add_to_waitlist function using
+absolute and relative paths
+
The first time we call the add_to_waitlist function in eat_at_restaurant,
+we use an absolute path. The add_to_waitlist function is defined in the same
+crate as eat_at_restaurant, which means we can use the crate keyword to
+start an absolute path. We then include each of the successive modules until we
+make our way to add_to_waitlist. You can imagine a filesystem with the same
+structure: we’d specify the path /front_of_house/hosting/add_to_waitlist to
+run the add_to_waitlist program; using the crate name to start from the
+crate root is like using / to start from the filesystem root in your shell.
+
The second time we call add_to_waitlist in eat_at_restaurant, we use a
+relative path. The path starts with front_of_house, the name of the module
+defined at the same level of the module tree as eat_at_restaurant. Here the
+filesystem equivalent would be using the path
+front_of_house/hosting/add_to_waitlist. Starting with a module name means
+that the path is relative.
+
Choosing whether to use a relative or absolute path is a decision you’ll make
+based on your project, and it depends on whether you’re more likely to move
+item definition code separately from or together with the code that uses the
+item. For example, if we moved the front_of_house module and the
+eat_at_restaurant function into a module named customer_experience, we’d
+need to update the absolute path to add_to_waitlist, but the relative path
+would still be valid. However, if we moved the eat_at_restaurant function
+separately into a module named dining, the absolute path to the
+add_to_waitlist call would stay the same, but the relative path would need to
+be updated. Our preference in general is to specify absolute paths because it’s
+more likely we’ll want to move code definitions and item calls independently of
+each other.
+
Let’s try to compile Listing 7-3 and find out why it won’t compile yet! The
+errors we get are shown in Listing 7-4.
+
$ cargo build
+ Compiling restaurant v0.1.0 (file:///projects/restaurant)
+error[E0603]: module `hosting` is private
+ --> src/lib.rs:9:28
+ |
+9 | crate::front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^ --------------- function `add_to_waitlist` is not publicly re-exported
+ | |
+ | private module
+ |
+note: the module `hosting` is defined here
+ --> src/lib.rs:2:5
+ |
+2 | mod hosting {
+ | ^^^^^^^^^^^
+
+error[E0603]: module `hosting` is private
+ --> src/lib.rs:12:21
+ |
+12 | front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^ --------------- function `add_to_waitlist` is not publicly re-exported
+ | |
+ | private module
+ |
+note: the module `hosting` is defined here
+ --> src/lib.rs:2:5
+ |
+2 | mod hosting {
+ | ^^^^^^^^^^^
+
+For more information about this error, try `rustc --explain E0603`.
+error: could not compile `restaurant` (lib) due to 2 previous errors
+
+
Listing 7-4: Compiler errors from building the code in
+Listing 7-3
+
The error messages say that module hosting is private. In other words, we
+have the correct paths for the hosting module and the add_to_waitlist
+function, but Rust won’t let us use them because it doesn’t have access to the
+private sections. In Rust, all items (functions, methods, structs, enums,
+modules, and constants) are private to parent modules by default. If you want
+to make an item like a function or struct private, you put it in a module.
+
Items in a parent module can’t use the private items inside child modules, but
+items in child modules can use the items in their ancestor modules. This is
+because child modules wrap and hide their implementation details, but the child
+modules can see the context in which they’re defined. To continue with our
+metaphor, think of the privacy rules as being like the back office of a
+restaurant: what goes on in there is private to restaurant customers, but
+office managers can see and do everything in the restaurant they operate.
+
Rust chose to have the module system function this way so that hiding inner
+implementation details is the default. That way, you know which parts of the
+inner code you can change without breaking outer code. However, Rust does give
+you the option to expose inner parts of child modules’ code to outer ancestor
+modules by using the pub keyword to make an item public.
Let’s return to the error in Listing 7-4 that told us the hosting module is
+private. We want the eat_at_restaurant function in the parent module to have
+access to the add_to_waitlist function in the child module, so we mark the
+hosting module with the pub keyword, as shown in Listing 7-5.
Listing 7-5: Declaring the hosting module as pub to
+use it from eat_at_restaurant
+
Unfortunately, the code in Listing 7-5 still results in compiler errors, as
+shown in Listing 7-6.
+
$ cargo build
+ Compiling restaurant v0.1.0 (file:///projects/restaurant)
+error[E0603]: function `add_to_waitlist` is private
+ --> src/lib.rs:9:37
+ |
+9 | crate::front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^^^^^^^^^ private function
+ |
+note: the function `add_to_waitlist` is defined here
+ --> src/lib.rs:3:9
+ |
+3 | fn add_to_waitlist() {}
+ | ^^^^^^^^^^^^^^^^^^^^
+
+error[E0603]: function `add_to_waitlist` is private
+ --> src/lib.rs:12:30
+ |
+12 | front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^^^^^^^^^ private function
+ |
+note: the function `add_to_waitlist` is defined here
+ --> src/lib.rs:3:9
+ |
+3 | fn add_to_waitlist() {}
+ | ^^^^^^^^^^^^^^^^^^^^
+
+For more information about this error, try `rustc --explain E0603`.
+error: could not compile `restaurant` (lib) due to 2 previous errors
+
+
Listing 7-6: Compiler errors from building the code in
+Listing 7-5
+
What happened? Adding the pub keyword in front of mod hosting makes the
+module public. With this change, if we can access front_of_house, we can
+access hosting. But the contents of hosting are still private; making the
+module public doesn’t make its contents public. The pub keyword on a module
+only lets code in its ancestor modules refer to it, not access its inner code.
+Because modules are containers, there’s not much we can do by only making the
+module public; we need to go further and choose to make one or more of the
+items within the module public as well.
+
The errors in Listing 7-6 say that the add_to_waitlist function is private.
+The privacy rules apply to structs, enums, functions, and methods as well as
+modules.
+
Let’s also make the add_to_waitlist function public by adding the pub
+keyword before its definition, as in Listing 7-7.
Listing 7-7: Adding the pub keyword to mod hosting
+and fn add_to_waitlist lets us call the function from
+eat_at_restaurant
+
Now the code will compile! To see why adding the pub keyword lets us use
+these paths in eat_at_restaurant with respect to the privacy rules, let’s look
+at the absolute and the relative paths.
+
In the absolute path, we start with crate, the root of our crate’s module
+tree. The front_of_house module is defined in the crate root. While
+front_of_house isn’t public, because the eat_at_restaurant function is
+defined in the same module as front_of_house (that is, eat_at_restaurant
+and front_of_house are siblings), we can refer to front_of_house from
+eat_at_restaurant. Next is the hosting module marked with pub. We can
+access the parent module of hosting, so we can access hosting. Finally, the
+add_to_waitlist function is marked with pub and we can access its parent
+module, so this function call works!
+
In the relative path, the logic is the same as the absolute path except for the
+first step: rather than starting from the crate root, the path starts from
+front_of_house. The front_of_house module is defined within the same module
+as eat_at_restaurant, so the relative path starting from the module in which
+eat_at_restaurant is defined works. Then, because hosting and
+add_to_waitlist are marked with pub, the rest of the path works, and this
+function call is valid!
+
If you plan on sharing your library crate so other projects can use your code,
+your public API is your contract with users of your crate that determines how
+they can interact with your code. There are many considerations around managing
+changes to your public API to make it easier for people to depend on your
+crate. These considerations are out of the scope of this book; if you’re
+interested in this topic, see The Rust API Guidelines.
We mentioned that a package can contain both a src/main.rs binary crate
+root as well as a src/lib.rs library crate root, and both crates will have
+the package name by default. Typically, packages with this pattern of
+containing both a library and a binary crate will have just enough code in the
+binary crate to start an executable that calls code within the library crate.
+This lets other projects benefit from most of the functionality that the
+package provides because the library crate’s code can be shared.
+
The module tree should be defined in src/lib.rs. Then, any public items can
+be used in the binary crate by starting paths with the name of the package.
+The binary crate becomes a user of the library crate just like a completely
+external crate would use the library crate: it can only use the public API.
+This helps you design a good API; not only are you the author, you’re also a
+client!
+
In Chapter 12, we’ll demonstrate this organizational
+practice with a command-line program that will contain both a binary crate
+and a library crate.
We can construct relative paths that begin in the parent module, rather than
+the current module or the crate root, by using super at the start of the
+path. This is like starting a filesystem path with the .. syntax. Using
+super allows us to reference an item that we know is in the parent module,
+which can make rearranging the module tree easier when the module is closely
+related to the parent but the parent might be moved elsewhere in the module
+tree someday.
+
Consider the code in Listing 7-8 that models the situation in which a chef
+fixes an incorrect order and personally brings it out to the customer. The
+function fix_incorrect_order defined in the back_of_house module calls the
+function deliver_order defined in the parent module by specifying the path to
+deliver_order, starting with super.
Listing 7-8: Calling a function using a relative path
+starting with super
+
The fix_incorrect_order function is in the back_of_house module, so we can
+use super to go to the parent module of back_of_house, which in this case
+is crate, the root. From there, we look for deliver_order and find it.
+Success! We think the back_of_house module and the deliver_order function
+are likely to stay in the same relationship to each other and get moved
+together should we decide to reorganize the crate’s module tree. Therefore, we
+used super so we’ll have fewer places to update code in the future if this
+code gets moved to a different module.
We can also use pub to designate structs and enums as public, but there are a
+few extra details to the usage of pub with structs and enums. If we use pub
+before a struct definition, we make the struct public, but the struct’s fields
+will still be private. We can make each field public or not on a case-by-case
+basis. In Listing 7-9, we’ve defined a public back_of_house::Breakfast struct
+with a public toast field but a private seasonal_fruit field. This models
+the case in a restaurant where the customer can pick the type of bread that
+comes with a meal, but the chef decides which fruit accompanies the meal based
+on what’s in season and in stock. The available fruit changes quickly, so
+customers can’t choose the fruit or even see which fruit they’ll get.
+
Filename: src/lib.rs
+
mod back_of_house {
+ pub struct Breakfast {
+ pub toast: String,
+ seasonal_fruit: String,
+ }
+
+ impl Breakfast {
+ pub fn summer(toast: &str) -> Breakfast {
+ Breakfast {
+ toast: String::from(toast),
+ seasonal_fruit: String::from("peaches"),
+ }
+ }
+ }
+}
+
+pub fn eat_at_restaurant() {
+ // Order a breakfast in the summer with Rye toast
+ let mut meal = back_of_house::Breakfast::summer("Rye");
+ // Change our mind about what bread we'd like
+ meal.toast = String::from("Wheat");
+ println!("I'd like {} toast please", meal.toast);
+
+ // The next line won't compile if we uncomment it; we're not allowed
+ // to see or modify the seasonal fruit that comes with the meal
+ // meal.seasonal_fruit = String::from("blueberries");
+}
+
Listing 7-9: A struct with some public fields and some
+private fields
+
Because the toast field in the back_of_house::Breakfast struct is public,
+in eat_at_restaurant we can write and read to the toast field using dot
+notation. Notice that we can’t use the seasonal_fruit field in
+eat_at_restaurant, because seasonal_fruit is private. Try uncommenting the
+line modifying the seasonal_fruit field value to see what error you get!
+
Also, note that because back_of_house::Breakfast has a private field, the
+struct needs to provide a public associated function that constructs an
+instance of Breakfast (we’ve named it summer here). If Breakfast didn’t
+have such a function, we couldn’t create an instance of Breakfast in
+eat_at_restaurant because we couldn’t set the value of the private
+seasonal_fruit field in eat_at_restaurant.
+
In contrast, if we make an enum public, all of its variants are then public. We
+only need the pub before the enum keyword, as shown in Listing 7-10.
Listing 7-10: Designating an enum as public makes all its
+variants public
+
Because we made the Appetizer enum public, we can use the Soup and Salad
+variants in eat_at_restaurant.
+
Enums aren’t very useful unless their variants are public; it would be annoying
+to have to annotate all enum variants with pub in every case, so the default
+for enum variants is to be public. Structs are often useful without their
+fields being public, so struct fields follow the general rule of everything
+being private by default unless annotated with pub.
+
There’s one more situation involving pub that we haven’t covered, and that is
+our last module system feature: the use keyword. We’ll cover use by itself
+first, and then we’ll show how to combine pub and use.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch07-04-bringing-paths-into-scope-with-the-use-keyword.html b/ch07-04-bringing-paths-into-scope-with-the-use-keyword.html
new file mode 100644
index 0000000000..fbfc5787df
--- /dev/null
+++ b/ch07-04-bringing-paths-into-scope-with-the-use-keyword.html
@@ -0,0 +1,606 @@
+
+
+
+
+
+ Bringing Paths Into Scope with the use Keyword - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Having to write out the paths to call functions can feel inconvenient and
+repetitive. In Listing 7-7, whether we chose the absolute or relative path to
+the add_to_waitlist function, every time we wanted to call add_to_waitlist
+we had to specify front_of_house and hosting too. Fortunately, there’s a
+way to simplify this process: we can create a shortcut to a path with the use
+keyword once, and then use the shorter name everywhere else in the scope.
+
In Listing 7-11, we bring the crate::front_of_house::hosting module into the
+scope of the eat_at_restaurant function so we only have to specify
+hosting::add_to_waitlist to call the add_to_waitlist function in
+eat_at_restaurant.
Listing 7-11: Bringing a module into scope with
+use
+
Adding use and a path in a scope is similar to creating a symbolic link in
+the filesystem. By adding use crate::front_of_house::hosting in the crate
+root, hosting is now a valid name in that scope, just as though the hosting
+module had been defined in the crate root. Paths brought into scope with use
+also check privacy, like any other paths.
+
Note that use only creates the shortcut for the particular scope in which the
+use occurs. Listing 7-12 moves the eat_at_restaurant function into a new
+child module named customer, which is then a different scope than the use
+statement, so the function body won’t compile.
Listing 7-12: A use statement only applies in the scope
+it’s in
+
The compiler error shows that the shortcut no longer applies within the
+customer module:
+
$ cargo build
+ Compiling restaurant v0.1.0 (file:///projects/restaurant)
+error[E0433]: failed to resolve: use of undeclared crate or module `hosting`
+ --> src/lib.rs:11:9
+ |
+11 | hosting::add_to_waitlist();
+ | ^^^^^^^ use of undeclared crate or module `hosting`
+ |
+help: consider importing this module through its public re-export
+ |
+10 + use crate::hosting;
+ |
+
+warning: unused import: `crate::front_of_house::hosting`
+ --> src/lib.rs:7:5
+ |
+7 | use crate::front_of_house::hosting;
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: `#[warn(unused_imports)]` on by default
+
+For more information about this error, try `rustc --explain E0433`.
+warning: `restaurant` (lib) generated 1 warning
+error: could not compile `restaurant` (lib) due to 1 previous error; 1 warning emitted
+
+
Notice there’s also a warning that the use is no longer used in its scope! To
+fix this problem, move the use within the customer module too, or reference
+the shortcut in the parent module with super::hosting within the child
+customer module.
In Listing 7-11, you might have wondered why we specified use crate::front_of_house::hosting and then called hosting::add_to_waitlist in
+eat_at_restaurant, rather than specifying the use path all the way out to
+the add_to_waitlist function to achieve the same result, as in Listing 7-13.
Listing 7-13: Bringing the add_to_waitlist function
+into scope with use, which is unidiomatic
+
Although both Listing 7-11 and Listing 7-13 accomplish the same task, Listing
+7-11 is the idiomatic way to bring a function into scope with use. Bringing
+the function’s parent module into scope with use means we have to specify the
+parent module when calling the function. Specifying the parent module when
+calling the function makes it clear that the function isn’t locally defined
+while still minimizing repetition of the full path. The code in Listing 7-13 is
+unclear as to where add_to_waitlist is defined.
+
On the other hand, when bringing in structs, enums, and other items with use,
+it’s idiomatic to specify the full path. Listing 7-14 shows the idiomatic way
+to bring the standard library’s HashMap struct into the scope of a binary
+crate.
+
Filename: src/main.rs
+
use std::collections::HashMap;
+
+fn main() {
+ let mut map = HashMap::new();
+ map.insert(1, 2);
+}
+
Listing 7-14: Bringing HashMap into scope in an
+idiomatic way
+
There’s no strong reason behind this idiom: it’s just the convention that has
+emerged, and folks have gotten used to reading and writing Rust code this way.
+
The exception to this idiom is if we’re bringing two items with the same name
+into scope with use statements, because Rust doesn’t allow that. Listing 7-15
+shows how to bring two Result types into scope that have the same name but
+different parent modules, and how to refer to them.
Listing 7-15: Bringing two types with the same name into
+the same scope requires using their parent modules.
+
As you can see, using the parent modules distinguishes the two Result types.
+If instead we specified use std::fmt::Result and use std::io::Result, we’d
+have two Result types in the same scope, and Rust wouldn’t know which one we
+meant when we used Result.
There’s another solution to the problem of bringing two types of the same name
+into the same scope with use: after the path, we can specify as and a new
+local name, or alias, for the type. Listing 7-16 shows another way to write
+the code in Listing 7-15 by renaming one of the two Result types using as.
+
Filename: src/lib.rs
+
use std::fmt::Result;
+use std::io::Result as IoResult;
+
+fn function1() -> Result {
+ // --snip--
+ Ok(())
+}
+
+fn function2() -> IoResult<()> {
+ // --snip--
+ Ok(())
+}
+
Listing 7-16: Renaming a type when it’s brought into
+scope with the as keyword
+
In the second use statement, we chose the new name IoResult for the
+std::io::Result type, which won’t conflict with the Result from std::fmt
+that we’ve also brought into scope. Listing 7-15 and Listing 7-16 are
+considered idiomatic, so the choice is up to you!
When we bring a name into scope with the use keyword, the name available in
+the new scope is private. To enable the code that calls our code to refer to
+that name as if it had been defined in that code’s scope, we can combine pub
+and use. This technique is called re-exporting because we’re bringing an
+item into scope but also making that item available for others to bring into
+their scope.
+
Listing 7-17 shows the code in Listing 7-11 with use in the root module
+changed to pub use.
+
Filename: src/lib.rs
+
mod front_of_house {
+ pub mod hosting {
+ pub fn add_to_waitlist() {}
+ }
+}
+
+pub use crate::front_of_house::hosting;
+
+pub fn eat_at_restaurant() {
+ hosting::add_to_waitlist();
+}
+
Listing 7-17: Making a name available for any code to use
+from a new scope with pub use
+
Before this change, external code would have to call the add_to_waitlist
+function by using the path
+restaurant::front_of_house::hosting::add_to_waitlist(), which also would have
+required the front_of_house module to be marked as pub. Now that this pub use has re-exported the hosting module from the root module, external code
+can use the path restaurant::hosting::add_to_waitlist() instead.
+
Re-exporting is useful when the internal structure of your code is different
+from how programmers calling your code would think about the domain. For
+example, in this restaurant metaphor, the people running the restaurant think
+about “front of house” and “back of house.” But customers visiting a restaurant
+probably won’t think about the parts of the restaurant in those terms. With
+pub use, we can write our code with one structure but expose a different
+structure. Doing so makes our library well organized for programmers working on
+the library and programmers calling the library. We’ll look at another example
+of pub use and how it affects your crate’s documentation in the “Exporting a
+Convenient Public API with pub use” section of
+Chapter 14.
In Chapter 2, we programmed a guessing game project that used an external
+package called rand to get random numbers. To use rand in our project, we
+added this line to Cargo.toml:
+
+
Filename: Cargo.toml
+
rand = "0.8.5"
+
+
Adding rand as a dependency in Cargo.toml tells Cargo to download the
+rand package and any dependencies from crates.io and
+make rand available to our project.
+
Then, to bring rand definitions into the scope of our package, we added a
+use line starting with the name of the crate, rand, and listed the items
+we wanted to bring into scope. Recall that in the “Generating a Random
+Number” section in Chapter 2, we brought the Rng trait
+into scope and called the rand::thread_rng function:
+
use std::io;
+use rand::Rng;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+}
+
Members of the Rust community have made many packages available at
+crates.io, and pulling any of them into your package
+involves these same steps: listing them in your package’s Cargo.toml file and
+using use to bring items from their crates into scope.
+
Note that the standard std library is also a crate that’s external to our
+package. Because the standard library is shipped with the Rust language, we
+don’t need to change Cargo.toml to include std. But we do need to refer to
+it with use to bring items from there into our package’s scope. For example,
+with HashMap we would use this line:
If we’re using multiple items defined in the same crate or same module, listing
+each item on its own line can take up a lot of vertical space in our files. For
+example, these two use statements we had in the guessing game in Listing 2-4
+bring items from std into scope:
+
Filename: src/main.rs
+
use rand::Rng;
+// --snip--
+use std::cmp::Ordering;
+use std::io;
+// --snip--
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+
Instead, we can use nested paths to bring the same items into scope in one
+line. We do this by specifying the common part of the path, followed by two
+colons, and then curly brackets around a list of the parts of the paths that
+differ, as shown in Listing 7-18.
+
Filename: src/main.rs
+
use rand::Rng;
+// --snip--
+use std::{cmp::Ordering, io};
+// --snip--
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+
Listing 7-18: Specifying a nested path to bring multiple
+items with the same prefix into scope
+
In bigger programs, bringing many items into scope from the same crate or
+module using nested paths can reduce the number of separate use statements
+needed by a lot!
+
We can use a nested path at any level in a path, which is useful when combining
+two use statements that share a subpath. For example, Listing 7-19 shows two
+use statements: one that brings std::io into scope and one that brings
+std::io::Write into scope.
+
Filename: src/lib.rs
+
use std::io;
+use std::io::Write;
+
Listing 7-19: Two use statements where one is a subpath
+of the other
+
The common part of these two paths is std::io, and that’s the complete first
+path. To merge these two paths into one use statement, we can use self in
+the nested path, as shown in Listing 7-20.
+
Filename: src/lib.rs
+
use std::io::{self, Write};
+
Listing 7-20: Combining the paths in Listing 7-19 into
+one use statement
+
This line brings std::io and std::io::Write into scope.
This use statement brings all public items defined in std::collections into
+the current scope. Be careful when using the glob operator! Glob can make it
+harder to tell what names are in scope and where a name used in your program
+was defined.
+
The glob operator is often used when testing to bring everything under test
+into the tests module; we’ll talk about that in the “How to Write
+Tests” section in Chapter 11. The glob operator
+is also sometimes used as part of the prelude pattern: see the standard
+library documentation
+for more information on that pattern.
So far, all the examples in this chapter defined multiple modules in one file.
+When modules get large, you might want to move their definitions to a separate
+file to make the code easier to navigate.
+
For example, let’s start from the code in Listing 7-17 that had multiple
+restaurant modules. We’ll extract modules into files instead of having all the
+modules defined in the crate root file. In this case, the crate root file is
+src/lib.rs, but this procedure also works with binary crates whose crate root
+file is src/main.rs.
+
First we’ll extract the front_of_house module to its own file. Remove the
+code inside the curly brackets for the front_of_house module, leaving only
+the mod front_of_house; declaration, so that src/lib.rs contains the code
+shown in Listing 7-21. Note that this won’t compile until we create the
+src/front_of_house.rs file in Listing 7-22.
+
Filename: src/lib.rs
+
mod front_of_house;
+
+pub use crate::front_of_house::hosting;
+
+pub fn eat_at_restaurant() {
+ hosting::add_to_waitlist();
+}
+
Listing 7-21: Declaring the front_of_house module whose
+body will be in src/front_of_house.rs
+
Next, place the code that was in the curly brackets into a new file named
+src/front_of_house.rs, as shown in Listing 7-22. The compiler knows to look
+in this file because it came across the module declaration in the crate root
+with the name front_of_house.
+
Filename: src/front_of_house.rs
+
pub mod hosting {
+ pub fn add_to_waitlist() {}
+}
+
Listing 7-22: Definitions inside the front_of_house
+module in src/front_of_house.rs
+
Note that you only need to load a file using a mod declaration once in your
+module tree. Once the compiler knows the file is part of the project (and knows
+where in the module tree the code resides because of where you’ve put the mod
+statement), other files in your project should refer to the loaded file’s code
+using a path to where it was declared, as covered in the “Paths for Referring
+to an Item in the Module Tree” section. In other words,
+mod is not an “include” operation that you may have seen in other
+programming languages.
+
Next, we’ll extract the hosting module to its own file. The process is a bit
+different because hosting is a child module of front_of_house, not of the
+root module. We’ll place the file for hosting in a new directory that will be
+named for its ancestors in the module tree, in this case src/front_of_house.
+
To start moving hosting, we change src/front_of_house.rs to contain only
+the declaration of the hosting module:
+
Filename: src/front_of_house.rs
+
pub mod hosting;
+
Then we create a src/front_of_house directory and a hosting.rs file to
+contain the definitions made in the hosting module:
+
Filename: src/front_of_house/hosting.rs
+
pub fn add_to_waitlist() {}
+
If we instead put hosting.rs in the src directory, the compiler would
+expect the hosting.rs code to be in a hosting module declared in the crate
+root, and not declared as a child of the front_of_house module. The
+compiler’s rules for which files to check for which modules’ code mean the
+directories and files more closely match the module tree.
So far we’ve covered the most idiomatic file paths the Rust compiler uses,
+but Rust also supports an older style of file path. For a module named
+front_of_house declared in the crate root, the compiler will look for the
+module’s code in:
+
+
src/front_of_house.rs (what we covered)
+
src/front_of_house/mod.rs (older style, still supported path)
+
+
For a module named hosting that is a submodule of front_of_house, the
+compiler will look for the module’s code in:
+
+
src/front_of_house/hosting.rs (what we covered)
+
src/front_of_house/hosting/mod.rs (older style, still supported path)
+
+
If you use both styles for the same module, you’ll get a compiler error.
+Using a mix of both styles for different modules in the same project is
+allowed, but might be confusing for people navigating your project.
+
The main downside to the style that uses files named mod.rs is that your
+project can end up with many files named mod.rs, which can get confusing
+when you have them open in your editor at the same time.
+
+
We’ve moved each module’s code to a separate file, and the module tree remains
+the same. The function calls in eat_at_restaurant will work without any
+modification, even though the definitions live in different files. This
+technique lets you move modules to new files as they grow in size.
+
Note that the pub use crate::front_of_house::hosting statement in
+src/lib.rs also hasn’t changed, nor does use have any impact on what files
+are compiled as part of the crate. The mod keyword declares modules, and Rust
+looks in a file with the same name as the module for the code that goes into
+that module.
Rust lets you split a package into multiple crates and a crate into modules so
+you can refer to items defined in one module from another module. You can do
+this by specifying absolute or relative paths. These paths can be brought into
+scope with a use statement so you can use a shorter path for multiple uses of
+the item in that scope. Module code is private by default, but you can make
+definitions public by adding the pub keyword.
+
In the next chapter, we’ll look at some collection data structures in the
+standard library that you can use in your neatly organized code.
Rust’s standard library includes a number of very useful data structures called
+collections. Most other data types represent one specific value, but
+collections can contain multiple values. Unlike the built-in array and tuple
+types, the data these collections point to is stored on the heap, which means
+the amount of data does not need to be known at compile time and can grow or
+shrink as the program runs. Each kind of collection has different capabilities
+and costs, and choosing an appropriate one for your current situation is a
+skill you’ll develop over time. In this chapter, we’ll discuss three
+collections that are used very often in Rust programs:
+
+
A vector allows you to store a variable number of values next to each other.
+
A string is a collection of characters. We’ve mentioned the String type
+previously, but in this chapter we’ll talk about it in depth.
+
A hash map allows you to associate a value with a specific key. It’s a
+particular implementation of the more general data structure called a map.
+
+
To learn about the other kinds of collections provided by the standard library,
+see the documentation.
+
We’ll discuss how to create and update vectors, strings, and hash maps, as well
+as what makes each special.
The first collection type we’ll look at is Vec<T>, also known as a vector.
+Vectors allow you to store more than one value in a single data structure that
+puts all the values next to each other in memory. Vectors can only store values
+of the same type. They are useful when you have a list of items, such as the
+lines of text in a file or the prices of items in a shopping cart.
To create a new empty vector, we call the Vec::new function, as shown in
+Listing 8-1.
+
fn main() {
+ let v: Vec<i32> = Vec::new();
+}
+
Listing 8-1: Creating a new, empty vector to hold values
+of type i32
+
Note that we added a type annotation here. Because we aren’t inserting any
+values into this vector, Rust doesn’t know what kind of elements we intend to
+store. This is an important point. Vectors are implemented using generics;
+we’ll cover how to use generics with your own types in Chapter 10. For now,
+know that the Vec<T> type provided by the standard library can hold any type.
+When we create a vector to hold a specific type, we can specify the type within
+angle brackets. In Listing 8-1, we’ve told Rust that the Vec<T> in v will
+hold elements of the i32 type.
+
More often, you’ll create a Vec<T> with initial values and Rust will infer
+the type of value you want to store, so you rarely need to do this type
+annotation. Rust conveniently provides the vec! macro, which will create a
+new vector that holds the values you give it. Listing 8-2 creates a new
+Vec<i32> that holds the values 1, 2, and 3. The integer type is i32
+because that’s the default integer type, as we discussed in the “Data
+Types” section of Chapter 3.
+
fn main() {
+ let v = vec![1, 2, 3];
+}
+
Listing 8-2: Creating a new vector containing
+values
+
Because we’ve given initial i32 values, Rust can infer that the type of v
+is Vec<i32>, and the type annotation isn’t necessary. Next, we’ll look at how
+to modify a vector.
To create a vector and then add elements to it, we can use the push method,
+as shown in Listing 8-3.
+
fn main() {
+ let mut v = Vec::new();
+
+ v.push(5);
+ v.push(6);
+ v.push(7);
+ v.push(8);
+}
+
Listing 8-3: Using the push method to add values to a
+vector
+
As with any variable, if we want to be able to change its value, we need to
+make it mutable using the mut keyword, as discussed in Chapter 3. The numbers
+we place inside are all of type i32, and Rust infers this from the data, so
+we don’t need the Vec<i32> annotation.
There are two ways to reference a value stored in a vector: via indexing or by
+using the get method. In the following examples, we’ve annotated the types of
+the values that are returned from these functions for extra clarity.
+
Listing 8-4 shows both methods of accessing a value in a vector, with indexing
+syntax and the get method.
+
fn main() {
+ let v = vec![1, 2, 3, 4, 5];
+
+ let third: &i32 = &v[2];
+ println!("The third element is {third}");
+
+ let third: Option<&i32> = v.get(2);
+ match third {
+ Some(third) => println!("The third element is {third}"),
+ None => println!("There is no third element."),
+ }
+}
+
Listing 8-4: Using indexing syntax and using the get
+method to access an item in a vector
+
Note a few details here. We use the index value of 2 to get the third element
+because vectors are indexed by number, starting at zero. Using & and []
+gives us a reference to the element at the index value. When we use the get
+method with the index passed as an argument, we get an Option<&T> that we can
+use with match.
+
Rust provides these two ways to reference an element so you can choose how the
+program behaves when you try to use an index value outside the range of
+existing elements. As an example, let’s see what happens when we have a vector
+of five elements and then we try to access an element at index 100 with each
+technique, as shown in Listing 8-5.
+
fn main() {
+ let v = vec![1, 2, 3, 4, 5];
+
+ let does_not_exist = &v[100];
+ let does_not_exist = v.get(100);
+}
+
Listing 8-5: Attempting to access the element at index
+100 in a vector containing five elements
+
When we run this code, the first [] method will cause the program to panic
+because it references a nonexistent element. This method is best used when you
+want your program to crash if there’s an attempt to access an element past the
+end of the vector.
+
When the get method is passed an index that is outside the vector, it returns
+None without panicking. You would use this method if accessing an element
+beyond the range of the vector may happen occasionally under normal
+circumstances. Your code will then have logic to handle having either
+Some(&element) or None, as discussed in Chapter 6. For example, the index
+could be coming from a person entering a number. If they accidentally enter a
+number that’s too large and the program gets a None value, you could tell the
+user how many items are in the current vector and give them another chance to
+enter a valid value. That would be more user-friendly than crashing the program
+due to a typo!
+
When the program has a valid reference, the borrow checker enforces the
+ownership and borrowing rules (covered in Chapter 4) to ensure this reference
+and any other references to the contents of the vector remain valid. Recall the
+rule that states you can’t have mutable and immutable references in the same
+scope. That rule applies in Listing 8-6, where we hold an immutable reference
+to the first element in a vector and try to add an element to the end. This
+program won’t work if we also try to refer to that element later in the
+function.
+
fn main() {
+ let mut v = vec![1, 2, 3, 4, 5];
+
+ let first = &v[0];
+
+ v.push(6);
+
+ println!("The first element is: {first}");
+}
+
Listing 8-6: Attempting to add an element to a vector
+while holding a reference to an item
+
Compiling this code will result in this error:
+
$ cargo run
+ Compiling collections v0.1.0 (file:///projects/collections)
+error[E0502]: cannot borrow `v` as mutable because it is also borrowed as immutable
+ --> src/main.rs:6:5
+ |
+4 | let first = &v[0];
+ | - immutable borrow occurs here
+5 |
+6 | v.push(6);
+ | ^^^^^^^^^ mutable borrow occurs here
+7 |
+8 | println!("The first element is: {first}");
+ | ------- immutable borrow later used here
+
+For more information about this error, try `rustc --explain E0502`.
+error: could not compile `collections` (bin "collections") due to 1 previous error
+
+
The code in Listing 8-6 might look like it should work: why should a reference
+to the first element care about changes at the end of the vector? This error is
+due to the way vectors work: because vectors put the values next to each other
+in memory, adding a new element onto the end of the vector might require
+allocating new memory and copying the old elements to the new space, if there
+isn’t enough room to put all the elements next to each other where the vector
+is currently stored. In that case, the reference to the first element would be
+pointing to deallocated memory. The borrowing rules prevent programs from
+ending up in that situation.
+
+
Note: For more on the implementation details of the Vec<T> type, see “The
+Rustonomicon”.
To access each element in a vector in turn, we would iterate through all of the
+elements rather than use indices to access one at a time. Listing 8-7 shows how
+to use a for loop to get immutable references to each element in a vector of
+i32 values and print them.
+
fn main() {
+ let v = vec![100, 32, 57];
+ for i in &v {
+ println!("{i}");
+ }
+}
+
Listing 8-7: Printing each element in a vector by
+iterating over the elements using a for loop
+
We can also iterate over mutable references to each element in a mutable vector
+in order to make changes to all the elements. The for loop in Listing 8-8
+will add 50 to each element.
+
fn main() {
+ let mut v = vec![100, 32, 57];
+ for i in &mut v {
+ *i += 50;
+ }
+}
+
Listing 8-8: Iterating over mutable references to
+elements in a vector
+
To change the value that the mutable reference refers to, we have to use the
+* dereference operator to get to the value in i before we can use the +=
+operator. We’ll talk more about the dereference operator in the “Following the
+Pointer to the Value with the Dereference Operator”
+section of Chapter 15.
+
Iterating over a vector, whether immutably or mutably, is safe because of the
+borrow checker’s rules. If we attempted to insert or remove items in the for
+loop bodies in Listing 8-7 and Listing 8-8, we would get a compiler error
+similar to the one we got with the code in Listing 8-6. The reference to the
+vector that the for loop holds prevents simultaneous modification of the
+whole vector.
Vectors can only store values that are of the same type. This can be
+inconvenient; there are definitely use cases for needing to store a list of
+items of different types. Fortunately, the variants of an enum are defined
+under the same enum type, so when we need one type to represent elements of
+different types, we can define and use an enum!
+
For example, say we want to get values from a row in a spreadsheet in which
+some of the columns in the row contain integers, some floating-point numbers,
+and some strings. We can define an enum whose variants will hold the different
+value types, and all the enum variants will be considered the same type: that
+of the enum. Then we can create a vector to hold that enum and so, ultimately,
+hold different types. We’ve demonstrated this in Listing 8-9.
Listing 8-9: Defining an enum to store values of
+different types in one vector
+
Rust needs to know what types will be in the vector at compile time so it knows
+exactly how much memory on the heap will be needed to store each element. We
+must also be explicit about what types are allowed in this vector. If Rust
+allowed a vector to hold any type, there would be a chance that one or more of
+the types would cause errors with the operations performed on the elements of
+the vector. Using an enum plus a match expression means that Rust will ensure
+at compile time that every possible case is handled, as discussed in Chapter 6.
+
If you don’t know the exhaustive set of types a program will get at runtime to
+store in a vector, the enum technique won’t work. Instead, you can use a trait
+object, which we’ll cover in Chapter 17.
+
Now that we’ve discussed some of the most common ways to use vectors, be sure
+to review the API documentation for all of the many
+useful methods defined on Vec<T> by the standard library. For example, in
+addition to push, a pop method removes and returns the last element.
Like any other struct, a vector is freed when it goes out of scope, as
+annotated in Listing 8-10.
+
fn main() {
+ {
+ let v = vec![1, 2, 3, 4];
+
+ // do stuff with v
+ } // <- v goes out of scope and is freed here
+}
+
Listing 8-10: Showing where the vector and its elements
+are dropped
+
When the vector gets dropped, all of its contents are also dropped, meaning the
+integers it holds will be cleaned up. The borrow checker ensures that any
+references to contents of a vector are only used while the vector itself is
+valid.
+
Let’s move on to the next collection type: String!
We talked about strings in Chapter 4, but we’ll look at them in more depth now.
+New Rustaceans commonly get stuck on strings for a combination of three
+reasons: Rust’s propensity for exposing possible errors, strings being a more
+complicated data structure than many programmers give them credit for, and
+UTF-8. These factors combine in a way that can seem difficult when you’re
+coming from other programming languages.
+
We discuss strings in the context of collections because strings are
+implemented as a collection of bytes, plus some methods to provide useful
+functionality when those bytes are interpreted as text. In this section, we’ll
+talk about the operations on String that every collection type has, such as
+creating, updating, and reading. We’ll also discuss the ways in which String
+is different from the other collections, namely how indexing into a String is
+complicated by the differences between how people and computers interpret
+String data.
We’ll first define what we mean by the term string. Rust has only one string
+type in the core language, which is the string slice str that is usually seen
+in its borrowed form &str. In Chapter 4, we talked about string slices,
+which are references to some UTF-8 encoded string data stored elsewhere. String
+literals, for example, are stored in the program’s binary and are therefore
+string slices.
+
The String type, which is provided by Rust’s standard library rather than
+coded into the core language, is a growable, mutable, owned, UTF-8 encoded
+string type. When Rustaceans refer to “strings” in Rust, they might be
+referring to either the String or the string slice &str types, not just one
+of those types. Although this section is largely about String, both types are
+used heavily in Rust’s standard library, and both String and string slices
+are UTF-8 encoded.
Many of the same operations available with Vec<T> are available with String
+as well because String is actually implemented as a wrapper around a vector
+of bytes with some extra guarantees, restrictions, and capabilities. An example
+of a function that works the same way with Vec<T> and String is the new
+function to create an instance, shown in Listing 8-11.
+
fn main() {
+ let mut s = String::new();
+}
+
Listing 8-11: Creating a new, empty String
+
This line creates a new, empty string called s, into which we can then load
+data. Often, we’ll have some initial data with which we want to start the
+string. For that, we use the to_string method, which is available on any type
+that implements the Display trait, as string literals do. Listing 8-12 shows
+two examples.
+
fn main() {
+ let data = "initial contents";
+
+ let s = data.to_string();
+
+ // the method also works on a literal directly:
+ let s = "initial contents".to_string();
+}
+
Listing 8-12: Using the to_string method to create a
+String from a string literal
+
This code creates a string containing initial contents.
+
We can also use the function String::from to create a String from a string
+literal. The code in Listing 8-13 is equivalent to the code in Listing 8-12
+that uses to_string.
+
fn main() {
+ let s = String::from("initial contents");
+}
+
Listing 8-13: Using the String::from function to create
+a String from a string literal
+
Because strings are used for so many things, we can use many different generic
+APIs for strings, providing us with a lot of options. Some of them can seem
+redundant, but they all have their place! In this case, String::from and
+to_string do the same thing, so which one you choose is a matter of style and
+readability.
+
Remember that strings are UTF-8 encoded, so we can include any properly encoded
+data in them, as shown in Listing 8-14.
+
fn main() {
+ let hello = String::from("السلام عليكم");
+ let hello = String::from("Dobrý den");
+ let hello = String::from("Hello");
+ let hello = String::from("שלום");
+ let hello = String::from("नमस्ते");
+ let hello = String::from("こんにちは");
+ let hello = String::from("안녕하세요");
+ let hello = String::from("你好");
+ let hello = String::from("Olá");
+ let hello = String::from("Здравствуйте");
+ let hello = String::from("Hola");
+}
+
Listing 8-14: Storing greetings in different languages in
+strings
A String can grow in size and its contents can change, just like the contents
+of a Vec<T>, if you push more data into it. In addition, you can conveniently
+use the + operator or the format! macro to concatenate String values.
We can grow a String by using the push_str method to append a string slice,
+as shown in Listing 8-15.
+
fn main() {
+ let mut s = String::from("foo");
+ s.push_str("bar");
+}
+
Listing 8-15: Appending a string slice to a String
+using the push_str method
+
After these two lines, s will contain foobar. The push_str method takes a
+string slice because we don’t necessarily want to take ownership of the
+parameter. For example, in the code in Listing 8-16, we want to be able to use
+s2 after appending its contents to s1.
+
fn main() {
+ let mut s1 = String::from("foo");
+ let s2 = "bar";
+ s1.push_str(s2);
+ println!("s2 is {s2}");
+}
+
Listing 8-16: Using a string slice after appending its
+contents to a String
+
If the push_str method took ownership of s2, we wouldn’t be able to print
+its value on the last line. However, this code works as we’d expect!
+
The push method takes a single character as a parameter and adds it to the
+String. Listing 8-17 adds the letter l to a String using the push
+method.
+
fn main() {
+ let mut s = String::from("lo");
+ s.push('l');
+}
+
Listing 8-17: Adding one character to a String value
+using push
Often, you’ll want to combine two existing strings. One way to do so is to use
+the + operator, as shown in Listing 8-18.
+
fn main() {
+ let s1 = String::from("Hello, ");
+ let s2 = String::from("world!");
+ let s3 = s1 + &s2; // note s1 has been moved here and can no longer be used
+}
+
Listing 8-18: Using the + operator to combine two
+String values into a new String value
+
The string s3 will contain Hello, world!. The reason s1 is no longer
+valid after the addition, and the reason we used a reference to s2, has to do
+with the signature of the method that’s called when we use the + operator.
+The + operator uses the add method, whose signature looks something like
+this:
+
fn add(self, s: &str) -> String {
+
In the standard library, you’ll see add defined using generics and associated
+types. Here, we’ve substituted in concrete types, which is what happens when we
+call this method with String values. We’ll discuss generics in Chapter 10.
+This signature gives us the clues we need in order to understand the tricky
+bits of the + operator.
+
First, s2 has an &, meaning that we’re adding a reference of the second
+string to the first string. This is because of the s parameter in the add
+function: we can only add a &str to a String; we can’t add two String
+values together. But wait—the type of &s2 is &String, not &str, as
+specified in the second parameter to add. So why does Listing 8-18 compile?
+
The reason we’re able to use &s2 in the call to add is that the compiler
+can coerce the &String argument into a &str. When we call the add
+method, Rust uses a deref coercion, which here turns &s2 into &s2[..].
+We’ll discuss deref coercion in more depth in Chapter 15. Because add does
+not take ownership of the s parameter, s2 will still be a valid String
+after this operation.
+
Second, we can see in the signature that add takes ownership of self
+because self does not have an &. This means s1 in Listing 8-18 will be
+moved into the add call and will no longer be valid after that. So, although
+let s3 = s1 + &s2; looks like it will copy both strings and create a new one,
+this statement actually takes ownership of s1, appends a copy of the contents
+of s2, and then returns ownership of the result. In other words, it looks
+like it’s making a lot of copies, but it isn’t; the implementation is more
+efficient than copying.
+
If we need to concatenate multiple strings, the behavior of the + operator
+gets unwieldy:
+
fn main() {
+ let s1 = String::from("tic");
+ let s2 = String::from("tac");
+ let s3 = String::from("toe");
+
+ let s = s1 + "-" + &s2 + "-" + &s3;
+}
+
At this point, s will be tic-tac-toe. With all of the + and "
+characters, it’s difficult to see what’s going on. For combining strings in
+more complicated ways, we can instead use the format! macro:
+
fn main() {
+ let s1 = String::from("tic");
+ let s2 = String::from("tac");
+ let s3 = String::from("toe");
+
+ let s = format!("{s1}-{s2}-{s3}");
+}
+
This code also sets s to tic-tac-toe. The format! macro works like
+println!, but instead of printing the output to the screen, it returns a
+String with the contents. The version of the code using format! is much
+easier to read, and the code generated by the format! macro uses references
+so that this call doesn’t take ownership of any of its parameters.
In many other programming languages, accessing individual characters in a
+string by referencing them by index is a valid and common operation. However,
+if you try to access parts of a String using indexing syntax in Rust, you’ll
+get an error. Consider the invalid code in Listing 8-19.
+
fn main() {
+ let s1 = String::from("hello");
+ let h = s1[0];
+}
+
Listing 8-19: Attempting to use indexing syntax with a
+String
+
This code will result in the following error:
+
$ cargo run
+ Compiling collections v0.1.0 (file:///projects/collections)
+error[E0277]: the type `str` cannot be indexed by `{integer}`
+ --> src/main.rs:3:16
+ |
+3 | let h = s1[0];
+ | ^ string indices are ranges of `usize`
+ |
+ = help: the trait `SliceIndex<str>` is not implemented for `{integer}`, which is required by `String: Index<_>`
+ = note: you can use `.chars().nth()` or `.bytes().nth()`
+ for more information, see chapter 8 in The Book: <https://doc.rust-lang.org/book/ch08-02-strings.html#indexing-into-strings>
+ = help: the trait `SliceIndex<[_]>` is implemented for `usize`
+ = help: for that trait implementation, expected `[_]`, found `str`
+ = note: required for `String` to implement `Index<{integer}>`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `collections` (bin "collections") due to 1 previous error
+
+
The error and the note tell the story: Rust strings don’t support indexing. But
+why not? To answer that question, we need to discuss how Rust stores strings in
+memory.
A String is a wrapper over a Vec<u8>. Let’s look at some of our properly
+encoded UTF-8 example strings from Listing 8-14. First, this one:
+
fn main() {
+ let hello = String::from("السلام عليكم");
+ let hello = String::from("Dobrý den");
+ let hello = String::from("Hello");
+ let hello = String::from("שלום");
+ let hello = String::from("नमस्ते");
+ let hello = String::from("こんにちは");
+ let hello = String::from("안녕하세요");
+ let hello = String::from("你好");
+ let hello = String::from("Olá");
+ let hello = String::from("Здравствуйте");
+ let hello = String::from("Hola");
+}
+
In this case, len will be 4, which means the vector storing the string
+"Hola" is 4 bytes long. Each of these letters takes one byte when encoded in
+UTF-8. The following line, however, may surprise you (note that this string
+begins with the capital Cyrillic letter Ze, not the number 3):
+
fn main() {
+ let hello = String::from("السلام عليكم");
+ let hello = String::from("Dobrý den");
+ let hello = String::from("Hello");
+ let hello = String::from("שלום");
+ let hello = String::from("नमस्ते");
+ let hello = String::from("こんにちは");
+ let hello = String::from("안녕하세요");
+ let hello = String::from("你好");
+ let hello = String::from("Olá");
+ let hello = String::from("Здравствуйте");
+ let hello = String::from("Hola");
+}
+
If you were asked how long the string is, you might say 12. In fact, Rust’s
+answer is 24: that’s the number of bytes it takes to encode “Здравствуйте” in
+UTF-8, because each Unicode scalar value in that string takes 2 bytes of
+storage. Therefore, an index into the string’s bytes will not always correlate
+to a valid Unicode scalar value. To demonstrate, consider this invalid Rust
+code:
+
let hello = "Здравствуйте";
+let answer = &hello[0];
+
You already know that answer will not be З, the first letter. When encoded
+in UTF-8, the first byte of З is 208 and the second is 151, so it would
+seem that answer should in fact be 208, but 208 is not a valid character
+on its own. Returning 208 is likely not what a user would want if they asked
+for the first letter of this string; however, that’s the only data that Rust
+has at byte index 0. Users generally don’t want the byte value returned, even
+if the string contains only Latin letters: if &"hello"[0] were valid code
+that returned the byte value, it would return 104, not h.
+
The answer, then, is that to avoid returning an unexpected value and causing
+bugs that might not be discovered immediately, Rust doesn’t compile this code
+at all and prevents misunderstandings early in the development process.
Another point about UTF-8 is that there are actually three relevant ways to
+look at strings from Rust’s perspective: as bytes, scalar values, and grapheme
+clusters (the closest thing to what we would call letters).
+
If we look at the Hindi word “नमस्ते” written in the Devanagari script, it is
+stored as a vector of u8 values that looks like this:
That’s 18 bytes and is how computers ultimately store this data. If we look at
+them as Unicode scalar values, which are what Rust’s char type is, those
+bytes look like this:
+
['न', 'म', 'स', '्', 'त', 'े']
+
+
There are six char values here, but the fourth and sixth are not letters:
+they’re diacritics that don’t make sense on their own. Finally, if we look at
+them as grapheme clusters, we’d get what a person would call the four letters
+that make up the Hindi word:
+
["न", "म", "स्", "ते"]
+
+
Rust provides different ways of interpreting the raw string data that computers
+store so that each program can choose the interpretation it needs, no matter
+what human language the data is in.
+
A final reason Rust doesn’t allow us to index into a String to get a
+character is that indexing operations are expected to always take constant time
+(O(1)). But it isn’t possible to guarantee that performance with a String,
+because Rust would have to walk through the contents from the beginning to the
+index to determine how many valid characters there were.
Indexing into a string is often a bad idea because it’s not clear what the
+return type of the string-indexing operation should be: a byte value, a
+character, a grapheme cluster, or a string slice. If you really need to use
+indices to create string slices, therefore, Rust asks you to be more specific.
+
Rather than indexing using [] with a single number, you can use [] with a
+range to create a string slice containing particular bytes:
Here, s will be a &str that contains the first four bytes of the string.
+Earlier, we mentioned that each of these characters was two bytes, which means
+s will be Зд.
+
If we were to try to slice only part of a character’s bytes with something like
+&hello[0..1], Rust would panic at runtime in the same way as if an invalid
+index were accessed in a vector:
+
$ cargo run
+ Compiling collections v0.1.0 (file:///projects/collections)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.43s
+ Running `target/debug/collections`
+thread 'main' panicked at src/main.rs:4:19:
+byte index 1 is not a char boundary; it is inside 'З' (bytes 0..2) of `Здравствуйте`
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
You should use caution when creating string slices with ranges, because doing
+so can crash your program.
The best way to operate on pieces of strings is to be explicit about whether
+you want characters or bytes. For individual Unicode scalar values, use the
+chars method. Calling chars on “Зд” separates out and returns two values of
+type char, and you can iterate over the result to access each element:
+
#![allow(unused)]
+fn main() {
+for c in "Зд".chars() {
+ println!("{c}");
+}
+}
+
This code will print the following:
+
З
+д
+
+
Alternatively, the bytes method returns each raw byte, which might be
+appropriate for your domain:
+
#![allow(unused)]
+fn main() {
+for b in "Зд".bytes() {
+ println!("{b}");
+}
+}
+
This code will print the four bytes that make up this string:
+
208
+151
+208
+180
+
+
But be sure to remember that valid Unicode scalar values may be made up of more
+than one byte.
+
Getting grapheme clusters from strings, as with the Devanagari script, is
+complex, so this functionality is not provided by the standard library. Crates
+are available on crates.io if this is the
+functionality you need.
To summarize, strings are complicated. Different programming languages make
+different choices about how to present this complexity to the programmer. Rust
+has chosen to make the correct handling of String data the default behavior
+for all Rust programs, which means programmers have to put more thought into
+handling UTF-8 data up front. This trade-off exposes more of the complexity of
+strings than is apparent in other programming languages, but it prevents you
+from having to handle errors involving non-ASCII characters later in your
+development life cycle.
+
The good news is that the standard library offers a lot of functionality built
+off the String and &str types to help handle these complex situations
+correctly. Be sure to check out the documentation for useful methods like
+contains for searching in a string and replace for substituting parts of a
+string with another string.
+
Let’s switch to something a bit less complex: hash maps!
The last of our common collections is the hash map. The type HashMap<K, V>
+stores a mapping of keys of type K to values of type V using a hashing
+function, which determines how it places these keys and values into memory.
+Many programming languages support this kind of data structure, but they often
+use a different name, such as hash, map, object, hash table,
+dictionary, or associative array, just to name a few.
+
Hash maps are useful when you want to look up data not by using an index, as
+you can with vectors, but by using a key that can be of any type. For example,
+in a game, you could keep track of each team’s score in a hash map in which
+each key is a team’s name and the values are each team’s score. Given a team
+name, you can retrieve its score.
+
We’ll go over the basic API of hash maps in this section, but many more goodies
+are hiding in the functions defined on HashMap<K, V> by the standard library.
+As always, check the standard library documentation for more information.
One way to create an empty hash map is to use new and to add elements with
+insert. In Listing 8-20, we’re keeping track of the scores of two teams whose
+names are Blue and Yellow. The Blue team starts with 10 points, and the
+Yellow team starts with 50.
Listing 8-20: Creating a new hash map and inserting some
+keys and values
+
Note that we need to first use the HashMap from the collections portion of
+the standard library. Of our three common collections, this one is the least
+often used, so it’s not included in the features brought into scope
+automatically in the prelude. Hash maps also have less support from the
+standard library; there’s no built-in macro to construct them, for example.
+
Just like vectors, hash maps store their data on the heap. This HashMap has
+keys of type String and values of type i32. Like vectors, hash maps are
+homogeneous: all of the keys must have the same type, and all of the values
+must have the same type.
We can get a value out of the hash map by providing its key to the get
+method, as shown in Listing 8-21.
+
fn main() {
+ use std::collections::HashMap;
+
+ let mut scores = HashMap::new();
+
+ scores.insert(String::from("Blue"), 10);
+ scores.insert(String::from("Yellow"), 50);
+
+ let team_name = String::from("Blue");
+ let score = scores.get(&team_name).copied().unwrap_or(0);
+}
+
Listing 8-21: Accessing the score for the Blue team
+stored in the hash map
+
Here, score will have the value that’s associated with the Blue team, and the
+result will be 10. The get method returns an Option<&V>; if there’s no
+value for that key in the hash map, get will return None. This program
+handles the Option by calling copied to get an Option<i32> rather than an
+Option<&i32>, then unwrap_or to set score to zero if scores doesn’t
+have an entry for the key.
+
We can iterate over each key–value pair in a hash map in a similar manner as we
+do with vectors, using a for loop:
+
fn main() {
+ use std::collections::HashMap;
+
+ let mut scores = HashMap::new();
+
+ scores.insert(String::from("Blue"), 10);
+ scores.insert(String::from("Yellow"), 50);
+
+ for (key, value) in &scores {
+ println!("{key}: {value}");
+ }
+}
+
This code will print each pair in an arbitrary order:
For types that implement the Copy trait, like i32, the values are copied
+into the hash map. For owned values like String, the values will be moved and
+the hash map will be the owner of those values, as demonstrated in Listing 8-22.
+
fn main() {
+ use std::collections::HashMap;
+
+ let field_name = String::from("Favorite color");
+ let field_value = String::from("Blue");
+
+ let mut map = HashMap::new();
+ map.insert(field_name, field_value);
+ // field_name and field_value are invalid at this point, try using them and
+ // see what compiler error you get!
+}
+
Listing 8-22: Showing that keys and values are owned by
+the hash map once they’re inserted
+
We aren’t able to use the variables field_name and field_value after
+they’ve been moved into the hash map with the call to insert.
+
If we insert references to values into the hash map, the values won’t be moved
+into the hash map. The values that the references point to must be valid for at
+least as long as the hash map is valid. We’ll talk more about these issues in
+the “Validating References with
+Lifetimes” section in
+Chapter 10.
Although the number of key and value pairs is growable, each unique key can
+only have one value associated with it at a time (but not vice versa: for
+example, both the Blue team and the Yellow team could have the value 10
+stored in the scores hash map).
+
When you want to change the data in a hash map, you have to decide how to
+handle the case when a key already has a value assigned. You could replace the
+old value with the new value, completely disregarding the old value. You could
+keep the old value and ignore the new value, only adding the new value if the
+key doesn’t already have a value. Or you could combine the old value and the
+new value. Let’s look at how to do each of these!
If we insert a key and a value into a hash map and then insert that same key
+with a different value, the value associated with that key will be replaced.
+Even though the code in Listing 8-23 calls insert twice, the hash map will
+only contain one key–value pair because we’re inserting the value for the Blue
+team’s key both times.
It’s common to check whether a particular key already exists in the hash map
+with a value and then to take the following actions: if the key does exist in
+the hash map, the existing value should remain the way it is; if the key
+doesn’t exist, insert it and a value for it.
+
Hash maps have a special API for this called entry that takes the key you
+want to check as a parameter. The return value of the entry method is an enum
+called Entry that represents a value that might or might not exist. Let’s say
+we want to check whether the key for the Yellow team has a value associated
+with it. If it doesn’t, we want to insert the value 50, and the same for the
+Blue team. Using the entry API, the code looks like Listing 8-24.
Listing 8-24: Using the entry method to only insert if
+the key does not already have a value
+
The or_insert method on Entry is defined to return a mutable reference to
+the value for the corresponding Entry key if that key exists, and if not, it
+inserts the parameter as the new value for this key and returns a mutable
+reference to the new value. This technique is much cleaner than writing the
+logic ourselves and, in addition, plays more nicely with the borrow checker.
+
Running the code in Listing 8-24 will print {"Yellow": 50, "Blue": 10}. The
+first call to entry will insert the key for the Yellow team with the value
+50 because the Yellow team doesn’t have a value already. The second call to
+entry will not change the hash map because the Blue team already has the
+value 10.
Another common use case for hash maps is to look up a key’s value and then
+update it based on the old value. For instance, Listing 8-25 shows code that
+counts how many times each word appears in some text. We use a hash map with
+the words as keys and increment the value to keep track of how many times we’ve
+seen that word. If it’s the first time we’ve seen a word, we’ll first insert
+the value 0.
+
fn main() {
+ use std::collections::HashMap;
+
+ let text = "hello world wonderful world";
+
+ let mut map = HashMap::new();
+
+ for word in text.split_whitespace() {
+ let count = map.entry(word).or_insert(0);
+ *count += 1;
+ }
+
+ println!("{map:?}");
+}
+
Listing 8-25: Counting occurrences of words using a hash
+map that stores words and counts
+
This code will print {"world": 2, "hello": 1, "wonderful": 1}. You might see
+the same key–value pairs printed in a different order: recall from the
+“Accessing Values in a Hash Map” section that
+iterating over a hash map happens in an arbitrary order.
+
The split_whitespace method returns an iterator over subslices, separated by
+whitespace, of the value in text. The or_insert method returns a mutable
+reference (&mut V) to the value for the specified key. Here, we store that
+mutable reference in the count variable, so in order to assign to that value,
+we must first dereference count using the asterisk (*). The mutable
+reference goes out of scope at the end of the for loop, so all of these
+changes are safe and allowed by the borrowing rules.
By default, HashMap uses a hashing function called SipHash that can provide
+resistance to denial-of-service (DoS) attacks involving hash
+tables1. This is not the fastest hashing algorithm
+available, but the trade-off for better security that comes with the drop in
+performance is worth it. If you profile your code and find that the default
+hash function is too slow for your purposes, you can switch to another function
+by specifying a different hasher. A hasher is a type that implements the
+BuildHasher trait. We’ll talk about traits and how to implement them in
+Chapter 10. You don’t necessarily have to implement
+your own hasher from scratch; crates.io
+has libraries shared by other Rust users that provide hashers implementing many
+common hashing algorithms.
Vectors, strings, and hash maps will provide a large amount of functionality
+necessary in programs when you need to store, access, and modify data. Here are
+some exercises you should now be equipped to solve:
+
+
Given a list of integers, use a vector and return the median (when sorted,
+the value in the middle position) and mode (the value that occurs most
+often; a hash map will be helpful here) of the list.
+
Convert strings to pig latin. The first consonant of each word is moved to
+the end of the word and ay is added, so first becomes irst-fay. Words
+that start with a vowel have hay added to the end instead (apple becomes
+apple-hay). Keep in mind the details about UTF-8 encoding!
+
Using a hash map and vectors, create a text interface to allow a user to add
+employee names to a department in a company; for example, “Add Sally to
+Engineering” or “Add Amir to Sales.” Then let the user retrieve a list of all
+people in a department or all people in the company by department, sorted
+alphabetically.
+
+
The standard library API documentation describes methods that vectors, strings,
+and hash maps have that will be helpful for these exercises!
+
We’re getting into more complex programs in which operations can fail, so it’s
+a perfect time to discuss error handling. We’ll do that next!
Errors are a fact of life in software, so Rust has a number of features for
+handling situations in which something goes wrong. In many cases, Rust requires
+you to acknowledge the possibility of an error and take some action before your
+code will compile. This requirement makes your program more robust by ensuring
+that you’ll discover errors and handle them appropriately before you’ve
+deployed your code to production!
+
Rust groups errors into two major categories: recoverable and unrecoverable
+errors. For a recoverable error, such as a file not found error, we most
+likely just want to report the problem to the user and retry the operation.
+Unrecoverable errors are always symptoms of bugs, such as trying to access a
+location beyond the end of an array, and so we want to immediately stop the
+program.
+
Most languages don’t distinguish between these two kinds of errors and handle
+both in the same way, using mechanisms such as exceptions. Rust doesn’t have
+exceptions. Instead, it has the type Result<T, E> for recoverable errors and
+the panic! macro that stops execution when the program encounters an
+unrecoverable error. This chapter covers calling panic! first and then talks
+about returning Result<T, E> values. Additionally, we’ll explore
+considerations when deciding whether to try to recover from an error or to stop
+execution.
Sometimes bad things happen in your code, and there’s nothing you can do about
+it. In these cases, Rust has the panic! macro. There are two ways to cause a
+panic in practice: by taking an action that causes our code to panic (such as
+accessing an array past the end) or by explicitly calling the panic! macro.
+In both cases, we cause a panic in our program. By default, these panics will
+print a failure message, unwind, clean up the stack, and quit. Via an
+environment variable, you can also have Rust display the call stack when a
+panic occurs to make it easier to track down the source of the panic.
By default, when a panic occurs the program starts unwinding, which means
+Rust walks back up the stack and cleans up the data from each function it
+encounters. However, walking back and cleaning up is a lot of work. Rust,
+therefore, allows you to choose the alternative of immediately aborting,
+which ends the program without cleaning up.
+
Memory that the program was using will then need to be cleaned up by the
+operating system. If in your project you need to make the resultant binary as
+small as possible, you can switch from unwinding to aborting upon a panic by
+adding panic = 'abort' to the appropriate [profile] sections in your
+Cargo.toml file. For example, if you want to abort on panic in release mode,
+add this:
+
[profile.release]
+panic = 'abort'
+
+
+
Let’s try calling panic! in a simple program:
+
Filename: src/main.rs
+
fn main() {
+ panic!("crash and burn");
+}
+
When you run the program, you’ll see something like this:
+
$ cargo run
+ Compiling panic v0.1.0 (file:///projects/panic)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.25s
+ Running `target/debug/panic`
+thread 'main' panicked at src/main.rs:2:5:
+crash and burn
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
The call to panic! causes the error message contained in the last two lines.
+The first line shows our panic message and the place in our source code where
+the panic occurred: src/main.rs:2:5 indicates that it’s the second line,
+fifth character of our src/main.rs file.
+
In this case, the line indicated is part of our code, and if we go to that
+line, we see the panic! macro call. In other cases, the panic! call might
+be in code that our code calls, and the filename and line number reported by
+the error message will be someone else’s code where the panic! macro is
+called, not the line of our code that eventually led to the panic! call.
+
+
+
We can use the backtrace of the functions the panic! call came from to figure
+out the part of our code that is causing the problem. To understand how to use
+a panic! backtrace, let’s look at another example and see what it’s like when
+a panic! call comes from a library because of a bug in our code instead of
+from our code calling the macro directly. Listing 9-1 has some code that
+attempts to access an index in a vector beyond the range of valid indexes.
+
Filename: src/main.rs
+
fn main() {
+ let v = vec![1, 2, 3];
+
+ v[99];
+}
+
Listing 9-1: Attempting to access an element beyond the
+end of a vector, which will cause a call to panic!
+
Here, we’re attempting to access the 100th element of our vector (which is at
+index 99 because indexing starts at zero), but the vector has only three
+elements. In this situation, Rust will panic. Using [] is supposed to return
+an element, but if you pass an invalid index, there’s no element that Rust
+could return here that would be correct.
+
In C, attempting to read beyond the end of a data structure is undefined
+behavior. You might get whatever is at the location in memory that would
+correspond to that element in the data structure, even though the memory
+doesn’t belong to that structure. This is called a buffer overread and can
+lead to security vulnerabilities if an attacker is able to manipulate the index
+in such a way as to read data they shouldn’t be allowed to that is stored after
+the data structure.
+
To protect your program from this sort of vulnerability, if you try to read an
+element at an index that doesn’t exist, Rust will stop execution and refuse to
+continue. Let’s try it and see:
+
$ cargo run
+ Compiling panic v0.1.0 (file:///projects/panic)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
+ Running `target/debug/panic`
+thread 'main' panicked at src/main.rs:4:6:
+index out of bounds: the len is 3 but the index is 99
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
This error points at line 4 of our main.rs where we attempt to access index
+99 of the vector in v.
+
The note: line tells us that we can set the RUST_BACKTRACE environment
+variable to get a backtrace of exactly what happened to cause the error. A
+backtrace is a list of all the functions that have been called to get to this
+point. Backtraces in Rust work as they do in other languages: the key to
+reading the backtrace is to start from the top and read until you see files you
+wrote. That’s the spot where the problem originated. The lines above that spot
+are code that your code has called; the lines below are code that called your
+code. These before-and-after lines might include core Rust code, standard
+library code, or crates that you’re using. Let’s try getting a backtrace by
+setting the RUST_BACKTRACE environment variable to any value except 0.
+Listing 9-2 shows output similar to what you’ll see.
+
+
$ RUST_BACKTRACE=1 cargo run
+thread 'main' panicked at src/main.rs:4:6:
+index out of bounds: the len is 3 but the index is 99
+stack backtrace:
+ 0: rust_begin_unwind
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/std/src/panicking.rs:645:5
+ 1: core::panicking::panic_fmt
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/panicking.rs:72:14
+ 2: core::panicking::panic_bounds_check
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/panicking.rs:208:5
+ 3: <usize as core::slice::index::SliceIndex<[T]>>::index
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/slice/index.rs:255:10
+ 4: core::slice::index::<impl core::ops::index::Index<I> for [T]>::index
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/slice/index.rs:18:9
+ 5: <alloc::vec::Vec<T,A> as core::ops::index::Index<I>>::index
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/alloc/src/vec/mod.rs:2770:9
+ 6: panic::main
+ at ./src/main.rs:4:6
+ 7: core::ops::function::FnOnce::call_once
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/ops/function.rs:250:5
+note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
+
+
Listing 9-2: The backtrace generated by a call to
+panic! displayed when the environment variable RUST_BACKTRACE is set
+
That’s a lot of output! The exact output you see might be different depending
+on your operating system and Rust version. In order to get backtraces with this
+information, debug symbols must be enabled. Debug symbols are enabled by
+default when using cargo build or cargo run without the --release flag,
+as we have here.
+
In the output in Listing 9-2, line 6 of the backtrace points to the line in our
+project that’s causing the problem: line 4 of src/main.rs. If we don’t want
+our program to panic, we should start our investigation at the location pointed
+to by the first line mentioning a file we wrote. In Listing 9-1, where we
+deliberately wrote code that would panic, the way to fix the panic is to not
+request an element beyond the range of the vector indexes. When your code
+panics in the future, you’ll need to figure out what action the code is taking
+with what values to cause the panic and what the code should do instead.
+
We’ll come back to panic! and when we should and should not use panic! to
+handle error conditions in the “To panic! or Not to
+panic!” section later in this
+chapter. Next, we’ll look at how to recover from an error using Result.
Most errors aren’t serious enough to require the program to stop entirely.
+Sometimes when a function fails it’s for a reason that you can easily interpret
+and respond to. For example, if you try to open a file and that operation fails
+because the file doesn’t exist, you might want to create the file instead of
+terminating the process.
The T and E are generic type parameters: we’ll discuss generics in more
+detail in Chapter 10. What you need to know right now is that T represents
+the type of the value that will be returned in a success case within the Ok
+variant, and E represents the type of the error that will be returned in a
+failure case within the Err variant. Because Result has these generic type
+parameters, we can use the Result type and the functions defined on it in
+many different situations where the success value and error value we want to
+return may differ.
+
Let’s call a function that returns a Result value because the function could
+fail. In Listing 9-3 we try to open a file.
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file_result = File::open("hello.txt");
+}
+
Listing 9-3: Opening a file
+
The return type of File::open is a Result<T, E>. The generic parameter T
+has been filled in by the implementation of File::open with the type of the
+success value, std::fs::File, which is a file handle. The type of E used in
+the error value is std::io::Error. This return type means the call to
+File::open might succeed and return a file handle that we can read from or
+write to. The function call also might fail: for example, the file might not
+exist, or we might not have permission to access the file. The File::open
+function needs to have a way to tell us whether it succeeded or failed and at
+the same time give us either the file handle or error information. This
+information is exactly what the Result enum conveys.
+
In the case where File::open succeeds, the value in the variable
+greeting_file_result will be an instance of Ok that contains a file handle.
+In the case where it fails, the value in greeting_file_result will be an
+instance of Err that contains more information about the kind of error that
+occurred.
+
We need to add to the code in Listing 9-3 to take different actions depending
+on the value File::open returns. Listing 9-4 shows one way to handle the
+Result using a basic tool, the match expression that we discussed in
+Chapter 6.
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file_result = File::open("hello.txt");
+
+ let greeting_file = match greeting_file_result {
+ Ok(file) => file,
+ Err(error) => panic!("Problem opening the file: {error:?}"),
+ };
+}
+
Listing 9-4: Using a match expression to handle the
+Result variants that might be returned
+
Note that, like the Option enum, the Result enum and its variants have been
+brought into scope by the prelude, so we don’t need to specify Result::
+before the Ok and Err variants in the match arms.
+
When the result is Ok, this code will return the inner file value out of
+the Ok variant, and we then assign that file handle value to the variable
+greeting_file. After the match, we can use the file handle for reading or
+writing.
+
The other arm of the match handles the case where we get an Err value from
+File::open. In this example, we’ve chosen to call the panic! macro. If
+there’s no file named hello.txt in our current directory and we run this
+code, we’ll see the following output from the panic! macro:
+
$ cargo run
+ Compiling error-handling v0.1.0 (file:///projects/error-handling)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.73s
+ Running `target/debug/error-handling`
+thread 'main' panicked at src/main.rs:8:23:
+Problem opening the file: Os { code: 2, kind: NotFound, message: "No such file or directory" }
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
As usual, this output tells us exactly what has gone wrong.
The code in Listing 9-4 will panic! no matter why File::open failed.
+However, we want to take different actions for different failure reasons. If
+File::open failed because the file doesn’t exist, we want to create the file
+and return the handle to the new file. If File::open failed for any other
+reason—for example, because we didn’t have permission to open the file—we still
+want the code to panic! in the same way it did in Listing 9-4. For this, we
+add an inner match expression, shown in Listing 9-5.
+
Filename: src/main.rs
+
+
use std::fs::File;
+use std::io::ErrorKind;
+
+fn main() {
+ let greeting_file_result = File::open("hello.txt");
+
+ let greeting_file = match greeting_file_result {
+ Ok(file) => file,
+ Err(error) => match error.kind() {
+ ErrorKind::NotFound => match File::create("hello.txt") {
+ Ok(fc) => fc,
+ Err(e) => panic!("Problem creating the file: {e:?}"),
+ },
+ other_error => {
+ panic!("Problem opening the file: {other_error:?}");
+ }
+ },
+ };
+}
+
Listing 9-5: Handling different kinds of errors in
+different ways
+
The type of the value that File::open returns inside the Err variant is
+io::Error, which is a struct provided by the standard library. This struct
+has a method kind that we can call to get an io::ErrorKind value. The enum
+io::ErrorKind is provided by the standard library and has variants
+representing the different kinds of errors that might result from an io
+operation. The variant we want to use is ErrorKind::NotFound, which indicates
+the file we’re trying to open doesn’t exist yet. So we match on
+greeting_file_result, but we also have an inner match on error.kind().
+
The condition we want to check in the inner match is whether the value returned
+by error.kind() is the NotFound variant of the ErrorKind enum. If it is,
+we try to create the file with File::create. However, because File::create
+could also fail, we need a second arm in the inner match expression. When the
+file can’t be created, a different error message is printed. The second arm of
+the outer match stays the same, so the program panics on any error besides
+the missing file error.
That’s a lot of match! The match expression is very useful but also very
+much a primitive. In Chapter 13, you’ll learn about closures, which are used
+with many of the methods defined on Result<T, E>. These methods can be more
+concise than using match when handling Result<T, E> values in your code.
+
For example, here’s another way to write the same logic as shown in Listing
+9-5, this time using closures and the unwrap_or_else method:
+
+
use std::fs::File;
+use std::io::ErrorKind;
+
+fn main() {
+ let greeting_file = File::open("hello.txt").unwrap_or_else(|error| {
+ if error.kind() == ErrorKind::NotFound {
+ File::create("hello.txt").unwrap_or_else(|error| {
+ panic!("Problem creating the file: {error:?}");
+ })
+ } else {
+ panic!("Problem opening the file: {error:?}");
+ }
+ });
+}
+
Although this code has the same behavior as Listing 9-5, it doesn’t contain
+any match expressions and is cleaner to read. Come back to this example
+after you’ve read Chapter 13, and look up the unwrap_or_else method in the
+standard library documentation. Many more of these methods can clean up huge
+nested match expressions when you’re dealing with errors.
Using match works well enough, but it can be a bit verbose and doesn’t always
+communicate intent well. The Result<T, E> type has many helper methods
+defined on it to do various, more specific tasks. The unwrap method is a
+shortcut method implemented just like the match expression we wrote in
+Listing 9-4. If the Result value is the Ok variant, unwrap will return
+the value inside the Ok. If the Result is the Err variant, unwrap will
+call the panic! macro for us. Here is an example of unwrap in action:
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file = File::open("hello.txt").unwrap();
+}
+
If we run this code without a hello.txt file, we’ll see an error message from
+the panic! call that the unwrap method makes:
+
+
thread 'main' panicked at src/main.rs:4:49:
+called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }
+
+
Similarly, the expect method lets us also choose the panic! error message.
+Using expect instead of unwrap and providing good error messages can convey
+your intent and make tracking down the source of a panic easier. The syntax of
+expect looks like this:
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file = File::open("hello.txt")
+ .expect("hello.txt should be included in this project");
+}
+
We use expect in the same way as unwrap: to return the file handle or call
+the panic! macro. The error message used by expect in its call to panic!
+will be the parameter that we pass to expect, rather than the default
+panic! message that unwrap uses. Here’s what it looks like:
+
+
thread 'main' panicked at src/main.rs:5:10:
+hello.txt should be included in this project: Os { code: 2, kind: NotFound, message: "No such file or directory" }
+
+
In production-quality code, most Rustaceans choose expect rather than
+unwrap and give more context about why the operation is expected to always
+succeed. That way, if your assumptions are ever proven wrong, you have more
+information to use in debugging.
When a function’s implementation calls something that might fail, instead of
+handling the error within the function itself you can return the error to the
+calling code so that it can decide what to do. This is known as propagating
+the error and gives more control to the calling code, where there might be more
+information or logic that dictates how the error should be handled than what
+you have available in the context of your code.
+
For example, Listing 9-6 shows a function that reads a username from a file. If
+the file doesn’t exist or can’t be read, this function will return those errors
+to the code that called the function.
Listing 9-6: A function that returns errors to the
+calling code using match
+
This function can be written in a much shorter way, but we’re going to start by
+doing a lot of it manually in order to explore error handling; at the end,
+we’ll show the shorter way. Let’s look at the return type of the function
+first: Result<String, io::Error>. This means the function is returning a
+value of the type Result<T, E>, where the generic parameter T has been
+filled in with the concrete type String and the generic type E has been
+filled in with the concrete type io::Error.
+
If this function succeeds without any problems, the code that calls this
+function will receive an Ok value that holds a String—the username that
+this function read from the file. If this function encounters any problems, the
+calling code will receive an Err value that holds an instance of io::Error
+that contains more information about what the problems were. We chose
+io::Error as the return type of this function because that happens to be the
+type of the error value returned from both of the operations we’re calling in
+this function’s body that might fail: the File::open function and the
+read_to_string method.
+
The body of the function starts by calling the File::open function. Then we
+handle the Result value with a match similar to the match in Listing 9-4.
+If File::open succeeds, the file handle in the pattern variable file
+becomes the value in the mutable variable username_file and the function
+continues. In the Err case, instead of calling panic!, we use the return
+keyword to return early out of the function entirely and pass the error value
+from File::open, now in the pattern variable e, back to the calling code as
+this function’s error value.
+
So, if we have a file handle in username_file, the function then creates a
+new String in variable username and calls the read_to_string method on
+the file handle in username_file to read the contents of the file into
+username. The read_to_string method also returns a Result because it
+might fail, even though File::open succeeded. So we need another match to
+handle that Result: if read_to_string succeeds, then our function has
+succeeded, and we return the username from the file that’s now in username
+wrapped in an Ok. If read_to_string fails, we return the error value in the
+same way that we returned the error value in the match that handled the
+return value of File::open. However, we don’t need to explicitly say
+return, because this is the last expression in the function.
+
The code that calls this code will then handle getting either an Ok value
+that contains a username or an Err value that contains an io::Error. It’s
+up to the calling code to decide what to do with those values. If the calling
+code gets an Err value, it could call panic! and crash the program, use a
+default username, or look up the username from somewhere other than a file, for
+example. We don’t have enough information on what the calling code is actually
+trying to do, so we propagate all the success or error information upward for
+it to handle appropriately.
+
This pattern of propagating errors is so common in Rust that Rust provides the
+question mark operator ? to make this easier.
Listing 9-7 shows an implementation of read_username_from_file that has the
+same functionality as in Listing 9-6, but this implementation uses the ?
+operator.
Listing 9-7: A function that returns errors to the
+calling code using the ? operator
+
The ? placed after a Result value is defined to work in almost the same way
+as the match expressions we defined to handle the Result values in Listing
+9-6. If the value of the Result is an Ok, the value inside the Ok will
+get returned from this expression, and the program will continue. If the value
+is an Err, the Err will be returned from the whole function as if we had
+used the return keyword so the error value gets propagated to the calling
+code.
+
There is a difference between what the match expression from Listing 9-6 does
+and what the ? operator does: error values that have the ? operator called
+on them go through the from function, defined in the From trait in the
+standard library, which is used to convert values from one type into another.
+When the ? operator calls the from function, the error type received is
+converted into the error type defined in the return type of the current
+function. This is useful when a function returns one error type to represent
+all the ways a function might fail, even if parts might fail for many different
+reasons.
+
For example, we could change the read_username_from_file function in Listing
+9-7 to return a custom error type named OurError that we define. If we also
+define impl From<io::Error> for OurError to construct an instance of
+OurError from an io::Error, then the ? operator calls in the body of
+read_username_from_file will call from and convert the error types without
+needing to add any more code to the function.
+
In the context of Listing 9-7, the ? at the end of the File::open call will
+return the value inside an Ok to the variable username_file. If an error
+occurs, the ? operator will return early out of the whole function and give
+any Err value to the calling code. The same thing applies to the ? at the
+end of the read_to_string call.
+
The ? operator eliminates a lot of boilerplate and makes this function’s
+implementation simpler. We could even shorten this code further by chaining
+method calls immediately after the ?, as shown in Listing 9-8.
Listing 9-8: Chaining method calls after the ?
+operator
+
We’ve moved the creation of the new String in username to the beginning of
+the function; that part hasn’t changed. Instead of creating a variable
+username_file, we’ve chained the call to read_to_string directly onto the
+result of File::open("hello.txt")?. We still have a ? at the end of the
+read_to_string call, and we still return an Ok value containing username
+when both File::open and read_to_string succeed rather than returning
+errors. The functionality is again the same as in Listing 9-6 and Listing 9-7;
+this is just a different, more ergonomic way to write it.
+
Listing 9-9 shows a way to make this even shorter using fs::read_to_string.
Listing 9-9: Using fs::read_to_string instead of
+opening and then reading the file
+
Reading a file into a string is a fairly common operation, so the standard
+library provides the convenient fs::read_to_string function that opens the
+file, creates a new String, reads the contents of the file, puts the contents
+into that String, and returns it. Of course, using fs::read_to_string
+doesn’t give us the opportunity to explain all the error handling, so we did it
+the longer way first.
The ? operator can only be used in functions whose return type is compatible
+with the value the ? is used on. This is because the ? operator is defined
+to perform an early return of a value out of the function, in the same manner
+as the match expression we defined in Listing 9-6. In Listing 9-6, the
+match was using a Result value, and the early return arm returned an
+Err(e) value. The return type of the function has to be a Result so that
+it’s compatible with this return.
+
In Listing 9-10, let’s look at the error we’ll get if we use the ? operator
+in a main function with a return type that is incompatible with the type of
+the value we use ? on.
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file = File::open("hello.txt")?;
+}
+
Listing 9-10: Attempting to use the ? in the main
+function that returns () won’t compile.
+
This code opens a file, which might fail. The ? operator follows the Result
+value returned by File::open, but this main function has the return type of
+(), not Result. When we compile this code, we get the following error
+message:
+
$ cargo run
+ Compiling error-handling v0.1.0 (file:///projects/error-handling)
+error[E0277]: the `?` operator can only be used in a function that returns `Result` or `Option` (or another type that implements `FromResidual`)
+ --> src/main.rs:4:48
+ |
+3 | fn main() {
+ | --------- this function should return `Result` or `Option` to accept `?`
+4 | let greeting_file = File::open("hello.txt")?;
+ | ^ cannot use the `?` operator in a function that returns `()`
+ |
+ = help: the trait `FromResidual<Result<Infallible, std::io::Error>>` is not implemented for `()`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `error-handling` (bin "error-handling") due to 1 previous error
+
+
This error points out that we’re only allowed to use the ? operator in a
+function that returns Result, Option, or another type that implements
+FromResidual.
+
To fix the error, you have two choices. One choice is to change the return type
+of your function to be compatible with the value you’re using the ? operator
+on as long as you have no restrictions preventing that. The other choice is to
+use a match or one of the Result<T, E> methods to handle the Result<T, E>
+in whatever way is appropriate.
+
The error message also mentioned that ? can be used with Option<T> values
+as well. As with using ? on Result, you can only use ? on Option in a
+function that returns an Option. The behavior of the ? operator when called
+on an Option<T> is similar to its behavior when called on a Result<T, E>:
+if the value is None, the None will be returned early from the function at
+that point. If the value is Some, the value inside the Some is the
+resultant value of the expression, and the function continues. Listing 9-11 has
+an example of a function that finds the last character of the first line in the
+given text.
Listing 9-11: Using the ? operator on an Option<T>
+value
+
This function returns Option<char> because it’s possible that there is a
+character there, but it’s also possible that there isn’t. This code takes the
+text string slice argument and calls the lines method on it, which returns
+an iterator over the lines in the string. Because this function wants to
+examine the first line, it calls next on the iterator to get the first value
+from the iterator. If text is the empty string, this call to next will
+return None, in which case we use ? to stop and return None from
+last_char_of_first_line. If text is not the empty string, next will
+return a Some value containing a string slice of the first line in text.
+
The ? extracts the string slice, and we can call chars on that string slice
+to get an iterator of its characters. We’re interested in the last character in
+this first line, so we call last to return the last item in the iterator.
+This is an Option because it’s possible that the first line is the empty
+string; for example, if text starts with a blank line but has characters on
+other lines, as in "\nhi". However, if there is a last character on the first
+line, it will be returned in the Some variant. The ? operator in the middle
+gives us a concise way to express this logic, allowing us to implement the
+function in one line. If we couldn’t use the ? operator on Option, we’d
+have to implement this logic using more method calls or a match expression.
+
Note that you can use the ? operator on a Result in a function that returns
+Result, and you can use the ? operator on an Option in a function that
+returns Option, but you can’t mix and match. The ? operator won’t
+automatically convert a Result to an Option or vice versa; in those cases,
+you can use methods like the ok method on Result or the ok_or method on
+Option to do the conversion explicitly.
+
So far, all the main functions we’ve used return (). The main function is
+special because it’s the entry point and exit point of an executable program,
+and there are restrictions on what its return type can be for the program to
+behave as expected.
+
Luckily, main can also return a Result<(), E>. Listing 9-12 has the code
+from Listing 9-10, but we’ve changed the return type of main to be
+Result<(), Box<dyn Error>> and added a return value Ok(()) to the end. This
+code will now compile.
Listing 9-12: Changing main to return Result<(), E>
+allows the use of the ? operator on Result values.
+
The Box<dyn Error> type is a trait object, which we’ll talk about in the
+“Using Trait Objects that Allow for Values of Different
+Types” section in Chapter 17. For now, you can
+read Box<dyn Error> to mean “any kind of error.” Using ? on a Result
+value in a main function with the error type Box<dyn Error> is allowed
+because it allows any Err value to be returned early. Even though the body of
+this main function will only ever return errors of type std::io::Error, by
+specifying Box<dyn Error>, this signature will continue to be correct even if
+more code that returns other errors is added to the body of main.
+
When a main function returns a Result<(), E>, the executable will exit with
+a value of 0 if main returns Ok(()) and will exit with a nonzero value if
+main returns an Err value. Executables written in C return integers when
+they exit: programs that exit successfully return the integer 0, and programs
+that error return some integer other than 0. Rust also returns integers from
+executables to be compatible with this convention.
+
The main function may return any types that implement the
+std::process::Termination trait, which contains
+a function report that returns an ExitCode. Consult the standard library
+documentation for more information on implementing the Termination trait for
+your own types.
+
Now that we’ve discussed the details of calling panic! or returning Result,
+let’s return to the topic of how to decide which is appropriate to use in which
+cases.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch09-03-to-panic-or-not-to-panic.html b/ch09-03-to-panic-or-not-to-panic.html
new file mode 100644
index 0000000000..45edab2f5c
--- /dev/null
+++ b/ch09-03-to-panic-or-not-to-panic.html
@@ -0,0 +1,481 @@
+
+
+
+
+
+ To panic! or Not to panic! - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
So how do you decide when you should call panic! and when you should return
+Result? When code panics, there’s no way to recover. You could call panic!
+for any error situation, whether there’s a possible way to recover or not, but
+then you’re making the decision that a situation is unrecoverable on behalf of
+the calling code. When you choose to return a Result value, you give the
+calling code options. The calling code could choose to attempt to recover in a
+way that’s appropriate for its situation, or it could decide that an Err
+value in this case is unrecoverable, so it can call panic! and turn your
+recoverable error into an unrecoverable one. Therefore, returning Result is a
+good default choice when you’re defining a function that might fail.
+
In situations such as examples, prototype code, and tests, it’s more
+appropriate to write code that panics instead of returning a Result. Let’s
+explore why, then discuss situations in which the compiler can’t tell that
+failure is impossible, but you as a human can. The chapter will conclude with
+some general guidelines on how to decide whether to panic in library code.
When you’re writing an example to illustrate some concept, also including
+robust error-handling code can make the example less clear. In examples, it’s
+understood that a call to a method like unwrap that could panic is meant as a
+placeholder for the way you’d want your application to handle errors, which can
+differ based on what the rest of your code is doing.
+
Similarly, the unwrap and expect methods are very handy when prototyping,
+before you’re ready to decide how to handle errors. They leave clear markers in
+your code for when you’re ready to make your program more robust.
+
If a method call fails in a test, you’d want the whole test to fail, even if
+that method isn’t the functionality under test. Because panic! is how a test
+is marked as a failure, calling unwrap or expect is exactly what should
+happen.
It would also be appropriate to call unwrap or expect when you have some
+other logic that ensures the Result will have an Ok value, but the logic
+isn’t something the compiler understands. You’ll still have a Result value
+that you need to handle: whatever operation you’re calling still has the
+possibility of failing in general, even though it’s logically impossible in
+your particular situation. If you can ensure by manually inspecting the code
+that you’ll never have an Err variant, it’s perfectly acceptable to call
+unwrap, and even better to document the reason you think you’ll never have an
+Err variant in the expect text. Here’s an example:
+
fn main() {
+ use std::net::IpAddr;
+
+ let home: IpAddr = "127.0.0.1"
+ .parse()
+ .expect("Hardcoded IP address should be valid");
+}
+
We’re creating an IpAddr instance by parsing a hardcoded string. We can see
+that 127.0.0.1 is a valid IP address, so it’s acceptable to use expect
+here. However, having a hardcoded, valid string doesn’t change the return type
+of the parse method: we still get a Result value, and the compiler will
+still make us handle the Result as if the Err variant is a possibility
+because the compiler isn’t smart enough to see that this string is always a
+valid IP address. If the IP address string came from a user rather than being
+hardcoded into the program and therefore did have a possibility of failure,
+we’d definitely want to handle the Result in a more robust way instead.
+Mentioning the assumption that this IP address is hardcoded will prompt us to
+change expect to better error-handling code if, in the future, we need to get
+the IP address from some other source instead.
It’s advisable to have your code panic when it’s possible that your code could
+end up in a bad state. In this context, a bad state is when some assumption,
+guarantee, contract, or invariant has been broken, such as when invalid values,
+contradictory values, or missing values are passed to your code—plus one or
+more of the following:
+
+
The bad state is something that is unexpected, as opposed to something that
+will likely happen occasionally, like a user entering data in the wrong
+format.
+
Your code after this point needs to rely on not being in this bad state,
+rather than checking for the problem at every step.
+
There’s not a good way to encode this information in the types you use. We’ll
+work through an example of what we mean in the “Encoding States and Behavior
+as Types” section of Chapter 17.
+
+
If someone calls your code and passes in values that don’t make sense, it’s
+best to return an error if you can so the user of the library can decide what
+they want to do in that case. However, in cases where continuing could be
+insecure or harmful, the best choice might be to call panic! and alert the
+person using your library to the bug in their code so they can fix it during
+development. Similarly, panic! is often appropriate if you’re calling
+external code that is out of your control and it returns an invalid state that
+you have no way of fixing.
+
However, when failure is expected, it’s more appropriate to return a Result
+than to make a panic! call. Examples include a parser being given malformed
+data or an HTTP request returning a status that indicates you have hit a rate
+limit. In these cases, returning a Result indicates that failure is an
+expected possibility that the calling code must decide how to handle.
+
When your code performs an operation that could put a user at risk if it’s
+called using invalid values, your code should verify the values are valid first
+and panic if the values aren’t valid. This is mostly for safety reasons:
+attempting to operate on invalid data can expose your code to vulnerabilities.
+This is the main reason the standard library will call panic! if you attempt
+an out-of-bounds memory access: trying to access memory that doesn’t belong to
+the current data structure is a common security problem. Functions often have
+contracts: their behavior is only guaranteed if the inputs meet particular
+requirements. Panicking when the contract is violated makes sense because a
+contract violation always indicates a caller-side bug, and it’s not a kind of
+error you want the calling code to have to explicitly handle. In fact, there’s
+no reasonable way for calling code to recover; the calling programmers need
+to fix the code. Contracts for a function, especially when a violation will
+cause a panic, should be explained in the API documentation for the function.
+
However, having lots of error checks in all of your functions would be verbose
+and annoying. Fortunately, you can use Rust’s type system (and thus the type
+checking done by the compiler) to do many of the checks for you. If your
+function has a particular type as a parameter, you can proceed with your code’s
+logic knowing that the compiler has already ensured you have a valid value. For
+example, if you have a type rather than an Option, your program expects to
+have something rather than nothing. Your code then doesn’t have to handle
+two cases for the Some and None variants: it will only have one case for
+definitely having a value. Code trying to pass nothing to your function won’t
+even compile, so your function doesn’t have to check for that case at runtime.
+Another example is using an unsigned integer type such as u32, which ensures
+the parameter is never negative.
Let’s take the idea of using Rust’s type system to ensure we have a valid value
+one step further and look at creating a custom type for validation. Recall the
+guessing game in Chapter 2 in which our code asked the user to guess a number
+between 1 and 100. We never validated that the user’s guess was between those
+numbers before checking it against our secret number; we only validated that
+the guess was positive. In this case, the consequences were not very dire: our
+output of “Too high” or “Too low” would still be correct. But it would be a
+useful enhancement to guide the user toward valid guesses and have different
+behavior when the user guesses a number that’s out of range versus when the
+user types, for example, letters instead.
+
One way to do this would be to parse the guess as an i32 instead of only a
+u32 to allow potentially negative numbers, and then add a check for the
+number being in range, like so:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ loop {
+ // --snip--
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: i32 = match guess.trim().parse() {
+ Ok(num) => num,
+ Err(_) => continue,
+ };
+
+ if guess < 1 || guess > 100 {
+ println!("The secret number will be between 1 and 100.");
+ continue;
+ }
+
+ match guess.cmp(&secret_number) {
+ // --snip--
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => {
+ println!("You win!");
+ break;
+ }
+ }
+ }
+}
+
The if expression checks whether our value is out of range, tells the user
+about the problem, and calls continue to start the next iteration of the loop
+and ask for another guess. After the if expression, we can proceed with the
+comparisons between guess and the secret number knowing that guess is
+between 1 and 100.
+
However, this is not an ideal solution: if it were absolutely critical that the
+program only operated on values between 1 and 100, and it had many functions
+with this requirement, having a check like this in every function would be
+tedious (and might impact performance).
+
Instead, we can make a new type and put the validations in a function to create
+an instance of the type rather than repeating the validations everywhere. That
+way, it’s safe for functions to use the new type in their signatures and
+confidently use the values they receive. Listing 9-13 shows one way to define a
+Guess type that will only create an instance of Guess if the new function
+receives a value between 1 and 100.
+
Filename: src/lib.rs
+
#![allow(unused)]
+fn main() {
+pub struct Guess {
+ value: i32,
+}
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 || value > 100 {
+ panic!("Guess value must be between 1 and 100, got {value}.");
+ }
+
+ Guess { value }
+ }
+
+ pub fn value(&self) -> i32 {
+ self.value
+ }
+}
+}
+
Listing 9-13: A Guess type that will only continue with
+values between 1 and 100
+
First we define a struct named Guess that has a field named value that
+holds an i32. This is where the number will be stored.
+
Then we implement an associated function named new on Guess that creates
+instances of Guess values. The new function is defined to have one
+parameter named value of type i32 and to return a Guess. The code in the
+body of the new function tests value to make sure it’s between 1 and 100.
+If value doesn’t pass this test, we make a panic! call, which will alert
+the programmer who is writing the calling code that they have a bug they need
+to fix, because creating a Guess with a value outside this range would
+violate the contract that Guess::new is relying on. The conditions in which
+Guess::new might panic should be discussed in its public-facing API
+documentation; we’ll cover documentation conventions indicating the possibility
+of a panic! in the API documentation that you create in Chapter 14. If
+value does pass the test, we create a new Guess with its value field set
+to the value parameter and return the Guess.
+
Next, we implement a method named value that borrows self, doesn’t have any
+other parameters, and returns an i32. This kind of method is sometimes called
+a getter because its purpose is to get some data from its fields and return
+it. This public method is necessary because the value field of the Guess
+struct is private. It’s important that the value field be private so code
+using the Guess struct is not allowed to set value directly: code outside
+the module must use the Guess::new function to create an instance of
+Guess, thereby ensuring there’s no way for a Guess to have a value that
+hasn’t been checked by the conditions in the Guess::new function.
+
A function that has a parameter or returns only numbers between 1 and 100 could
+then declare in its signature that it takes or returns a Guess rather than an
+i32 and wouldn’t need to do any additional checks in its body.
Rust’s error-handling features are designed to help you write more robust code.
+The panic! macro signals that your program is in a state it can’t handle and
+lets you tell the process to stop instead of trying to proceed with invalid or
+incorrect values. The Result enum uses Rust’s type system to indicate that
+operations might fail in a way that your code could recover from. You can use
+Result to tell code that calls your code that it needs to handle potential
+success or failure as well. Using panic! and Result in the appropriate
+situations will make your code more reliable in the face of inevitable problems.
+
Now that you’ve seen useful ways that the standard library uses generics with
+the Option and Result enums, we’ll talk about how generics work and how you
+can use them in your code.
Every programming language has tools for effectively handling the duplication
+of concepts. In Rust, one such tool is generics: abstract stand-ins for
+concrete types or other properties. We can express the behavior of generics or
+how they relate to other generics without knowing what will be in their place
+when compiling and running the code.
+
Functions can take parameters of some generic type, instead of a concrete type
+like i32 or String, in the same way they take parameters with unknown
+values to run the same code on multiple concrete values. In fact, we’ve already
+used generics in Chapter 6 with Option<T>, in Chapter 8 with Vec<T> and
+HashMap<K, V>, and in Chapter 9 with Result<T, E>. In this chapter, you’ll
+explore how to define your own types, functions, and methods with generics!
+
First we’ll review how to extract a function to reduce code duplication. We’ll
+then use the same technique to make a generic function from two functions that
+differ only in the types of their parameters. We’ll also explain how to use
+generic types in struct and enum definitions.
+
Then you’ll learn how to use traits to define behavior in a generic way. You
+can combine traits with generic types to constrain a generic type to accept
+only those types that have a particular behavior, as opposed to just any type.
+
Finally, we’ll discuss lifetimes: a variety of generics that give the
+compiler information about how references relate to each other. Lifetimes allow
+us to give the compiler enough information about borrowed values so that it can
+ensure references will be valid in more situations than it could without our
+help.
Generics allow us to replace specific types with a placeholder that represents
+multiple types to remove code duplication. Before diving into generics syntax,
+let’s first look at how to remove duplication in a way that doesn’t involve
+generic types by extracting a function that replaces specific values with a
+placeholder that represents multiple values. Then we’ll apply the same
+technique to extract a generic function! By looking at how to recognize
+duplicated code you can extract into a function, you’ll start to recognize
+duplicated code that can use generics.
+
We’ll begin with the short program in Listing 10-1 that finds the largest
+number in a list.
+
Filename: src/main.rs
+
fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let mut largest = &number_list[0];
+
+ for number in &number_list {
+ if number > largest {
+ largest = number;
+ }
+ }
+
+ println!("The largest number is {largest}");
+ assert_eq!(*largest, 100);
+}
+
Listing 10-1: Finding the largest number in a list of
+numbers
+
We store a list of integers in the variable number_list and place a reference
+to the first number in the list in a variable named largest. We then iterate
+through all the numbers in the list, and if the current number is greater than
+the number stored in largest, we replace the reference in that variable.
+However, if the current number is less than or equal to the largest number seen
+so far, the variable doesn’t change, and the code moves on to the next number
+in the list. After considering all the numbers in the list, largest should
+refer to the largest number, which in this case is 100.
+
We’ve now been tasked with finding the largest number in two different lists of
+numbers. To do so, we can choose to duplicate the code in Listing 10-1 and use
+the same logic at two different places in the program, as shown in Listing 10-2.
+
Filename: src/main.rs
+
fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let mut largest = &number_list[0];
+
+ for number in &number_list {
+ if number > largest {
+ largest = number;
+ }
+ }
+
+ println!("The largest number is {largest}");
+
+ let number_list = vec![102, 34, 6000, 89, 54, 2, 43, 8];
+
+ let mut largest = &number_list[0];
+
+ for number in &number_list {
+ if number > largest {
+ largest = number;
+ }
+ }
+
+ println!("The largest number is {largest}");
+}
+
Listing 10-2: Code to find the largest number in two
+lists of numbers
+
Although this code works, duplicating code is tedious and error prone. We also
+have to remember to update the code in multiple places when we want to change
+it.
+
To eliminate this duplication, we’ll create an abstraction by defining a
+function that operates on any list of integers passed in as a parameter. This
+solution makes our code clearer and lets us express the concept of finding the
+largest number in a list abstractly.
+
In Listing 10-3, we extract the code that finds the largest number into a
+function named largest. Then we call the function to find the largest number
+in the two lists from Listing 10-2. We could also use the function on any other
+list of i32 values we might have in the future.
+
Filename: src/main.rs
+
fn largest(list: &[i32]) -> &i32 {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let result = largest(&number_list);
+ println!("The largest number is {result}");
+ assert_eq!(*result, 100);
+
+ let number_list = vec![102, 34, 6000, 89, 54, 2, 43, 8];
+
+ let result = largest(&number_list);
+ println!("The largest number is {result}");
+ assert_eq!(*result, 6000);
+}
+
Listing 10-3: Abstracted code to find the largest number
+in two lists
+
The largest function has a parameter called list, which represents any
+concrete slice of i32 values we might pass into the function. As a result,
+when we call the function, the code runs on the specific values that we pass
+in.
+
In summary, here are the steps we took to change the code from Listing 10-2 to
+Listing 10-3:
+
+
Identify duplicate code.
+
Extract the duplicate code into the body of the function, and specify the
+inputs and return values of that code in the function signature.
+
Update the two instances of duplicated code to call the function instead.
+
+
Next, we’ll use these same steps with generics to reduce code duplication. In
+the same way that the function body can operate on an abstract list instead
+of specific values, generics allow code to operate on abstract types.
+
For example, say we had two functions: one that finds the largest item in a
+slice of i32 values and one that finds the largest item in a slice of char
+values. How would we eliminate that duplication? Let’s find out!
We use generics to create definitions for items like function signatures or
+structs, which we can then use with many different concrete data types. Let’s
+first look at how to define functions, structs, enums, and methods using
+generics. Then we’ll discuss how generics affect code performance.
When defining a function that uses generics, we place the generics in the
+signature of the function where we would usually specify the data types of the
+parameters and return value. Doing so makes our code more flexible and provides
+more functionality to callers of our function while preventing code duplication.
+
Continuing with our largest function, Listing 10-4 shows two functions that
+both find the largest value in a slice. We’ll then combine these into a single
+function that uses generics.
+
Filename: src/main.rs
+
fn largest_i32(list: &[i32]) -> &i32 {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn largest_char(list: &[char]) -> &char {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let result = largest_i32(&number_list);
+ println!("The largest number is {result}");
+ assert_eq!(*result, 100);
+
+ let char_list = vec!['y', 'm', 'a', 'q'];
+
+ let result = largest_char(&char_list);
+ println!("The largest char is {result}");
+ assert_eq!(*result, 'y');
+}
+
Listing 10-4: Two functions that differ only in their
+names and in the types in their signatures
+
The largest_i32 function is the one we extracted in Listing 10-3 that finds
+the largest i32 in a slice. The largest_char function finds the largest
+char in a slice. The function bodies have the same code, so let’s eliminate
+the duplication by introducing a generic type parameter in a single function.
+
To parameterize the types in a new single function, we need to name the type
+parameter, just as we do for the value parameters to a function. You can use
+any identifier as a type parameter name. But we’ll use T because, by
+convention, type parameter names in Rust are short, often just one letter, and
+Rust’s type-naming convention is UpperCamelCase. Short for type, T is the
+default choice of most Rust programmers.
+
When we use a parameter in the body of the function, we have to declare the
+parameter name in the signature so the compiler knows what that name means.
+Similarly, when we use a type parameter name in a function signature, we have
+to declare the type parameter name before we use it. To define the generic
+largest function, we place type name declarations inside angle brackets,
+<>, between the name of the function and the parameter list, like this:
+
fn largest<T>(list: &[T]) -> &T {
+
We read this definition as: the function largest is generic over some type
+T. This function has one parameter named list, which is a slice of values
+of type T. The largest function will return a reference to a value of the
+same type T.
+
Listing 10-5 shows the combined largest function definition using the generic
+data type in its signature. The listing also shows how we can call the function
+with either a slice of i32 values or char values. Note that this code won’t
+compile yet, but we’ll fix it later in this chapter.
+
Filename: src/main.rs
+
fn largest<T>(list: &[T]) -> &T {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let result = largest(&number_list);
+ println!("The largest number is {result}");
+
+ let char_list = vec!['y', 'm', 'a', 'q'];
+
+ let result = largest(&char_list);
+ println!("The largest char is {result}");
+}
+
Listing 10-5: The largest function using generic type
+parameters; this doesn’t compile yet
+
If we compile this code right now, we’ll get this error:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0369]: binary operation `>` cannot be applied to type `&T`
+ --> src/main.rs:5:17
+ |
+5 | if item > largest {
+ | ---- ^ ------- &T
+ | |
+ | &T
+ |
+help: consider restricting type parameter `T`
+ |
+1 | fn largest<T: std::cmp::PartialOrd>(list: &[T]) -> &T {
+ | ++++++++++++++++++++++
+
+For more information about this error, try `rustc --explain E0369`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The help text mentions std::cmp::PartialOrd, which is a trait, and we’re
+going to talk about traits in the next section. For now, know that this error
+states that the body of largest won’t work for all possible types that T
+could be. Because we want to compare values of type T in the body, we can
+only use types whose values can be ordered. To enable comparisons, the standard
+library has the std::cmp::PartialOrd trait that you can implement on types
+(see Appendix C for more on this trait). By following the help text’s
+suggestion, we restrict the types valid for T to only those that implement
+PartialOrd and this example will compile, because the standard library
+implements PartialOrd on both i32 and char.
We can also define structs to use a generic type parameter in one or more
+fields using the <> syntax. Listing 10-6 defines a Point<T> struct to hold
+x and y coordinate values of any type.
+
Filename: src/main.rs
+
struct Point<T> {
+ x: T,
+ y: T,
+}
+
+fn main() {
+ let integer = Point { x: 5, y: 10 };
+ let float = Point { x: 1.0, y: 4.0 };
+}
+
Listing 10-6: A Point<T> struct that holds x and y
+values of type T
+
The syntax for using generics in struct definitions is similar to that used in
+function definitions. First we declare the name of the type parameter inside
+angle brackets just after the name of the struct. Then we use the generic
+type in the struct definition where we would otherwise specify concrete data
+types.
+
Note that because we’ve used only one generic type to define Point<T>, this
+definition says that the Point<T> struct is generic over some type T, and
+the fields x and y are both that same type, whatever that type may be. If
+we create an instance of a Point<T> that has values of different types, as in
+Listing 10-7, our code won’t compile.
Listing 10-7: The fields x and y must be the same
+type because both have the same generic data type T.
+
In this example, when we assign the integer value 5 to x, we let the
+compiler know that the generic type T will be an integer for this instance of
+Point<T>. Then when we specify 4.0 for y, which we’ve defined to have the
+same type as x, we’ll get a type mismatch error like this:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0308]: mismatched types
+ --> src/main.rs:7:38
+ |
+7 | let wont_work = Point { x: 5, y: 4.0 };
+ | ^^^ expected integer, found floating-point number
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
To define a Point struct where x and y are both generics but could have
+different types, we can use multiple generic type parameters. For example, in
+Listing 10-8, we change the definition of Point to be generic over types T
+and U where x is of type T and y is of type U.
+
Filename: src/main.rs
+
struct Point<T, U> {
+ x: T,
+ y: U,
+}
+
+fn main() {
+ let both_integer = Point { x: 5, y: 10 };
+ let both_float = Point { x: 1.0, y: 4.0 };
+ let integer_and_float = Point { x: 5, y: 4.0 };
+}
+
Listing 10-8: A Point<T, U> generic over two types so
+that x and y can be values of different types
+
Now all the instances of Point shown are allowed! You can use as many generic
+type parameters in a definition as you want, but using more than a few makes
+your code hard to read. If you’re finding you need lots of generic types in
+your code, it could indicate that your code needs restructuring into smaller
+pieces.
As we did with structs, we can define enums to hold generic data types in their
+variants. Let’s take another look at the Option<T> enum that the standard
+library provides, which we used in Chapter 6:
This definition should now make more sense to you. As you can see, the
+Option<T> enum is generic over type T and has two variants: Some, which
+holds one value of type T, and a None variant that doesn’t hold any value.
+By using the Option<T> enum, we can express the abstract concept of an
+optional value, and because Option<T> is generic, we can use this abstraction
+no matter what the type of the optional value is.
+
Enums can use multiple generic types as well. The definition of the Result
+enum that we used in Chapter 9 is one example:
The Result enum is generic over two types, T and E, and has two variants:
+Ok, which holds a value of type T, and Err, which holds a value of type
+E. This definition makes it convenient to use the Result enum anywhere we
+have an operation that might succeed (return a value of some type T) or fail
+(return an error of some type E). In fact, this is what we used to open a
+file in Listing 9-3, where T was filled in with the type std::fs::File when
+the file was opened successfully and E was filled in with the type
+std::io::Error when there were problems opening the file.
+
When you recognize situations in your code with multiple struct or enum
+definitions that differ only in the types of the values they hold, you can
+avoid duplication by using generic types instead.
We can implement methods on structs and enums (as we did in Chapter 5) and use
+generic types in their definitions too. Listing 10-9 shows the Point<T>
+struct we defined in Listing 10-6 with a method named x implemented on it.
Listing 10-9: Implementing a method named x on the
+Point<T> struct that will return a reference to the x field of type
+T
+
Here, we’ve defined a method named x on Point<T> that returns a reference
+to the data in the field x.
+
Note that we have to declare T just after impl so we can use T to specify
+that we’re implementing methods on the type Point<T>. By declaring T as a
+generic type after impl, Rust can identify that the type in the angle
+brackets in Point is a generic type rather than a concrete type. We could
+have chosen a different name for this generic parameter than the generic
+parameter declared in the struct definition, but using the same name is
+conventional. Methods written within an impl that declares the generic type
+will be defined on any instance of the type, no matter what concrete type ends
+up substituting for the generic type.
+
We can also specify constraints on generic types when defining methods on the
+type. We could, for example, implement methods only on Point<f32> instances
+rather than on Point<T> instances with any generic type. In Listing 10-10 we
+use the concrete type f32, meaning we don’t declare any types after impl.
Listing 10-10: An impl block that only applies to a
+struct with a particular concrete type for the generic type parameter T
+
This code means the type Point<f32> will have a distance_from_origin
+method; other instances of Point<T> where T is not of type f32 will not
+have this method defined. The method measures how far our point is from the
+point at coordinates (0.0, 0.0) and uses mathematical operations that are
+available only for floating-point types.
+
Generic type parameters in a struct definition aren’t always the same as those
+you use in that same struct’s method signatures. Listing 10-11 uses the generic
+types X1 and Y1 for the Point struct and X2Y2 for the mixup method
+signature to make the example clearer. The method creates a new Point
+instance with the x value from the selfPoint (of type X1) and the y
+value from the passed-in Point (of type Y2).
Listing 10-11: A method that uses generic types different
+from its struct’s definition
+
In main, we’ve defined a Point that has an i32 for x (with value 5)
+and an f64 for y (with value 10.4). The p2 variable is a Point struct
+that has a string slice for x (with value "Hello") and a char for y
+(with value c). Calling mixup on p1 with the argument p2 gives us p3,
+which will have an i32 for x because x came from p1. The p3 variable
+will have a char for y because y came from p2. The println! macro
+call will print p3.x = 5, p3.y = c.
+
The purpose of this example is to demonstrate a situation in which some generic
+parameters are declared with impl and some are declared with the method
+definition. Here, the generic parameters X1 and Y1 are declared after
+impl because they go with the struct definition. The generic parameters X2
+and Y2 are declared after fn mixup because they’re only relevant to the
+method.
You might be wondering whether there is a runtime cost when using generic type
+parameters. The good news is that using generic types won’t make your program
+run any slower than it would with concrete types.
+
Rust accomplishes this by performing monomorphization of the code using
+generics at compile time. Monomorphization is the process of turning generic
+code into specific code by filling in the concrete types that are used when
+compiled. In this process, the compiler does the opposite of the steps we used
+to create the generic function in Listing 10-5: the compiler looks at all the
+places where generic code is called and generates code for the concrete types
+the generic code is called with.
+
Let’s look at how this works by using the standard library’s generic
+Option<T> enum:
When Rust compiles this code, it performs monomorphization. During that
+process, the compiler reads the values that have been used in Option<T>
+instances and identifies two kinds of Option<T>: one is i32 and the other
+is f64. As such, it expands the generic definition of Option<T> into two
+definitions specialized to i32 and f64, thereby replacing the generic
+definition with the specific ones.
+
The monomorphized version of the code looks similar to the following (the
+compiler uses different names than what we’re using here for illustration):
The generic Option<T> is replaced with the specific definitions created by
+the compiler. Because Rust compiles generic code into code that specifies the
+type in each instance, we pay no runtime cost for using generics. When the code
+runs, it performs just as it would if we had duplicated each definition by
+hand. The process of monomorphization makes Rust’s generics extremely efficient
+at runtime.
A trait defines the functionality a particular type has and can share with
+other types. We can use traits to define shared behavior in an abstract way. We
+can use trait bounds to specify that a generic type can be any type that has
+certain behavior.
+
+
Note: Traits are similar to a feature often called interfaces in other
+languages, although with some differences.
A type’s behavior consists of the methods we can call on that type. Different
+types share the same behavior if we can call the same methods on all of those
+types. Trait definitions are a way to group method signatures together to
+define a set of behaviors necessary to accomplish some purpose.
+
For example, let’s say we have multiple structs that hold various kinds and
+amounts of text: a NewsArticle struct that holds a news story filed in a
+particular location and a Tweet that can have, at most, 280 characters along
+with metadata that indicates whether it was a new tweet, a retweet, or a reply
+to another tweet.
+
We want to make a media aggregator library crate named aggregator that can
+display summaries of data that might be stored in a NewsArticle or Tweet
+instance. To do this, we need a summary from each type, and we’ll request that
+summary by calling a summarize method on an instance. Listing 10-12 shows the
+definition of a public Summary trait that expresses this behavior.
Listing 10-12: A Summary trait that consists of the
+behavior provided by a summarize method
+
Here, we declare a trait using the trait keyword and then the trait’s name,
+which is Summary in this case. We also declare the trait as pub so that
+crates depending on this crate can make use of this trait too, as we’ll see in
+a few examples. Inside the curly brackets, we declare the method signatures
+that describe the behaviors of the types that implement this trait, which in
+this case is fn summarize(&self) -> String.
+
After the method signature, instead of providing an implementation within curly
+brackets, we use a semicolon. Each type implementing this trait must provide
+its own custom behavior for the body of the method. The compiler will enforce
+that any type that has the Summary trait will have the method summarize
+defined with this signature exactly.
+
A trait can have multiple methods in its body: the method signatures are listed
+one per line, and each line ends in a semicolon.
Now that we’ve defined the desired signatures of the Summary trait’s methods,
+we can implement it on the types in our media aggregator. Listing 10-13 shows
+an implementation of the Summary trait on the NewsArticle struct that uses
+the headline, the author, and the location to create the return value of
+summarize. For the Tweet struct, we define summarize as the username
+followed by the entire text of the tweet, assuming that the tweet content is
+already limited to 280 characters.
Listing 10-13: Implementing the Summary trait on the
+NewsArticle and Tweet types
+
Implementing a trait on a type is similar to implementing regular methods. The
+difference is that after impl, we put the trait name we want to implement,
+then use the for keyword, and then specify the name of the type we want to
+implement the trait for. Within the impl block, we put the method signatures
+that the trait definition has defined. Instead of adding a semicolon after each
+signature, we use curly brackets and fill in the method body with the specific
+behavior that we want the methods of the trait to have for the particular type.
+
Now that the library has implemented the Summary trait on NewsArticle and
+Tweet, users of the crate can call the trait methods on instances of
+NewsArticle and Tweet in the same way we call regular methods. The only
+difference is that the user must bring the trait into scope as well as the
+types. Here’s an example of how a binary crate could use our aggregator
+library crate:
+
use aggregator::{Summary, Tweet};
+
+fn main() {
+ let tweet = Tweet {
+ username: String::from("horse_ebooks"),
+ content: String::from(
+ "of course, as you probably already know, people",
+ ),
+ reply: false,
+ retweet: false,
+ };
+
+ println!("1 new tweet: {}", tweet.summarize());
+}
+
This code prints 1 new tweet: horse_ebooks: of course, as you probably already know, people.
+
Other crates that depend on the aggregator crate can also bring the Summary
+trait into scope to implement Summary on their own types. One restriction to
+note is that we can implement a trait on a type only if either the trait or the
+type, or both, are local to our crate. For example, we can implement standard
+library traits like Display on a custom type like Tweet as part of our
+aggregator crate functionality because the type Tweet is local to our
+aggregator crate. We can also implement Summary on Vec<T> in our
+aggregator crate because the trait Summary is local to our aggregator
+crate.
+
But we can’t implement external traits on external types. For example, we can’t
+implement the Display trait on Vec<T> within our aggregator crate because
+Display and Vec<T> are both defined in the standard library and aren’t
+local to our aggregator crate. This restriction is part of a property called
+coherence, and more specifically the orphan rule, so named because the
+parent type is not present. This rule ensures that other people’s code can’t
+break your code and vice versa. Without the rule, two crates could implement
+the same trait for the same type, and Rust wouldn’t know which implementation
+to use.
Sometimes it’s useful to have default behavior for some or all of the methods
+in a trait instead of requiring implementations for all methods on every type.
+Then, as we implement the trait on a particular type, we can keep or override
+each method’s default behavior.
+
In Listing 10-14, we specify a default string for the summarize method of the
+Summary trait instead of only defining the method signature, as we did in
+Listing 10-12.
Listing 10-14: Defining a Summary trait with a default
+implementation of the summarize method
+
To use a default implementation to summarize instances of NewsArticle, we
+specify an empty impl block with impl Summary for NewsArticle {}.
+
Even though we’re no longer defining the summarize method on NewsArticle
+directly, we’ve provided a default implementation and specified that
+NewsArticle implements the Summary trait. As a result, we can still call
+the summarize method on an instance of NewsArticle, like this:
+
use aggregator::{self, NewsArticle, Summary};
+
+fn main() {
+ let article = NewsArticle {
+ headline: String::from("Penguins win the Stanley Cup Championship!"),
+ location: String::from("Pittsburgh, PA, USA"),
+ author: String::from("Iceburgh"),
+ content: String::from(
+ "The Pittsburgh Penguins once again are the best \
+ hockey team in the NHL.",
+ ),
+ };
+
+ println!("New article available! {}", article.summarize());
+}
+
This code prints New article available! (Read more...).
+
Creating a default implementation doesn’t require us to change anything about
+the implementation of Summary on Tweet in Listing 10-13. The reason is that
+the syntax for overriding a default implementation is the same as the syntax
+for implementing a trait method that doesn’t have a default implementation.
+
Default implementations can call other methods in the same trait, even if those
+other methods don’t have a default implementation. In this way, a trait can
+provide a lot of useful functionality and only require implementors to specify
+a small part of it. For example, we could define the Summary trait to have a
+summarize_author method whose implementation is required, and then define a
+summarize method that has a default implementation that calls the
+summarize_author method:
After we define summarize_author, we can call summarize on instances of the
+Tweet struct, and the default implementation of summarize will call the
+definition of summarize_author that we’ve provided. Because we’ve implemented
+summarize_author, the Summary trait has given us the behavior of the
+summarize method without requiring us to write any more code. Here’s what
+that looks like:
+
use aggregator::{self, Summary, Tweet};
+
+fn main() {
+ let tweet = Tweet {
+ username: String::from("horse_ebooks"),
+ content: String::from(
+ "of course, as you probably already know, people",
+ ),
+ reply: false,
+ retweet: false,
+ };
+
+ println!("1 new tweet: {}", tweet.summarize());
+}
+
This code prints 1 new tweet: (Read more from @horse_ebooks...).
+
Note that it isn’t possible to call the default implementation from an
+overriding implementation of that same method.
Now that you know how to define and implement traits, we can explore how to use
+traits to define functions that accept many different types. We’ll use the
+Summary trait we implemented on the NewsArticle and Tweet types in
+Listing 10-13 to define a notify function that calls the summarize method
+on its item parameter, which is of some type that implements the Summary
+trait. To do this, we use the impl Trait syntax, like this:
Instead of a concrete type for the item parameter, we specify the impl
+keyword and the trait name. This parameter accepts any type that implements the
+specified trait. In the body of notify, we can call any methods on item
+that come from the Summary trait, such as summarize. We can call notify
+and pass in any instance of NewsArticle or Tweet. Code that calls the
+function with any other type, such as a String or an i32, won’t compile
+because those types don’t implement Summary.
This longer form is equivalent to the example in the previous section but is
+more verbose. We place trait bounds with the declaration of the generic type
+parameter after a colon and inside angle brackets.
+
The impl Trait syntax is convenient and makes for more concise code in simple
+cases, while the fuller trait bound syntax can express more complexity in other
+cases. For example, we can have two parameters that implement Summary. Doing
+so with the impl Trait syntax looks like this:
Using impl Trait is appropriate if we want this function to allow item1 and
+item2 to have different types (as long as both types implement Summary). If
+we want to force both parameters to have the same type, however, we must use a
+trait bound, like this:
+
pub fn notify<T: Summary>(item1: &T, item2: &T) {
+
The generic type T specified as the type of the item1 and item2
+parameters constrains the function such that the concrete type of the value
+passed as an argument for item1 and item2 must be the same.
We can also specify more than one trait bound. Say we wanted notify to use
+display formatting as well as summarize on item: we specify in the notify
+definition that item must implement both Display and Summary. We can do
+so using the + syntax:
+
pub fn notify(item: &(impl Summary + Display)) {
+
The + syntax is also valid with trait bounds on generic types:
+
pub fn notify<T: Summary + Display>(item: &T) {
+
With the two trait bounds specified, the body of notify can call summarize
+and use {} to format item.
Using too many trait bounds has its downsides. Each generic has its own trait
+bounds, so functions with multiple generic type parameters can contain lots of
+trait bound information between the function’s name and its parameter list,
+making the function signature hard to read. For this reason, Rust has alternate
+syntax for specifying trait bounds inside a where clause after the function
+signature. So, instead of writing this:
This function’s signature is less cluttered: the function name, parameter list,
+and return type are close together, similar to a function without lots of trait
+bounds.
By using impl Summary for the return type, we specify that the
+returns_summarizable function returns some type that implements the Summary
+trait without naming the concrete type. In this case, returns_summarizable
+returns a Tweet, but the code calling this function doesn’t need to know that.
+
The ability to specify a return type only by the trait it implements is
+especially useful in the context of closures and iterators, which we cover in
+Chapter 13. Closures and iterators create types that only the compiler knows or
+types that are very long to specify. The impl Trait syntax lets you concisely
+specify that a function returns some type that implements the Iterator trait
+without needing to write out a very long type.
+
However, you can only use impl Trait if you’re returning a single type. For
+example, this code that returns either a NewsArticle or a Tweet with the
+return type specified as impl Summary wouldn’t work:
+
pub trait Summary {
+ fn summarize(&self) -> String;
+}
+
+pub struct NewsArticle {
+ pub headline: String,
+ pub location: String,
+ pub author: String,
+ pub content: String,
+}
+
+impl Summary for NewsArticle {
+ fn summarize(&self) -> String {
+ format!("{}, by {} ({})", self.headline, self.author, self.location)
+ }
+}
+
+pub struct Tweet {
+ pub username: String,
+ pub content: String,
+ pub reply: bool,
+ pub retweet: bool,
+}
+
+impl Summary for Tweet {
+ fn summarize(&self) -> String {
+ format!("{}: {}", self.username, self.content)
+ }
+}
+
+fn returns_summarizable(switch: bool) -> impl Summary {
+ if switch {
+ NewsArticle {
+ headline: String::from(
+ "Penguins win the Stanley Cup Championship!",
+ ),
+ location: String::from("Pittsburgh, PA, USA"),
+ author: String::from("Iceburgh"),
+ content: String::from(
+ "The Pittsburgh Penguins once again are the best \
+ hockey team in the NHL.",
+ ),
+ }
+ } else {
+ Tweet {
+ username: String::from("horse_ebooks"),
+ content: String::from(
+ "of course, as you probably already know, people",
+ ),
+ reply: false,
+ retweet: false,
+ }
+ }
+}
+
Returning either a NewsArticle or a Tweet isn’t allowed due to restrictions
+around how the impl Trait syntax is implemented in the compiler. We’ll cover
+how to write a function with this behavior in the “Using Trait Objects That
+Allow for Values of Different
+Types” section of Chapter 17.
By using a trait bound with an impl block that uses generic type parameters,
+we can implement methods conditionally for types that implement the specified
+traits. For example, the type Pair<T> in Listing 10-15 always implements the
+new function to return a new instance of Pair<T> (recall from the
+“Defining Methods” section of Chapter 5 that Self
+is a type alias for the type of the impl block, which in this case is
+Pair<T>). But in the next impl block, Pair<T> only implements the
+cmp_display method if its inner type T implements the PartialOrd trait
+that enables comparison and the Display trait that enables printing.
+
Filename: src/lib.rs
+
use std::fmt::Display;
+
+struct Pair<T> {
+ x: T,
+ y: T,
+}
+
+impl<T> Pair<T> {
+ fn new(x: T, y: T) -> Self {
+ Self { x, y }
+ }
+}
+
+impl<T: Display + PartialOrd> Pair<T> {
+ fn cmp_display(&self) {
+ if self.x >= self.y {
+ println!("The largest member is x = {}", self.x);
+ } else {
+ println!("The largest member is y = {}", self.y);
+ }
+ }
+}
+
Listing 10-15: Conditionally implementing methods on a
+generic type depending on trait bounds
+
We can also conditionally implement a trait for any type that implements
+another trait. Implementations of a trait on any type that satisfies the trait
+bounds are called blanket implementations and are used extensively in the
+Rust standard library. For example, the standard library implements the
+ToString trait on any type that implements the Display trait. The impl
+block in the standard library looks similar to this code:
+
impl<T: Display> ToString for T {
+ // --snip--
+}
+
Because the standard library has this blanket implementation, we can call the
+to_string method defined by the ToString trait on any type that implements
+the Display trait. For example, we can turn integers into their corresponding
+String values like this because integers implement Display:
+
#![allow(unused)]
+fn main() {
+let s = 3.to_string();
+}
+
Blanket implementations appear in the documentation for the trait in the
+“Implementors” section.
+
Traits and trait bounds let us write code that uses generic type parameters to
+reduce duplication but also specify to the compiler that we want the generic
+type to have particular behavior. The compiler can then use the trait bound
+information to check that all the concrete types used with our code provide the
+correct behavior. In dynamically typed languages, we would get an error at
+runtime if we called a method on a type which didn’t define the method. But
+Rust moves these errors to compile time so we’re forced to fix the problems
+before our code is even able to run. Additionally, we don’t have to write code
+that checks for behavior at runtime because we’ve already checked at compile
+time. Doing so improves performance without having to give up the flexibility
+of generics.
Lifetimes are another kind of generic that we’ve already been using. Rather
+than ensuring that a type has the behavior we want, lifetimes ensure that
+references are valid as long as we need them to be.
+
One detail we didn’t discuss in the “References and
+Borrowing” section in Chapter 4 is
+that every reference in Rust has a lifetime, which is the scope for which
+that reference is valid. Most of the time, lifetimes are implicit and inferred,
+just like most of the time, types are inferred. We must annotate types only
+when multiple types are possible. In a similar way, we must annotate lifetimes
+when the lifetimes of references could be related in a few different ways. Rust
+requires us to annotate the relationships using generic lifetime parameters to
+ensure the actual references used at runtime will definitely be valid.
+
Annotating lifetimes is not a concept most other programming languages have, so
+this is going to feel unfamiliar. Although we won’t cover lifetimes in their
+entirety in this chapter, we’ll discuss common ways you might encounter
+lifetime syntax so you can get comfortable with the concept.
The main aim of lifetimes is to prevent dangling references, which cause a
+program to reference data other than the data it’s intended to reference.
+Consider the program in Listing 10-16, which has an outer scope and an inner
+scope.
+
fn main() {
+ let r;
+
+ {
+ let x = 5;
+ r = &x;
+ }
+
+ println!("r: {r}");
+}
+
Listing 10-16: An attempt to use a reference whose value
+has gone out of scope
+
+
Note: The examples in Listing 10-16, 10-17, and 10-23 declare variables
+without giving them an initial value, so the variable name exists in the outer
+scope. At first glance, this might appear to be in conflict with Rust’s having
+no null values. However, if we try to use a variable before giving it a value,
+we’ll get a compile-time error, which shows that Rust indeed does not allow
+null values.
+
+
The outer scope declares a variable named r with no initial value, and the
+inner scope declares a variable named x with the initial value of 5. Inside
+the inner scope, we attempt to set the value of r as a reference to x. Then
+the inner scope ends, and we attempt to print the value in r. This code won’t
+compile because the value that r is referring to has gone out of scope before
+we try to use it. Here is the error message:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0597]: `x` does not live long enough
+ --> src/main.rs:6:13
+ |
+5 | let x = 5;
+ | - binding `x` declared here
+6 | r = &x;
+ | ^^ borrowed value does not live long enough
+7 | }
+ | - `x` dropped here while still borrowed
+8 |
+9 | println!("r: {r}");
+ | --- borrow later used here
+
+For more information about this error, try `rustc --explain E0597`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The error message says that the variable x “does not live long enough.” The
+reason is that x will be out of scope when the inner scope ends on line 7.
+But r is still valid for the outer scope; because its scope is larger, we say
+that it “lives longer.” If Rust allowed this code to work, r would be
+referencing memory that was deallocated when x went out of scope, and
+anything we tried to do with r wouldn’t work correctly. So how does Rust
+determine that this code is invalid? It uses a borrow checker.
The Rust compiler has a borrow checker that compares scopes to determine
+whether all borrows are valid. Listing 10-17 shows the same code as Listing
+10-16 but with annotations showing the lifetimes of the variables.
+
fn main() {
+ let r; // ---------+-- 'a
+ // |
+ { // |
+ let x = 5; // -+-- 'b |
+ r = &x; // | |
+ } // -+ |
+ // |
+ println!("r: {r}"); // |
+} // ---------+
+
Listing 10-17: Annotations of the lifetimes of r and
+x, named 'a and 'b, respectively
+
Here, we’ve annotated the lifetime of r with 'a and the lifetime of x
+with 'b. As you can see, the inner 'b block is much smaller than the outer
+'a lifetime block. At compile time, Rust compares the size of the two
+lifetimes and sees that r has a lifetime of 'a but that it refers to memory
+with a lifetime of 'b. The program is rejected because 'b is shorter than
+'a: the subject of the reference doesn’t live as long as the reference.
+
Listing 10-18 fixes the code so it doesn’t have a dangling reference and it
+compiles without any errors.
+
fn main() {
+ let x = 5; // ----------+-- 'b
+ // |
+ let r = &x; // --+-- 'a |
+ // | |
+ println!("r: {r}"); // | |
+ // --+ |
+} // ----------+
+
Listing 10-18: A valid reference because the data has a
+longer lifetime than the reference
+
Here, x has the lifetime 'b, which in this case is larger than 'a. This
+means r can reference x because Rust knows that the reference in r will
+always be valid while x is valid.
+
Now that you know what the lifetimes of references are and how Rust analyzes
+lifetimes to ensure references will always be valid, let’s explore generic
+lifetimes of parameters and return values in the context of functions.
We’ll write a function that returns the longer of two string slices. This
+function will take two string slices and return a single string slice. After
+we’ve implemented the longest function, the code in Listing 10-19 should
+print The longest string is abcd.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
Listing 10-19: A main function that calls the longest
+function to find the longer of two string slices
+
Note that we want the function to take string slices, which are references,
+rather than strings, because we don’t want the longest function to take
+ownership of its parameters. Refer to the “String Slices as
+Parameters” section in Chapter 4
+for more discussion about why the parameters we use in Listing 10-19 are the
+ones we want.
+
If we try to implement the longest function as shown in Listing 10-20, it
+won’t compile.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest(x: &str, y: &str) -> &str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-20: An implementation of the longest
+function that returns the longer of two string slices but does not yet
+compile
+
Instead, we get the following error that talks about lifetimes:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:9:33
+ |
+9 | fn longest(x: &str, y: &str) -> &str {
+ | ---- ---- ^ expected named lifetime parameter
+ |
+ = help: this function's return type contains a borrowed value, but the signature does not say whether it is borrowed from `x` or `y`
+help: consider introducing a named lifetime parameter
+ |
+9 | fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ | ++++ ++ ++ ++
+
+error: lifetime may not live long enough
+ --> src/main.rs:11:9
+ |
+9 | fn longest(x: &str, y: &str) -> &str {
+ | - let's call the lifetime of this reference `'1`
+10 | if x.len() > y.len() {
+11 | x
+ | ^ returning this value requires that `'1` must outlive `'static`
+
+error: lifetime may not live long enough
+ --> src/main.rs:13:9
+ |
+9 | fn longest(x: &str, y: &str) -> &str {
+ | - let's call the lifetime of this reference `'2`
+...
+13 | y
+ | ^ returning this value requires that `'2` must outlive `'static`
+
+For more information about this error, try `rustc --explain E0106`.
+error: could not compile `chapter10` (bin "chapter10") due to 3 previous errors
+
+
The help text reveals that the return type needs a generic lifetime parameter
+on it because Rust can’t tell whether the reference being returned refers to
+x or y. Actually, we don’t know either, because the if block in the body
+of this function returns a reference to x and the else block returns a
+reference to y!
+
When we’re defining this function, we don’t know the concrete values that will
+be passed into this function, so we don’t know whether the if case or the
+else case will execute. We also don’t know the concrete lifetimes of the
+references that will be passed in, so we can’t look at the scopes as we did in
+Listings 10-17 and 10-18 to determine whether the reference we return will
+always be valid. The borrow checker can’t determine this either, because it
+doesn’t know how the lifetimes of x and y relate to the lifetime of the
+return value. To fix this error, we’ll add generic lifetime parameters that
+define the relationship between the references so the borrow checker can
+perform its analysis.
Lifetime annotations don’t change how long any of the references live. Rather,
+they describe the relationships of the lifetimes of multiple references to each
+other without affecting the lifetimes. Just as functions can accept any type
+when the signature specifies a generic type parameter, functions can accept
+references with any lifetime by specifying a generic lifetime parameter.
+
Lifetime annotations have a slightly unusual syntax: the names of lifetime
+parameters must start with an apostrophe (') and are usually all lowercase
+and very short, like generic types. Most people use the name 'a for the first
+lifetime annotation. We place lifetime parameter annotations after the & of a
+reference, using a space to separate the annotation from the reference’s type.
+
Here are some examples: a reference to an i32 without a lifetime parameter, a
+reference to an i32 that has a lifetime parameter named 'a, and a mutable
+reference to an i32 that also has the lifetime 'a.
+
&i32 // a reference
+&'a i32 // a reference with an explicit lifetime
+&'a mut i32 // a mutable reference with an explicit lifetime
+
One lifetime annotation by itself doesn’t have much meaning because the
+annotations are meant to tell Rust how generic lifetime parameters of multiple
+references relate to each other. Let’s examine how the lifetime annotations
+relate to each other in the context of the longest function.
To use lifetime annotations in function signatures, we need to declare the
+generic lifetime parameters inside angle brackets between the function name
+and the parameter list, just as we did with generic type parameters.
+
We want the signature to express the following constraint: the returned
+reference will be valid as long as both the parameters are valid. This is the
+relationship between lifetimes of the parameters and the return value. We’ll
+name the lifetime 'a and then add it to each reference, as shown in Listing
+10-21.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-21: The longest function definition
+specifying that all the references in the signature must have the same lifetime
+'a
+
This code should compile and produce the result we want when we use it with the
+main function in Listing 10-19.
+
The function signature now tells Rust that for some lifetime 'a, the function
+takes two parameters, both of which are string slices that live at least as
+long as lifetime 'a. The function signature also tells Rust that the string
+slice returned from the function will live at least as long as lifetime 'a.
+In practice, it means that the lifetime of the reference returned by the
+longest function is the same as the smaller of the lifetimes of the values
+referred to by the function arguments. These relationships are what we want
+Rust to use when analyzing this code.
+
Remember, when we specify the lifetime parameters in this function signature,
+we’re not changing the lifetimes of any values passed in or returned. Rather,
+we’re specifying that the borrow checker should reject any values that don’t
+adhere to these constraints. Note that the longest function doesn’t need to
+know exactly how long x and y will live, only that some scope can be
+substituted for 'a that will satisfy this signature.
+
When annotating lifetimes in functions, the annotations go in the function
+signature, not in the function body. The lifetime annotations become part of
+the contract of the function, much like the types in the signature. Having
+function signatures contain the lifetime contract means the analysis the Rust
+compiler does can be simpler. If there’s a problem with the way a function is
+annotated or the way it is called, the compiler errors can point to the part of
+our code and the constraints more precisely. If, instead, the Rust compiler
+made more inferences about what we intended the relationships of the lifetimes
+to be, the compiler might only be able to point to a use of our code many steps
+away from the cause of the problem.
+
When we pass concrete references to longest, the concrete lifetime that is
+substituted for 'a is the part of the scope of x that overlaps with the
+scope of y. In other words, the generic lifetime 'a will get the concrete
+lifetime that is equal to the smaller of the lifetimes of x and y. Because
+we’ve annotated the returned reference with the same lifetime parameter 'a,
+the returned reference will also be valid for the length of the smaller of the
+lifetimes of x and y.
+
Let’s look at how the lifetime annotations restrict the longest function by
+passing in references that have different concrete lifetimes. Listing 10-22 is
+a straightforward example.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("long string is long");
+
+ {
+ let string2 = String::from("xyz");
+ let result = longest(string1.as_str(), string2.as_str());
+ println!("The longest string is {result}");
+ }
+}
+
+fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-22: Using the longest function with
+references to String values that have different concrete lifetimes
+
In this example, string1 is valid until the end of the outer scope, string2
+is valid until the end of the inner scope, and result references something
+that is valid until the end of the inner scope. Run this code and you’ll see
+that the borrow checker approves; it will compile and print The longest string is long string is long.
+
Next, let’s try an example that shows that the lifetime of the reference in
+result must be the smaller lifetime of the two arguments. We’ll move the
+declaration of the result variable outside the inner scope but leave the
+assignment of the value to the result variable inside the scope with
+string2. Then we’ll move the println! that uses result to outside the
+inner scope, after the inner scope has ended. The code in Listing 10-23 will
+not compile.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("long string is long");
+ let result;
+ {
+ let string2 = String::from("xyz");
+ result = longest(string1.as_str(), string2.as_str());
+ }
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-23: Attempting to use result after string2
+has gone out of scope
+
When we try to compile this code, we get this error:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0597]: `string2` does not live long enough
+ --> src/main.rs:6:44
+ |
+5 | let string2 = String::from("xyz");
+ | ------- binding `string2` declared here
+6 | result = longest(string1.as_str(), string2.as_str());
+ | ^^^^^^^ borrowed value does not live long enough
+7 | }
+ | - `string2` dropped here while still borrowed
+8 | println!("The longest string is {result}");
+ | -------- borrow later used here
+
+For more information about this error, try `rustc --explain E0597`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The error shows that for result to be valid for the println! statement,
+string2 would need to be valid until the end of the outer scope. Rust knows
+this because we annotated the lifetimes of the function parameters and return
+values using the same lifetime parameter 'a.
+
As humans, we can look at this code and see that string1 is longer than
+string2, and therefore, result will contain a reference to string1.
+Because string1 has not gone out of scope yet, a reference to string1 will
+still be valid for the println! statement. However, the compiler can’t see
+that the reference is valid in this case. We’ve told Rust that the lifetime of
+the reference returned by the longest function is the same as the smaller of
+the lifetimes of the references passed in. Therefore, the borrow checker
+disallows the code in Listing 10-23 as possibly having an invalid reference.
+
Try designing more experiments that vary the values and lifetimes of the
+references passed in to the longest function and how the returned reference
+is used. Make hypotheses about whether or not your experiments will pass the
+borrow checker before you compile; then check to see if you’re right!
The way in which you need to specify lifetime parameters depends on what your
+function is doing. For example, if we changed the implementation of the
+longest function to always return the first parameter rather than the longest
+string slice, we wouldn’t need to specify a lifetime on the y parameter. The
+following code will compile:
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "efghijklmnopqrstuvwxyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &'a str, y: &str) -> &'a str {
+ x
+}
+
We’ve specified a lifetime parameter 'a for the parameter x and the return
+type, but not for the parameter y, because the lifetime of y does not have
+any relationship with the lifetime of x or the return value.
+
When returning a reference from a function, the lifetime parameter for the
+return type needs to match the lifetime parameter for one of the parameters. If
+the reference returned does not refer to one of the parameters, it must refer
+to a value created within this function. However, this would be a dangling
+reference because the value will go out of scope at the end of the function.
+Consider this attempted implementation of the longest function that won’t
+compile:
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &str, y: &str) -> &'a str {
+ let result = String::from("really long string");
+ result.as_str()
+}
+
Here, even though we’ve specified a lifetime parameter 'a for the return
+type, this implementation will fail to compile because the return value
+lifetime is not related to the lifetime of the parameters at all. Here is the
+error message we get:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0515]: cannot return value referencing local variable `result`
+ --> src/main.rs:11:5
+ |
+11 | result.as_str()
+ | ------^^^^^^^^^
+ | |
+ | returns a value referencing data owned by the current function
+ | `result` is borrowed here
+
+For more information about this error, try `rustc --explain E0515`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The problem is that result goes out of scope and gets cleaned up at the end
+of the longest function. We’re also trying to return a reference to result
+from the function. There is no way we can specify lifetime parameters that
+would change the dangling reference, and Rust won’t let us create a dangling
+reference. In this case, the best fix would be to return an owned data type
+rather than a reference so the calling function is then responsible for
+cleaning up the value.
+
Ultimately, lifetime syntax is about connecting the lifetimes of various
+parameters and return values of functions. Once they’re connected, Rust has
+enough information to allow memory-safe operations and disallow operations that
+would create dangling pointers or otherwise violate memory safety.
So far, the structs we’ve defined all hold owned types. We can define structs
+to hold references, but in that case we would need to add a lifetime annotation
+on every reference in the struct’s definition. Listing 10-24 has a struct named
+ImportantExcerpt that holds a string slice.
+
Filename: src/main.rs
+
struct ImportantExcerpt<'a> {
+ part: &'a str,
+}
+
+fn main() {
+ let novel = String::from("Call me Ishmael. Some years ago...");
+ let first_sentence = novel.split('.').next().unwrap();
+ let i = ImportantExcerpt {
+ part: first_sentence,
+ };
+}
+
Listing 10-24: A struct that holds a reference, requiring
+a lifetime annotation
+
This struct has the single field part that holds a string slice, which is a
+reference. As with generic data types, we declare the name of the generic
+lifetime parameter inside angle brackets after the name of the struct so we can
+use the lifetime parameter in the body of the struct definition. This
+annotation means an instance of ImportantExcerpt can’t outlive the reference
+it holds in its part field.
+
The main function here creates an instance of the ImportantExcerpt struct
+that holds a reference to the first sentence of the String owned by the
+variable novel. The data in novel exists before the ImportantExcerpt
+instance is created. In addition, novel doesn’t go out of scope until after
+the ImportantExcerpt goes out of scope, so the reference in the
+ImportantExcerpt instance is valid.
You’ve learned that every reference has a lifetime and that you need to specify
+lifetime parameters for functions or structs that use references. However, we
+had a function in Listing 4-9, shown again in Listing 10-25, that compiled
+without lifetime annotations.
+
Filename: src/lib.rs
+
fn first_word(s: &str) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let my_string = String::from("hello world");
+
+ // first_word works on slices of `String`s
+ let word = first_word(&my_string[..]);
+
+ let my_string_literal = "hello world";
+
+ // first_word works on slices of string literals
+ let word = first_word(&my_string_literal[..]);
+
+ // Because string literals *are* string slices already,
+ // this works too, without the slice syntax!
+ let word = first_word(my_string_literal);
+}
+
Listing 10-25: A function we defined in Listing 4-9 that
+compiled without lifetime annotations, even though the parameter and return
+type are references
+
The reason this function compiles without lifetime annotations is historical:
+in early versions (pre-1.0) of Rust, this code wouldn’t have compiled because
+every reference needed an explicit lifetime. At that time, the function
+signature would have been written like this:
+
fn first_word<'a>(s: &'a str) -> &'a str {
+
After writing a lot of Rust code, the Rust team found that Rust programmers
+were entering the same lifetime annotations over and over in particular
+situations. These situations were predictable and followed a few deterministic
+patterns. The developers programmed these patterns into the compiler’s code so
+the borrow checker could infer the lifetimes in these situations and wouldn’t
+need explicit annotations.
+
This piece of Rust history is relevant because it’s possible that more
+deterministic patterns will emerge and be added to the compiler. In the future,
+even fewer lifetime annotations might be required.
+
The patterns programmed into Rust’s analysis of references are called the
+lifetime elision rules. These aren’t rules for programmers to follow; they’re
+a set of particular cases that the compiler will consider, and if your code
+fits these cases, you don’t need to write the lifetimes explicitly.
+
The elision rules don’t provide full inference. If there is still ambiguity as
+to what lifetimes the references have after Rust applies the rules, the
+compiler won’t guess what the lifetime of the remaining references should be.
+Instead of guessing, the compiler will give you an error that you can resolve
+by adding the lifetime annotations.
+
Lifetimes on function or method parameters are called input lifetimes, and
+lifetimes on return values are called output lifetimes.
+
The compiler uses three rules to figure out the lifetimes of the references
+when there aren’t explicit annotations. The first rule applies to input
+lifetimes, and the second and third rules apply to output lifetimes. If the
+compiler gets to the end of the three rules and there are still references for
+which it can’t figure out lifetimes, the compiler will stop with an error.
+These rules apply to fn definitions as well as impl blocks.
+
The first rule is that the compiler assigns a lifetime parameter to each
+parameter that’s a reference. In other words, a function with one parameter
+gets one lifetime parameter: fn foo<'a>(x: &'a i32); a function with two
+parameters gets two separate lifetime parameters: fn foo<'a, 'b>(x: &'a i32, y: &'b i32); and so on.
+
The second rule is that, if there is exactly one input lifetime parameter, that
+lifetime is assigned to all output lifetime parameters: fn foo<'a>(x: &'a i32) -> &'a i32.
+
The third rule is that, if there are multiple input lifetime parameters, but
+one of them is &self or &mut self because this is a method, the lifetime of
+self is assigned to all output lifetime parameters. This third rule makes
+methods much nicer to read and write because fewer symbols are necessary.
+
Let’s pretend we’re the compiler. We’ll apply these rules to figure out the
+lifetimes of the references in the signature of the first_word function in
+Listing 10-25. The signature starts without any lifetimes associated with the
+references:
+
fn first_word(s: &str) -> &str {
+
Then the compiler applies the first rule, which specifies that each parameter
+gets its own lifetime. We’ll call it 'a as usual, so now the signature is
+this:
+
fn first_word<'a>(s: &'a str) -> &str {
+
The second rule applies because there is exactly one input lifetime. The second
+rule specifies that the lifetime of the one input parameter gets assigned to
+the output lifetime, so the signature is now this:
+
fn first_word<'a>(s: &'a str) -> &'a str {
+
Now all the references in this function signature have lifetimes, and the
+compiler can continue its analysis without needing the programmer to annotate
+the lifetimes in this function signature.
+
Let’s look at another example, this time using the longest function that had
+no lifetime parameters when we started working with it in Listing 10-20:
+
fn longest(x: &str, y: &str) -> &str {
+
Let’s apply the first rule: each parameter gets its own lifetime. This time we
+have two parameters instead of one, so we have two lifetimes:
You can see that the second rule doesn’t apply because there is more than one
+input lifetime. The third rule doesn’t apply either, because longest is a
+function rather than a method, so none of the parameters are self. After
+working through all three rules, we still haven’t figured out what the return
+type’s lifetime is. This is why we got an error trying to compile the code in
+Listing 10-20: the compiler worked through the lifetime elision rules but still
+couldn’t figure out all the lifetimes of the references in the signature.
+
Because the third rule really only applies in method signatures, we’ll look at
+lifetimes in that context next to see why the third rule means we don’t have to
+annotate lifetimes in method signatures very often.
When we implement methods on a struct with lifetimes, we use the same syntax as
+that of generic type parameters shown in Listing 10-11. Where we declare and
+use the lifetime parameters depends on whether they’re related to the struct
+fields or the method parameters and return values.
+
Lifetime names for struct fields always need to be declared after the impl
+keyword and then used after the struct’s name because those lifetimes are part
+of the struct’s type.
+
In method signatures inside the impl block, references might be tied to the
+lifetime of references in the struct’s fields, or they might be independent. In
+addition, the lifetime elision rules often make it so that lifetime annotations
+aren’t necessary in method signatures. Let’s look at some examples using the
+struct named ImportantExcerpt that we defined in Listing 10-24.
+
First we’ll use a method named level whose only parameter is a reference to
+self and whose return value is an i32, which is not a reference to anything:
The lifetime parameter declaration after impl and its use after the type name
+are required, but we’re not required to annotate the lifetime of the reference
+to self because of the first elision rule.
+
Here is an example where the third lifetime elision rule applies:
There are two input lifetimes, so Rust applies the first lifetime elision rule
+and gives both &self and announcement their own lifetimes. Then, because
+one of the parameters is &self, the return type gets the lifetime of &self,
+and all lifetimes have been accounted for.
One special lifetime we need to discuss is 'static, which denotes that the
+affected reference can live for the entire duration of the program. All
+string literals have the 'static lifetime, which we can annotate as follows:
+
#![allow(unused)]
+fn main() {
+let s: &'static str = "I have a static lifetime.";
+}
+
The text of this string is stored directly in the program’s binary, which is
+always available. Therefore, the lifetime of all string literals is 'static.
+
You might see suggestions to use the 'static lifetime in error messages. But
+before specifying 'static as the lifetime for a reference, think about
+whether the reference you have actually lives the entire lifetime of your
+program or not, and whether you want it to. Most of the time, an error message
+suggesting the 'static lifetime results from attempting to create a dangling
+reference or a mismatch of the available lifetimes. In such cases, the solution
+is to fix those problems, not to specify the 'static lifetime.
Let’s briefly look at the syntax of specifying generic type parameters, trait
+bounds, and lifetimes all in one function!
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest_with_an_announcement(
+ string1.as_str(),
+ string2,
+ "Today is someone's birthday!",
+ );
+ println!("The longest string is {result}");
+}
+
+use std::fmt::Display;
+
+fn longest_with_an_announcement<'a, T>(
+ x: &'a str,
+ y: &'a str,
+ ann: T,
+) -> &'a str
+where
+ T: Display,
+{
+ println!("Announcement! {ann}");
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
This is the longest function from Listing 10-21 that returns the longer of
+two string slices. But now it has an extra parameter named ann of the generic
+type T, which can be filled in by any type that implements the Display
+trait as specified by the where clause. This extra parameter will be printed
+using {}, which is why the Display trait bound is necessary. Because
+lifetimes are a type of generic, the declarations of the lifetime parameter
+'a and the generic type parameter T go in the same list inside the angle
+brackets after the function name.
We covered a lot in this chapter! Now that you know about generic type
+parameters, traits and trait bounds, and generic lifetime parameters, you’re
+ready to write code without repetition that works in many different situations.
+Generic type parameters let you apply the code to different types. Traits and
+trait bounds ensure that even though the types are generic, they’ll have the
+behavior the code needs. You learned how to use lifetime annotations to ensure
+that this flexible code won’t have any dangling references. And all of this
+analysis happens at compile time, which doesn’t affect runtime performance!
+
Believe it or not, there is much more to learn on the topics we discussed in
+this chapter: Chapter 17 discusses trait objects, which are another way to use
+traits. There are also more complex scenarios involving lifetime annotations
+that you will only need in very advanced scenarios; for those, you should read
+the Rust Reference. But next, you’ll learn how to write tests in
+Rust so you can make sure your code is working the way it should.
In his 1972 essay “The Humble Programmer,” Edsger W. Dijkstra said that
+“Program testing can be a very effective way to show the presence of bugs, but
+it is hopelessly inadequate for showing their absence.” That doesn’t mean we
+shouldn’t try to test as much as we can!
+
Correctness in our programs is the extent to which our code does what we intend
+it to do. Rust is designed with a high degree of concern about the correctness
+of programs, but correctness is complex and not easy to prove. Rust’s type
+system shoulders a huge part of this burden, but the type system cannot catch
+everything. As such, Rust includes support for writing automated software tests.
+
Say we write a function add_two that adds 2 to whatever number is passed to
+it. This function’s signature accepts an integer as a parameter and returns an
+integer as a result. When we implement and compile that function, Rust does all
+the type checking and borrow checking that you’ve learned so far to ensure
+that, for instance, we aren’t passing a String value or an invalid reference
+to this function. But Rust can’t check that this function will do precisely
+what we intend, which is return the parameter plus 2 rather than, say, the
+parameter plus 10 or the parameter minus 50! That’s where tests come in.
+
We can write tests that assert, for example, that when we pass 3 to the
+add_two function, the returned value is 5. We can run these tests whenever
+we make changes to our code to make sure any existing correct behavior has not
+changed.
+
Testing is a complex skill: although we can’t cover every detail about how to
+write good tests in one chapter, we’ll discuss the mechanics of Rust’s testing
+facilities. We’ll talk about the annotations and macros available to you when
+writing your tests, the default behavior and options provided for running your
+tests, and how to organize tests into unit tests and integration tests.
Tests are Rust functions that verify that the non-test code is functioning in
+the expected manner. The bodies of test functions typically perform these three
+actions:
+
+
Set up any needed data or state.
+
Run the code you want to test.
+
Assert the results are what you expect.
+
+
Let’s look at the features Rust provides specifically for writing tests that
+take these actions, which include the test attribute, a few macros, and the
+should_panic attribute.
At its simplest, a test in Rust is a function that’s annotated with the test
+attribute. Attributes are metadata about pieces of Rust code; one example is
+the derive attribute we used with structs in Chapter 5. To change a function
+into a test function, add #[test] on the line before fn. When you run your
+tests with the cargo test command, Rust builds a test runner binary that runs
+the annotated functions and reports on whether each
+test function passes or fails.
+
Whenever we make a new library project with Cargo, a test module with a test
+function in it is automatically generated for us. This module gives you a
+template for writing your tests so you don’t have to look up the exact
+structure and syntax every time you start a new project. You can add as many
+additional test functions and as many test modules as you want!
+
We’ll explore some aspects of how tests work by experimenting with the template
+test before we actually test any code. Then we’ll write some real-world tests
+that call some code that we’ve written and assert that its behavior is correct.
+
Let’s create a new library project called adder that will add two numbers:
+
$ cargo new adder --lib
+ Created library `adder` project
+$ cd adder
+
+
The contents of the src/lib.rs file in your adder library should look like
+Listing 11-1.
+
+Filename: src/lib.rs
+
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn it_works() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+}
+Listing 11-1: The test module and function generated automatically by cargo new
+
+
For now, let’s focus solely on the it_works() function. Note the
+#[test] annotation: this attribute indicates this is a test function, so the
+test runner knows to treat this function as a test. We might also have non-test
+functions in the tests module to help set up common scenarios or perform
+common operations, so we always need to indicate which functions are tests.
+
The example function body uses the assert_eq! macro to assert that result,
+which contains the result of adding 2 and 2, equals 4. This assertion serves as
+an example of the format for a typical test. Let’s run it to see that this test
+passes.
+
The cargo test command runs all tests in our project, as shown in Listing
+11-2.
+
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.57s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::it_works ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+Listing 11-2: The output from running the automatically generated test
+
+
Cargo compiled and ran the test. We see the line running 1 test. The next
+line shows the name of the generated test function, called it_works, and that
+the result of running that test is ok. The overall summary test result: ok.
+means that all the tests passed, and the portion that reads 1 passed; 0 failed totals the number of tests that passed or failed.
+
It’s possible to mark a test as ignored so it doesn’t run in a particular
+instance; we’ll cover that in the “Ignoring Some Tests Unless Specifically
+Requested” section later in this chapter. Because we
+haven’t done that here, the summary shows 0 ignored. We can also pass an
+argument to the cargo test command to run only tests whose name matches a
+string; this is called filtering and we’ll cover that in the “Running a
+Subset of Tests by Name” section. We also haven’t
+filtered the tests being run, so the end of the summary shows 0 filtered out.
+
The 0 measured statistic is for benchmark tests that measure performance.
+Benchmark tests are, as of this writing, only available in nightly Rust. See
+the documentation about benchmark tests to learn more.
+
The next part of the test output starting at Doc-tests adder is for the
+results of any documentation tests. We don’t have any documentation tests yet,
+but Rust can compile any code examples that appear in our API documentation.
+This feature helps keep your docs and your code in sync! We’ll discuss how to
+write documentation tests in the “Documentation Comments as
+Tests” section of Chapter 14. For now, we’ll
+ignore the Doc-tests output.
+
Let’s start to customize the test to our own needs. First change the name of
+the it_works function to a different name, such as exploration, like so:
+
Filename: src/lib.rs
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn exploration() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+}
+
Then run cargo test again. The output now shows exploration instead of
+it_works:
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.59s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::exploration ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
Now we’ll add another test, but this time we’ll make a test that fails! Tests
+fail when something in the test function panics. Each test is run in a new
+thread, and when the main thread sees that a test thread has died, the test is
+marked as failed. In Chapter 9, we talked about how the simplest way to panic
+is to call the panic! macro. Enter the new test as a function named
+another, so your src/lib.rs file looks like Listing 11-3.
+
+Filename: src/lib.rs
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn exploration() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+
+ #[test]
+ fn another() {
+ panic!("Make this test fail");
+ }
+}
+Listing 11-3: Adding a second test that will fail because we call the panic! macro
+
+
Run the tests again using cargo test. The output should look like Listing
+11-4, which shows that our exploration test passed and another failed.
+
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.72s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 2 tests
+test tests::another ... FAILED
+test tests::exploration ... ok
+
+failures:
+
+---- tests::another stdout ----
+thread 'tests::another' panicked at src/lib.rs:17:9:
+Make this test fail
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::another
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+Listing 11-4: Test results when one test passes and one test fails
+
+
Instead of ok, the line test tests::another shows FAILED. Two new
+sections appear between the individual results and the summary: the first
+displays the detailed reason for each test failure. In this case, we get the
+details that another failed because it panicked at 'Make this test fail' on
+line 10 in the src/lib.rs file. The next section lists just the names of all
+the failing tests, which is useful when there are lots of tests and lots of
+detailed failing test output. We can use the name of a failing test to run just
+that test to more easily debug it; we’ll talk more about ways to run tests in
+the “Controlling How Tests Are Run” section.
+
The summary line displays at the end: overall, our test result is FAILED. We
+had one test pass and one test fail.
+
Now that you’ve seen what the test results look like in different scenarios,
+let’s look at some macros other than panic! that are useful in tests.
The assert! macro, provided by the standard library, is useful when you want
+to ensure that some condition in a test evaluates to true. We give the
+assert! macro an argument that evaluates to a Boolean. If the value is
+true, nothing happens and the test passes. If the value is false, the
+assert! macro calls panic! to cause the test to fail. Using the assert!
+macro helps us check that our code is functioning in the way we intend.
+
In Chapter 5, Listing 5-15, we used a Rectangle struct and a can_hold
+method, which are repeated here in Listing 11-5. Let’s put this code in the
+src/lib.rs file, then write some tests for it using the assert! macro.
+Listing 11-5: The Rectangle struct and its can_hold method from Chapter 5
+
+
The can_hold method returns a Boolean, which means it’s a perfect use case
+for the assert! macro. In Listing 11-6, we write a test that exercises the
+can_hold method by creating a Rectangle instance that has a width of 8 and
+a height of 7 and asserting that it can hold another Rectangle instance that
+has a width of 5 and a height of 1.
+Listing 11-6: A test for can_hold that checks whether a larger rectangle can indeed hold a smaller rectangle
+
+
Note that we’ve added a new line inside the tests module: use super::*;.
+The tests module is a regular module that follows the usual visibility rules
+we covered in Chapter 7 in the “Paths for Referring to an Item in the Module
+Tree”
+section. Because the tests module is an inner module, we need to bring the
+code under test in the outer module into the scope of the inner module. We use
+a glob here so anything we define in the outer module is available to this
+tests module.
+
We’ve named our test larger_can_hold_smaller, and we’ve created the two
+Rectangle instances that we need. Then we called the assert! macro and
+passed it the result of calling larger.can_hold(&smaller). This expression is
+supposed to return true, so our test should pass. Let’s find out!
+
$ cargo test
+ Compiling rectangle v0.1.0 (file:///projects/rectangle)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
+ Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e)
+
+running 1 test
+test tests::larger_can_hold_smaller ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests rectangle
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
It does pass! Let’s add another test, this time asserting that a smaller
+rectangle cannot hold a larger rectangle:
Because the correct result of the can_hold function in this case is false,
+we need to negate that result before we pass it to the assert! macro. As a
+result, our test will pass if can_hold returns false:
Two tests that pass! Now let’s see what happens to our test results when we
+introduce a bug in our code. We’ll change the implementation of the can_hold
+method by replacing the greater-than sign with a less-than sign when it
+compares the widths:
$ cargo test
+ Compiling rectangle v0.1.0 (file:///projects/rectangle)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
+ Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e)
+
+running 2 tests
+test tests::larger_can_hold_smaller ... FAILED
+test tests::smaller_cannot_hold_larger ... ok
+
+failures:
+
+---- tests::larger_can_hold_smaller stdout ----
+thread 'tests::larger_can_hold_smaller' panicked at src/lib.rs:28:9:
+assertion failed: larger.can_hold(&smaller)
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::larger_can_hold_smaller
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Our tests caught the bug! Because larger.width is 8 and smaller.width is
+5, the comparison of the widths in can_hold now returns false: 8 is not
+less than 5.
A common way to verify functionality is to test for equality between the result
+of the code under test and the value you expect the code to return. You could
+do this using the assert! macro and passing it an expression using the ==
+operator. However, this is such a common test that the standard library
+provides a pair of macros—assert_eq! and assert_ne!—to perform this test
+more conveniently. These macros compare two arguments for equality or
+inequality, respectively. They’ll also print the two values if the assertion
+fails, which makes it easier to see why the test failed; conversely, the
+assert! macro only indicates that it got a false value for the ==
+expression, without printing the values that led to the false value.
+
In Listing 11-7, we write a function named add_two that adds 2 to its
+parameter, then we test this function using the assert_eq! macro.
+Listing 11-7: Testing the function add_two using the assert_eq! macro
+
+
Let’s check that it passes!
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
We pass 4 as the argument to assert_eq!, which is equal to the result of
+calling add_two(2). The line for this test is test tests::it_adds_two ... ok, and the ok text indicates that our test passed!
+
Let’s introduce a bug into our code to see what assert_eq! looks like when it
+fails. Change the implementation of the add_two function to instead add 3:
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::it_adds_two ... FAILED
+
+failures:
+
+---- tests::it_adds_two stdout ----
+assertion `left == right` failed
+ left: 5
+ right: 4
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::it_adds_two
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Our test caught the bug! The it_adds_two test failed, and the message tells
+us that the assertion that fails was assertion `left == right` failed
+and what the left and right values are. This message helps us start
+debugging: the left argument was 4 but the right argument, where we had
+add_two(2), was 5. You can imagine that this would be especially helpful
+when we have a lot of tests going on.
+
Note that in some languages and test frameworks, the parameters to equality
+assertion functions are called expected and actual, and the order in which
+we specify the arguments matters. However, in Rust, they’re called left and
+right, and the order in which we specify the value we expect and the value
+the code produces doesn’t matter. We could write the assertion in this test as
+assert_eq!(4, add_two(2)), which would result in the same failure message
+that displays assertion failed: `(left == right)`.
+
The assert_ne! macro will pass if the two values we give it are not equal and
+fail if they’re equal. This macro is most useful for cases when we’re not sure
+what a value will be, but we know what the value definitely shouldn’t be.
+For example, if we’re testing a function that is guaranteed to change its input
+in some way, but the way in which the input is changed depends on the day of
+the week that we run our tests, the best thing to assert might be that the
+output of the function is not equal to the input.
+
Under the surface, the assert_eq! and assert_ne! macros use the operators
+== and !=, respectively. When the assertions fail, these macros print their
+arguments using debug formatting, which means the values being compared must
+implement the PartialEq and Debug traits. All primitive types and most of
+the standard library types implement these traits. For structs and enums that
+you define yourself, you’ll need to implement PartialEq to assert equality of
+those types. You’ll also need to implement Debug to print the values when the
+assertion fails. Because both traits are derivable traits, as mentioned in
+Listing 5-12 in Chapter 5, this is usually as straightforward as adding the
+#[derive(PartialEq, Debug)] annotation to your struct or enum definition. See
+Appendix C, “Derivable Traits,” for more
+details about these and other derivable traits.
You can also add a custom message to be printed with the failure message as
+optional arguments to the assert!, assert_eq!, and assert_ne! macros. Any
+arguments specified after the required arguments are passed along to the
+format! macro (discussed in Chapter 8 in the “Concatenation with the +
+Operator or the format!
+Macro”
+section), so you can pass a format string that contains {} placeholders and
+values to go in those placeholders. Custom messages are useful for documenting
+what an assertion means; when a test fails, you’ll have a better idea of what
+the problem is with the code.
+
For example, let’s say we have a function that greets people by name and we
+want to test that the name we pass into the function appears in the output:
The requirements for this program haven’t been agreed upon yet, and we’re
+pretty sure the Hello text at the beginning of the greeting will change. We
+decided we don’t want to have to update the test when the requirements change,
+so instead of checking for exact equality to the value returned from the
+greeting function, we’ll just assert that the output contains the text of the
+input parameter.
+
Now let’s introduce a bug into this code by changing greeting to exclude
+name to see what the default test failure looks like:
$ cargo test
+ Compiling greeter v0.1.0 (file:///projects/greeter)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.91s
+ Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a)
+
+running 1 test
+test tests::greeting_contains_name ... FAILED
+
+failures:
+
+---- tests::greeting_contains_name stdout ----
+thread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:
+assertion failed: result.contains("Carol")
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::greeting_contains_name
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
This result just indicates that the assertion failed and which line the
+assertion is on. A more useful failure message would print the value from the
+greeting function. Let’s add a custom failure message composed of a format
+string with a placeholder filled in with the actual value we got from the
+greeting function:
+
pub fn greeting(name: &str) -> String {
+ String::from("Hello!")
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn greeting_contains_name() {
+ let result = greeting("Carol");
+ assert!(
+ result.contains("Carol"),
+ "Greeting did not contain name, value was `{}`",
+ result
+ );
+ }
+}
+
Now when we run the test, we’ll get a more informative error message:
+
$ cargo test
+ Compiling greeter v0.1.0 (file:///projects/greeter)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.93s
+ Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a)
+
+running 1 test
+test tests::greeting_contains_name ... FAILED
+
+failures:
+
+---- tests::greeting_contains_name stdout ----
+thread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:
+Greeting did not contain name, value was `Hello!`
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::greeting_contains_name
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
We can see the value we actually got in the test output, which would help us
+debug what happened instead of what we were expecting to happen.
In addition to checking return values, it’s important to check that our code
+handles error conditions as we expect. For example, consider the Guess type
+that we created in Chapter 9, Listing 9-13. Other code that uses Guess
+depends on the guarantee that Guess instances will contain only values
+between 1 and 100. We can write a test that ensures that attempting to create a
+Guess instance with a value outside that range panics.
+
We do this by adding the attribute should_panic to our test function. The
+test passes if the code inside the function panics; the test fails if the code
+inside the function doesn’t panic.
+
Listing 11-8 shows a test that checks that the error conditions of Guess::new
+happen when we expect them to.
+
+Filename: src/lib.rs
+
pub struct Guess {
+ value: i32,
+}
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 || value > 100 {
+ panic!("Guess value must be between 1 and 100, got {value}.");
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+Listing 11-8: Testing that a condition will cause a panic!
+
+
We place the #[should_panic] attribute after the #[test] attribute and
+before the test function it applies to. Let’s look at the result when this test
+passes:
+
$ cargo test
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
+ Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
+
+running 1 test
+test tests::greater_than_100 - should panic ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests guessing_game
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
Looks good! Now let’s introduce a bug in our code by removing the condition
+that the new function will panic if the value is greater than 100:
+
pub struct Guess {
+ value: i32,
+}
+
+// --snip--
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 {
+ panic!("Guess value must be between 1 and 100, got {value}.");
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+
When we run the test in Listing 11-8, it will fail:
+
$ cargo test
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.62s
+ Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
+
+running 1 test
+test tests::greater_than_100 - should panic ... FAILED
+
+failures:
+
+---- tests::greater_than_100 stdout ----
+note: test did not panic as expected
+
+failures:
+ tests::greater_than_100
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
We don’t get a very helpful message in this case, but when we look at the test
+function, we see that it’s annotated with #[should_panic]. The failure we got
+means that the code in the test function did not cause a panic.
+
Tests that use should_panic can be imprecise. A should_panic test would
+pass even if the test panics for a different reason from the one we were
+expecting. To make should_panic tests more precise, we can add an optional
+expected parameter to the should_panic attribute. The test harness will
+make sure that the failure message contains the provided text. For example,
+consider the modified code for Guess in Listing 11-9 where the new function
+panics with different messages depending on whether the value is too small or
+too large.
+
+Filename: src/lib.rs
+
pub struct Guess {
+ value: i32,
+}
+
+// --snip--
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 {
+ panic!(
+ "Guess value must be greater than or equal to 1, got {value}."
+ );
+ } else if value > 100 {
+ panic!(
+ "Guess value must be less than or equal to 100, got {value}."
+ );
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic(expected = "less than or equal to 100")]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+Listing 11-9: Testing for a panic! with a panic message containing a specified substring
+
+
This test will pass because the value we put in the should_panic attribute’s
+expected parameter is a substring of the message that the Guess::new
+function panics with. We could have specified the entire panic message that we
+expect, which in this case would be Guess value must be less than or equal to 100, got 200. What you choose to specify depends on how much of the panic
+message is unique or dynamic and how precise you want your test to be. In this
+case, a substring of the panic message is enough to ensure that the code in the
+test function executes the else if value > 100 case.
+
To see what happens when a should_panic test with an expected message
+fails, let’s again introduce a bug into our code by swapping the bodies of the
+if value < 1 and the else if value > 100 blocks:
+
pub struct Guess {
+ value: i32,
+}
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 {
+ panic!(
+ "Guess value must be less than or equal to 100, got {value}."
+ );
+ } else if value > 100 {
+ panic!(
+ "Guess value must be greater than or equal to 1, got {value}."
+ );
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic(expected = "less than or equal to 100")]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+
This time when we run the should_panic test, it will fail:
+
$ cargo test
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
+ Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
+
+running 1 test
+test tests::greater_than_100 - should panic ... FAILED
+
+failures:
+
+---- tests::greater_than_100 stdout ----
+thread 'tests::greater_than_100' panicked at src/lib.rs:12:13:
+Guess value must be greater than or equal to 1, got 200.
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+note: panic did not contain expected string
+ panic message: `"Guess value must be greater than or equal to 1, got 200."`,
+ expected substring: `"less than or equal to 100"`
+
+failures:
+ tests::greater_than_100
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
The failure message indicates that this test did indeed panic as we expected,
+but the panic message did not include the expected string less than or equal to 100. The panic message that we did get in this case was Guess value must be greater than or equal to 1, got 200. Now we can start figuring out where
+our bug is!
Our tests so far all panic when they fail. We can also write tests that use
+Result<T, E>! Here’s the test from Listing 11-1, rewritten to use Result<T, E> and return an Err instead of panicking:
+
#[cfg(test)]
+mod tests {
+ #[test]
+ fn it_works() -> Result<(), String> {
+ if 2 + 2 == 4 {
+ Ok(())
+ } else {
+ Err(String::from("two plus two does not equal four"))
+ }
+ }
+}
+
The it_works function now has the Result<(), String> return type. In the
+body of the function, rather than calling the assert_eq! macro, we return
+Ok(()) when the test passes and an Err with a String inside when the test
+fails.
+
Writing tests so they return a Result<T, E> enables you to use the question
+mark operator in the body of tests, which can be a convenient way to write
+tests that should fail if any operation within them returns an Err variant.
+
You can’t use the #[should_panic] annotation on tests that use Result<T, E>. To assert that an operation returns an Err variant, don’t use the
+question mark operator on the Result<T, E> value. Instead, use
+assert!(value.is_err()).
+
Now that you know several ways to write tests, let’s look at what is happening
+when we run our tests and explore the different options we can use with cargo test.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch11-02-running-tests.html b/ch11-02-running-tests.html
new file mode 100644
index 0000000000..5fe201fcb3
--- /dev/null
+++ b/ch11-02-running-tests.html
@@ -0,0 +1,535 @@
+
+
+
+
+
+ Controlling How Tests Are Run - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Just as cargo run compiles your code and then runs the resulting binary,
+cargo test compiles your code in test mode and runs the resulting test
+binary. The default behavior of the binary produced by cargo test is to run
+all the tests in parallel and capture output generated during test runs,
+preventing the output from being displayed and making it easier to read the
+output related to the test results. You can, however, specify command line
+options to change this default behavior.
+
Some command line options go to cargo test, and some go to the resulting test
+binary. To separate these two types of arguments, you list the arguments that
+go to cargo test followed by the separator -- and then the ones that go to
+the test binary. Running cargo test --help displays the options you can use
+with cargo test, and running cargo test -- --help displays the options you
+can use after the separator.
When you run multiple tests, by default they run in parallel using threads,
+meaning they finish running faster and you get feedback quicker. Because the
+tests are running at the same time, you must make sure your tests don’t depend
+on each other or on any shared state, including a shared environment, such as
+the current working directory or environment variables.
+
For example, say each of your tests runs some code that creates a file on disk
+named test-output.txt and writes some data to that file. Then each test reads
+the data in that file and asserts that the file contains a particular value,
+which is different in each test. Because the tests run at the same time, one
+test might overwrite the file in the time between another test writing and
+reading the file. The second test will then fail, not because the code is
+incorrect but because the tests have interfered with each other while running
+in parallel. One solution is to make sure each test writes to a different file;
+another solution is to run the tests one at a time.
+
If you don’t want to run the tests in parallel or if you want more fine-grained
+control over the number of threads used, you can send the --test-threads flag
+and the number of threads you want to use to the test binary. Take a look at
+the following example:
+
$ cargo test -- --test-threads=1
+
+
We set the number of test threads to 1, telling the program not to use any
+parallelism. Running the tests using one thread will take longer than running
+them in parallel, but the tests won’t interfere with each other if they share
+state.
By default, if a test passes, Rust’s test library captures anything printed to
+standard output. For example, if we call println! in a test and the test
+passes, we won’t see the println! output in the terminal; we’ll see only the
+line that indicates the test passed. If a test fails, we’ll see whatever was
+printed to standard output with the rest of the failure message.
+
As an example, Listing 11-10 has a silly function that prints the value of its
+parameter and returns 10, as well as a test that passes and a test that fails.
+
+Filename: src/lib.rs
+
fn prints_and_returns_10(a: i32) -> i32 {
+ println!("I got the value {a}");
+ 10
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn this_test_will_pass() {
+ let value = prints_and_returns_10(4);
+ assert_eq!(10, value);
+ }
+
+ #[test]
+ fn this_test_will_fail() {
+ let value = prints_and_returns_10(8);
+ assert_eq!(5, value);
+ }
+}
+Listing 11-10: Tests for a function that calls println!
+
+
When we run these tests with cargo test, we’ll see the following output:
+
$ cargo test
+ Compiling silly-function v0.1.0 (file:///projects/silly-function)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
+ Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
+
+running 2 tests
+test tests::this_test_will_fail ... FAILED
+test tests::this_test_will_pass ... ok
+
+failures:
+
+---- tests::this_test_will_fail stdout ----
+I got the value 8
+thread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:
+assertion `left == right` failed
+ left: 5
+ right: 10
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::this_test_will_fail
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Note that nowhere in this output do we see I got the value 4, which is what
+is printed when the test that passes runs. That output has been captured. The
+output from the test that failed, I got the value 8, appears in the section
+of the test summary output, which also shows the cause of the test failure.
+
If we want to see printed values for passing tests as well, we can tell Rust
+to also show the output of successful tests with --show-output.
+
$ cargo test -- --show-output
+
+
When we run the tests in Listing 11-10 again with the --show-output flag, we
+see the following output:
+
$ cargo test -- --show-output
+ Compiling silly-function v0.1.0 (file:///projects/silly-function)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s
+ Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
+
+running 2 tests
+test tests::this_test_will_fail ... FAILED
+test tests::this_test_will_pass ... ok
+
+successes:
+
+---- tests::this_test_will_pass stdout ----
+I got the value 4
+
+
+successes:
+ tests::this_test_will_pass
+
+failures:
+
+---- tests::this_test_will_fail stdout ----
+I got the value 8
+thread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:
+assertion `left == right` failed
+ left: 5
+ right: 10
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::this_test_will_fail
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
Sometimes, running a full test suite can take a long time. If you’re working on
+code in a particular area, you might want to run only the tests pertaining to
+that code. You can choose which tests to run by passing cargo test the name
+or names of the test(s) you want to run as an argument.
+
To demonstrate how to run a subset of tests, we’ll first create three tests for
+our add_two function, as shown in Listing 11-11, and choose which ones to run.
We can pass the name of any test function to cargo test to run only that test:
+
$ cargo test one_hundred
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.69s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::one_hundred ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out; finished in 0.00s
+
+
+
Only the test with the name one_hundred ran; the other two tests didn’t match
+that name. The test output lets us know we had more tests that didn’t run by
+displaying 2 filtered out at the end.
+
We can’t specify the names of multiple tests in this way; only the first value
+given to cargo test will be used. But there is a way to run multiple tests.
We can specify part of a test name, and any test whose name matches that value
+will be run. For example, because two of our tests’ names contain add, we can
+run those two by running cargo test add:
+
$ cargo test add
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 2 tests
+test tests::add_three_and_two ... ok
+test tests::add_two_and_two ... ok
+
+test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
+
+
+
This command ran all tests with add in the name and filtered out the test
+named one_hundred. Also note that the module in which a test appears becomes
+part of the test’s name, so we can run all the tests in a module by filtering
+on the module’s name.
Sometimes a few specific tests can be very time-consuming to execute, so you
+might want to exclude them during most runs of cargo test. Rather than
+listing as arguments all tests you do want to run, you can instead annotate the
+time-consuming tests using the ignore attribute to exclude them, as shown
+here:
+
Filename: src/lib.rs
+
#[test]
+fn it_works() {
+ assert_eq!(2 + 2, 4);
+}
+
+#[test]
+#[ignore]
+fn expensive_test() {
+ // code that takes an hour to run
+}
+
After #[test] we add the #[ignore] line to the test we want to exclude. Now
+when we run our tests, it_works runs, but expensive_test doesn’t:
The expensive_test function is listed as ignored. If we want to run only
+the ignored tests, we can use cargo test -- --ignored:
+
$ cargo test -- --ignored
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test expensive_test ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
By controlling which tests run, you can make sure your cargo test results
+will be fast. When you’re at a point where it makes sense to check the results
+of the ignored tests and you have time to wait for the results, you can run
+cargo test -- --ignored instead. If you want to run all tests whether they’re
+ignored or not, you can run cargo test -- --include-ignored.
As mentioned at the start of the chapter, testing is a complex discipline, and
+different people use different terminology and organization. The Rust community
+thinks about tests in terms of two main categories: unit tests and integration
+tests. Unit tests are small and more focused, testing one module in isolation
+at a time, and can test private interfaces. Integration tests are entirely
+external to your library and use your code in the same way any other external
+code would, using only the public interface and potentially exercising multiple
+modules per test.
+
Writing both kinds of tests is important to ensure that the pieces of your
+library are doing what you expect them to, separately and together.
The purpose of unit tests is to test each unit of code in isolation from the
+rest of the code to quickly pinpoint where code is and isn’t working as
+expected. You’ll put unit tests in the src directory in each file with the
+code that they’re testing. The convention is to create a module named tests
+in each file to contain the test functions and to annotate the module with
+cfg(test).
The #[cfg(test)] annotation on the tests module tells Rust to compile and run
+the test code only when you run cargo test, not when you run cargo build.
+This saves compile time when you only want to build the library and saves space
+in the resulting compiled artifact because the tests are not included. You’ll
+see that because integration tests go in a different directory, they don’t need
+the #[cfg(test)] annotation. However, because unit tests go in the same files
+as the code, you’ll use #[cfg(test)] to specify that they shouldn’t be
+included in the compiled result.
+
Recall that when we generated the new adder project in the first section of
+this chapter, Cargo generated this code for us:
+
Filename: src/lib.rs
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn it_works() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+}
+
This code is the automatically generated test module. The attribute cfg
+stands for configuration and tells Rust that the following item should only
+be included given a certain configuration option. In this case, the
+configuration option is test, which is provided by Rust for compiling and
+running tests. By using the cfg attribute, Cargo compiles our test code only
+if we actively run the tests with cargo test. This includes any helper
+functions that might be within this module, in addition to the functions
+annotated with #[test].
There’s debate within the testing community about whether or not private
+functions should be tested directly, and other languages make it difficult or
+impossible to test private functions. Regardless of which testing ideology you
+adhere to, Rust’s privacy rules do allow you to test private functions.
+Consider the code in Listing 11-12 with the private function internal_adder.
Note that the internal_adder function is not marked as pub. Tests are just
+Rust code, and the tests module is just another module. As we discussed in
+the “Paths for Referring to an Item in the Module Tree”
+section, items in child modules can use the items in their ancestor modules. In
+this test, we bring all of the tests module’s parent’s items into scope with
+use super::*, and then the test can call internal_adder. If you don’t think
+private functions should be tested, there’s nothing in Rust that will compel
+you to do so.
In Rust, integration tests are entirely external to your library. They use your
+library in the same way any other code would, which means they can only call
+functions that are part of your library’s public API. Their purpose is to test
+whether many parts of your library work together correctly. Units of code that
+work correctly on their own could have problems when integrated, so test
+coverage of the integrated code is important as well. To create integration
+tests, you first need a tests directory.
We create a tests directory at the top level of our project directory, next
+to src. Cargo knows to look for integration test files in this directory. We
+can then make as many test files as we want, and Cargo will compile each of the
+files as an individual crate.
+
Let’s create an integration test. With the code in Listing 11-12 still in the
+src/lib.rs file, make a tests directory, and create a new file named
+tests/integration_test.rs. Your directory structure should look like this:
+Listing 11-13: An integration test of a function in the adder crate
+
+
Each file in the tests directory is a separate crate, so we need to bring our
+library into each test crate’s scope. For that reason we add use adder::add_two at the top of the code, which we didn’t need in the unit
+tests.
+
We don’t need to annotate any code in tests/integration_test.rs with
+#[cfg(test)]. Cargo treats the tests directory specially and compiles files
+in this directory only when we run cargo test. Run cargo test now:
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 1.31s
+ Running unittests src/lib.rs (target/debug/deps/adder-1082c4b063a8fbe6)
+
+running 1 test
+test tests::internal ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running tests/integration_test.rs (target/debug/deps/integration_test-1082c4b063a8fbe6)
+
+running 1 test
+test it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
The three sections of output include the unit tests, the integration test, and
+the doc tests. Note that if any test in a section fails, the following sections
+will not be run. For example, if a unit test fails, there won’t be any output
+for integration and doc tests because those tests will only be run if all unit
+tests are passing.
+
The first section for the unit tests is the same as we’ve been seeing: one line
+for each unit test (one named internal that we added in Listing 11-12) and
+then a summary line for the unit tests.
+
The integration tests section starts with the line Running tests/integration_test.rs. Next, there is a line for each test function in
+that integration test and a summary line for the results of the integration
+test just before the Doc-tests adder section starts.
+
Each integration test file has its own section, so if we add more files in the
+tests directory, there will be more integration test sections.
+
We can still run a particular integration test function by specifying the test
+function’s name as an argument to cargo test. To run all the tests in a
+particular integration test file, use the --test argument of cargo test
+followed by the name of the file:
+
$ cargo test --test integration_test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.64s
+ Running tests/integration_test.rs (target/debug/deps/integration_test-82e7799c1bc62298)
+
+running 1 test
+test it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
This command runs only the tests in the tests/integration_test.rs file.
As you add more integration tests, you might want to make more files in the
+tests directory to help organize them; for example, you can group the test
+functions by the functionality they’re testing. As mentioned earlier, each file
+in the tests directory is compiled as its own separate crate, which is useful
+for creating separate scopes to more closely imitate the way end users will be
+using your crate. However, this means files in the tests directory don’t
+share the same behavior as files in src do, as you learned in Chapter 7
+regarding how to separate code into modules and files.
+
The different behavior of tests directory files is most noticeable when you
+have a set of helper functions to use in multiple integration test files and
+you try to follow the steps in the “Separating Modules into Different
+Files” section of Chapter 7 to
+extract them into a common module. For example, if we create tests/common.rs
+and place a function named setup in it, we can add some code to setup that
+we want to call from multiple test functions in multiple test files:
+
Filename: tests/common.rs
+
pub fn setup() {
+ // setup code specific to your library's tests would go here
+}
+
When we run the tests again, we’ll see a new section in the test output for the
+common.rs file, even though this file doesn’t contain any test functions nor
+did we call the setup function from anywhere:
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.89s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::internal ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running tests/common.rs (target/debug/deps/common-92948b65e88960b4)
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running tests/integration_test.rs (target/debug/deps/integration_test-92948b65e88960b4)
+
+running 1 test
+test it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
Having common appear in the test results with running 0 tests displayed for
+it is not what we wanted. We just wanted to share some code with the other
+integration test files.
+
To avoid having common appear in the test output, instead of creating
+tests/common.rs, we’ll create tests/common/mod.rs. The project directory
+now looks like this:
This is the older naming convention that Rust also understands that we
+mentioned in the “Alternate File Paths” section of
+Chapter 7. Naming the file this way tells Rust not to treat the common module
+as an integration test file. When we move the setup function code into
+tests/common/mod.rs and delete the tests/common.rs file, the section in the
+test output will no longer appear. Files in subdirectories of the tests
+directory don’t get compiled as separate crates or have sections in the test
+output.
+
After we’ve created tests/common/mod.rs, we can use it from any of the
+integration test files as a module. Here’s an example of calling the setup
+function from the it_adds_two test in tests/integration_test.rs:
Note that the mod common; declaration is the same as the module declaration
+we demonstrated in Listing 7-21. Then in the test function, we can call the
+common::setup() function.
If our project is a binary crate that only contains a src/main.rs file and
+doesn’t have a src/lib.rs file, we can’t create integration tests in the
+tests directory and bring functions defined in the src/main.rs file into
+scope with a use statement. Only library crates expose functions that other
+crates can use; binary crates are meant to be run on their own.
+
This is one of the reasons Rust projects that provide a binary have a
+straightforward src/main.rs file that calls logic that lives in the
+src/lib.rs file. Using that structure, integration tests can test the
+library crate with use to make the important functionality available.
+If the important functionality works, the small amount of code in the
+src/main.rs file will work as well, and that small amount of code doesn’t
+need to be tested.
Rust’s testing features provide a way to specify how code should function to
+ensure it continues to work as you expect, even as you make changes. Unit tests
+exercise different parts of a library separately and can test private
+implementation details. Integration tests check that many parts of the library
+work together correctly, and they use the library’s public API to test the code
+in the same way external code will use it. Even though Rust’s type system and
+ownership rules help prevent some kinds of bugs, tests are still important to
+reduce logic bugs having to do with how your code is expected to behave.
+
Let’s combine the knowledge you learned in this chapter and in previous
+chapters to work on a project!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch12-00-an-io-project.html b/ch12-00-an-io-project.html
new file mode 100644
index 0000000000..d58fb9f3f8
--- /dev/null
+++ b/ch12-00-an-io-project.html
@@ -0,0 +1,272 @@
+
+
+
+
+
+ An I/O Project: Building a Command Line Program - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This chapter is a recap of the many skills you’ve learned so far and an
+exploration of a few more standard library features. We’ll build a command line
+tool that interacts with file and command line input/output to practice some of
+the Rust concepts you now have under your belt.
+
Rust’s speed, safety, single binary output, and cross-platform support make it
+an ideal language for creating command line tools, so for our project, we’ll
+make our own version of the classic command line search tool grep
+(globally search a regular expression and print). In the
+simplest use case, grep searches a specified file for a specified string. To
+do so, grep takes as its arguments a file path and a string. Then it reads
+the file, finds lines in that file that contain the string argument, and prints
+those lines.
+
Along the way, we’ll show how to make our command line tool use the terminal
+features that many other command line tools use. We’ll read the value of an
+environment variable to allow the user to configure the behavior of our tool.
+We’ll also print error messages to the standard error console stream (stderr)
+instead of standard output (stdout), so, for example, the user can redirect
+successful output to a file while still seeing error messages onscreen.
+
One Rust community member, Andrew Gallant, has already created a fully
+featured, very fast version of grep, called ripgrep. By comparison, our
+version will be fairly simple, but this chapter will give you some of the
+background knowledge you need to understand a real-world project such as
+ripgrep.
+
Our grep project will combine a number of concepts you’ve learned so far:
+
+
Organizing code (using what you learned about modules in Chapter 7)
+
Using vectors and strings (collections, Chapter 8)
Let’s create a new project with, as always, cargo new. We’ll call our project
+minigrep to distinguish it from the grep tool that you might already have
+on your system.
+
$ cargo new minigrep
+ Created binary (application) `minigrep` project
+$ cd minigrep
+
+
The first task is to make minigrep accept its two command line arguments: the
+file path and a string to search for. That is, we want to be able to run our
+program with cargo run, two hyphens to indicate the following arguments are
+for our program rather than for cargo, a string to search for, and a path to
+a file to search in, like so:
+
$ cargo run -- searchstring example-filename.txt
+
+
Right now, the program generated by cargo new cannot process arguments we
+give it. Some existing libraries on crates.io can help
+with writing a program that accepts command line arguments, but because you’re
+just learning this concept, let’s implement this capability ourselves.
To enable minigrep to read the values of command line arguments we pass to
+it, we’ll need the std::env::args function provided in Rust’s standard
+library. This function returns an iterator of the command line arguments passed
+to minigrep. We’ll cover iterators fully in Chapter 13. For now, you only need to know two details about iterators: iterators
+produce a series of values, and we can call the collect method on an iterator
+to turn it into a collection, such as a vector, that contains all the elements
+the iterator produces.
+
The code in Listing 12-1 allows your minigrep program to read any command
+line arguments passed to it and then collect the values into a vector.
+
+Filename: src/main.rs
+
use std::env;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+ dbg!(args);
+}
+Listing 12-1: Collecting the command line arguments into a vector and printing them
+
+
First, we bring the std::env module into scope with a use statement so we
+can use its args function. Notice that the std::env::args function is
+nested in two levels of modules. As we discussed in Chapter
+7, in cases where the desired function is
+nested in more than one module, we’ve chosen to bring the parent module into
+scope rather than the function. By doing so, we can easily use other functions
+from std::env. It’s also less ambiguous than adding use std::env::args and
+then calling the function with just args, because args might easily be
+mistaken for a function that’s defined in the current module.
Note that std::env::args will panic if any argument contains invalid
+Unicode. If your program needs to accept arguments containing invalid
+Unicode, use std::env::args_os instead. That function returns an iterator
+that produces OsString values instead of String values. We’ve chosen to
+use std::env::args here for simplicity, because OsString values differ
+per platform and are more complex to work with than String values.
+
+
On the first line of main, we call env::args, and we immediately use
+collect to turn the iterator into a vector containing all the values produced
+by the iterator. We can use the collect function to create many kinds of
+collections, so we explicitly annotate the type of args to specify that we
+want a vector of strings. Although we very rarely need to annotate types in
+Rust, collect is one function you do often need to annotate because Rust
+isn’t able to infer the kind of collection you want.
+
Finally, we print the vector using the debug macro. Let’s try running the code
+first with no arguments and then with two arguments:
Notice that the first value in the vector is "target/debug/minigrep", which
+is the name of our binary. This matches the behavior of the arguments list in
+C, letting programs use the name by which they were invoked in their execution.
+It’s often convenient to have access to the program name in case you want to
+print it in messages or change behavior of the program based on what command
+line alias was used to invoke the program. But for the purposes of this
+chapter, we’ll ignore it and save only the two arguments we need.
The program is currently able to access the values specified as command line
+arguments. Now we need to save the values of the two arguments in variables so
+we can use the values throughout the rest of the program. We do that in Listing
+12-2.
+
+Filename: src/main.rs
+
use std::env;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let query = &args[1];
+ let file_path = &args[2];
+
+ println!("Searching for {query}");
+ println!("In file {file_path}");
+}
+Listing 12-2: Creating variables to hold the query argument and file path argument
+
+
As we saw when we printed the vector, the program’s name takes up the first
+value in the vector at args[0], so we’re starting arguments at index 1. The
+first argument minigrep takes is the string we’re searching for, so we put a
+reference to the first argument in the variable query. The second argument
+will be the file path, so we put a reference to the second argument in the
+variable file_path.
+
We temporarily print the values of these variables to prove that the code is
+working as we intend. Let’s run this program again with the arguments test
+and sample.txt:
+
$ cargo run -- test sample.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep test sample.txt`
+Searching for test
+In file sample.txt
+
+
Great, the program is working! The values of the arguments we need are being
+saved into the right variables. Later we’ll add some error handling to deal
+with certain potential erroneous situations, such as when the user provides no
+arguments; for now, we’ll ignore that situation and work on adding file-reading
+capabilities instead.
Now we’ll add functionality to read the file specified in the file_path
+argument. First, we need a sample file to test it with: we’ll use a file with a
+small amount of text over multiple lines with some repeated words. Listing 12-3
+has an Emily Dickinson poem that will work well! Create a file called
+poem.txt at the root level of your project, and enter the poem “I’m Nobody!
+Who are you?”
+
+Filename: poem.txt
+
I'm nobody! Who are you?
+Are you nobody, too?
+Then there's a pair of us - don't tell!
+They'd banish us, you know.
+
+How dreary to be somebody!
+How public, like a frog
+To tell your name the livelong day
+To an admiring bog!
+
+Listing 12-3: A poem by Emily Dickinson makes a good test case
+
+
With the text in place, edit src/main.rs and add code to read the file, as
+shown in Listing 12-4.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ // --snip--
+ let args: Vec<String> = env::args().collect();
+
+ let query = &args[1];
+ let file_path = &args[2];
+
+ println!("Searching for {query}");
+ println!("In file {file_path}");
+
+ let contents = fs::read_to_string(file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+Listing 12-4: Reading the contents of the file specified by the second argument
+
+
First, we bring in a relevant part of the standard library with a use
+statement: we need std::fs to handle files.
+
In main, the new statement fs::read_to_string takes the file_path, opens
+that file, and returns a std::io::Result<String> of the file’s contents.
+
After that, we again add a temporary println! statement that prints the value
+of contents after the file is read, so we can check that the program is
+working so far.
+
Let’s run this code with any string as the first command line argument (because
+we haven’t implemented the searching part yet) and the poem.txt file as the
+second argument:
+
$ cargo run -- the poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep the poem.txt`
+Searching for the
+In file poem.txt
+With text:
+I'm nobody! Who are you?
+Are you nobody, too?
+Then there's a pair of us - don't tell!
+They'd banish us, you know.
+
+How dreary to be somebody!
+How public, like a frog
+To tell your name the livelong day
+To an admiring bog!
+
+
+
Great! The code read and then printed the contents of the file. But the code
+has a few flaws. At the moment, the main function has multiple
+responsibilities: generally, functions are clearer and easier to maintain if
+each function is responsible for only one idea. The other problem is that we’re
+not handling errors as well as we could. The program is still small, so these
+flaws aren’t a big problem, but as the program grows, it will be harder to fix
+them cleanly. It’s good practice to begin refactoring early on when developing
+a program, because it’s much easier to refactor smaller amounts of code. We’ll
+do that next.
To improve our program, we’ll fix four problems that have to do with the
+program’s structure and how it’s handling potential errors. First, our main
+function now performs two tasks: it parses arguments and reads files. As our
+program grows, the number of separate tasks the main function handles will
+increase. As a function gains responsibilities, it becomes more difficult to
+reason about, harder to test, and harder to change without breaking one of its
+parts. It’s best to separate functionality so each function is responsible for
+one task.
+
This issue also ties into the second problem: although query and file_path
+are configuration variables to our program, variables like contents are used
+to perform the program’s logic. The longer main becomes, the more variables
+we’ll need to bring into scope; the more variables we have in scope, the harder
+it will be to keep track of the purpose of each. It’s best to group the
+configuration variables into one structure to make their purpose clear.
+
The third problem is that we’ve used expect to print an error message when
+reading the file fails, but the error message just prints Should have been able to read the file. Reading a file can fail in a number of ways: for
+example, the file could be missing, or we might not have permission to open it.
+Right now, regardless of the situation, we’d print the same error message for
+everything, which wouldn’t give the user any information!
+
Fourth, we use expect to handle an error, and if the user runs our program
+without specifying enough arguments, they’ll get an index out of bounds error
+from Rust that doesn’t clearly explain the problem. It would be best if all the
+error-handling code were in one place so future maintainers had only one place
+to consult the code if the error-handling logic needed to change. Having all the
+error-handling code in one place will also ensure that we’re printing messages
+that will be meaningful to our end users.
+
Let’s address these four problems by refactoring our project.
The organizational problem of allocating responsibility for multiple tasks to
+the main function is common to many binary projects. As a result, the Rust
+community has developed guidelines for splitting the separate concerns of a
+binary program when main starts getting large. This process has the following
+steps:
+
+
Split your program into a main.rs and a lib.rs and move your program’s
+logic to lib.rs.
+
As long as your command line parsing logic is small, it can remain in
+main.rs.
+
When the command line parsing logic starts getting complicated, extract it
+from main.rs and move it to lib.rs.
+
+
The responsibilities that remain in the main function after this process
+should be limited to the following:
+
+
Calling the command line parsing logic with the argument values
+
Setting up any other configuration
+
Calling a run function in lib.rs
+
Handling the error if run returns an error
+
+
This pattern is about separating concerns: main.rs handles running the
+program, and lib.rs handles all the logic of the task at hand. Because you
+can’t test the main function directly, this structure lets you test all of
+your program’s logic by moving it into functions in lib.rs. The code that
+remains in main.rs will be small enough to verify its correctness by reading
+it. Let’s rework our program by following this process.
We’ll extract the functionality for parsing arguments into a function that
+main will call to prepare for moving the command line parsing logic to
+src/lib.rs. Listing 12-5 shows the new start of main that calls a new
+function parse_config, which we’ll define in src/main.rs for the moment.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let (query, file_path) = parse_config(&args);
+
+ // --snip--
+
+ println!("Searching for {query}");
+ println!("In file {file_path}");
+
+ let contents = fs::read_to_string(file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+fn parse_config(args: &[String]) -> (&str, &str) {
+ let query = &args[1];
+ let file_path = &args[2];
+
+ (query, file_path)
+}
+Listing 12-5: Extracting a parse_config function from main
+
+
We’re still collecting the command line arguments into a vector, but instead of
+assigning the argument value at index 1 to the variable query and the
+argument value at index 2 to the variable file_path within the main
+function, we pass the whole vector to the parse_config function. The
+parse_config function then holds the logic that determines which argument
+goes in which variable and passes the values back to main. We still create
+the query and file_path variables in main, but main no longer has the
+responsibility of determining how the command line arguments and variables
+correspond.
+
This rework may seem like overkill for our small program, but we’re refactoring
+in small, incremental steps. After making this change, run the program again to
+verify that the argument parsing still works. It’s good to check your progress
+often, to help identify the cause of problems when they occur.
We can take another small step to improve the parse_config function further.
+At the moment, we’re returning a tuple, but then we immediately break that
+tuple into individual parts again. This is a sign that perhaps we don’t have
+the right abstraction yet.
+
Another indicator that shows there’s room for improvement is the config part
+of parse_config, which implies that the two values we return are related and
+are both part of one configuration value. We’re not currently conveying this
+meaning in the structure of the data other than by grouping the two values into
+a tuple; we’ll instead put the two values into one struct and give each of the
+struct fields a meaningful name. Doing so will make it easier for future
+maintainers of this code to understand how the different values relate to each
+other and what their purpose is.
+
Listing 12-6 shows the improvements to the parse_config function.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = parse_config(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ // --snip--
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+fn parse_config(args: &[String]) -> Config {
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Config { query, file_path }
+}
+Listing 12-6: Refactoring parse_config to return an instance of a Config struct
+
+
We’ve added a struct named Config defined to have fields named query and
+file_path. The signature of parse_config now indicates that it returns a
+Config value. In the body of parse_config, where we used to return
+string slices that reference String values in args, we now define Config
+to contain owned String values. The args variable in main is the owner of
+the argument values and is only letting the parse_config function borrow
+them, which means we’d violate Rust’s borrowing rules if Config tried to take
+ownership of the values in args.
+
There are a number of ways we could manage the String data; the easiest,
+though somewhat inefficient, route is to call the clone method on the values.
+This will make a full copy of the data for the Config instance to own, which
+takes more time and memory than storing a reference to the string data.
+However, cloning the data also makes our code very straightforward because we
+don’t have to manage the lifetimes of the references; in this circumstance,
+giving up a little performance to gain simplicity is a worthwhile trade-off.
There’s a tendency among many Rustaceans to avoid using clone to fix
+ownership problems because of its runtime cost. In
+Chapter 13, you’ll learn how to use more efficient
+methods in this type of situation. But for now, it’s okay to copy a few
+strings to continue making progress because you’ll make these copies only
+once and your file path and query string are very small. It’s better to have
+a working program that’s a bit inefficient than to try to hyperoptimize code
+on your first pass. As you become more experienced with Rust, it’ll be
+easier to start with the most efficient solution, but for now, it’s
+perfectly acceptable to call clone.
+
+
We’ve updated main so it places the instance of Config returned by
+parse_config into a variable named config, and we updated the code that
+previously used the separate query and file_path variables so it now uses
+the fields on the Config struct instead.
+
Now our code more clearly conveys that query and file_path are related and
+that their purpose is to configure how the program will work. Any code that
+uses these values knows to find them in the config instance in the fields
+named for their purpose.
So far, we’ve extracted the logic responsible for parsing the command line
+arguments from main and placed it in the parse_config function. Doing so
+helped us to see that the query and file_path values were related and that
+relationship should be conveyed in our code. We then added a Config struct to
+name the related purpose of query and file_path and to be able to return the
+values’ names as struct field names from the parse_config function.
+
So now that the purpose of the parse_config function is to create a Config
+instance, we can change parse_config from a plain function to a function
+named new that is associated with the Config struct. Making this change
+will make the code more idiomatic. We can create instances of types in the
+standard library, such as String, by calling String::new. Similarly, by
+changing parse_config into a new function associated with Config, we’ll
+be able to create instances of Config by calling Config::new. Listing 12-7
+shows the changes we need to make.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::new(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+
+ // --snip--
+}
+
+// --snip--
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ fn new(args: &[String]) -> Config {
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Config { query, file_path }
+ }
+}
+Listing 12-7: Changing parse_config into Config::new
+
+
We’ve updated main where we were calling parse_config to instead call
+Config::new. We’ve changed the name of parse_config to new and moved it
+within an impl block, which associates the new function with Config. Try
+compiling this code again to make sure it works.
Now we’ll work on fixing our error handling. Recall that attempting to access
+the values in the args vector at index 1 or index 2 will cause the program to
+panic if the vector contains fewer than three items. Try running the program
+without any arguments; it will look like this:
+
$ cargo run
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep`
+thread 'main' panicked at src/main.rs:27:21:
+index out of bounds: the len is 1 but the index is 1
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
The line index out of bounds: the len is 1 but the index is 1 is an error
+message intended for programmers. It won’t help our end users understand what
+they should do instead. Let’s fix that now.
In Listing 12-8, we add a check in the new function that will verify that the
+slice is long enough before accessing index 1 and 2. If the slice isn’t long
+enough, the program panics and displays a better error message.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::new(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ // --snip--
+ fn new(args: &[String]) -> Config {
+ if args.len() < 3 {
+ panic!("not enough arguments");
+ }
+ // --snip--
+
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Config { query, file_path }
+ }
+}
+Listing 12-8: Adding a check for the number of arguments
+
+
This code is similar to the Guess::new function we wrote in Listing
+9-13, where we called panic! when the
+value argument was out of the range of valid values. Instead of checking for
+a range of values here, we’re checking that the length of args is at least 3
+and the rest of the function can operate under the assumption that this
+condition has been met. If args has fewer than three items, this condition
+will be true, and we call the panic! macro to end the program immediately.
+
With these extra few lines of code in new, let’s run the program without any
+arguments again to see what the error looks like now:
+
$ cargo run
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep`
+thread 'main' panicked at src/main.rs:26:13:
+not enough arguments
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
This output is better: we now have a reasonable error message. However, we also
+have extraneous information we don’t want to give to our users. Perhaps using
+the technique we used in Listing 9-13 isn’t the best to use here: a call to
+panic! is more appropriate for a programming problem than a usage problem,
+as discussed in Chapter 9. Instead,
+we’ll use the other technique you learned about in Chapter 9—returning a
+Result that indicates either success or an error.
We can instead return a Result value that will contain a Config instance in
+the successful case and will describe the problem in the error case. We’re also
+going to change the function name from new to build because many
+programmers expect new functions to never fail. When Config::build is
+communicating to main, we can use the Result type to signal there was a
+problem. Then we can change main to convert an Err variant into a more
+practical error for our users without the surrounding text about thread 'main' and RUST_BACKTRACE that a call to panic! causes.
+
Listing 12-9 shows the changes we need to make to the return value of the
+function we’re now calling Config::build and the body of the function needed
+to return a Result. Note that this won’t compile until we update main as
+well, which we’ll do in the next listing.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::new(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ fn build(args: &[String]) -> Result<Config, &'static str> {
+ if args.len() < 3 {
+ return Err("not enough arguments");
+ }
+
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Ok(Config { query, file_path })
+ }
+}
+Listing 12-9: Returning a Result from Config::build
+
+
Our build function returns a Result with a Config instance in the success
+case and a &'static str in the error case. Our error values will always be
+string literals that have the 'static lifetime.
+
We’ve made two changes in the body of the function: instead of calling panic!
+when the user doesn’t pass enough arguments, we now return an Err value, and
+we’ve wrapped the Config return value in an Ok. These changes make the
+function conform to its new type signature.
+
Returning an Err value from Config::build allows the main function to
+handle the Result value returned from the build function and exit the
+process more cleanly in the error case.
To handle the error case and print a user-friendly message, we need to update
+main to handle the Result being returned by Config::build, as shown in
+Listing 12-10. We’ll also take the responsibility of exiting the command line
+tool with a nonzero error code away from panic! and instead implement it by
+hand. A nonzero exit status is a convention to signal to the process that
+called our program that the program exited with an error state.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+use std::process;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::build(&args).unwrap_or_else(|err| {
+ println!("Problem parsing arguments: {err}");
+ process::exit(1);
+ });
+
+ // --snip--
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ fn build(args: &[String]) -> Result<Config, &'static str> {
+ if args.len() < 3 {
+ return Err("not enough arguments");
+ }
+
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Ok(Config { query, file_path })
+ }
+}
+Listing 12-10: Exiting with an error code if building a Config fails
+
+
In this listing, we’ve used a method we haven’t covered in detail yet:
+unwrap_or_else, which is defined on Result<T, E> by the standard library.
+Using unwrap_or_else allows us to define some custom, non-panic! error
+handling. If the Result is an Ok value, this method’s behavior is similar
+to unwrap: it returns the inner value Ok is wrapping. However, if the value
+is an Err value, this method calls the code in the closure, which is an
+anonymous function we define and pass as an argument to unwrap_or_else. We’ll
+cover closures in more detail in Chapter 13. For now,
+you just need to know that unwrap_or_else will pass the inner value of the
+Err, which in this case is the static string "not enough arguments" that we
+added in Listing 12-9, to our closure in the argument err that appears
+between the vertical pipes. The code in the closure can then use the err
+value when it runs.
+
We’ve added a new use line to bring process from the standard library into
+scope. The code in the closure that will be run in the error case is only two
+lines: we print the err value and then call process::exit. The
+process::exit function will stop the program immediately and return the
+number that was passed as the exit status code. This is similar to the
+panic!-based handling we used in Listing 12-8, but we no longer get all the
+extra output. Let’s try it:
+
$ cargo run
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.48s
+ Running `target/debug/minigrep`
+Problem parsing arguments: not enough arguments
+
+
Great! This output is much friendlier for our users.
Now that we’ve finished refactoring the configuration parsing, let’s turn to
+the program’s logic. As we stated in “Separation of Concerns for Binary
+Projects”, we’ll
+extract a function named run that will hold all the logic currently in the
+main function that isn’t involved with setting up configuration or handling
+errors. When we’re done, main will be concise and easy to verify by
+inspection, and we’ll be able to write tests for all the other logic.
+
Listing 12-11 shows the extracted run function. For now, we’re just making
+the small, incremental improvement of extracting the function. We’re still
+defining the function in src/main.rs.
+Listing 12-11: Extracting a run function containing the rest of the program logic
+
+
The run function now contains all the remaining logic from main, starting
+from reading the file. The run function takes the Config instance as an
+argument.
With the remaining program logic separated into the run function, we can
+improve the error handling, as we did with Config::build in Listing 12-9.
+Instead of allowing the program to panic by calling expect, the run
+function will return a Result<T, E> when something goes wrong. This will let
+us further consolidate the logic around handling errors into main in a
+user-friendly way. Listing 12-12 shows the changes we need to make to the
+signature and body of run.
+Listing 12-12: Changing the run function to return Result
+
+
We’ve made three significant changes here. First, we changed the return type of
+the run function to Result<(), Box<dyn Error>>. This function previously
+returned the unit type, (), and we keep that as the value returned in the
+Ok case.
+
For the error type, we used the trait objectBox<dyn Error> (and we’ve
+brought std::error::Error into scope with a use statement at the top).
+We’ll cover trait objects in Chapter 17. For now, just
+know that Box<dyn Error> means the function will return a type that
+implements the Error trait, but we don’t have to specify what particular type
+the return value will be. This gives us flexibility to return error values that
+may be of different types in different error cases. The dyn keyword is short
+for “dynamic.”
+
Second, we’ve removed the call to expect in favor of the ? operator, as we
+talked about in Chapter 9. Rather than
+panic! on an error, ? will return the error value from the current function
+for the caller to handle.
+
Third, the run function now returns an Ok value in the success case.
+We’ve declared the run function’s success type as () in the signature,
+which means we need to wrap the unit type value in the Ok value. This
+Ok(()) syntax might look a bit strange at first, but using () like this is
+the idiomatic way to indicate that we’re calling run for its side effects
+only; it doesn’t return a value we need.
+
When you run this code, it will compile but will display a warning:
+
$ cargo run -- the poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+warning: unused `Result` that must be used
+ --> src/main.rs:19:5
+ |
+19 | run(config);
+ | ^^^^^^^^^^^
+ |
+ = note: this `Result` may be an `Err` variant, which should be handled
+ = note: `#[warn(unused_must_use)]` on by default
+help: use `let _ = ...` to ignore the resulting value
+ |
+19 | let _ = run(config);
+ | +++++++
+
+warning: `minigrep` (bin "minigrep") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.71s
+ Running `target/debug/minigrep the poem.txt`
+Searching for the
+In file poem.txt
+With text:
+I'm nobody! Who are you?
+Are you nobody, too?
+Then there's a pair of us - don't tell!
+They'd banish us, you know.
+
+How dreary to be somebody!
+How public, like a frog
+To tell your name the livelong day
+To an admiring bog!
+
+
+
Rust tells us that our code ignored the Result value and the Result value
+might indicate that an error occurred. But we’re not checking to see whether or
+not there was an error, and the compiler reminds us that we probably meant to
+have some error-handling code here! Let’s rectify that problem now.
We use if let rather than unwrap_or_else to check whether run returns an
+Err value and call process::exit(1) if it does. The run function doesn’t
+return a value that we want to unwrap in the same way that Config::build
+returns the Config instance. Because run returns () in the success case,
+we only care about detecting an error, so we don’t need unwrap_or_else to
+return the unwrapped value, which would only be ().
+
The bodies of the if let and the unwrap_or_else functions are the same in
+both cases: we print the error and exit.
Our minigrep project is looking good so far! Now we’ll split the
+src/main.rs file and put some code into the src/lib.rs file. That way we
+can test the code and have a src/main.rs file with fewer responsibilities.
+
Let’s move all the code that isn’t the main function from src/main.rs to
+src/lib.rs:
+
+
The run function definition
+
The relevant use statements
+
The definition of Config
+
The Config::build function definition
+
+
The contents of src/lib.rs should have the signatures shown in Listing 12-13
+(we’ve omitted the bodies of the functions for brevity). Note that this won’t
+compile until we modify src/main.rs in Listing 12-14.
+Listing 12-13: Moving Config and run into src/lib.rs
+
+
We’ve made liberal use of the pub keyword: on Config, on its fields and its
+build method, and on the run function. We now have a library crate that has
+a public API we can test!
+
Now we need to bring the code we moved to src/lib.rs into the scope of the
+binary crate in src/main.rs, as shown in Listing 12-14.
+Listing 12-14: Using the minigrep library crate in src/main.rs
+
+
We add a use minigrep::Config line to bring the Config type from the
+library crate into the binary crate’s scope, and we prefix the run function
+with our crate name. Now all the functionality should be connected and should
+work. Run the program with cargo run and make sure everything works
+correctly.
+
Whew! That was a lot of work, but we’ve set ourselves up for success in the
+future. Now it’s much easier to handle errors, and we’ve made the code more
+modular. Almost all of our work will be done in src/lib.rs from here on out.
+
Let’s take advantage of this newfound modularity by doing something that would
+have been difficult with the old code but is easy with the new code: we’ll
+write some tests!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch12-04-testing-the-librarys-functionality.html b/ch12-04-testing-the-librarys-functionality.html
new file mode 100644
index 0000000000..901ec8ccc0
--- /dev/null
+++ b/ch12-04-testing-the-librarys-functionality.html
@@ -0,0 +1,765 @@
+
+
+
+
+
+ Developing the Library’s Functionality with Test Driven Development - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Now that we’ve extracted the logic into src/lib.rs and left the argument
+collecting and error handling in src/main.rs, it’s much easier to write tests
+for the core functionality of our code. We can call functions directly with
+various arguments and check return values without having to call our binary
+from the command line.
+
In this section, we’ll add the searching logic to the minigrep program
+using the test-driven development (TDD) process with the following steps:
+
+
Write a test that fails and run it to make sure it fails for the reason you
+expect.
+
Write or modify just enough code to make the new test pass.
+
Refactor the code you just added or changed and make sure the tests
+continue to pass.
+
Repeat from step 1!
+
+
Though it’s just one of many ways to write software, TDD can help drive code
+design. Writing the test before you write the code that makes the test pass
+helps to maintain high test coverage throughout the process.
+
We’ll test drive the implementation of the functionality that will actually do
+the searching for the query string in the file contents and produce a list of
+lines that match the query. We’ll add this functionality in a function called
+search.
Because we don’t need them anymore, let’s remove the println! statements from
+src/lib.rs and src/main.rs that we used to check the program’s behavior.
+Then, in src/lib.rs, add a tests module with a test function, as we did in
+Chapter 11. The test function specifies the
+behavior we want the search function to have: it will take a query and the
+text to search, and it will return only the lines from the text that contain
+the query. Listing 12-15 shows this test, which won’t compile yet.
+Listing 12-15: Creating a failing test for the search function we wish we had
+
+
This test searches for the string "duct". The text we’re searching is three
+lines, only one of which contains "duct" (Note that the backslash after the
+opening double quote tells Rust not to put a newline character at the beginning
+of the contents of this string literal). We assert that the value returned from
+the search function contains only the line we expect.
+
We aren’t yet able to run this test and watch it fail because the test doesn’t
+even compile: the search function doesn’t exist yet! In accordance with TDD
+principles, we’ll add just enough code to get the test to compile and run by
+adding a definition of the search function that always returns an empty
+vector, as shown in Listing 12-16. Then the test should compile and fail
+because an empty vector doesn’t match a vector containing the line "safe, fast, productive."
+Listing 12-16: Defining just enough of the search function so our test will compile
+
+
Notice that we need to define an explicit lifetime 'a in the signature of
+search and use that lifetime with the contents argument and the return
+value. Recall in Chapter 10 that the lifetime
+parameters specify which argument lifetime is connected to the lifetime of the
+return value. In this case, we indicate that the returned vector should contain
+string slices that reference slices of the argument contents (rather than the
+argument query).
+
In other words, we tell Rust that the data returned by the search function
+will live as long as the data passed into the search function in the
+contents argument. This is important! The data referenced by a slice needs
+to be valid for the reference to be valid; if the compiler assumes we’re making
+string slices of query rather than contents, it will do its safety checking
+incorrectly.
+
If we forget the lifetime annotations and try to compile this function, we’ll
+get this error:
+
$ cargo build
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+error[E0106]: missing lifetime specifier
+ --> src/lib.rs:28:51
+ |
+28 | pub fn search(query: &str, contents: &str) -> Vec<&str> {
+ | ---- ---- ^ expected named lifetime parameter
+ |
+ = help: this function's return type contains a borrowed value, but the signature does not say whether it is borrowed from `query` or `contents`
+help: consider introducing a named lifetime parameter
+ |
+28 | pub fn search<'a>(query: &'a str, contents: &'a str) -> Vec<&'a str> {
+ | ++++ ++ ++ ++
+
+For more information about this error, try `rustc --explain E0106`.
+error: could not compile `minigrep` (lib) due to 1 previous error
+
+
Rust can’t possibly know which of the two arguments we need, so we need to tell
+it explicitly. Because contents is the argument that contains all of our text
+and we want to return the parts of that text that match, we know contents is
+the argument that should be connected to the return value using the lifetime
+syntax.
+
Other programming languages don’t require you to connect arguments to return
+values in the signature, but this practice will get easier over time. You might
+want to compare this example with the “Validating References with
+Lifetimes” section in
+Chapter 10.
+
Now let’s run the test:
+
$ cargo test
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.97s
+ Running unittests src/lib.rs (target/debug/deps/minigrep-9cd200e5fac0fc94)
+
+running 1 test
+test tests::one_result ... FAILED
+
+failures:
+
+---- tests::one_result stdout ----
+thread 'tests::one_result' panicked at src/lib.rs:44:9:
+assertion `left == right` failed
+ left: ["safe, fast, productive."]
+ right: []
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::one_result
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Great, the test fails, exactly as we expected. Let’s get the test to pass!
Rust has a helpful method to handle line-by-line iteration of strings,
+conveniently named lines, that works as shown in Listing 12-17. Note this
+won’t compile yet.
+Listing 12-17: Iterating through each line in contents
+
+
The lines method returns an iterator. We’ll talk about iterators in depth in
+Chapter 13, but recall that you saw this way
+of using an iterator in Listing 3-5, where we used a
+for loop with an iterator to run some code on each item in a collection.
Next, we’ll check whether the current line contains our query string.
+Fortunately, strings have a helpful method named contains that does this for
+us! Add a call to the contains method in the search function, as shown in
+Listing 12-18. Note this still won’t compile yet.
+Listing 12-18: Adding functionality to see whether the line contains the string in query
+
+
At the moment, we’re building up functionality. To get it to compile, we need
+to return a value from the body as we indicated we would in the function
+signature.
To finish this function, we need a way to store the matching lines that we want
+to return. For that, we can make a mutable vector before the for loop and
+call the push method to store a line in the vector. After the for loop,
+we return the vector, as shown in Listing 12-19.
At this point, we could consider opportunities for refactoring the
+implementation of the search function while keeping the tests passing to
+maintain the same functionality. The code in the search function isn’t too bad,
+but it doesn’t take advantage of some useful features of iterators. We’ll
+return to this example in Chapter 13, where
+we’ll explore iterators in detail, and look at how to improve it.
Now that the search function is working and tested, we need to call search
+from our run function. We need to pass the config.query value and the
+contents that run reads from the file to the search function. Then run
+will print each line returned from search:
We’re still using a for loop to return each line from search and print it.
+
Now the entire program should work! Let’s try it out, first with a word that
+should return exactly one line from the Emily Dickinson poem, “frog”:
+
$ cargo run -- frog poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.38s
+ Running `target/debug/minigrep frog poem.txt`
+How public, like a frog
+
+
Cool! Now let’s try a word that will match multiple lines, like “body”:
+
$ cargo run -- body poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep body poem.txt`
+I'm nobody! Who are you?
+Are you nobody, too?
+How dreary to be somebody!
+
+
And finally, let’s make sure that we don’t get any lines when we search for a
+word that isn’t anywhere in the poem, such as “monomorphization”:
Excellent! We’ve built our own mini version of a classic tool and learned a lot
+about how to structure applications. We’ve also learned a bit about file input
+and output, lifetimes, testing, and command line parsing.
+
To round out this project, we’ll briefly demonstrate how to work with
+environment variables and how to print to standard error, both of which are
+useful when you’re writing command line programs.
We’ll improve minigrep by adding an extra feature: an option for
+case-insensitive searching that the user can turn on via an environment
+variable. We could make this feature a command line option and require that
+users enter it each time they want it to apply, but by instead making it an
+environment variable, we allow our users to set the environment variable once
+and have all their searches be case insensitive in that terminal session.
We first add a new search_case_insensitive function that will be called when
+the environment variable has a value. We’ll continue to follow the TDD process,
+so the first step is again to write a failing test. We’ll add a new test for
+the new search_case_insensitive function and rename our old test from
+one_result to case_sensitive to clarify the differences between the two
+tests, as shown in Listing 12-20.
+Listing 12-20: Adding a new failing test for the case-insensitive function we’re about to add
+
+
Note that we’ve edited the old test’s contents too. We’ve added a new line
+with the text "Duct tape." using a capital D that shouldn’t match the query
+"duct" when we’re searching in a case-sensitive manner. Changing the old test
+in this way helps ensure that we don’t accidentally break the case-sensitive
+search functionality that we’ve already implemented. This test should pass now
+and should continue to pass as we work on the case-insensitive search.
+
The new test for the case-insensitive search uses "rUsT" as its query. In
+the search_case_insensitive function we’re about to add, the query "rUsT"
+should match the line containing "Rust:" with a capital R and match the line
+"Trust me." even though both have different casing from the query. This is
+our failing test, and it will fail to compile because we haven’t yet defined
+the search_case_insensitive function. Feel free to add a skeleton
+implementation that always returns an empty vector, similar to the way we did
+for the search function in Listing 12-16 to see the test compile and fail.
The search_case_insensitive function, shown in Listing 12-21, will be almost
+the same as the search function. The only difference is that we’ll lowercase
+the query and each line so whatever the case of the input arguments,
+they’ll be the same case when we check whether the line contains the query.
+Listing 12-21: Defining the search_case_insensitive function to lowercase the query and the line before comparing them
+
+
First, we lowercase the query string and store it in a shadowed variable with
+the same name. Calling to_lowercase on the query is necessary so no
+matter whether the user’s query is "rust", "RUST", "Rust", or "rUsT",
+we’ll treat the query as if it were "rust" and be insensitive to the case.
+While to_lowercase will handle basic Unicode, it won’t be 100% accurate. If
+we were writing a real application, we’d want to do a bit more work here, but
+this section is about environment variables, not Unicode, so we’ll leave it at
+that here.
+
Note that query is now a String rather than a string slice, because calling
+to_lowercase creates new data rather than referencing existing data. Say the
+query is "rUsT", as an example: that string slice doesn’t contain a lowercase
+u or t for us to use, so we have to allocate a new String containing
+"rust". When we pass query as an argument to the contains method now, we
+need to add an ampersand because the signature of contains is defined to take
+a string slice.
+
Next, we add a call to to_lowercase on each line to lowercase all
+characters. Now that we’ve converted line and query to lowercase, we’ll
+find matches no matter what the case of the query is.
+
Let’s see if this implementation passes the tests:
Great! They passed. Now, let’s call the new search_case_insensitive function
+from the run function. First, we’ll add a configuration option to the
+Config struct to switch between case-sensitive and case-insensitive search.
+Adding this field will cause compiler errors because we aren’t initializing
+this field anywhere yet:
We added the ignore_case field that holds a Boolean. Next, we need the run
+function to check the ignore_case field’s value and use that to decide
+whether to call the search function or the search_case_insensitive
+function, as shown in Listing 12-22. This still won’t compile yet.
+Listing 12-22: Calling either search or search_case_insensitive based on the value in config.ignore_case
+
+
Finally, we need to check for the environment variable. The functions for
+working with environment variables are in the env module in the standard
+library, so we bring that module into scope at the top of src/lib.rs. Then
+we’ll use the var function from the env module to check if any value
+has been set for an environment variable named IGNORE_CASE, as shown in
+Listing 12-23.
+Listing 12-23: Checking for any value in an environment variable named IGNORE_CASE
+
+
Here, we create a new variable ignore_case. To set its value, we call the
+env::var function and pass it the name of the IGNORE_CASE environment
+variable. The env::var function returns a Result that will be the
+successful Ok variant that contains the value of the environment variable if
+the environment variable is set to any value. It will return the Err variant
+if the environment variable is not set.
+
We’re using the is_ok method on the Result to check whether the environment
+variable is set, which means the program should do a case-insensitive search.
+If the IGNORE_CASE environment variable isn’t set to anything, is_ok will
+return false and the program will perform a case-sensitive search. We don’t
+care about the value of the environment variable, just whether it’s set or
+unset, so we’re checking is_ok rather than using unwrap, expect, or any
+of the other methods we’ve seen on Result.
+
We pass the value in the ignore_case variable to the Config instance so the
+run function can read that value and decide whether to call
+search_case_insensitive or search, as we implemented in Listing 12-22.
+
Let’s give it a try! First, we’ll run our program without the environment
+variable set and with the query to, which should match any line that contains
+the word “to” in all lowercase:
+
$ cargo run -- to poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep to poem.txt`
+Are you nobody, too?
+How dreary to be somebody!
+
+
Looks like that still works! Now, let’s run the program with IGNORE_CASE
+set to 1 but with the same query to.
+
$ IGNORE_CASE=1 cargo run -- to poem.txt
+
+
If you’re using PowerShell, you will need to set the environment variable and
+run the program as separate commands:
+
PS> $Env:IGNORE_CASE=1; cargo run -- to poem.txt
+
+
This will make IGNORE_CASE persist for the remainder of your shell
+session. It can be unset with the Remove-Item cmdlet:
+
PS> Remove-Item Env:IGNORE_CASE
+
+
We should get lines that contain “to” that might have uppercase letters:
+
+
Are you nobody, too?
+How dreary to be somebody!
+To tell your name the livelong day
+To an admiring bog!
+
+
Excellent, we also got lines containing “To”! Our minigrep program can now do
+case-insensitive searching controlled by an environment variable. Now you know
+how to manage options set using either command line arguments or environment
+variables.
+
Some programs allow arguments and environment variables for the same
+configuration. In those cases, the programs decide that one or the other takes
+precedence. For another exercise on your own, try controlling case sensitivity
+through either a command line argument or an environment variable. Decide
+whether the command line argument or the environment variable should take
+precedence if the program is run with one set to case sensitive and one set to
+ignore case.
+
The std::env module contains many more useful features for dealing with
+environment variables: check out its documentation to see what is available.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch12-06-writing-to-stderr-instead-of-stdout.html b/ch12-06-writing-to-stderr-instead-of-stdout.html
new file mode 100644
index 0000000000..16b81a8a1b
--- /dev/null
+++ b/ch12-06-writing-to-stderr-instead-of-stdout.html
@@ -0,0 +1,327 @@
+
+
+
+
+
+ Writing Error Messages to Standard Error Instead of Standard Output - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
At the moment, we’re writing all of our output to the terminal using the
+println! macro. In most terminals, there are two kinds of output: standard
+output (stdout) for general information and standard error (stderr) for
+error messages. This distinction enables users to choose to direct the
+successful output of a program to a file but still print error messages to the
+screen.
+
The println! macro is only capable of printing to standard output, so we
+have to use something else to print to standard error.
First, let’s observe how the content printed by minigrep is currently being
+written to standard output, including any error messages we want to write to
+standard error instead. We’ll do that by redirecting the standard output stream
+to a file while intentionally causing an error. We won’t redirect the standard
+error stream, so any content sent to standard error will continue to display on
+the screen.
+
Command line programs are expected to send error messages to the standard error
+stream so we can still see error messages on the screen even if we redirect the
+standard output stream to a file. Our program is not currently well-behaved:
+we’re about to see that it saves the error message output to a file instead!
+
To demonstrate this behavior, we’ll run the program with > and the file path,
+output.txt, that we want to redirect the standard output stream to. We won’t
+pass any arguments, which should cause an error:
+
$ cargo run > output.txt
+
+
The > syntax tells the shell to write the contents of standard output to
+output.txt instead of the screen. We didn’t see the error message we were
+expecting printed to the screen, so that means it must have ended up in the
+file. This is what output.txt contains:
+
Problem parsing arguments: not enough arguments
+
+
Yup, our error message is being printed to standard output. It’s much more
+useful for error messages like this to be printed to standard error so only
+data from a successful run ends up in the file. We’ll change that.
We’ll use the code in Listing 12-24 to change how error messages are printed.
+Because of the refactoring we did earlier in this chapter, all the code that
+prints error messages is in one function, main. The standard library provides
+the eprintln! macro that prints to the standard error stream, so let’s change
+the two places we were calling println! to print errors to use eprintln!
+instead.
+
+Filename: src/main.rs
+
use std::env;
+use std::process;
+
+use minigrep::Config;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::build(&args).unwrap_or_else(|err| {
+ eprintln!("Problem parsing arguments: {err}");
+ process::exit(1);
+ });
+
+ if let Err(e) = minigrep::run(config) {
+ eprintln!("Application error: {e}");
+ process::exit(1);
+ }
+}
+Listing 12-24: Writing error messages to standard error instead of standard output using eprintln!
+
+
Let’s now run the program again in the same way, without any arguments and
+redirecting standard output with >:
+
$ cargo run > output.txt
+Problem parsing arguments: not enough arguments
+
+
Now we see the error onscreen and output.txt contains nothing, which is the
+behavior we expect of command line programs.
+
Let’s run the program again with arguments that don’t cause an error but still
+redirect standard output to a file, like so:
+
$ cargo run -- to poem.txt > output.txt
+
+
We won’t see any output to the terminal, and output.txt will contain our
+results:
+
Filename: output.txt
+
Are you nobody, too?
+How dreary to be somebody!
+
+
This demonstrates that we’re now using standard output for successful output
+and standard error for error output as appropriate.
This chapter recapped some of the major concepts you’ve learned so far and
+covered how to perform common I/O operations in Rust. By using command line
+arguments, files, environment variables, and the eprintln! macro for printing
+errors, you’re now prepared to write command line applications. Combined with
+the concepts in previous chapters, your code will be well organized, store data
+effectively in the appropriate data structures, handle errors nicely, and be
+well tested.
+
Next, we’ll explore some Rust features that were influenced by functional
+languages: closures and iterators.
Rust’s design has taken inspiration from many existing languages and
+techniques, and one significant influence is functional programming.
+Programming in a functional style often includes using functions as values by
+passing them in arguments, returning them from other functions, assigning them
+to variables for later execution, and so forth.
+
In this chapter, we won’t debate the issue of what functional programming is or
+isn’t but will instead discuss some features of Rust that are similar to
+features in many languages often referred to as functional.
+
More specifically, we’ll cover:
+
+
Closures, a function-like construct you can store in a variable
+
Iterators, a way of processing a series of elements
+
How to use closures and iterators to improve the I/O project in Chapter 12
+
The performance of closures and iterators (Spoiler alert: they’re faster than
+you might think!)
+
+
We’ve already covered some other Rust features, such as pattern matching and
+enums, that are also influenced by the functional style. Because mastering
+closures and iterators is an important part of writing idiomatic, fast Rust
+code, we’ll devote this entire chapter to them.
Rust’s closures are anonymous functions you can save in a variable or pass as
+arguments to other functions. You can create the closure in one place and then
+call the closure elsewhere to evaluate it in a different context. Unlike
+functions, closures can capture values from the scope in which they’re defined.
+We’ll demonstrate how these closure features allow for code reuse and behavior
+customization.
We’ll first examine how we can use closures to capture values from the
+environment they’re defined in for later use. Here’s the scenario: Every so
+often, our t-shirt company gives away an exclusive, limited-edition shirt to
+someone on our mailing list as a promotion. People on the mailing list can
+optionally add their favorite color to their profile. If the person chosen for
+a free shirt has their favorite color set, they get that color shirt. If the
+person hasn’t specified a favorite color, they get whatever color the company
+currently has the most of.
+
There are many ways to implement this. For this example, we’re going to use an
+enum called ShirtColor that has the variants Red and Blue (limiting the
+number of colors available for simplicity). We represent the company’s
+inventory with an Inventory struct that has a field named shirts that
+contains a Vec<ShirtColor> representing the shirt colors currently in stock.
+The method giveaway defined on Inventory gets the optional shirt
+color preference of the free shirt winner, and returns the shirt color the
+person will get. This setup is shown in Listing 13-1:
+
+Filename: src/main.rs
+
#[derive(Debug, PartialEq, Copy, Clone)]
+enum ShirtColor {
+ Red,
+ Blue,
+}
+
+struct Inventory {
+ shirts: Vec<ShirtColor>,
+}
+
+impl Inventory {
+ fn giveaway(&self, user_preference: Option<ShirtColor>) -> ShirtColor {
+ user_preference.unwrap_or_else(|| self.most_stocked())
+ }
+
+ fn most_stocked(&self) -> ShirtColor {
+ let mut num_red = 0;
+ let mut num_blue = 0;
+
+ for color in &self.shirts {
+ match color {
+ ShirtColor::Red => num_red += 1,
+ ShirtColor::Blue => num_blue += 1,
+ }
+ }
+ if num_red > num_blue {
+ ShirtColor::Red
+ } else {
+ ShirtColor::Blue
+ }
+ }
+}
+
+fn main() {
+ let store = Inventory {
+ shirts: vec![ShirtColor::Blue, ShirtColor::Red, ShirtColor::Blue],
+ };
+
+ let user_pref1 = Some(ShirtColor::Red);
+ let giveaway1 = store.giveaway(user_pref1);
+ println!(
+ "The user with preference {:?} gets {:?}",
+ user_pref1, giveaway1
+ );
+
+ let user_pref2 = None;
+ let giveaway2 = store.giveaway(user_pref2);
+ println!(
+ "The user with preference {:?} gets {:?}",
+ user_pref2, giveaway2
+ );
+}
+Listing 13-1: Shirt company giveaway situation
+
+
The store defined in main has two blue shirts and one red shirt remaining
+to distribute for this limited-edition promotion. We call the giveaway method
+for a user with a preference for a red shirt and a user without any preference.
+
Again, this code could be implemented in many ways, and here, to focus on
+closures, we’ve stuck to concepts you’ve already learned except for the body of
+the giveaway method that uses a closure. In the giveaway method, we get the
+user preference as a parameter of type Option<ShirtColor> and call the
+unwrap_or_else method on user_preference. The unwrap_or_else method on
+Option<T> is defined by the standard library.
+It takes one argument: a closure without any arguments that returns a value T
+(the same type stored in the Some variant of the Option<T>, in this case
+ShirtColor). If the Option<T> is the Some variant, unwrap_or_else
+returns the value from within the Some. If the Option<T> is the None
+variant, unwrap_or_else calls the closure and returns the value returned by
+the closure.
+
We specify the closure expression || self.most_stocked() as the argument to
+unwrap_or_else. This is a closure that takes no parameters itself (if the
+closure had parameters, they would appear between the two vertical bars). The
+body of the closure calls self.most_stocked(). We’re defining the closure
+here, and the implementation of unwrap_or_else will evaluate the closure
+later if the result is needed.
+
Running this code prints:
+
$ cargo run
+ Compiling shirt-company v0.1.0 (file:///projects/shirt-company)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
+ Running `target/debug/shirt-company`
+The user with preference Some(Red) gets Red
+The user with preference None gets Blue
+
+
One interesting aspect here is that we’ve passed a closure that calls
+self.most_stocked() on the current Inventory instance. The standard library
+didn’t need to know anything about the Inventory or ShirtColor types we
+defined, or the logic we want to use in this scenario. The closure captures an
+immutable reference to the selfInventory instance and passes it with the
+code we specify to the unwrap_or_else method. Functions, on the other hand,
+are not able to capture their environment in this way.
There are more differences between functions and closures. Closures don’t
+usually require you to annotate the types of the parameters or the return value
+like fn functions do. Type annotations are required on functions because the
+types are part of an explicit interface exposed to your users. Defining this
+interface rigidly is important for ensuring that everyone agrees on what types
+of values a function uses and returns. Closures, on the other hand, aren’t used
+in an exposed interface like this: they’re stored in variables and used without
+naming them and exposing them to users of our library.
+
Closures are typically short and relevant only within a narrow context rather
+than in any arbitrary scenario. Within these limited contexts, the compiler can
+infer the types of the parameters and the return type, similar to how it’s able
+to infer the types of most variables (there are rare cases where the compiler
+needs closure type annotations too).
+
As with variables, we can add type annotations if we want to increase
+explicitness and clarity at the cost of being more verbose than is strictly
+necessary. Annotating the types for a closure would look like the definition
+shown in Listing 13-2. In this example, we’re defining a closure and storing it
+in a variable rather than defining the closure in the spot we pass it as an
+argument as we did in Listing 13-1.
+
+Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn generate_workout(intensity: u32, random_number: u32) {
+ let expensive_closure = |num: u32| -> u32 {
+ println!("calculating slowly...");
+ thread::sleep(Duration::from_secs(2));
+ num
+ };
+
+ if intensity < 25 {
+ println!("Today, do {} pushups!", expensive_closure(intensity));
+ println!("Next, do {} situps!", expensive_closure(intensity));
+ } else {
+ if random_number == 3 {
+ println!("Take a break today! Remember to stay hydrated!");
+ } else {
+ println!(
+ "Today, run for {} minutes!",
+ expensive_closure(intensity)
+ );
+ }
+ }
+}
+
+fn main() {
+ let simulated_user_specified_value = 10;
+ let simulated_random_number = 7;
+
+ generate_workout(simulated_user_specified_value, simulated_random_number);
+}
+Listing 13-2: Adding optional type annotations of the parameter and return value types in the closure
+
+
With type annotations added, the syntax of closures looks more similar to the
+syntax of functions. Here we define a function that adds 1 to its parameter and
+a closure that has the same behavior, for comparison. We’ve added some spaces
+to line up the relevant parts. This illustrates how closure syntax is similar
+to function syntax except for the use of pipes and the amount of syntax that is
+optional:
+
fn add_one_v1 (x: u32) -> u32 { x + 1 }
+let add_one_v2 = |x: u32| -> u32 { x + 1 };
+let add_one_v3 = |x| { x + 1 };
+let add_one_v4 = |x| x + 1 ;
+
The first line shows a function definition, and the second line shows a fully
+annotated closure definition. In the third line, we remove the type annotations
+from the closure definition. In the fourth line, we remove the brackets, which
+are optional because the closure body has only one expression. These are all
+valid definitions that will produce the same behavior when they’re called. The
+add_one_v3 and add_one_v4 lines require the closures to be evaluated to be
+able to compile because the types will be inferred from their usage. This is
+similar to let v = Vec::new(); needing either type annotations or values of
+some type to be inserted into the Vec for Rust to be able to infer the type.
+
For closure definitions, the compiler will infer one concrete type for each of
+their parameters and for their return value. For instance, Listing 13-3 shows
+the definition of a short closure that just returns the value it receives as a
+parameter. This closure isn’t very useful except for the purposes of this
+example. Note that we haven’t added any type annotations to the definition.
+Because there are no type annotations, we can call the closure with any type,
+which we’ve done here with String the first time. If we then try to call
+example_closure with an integer, we’ll get an error.
+
+Filename: src/main.rs
+
fn main() {
+ let example_closure = |x| x;
+
+ let s = example_closure(String::from("hello"));
+ let n = example_closure(5);
+}
+Listing 13-3: Attempting to call a closure whose types are inferred with two different types
+
+
The compiler gives us this error:
+
$ cargo run
+ Compiling closure-example v0.1.0 (file:///projects/closure-example)
+error[E0308]: mismatched types
+ --> src/main.rs:5:29
+ |
+5 | let n = example_closure(5);
+ | --------------- ^- help: try using a conversion method: `.to_string()`
+ | | |
+ | | expected `String`, found integer
+ | arguments to this function are incorrect
+ |
+note: expected because the closure was earlier called with an argument of type `String`
+ --> src/main.rs:4:29
+ |
+4 | let s = example_closure(String::from("hello"));
+ | --------------- ^^^^^^^^^^^^^^^^^^^^^ expected because this argument is of type `String`
+ | |
+ | in this closure call
+note: closure parameter defined here
+ --> src/main.rs:2:28
+ |
+2 | let example_closure = |x| x;
+ | ^
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `closure-example` (bin "closure-example") due to 1 previous error
+
+
The first time we call example_closure with the String value, the compiler
+infers the type of x and the return type of the closure to be String. Those
+types are then locked into the closure in example_closure, and we get a type
+error when we next try to use a different type with the same closure.
Closures can capture values from their environment in three ways, which
+directly map to the three ways a function can take a parameter: borrowing
+immutably, borrowing mutably, and taking ownership. The closure will decide
+which of these to use based on what the body of the function does with the
+captured values.
+
In Listing 13-4, we define a closure that captures an immutable reference to
+the vector named list because it only needs an immutable reference to print
+the value:
+Listing 13-4: Defining and calling a closure that captures an immutable reference
+
+
This example also illustrates that a variable can bind to a closure definition,
+and we can later call the closure by using the variable name and parentheses as
+if the variable name were a function name.
+
Because we can have multiple immutable references to list at the same time,
+list is still accessible from the code before the closure definition, after
+the closure definition but before the closure is called, and after the closure
+is called. This code compiles, runs, and prints:
Note that there’s no longer a println! between the definition and the call of
+the borrows_mutably closure: when borrows_mutably is defined, it captures a
+mutable reference to list. We don’t use the closure again after the closure
+is called, so the mutable borrow ends. Between the closure definition and the
+closure call, an immutable borrow to print isn’t allowed because no other
+borrows are allowed when there’s a mutable borrow. Try adding a println!
+there to see what error message you get!
+
If you want to force the closure to take ownership of the values it uses in the
+environment even though the body of the closure doesn’t strictly need
+ownership, you can use the move keyword before the parameter list.
+
This technique is mostly useful when passing a closure to a new thread to move
+the data so that it’s owned by the new thread. We’ll discuss threads and why
+you would want to use them in detail in Chapter 16 when we talk about
+concurrency, but for now, let’s briefly explore spawning a new thread using a
+closure that needs the move keyword. Listing 13-6 shows Listing 13-4 modified
+to print the vector in a new thread rather than in the main thread:
+
+Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let list = vec![1, 2, 3];
+ println!("Before defining closure: {list:?}");
+
+ thread::spawn(move || println!("From thread: {list:?}"))
+ .join()
+ .unwrap();
+}
+Listing 13-6: Using move to force the closure for the thread to take ownership of list
+
+
We spawn a new thread, giving the thread a closure to run as an argument. The
+closure body prints out the list. In Listing 13-4, the closure only captured
+list using an immutable reference because that’s the least amount of access
+to list needed to print it. In this example, even though the closure body
+still only needs an immutable reference, we need to specify that list should
+be moved into the closure by putting the move keyword at the beginning of the
+closure definition. The new thread might finish before the rest of the main
+thread finishes, or the main thread might finish first. If the main thread
+maintained ownership of list but ended before the new thread did and dropped
+list, the immutable reference in the thread would be invalid. Therefore, the
+compiler requires that list be moved into the closure given to the new thread
+so the reference will be valid. Try removing the move keyword or using list
+in the main thread after the closure is defined to see what compiler errors you
+get!
Once a closure has captured a reference or captured ownership of a value from
+the environment where the closure is defined (thus affecting what, if anything,
+is moved into the closure), the code in the body of the closure defines what
+happens to the references or values when the closure is evaluated later (thus
+affecting what, if anything, is moved out of the closure). A closure body can
+do any of the following: move a captured value out of the closure, mutate the
+captured value, neither move nor mutate the value, or capture nothing from the
+environment to begin with.
+
The way a closure captures and handles values from the environment affects
+which traits the closure implements, and traits are how functions and structs
+can specify what kinds of closures they can use. Closures will automatically
+implement one, two, or all three of these Fn traits, in an additive fashion,
+depending on how the closure’s body handles the values:
+
+
FnOnce applies to closures that can be called once. All closures implement
+at least this trait, because all closures can be called. A closure that
+moves captured values out of its body will only implement FnOnce and none
+of the other Fn traits, because it can only be called once.
+
FnMut applies to closures that don’t move captured values out of their
+body, but that might mutate the captured values. These closures can be
+called more than once.
+
Fn applies to closures that don’t move captured values out of their body
+and that don’t mutate captured values, as well as closures that capture
+nothing from their environment. These closures can be called more than once
+without mutating their environment, which is important in cases such as
+calling a closure multiple times concurrently.
+
+
Let’s look at the definition of the unwrap_or_else method on Option<T> that
+we used in Listing 13-1:
+
impl<T> Option<T> {
+ pub fn unwrap_or_else<F>(self, f: F) -> T
+ where
+ F: FnOnce() -> T
+ {
+ match self {
+ Some(x) => x,
+ None => f(),
+ }
+ }
+}
+
Recall that T is the generic type representing the type of the value in the
+Some variant of an Option. That type T is also the return type of the
+unwrap_or_else function: code that calls unwrap_or_else on an
+Option<String>, for example, will get a String.
+
Next, notice that the unwrap_or_else function has the additional generic type
+parameter F. The F type is the type of the parameter named f, which is
+the closure we provide when calling unwrap_or_else.
+
The trait bound specified on the generic type F is FnOnce() -> T, which
+means F must be able to be called once, take no arguments, and return a T.
+Using FnOnce in the trait bound expresses the constraint that
+unwrap_or_else is only going to call f at most one time. In the body of
+unwrap_or_else, we can see that if the Option is Some, f won’t be
+called. If the Option is None, f will be called once. Because all
+closures implement FnOnce, unwrap_or_else accepts all three kinds of
+closures and is as flexible as it can be.
+
+
Note: Functions can implement all three of the Fn traits too. If what we
+want to do doesn’t require capturing a value from the environment, we can use
+the name of a function rather than a closure where we need something that
+implements one of the Fn traits. For example, on an Option<Vec<T>> value,
+we could call unwrap_or_else(Vec::new) to get a new, empty vector if the
+value is None.
+
+
Now let’s look at the standard library method sort_by_key defined on slices,
+to see how that differs from unwrap_or_else and why sort_by_key uses
+FnMut instead of FnOnce for the trait bound. The closure gets one argument
+in the form of a reference to the current item in the slice being considered,
+and returns a value of type K that can be ordered. This function is useful
+when you want to sort a slice by a particular attribute of each item. In
+Listing 13-7, we have a list of Rectangle instances and we use sort_by_key
+to order them by their width attribute from low to high:
The reason sort_by_key is defined to take an FnMut closure is that it calls
+the closure multiple times: once for each item in the slice. The closure |r| r.width doesn’t capture, mutate, or move out anything from its environment, so
+it meets the trait bound requirements.
+
In contrast, Listing 13-8 shows an example of a closure that implements just
+the FnOnce trait, because it moves a value out of the environment. The
+compiler won’t let us use this closure with sort_by_key:
+Listing 13-8: Attempting to use an FnOnce closure with sort_by_key
+
+
This is a contrived, convoluted way (that doesn’t work) to try and count the
+number of times sort_by_key calls the closure when sorting list. This code
+attempts to do this counting by pushing value—a String from the closure’s
+environment—into the sort_operations vector. The closure captures value
+then moves value out of the closure by transferring ownership of value to
+the sort_operations vector. This closure can be called once; trying to call
+it a second time wouldn’t work because value would no longer be in the
+environment to be pushed into sort_operations again! Therefore, this closure
+only implements FnOnce. When we try to compile this code, we get this error
+that value can’t be moved out of the closure because the closure must
+implement FnMut:
+
$ cargo run
+ Compiling rectangles v0.1.0 (file:///projects/rectangles)
+error[E0507]: cannot move out of `value`, a captured variable in an `FnMut` closure
+ --> src/main.rs:18:30
+ |
+15 | let value = String::from("closure called");
+ | ----- captured outer variable
+16 |
+17 | list.sort_by_key(|r| {
+ | --- captured by this `FnMut` closure
+18 | sort_operations.push(value);
+ | ^^^^^ move occurs because `value` has type `String`, which does not implement the `Copy` trait
+
+For more information about this error, try `rustc --explain E0507`.
+error: could not compile `rectangles` (bin "rectangles") due to 1 previous error
+
+
The error points to the line in the closure body that moves value out of the
+environment. To fix this, we need to change the closure body so that it doesn’t
+move values out of the environment. To count the number of times the closure
+is called, keeping a counter in the environment and incrementing its value in
+the closure body is a more straightforward way to calculate that. The closure
+in Listing 13-9 works with sort_by_key because it is only capturing a mutable
+reference to the num_sort_operations counter and can therefore be called more
+than once:
+Listing 13-9: Using an FnMut closure with sort_by_key is allowed
+
+
The Fn traits are important when defining or using functions or types that
+make use of closures. In the next section, we’ll discuss iterators. Many
+iterator methods take closure arguments, so keep these closure details in mind
+as we continue!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch13-02-iterators.html b/ch13-02-iterators.html
new file mode 100644
index 0000000000..59f51178cf
--- /dev/null
+++ b/ch13-02-iterators.html
@@ -0,0 +1,515 @@
+
+
+
+
+
+ Processing a Series of Items with Iterators - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The iterator pattern allows you to perform some task on a sequence of items in
+turn. An iterator is responsible for the logic of iterating over each item and
+determining when the sequence has finished. When you use iterators, you don’t
+have to reimplement that logic yourself.
+
In Rust, iterators are lazy, meaning they have no effect until you call
+methods that consume the iterator to use it up. For example, the code in
+Listing 13-10 creates an iterator over the items in the vector v1 by calling
+the iter method defined on Vec<T>. This code by itself doesn’t do anything
+useful.
+
+Filename: src/main.rs
+
fn main() {
+ let v1 = vec![1, 2, 3];
+
+ let v1_iter = v1.iter();
+}
+Listing 13-10: Creating an iterator
+
+
The iterator is stored in the v1_iter variable. Once we’ve created an
+iterator, we can use it in a variety of ways. In Listing 3-5 in Chapter 3, we
+iterated over an array using a for loop to execute some code on each of its
+items. Under the hood this implicitly created and then consumed an iterator,
+but we glossed over how exactly that works until now.
+
In the example in Listing 13-11, we separate the creation of the iterator from
+the use of the iterator in the for loop. When the for loop is called using
+the iterator in v1_iter, each element in the iterator is used in one
+iteration of the loop, which prints out each value.
+
+Filename: src/main.rs
+
fn main() {
+ let v1 = vec![1, 2, 3];
+
+ let v1_iter = v1.iter();
+
+ for val in v1_iter {
+ println!("Got: {val}");
+ }
+}
+Listing 13-11: Using an iterator in a for loop
+
+
In languages that don’t have iterators provided by their standard libraries,
+you would likely write this same functionality by starting a variable at index
+0, using that variable to index into the vector to get a value, and
+incrementing the variable value in a loop until it reached the total number of
+items in the vector.
+
Iterators handle all that logic for you, cutting down on repetitive code you
+could potentially mess up. Iterators give you more flexibility to use the same
+logic with many different kinds of sequences, not just data structures you can
+index into, like vectors. Let’s examine how iterators do that.
Notice this definition uses some new syntax: type Item and Self::Item,
+which are defining an associated type with this trait. We’ll talk about
+associated types in depth in Chapter 19. For now, all you need to know is that
+this code says implementing the Iterator trait requires that you also define
+an Item type, and this Item type is used in the return type of the next
+method. In other words, the Item type will be the type returned from the
+iterator.
+
The Iterator trait only requires implementors to define one method: the
+next method, which returns one item of the iterator at a time wrapped in
+Some and, when iteration is over, returns None.
+
We can call the next method on iterators directly; Listing 13-12 demonstrates
+what values are returned from repeated calls to next on the iterator created
+from the vector.
+Listing 13-12: Calling the next method on an iterator
+
+
Note that we needed to make v1_iter mutable: calling the next method on an
+iterator changes internal state that the iterator uses to keep track of where
+it is in the sequence. In other words, this code consumes, or uses up, the
+iterator. Each call to next eats up an item from the iterator. We didn’t need
+to make v1_iter mutable when we used a for loop because the loop took
+ownership of v1_iter and made it mutable behind the scenes.
+
Also note that the values we get from the calls to next are immutable
+references to the values in the vector. The iter method produces an iterator
+over immutable references. If we want to create an iterator that takes
+ownership of v1 and returns owned values, we can call into_iter instead of
+iter. Similarly, if we want to iterate over mutable references, we can call
+iter_mut instead of iter.
The Iterator trait has a number of different methods with default
+implementations provided by the standard library; you can find out about these
+methods by looking in the standard library API documentation for the Iterator
+trait. Some of these methods call the next method in their definition, which
+is why you’re required to implement the next method when implementing the
+Iterator trait.
+
Methods that call next are called consuming adaptors, because calling them
+uses up the iterator. One example is the sum method, which takes ownership of
+the iterator and iterates through the items by repeatedly calling next, thus
+consuming the iterator. As it iterates through, it adds each item to a running
+total and returns the total when iteration is complete. Listing 13-13 has a
+test illustrating a use of the sum method:
Iterator adaptors are methods defined on the Iterator trait that don’t
+consume the iterator. Instead, they produce different iterators by changing
+some aspect of the original iterator.
+
Listing 13-14 shows an example of calling the iterator adaptor method map,
+which takes a closure to call on each item as the items are iterated through.
+The map method returns a new iterator that produces the modified items. The
+closure here creates a new iterator in which each item from the vector will be
+incremented by 1:
+
+Filename: src/main.rs
+
fn main() {
+ let v1: Vec<i32> = vec![1, 2, 3];
+
+ v1.iter().map(|x| x + 1);
+}
+Listing 13-14: Calling the iterator adaptor map to create a new iterator
+
+
However, this code produces a warning:
+
$ cargo run
+ Compiling iterators v0.1.0 (file:///projects/iterators)
+warning: unused `Map` that must be used
+ --> src/main.rs:4:5
+ |
+4 | v1.iter().map(|x| x + 1);
+ | ^^^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: iterators are lazy and do nothing unless consumed
+ = note: `#[warn(unused_must_use)]` on by default
+help: use `let _ = ...` to ignore the resulting value
+ |
+4 | let _ = v1.iter().map(|x| x + 1);
+ | +++++++
+
+warning: `iterators` (bin "iterators") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.47s
+ Running `target/debug/iterators`
+
+
The code in Listing 13-14 doesn’t do anything; the closure we’ve specified
+never gets called. The warning reminds us why: iterator adaptors are lazy, and
+we need to consume the iterator here.
+
To fix this warning and consume the iterator, we’ll use the collect method,
+which we used in Chapter 12 with env::args in Listing 12-1. This method
+consumes the iterator and collects the resulting values into a collection data
+type.
+
In Listing 13-15, we collect the results of iterating over the iterator that’s
+returned from the call to map into a vector. This vector will end up
+containing each item from the original vector incremented by 1.
+
+Filename: src/main.rs
+
fn main() {
+ let v1: Vec<i32> = vec![1, 2, 3];
+
+ let v2: Vec<_> = v1.iter().map(|x| x + 1).collect();
+
+ assert_eq!(v2, vec![2, 3, 4]);
+}
+Listing 13-15: Calling the map method to create a new iterator and then calling the collect method to consume the new iterator and create a vector
+
+
Because map takes a closure, we can specify any operation we want to perform
+on each item. This is a great example of how closures let you customize some
+behavior while reusing the iteration behavior that the Iterator trait
+provides.
+
You can chain multiple calls to iterator adaptors to perform complex actions in
+a readable way. But because all iterators are lazy, you have to call one of the
+consuming adaptor methods to get results from calls to iterator adaptors.
Many iterator adapters take closures as arguments, and commonly the closures
+we’ll specify as arguments to iterator adapters will be closures that capture
+their environment.
+
For this example, we’ll use the filter method that takes a closure. The
+closure gets an item from the iterator and returns a bool. If the closure
+returns true, the value will be included in the iteration produced by
+filter. If the closure returns false, the value won’t be included.
+
In Listing 13-16, we use filter with a closure that captures the shoe_size
+variable from its environment to iterate over a collection of Shoe struct
+instances. It will return only shoes that are the specified size.
+Listing 13-16: Using the filter method with a closure that captures shoe_size
+
+
The shoes_in_size function takes ownership of a vector of shoes and a shoe
+size as parameters. It returns a vector containing only shoes of the specified
+size.
+
In the body of shoes_in_size, we call into_iter to create an iterator
+that takes ownership of the vector. Then we call filter to adapt that
+iterator into a new iterator that only contains elements for which the closure
+returns true.
+
The closure captures the shoe_size parameter from the environment and
+compares the value with each shoe’s size, keeping only shoes of the size
+specified. Finally, calling collect gathers the values returned by the
+adapted iterator into a vector that’s returned by the function.
+
The test shows that when we call shoes_in_size, we get back only shoes
+that have the same size as the value we specified.
With this new knowledge about iterators, we can improve the I/O project in
+Chapter 12 by using iterators to make places in the code clearer and more
+concise. Let’s look at how iterators can improve our implementation of the
+Config::build function and the search function.
In Listing 12-6, we added code that took a slice of String values and created
+an instance of the Config struct by indexing into the slice and cloning the
+values, allowing the Config struct to own those values. In Listing 13-17,
+we’ve reproduced the implementation of the Config::build function as it was
+in Listing 12-23:
+Listing 13-17: Reproduction of the Config::build function from Listing 12-23
+
+
At the time, we said not to worry about the inefficient clone calls because
+we would remove them in the future. Well, that time is now!
+
We needed clone here because we have a slice with String elements in the
+parameter args, but the build function doesn’t own args. To return
+ownership of a Config instance, we had to clone the values from the query
+and file_path fields of Config so the Config instance can own its values.
+
With our new knowledge about iterators, we can change the build function to
+take ownership of an iterator as its argument instead of borrowing a slice.
+We’ll use the iterator functionality instead of the code that checks the length
+of the slice and indexes into specific locations. This will clarify what the
+Config::build function is doing because the iterator will access the values.
+
Once Config::build takes ownership of the iterator and stops using indexing
+operations that borrow, we can move the String values from the iterator into
+Config rather than calling clone and making a new allocation.
We’ll first change the start of the main function that we had in Listing
+12-24 to the code in Listing 13-18, which this time uses an iterator. This
+won’t compile until we update Config::build as well.
+Listing 13-18: Passing the return value of env::args to Config::build
+
+
The env::args function returns an iterator! Rather than collecting the
+iterator values into a vector and then passing a slice to Config::build, now
+we’re passing ownership of the iterator returned from env::args to
+Config::build directly.
+
Next, we need to update the definition of Config::build. In your I/O
+project’s src/lib.rs file, let’s change the signature of Config::build to
+look like Listing 13-19. This still won’t compile because we need to update the
+function body.
+Listing 13-19: Updating the signature of Config::build to expect an iterator
+
+
The standard library documentation for the env::args function shows that the
+type of the iterator it returns is std::env::Args, and that type implements
+the Iterator trait and returns String values.
+
We’ve updated the signature of the Config::build function so the parameter
+args has a generic type with the trait bounds impl Iterator<Item = String>
+instead of &[String]. This usage of the impl Trait syntax we discussed in
+the “Traits as Parameters” section of Chapter 10
+means that args can be any type that implements the Iterator trait and
+returns String items.
+
Because we’re taking ownership of args and we’ll be mutating args by
+iterating over it, we can add the mut keyword into the specification of the
+args parameter to make it mutable.
Next, we’ll fix the body of Config::build. Because args implements the
+Iterator trait, we know we can call the next method on it! Listing 13-20
+updates the code from Listing 12-23 to use the next method:
+Listing 13-20: Changing the body of Config::build to use iterator methods
+
+
Remember that the first value in the return value of env::args is the name of
+the program. We want to ignore that and get to the next value, so first we call
+next and do nothing with the return value. Second, we call next to get the
+value we want to put in the query field of Config. If next returns a
+Some, we use a match to extract the value. If it returns None, it means
+not enough arguments were given and we return early with an Err value. We do
+the same thing for the file_path value.
We can also take advantage of iterators in the search function in our I/O
+project, which is reproduced here in Listing 13-21 as it was in Listing 12-19:
+Listing 13-21: The implementation of the search function from Listing 12-19
+
+
We can write this code in a more concise way using iterator adaptor methods.
+Doing so also lets us avoid having a mutable intermediate results vector. The
+functional programming style prefers to minimize the amount of mutable state to
+make code clearer. Removing the mutable state might enable a future enhancement
+to make searching happen in parallel, because we wouldn’t have to manage
+concurrent access to the results vector. Listing 13-22 shows this change:
+Listing 13-22: Using iterator adaptor methods in the implementation of the search function
+
+
Recall that the purpose of the search function is to return all lines in
+contents that contain the query. Similar to the filter example in Listing
+13-16, this code uses the filter adaptor to keep only the lines that
+line.contains(query) returns true for. We then collect the matching lines
+into another vector with collect. Much simpler! Feel free to make the same
+change to use iterator methods in the search_case_insensitive function as
+well.
The next logical question is which style you should choose in your own code and
+why: the original implementation in Listing 13-21 or the version using
+iterators in Listing 13-22. Most Rust programmers prefer to use the iterator
+style. It’s a bit tougher to get the hang of at first, but once you get a feel
+for the various iterator adaptors and what they do, iterators can be easier to
+understand. Instead of fiddling with the various bits of looping and building
+new vectors, the code focuses on the high-level objective of the loop. This
+abstracts away some of the commonplace code so it’s easier to see the concepts
+that are unique to this code, such as the filtering condition each element in
+the iterator must pass.
+
But are the two implementations truly equivalent? The intuitive assumption
+might be that the more low-level loop will be faster. Let’s talk about
+performance.
To determine whether to use loops or iterators, you need to know which
+implementation is faster: the version of the search function with an explicit
+for loop or the version with iterators.
+
We ran a benchmark by loading the entire contents of The Adventures of
+Sherlock Holmes by Sir Arthur Conan Doyle into a String and looking for the
+word the in the contents. Here are the results of the benchmark on the
+version of search using the for loop and the version using iterators:
The iterator version was slightly faster! We won’t explain the benchmark code
+here, because the point is not to prove that the two versions are equivalent
+but to get a general sense of how these two implementations compare
+performance-wise.
+
For a more comprehensive benchmark, you should check using various texts of
+various sizes as the contents, different words and words of different lengths
+as the query, and all kinds of other variations. The point is this:
+iterators, although a high-level abstraction, get compiled down to roughly the
+same code as if you’d written the lower-level code yourself. Iterators are one
+of Rust’s zero-cost abstractions, by which we mean using the abstraction
+imposes no additional runtime overhead. This is analogous to how Bjarne
+Stroustrup, the original designer and implementor of C++, defines
+zero-overhead in “Foundations of C++” (2012):
+
+
In general, C++ implementations obey the zero-overhead principle: What you
+don’t use, you don’t pay for. And further: What you do use, you couldn’t hand
+code any better.
+
+
As another example, the following code is taken from an audio decoder. The
+decoding algorithm uses the linear prediction mathematical operation to
+estimate future values based on a linear function of the previous samples. This
+code uses an iterator chain to do some math on three variables in scope: a
+buffer slice of data, an array of 12 coefficients, and an amount by which
+to shift data in qlp_shift. We’ve declared the variables within this example
+but not given them any values; although this code doesn’t have much meaning
+outside of its context, it’s still a concise, real-world example of how Rust
+translates high-level ideas to low-level code.
+
let buffer: &mut [i32];
+let coefficients: [i64; 12];
+let qlp_shift: i16;
+
+for i in 12..buffer.len() {
+ let prediction = coefficients.iter()
+ .zip(&buffer[i - 12..i])
+ .map(|(&c, &s)| c * s as i64)
+ .sum::<i64>() >> qlp_shift;
+ let delta = buffer[i];
+ buffer[i] = prediction as i32 + delta;
+}
+
To calculate the value of prediction, this code iterates through each of the
+12 values in coefficients and uses the zip method to pair the coefficient
+values with the previous 12 values in buffer. Then, for each pair, we
+multiply the values together, sum all the results, and shift the bits in the
+sum qlp_shift bits to the right.
+
Calculations in applications like audio decoders often prioritize performance
+most highly. Here, we’re creating an iterator, using two adaptors, and then
+consuming the value. What assembly code would this Rust code compile to? Well,
+as of this writing, it compiles down to the same assembly you’d write by hand.
+There’s no loop at all corresponding to the iteration over the values in
+coefficients: Rust knows that there are 12 iterations, so it “unrolls” the
+loop. Unrolling is an optimization that removes the overhead of the loop
+controlling code and instead generates repetitive code for each iteration of
+the loop.
+
All of the coefficients get stored in registers, which means accessing the
+values is very fast. There are no bounds checks on the array access at runtime.
+All these optimizations that Rust is able to apply make the resulting code
+extremely efficient. Now that you know this, you can use iterators and closures
+without fear! They make code seem like it’s higher level but don’t impose a
+runtime performance penalty for doing so.
Closures and iterators are Rust features inspired by functional programming
+language ideas. They contribute to Rust’s capability to clearly express
+high-level ideas at low-level performance. The implementations of closures and
+iterators are such that runtime performance is not affected. This is part of
+Rust’s goal to strive to provide zero-cost abstractions.
+
Now that we’ve improved the expressiveness of our I/O project, let’s look at
+some more features of cargo that will help us share the project with the
+world.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch14-00-more-about-cargo.html b/ch14-00-more-about-cargo.html
new file mode 100644
index 0000000000..2d498f3c6b
--- /dev/null
+++ b/ch14-00-more-about-cargo.html
@@ -0,0 +1,249 @@
+
+
+
+
+
+ More about Cargo and Crates.io - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
So far we’ve used only the most basic features of Cargo to build, run, and test
+our code, but it can do a lot more. In this chapter, we’ll discuss some of its
+other, more advanced features to show you how to do the following:
In Rust, release profiles are predefined and customizable profiles with
+different configurations that allow a programmer to have more control over
+various options for compiling code. Each profile is configured independently of
+the others.
+
Cargo has two main profiles: the dev profile Cargo uses when you run cargo build and the release profile Cargo uses when you run cargo build --release. The dev profile is defined with good defaults for development,
+and the release profile has good defaults for release builds.
+
These profile names might be familiar from the output of your builds:
+
+
$ cargo build
+ Finished dev [unoptimized + debuginfo] target(s) in 0.0s
+$ cargo build --release
+ Finished release [optimized] target(s) in 0.0s
+
+
The dev and release are these different profiles used by the compiler.
+
Cargo has default settings for each of the profiles that apply when you haven’t
+explicitly added any [profile.*] sections in the project’s Cargo.toml file.
+By adding [profile.*] sections for any profile you want to customize, you
+override any subset of the default settings. For example, here are the default
+values for the opt-level setting for the dev and release profiles:
The opt-level setting controls the number of optimizations Rust will apply to
+your code, with a range of 0 to 3. Applying more optimizations extends
+compiling time, so if you’re in development and compiling your code often,
+you’ll want fewer optimizations to compile faster even if the resulting code
+runs slower. The default opt-level for dev is therefore 0. When you’re
+ready to release your code, it’s best to spend more time compiling. You’ll only
+compile in release mode once, but you’ll run the compiled program many times,
+so release mode trades longer compile time for code that runs faster. That is
+why the default opt-level for the release profile is 3.
+
You can override a default setting by adding a different value for it in
+Cargo.toml. For example, if we want to use optimization level 1 in the
+development profile, we can add these two lines to our project’s Cargo.toml
+file:
+
Filename: Cargo.toml
+
[profile.dev]
+opt-level = 1
+
+
This code overrides the default setting of 0. Now when we run cargo build,
+Cargo will use the defaults for the dev profile plus our customization to
+opt-level. Because we set opt-level to 1, Cargo will apply more
+optimizations than the default, but not as many as in a release build.
+
For the full list of configuration options and defaults for each profile, see
+Cargo’s documentation.
We’ve used packages from crates.io as
+dependencies of our project, but you can also share your code with other people
+by publishing your own packages. The crate registry at
+crates.io distributes the source code of
+your packages, so it primarily hosts code that is open source.
+
Rust and Cargo have features that make your published package easier for people
+to find and use. We’ll talk about some of these features next and then explain
+how to publish a package.
Accurately documenting your packages will help other users know how and when to
+use them, so it’s worth investing the time to write documentation. In Chapter
+3, we discussed how to comment Rust code using two slashes, //. Rust also has
+a particular kind of comment for documentation, known conveniently as a
+documentation comment, that will generate HTML documentation. The HTML
+displays the contents of documentation comments for public API items intended
+for programmers interested in knowing how to use your crate as opposed to how
+your crate is implemented.
+
Documentation comments use three slashes, ///, instead of two and support
+Markdown notation for formatting the text. Place documentation comments just
+before the item they’re documenting. Listing 14-1 shows documentation comments
+for an add_one function in a crate named my_crate.
+
+Filename: src/lib.rs
+
/// Adds one to the number given.
+///
+/// # Examples
+///
+/// ```
+/// let arg = 5;
+/// let answer = my_crate::add_one(arg);
+///
+/// assert_eq!(6, answer);
+/// ```
+pub fn add_one(x: i32) -> i32 {
+ x + 1
+}
+Listing 14-1: A documentation comment for a function
+
+
Here, we give a description of what the add_one function does, start a
+section with the heading Examples, and then provide code that demonstrates
+how to use the add_one function. We can generate the HTML documentation from
+this documentation comment by running cargo doc. This command runs the
+rustdoc tool distributed with Rust and puts the generated HTML documentation
+in the target/doc directory.
+
For convenience, running cargo doc --open will build the HTML for your
+current crate’s documentation (as well as the documentation for all of your
+crate’s dependencies) and open the result in a web browser. Navigate to the
+add_one function and you’ll see how the text in the documentation comments is
+rendered, as shown in Figure 14-1:
+
+
Figure 14-1: HTML documentation for the add_one
+function
We used the # Examples Markdown heading in Listing 14-1 to create a section
+in the HTML with the title “Examples.” Here are some other sections that crate
+authors commonly use in their documentation:
+
+
Panics: The scenarios in which the function being documented could
+panic. Callers of the function who don’t want their programs to panic should
+make sure they don’t call the function in these situations.
+
Errors: If the function returns a Result, describing the kinds of
+errors that might occur and what conditions might cause those errors to be
+returned can be helpful to callers so they can write code to handle the
+different kinds of errors in different ways.
+
Safety: If the function is unsafe to call (we discuss unsafety in
+Chapter 19), there should be a section explaining why the function is unsafe
+and covering the invariants that the function expects callers to uphold.
+
+
Most documentation comments don’t need all of these sections, but this is a
+good checklist to remind you of the aspects of your code users will be
+interested in knowing about.
Adding example code blocks in your documentation comments can help demonstrate
+how to use your library, and doing so has an additional bonus: running cargo test will run the code examples in your documentation as tests! Nothing is
+better than documentation with examples. But nothing is worse than examples
+that don’t work because the code has changed since the documentation was
+written. If we run cargo test with the documentation for the add_one
+function from Listing 14-1, we will see a section in the test results like this:
+
+
Doc-tests my_crate
+
+running 1 test
+test src/lib.rs - add_one (line 5) ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.27s
+
+
Now if we change either the function or the example so the assert_eq! in the
+example panics and run cargo test again, we’ll see that the doc tests catch
+that the example and the code are out of sync with each other!
The style of doc comment //! adds documentation to the item that contains the
+comments rather than to the items following the comments. We typically use
+these doc comments inside the crate root file (src/lib.rs by convention) or
+inside a module to document the crate or the module as a whole.
+
For example, to add documentation that describes the purpose of the my_crate
+crate that contains the add_one function, we add documentation comments that
+start with //! to the beginning of the src/lib.rs file, as shown in Listing
+14-2:
+
+Filename: src/lib.rs
+
//! # My Crate
+//!
+//! `my_crate` is a collection of utilities to make performing certain
+//! calculations more convenient.
+
+/// Adds one to the number given.
+// --snip--
+///
+/// # Examples
+///
+/// ```
+/// let arg = 5;
+/// let answer = my_crate::add_one(arg);
+///
+/// assert_eq!(6, answer);
+/// ```
+pub fn add_one(x: i32) -> i32 {
+ x + 1
+}
+Listing 14-2: Documentation for the my_crate crate as a whole
+
+
Notice there isn’t any code after the last line that begins with //!. Because
+we started the comments with //! instead of ///, we’re documenting the item
+that contains this comment rather than an item that follows this comment. In
+this case, that item is the src/lib.rs file, which is the crate root. These
+comments describe the entire crate.
+
When we run cargo doc --open, these comments will display on the front
+page of the documentation for my_crate above the list of public items in the
+crate, as shown in Figure 14-2:
+
+
Figure 14-2: Rendered documentation for my_crate,
+including the comment describing the crate as a whole
+
Documentation comments within items are useful for describing crates and
+modules especially. Use them to explain the overall purpose of the container to
+help your users understand the crate’s organization.
The structure of your public API is a major consideration when publishing a
+crate. People who use your crate are less familiar with the structure than you
+are and might have difficulty finding the pieces they want to use if your crate
+has a large module hierarchy.
+
In Chapter 7, we covered how to make items public using the pub keyword, and
+bring items into a scope with the use keyword. However, the structure that
+makes sense to you while you’re developing a crate might not be very convenient
+for your users. You might want to organize your structs in a hierarchy
+containing multiple levels, but then people who want to use a type you’ve
+defined deep in the hierarchy might have trouble finding out that type exists.
+They might also be annoyed at having to enter use
+my_crate::some_module::another_module::UsefulType; rather than use
+my_crate::UsefulType;.
+
The good news is that if the structure isn’t convenient for others to use
+from another library, you don’t have to rearrange your internal organization:
+instead, you can re-export items to make a public structure that’s different
+from your private structure by using pub use. Re-exporting takes a public
+item in one location and makes it public in another location, as if it were
+defined in the other location instead.
+
For example, say we made a library named art for modeling artistic concepts.
+Within this library are two modules: a kinds module containing two enums
+named PrimaryColor and SecondaryColor and a utils module containing a
+function named mix, as shown in Listing 14-3:
+
+Filename: src/lib.rs
+
//! # Art
+//!
+//! A library for modeling artistic concepts.
+
+pub mod kinds {
+ /// The primary colors according to the RYB color model.
+ pub enum PrimaryColor {
+ Red,
+ Yellow,
+ Blue,
+ }
+
+ /// The secondary colors according to the RYB color model.
+ pub enum SecondaryColor {
+ Orange,
+ Green,
+ Purple,
+ }
+}
+
+pub mod utils {
+ use crate::kinds::*;
+
+ /// Combines two primary colors in equal amounts to create
+ /// a secondary color.
+ pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
+ // --snip--
+ unimplemented!();
+ }
+}
+Listing 14-3: An art library with items organized into kinds and utils modules
+
+
Figure 14-3 shows what the front page of the documentation for this crate
+generated by cargo doc would look like:
+
+
Figure 14-3: Front page of the documentation for art
+that lists the kinds and utils modules
+
Note that the PrimaryColor and SecondaryColor types aren’t listed on the
+front page, nor is the mix function. We have to click kinds and utils to
+see them.
+
Another crate that depends on this library would need use statements that
+bring the items from art into scope, specifying the module structure that’s
+currently defined. Listing 14-4 shows an example of a crate that uses the
+PrimaryColor and mix items from the art crate:
+
+Filename: src/main.rs
+
use art::kinds::PrimaryColor;
+use art::utils::mix;
+
+fn main() {
+ let red = PrimaryColor::Red;
+ let yellow = PrimaryColor::Yellow;
+ mix(red, yellow);
+}
+Listing 14-4: A crate using the art crate’s items with its internal structure exported
+
+
The author of the code in Listing 14-4, which uses the art crate, had to
+figure out that PrimaryColor is in the kinds module and mix is in the
+utils module. The module structure of the art crate is more relevant to
+developers working on the art crate than to those using it. The internal
+structure doesn’t contain any useful information for someone trying to
+understand how to use the art crate, but rather causes confusion because
+developers who use it have to figure out where to look, and must specify the
+module names in the use statements.
+
To remove the internal organization from the public API, we can modify the
+art crate code in Listing 14-3 to add pub use statements to re-export the
+items at the top level, as shown in Listing 14-5:
+
+Filename: src/lib.rs
+
//! # Art
+//!
+//! A library for modeling artistic concepts.
+
+pub use self::kinds::PrimaryColor;
+pub use self::kinds::SecondaryColor;
+pub use self::utils::mix;
+
+pub mod kinds {
+ // --snip--
+ /// The primary colors according to the RYB color model.
+ pub enum PrimaryColor {
+ Red,
+ Yellow,
+ Blue,
+ }
+
+ /// The secondary colors according to the RYB color model.
+ pub enum SecondaryColor {
+ Orange,
+ Green,
+ Purple,
+ }
+}
+
+pub mod utils {
+ // --snip--
+ use crate::kinds::*;
+
+ /// Combines two primary colors in equal amounts to create
+ /// a secondary color.
+ pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
+ SecondaryColor::Orange
+ }
+}
+Listing 14-5: Adding pub use statements to re-export items
+
+
The API documentation that cargo doc generates for this crate will now list
+and link re-exports on the front page, as shown in Figure 14-4, making the
+PrimaryColor and SecondaryColor types and the mix function easier to find.
+
+
Figure 14-4: The front page of the documentation for art
+that lists the re-exports
+
The art crate users can still see and use the internal structure from Listing
+14-3 as demonstrated in Listing 14-4, or they can use the more convenient
+structure in Listing 14-5, as shown in Listing 14-6:
+
+Filename: src/main.rs
+
use art::mix;
+use art::PrimaryColor;
+
+fn main() {
+ // --snip--
+ let red = PrimaryColor::Red;
+ let yellow = PrimaryColor::Yellow;
+ mix(red, yellow);
+}
+Listing 14-6: A program using the re-exported items from the art crate
+
+
In cases where there are many nested modules, re-exporting the types at the top
+level with pub use can make a significant difference in the experience of
+people who use the crate. Another common use of pub use is to re-export
+definitions of a dependency in the current crate to make that crate’s
+definitions part of your crate’s public API.
+
Creating a useful public API structure is more of an art than a science, and
+you can iterate to find the API that works best for your users. Choosing pub use gives you flexibility in how you structure your crate internally and
+decouples that internal structure from what you present to your users. Look at
+some of the code of crates you’ve installed to see if their internal structure
+differs from their public API.
Before you can publish any crates, you need to create an account on
+crates.io and get an API token. To do so,
+visit the home page at crates.io and log
+in via a GitHub account. (The GitHub account is currently a requirement, but
+the site might support other ways of creating an account in the future.) Once
+you’re logged in, visit your account settings at
+https://crates.io/me/ and retrieve your
+API key. Then run the cargo login command and paste your API key when prompted, like this:
+
$ cargo login
+abcdefghijklmnopqrstuvwxyz012345
+
+
This command will inform Cargo of your API token and store it locally in
+~/.cargo/credentials. Note that this token is a secret: do not share it
+with anyone else. If you do share it with anyone for any reason, you should
+revoke it and generate a new token on crates.io.
Let’s say you have a crate you want to publish. Before publishing, you’ll need
+to add some metadata in the [package] section of the crate’s Cargo.toml
+file.
+
Your crate will need a unique name. While you’re working on a crate locally,
+you can name a crate whatever you’d like. However, crate names on
+crates.io are allocated on a first-come,
+first-served basis. Once a crate name is taken, no one else can publish a crate
+with that name. Before attempting to publish a crate, search for the name you
+want to use. If the name has been used, you will need to find another name and
+edit the name field in the Cargo.toml file under the [package] section to
+use the new name for publishing, like so:
+
Filename: Cargo.toml
+
[package]
+name = "guessing_game"
+
+
Even if you’ve chosen a unique name, when you run cargo publish to publish
+the crate at this point, you’ll get a warning and then an error:
+
+
$ cargo publish
+ Updating crates.io index
+warning: manifest has no description, license, license-file, documentation, homepage or repository.
+See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
+--snip--
+error: failed to publish to registry at https://crates.io
+
+Caused by:
+ the remote server responded with an error: missing or empty metadata fields: description, license. Please see https://doc.rust-lang.org/cargo/reference/manifest.html for how to upload metadata
+
+
This errors because you’re missing some crucial information: a description and
+license are required so people will know what your crate does and under what
+terms they can use it. In Cargo.toml, add a description that’s just a
+sentence or two, because it will appear with your crate in search results. For
+the license field, you need to give a license identifier value. The Linux
+Foundation’s Software Package Data Exchange (SPDX) lists the identifiers
+you can use for this value. For example, to specify that you’ve licensed your
+crate using the MIT License, add the MIT identifier:
If you want to use a license that doesn’t appear in the SPDX, you need to place
+the text of that license in a file, include the file in your project, and then
+use license-file to specify the name of that file instead of using the
+license key.
+
Guidance on which license is appropriate for your project is beyond the scope
+of this book. Many people in the Rust community license their projects in the
+same way as Rust by using a dual license of MIT OR Apache-2.0. This practice
+demonstrates that you can also specify multiple license identifiers separated
+by OR to have multiple licenses for your project.
+
With a unique name, the version, your description, and a license added, the
+Cargo.toml file for a project that is ready to publish might look like this:
+
Filename: Cargo.toml
+
[package]
+name = "guessing_game"
+version = "0.1.0"
+edition = "2021"
+description = "A fun game where you guess what number the computer has chosen."
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+
+
Cargo’s documentation describes other
+metadata you can specify to ensure others can discover and use your crate more
+easily.
Now that you’ve created an account, saved your API token, chosen a name for
+your crate, and specified the required metadata, you’re ready to publish!
+Publishing a crate uploads a specific version to
+crates.io for others to use.
+
Be careful, because a publish is permanent. The version can never be
+overwritten, and the code cannot be deleted. One major goal of
+crates.io is to act as a permanent archive
+of code so that builds of all projects that depend on crates from
+crates.io will continue to work. Allowing
+version deletions would make fulfilling that goal impossible. However, there is
+no limit to the number of crate versions you can publish.
+
Run the cargo publish command again. It should succeed now:
When you’ve made changes to your crate and are ready to release a new version,
+you change the version value specified in your Cargo.toml file and
+republish. Use the Semantic Versioning rules to decide what an
+appropriate next version number is based on the kinds of changes you’ve made.
+Then run cargo publish to upload the new version.
Although you can’t remove previous versions of a crate, you can prevent any
+future projects from adding them as a new dependency. This is useful when a
+crate version is broken for one reason or another. In such situations, Cargo
+supports yanking a crate version.
+
Yanking a version prevents new projects from depending on that version while
+allowing all existing projects that depend on it to continue. Essentially, a
+yank means that all projects with a Cargo.lock will not break, and any future
+Cargo.lock files generated will not use the yanked version.
+
To yank a version of a crate, in the directory of the crate that you’ve
+previously published, run cargo yank and specify which version you want to
+yank. For example, if we’ve published a crate named guessing_game version
+1.0.1 and we want to yank it, in the project directory for guessing_game we’d
+run:
A yank does not delete any code. It cannot, for example, delete accidentally
+uploaded secrets. If that happens, you must reset those secrets immediately.
In Chapter 12, we built a package that included a binary crate and a library
+crate. As your project develops, you might find that the library crate
+continues to get bigger and you want to split your package further into
+multiple library crates. Cargo offers a feature called workspaces that can
+help manage multiple related packages that are developed in tandem.
A workspace is a set of packages that share the same Cargo.lock and output
+directory. Let’s make a project using a workspace—we’ll use trivial code so we
+can concentrate on the structure of the workspace. There are multiple ways to
+structure a workspace, so we’ll just show one common way. We’ll have a
+workspace containing a binary and two libraries. The binary, which will provide
+the main functionality, will depend on the two libraries. One library will
+provide an add_one function, and a second library an add_two function.
+These three crates will be part of the same workspace. We’ll start by creating
+a new directory for the workspace:
+
$ mkdir add
+$ cd add
+
+
Next, in the add directory, we create the Cargo.toml file that will
+configure the entire workspace. This file won’t have a [package] section.
+Instead, it will start with a [workspace] section that will allow us to add
+members to the workspace by specifying the path to the package with our binary
+crate; in this case, that path is adder:
+
Filename: Cargo.toml
+
[workspace]
+
+members = [
+ "adder",
+]
+
+
Next, we’ll create the adder binary crate by running cargo new within the
+add directory:
+
+
$ cargo new adder
+ Created binary (application) `adder` package
+
+
At this point, we can build the workspace by running cargo build. The files
+in your add directory should look like this:
The workspace has one target directory at the top level that the compiled
+artifacts will be placed into; the adder package doesn’t have its own
+target directory. Even if we were to run cargo build from inside the
+adder directory, the compiled artifacts would still end up in add/target
+rather than add/adder/target. Cargo structures the target directory in a
+workspace like this because the crates in a workspace are meant to depend on
+each other. If each crate had its own target directory, each crate would have
+to recompile each of the other crates in the workspace to place the artifacts
+in its own target directory. By sharing one target directory, the crates
+can avoid unnecessary rebuilding.
Next, let’s create another member package in the workspace and call it
+add_one. Change the top-level Cargo.toml to specify the add_one path in
+the members list:
In the add_one/src/lib.rs file, let’s add an add_one function:
+
Filename: add_one/src/lib.rs
+
pub fn add_one(x: i32) -> i32 {
+ x + 1
+}
+
Now we can have the adder package with our binary depend on the add_one
+package that has our library. First, we’ll need to add a path dependency on
+add_one to adder/Cargo.toml.
Cargo doesn’t assume that crates in a workspace will depend on each other, so
+we need to be explicit about the dependency relationships.
+
Next, let’s use the add_one function (from the add_one crate) in the
+adder crate. Open the adder/src/main.rs file and add a use line at the
+top to bring the new add_one library crate into scope. Then change the main
+function to call the add_one function, as in Listing 14-7.
+
+Filename: adder/src/main.rs
+
use add_one;
+
+fn main() {
+ let num = 10;
+ println!("Hello, world! {num} plus one is {}!", add_one::add_one(num));
+}
+Listing 14-7: Using the add_one library crate from the adder crate
+
+
Let’s build the workspace by running cargo build in the top-level add
+directory!
To run the binary crate from the add directory, we can specify which
+package in the workspace we want to run by using the -p argument and the
+package name with cargo run:
+
+
$ cargo run -p adder
+ Finished dev [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/adder`
+Hello, world! 10 plus one is 11!
+
+
This runs the code in adder/src/main.rs, which depends on the add_one crate.
Notice that the workspace has only one Cargo.lock file at the top level,
+rather than having a Cargo.lock in each crate’s directory. This ensures that
+all crates are using the same version of all dependencies. If we add the rand
+package to the adder/Cargo.toml and add_one/Cargo.toml files, Cargo will
+resolve both of those to one version of rand and record that in the one
+Cargo.lock. Making all crates in the workspace use the same dependencies
+means the crates will always be compatible with each other. Let’s add the
+rand crate to the [dependencies] section in the add_one/Cargo.toml file
+so we can use the rand crate in the add_one crate:
+
+
Filename: add_one/Cargo.toml
+
[dependencies]
+rand = "0.8.5"
+
+
We can now add use rand; to the add_one/src/lib.rs file, and building the
+whole workspace by running cargo build in the add directory will bring in
+and compile the rand crate. We will get one warning because we aren’t
+referring to the rand we brought into scope:
The top-level Cargo.lock now contains information about the dependency of
+add_one on rand. However, even though rand is used somewhere in the
+workspace, we can’t use it in other crates in the workspace unless we add
+rand to their Cargo.toml files as well. For example, if we add use rand;
+to the adder/src/main.rs file for the adder package, we’ll get an error:
To fix this, edit the Cargo.toml file for the adder package and indicate
+that rand is a dependency for it as well. Building the adder package will
+add rand to the list of dependencies for adder in Cargo.lock, but no
+additional copies of rand will be downloaded. Cargo will ensure that every
+crate in every package in the workspace using the rand package will be using
+the same version as long as they specify compatible versions of rand, saving
+us space and ensuring that the crates in the workspace will be compatible with
+each other.
+
If crates in the workspace specify incompatible versions of the same dependency,
+Cargo will resolve each of them, but will still try to resolve as few versions
+as possible.
Now run cargo test in the top-level add directory. Running cargo test in
+a workspace structured like this one will run the tests for all the crates in
+the workspace:
+
+
$ cargo test
+ Compiling add_one v0.1.0 (file:///projects/add/add_one)
+ Compiling adder v0.1.0 (file:///projects/add/adder)
+ Finished test [unoptimized + debuginfo] target(s) in 0.27s
+ Running unittests src/lib.rs (target/debug/deps/add_one-f0253159197f7841)
+
+running 1 test
+test tests::it_works ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running unittests src/main.rs (target/debug/deps/adder-49979ff40686fa8e)
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests add_one
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
The first section of the output shows that the it_works test in the add_one
+crate passed. The next section shows that zero tests were found in the adder
+crate, and then the last section shows zero documentation tests were found in
+the add_one crate.
+
We can also run tests for one particular crate in a workspace from the
+top-level directory by using the -p flag and specifying the name of the crate
+we want to test:
+
+
$ cargo test -p add_one
+ Finished test [unoptimized + debuginfo] target(s) in 0.00s
+ Running unittests src/lib.rs (target/debug/deps/add_one-b3235fea9a156f74)
+
+running 1 test
+test tests::it_works ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests add_one
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
This output shows cargo test only ran the tests for the add_one crate and
+didn’t run the adder crate tests.
+
If you publish the crates in the workspace to crates.io,
+each crate in the workspace will need to be published separately. Like cargo test, we can publish a particular crate in our workspace by using the -p
+flag and specifying the name of the crate we want to publish.
+
For additional practice, add an add_two crate to this workspace in a similar
+way as the add_one crate!
+
As your project grows, consider using a workspace: it’s easier to understand
+smaller, individual components than one big blob of code. Furthermore, keeping
+the crates in a workspace can make coordination between crates easier if they
+are often changed at the same time.
The cargo install command allows you to install and use binary crates
+locally. This isn’t intended to replace system packages; it’s meant to be a
+convenient way for Rust developers to install tools that others have shared on
+crates.io. Note that you can only install
+packages that have binary targets. A binary target is the runnable program
+that is created if the crate has a src/main.rs file or another file specified
+as a binary, as opposed to a library target that isn’t runnable on its own but
+is suitable for including within other programs. Usually, crates have
+information in the README file about whether a crate is a library, has a
+binary target, or both.
+
All binaries installed with cargo install are stored in the installation
+root’s bin folder. If you installed Rust using rustup.rs and don’t have any
+custom configurations, this directory will be $HOME/.cargo/bin. Ensure that
+directory is in your $PATH to be able to run programs you’ve installed with
+cargo install.
+
For example, in Chapter 12 we mentioned that there’s a Rust implementation of
+the grep tool called ripgrep for searching files. To install ripgrep, we
+can run the following:
The second-to-last line of the output shows the location and the name of the
+installed binary, which in the case of ripgrep is rg. As long as the
+installation directory is in your $PATH, as mentioned previously, you can
+then run rg --help and start using a faster, rustier tool for searching files!
Cargo is designed so you can extend it with new subcommands without having to
+modify Cargo. If a binary in your $PATH is named cargo-something, you can
+run it as if it was a Cargo subcommand by running cargo something. Custom
+commands like this are also listed when you run cargo --list. Being able to
+use cargo install to install extensions and then run them just like the
+built-in Cargo tools is a super convenient benefit of Cargo’s design!
Sharing code with Cargo and crates.io is
+part of what makes the Rust ecosystem useful for many different tasks. Rust’s
+standard library is small and stable, but crates are easy to share, use, and
+improve on a timeline different from that of the language. Don’t be shy about
+sharing code that’s useful to you on crates.io; it’s likely that it will be useful to someone else as well!
A pointer is a general concept for a variable that contains an address in
+memory. This address refers to, or “points at,” some other data. The most
+common kind of pointer in Rust is a reference, which you learned about in
+Chapter 4. References are indicated by the & symbol and borrow the value they
+point to. They don’t have any special capabilities other than referring to
+data, and have no overhead.
+
Smart pointers, on the other hand, are data structures that act like a
+pointer but also have additional metadata and capabilities. The concept of
+smart pointers isn’t unique to Rust: smart pointers originated in C++ and exist
+in other languages as well. Rust has a variety of smart pointers defined in the
+standard library that provide functionality beyond that provided by references.
+To explore the general concept, we’ll look at a couple of different examples of
+smart pointers, including a reference counting smart pointer type. This
+pointer enables you to allow data to have multiple owners by keeping track of
+the number of owners and, when no owners remain, cleaning up the data.
+
Rust, with its concept of ownership and borrowing, has an additional difference
+between references and smart pointers: while references only borrow data, in
+many cases, smart pointers own the data they point to.
+
Though we didn’t call them as such at the time, we’ve already encountered a few
+smart pointers in this book, including String and Vec<T> in Chapter 8. Both
+these types count as smart pointers because they own some memory and allow you
+to manipulate it. They also have metadata and extra capabilities or guarantees.
+String, for example, stores its capacity as metadata and has the extra
+ability to ensure its data will always be valid UTF-8.
+
Smart pointers are usually implemented using structs. Unlike an ordinary
+struct, smart pointers implement the Deref and Drop traits. The Deref
+trait allows an instance of the smart pointer struct to behave like a reference
+so you can write your code to work with either references or smart pointers.
+The Drop trait allows you to customize the code that’s run when an instance
+of the smart pointer goes out of scope. In this chapter, we’ll discuss both
+traits and demonstrate why they’re important to smart pointers.
+
Given that the smart pointer pattern is a general design pattern used
+frequently in Rust, this chapter won’t cover every existing smart pointer. Many
+libraries have their own smart pointers, and you can even write your own. We’ll
+cover the most common smart pointers in the standard library:
+
+
Box<T> for allocating values on the heap
+
Rc<T>, a reference counting type that enables multiple ownership
+
Ref<T> and RefMut<T>, accessed through RefCell<T>, a type that enforces
+the borrowing rules at runtime instead of compile time
+
+
In addition, we’ll cover the interior mutability pattern where an immutable
+type exposes an API for mutating an interior value. We’ll also discuss
+reference cycles: how they can leak memory and how to prevent them.
+
Let’s dive in!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch15-01-box.html b/ch15-01-box.html
new file mode 100644
index 0000000000..1449aed271
--- /dev/null
+++ b/ch15-01-box.html
@@ -0,0 +1,481 @@
+
+
+
+
+
+ Using Box<T> to Point to Data on the Heap - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The most straightforward smart pointer is a box, whose type is written
+Box<T>. Boxes allow you to store data on the heap rather than the stack. What
+remains on the stack is the pointer to the heap data. Refer to Chapter 4 to
+review the difference between the stack and the heap.
+
Boxes don’t have performance overhead, other than storing their data on the
+heap instead of on the stack. But they don’t have many extra capabilities
+either. You’ll use them most often in these situations:
+
+
When you have a type whose size can’t be known at compile time and you want
+to use a value of that type in a context that requires an exact size
+
When you have a large amount of data and you want to transfer ownership but
+ensure the data won’t be copied when you do so
+
When you want to own a value and you care only that it’s a type that
+implements a particular trait rather than being of a specific type
+
+
We’ll demonstrate the first situation in the “Enabling Recursive Types with
+Boxes” section. In the
+second case, transferring ownership of a large amount of data can take a long
+time because the data is copied around on the stack. To improve performance in
+this situation, we can store the large amount of data on the heap in a box.
+Then, only the small amount of pointer data is copied around on the stack,
+while the data it references stays in one place on the heap. The third case is
+known as a trait object, and Chapter 17 devotes an entire section, “Using
+Trait Objects That Allow for Values of Different Types,” just to that topic. So what you learn here you’ll apply again in
+Chapter 17!
Before we discuss the heap storage use case for Box<T>, we’ll cover the
+syntax and how to interact with values stored within a Box<T>.
+
Listing 15-1 shows how to use a box to store an i32 value on the heap:
+
Filename: src/main.rs
+
fn main() {
+ let b = Box::new(5);
+ println!("b = {b}");
+}
+
Listing 15-1: Storing an i32 value on the heap using a
+box
+
We define the variable b to have the value of a Box that points to the
+value 5, which is allocated on the heap. This program will print b = 5; in
+this case, we can access the data in the box similar to how we would if this
+data were on the stack. Just like any owned value, when a box goes out of
+scope, as b does at the end of main, it will be deallocated. The
+deallocation happens both for the box (stored on the stack) and the data it
+points to (stored on the heap).
+
Putting a single value on the heap isn’t very useful, so you won’t use boxes by
+themselves in this way very often. Having values like a single i32 on the
+stack, where they’re stored by default, is more appropriate in the majority of
+situations. Let’s look at a case where boxes allow us to define types that we
+wouldn’t be allowed to if we didn’t have boxes.
A value of recursive type can have another value of the same type as part of
+itself. Recursive types pose an issue because at compile time Rust needs to
+know how much space a type takes up. However, the nesting of values of
+recursive types could theoretically continue infinitely, so Rust can’t know how
+much space the value needs. Because boxes have a known size, we can enable
+recursive types by inserting a box in the recursive type definition.
+
As an example of a recursive type, let’s explore the cons list. This is a data
+type commonly found in functional programming languages. The cons list type
+we’ll define is straightforward except for the recursion; therefore, the
+concepts in the example we’ll work with will be useful any time you get into
+more complex situations involving recursive types.
A cons list is a data structure that comes from the Lisp programming language
+and its dialects and is made up of nested pairs, and is the Lisp version of a
+linked list. Its name comes from the cons function (short for “construct
+function”) in Lisp that constructs a new pair from its two arguments. By
+calling cons on a pair consisting of a value and another pair, we can
+construct cons lists made up of recursive pairs.
+
For example, here’s a pseudocode representation of a cons list containing the
+list 1, 2, 3 with each pair in parentheses:
+
(1, (2, (3, Nil)))
+
+
Each item in a cons list contains two elements: the value of the current item
+and the next item. The last item in the list contains only a value called Nil
+without a next item. A cons list is produced by recursively calling the cons
+function. The canonical name to denote the base case of the recursion is Nil.
+Note that this is not the same as the “null” or “nil” concept in Chapter 6,
+which is an invalid or absent value.
+
The cons list isn’t a commonly used data structure in Rust. Most of the time
+when you have a list of items in Rust, Vec<T> is a better choice to use.
+Other, more complex recursive data types are useful in various situations,
+but by starting with the cons list in this chapter, we can explore how boxes
+let us define a recursive data type without much distraction.
+
Listing 15-2 contains an enum definition for a cons list. Note that this code
+won’t compile yet because the List type doesn’t have a known size, which
+we’ll demonstrate.
Listing 15-2: The first attempt at defining an enum to
+represent a cons list data structure of i32 values
+
+
Note: We’re implementing a cons list that holds only i32 values for the
+purposes of this example. We could have implemented it using generics, as we
+discussed in Chapter 10, to define a cons list type that could store values of
+any type.
+
+
Using the List type to store the list 1, 2, 3 would look like the code in
+Listing 15-3:
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, List),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+
+fn main() {
+ let list = Cons(1, Cons(2, Cons(3, Nil)));
+}
+
Listing 15-3: Using the List enum to store the list 1, 2, 3
+
The first Cons value holds 1 and another List value. This List value is
+another Cons value that holds 2 and another List value. This List value
+is one more Cons value that holds 3 and a List value, which is finally
+Nil, the non-recursive variant that signals the end of the list.
+
If we try to compile the code in Listing 15-3, we get the error shown in
+Listing 15-4:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+error[E0072]: recursive type `List` has infinite size
+ --> src/main.rs:1:1
+ |
+1 | enum List {
+ | ^^^^^^^^^
+2 | Cons(i32, List),
+ | ---- recursive without indirection
+ |
+help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to break the cycle
+ |
+2 | Cons(i32, Box<List>),
+ | ++++ +
+
+error[E0391]: cycle detected when computing when `List` needs drop
+ --> src/main.rs:1:1
+ |
+1 | enum List {
+ | ^^^^^^^^^
+ |
+ = note: ...which immediately requires computing when `List` needs drop again
+ = note: cycle used when computing whether `List` needs drop
+ = note: see https://rustc-dev-guide.rust-lang.org/overview.html#queries and https://rustc-dev-guide.rust-lang.org/query.html for more information
+
+Some errors have detailed explanations: E0072, E0391.
+For more information about an error, try `rustc --explain E0072`.
+error: could not compile `cons-list` (bin "cons-list") due to 2 previous errors
+
+
Listing 15-4: The error we get when attempting to define
+a recursive enum
+
The error shows this type “has infinite size.” The reason is that we’ve defined
+List with a variant that is recursive: it holds another value of itself
+directly. As a result, Rust can’t figure out how much space it needs to store a
+List value. Let’s break down why we get this error. First, we’ll look at how
+Rust decides how much space it needs to store a value of a non-recursive type.
To determine how much space to allocate for a Message value, Rust goes
+through each of the variants to see which variant needs the most space. Rust
+sees that Message::Quit doesn’t need any space, Message::Move needs enough
+space to store two i32 values, and so forth. Because only one variant will be
+used, the most space a Message value will need is the space it would take to
+store the largest of its variants.
+
Contrast this with what happens when Rust tries to determine how much space a
+recursive type like the List enum in Listing 15-2 needs. The compiler starts
+by looking at the Cons variant, which holds a value of type i32 and a value
+of type List. Therefore, Cons needs an amount of space equal to the size of
+an i32 plus the size of a List. To figure out how much memory the List
+type needs, the compiler looks at the variants, starting with the Cons
+variant. The Cons variant holds a value of type i32 and a value of type
+List, and this process continues infinitely, as shown in Figure 15-1.
+
+
Figure 15-1: An infinite List consisting of infinite
+Cons variants
Because Rust can’t figure out how much space to allocate for recursively
+defined types, the compiler gives an error with this helpful suggestion:
+
+
help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to break the cycle
+ |
+2 | Cons(i32, Box<List>),
+ | ++++ +
+
+
In this suggestion, “indirection” means that instead of storing a value
+directly, we should change the data structure to store the value indirectly by
+storing a pointer to the value instead.
+
Because a Box<T> is a pointer, Rust always knows how much space a Box<T>
+needs: a pointer’s size doesn’t change based on the amount of data it’s
+pointing to. This means we can put a Box<T> inside the Cons variant instead
+of another List value directly. The Box<T> will point to the next List
+value that will be on the heap rather than inside the Cons variant.
+Conceptually, we still have a list, created with lists holding other lists, but
+this implementation is now more like placing the items next to one another
+rather than inside one another.
+
We can change the definition of the List enum in Listing 15-2 and the usage
+of the List in Listing 15-3 to the code in Listing 15-5, which will compile:
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Box<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+
+fn main() {
+ let list = Cons(1, Box::new(Cons(2, Box::new(Cons(3, Box::new(Nil))))));
+}
+
Listing 15-5: Definition of List that uses Box<T> in
+order to have a known size
+
The Cons variant needs the size of an i32 plus the space to store the
+box’s pointer data. The Nil variant stores no values, so it needs less space
+than the Cons variant. We now know that any List value will take up the
+size of an i32 plus the size of a box’s pointer data. By using a box, we’ve
+broken the infinite, recursive chain, so the compiler can figure out the size
+it needs to store a List value. Figure 15-2 shows what the Cons variant
+looks like now.
+
+
Figure 15-2: A List that is not infinitely sized
+because Cons holds a Box
+
Boxes provide only the indirection and heap allocation; they don’t have any
+other special capabilities, like those we’ll see with the other smart pointer
+types. They also don’t have the performance overhead that these special
+capabilities incur, so they can be useful in cases like the cons list where the
+indirection is the only feature we need. We’ll look at more use cases for boxes
+in Chapter 17, too.
+
The Box<T> type is a smart pointer because it implements the Deref trait,
+which allows Box<T> values to be treated like references. When a Box<T>
+value goes out of scope, the heap data that the box is pointing to is cleaned
+up as well because of the Drop trait implementation. These two traits will be
+even more important to the functionality provided by the other smart pointer
+types we’ll discuss in the rest of this chapter. Let’s explore these two traits
+in more detail.
Implementing the Deref trait allows you to customize the behavior of the
+dereference operator* (not to be confused with the multiplication or glob
+operator). By implementing Deref in such a way that a smart pointer can be
+treated like a regular reference, you can write code that operates on
+references and use that code with smart pointers too.
+
Let’s first look at how the dereference operator works with regular references.
+Then we’ll try to define a custom type that behaves like Box<T>, and see why
+the dereference operator doesn’t work like a reference on our newly defined
+type. We’ll explore how implementing the Deref trait makes it possible for
+smart pointers to work in ways similar to references. Then we’ll look at
+Rust’s deref coercion feature and how it lets us work with either references
+or smart pointers.
+
+
Note: There’s one big difference between the MyBox<T> type we’re about to
+build and the real Box<T>: our version will not store its data on the heap.
+We are focusing this example on Deref, so where the data is actually stored
+is less important than the pointer-like behavior.
A regular reference is a type of pointer, and one way to think of a pointer is
+as an arrow to a value stored somewhere else. In Listing 15-6, we create a
+reference to an i32 value and then use the dereference operator to follow the
+reference to the value:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+ let y = &x;
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-6: Using the dereference operator to follow a
+reference to an i32 value
+
The variable x holds an i32 value 5. We set y equal to a reference to
+x. We can assert that x is equal to 5. However, if we want to make an
+assertion about the value in y, we have to use *y to follow the reference
+to the value it’s pointing to (hence dereference) so the compiler can compare
+the actual value. Once we dereference y, we have access to the integer value
+y is pointing to that we can compare with 5.
+
If we tried to write assert_eq!(5, y); instead, we would get this compilation
+error:
+
$ cargo run
+ Compiling deref-example v0.1.0 (file:///projects/deref-example)
+error[E0277]: can't compare `{integer}` with `&{integer}`
+ --> src/main.rs:6:5
+ |
+6 | assert_eq!(5, y);
+ | ^^^^^^^^^^^^^^^^ no implementation for `{integer} == &{integer}`
+ |
+ = help: the trait `PartialEq<&{integer}>` is not implemented for `{integer}`
+ = note: this error originates in the macro `assert_eq` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `deref-example` (bin "deref-example") due to 1 previous error
+
+
Comparing a number and a reference to a number isn’t allowed because they’re
+different types. We must use the dereference operator to follow the reference
+to the value it’s pointing to.
We can rewrite the code in Listing 15-6 to use a Box<T> instead of a
+reference; the dereference operator used on the Box<T> in Listing 15-7
+functions in the same way as the dereference operator used on the reference in
+Listing 15-6:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+ let y = Box::new(x);
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-7: Using the dereference operator on a
+Box<i32>
+
The main difference between Listing 15-7 and Listing 15-6 is that here we set
+y to be an instance of a Box<T> pointing to a copied value of x rather
+than a reference pointing to the value of x. In the last assertion, we can
+use the dereference operator to follow the pointer of the Box<T> in the same
+way that we did when y was a reference. Next, we’ll explore what is special
+about Box<T> that enables us to use the dereference operator by defining our
+own type.
Let’s build a smart pointer similar to the Box<T> type provided by the
+standard library to experience how smart pointers behave differently from
+references by default. Then we’ll look at how to add the ability to use the
+dereference operator.
+
The Box<T> type is ultimately defined as a tuple struct with one element, so
+Listing 15-8 defines a MyBox<T> type in the same way. We’ll also define a
+new function to match the new function defined on Box<T>.
We define a struct named MyBox and declare a generic parameter T, because
+we want our type to hold values of any type. The MyBox type is a tuple struct
+with one element of type T. The MyBox::new function takes one parameter of
+type T and returns a MyBox instance that holds the value passed in.
+
Let’s try adding the main function in Listing 15-7 to Listing 15-8 and
+changing it to use the MyBox<T> type we’ve defined instead of Box<T>. The
+code in Listing 15-9 won’t compile because Rust doesn’t know how to dereference
+MyBox.
+
Filename: src/main.rs
+
struct MyBox<T>(T);
+
+impl<T> MyBox<T> {
+ fn new(x: T) -> MyBox<T> {
+ MyBox(x)
+ }
+}
+
+fn main() {
+ let x = 5;
+ let y = MyBox::new(x);
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-9: Attempting to use MyBox<T> in the same
+way we used references and Box<T>
+
Here’s the resulting compilation error:
+
$ cargo run
+ Compiling deref-example v0.1.0 (file:///projects/deref-example)
+error[E0614]: type `MyBox<{integer}>` cannot be dereferenced
+ --> src/main.rs:14:19
+ |
+14 | assert_eq!(5, *y);
+ | ^^
+
+For more information about this error, try `rustc --explain E0614`.
+error: could not compile `deref-example` (bin "deref-example") due to 1 previous error
+
+
Our MyBox<T> type can’t be dereferenced because we haven’t implemented that
+ability on our type. To enable dereferencing with the * operator, we
+implement the Deref trait.
As discussed in the “Implementing a Trait on a Type” section of Chapter 10, to implement a trait, we need to provide
+implementations for the trait’s required methods. The Deref trait, provided
+by the standard library, requires us to implement one method named deref that
+borrows self and returns a reference to the inner data. Listing 15-10
+contains an implementation of Deref to add to the definition of MyBox:
+
Filename: src/main.rs
+
use std::ops::Deref;
+
+impl<T> Deref for MyBox<T> {
+ type Target = T;
+
+ fn deref(&self) -> &Self::Target {
+ &self.0
+ }
+}
+
+struct MyBox<T>(T);
+
+impl<T> MyBox<T> {
+ fn new(x: T) -> MyBox<T> {
+ MyBox(x)
+ }
+}
+
+fn main() {
+ let x = 5;
+ let y = MyBox::new(x);
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-10: Implementing Deref on MyBox<T>
+
The type Target = T; syntax defines an associated type for the Deref
+trait to use. Associated types are a slightly different way of declaring a
+generic parameter, but you don’t need to worry about them for now; we’ll cover
+them in more detail in Chapter 19.
+
We fill in the body of the deref method with &self.0 so deref returns a
+reference to the value we want to access with the * operator; recall from the
+“Using Tuple Structs without Named Fields to Create Different
+Types” section of Chapter 5 that .0 accesses
+the first value in a tuple struct. The main function in Listing 15-9 that
+calls * on the MyBox<T> value now compiles, and the assertions pass!
+
Without the Deref trait, the compiler can only dereference & references.
+The deref method gives the compiler the ability to take a value of any type
+that implements Deref and call the deref method to get a & reference that
+it knows how to dereference.
+
When we entered *y in Listing 15-9, behind the scenes Rust actually ran this
+code:
+
*(y.deref())
+
Rust substitutes the * operator with a call to the deref method and then a
+plain dereference so we don’t have to think about whether or not we need to
+call the deref method. This Rust feature lets us write code that functions
+identically whether we have a regular reference or a type that implements
+Deref.
+
The reason the deref method returns a reference to a value, and that the
+plain dereference outside the parentheses in *(y.deref()) is still necessary,
+is to do with the ownership system. If the deref method returned the value
+directly instead of a reference to the value, the value would be moved out of
+self. We don’t want to take ownership of the inner value inside MyBox<T> in
+this case or in most cases where we use the dereference operator.
+
Note that the * operator is replaced with a call to the deref method and
+then a call to the * operator just once, each time we use a * in our code.
+Because the substitution of the * operator does not recurse infinitely, we
+end up with data of type i32, which matches the 5 in assert_eq! in
+Listing 15-9.
Deref coercion converts a reference to a type that implements the Deref
+trait into a reference to another type. For example, deref coercion can convert
+&String to &str because String implements the Deref trait such that it
+returns &str. Deref coercion is a convenience Rust performs on arguments to
+functions and methods, and works only on types that implement the Deref
+trait. It happens automatically when we pass a reference to a particular type’s
+value as an argument to a function or method that doesn’t match the parameter
+type in the function or method definition. A sequence of calls to the deref
+method converts the type we provided into the type the parameter needs.
+
Deref coercion was added to Rust so that programmers writing function and
+method calls don’t need to add as many explicit references and dereferences
+with & and *. The deref coercion feature also lets us write more code that
+can work for either references or smart pointers.
+
To see deref coercion in action, let’s use the MyBox<T> type we defined in
+Listing 15-8 as well as the implementation of Deref that we added in Listing
+15-10. Listing 15-11 shows the definition of a function that has a string slice
+parameter:
Listing 15-11: A hello function that has the parameter
+name of type &str
+
We can call the hello function with a string slice as an argument, such as
+hello("Rust"); for example. Deref coercion makes it possible to call hello
+with a reference to a value of type MyBox<String>, as shown in Listing 15-12:
Listing 15-12: Calling hello with a reference to a
+MyBox<String> value, which works because of deref coercion
+
Here we’re calling the hello function with the argument &m, which is a
+reference to a MyBox<String> value. Because we implemented the Deref trait
+on MyBox<T> in Listing 15-10, Rust can turn &MyBox<String> into &String
+by calling deref. The standard library provides an implementation of Deref
+on String that returns a string slice, and this is in the API documentation
+for Deref. Rust calls deref again to turn the &String into &str, which
+matches the hello function’s definition.
+
If Rust didn’t implement deref coercion, we would have to write the code in
+Listing 15-13 instead of the code in Listing 15-12 to call hello with a value
+of type &MyBox<String>.
Listing 15-13: The code we would have to write if Rust
+didn’t have deref coercion
+
The (*m) dereferences the MyBox<String> into a String. Then the & and
+[..] take a string slice of the String that is equal to the whole string to
+match the signature of hello. This code without deref coercions is harder to
+read, write, and understand with all of these symbols involved. Deref coercion
+allows Rust to handle these conversions for us automatically.
+
When the Deref trait is defined for the types involved, Rust will analyze the
+types and use Deref::deref as many times as necessary to get a reference to
+match the parameter’s type. The number of times that Deref::deref needs to be
+inserted is resolved at compile time, so there is no runtime penalty for taking
+advantage of deref coercion!
Similar to how you use the Deref trait to override the * operator on
+immutable references, you can use the DerefMut trait to override the *
+operator on mutable references.
+
Rust does deref coercion when it finds types and trait implementations in three
+cases:
+
+
From &T to &U when T: Deref<Target=U>
+
From &mut T to &mut U when T: DerefMut<Target=U>
+
From &mut T to &U when T: Deref<Target=U>
+
+
The first two cases are the same as each other except that the second
+implements mutability. The first case states that if you have a &T, and T
+implements Deref to some type U, you can get a &U transparently. The
+second case states that the same deref coercion happens for mutable references.
+
The third case is trickier: Rust will also coerce a mutable reference to an
+immutable one. But the reverse is not possible: immutable references will
+never coerce to mutable references. Because of the borrowing rules, if you have
+a mutable reference, that mutable reference must be the only reference to that
+data (otherwise, the program wouldn’t compile). Converting one mutable
+reference to one immutable reference will never break the borrowing rules.
+Converting an immutable reference to a mutable reference would require that the
+initial immutable reference is the only immutable reference to that data, but
+the borrowing rules don’t guarantee that. Therefore, Rust can’t make the
+assumption that converting an immutable reference to a mutable reference is
+possible.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch15-03-drop.html b/ch15-03-drop.html
new file mode 100644
index 0000000000..6dd768d1be
--- /dev/null
+++ b/ch15-03-drop.html
@@ -0,0 +1,418 @@
+
+
+
+
+
+ Running Code on Cleanup with the Drop Trait - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The second trait important to the smart pointer pattern is Drop, which lets
+you customize what happens when a value is about to go out of scope. You can
+provide an implementation for the Drop trait on any type, and that code can
+be used to release resources like files or network connections.
+
We’re introducing Drop in the context of smart pointers because the
+functionality of the Drop trait is almost always used when implementing a
+smart pointer. For example, when a Box<T> is dropped it will deallocate the
+space on the heap that the box points to.
+
In some languages, for some types, the programmer must call code to free memory
+or resources every time they finish using an instance of those types. Examples
+include file handles, sockets, or locks. If they forget, the system might
+become overloaded and crash. In Rust, you can specify that a particular bit of
+code be run whenever a value goes out of scope, and the compiler will insert
+this code automatically. As a result, you don’t need to be careful about
+placing cleanup code everywhere in a program that an instance of a particular
+type is finished with—you still won’t leak resources!
+
You specify the code to run when a value goes out of scope by implementing the
+Drop trait. The Drop trait requires you to implement one method named
+drop that takes a mutable reference to self. To see when Rust calls drop,
+let’s implement drop with println! statements for now.
+
Listing 15-14 shows a CustomSmartPointer struct whose only custom
+functionality is that it will print Dropping CustomSmartPointer! when the
+instance goes out of scope, to show when Rust runs the drop function.
+
Filename: src/main.rs
+
struct CustomSmartPointer {
+ data: String,
+}
+
+impl Drop for CustomSmartPointer {
+ fn drop(&mut self) {
+ println!("Dropping CustomSmartPointer with data `{}`!", self.data);
+ }
+}
+
+fn main() {
+ let c = CustomSmartPointer {
+ data: String::from("my stuff"),
+ };
+ let d = CustomSmartPointer {
+ data: String::from("other stuff"),
+ };
+ println!("CustomSmartPointers created.");
+}
+
Listing 15-14: A CustomSmartPointer struct that
+implements the Drop trait where we would put our cleanup code
+
The Drop trait is included in the prelude, so we don’t need to bring it into
+scope. We implement the Drop trait on CustomSmartPointer and provide an
+implementation for the drop method that calls println!. The body of the
+drop function is where you would place any logic that you wanted to run when
+an instance of your type goes out of scope. We’re printing some text here to
+demonstrate visually when Rust will call drop.
+
In main, we create two instances of CustomSmartPointer and then print
+CustomSmartPointers created. At the end of main, our instances of
+CustomSmartPointer will go out of scope, and Rust will call the code we put
+in the drop method, printing our final message. Note that we didn’t need to
+call the drop method explicitly.
+
When we run this program, we’ll see the following output:
+
$ cargo run
+ Compiling drop-example v0.1.0 (file:///projects/drop-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.60s
+ Running `target/debug/drop-example`
+CustomSmartPointers created.
+Dropping CustomSmartPointer with data `other stuff`!
+Dropping CustomSmartPointer with data `my stuff`!
+
+
Rust automatically called drop for us when our instances went out of scope,
+calling the code we specified. Variables are dropped in the reverse order of
+their creation, so d was dropped before c. This example’s purpose is to
+give you a visual guide to how the drop method works; usually you would
+specify the cleanup code that your type needs to run rather than a print
+message.
Unfortunately, it’s not straightforward to disable the automatic drop
+functionality. Disabling drop isn’t usually necessary; the whole point of the
+Drop trait is that it’s taken care of automatically. Occasionally, however,
+you might want to clean up a value early. One example is when using smart
+pointers that manage locks: you might want to force the drop method that
+releases the lock so that other code in the same scope can acquire the lock.
+Rust doesn’t let you call the Drop trait’s drop method manually; instead
+you have to call the std::mem::drop function provided by the standard library
+if you want to force a value to be dropped before the end of its scope.
+
If we try to call the Drop trait’s drop method manually by modifying the
+main function from Listing 15-14, as shown in Listing 15-15, we’ll get a
+compiler error:
+
Filename: src/main.rs
+
struct CustomSmartPointer {
+ data: String,
+}
+
+impl Drop for CustomSmartPointer {
+ fn drop(&mut self) {
+ println!("Dropping CustomSmartPointer with data `{}`!", self.data);
+ }
+}
+
+fn main() {
+ let c = CustomSmartPointer {
+ data: String::from("some data"),
+ };
+ println!("CustomSmartPointer created.");
+ c.drop();
+ println!("CustomSmartPointer dropped before the end of main.");
+}
+
Listing 15-15: Attempting to call the drop method from
+the Drop trait manually to clean up early
+
When we try to compile this code, we’ll get this error:
+
$ cargo run
+ Compiling drop-example v0.1.0 (file:///projects/drop-example)
+error[E0040]: explicit use of destructor method
+ --> src/main.rs:16:7
+ |
+16 | c.drop();
+ | ^^^^ explicit destructor calls not allowed
+ |
+help: consider using `drop` function
+ |
+16 | drop(c);
+ | +++++ ~
+
+For more information about this error, try `rustc --explain E0040`.
+error: could not compile `drop-example` (bin "drop-example") due to 1 previous error
+
+
This error message states that we’re not allowed to explicitly call drop. The
+error message uses the term destructor, which is the general programming term
+for a function that cleans up an instance. A destructor is analogous to a
+constructor, which creates an instance. The drop function in Rust is one
+particular destructor.
+
Rust doesn’t let us call drop explicitly because Rust would still
+automatically call drop on the value at the end of main. This would cause a
+double free error because Rust would be trying to clean up the same value
+twice.
+
We can’t disable the automatic insertion of drop when a value goes out of
+scope, and we can’t call the drop method explicitly. So, if we need to force
+a value to be cleaned up early, we use the std::mem::drop function.
+
The std::mem::drop function is different from the drop method in the Drop
+trait. We call it by passing as an argument the value we want to force drop.
+The function is in the prelude, so we can modify main in Listing 15-15 to
+call the drop function, as shown in Listing 15-16:
+
Filename: src/main.rs
+
struct CustomSmartPointer {
+ data: String,
+}
+
+impl Drop for CustomSmartPointer {
+ fn drop(&mut self) {
+ println!("Dropping CustomSmartPointer with data `{}`!", self.data);
+ }
+}
+
+fn main() {
+ let c = CustomSmartPointer {
+ data: String::from("some data"),
+ };
+ println!("CustomSmartPointer created.");
+ drop(c);
+ println!("CustomSmartPointer dropped before the end of main.");
+}
+
Listing 15-16: Calling std::mem::drop to explicitly
+drop a value before it goes out of scope
+
Running this code will print the following:
+
$ cargo run
+ Compiling drop-example v0.1.0 (file:///projects/drop-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.73s
+ Running `target/debug/drop-example`
+CustomSmartPointer created.
+Dropping CustomSmartPointer with data `some data`!
+CustomSmartPointer dropped before the end of main.
+
+
The text Dropping CustomSmartPointer with data `some data`! is printed
+between the CustomSmartPointer created. and CustomSmartPointer dropped before the end of main. text, showing that the drop method code is called to
+drop c at that point.
+
You can use code specified in a Drop trait implementation in many ways to
+make cleanup convenient and safe: for instance, you could use it to create your
+own memory allocator! With the Drop trait and Rust’s ownership system, you
+don’t have to remember to clean up because Rust does it automatically.
+
You also don’t have to worry about problems resulting from accidentally
+cleaning up values still in use: the ownership system that makes sure
+references are always valid also ensures that drop gets called only once when
+the value is no longer being used.
+
Now that we’ve examined Box<T> and some of the characteristics of smart
+pointers, let’s look at a few other smart pointers defined in the standard
+library.
In the majority of cases, ownership is clear: you know exactly which variable
+owns a given value. However, there are cases when a single value might have
+multiple owners. For example, in graph data structures, multiple edges might
+point to the same node, and that node is conceptually owned by all of the edges
+that point to it. A node shouldn’t be cleaned up unless it doesn’t have any
+edges pointing to it and so has no owners.
+
You have to enable multiple ownership explicitly by using the Rust type
+Rc<T>, which is an abbreviation for reference counting. The Rc<T> type
+keeps track of the number of references to a value to determine whether or not
+the value is still in use. If there are zero references to a value, the value
+can be cleaned up without any references becoming invalid.
+
Imagine Rc<T> as a TV in a family room. When one person enters to watch TV,
+they turn it on. Others can come into the room and watch the TV. When the last
+person leaves the room, they turn off the TV because it’s no longer being used.
+If someone turns off the TV while others are still watching it, there would be
+uproar from the remaining TV watchers!
+
We use the Rc<T> type when we want to allocate some data on the heap for
+multiple parts of our program to read and we can’t determine at compile time
+which part will finish using the data last. If we knew which part would finish
+last, we could just make that part the data’s owner, and the normal ownership
+rules enforced at compile time would take effect.
+
Note that Rc<T> is only for use in single-threaded scenarios. When we discuss
+concurrency in Chapter 16, we’ll cover how to do reference counting in
+multithreaded programs.
Let’s return to our cons list example in Listing 15-5. Recall that we defined
+it using Box<T>. This time, we’ll create two lists that both share ownership
+of a third list. Conceptually, this looks similar to Figure 15-3:
+
+
Figure 15-3: Two lists, b and c, sharing ownership of
+a third list, a
+
We’ll create list a that contains 5 and then 10. Then we’ll make two more
+lists: b that starts with 3 and c that starts with 4. Both b and c
+lists will then continue on to the first a list containing 5 and 10. In other
+words, both lists will share the first list containing 5 and 10.
+
Trying to implement this scenario using our definition of List with Box<T>
+won’t work, as shown in Listing 15-17:
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Box<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+
+fn main() {
+ let a = Cons(5, Box::new(Cons(10, Box::new(Nil))));
+ let b = Cons(3, Box::new(a));
+ let c = Cons(4, Box::new(a));
+}
+
Listing 15-17: Demonstrating we’re not allowed to have
+two lists using Box<T> that try to share ownership of a third list
+
When we compile this code, we get this error:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+error[E0382]: use of moved value: `a`
+ --> src/main.rs:11:30
+ |
+9 | let a = Cons(5, Box::new(Cons(10, Box::new(Nil))));
+ | - move occurs because `a` has type `List`, which does not implement the `Copy` trait
+10 | let b = Cons(3, Box::new(a));
+ | - value moved here
+11 | let c = Cons(4, Box::new(a));
+ | ^ value used here after move
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `cons-list` (bin "cons-list") due to 1 previous error
+
+
The Cons variants own the data they hold, so when we create the b list, a
+is moved into b and b owns a. Then, when we try to use a again when
+creating c, we’re not allowed to because a has been moved.
+
We could change the definition of Cons to hold references instead, but then
+we would have to specify lifetime parameters. By specifying lifetime
+parameters, we would be specifying that every element in the list will live at
+least as long as the entire list. This is the case for the elements and lists
+in Listing 15-17, but not in every scenario.
+
Instead, we’ll change our definition of List to use Rc<T> in place of
+Box<T>, as shown in Listing 15-18. Each Cons variant will now hold a value
+and an Rc<T> pointing to a List. When we create b, instead of taking
+ownership of a, we’ll clone the Rc<List> that a is holding, thereby
+increasing the number of references from one to two and letting a and b
+share ownership of the data in that Rc<List>. We’ll also clone a when
+creating c, increasing the number of references from two to three. Every time
+we call Rc::clone, the reference count to the data within the Rc<List> will
+increase, and the data won’t be cleaned up unless there are zero references to
+it.
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Rc<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+use std::rc::Rc;
+
+fn main() {
+ let a = Rc::new(Cons(5, Rc::new(Cons(10, Rc::new(Nil)))));
+ let b = Cons(3, Rc::clone(&a));
+ let c = Cons(4, Rc::clone(&a));
+}
+
Listing 15-18: A definition of List that uses
+Rc<T>
+
We need to add a use statement to bring Rc<T> into scope because it’s not
+in the prelude. In main, we create the list holding 5 and 10 and store it in
+a new Rc<List> in a. Then when we create b and c, we call the
+Rc::clone function and pass a reference to the Rc<List> in a as an
+argument.
+
We could have called a.clone() rather than Rc::clone(&a), but Rust’s
+convention is to use Rc::clone in this case. The implementation of
+Rc::clone doesn’t make a deep copy of all the data like most types’
+implementations of clone do. The call to Rc::clone only increments the
+reference count, which doesn’t take much time. Deep copies of data can take a
+lot of time. By using Rc::clone for reference counting, we can visually
+distinguish between the deep-copy kinds of clones and the kinds of clones that
+increase the reference count. When looking for performance problems in the
+code, we only need to consider the deep-copy clones and can disregard calls to
+Rc::clone.
Let’s change our working example in Listing 15-18 so we can see the reference
+counts changing as we create and drop references to the Rc<List> in a.
+
In Listing 15-19, we’ll change main so it has an inner scope around list c;
+then we can see how the reference count changes when c goes out of scope.
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Rc<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+use std::rc::Rc;
+
+fn main() {
+ let a = Rc::new(Cons(5, Rc::new(Cons(10, Rc::new(Nil)))));
+ println!("count after creating a = {}", Rc::strong_count(&a));
+ let b = Cons(3, Rc::clone(&a));
+ println!("count after creating b = {}", Rc::strong_count(&a));
+ {
+ let c = Cons(4, Rc::clone(&a));
+ println!("count after creating c = {}", Rc::strong_count(&a));
+ }
+ println!("count after c goes out of scope = {}", Rc::strong_count(&a));
+}
+
Listing 15-19: Printing the reference count
+
At each point in the program where the reference count changes, we print the
+reference count, which we get by calling the Rc::strong_count function. This
+function is named strong_count rather than count because the Rc<T> type
+also has a weak_count; we’ll see what weak_count is used for in the
+“Preventing Reference Cycles: Turning an Rc<T> into a
+Weak<T>” section.
+
This code prints the following:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.45s
+ Running `target/debug/cons-list`
+count after creating a = 1
+count after creating b = 2
+count after creating c = 3
+count after c goes out of scope = 2
+
+
We can see that the Rc<List> in a has an initial reference count of 1; then
+each time we call clone, the count goes up by 1. When c goes out of scope,
+the count goes down by 1. We don’t have to call a function to decrease the
+reference count like we have to call Rc::clone to increase the reference
+count: the implementation of the Drop trait decreases the reference count
+automatically when an Rc<T> value goes out of scope.
+
What we can’t see in this example is that when b and then a go out of scope
+at the end of main, the count is then 0, and the Rc<List> is cleaned up
+completely. Using Rc<T> allows a single value to have multiple owners, and
+the count ensures that the value remains valid as long as any of the owners
+still exist.
+
Via immutable references, Rc<T> allows you to share data between multiple
+parts of your program for reading only. If Rc<T> allowed you to have multiple
+mutable references too, you might violate one of the borrowing rules discussed
+in Chapter 4: multiple mutable borrows to the same place can cause data races
+and inconsistencies. But being able to mutate data is very useful! In the next
+section, we’ll discuss the interior mutability pattern and the RefCell<T>
+type that you can use in conjunction with an Rc<T> to work with this
+immutability restriction.
Interior mutability is a design pattern in Rust that allows you to mutate
+data even when there are immutable references to that data; normally, this
+action is disallowed by the borrowing rules. To mutate data, the pattern uses
+unsafe code inside a data structure to bend Rust’s usual rules that govern
+mutation and borrowing. Unsafe code indicates to the compiler that we’re
+checking the rules manually instead of relying on the compiler to check them
+for us; we will discuss unsafe code more in Chapter 19.
+
We can use types that use the interior mutability pattern only when we can
+ensure that the borrowing rules will be followed at runtime, even though the
+compiler can’t guarantee that. The unsafe code involved is then wrapped in a
+safe API, and the outer type is still immutable.
+
Let’s explore this concept by looking at the RefCell<T> type that follows the
+interior mutability pattern.
Unlike Rc<T>, the RefCell<T> type represents single ownership over the data
+it holds. So, what makes RefCell<T> different from a type like Box<T>?
+Recall the borrowing rules you learned in Chapter 4:
+
+
At any given time, you can have either (but not both) one mutable reference
+or any number of immutable references.
+
References must always be valid.
+
+
With references and Box<T>, the borrowing rules’ invariants are enforced at
+compile time. With RefCell<T>, these invariants are enforced at runtime.
+With references, if you break these rules, you’ll get a compiler error. With
+RefCell<T>, if you break these rules, your program will panic and exit.
+
The advantages of checking the borrowing rules at compile time are that errors
+will be caught sooner in the development process, and there is no impact on
+runtime performance because all the analysis is completed beforehand. For those
+reasons, checking the borrowing rules at compile time is the best choice in the
+majority of cases, which is why this is Rust’s default.
+
The advantage of checking the borrowing rules at runtime instead is that
+certain memory-safe scenarios are then allowed, where they would’ve been
+disallowed by the compile-time checks. Static analysis, like the Rust compiler,
+is inherently conservative. Some properties of code are impossible to detect by
+analyzing the code: the most famous example is the Halting Problem, which is
+beyond the scope of this book but is an interesting topic to research.
+
Because some analysis is impossible, if the Rust compiler can’t be sure the
+code complies with the ownership rules, it might reject a correct program; in
+this way, it’s conservative. If Rust accepted an incorrect program, users
+wouldn’t be able to trust in the guarantees Rust makes. However, if Rust
+rejects a correct program, the programmer will be inconvenienced, but nothing
+catastrophic can occur. The RefCell<T> type is useful when you’re sure your
+code follows the borrowing rules but the compiler is unable to understand and
+guarantee that.
+
Similar to Rc<T>, RefCell<T> is only for use in single-threaded scenarios
+and will give you a compile-time error if you try using it in a multithreaded
+context. We’ll talk about how to get the functionality of RefCell<T> in a
+multithreaded program in Chapter 16.
+
Here is a recap of the reasons to choose Box<T>, Rc<T>, or RefCell<T>:
+
+
Rc<T> enables multiple owners of the same data; Box<T> and RefCell<T>
+have single owners.
+
Box<T> allows immutable or mutable borrows checked at compile time; Rc<T>
+allows only immutable borrows checked at compile time; RefCell<T> allows
+immutable or mutable borrows checked at runtime.
+
Because RefCell<T> allows mutable borrows checked at runtime, you can
+mutate the value inside the RefCell<T> even when the RefCell<T> is
+immutable.
+
+
Mutating the value inside an immutable value is the interior mutability
+pattern. Let’s look at a situation in which interior mutability is useful and
+examine how it’s possible.
A consequence of the borrowing rules is that when you have an immutable value,
+you can’t borrow it mutably. For example, this code won’t compile:
+
fn main() {
+ let x = 5;
+ let y = &mut x;
+}
+
If you tried to compile this code, you’d get the following error:
+
$ cargo run
+ Compiling borrowing v0.1.0 (file:///projects/borrowing)
+error[E0596]: cannot borrow `x` as mutable, as it is not declared as mutable
+ --> src/main.rs:3:13
+ |
+3 | let y = &mut x;
+ | ^^^^^^ cannot borrow as mutable
+ |
+help: consider changing this to be mutable
+ |
+2 | let mut x = 5;
+ | +++
+
+For more information about this error, try `rustc --explain E0596`.
+error: could not compile `borrowing` (bin "borrowing") due to 1 previous error
+
+
However, there are situations in which it would be useful for a value to mutate
+itself in its methods but appear immutable to other code. Code outside the
+value’s methods would not be able to mutate the value. Using RefCell<T> is
+one way to get the ability to have interior mutability, but RefCell<T>
+doesn’t get around the borrowing rules completely: the borrow checker in the
+compiler allows this interior mutability, and the borrowing rules are checked
+at runtime instead. If you violate the rules, you’ll get a panic! instead of
+a compiler error.
+
Let’s work through a practical example where we can use RefCell<T> to mutate
+an immutable value and see why that is useful.
Sometimes during testing a programmer will use a type in place of another type,
+in order to observe particular behavior and assert it’s implemented correctly.
+This placeholder type is called a test double. Think of it in the sense of a
+“stunt double” in filmmaking, where a person steps in and substitutes for an
+actor to do a particular tricky scene. Test doubles stand in for other types
+when we’re running tests. Mock objects are specific types of test doubles
+that record what happens during a test so you can assert that the correct
+actions took place.
+
Rust doesn’t have objects in the same sense as other languages have objects,
+and Rust doesn’t have mock object functionality built into the standard library
+as some other languages do. However, you can definitely create a struct that
+will serve the same purposes as a mock object.
+
Here’s the scenario we’ll test: we’ll create a library that tracks a value
+against a maximum value and sends messages based on how close to the maximum
+value the current value is. This library could be used to keep track of a
+user’s quota for the number of API calls they’re allowed to make, for example.
+
Our library will only provide the functionality of tracking how close to the
+maximum a value is and what the messages should be at what times. Applications
+that use our library will be expected to provide the mechanism for sending the
+messages: the application could put a message in the application, send an
+email, send a text message, or something else. The library doesn’t need to know
+that detail. All it needs is something that implements a trait we’ll provide
+called Messenger. Listing 15-20 shows the library code:
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
Listing 15-20: A library to keep track of how close a
+value is to a maximum value and warn when the value is at certain levels
+
One important part of this code is that the Messenger trait has one method
+called send that takes an immutable reference to self and the text of the
+message. This trait is the interface our mock object needs to implement so that
+the mock can be used in the same way a real object is. The other important part
+is that we want to test the behavior of the set_value method on the
+LimitTracker. We can change what we pass in for the value parameter, but
+set_value doesn’t return anything for us to make assertions on. We want to be
+able to say that if we create a LimitTracker with something that implements
+the Messenger trait and a particular value for max, when we pass different
+numbers for value, the messenger is told to send the appropriate messages.
+
We need a mock object that, instead of sending an email or text message when we
+call send, will only keep track of the messages it’s told to send. We can
+create a new instance of the mock object, create a LimitTracker that uses the
+mock object, call the set_value method on LimitTracker, and then check that
+the mock object has the messages we expect. Listing 15-21 shows an attempt to
+implement a mock object to do just that, but the borrow checker won’t allow it:
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ struct MockMessenger {
+ sent_messages: Vec<String>,
+ }
+
+ impl MockMessenger {
+ fn new() -> MockMessenger {
+ MockMessenger {
+ sent_messages: vec![],
+ }
+ }
+ }
+
+ impl Messenger for MockMessenger {
+ fn send(&self, message: &str) {
+ self.sent_messages.push(String::from(message));
+ }
+ }
+
+ #[test]
+ fn it_sends_an_over_75_percent_warning_message() {
+ let mock_messenger = MockMessenger::new();
+ let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
+
+ limit_tracker.set_value(80);
+
+ assert_eq!(mock_messenger.sent_messages.len(), 1);
+ }
+}
+
Listing 15-21: An attempt to implement a MockMessenger
+that isn’t allowed by the borrow checker
+
This test code defines a MockMessenger struct that has a sent_messages
+field with a Vec of String values to keep track of the messages it’s told
+to send. We also define an associated function new to make it convenient to
+create new MockMessenger values that start with an empty list of messages. We
+then implement the Messenger trait for MockMessenger so we can give a
+MockMessenger to a LimitTracker. In the definition of the send method, we
+take the message passed in as a parameter and store it in the MockMessenger
+list of sent_messages.
+
In the test, we’re testing what happens when the LimitTracker is told to set
+value to something that is more than 75 percent of the max value. First, we
+create a new MockMessenger, which will start with an empty list of messages.
+Then we create a new LimitTracker and give it a reference to the new
+MockMessenger and a max value of 100. We call the set_value method on the
+LimitTracker with a value of 80, which is more than 75 percent of 100. Then
+we assert that the list of messages that the MockMessenger is keeping track
+of should now have one message in it.
+
However, there’s one problem with this test, as shown here:
+
$ cargo test
+ Compiling limit-tracker v0.1.0 (file:///projects/limit-tracker)
+error[E0596]: cannot borrow `self.sent_messages` as mutable, as it is behind a `&` reference
+ --> src/lib.rs:58:13
+ |
+58 | self.sent_messages.push(String::from(message));
+ | ^^^^^^^^^^^^^^^^^^ `self` is a `&` reference, so the data it refers to cannot be borrowed as mutable
+ |
+help: consider changing this to be a mutable reference
+ |
+2 | fn send(&mut self, msg: &str);
+ | ~~~~~~~~~
+
+For more information about this error, try `rustc --explain E0596`.
+error: could not compile `limit-tracker` (lib test) due to 1 previous error
+
+
We can’t modify the MockMessenger to keep track of the messages, because the
+send method takes an immutable reference to self. We also can’t take the
+suggestion from the error text to use &mut self instead, because then the
+signature of send wouldn’t match the signature in the Messenger trait
+definition (feel free to try and see what error message you get).
+
This is a situation in which interior mutability can help! We’ll store the
+sent_messages within a RefCell<T>, and then the send method will be
+able to modify sent_messages to store the messages we’ve seen. Listing 15-22
+shows what that looks like:
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::cell::RefCell;
+
+ struct MockMessenger {
+ sent_messages: RefCell<Vec<String>>,
+ }
+
+ impl MockMessenger {
+ fn new() -> MockMessenger {
+ MockMessenger {
+ sent_messages: RefCell::new(vec![]),
+ }
+ }
+ }
+
+ impl Messenger for MockMessenger {
+ fn send(&self, message: &str) {
+ self.sent_messages.borrow_mut().push(String::from(message));
+ }
+ }
+
+ #[test]
+ fn it_sends_an_over_75_percent_warning_message() {
+ // --snip--
+ let mock_messenger = MockMessenger::new();
+ let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
+
+ limit_tracker.set_value(80);
+
+ assert_eq!(mock_messenger.sent_messages.borrow().len(), 1);
+ }
+}
+
Listing 15-22: Using RefCell<T> to mutate an inner
+value while the outer value is considered immutable
+
The sent_messages field is now of type RefCell<Vec<String>> instead of
+Vec<String>. In the new function, we create a new RefCell<Vec<String>>
+instance around the empty vector.
+
For the implementation of the send method, the first parameter is still an
+immutable borrow of self, which matches the trait definition. We call
+borrow_mut on the RefCell<Vec<String>> in self.sent_messages to get a
+mutable reference to the value inside the RefCell<Vec<String>>, which is the
+vector. Then we can call push on the mutable reference to the vector to keep
+track of the messages sent during the test.
+
The last change we have to make is in the assertion: to see how many items are
+in the inner vector, we call borrow on the RefCell<Vec<String>> to get an
+immutable reference to the vector.
+
Now that you’ve seen how to use RefCell<T>, let’s dig into how it works!
When creating immutable and mutable references, we use the & and &mut
+syntax, respectively. With RefCell<T>, we use the borrow and borrow_mut
+methods, which are part of the safe API that belongs to RefCell<T>. The
+borrow method returns the smart pointer type Ref<T>, and borrow_mut
+returns the smart pointer type RefMut<T>. Both types implement Deref, so we
+can treat them like regular references.
+
The RefCell<T> keeps track of how many Ref<T> and RefMut<T> smart
+pointers are currently active. Every time we call borrow, the RefCell<T>
+increases its count of how many immutable borrows are active. When a Ref<T>
+value goes out of scope, the count of immutable borrows goes down by one. Just
+like the compile-time borrowing rules, RefCell<T> lets us have many immutable
+borrows or one mutable borrow at any point in time.
+
If we try to violate these rules, rather than getting a compiler error as we
+would with references, the implementation of RefCell<T> will panic at
+runtime. Listing 15-23 shows a modification of the implementation of send in
+Listing 15-22. We’re deliberately trying to create two mutable borrows active
+for the same scope to illustrate that RefCell<T> prevents us from doing this
+at runtime.
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::cell::RefCell;
+
+ struct MockMessenger {
+ sent_messages: RefCell<Vec<String>>,
+ }
+
+ impl MockMessenger {
+ fn new() -> MockMessenger {
+ MockMessenger {
+ sent_messages: RefCell::new(vec![]),
+ }
+ }
+ }
+
+ impl Messenger for MockMessenger {
+ fn send(&self, message: &str) {
+ let mut one_borrow = self.sent_messages.borrow_mut();
+ let mut two_borrow = self.sent_messages.borrow_mut();
+
+ one_borrow.push(String::from(message));
+ two_borrow.push(String::from(message));
+ }
+ }
+
+ #[test]
+ fn it_sends_an_over_75_percent_warning_message() {
+ let mock_messenger = MockMessenger::new();
+ let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
+
+ limit_tracker.set_value(80);
+
+ assert_eq!(mock_messenger.sent_messages.borrow().len(), 1);
+ }
+}
+
Listing 15-23: Creating two mutable references in the
+same scope to see that RefCell<T> will panic
+
We create a variable one_borrow for the RefMut<T> smart pointer returned
+from borrow_mut. Then we create another mutable borrow in the same way in the
+variable two_borrow. This makes two mutable references in the same scope,
+which isn’t allowed. When we run the tests for our library, the code in Listing
+15-23 will compile without any errors, but the test will fail:
+
$ cargo test
+ Compiling limit-tracker v0.1.0 (file:///projects/limit-tracker)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.91s
+ Running unittests src/lib.rs (target/debug/deps/limit_tracker-e599811fa246dbde)
+
+running 1 test
+test tests::it_sends_an_over_75_percent_warning_message ... FAILED
+
+failures:
+
+---- tests::it_sends_an_over_75_percent_warning_message stdout ----
+thread 'tests::it_sends_an_over_75_percent_warning_message' panicked at src/lib.rs:60:53:
+already borrowed: BorrowMutError
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::it_sends_an_over_75_percent_warning_message
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Notice that the code panicked with the message already borrowed: BorrowMutError. This is how RefCell<T> handles violations of the borrowing
+rules at runtime.
+
Choosing to catch borrowing errors at runtime rather than compile time, as
+we’ve done here, means you’d potentially be finding mistakes in your code later
+in the development process: possibly not until your code was deployed to
+production. Also, your code would incur a small runtime performance penalty as
+a result of keeping track of the borrows at runtime rather than compile time.
+However, using RefCell<T> makes it possible to write a mock object that can
+modify itself to keep track of the messages it has seen while you’re using it
+in a context where only immutable values are allowed. You can use RefCell<T>
+despite its trade-offs to get more functionality than regular references
+provide.
A common way to use RefCell<T> is in combination with Rc<T>. Recall that
+Rc<T> lets you have multiple owners of some data, but it only gives immutable
+access to that data. If you have an Rc<T> that holds a RefCell<T>, you can
+get a value that can have multiple owners and that you can mutate!
+
For example, recall the cons list example in Listing 15-18 where we used
+Rc<T> to allow multiple lists to share ownership of another list. Because
+Rc<T> holds only immutable values, we can’t change any of the values in the
+list once we’ve created them. Let’s add in RefCell<T> to gain the ability to
+change the values in the lists. Listing 15-24 shows that by using a
+RefCell<T> in the Cons definition, we can modify the value stored in all
+the lists:
+
Filename: src/main.rs
+
#[derive(Debug)]
+enum List {
+ Cons(Rc<RefCell<i32>>, Rc<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+use std::cell::RefCell;
+use std::rc::Rc;
+
+fn main() {
+ let value = Rc::new(RefCell::new(5));
+
+ let a = Rc::new(Cons(Rc::clone(&value), Rc::new(Nil)));
+
+ let b = Cons(Rc::new(RefCell::new(3)), Rc::clone(&a));
+ let c = Cons(Rc::new(RefCell::new(4)), Rc::clone(&a));
+
+ *value.borrow_mut() += 10;
+
+ println!("a after = {a:?}");
+ println!("b after = {b:?}");
+ println!("c after = {c:?}");
+}
+
Listing 15-24: Using Rc<RefCell<i32>> to create a
+List that we can mutate
+
We create a value that is an instance of Rc<RefCell<i32>> and store it in a
+variable named value so we can access it directly later. Then we create a
+List in a with a Cons variant that holds value. We need to clone
+value so both a and value have ownership of the inner 5 value rather
+than transferring ownership from value to a or having a borrow from
+value.
+
We wrap the list a in an Rc<T> so when we create lists b and c, they
+can both refer to a, which is what we did in Listing 15-18.
+
After we’ve created the lists in a, b, and c, we want to add 10 to the
+value in value. We do this by calling borrow_mut on value, which uses the
+automatic dereferencing feature we discussed in Chapter 5 (see the section
+“Where’s the -> Operator?”) to
+dereference the Rc<T> to the inner RefCell<T> value. The borrow_mut
+method returns a RefMut<T> smart pointer, and we use the dereference operator
+on it and change the inner value.
+
When we print a, b, and c, we can see that they all have the modified
+value of 15 rather than 5:
This technique is pretty neat! By using RefCell<T>, we have an outwardly
+immutable List value. But we can use the methods on RefCell<T> that provide
+access to its interior mutability so we can modify our data when we need to.
+The runtime checks of the borrowing rules protect us from data races, and it’s
+sometimes worth trading a bit of speed for this flexibility in our data
+structures. Note that RefCell<T> does not work for multithreaded code!
+Mutex<T> is the thread-safe version of RefCell<T> and we’ll discuss
+Mutex<T> in Chapter 16.
Rust’s memory safety guarantees make it difficult, but not impossible, to
+accidentally create memory that is never cleaned up (known as a memory leak).
+Preventing memory leaks entirely is not one of Rust’s guarantees, meaning
+memory leaks are memory safe in Rust. We can see that Rust allows memory leaks
+by using Rc<T> and RefCell<T>: it’s possible to create references where
+items refer to each other in a cycle. This creates memory leaks because the
+reference count of each item in the cycle will never reach 0, and the values
+will never be dropped.
Let’s look at how a reference cycle might happen and how to prevent it,
+starting with the definition of the List enum and a tail method in Listing
+15-25:
Listing 15-25: A cons list definition that holds a
+RefCell<T> so we can modify what a Cons variant is referring to
+
We’re using another variation of the List definition from Listing 15-5. The
+second element in the Cons variant is now RefCell<Rc<List>>, meaning that
+instead of having the ability to modify the i32 value as we did in Listing
+15-24, we want to modify the List value a Cons variant is pointing to.
+We’re also adding a tail method to make it convenient for us to access the
+second item if we have a Cons variant.
+
In Listing 15-26, we’re adding a main function that uses the definitions in
+Listing 15-25. This code creates a list in a and a list in b that points to
+the list in a. Then it modifies the list in a to point to b, creating a
+reference cycle. There are println! statements along the way to show what the
+reference counts are at various points in this process.
+
Filename: src/main.rs
+
use crate::List::{Cons, Nil};
+use std::cell::RefCell;
+use std::rc::Rc;
+
+#[derive(Debug)]
+enum List {
+ Cons(i32, RefCell<Rc<List>>),
+ Nil,
+}
+
+impl List {
+ fn tail(&self) -> Option<&RefCell<Rc<List>>> {
+ match self {
+ Cons(_, item) => Some(item),
+ Nil => None,
+ }
+ }
+}
+
+fn main() {
+ let a = Rc::new(Cons(5, RefCell::new(Rc::new(Nil))));
+
+ println!("a initial rc count = {}", Rc::strong_count(&a));
+ println!("a next item = {:?}", a.tail());
+
+ let b = Rc::new(Cons(10, RefCell::new(Rc::clone(&a))));
+
+ println!("a rc count after b creation = {}", Rc::strong_count(&a));
+ println!("b initial rc count = {}", Rc::strong_count(&b));
+ println!("b next item = {:?}", b.tail());
+
+ if let Some(link) = a.tail() {
+ *link.borrow_mut() = Rc::clone(&b);
+ }
+
+ println!("b rc count after changing a = {}", Rc::strong_count(&b));
+ println!("a rc count after changing a = {}", Rc::strong_count(&a));
+
+ // Uncomment the next line to see that we have a cycle;
+ // it will overflow the stack
+ // println!("a next item = {:?}", a.tail());
+}
+
Listing 15-26: Creating a reference cycle of two List
+values pointing to each other
+
We create an Rc<List> instance holding a List value in the variable a
+with an initial list of 5, Nil. We then create an Rc<List> instance holding
+another List value in the variable b that contains the value 10 and points
+to the list in a.
+
We modify a so it points to b instead of Nil, creating a cycle. We do
+that by using the tail method to get a reference to the RefCell<Rc<List>>
+in a, which we put in the variable link. Then we use the borrow_mut
+method on the RefCell<Rc<List>> to change the value inside from an Rc<List>
+that holds a Nil value to the Rc<List> in b.
+
When we run this code, keeping the last println! commented out for the
+moment, we’ll get this output:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.53s
+ Running `target/debug/cons-list`
+a initial rc count = 1
+a next item = Some(RefCell { value: Nil })
+a rc count after b creation = 2
+b initial rc count = 1
+b next item = Some(RefCell { value: Cons(5, RefCell { value: Nil }) })
+b rc count after changing a = 2
+a rc count after changing a = 2
+
+
The reference count of the Rc<List> instances in both a and b are 2 after
+we change the list in a to point to b. At the end of main, Rust drops the
+variable b, which decreases the reference count of the bRc<List> instance
+from 2 to 1. The memory that Rc<List> has on the heap won’t be dropped at
+this point, because its reference count is 1, not 0. Then Rust drops a, which
+decreases the reference count of the aRc<List> instance from 2 to 1 as
+well. This instance’s memory can’t be dropped either, because the other
+Rc<List> instance still refers to it. The memory allocated to the list will
+remain uncollected forever. To visualize this reference cycle, we’ve created a
+diagram in Figure 15-4.
+
+
Figure 15-4: A reference cycle of lists a and b
+pointing to each other
+
If you uncomment the last println! and run the program, Rust will try to
+print this cycle with a pointing to b pointing to a and so forth until it
+overflows the stack.
+
Compared to a real-world program, the consequences of creating a reference cycle
+in this example aren’t very dire: right after we create the reference cycle,
+the program ends. However, if a more complex program allocated lots of memory
+in a cycle and held onto it for a long time, the program would use more memory
+than it needed and might overwhelm the system, causing it to run out of
+available memory.
+
Creating reference cycles is not easily done, but it’s not impossible either.
+If you have RefCell<T> values that contain Rc<T> values or similar nested
+combinations of types with interior mutability and reference counting, you must
+ensure that you don’t create cycles; you can’t rely on Rust to catch them.
+Creating a reference cycle would be a logic bug in your program that you should
+use automated tests, code reviews, and other software development practices to
+minimize.
+
Another solution for avoiding reference cycles is reorganizing your data
+structures so that some references express ownership and some references don’t.
+As a result, you can have cycles made up of some ownership relationships and
+some non-ownership relationships, and only the ownership relationships affect
+whether or not a value can be dropped. In Listing 15-25, we always want Cons
+variants to own their list, so reorganizing the data structure isn’t possible.
+Let’s look at an example using graphs made up of parent nodes and child nodes
+to see when non-ownership relationships are an appropriate way to prevent
+reference cycles.
So far, we’ve demonstrated that calling Rc::clone increases the
+strong_count of an Rc<T> instance, and an Rc<T> instance is only cleaned
+up if its strong_count is 0. You can also create a weak reference to the
+value within an Rc<T> instance by calling Rc::downgrade and passing a
+reference to the Rc<T>. Strong references are how you can share ownership of
+an Rc<T> instance. Weak references don’t express an ownership relationship,
+and their count doesn’t affect when an Rc<T> instance is cleaned up. They
+won’t cause a reference cycle because any cycle involving some weak references
+will be broken once the strong reference count of values involved is 0.
+
When you call Rc::downgrade, you get a smart pointer of type Weak<T>.
+Instead of increasing the strong_count in the Rc<T> instance by 1, calling
+Rc::downgrade increases the weak_count by 1. The Rc<T> type uses
+weak_count to keep track of how many Weak<T> references exist, similar to
+strong_count. The difference is the weak_count doesn’t need to be 0 for the
+Rc<T> instance to be cleaned up.
+
Because the value that Weak<T> references might have been dropped, to do
+anything with the value that a Weak<T> is pointing to, you must make sure the
+value still exists. Do this by calling the upgrade method on a Weak<T>
+instance, which will return an Option<Rc<T>>. You’ll get a result of Some
+if the Rc<T> value has not been dropped yet and a result of None if the
+Rc<T> value has been dropped. Because upgrade returns an Option<Rc<T>>,
+Rust will ensure that the Some case and the None case are handled, and
+there won’t be an invalid pointer.
+
As an example, rather than using a list whose items know only about the next
+item, we’ll create a tree whose items know about their children items and
+their parent items.
To start, we’ll build a tree with nodes that know about their child nodes.
+We’ll create a struct named Node that holds its own i32 value as well as
+references to its children Node values:
We want a Node to own its children, and we want to share that ownership with
+variables so we can access each Node in the tree directly. To do this, we
+define the Vec<T> items to be values of type Rc<Node>. We also want to
+modify which nodes are children of another node, so we have a RefCell<T> in
+children around the Vec<Rc<Node>>.
+
Next, we’ll use our struct definition and create one Node instance named
+leaf with the value 3 and no children, and another instance named branch
+with the value 5 and leaf as one of its children, as shown in Listing 15-27:
Listing 15-27: Creating a leaf node with no children
+and a branch node with leaf as one of its children
+
We clone the Rc<Node> in leaf and store that in branch, meaning the
+Node in leaf now has two owners: leaf and branch. We can get from
+branch to leaf through branch.children, but there’s no way to get from
+leaf to branch. The reason is that leaf has no reference to branch and
+doesn’t know they’re related. We want leaf to know that branch is its
+parent. We’ll do that next.
To make the child node aware of its parent, we need to add a parent field to
+our Node struct definition. The trouble is in deciding what the type of
+parent should be. We know it can’t contain an Rc<T>, because that would
+create a reference cycle with leaf.parent pointing to branch and
+branch.children pointing to leaf, which would cause their strong_count
+values to never be 0.
+
Thinking about the relationships another way, a parent node should own its
+children: if a parent node is dropped, its child nodes should be dropped as
+well. However, a child should not own its parent: if we drop a child node, the
+parent should still exist. This is a case for weak references!
+
So instead of Rc<T>, we’ll make the type of parent use Weak<T>,
+specifically a RefCell<Weak<Node>>. Now our Node struct definition looks
+like this:
A node will be able to refer to its parent node but doesn’t own its parent.
+In Listing 15-28, we update main to use this new definition so the leaf
+node will have a way to refer to its parent, branch:
Listing 15-28: A leaf node with a weak reference to its
+parent node branch
+
Creating the leaf node looks similar to Listing 15-27 with the exception of
+the parent field: leaf starts out without a parent, so we create a new,
+empty Weak<Node> reference instance.
+
At this point, when we try to get a reference to the parent of leaf by using
+the upgrade method, we get a None value. We see this in the output from the
+first println! statement:
+
leaf parent = None
+
+
When we create the branch node, it will also have a new Weak<Node>
+reference in the parent field, because branch doesn’t have a parent node.
+We still have leaf as one of the children of branch. Once we have the
+Node instance in branch, we can modify leaf to give it a Weak<Node>
+reference to its parent. We use the borrow_mut method on the
+RefCell<Weak<Node>> in the parent field of leaf, and then we use the
+Rc::downgrade function to create a Weak<Node> reference to branch from
+the Rc<Node> in branch.
+
When we print the parent of leaf again, this time we’ll get a Some variant
+holding branch: now leaf can access its parent! When we print leaf, we
+also avoid the cycle that eventually ended in a stack overflow like we had in
+Listing 15-26; the Weak<Node> references are printed as (Weak):
The lack of infinite output indicates that this code didn’t create a reference
+cycle. We can also tell this by looking at the values we get from calling
+Rc::strong_count and Rc::weak_count.
Let’s look at how the strong_count and weak_count values of the Rc<Node>
+instances change by creating a new inner scope and moving the creation of
+branch into that scope. By doing so, we can see what happens when branch is
+created and then dropped when it goes out of scope. The modifications are shown
+in Listing 15-29:
Listing 15-29: Creating branch in an inner scope and
+examining strong and weak reference counts
+
After leaf is created, its Rc<Node> has a strong count of 1 and a weak
+count of 0. In the inner scope, we create branch and associate it with
+leaf, at which point when we print the counts, the Rc<Node> in branch
+will have a strong count of 1 and a weak count of 1 (for leaf.parent pointing
+to branch with a Weak<Node>). When we print the counts in leaf, we’ll see
+it will have a strong count of 2, because branch now has a clone of the
+Rc<Node> of leaf stored in branch.children, but will still have a weak
+count of 0.
+
When the inner scope ends, branch goes out of scope and the strong count of
+the Rc<Node> decreases to 0, so its Node is dropped. The weak count of 1
+from leaf.parent has no bearing on whether or not Node is dropped, so we
+don’t get any memory leaks!
+
If we try to access the parent of leaf after the end of the scope, we’ll get
+None again. At the end of the program, the Rc<Node> in leaf has a strong
+count of 1 and a weak count of 0, because the variable leaf is now the only
+reference to the Rc<Node> again.
+
All of the logic that manages the counts and value dropping is built into
+Rc<T> and Weak<T> and their implementations of the Drop trait. By
+specifying that the relationship from a child to its parent should be a
+Weak<T> reference in the definition of Node, you’re able to have parent
+nodes point to child nodes and vice versa without creating a reference cycle
+and memory leaks.
This chapter covered how to use smart pointers to make different guarantees and
+trade-offs from those Rust makes by default with regular references. The
+Box<T> type has a known size and points to data allocated on the heap. The
+Rc<T> type keeps track of the number of references to data on the heap so
+that data can have multiple owners. The RefCell<T> type with its interior
+mutability gives us a type that we can use when we need an immutable type but
+need to change an inner value of that type; it also enforces the borrowing
+rules at runtime instead of at compile time.
+
Also discussed were the Deref and Drop traits, which enable a lot of the
+functionality of smart pointers. We explored reference cycles that can cause
+memory leaks and how to prevent them using Weak<T>.
+
If this chapter has piqued your interest and you want to implement your own
+smart pointers, check out “The Rustonomicon” for more useful
+information.
+
Next, we’ll talk about concurrency in Rust. You’ll even learn about a few new
+smart pointers.
Handling concurrent programming safely and efficiently is another of Rust’s
+major goals. Concurrent programming, where different parts of a program
+execute independently, and parallel programming, where different parts of a
+program execute at the same time, are becoming increasingly important as more
+computers take advantage of their multiple processors. Historically,
+programming in these contexts has been difficult and error prone: Rust hopes to
+change that.
+
Initially, the Rust team thought that ensuring memory safety and preventing
+concurrency problems were two separate challenges to be solved with different
+methods. Over time, the team discovered that the ownership and type systems are
+a powerful set of tools to help manage memory safety and concurrency
+problems! By leveraging ownership and type checking, many concurrency errors
+are compile-time errors in Rust rather than runtime errors. Therefore, rather
+than making you spend lots of time trying to reproduce the exact circumstances
+under which a runtime concurrency bug occurs, incorrect code will refuse to
+compile and present an error explaining the problem. As a result, you can fix
+your code while you’re working on it rather than potentially after it has been
+shipped to production. We’ve nicknamed this aspect of Rust fearless
+concurrency. Fearless concurrency allows you to write code that is free of
+subtle bugs and is easy to refactor without introducing new bugs.
+
+
Note: For simplicity’s sake, we’ll refer to many of the problems as
+concurrent rather than being more precise by saying concurrent and/or
+parallel. If this book were about concurrency and/or parallelism, we’d be
+more specific. For this chapter, please mentally substitute concurrent
+and/or parallel whenever we use concurrent.
+
+
Many languages are dogmatic about the solutions they offer for handling
+concurrent problems. For example, Erlang has elegant functionality for
+message-passing concurrency but has only obscure ways to share state between
+threads. Supporting only a subset of possible solutions is a reasonable
+strategy for higher-level languages, because a higher-level language promises
+benefits from giving up some control to gain abstractions. However, lower-level
+languages are expected to provide the solution with the best performance in any
+given situation and have fewer abstractions over the hardware. Therefore, Rust
+offers a variety of tools for modeling problems in whatever way is appropriate
+for your situation and requirements.
+
Here are the topics we’ll cover in this chapter:
+
+
How to create threads to run multiple pieces of code at the same time
+
Message-passing concurrency, where channels send messages between threads
+
Shared-state concurrency, where multiple threads have access to some piece
+of data
+
The Sync and Send traits, which extend Rust’s concurrency guarantees to
+user-defined types as well as types provided by the standard library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch16-01-threads.html b/ch16-01-threads.html
new file mode 100644
index 0000000000..b1f330a6a5
--- /dev/null
+++ b/ch16-01-threads.html
@@ -0,0 +1,564 @@
+
+
+
+
+
+ Using Threads to Run Code Simultaneously - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
In most current operating systems, an executed program’s code is run in a
+process, and the operating system will manage multiple processes at once.
+Within a program, you can also have independent parts that run simultaneously.
+The features that run these independent parts are called threads. For
+example, a web server could have multiple threads so that it could respond to
+more than one request at the same time.
+
Splitting the computation in your program into multiple threads to run multiple
+tasks at the same time can improve performance, but it also adds complexity.
+Because threads can run simultaneously, there’s no inherent guarantee about the
+order in which parts of your code on different threads will run. This can lead
+to problems, such as:
+
+
Race conditions, where threads are accessing data or resources in an
+inconsistent order
+
Deadlocks, where two threads are waiting for each other, preventing both
+threads from continuing
+
Bugs that happen only in certain situations and are hard to reproduce and fix
+reliably
+
+
Rust attempts to mitigate the negative effects of using threads, but
+programming in a multithreaded context still takes careful thought and requires
+a code structure that is different from that in programs running in a single
+thread.
+
Programming languages implement threads in a few different ways, and many
+operating systems provide an API the language can call for creating new threads.
+The Rust standard library uses a 1:1 model of thread implementation, whereby a
+program uses one operating system thread per one language thread. There are
+crates that implement other models of threading that make different tradeoffs to
+the 1:1 model. (Rust’s async system, which we will see in the next chapter,
+provides another approach to concurrency as well.)
To create a new thread, we call the thread::spawn function and pass it a
+closure (we talked about closures in Chapter 13) containing the code we want to
+run in the new thread. The example in Listing 16-1 prints some text from a main
+thread and other text from a new thread:
+
Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn main() {
+ thread::spawn(|| {
+ for i in 1..10 {
+ println!("hi number {i} from the spawned thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the main thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+}
+
Listing 16-1: Creating a new thread to print one thing
+while the main thread prints something else
+
Note that when the main thread of a Rust program completes, all spawned threads
+are shut down, whether or not they have finished running. The output from this
+program might be a little different every time, but it will look similar to the
+following:
+
+
hi number 1 from the main thread!
+hi number 1 from the spawned thread!
+hi number 2 from the main thread!
+hi number 2 from the spawned thread!
+hi number 3 from the main thread!
+hi number 3 from the spawned thread!
+hi number 4 from the main thread!
+hi number 4 from the spawned thread!
+hi number 5 from the spawned thread!
+
+
The calls to thread::sleep force a thread to stop its execution for a short
+duration, allowing a different thread to run. The threads will probably take
+turns, but that isn’t guaranteed: it depends on how your operating system
+schedules the threads. In this run, the main thread printed first, even though
+the print statement from the spawned thread appears first in the code. And even
+though we told the spawned thread to print until i is 9, it only got to 5
+before the main thread shut down.
+
If you run this code and only see output from the main thread, or don’t see any
+overlap, try increasing the numbers in the ranges to create more opportunities
+for the operating system to switch between the threads.
The code in Listing 16-1 not only stops the spawned thread prematurely most of
+the time due to the main thread ending, but because there is no guarantee on
+the order in which threads run, we also can’t guarantee that the spawned thread
+will get to run at all!
+
We can fix the problem of the spawned thread not running or ending prematurely
+by saving the return value of thread::spawn in a variable. The return type of
+thread::spawn is JoinHandle. A JoinHandle is an owned value that, when we
+call the join method on it, will wait for its thread to finish. Listing 16-2
+shows how to use the JoinHandle of the thread we created in Listing 16-1 and
+call join to make sure the spawned thread finishes before main exits:
+
Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn main() {
+ let handle = thread::spawn(|| {
+ for i in 1..10 {
+ println!("hi number {i} from the spawned thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the main thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+
+ handle.join().unwrap();
+}
+
Listing 16-2: Saving a JoinHandle from thread::spawn
+to guarantee the thread is run to completion
+
Calling join on the handle blocks the thread currently running until the
+thread represented by the handle terminates. Blocking a thread means that
+thread is prevented from performing work or exiting. Because we’ve put the call
+to join after the main thread’s for loop, running Listing 16-2 should
+produce output similar to this:
+
+
hi number 1 from the main thread!
+hi number 2 from the main thread!
+hi number 1 from the spawned thread!
+hi number 3 from the main thread!
+hi number 2 from the spawned thread!
+hi number 4 from the main thread!
+hi number 3 from the spawned thread!
+hi number 4 from the spawned thread!
+hi number 5 from the spawned thread!
+hi number 6 from the spawned thread!
+hi number 7 from the spawned thread!
+hi number 8 from the spawned thread!
+hi number 9 from the spawned thread!
+
+
The two threads continue alternating, but the main thread waits because of the
+call to handle.join() and does not end until the spawned thread is finished.
+
But let’s see what happens when we instead move handle.join() before the
+for loop in main, like this:
+
Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn main() {
+ let handle = thread::spawn(|| {
+ for i in 1..10 {
+ println!("hi number {i} from the spawned thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+ });
+
+ handle.join().unwrap();
+
+ for i in 1..5 {
+ println!("hi number {i} from the main thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+}
+
The main thread will wait for the spawned thread to finish and then run its
+for loop, so the output won’t be interleaved anymore, as shown here:
+
+
hi number 1 from the spawned thread!
+hi number 2 from the spawned thread!
+hi number 3 from the spawned thread!
+hi number 4 from the spawned thread!
+hi number 5 from the spawned thread!
+hi number 6 from the spawned thread!
+hi number 7 from the spawned thread!
+hi number 8 from the spawned thread!
+hi number 9 from the spawned thread!
+hi number 1 from the main thread!
+hi number 2 from the main thread!
+hi number 3 from the main thread!
+hi number 4 from the main thread!
+
+
Small details, such as where join is called, can affect whether or not your
+threads run at the same time.
We’ll often use the move keyword with closures passed to thread::spawn
+because the closure will then take ownership of the values it uses from the
+environment, thus transferring ownership of those values from one thread to
+another. In the “Capturing References or Moving Ownership” section of Chapter 13, we discussed move in the context of closures. Now,
+we’ll concentrate more on the interaction between move and thread::spawn.
+
Notice in Listing 16-1 that the closure we pass to thread::spawn takes no
+arguments: we’re not using any data from the main thread in the spawned
+thread’s code. To use data from the main thread in the spawned thread, the
+spawned thread’s closure must capture the values it needs. Listing 16-3 shows
+an attempt to create a vector in the main thread and use it in the spawned
+thread. However, this won’t yet work, as you’ll see in a moment.
+
Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let v = vec![1, 2, 3];
+
+ let handle = thread::spawn(|| {
+ println!("Here's a vector: {v:?}");
+ });
+
+ handle.join().unwrap();
+}
+
Listing 16-3: Attempting to use a vector created by the
+main thread in another thread
+
The closure uses v, so it will capture v and make it part of the closure’s
+environment. Because thread::spawn runs this closure in a new thread, we
+should be able to access v inside that new thread. But when we compile this
+example, we get the following error:
+
$ cargo run
+ Compiling threads v0.1.0 (file:///projects/threads)
+error[E0373]: closure may outlive the current function, but it borrows `v`, which is owned by the current function
+ --> src/main.rs:6:32
+ |
+6 | let handle = thread::spawn(|| {
+ | ^^ may outlive borrowed value `v`
+7 | println!("Here's a vector: {v:?}");
+ | - `v` is borrowed here
+ |
+note: function requires argument type to outlive `'static`
+ --> src/main.rs:6:18
+ |
+6 | let handle = thread::spawn(|| {
+ | __________________^
+7 | | println!("Here's a vector: {v:?}");
+8 | | });
+ | |______^
+help: to force the closure to take ownership of `v` (and any other referenced variables), use the `move` keyword
+ |
+6 | let handle = thread::spawn(move || {
+ | ++++
+
+For more information about this error, try `rustc --explain E0373`.
+error: could not compile `threads` (bin "threads") due to 1 previous error
+
+
Rust infers how to capture v, and because println! only needs a reference
+to v, the closure tries to borrow v. However, there’s a problem: Rust can’t
+tell how long the spawned thread will run, so it doesn’t know if the reference
+to v will always be valid.
+
Listing 16-4 provides a scenario that’s more likely to have a reference to v
+that won’t be valid:
+
Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let v = vec![1, 2, 3];
+
+ let handle = thread::spawn(|| {
+ println!("Here's a vector: {v:?}");
+ });
+
+ drop(v); // oh no!
+
+ handle.join().unwrap();
+}
+
Listing 16-4: A thread with a closure that attempts to
+capture a reference to v from a main thread that drops v
+
If Rust allowed us to run this code, there’s a possibility the spawned thread
+would be immediately put in the background without running at all. The spawned
+thread has a reference to v inside, but the main thread immediately drops
+v, using the drop function we discussed in Chapter 15. Then, when the
+spawned thread starts to execute, v is no longer valid, so a reference to it
+is also invalid. Oh no!
+
To fix the compiler error in Listing 16-3, we can use the error message’s
+advice:
+
+
help: to force the closure to take ownership of `v` (and any other referenced variables), use the `move` keyword
+ |
+6 | let handle = thread::spawn(move || {
+ | ++++
+
+
By adding the move keyword before the closure, we force the closure to take
+ownership of the values it’s using rather than allowing Rust to infer that it
+should borrow the values. The modification to Listing 16-3 shown in Listing
+16-5 will compile and run as we intend:
+
Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let v = vec![1, 2, 3];
+
+ let handle = thread::spawn(move || {
+ println!("Here's a vector: {v:?}");
+ });
+
+ handle.join().unwrap();
+}
+
Listing 16-5: Using the move keyword to force a closure
+to take ownership of the values it uses
+
We might be tempted to try the same thing to fix the code in Listing 16-4 where
+the main thread called drop by using a move closure. However, this fix will
+not work because what Listing 16-4 is trying to do is disallowed for a
+different reason. If we added move to the closure, we would move v into the
+closure’s environment, and we could no longer call drop on it in the main
+thread. We would get this compiler error instead:
+
$ cargo run
+ Compiling threads v0.1.0 (file:///projects/threads)
+error[E0382]: use of moved value: `v`
+ --> src/main.rs:10:10
+ |
+4 | let v = vec![1, 2, 3];
+ | - move occurs because `v` has type `Vec<i32>`, which does not implement the `Copy` trait
+5 |
+6 | let handle = thread::spawn(move || {
+ | ------- value moved into closure here
+7 | println!("Here's a vector: {v:?}");
+ | - variable moved due to use in closure
+...
+10 | drop(v); // oh no!
+ | ^ value used here after move
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `threads` (bin "threads") due to 1 previous error
+
+
Rust’s ownership rules have saved us again! We got an error from the code in
+Listing 16-3 because Rust was being conservative and only borrowing v for the
+thread, which meant the main thread could theoretically invalidate the spawned
+thread’s reference. By telling Rust to move ownership of v to the spawned
+thread, we’re guaranteeing Rust that the main thread won’t use v anymore. If
+we change Listing 16-4 in the same way, we’re then violating the ownership
+rules when we try to use v in the main thread. The move keyword overrides
+Rust’s conservative default of borrowing; it doesn’t let us violate the
+ownership rules.
+
With a basic understanding of threads and the thread API, let’s look at what we
+can do with threads.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch16-02-message-passing.html b/ch16-02-message-passing.html
new file mode 100644
index 0000000000..4f16d9673b
--- /dev/null
+++ b/ch16-02-message-passing.html
@@ -0,0 +1,544 @@
+
+
+
+
+
+ Using Message Passing to Transfer Data Between Threads - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
One increasingly popular approach to ensuring safe concurrency is message
+passing, where threads or actors communicate by sending each other messages
+containing data. Here’s the idea in a slogan from the Go language
+documentation:
+“Do not communicate by sharing memory; instead, share memory by communicating.”
+
To accomplish message-sending concurrency, Rust’s standard library provides an
+implementation of channels. A channel is a general programming concept by
+which data is sent from one thread to another.
+
You can imagine a channel in programming as being like a directional channel of
+water, such as a stream or a river. If you put something like a rubber duck
+into a river, it will travel downstream to the end of the waterway.
+
A channel has two halves: a transmitter and a receiver. The transmitter half is
+the upstream location where you put rubber ducks into the river, and the
+receiver half is where the rubber duck ends up downstream. One part of your
+code calls methods on the transmitter with the data you want to send, and
+another part checks the receiving end for arriving messages. A channel is said
+to be closed if either the transmitter or receiver half is dropped.
+
Here, we’ll work up to a program that has one thread to generate values and
+send them down a channel, and another thread that will receive the values and
+print them out. We’ll be sending simple values between threads using a channel
+to illustrate the feature. Once you’re familiar with the technique, you could
+use channels for any threads that need to communicate between each other, such
+as a chat system or a system where many threads perform parts of a calculation
+and send the parts to one thread that aggregates the results.
+
First, in Listing 16-6, we’ll create a channel but not do anything with it.
+Note that this won’t compile yet because Rust can’t tell what type of values we
+want to send over the channel.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+}
+
Listing 16-6: Creating a channel and assigning the two
+halves to tx and rx
+
We create a new channel using the mpsc::channel function; mpsc stands for
+multiple producer, single consumer. In short, the way Rust’s standard library
+implements channels means a channel can have multiple sending ends that
+produce values but only one receiving end that consumes those values. Imagine
+multiple streams flowing together into one big river: everything sent down any
+of the streams will end up in one river at the end. We’ll start with a single
+producer for now, but we’ll add multiple producers when we get this example
+working.
+
The mpsc::channel function returns a tuple, the first element of which is the
+sending end—the transmitter—and the second element is the receiving end—the
+receiver. The abbreviations tx and rx are traditionally used in many fields
+for transmitter and receiver respectively, so we name our variables as such
+to indicate each end. We’re using a let statement with a pattern that
+destructures the tuples; we’ll discuss the use of patterns in let statements
+and destructuring in Chapter 18. For now, know that using a let statement
+this way is a convenient approach to extract the pieces of the tuple returned
+by mpsc::channel.
+
Let’s move the transmitting end into a spawned thread and have it send one
+string so the spawned thread is communicating with the main thread, as shown in
+Listing 16-7. This is like putting a rubber duck in the river upstream or
+sending a chat message from one thread to another.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+ });
+}
+
Listing 16-7: Moving tx to a spawned thread and sending
+“hi”
+
Again, we’re using thread::spawn to create a new thread and then using move
+to move tx into the closure so the spawned thread owns tx. The spawned
+thread needs to own the transmitter to be able to send messages through the
+channel. The transmitter has a send method that takes the value we want to
+send. The send method returns a Result<T, E> type, so if the receiver has
+already been dropped and there’s nowhere to send a value, the send operation
+will return an error. In this example, we’re calling unwrap to panic in case
+of an error. But in a real application, we would handle it properly: return to
+Chapter 9 to review strategies for proper error handling.
+
In Listing 16-8, we’ll get the value from the receiver in the main thread. This
+is like retrieving the rubber duck from the water at the end of the river or
+receiving a chat message.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+ });
+
+ let received = rx.recv().unwrap();
+ println!("Got: {received}");
+}
+
Listing 16-8: Receiving the value “hi” in the main thread
+and printing it
+
The receiver has two useful methods: recv and try_recv. We’re using recv,
+short for receive, which will block the main thread’s execution and wait
+until a value is sent down the channel. Once a value is sent, recv will
+return it in a Result<T, E>. When the transmitter closes, recv will return
+an error to signal that no more values will be coming.
+
The try_recv method doesn’t block, but will instead return a Result<T, E>
+immediately: an Ok value holding a message if one is available and an Err
+value if there aren’t any messages this time. Using try_recv is useful if
+this thread has other work to do while waiting for messages: we could write a
+loop that calls try_recv every so often, handles a message if one is
+available, and otherwise does other work for a little while until checking
+again.
+
We’ve used recv in this example for simplicity; we don’t have any other work
+for the main thread to do other than wait for messages, so blocking the main
+thread is appropriate.
+
When we run the code in Listing 16-8, we’ll see the value printed from the main
+thread:
The ownership rules play a vital role in message sending because they help you
+write safe, concurrent code. Preventing errors in concurrent programming is the
+advantage of thinking about ownership throughout your Rust programs. Let’s do
+an experiment to show how channels and ownership work together to prevent
+problems: we’ll try to use a val value in the spawned thread after we’ve
+sent it down the channel. Try compiling the code in Listing 16-9 to see why
+this code isn’t allowed:
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+ println!("val is {val}");
+ });
+
+ let received = rx.recv().unwrap();
+ println!("Got: {received}");
+}
+
Listing 16-9: Attempting to use val after we’ve sent it
+down the channel
+
Here, we try to print val after we’ve sent it down the channel via tx.send.
+Allowing this would be a bad idea: once the value has been sent to another
+thread, that thread could modify or drop it before we try to use the value
+again. Potentially, the other thread’s modifications could cause errors or
+unexpected results due to inconsistent or nonexistent data. However, Rust gives
+us an error if we try to compile the code in Listing 16-9:
+
$ cargo run
+ Compiling message-passing v0.1.0 (file:///projects/message-passing)
+error[E0382]: borrow of moved value: `val`
+ --> src/main.rs:10:26
+ |
+8 | let val = String::from("hi");
+ | --- move occurs because `val` has type `String`, which does not implement the `Copy` trait
+9 | tx.send(val).unwrap();
+ | --- value moved here
+10 | println!("val is {val}");
+ | ^^^^^ value borrowed here after move
+ |
+ = note: this error originates in the macro `$crate::format_args_nl` which comes from the expansion of the macro `println` (in Nightly builds, run with -Z macro-backtrace for more info)
+help: consider cloning the value if the performance cost is acceptable
+ |
+9 | tx.send(val.clone()).unwrap();
+ | ++++++++
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `message-passing` (bin "message-passing") due to 1 previous error
+
+
Our concurrency mistake has caused a compile time error. The send function
+takes ownership of its parameter, and when the value is moved, the receiver
+takes ownership of it. This stops us from accidentally using the value again
+after sending it; the ownership system checks that everything is okay.
The code in Listing 16-8 compiled and ran, but it didn’t clearly show us that
+two separate threads were talking to each other over the channel. In Listing
+16-10 we’ve made some modifications that will prove the code in Listing 16-8 is
+running concurrently: the spawned thread will now send multiple messages and
+pause for a second between each message.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+use std::time::Duration;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("thread"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ thread::sleep(Duration::from_secs(1));
+ }
+ });
+
+ for received in rx {
+ println!("Got: {received}");
+ }
+}
+
Listing 16-10: Sending multiple messages and pausing
+between each
+
This time, the spawned thread has a vector of strings that we want to send to
+the main thread. We iterate over them, sending each individually, and pause
+between each by calling the thread::sleep function with a Duration value of
+1 second.
+
In the main thread, we’re not calling the recv function explicitly anymore:
+instead, we’re treating rx as an iterator. For each value received, we’re
+printing it. When the channel is closed, iteration will end.
+
When running the code in Listing 16-10, you should see the following output
+with a 1-second pause in between each line:
+
+
Got: hi
+Got: from
+Got: the
+Got: thread
+
+
Because we don’t have any code that pauses or delays in the for loop in the
+main thread, we can tell that the main thread is waiting to receive values from
+the spawned thread.
Earlier we mentioned that mpsc was an acronym for multiple producer,
+single consumer. Let’s put mpsc to use and expand the code in Listing 16-10
+to create multiple threads that all send values to the same receiver. We can do
+so by cloning the transmitter, as shown in Listing 16-11:
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+use std::time::Duration;
+
+fn main() {
+ // --snip--
+
+ let (tx, rx) = mpsc::channel();
+
+ let tx1 = tx.clone();
+ thread::spawn(move || {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("thread"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ thread::sleep(Duration::from_secs(1));
+ }
+ });
+
+ thread::spawn(move || {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ thread::sleep(Duration::from_secs(1));
+ }
+ });
+
+ for received in rx {
+ println!("Got: {received}");
+ }
+
+ // --snip--
+}
+
Listing 16-11: Sending multiple messages from multiple
+producers
+
This time, before we create the first spawned thread, we call clone on the
+transmitter. This will give us a new transmitter we can pass to the first
+spawned thread. We pass the original transmitter to a second spawned thread.
+This gives us two threads, each sending different messages to the one receiver.
+
When you run the code, your output should look something like this:
+
+
Got: hi
+Got: more
+Got: from
+Got: messages
+Got: for
+Got: the
+Got: thread
+Got: you
+
+
You might see the values in another order, depending on your system. This is
+what makes concurrency interesting as well as difficult. If you experiment with
+thread::sleep, giving it various values in the different threads, each run
+will be more nondeterministic and create different output each time.
+
Now that we’ve looked at how channels work, let’s look at a different method of
+concurrency.
Message passing is a fine way of handling concurrency, but it’s not the only
+one. Another method would be for multiple threads to access the same shared
+data. Consider this part of the slogan from the Go language documentation
+again: “do not communicate by sharing memory.”
+
What would communicating by sharing memory look like? In addition, why would
+message-passing enthusiasts caution not to use memory sharing?
+
In a way, channels in any programming language are similar to single ownership,
+because once you transfer a value down a channel, you should no longer use that
+value. Shared memory concurrency is like multiple ownership: multiple threads
+can access the same memory location at the same time. As you saw in Chapter 15,
+where smart pointers made multiple ownership possible, multiple ownership can
+add complexity because these different owners need managing. Rust’s type system
+and ownership rules greatly assist in getting this management correct. For an
+example, let’s look at mutexes, one of the more common concurrency primitives
+for shared memory.
Mutex is an abbreviation for mutual exclusion, as in, a mutex allows only
+one thread to access some data at any given time. To access the data in a
+mutex, a thread must first signal that it wants access by asking to acquire the
+mutex’s lock. The lock is a data structure that is part of the mutex that
+keeps track of who currently has exclusive access to the data. Therefore, the
+mutex is described as guarding the data it holds via the locking system.
+
Mutexes have a reputation for being difficult to use because you have to
+remember two rules:
+
+
You must attempt to acquire the lock before using the data.
+
When you’re done with the data that the mutex guards, you must unlock the
+data so other threads can acquire the lock.
+
+
For a real-world metaphor for a mutex, imagine a panel discussion at a
+conference with only one microphone. Before a panelist can speak, they have to
+ask or signal that they want to use the microphone. When they get the
+microphone, they can talk for as long as they want to and then hand the
+microphone to the next panelist who requests to speak. If a panelist forgets to
+hand the microphone off when they’re finished with it, no one else is able to
+speak. If management of the shared microphone goes wrong, the panel won’t work
+as planned!
+
Management of mutexes can be incredibly tricky to get right, which is why so
+many people are enthusiastic about channels. However, thanks to Rust’s type
+system and ownership rules, you can’t get locking and unlocking wrong.
As an example of how to use a mutex, let’s start by using a mutex in a
+single-threaded context, as shown in Listing 16-12:
+
Filename: src/main.rs
+
use std::sync::Mutex;
+
+fn main() {
+ let m = Mutex::new(5);
+
+ {
+ let mut num = m.lock().unwrap();
+ *num = 6;
+ }
+
+ println!("m = {m:?}");
+}
+
Listing 16-12: Exploring the API of Mutex<T> in a
+single-threaded context for simplicity
+
As with many types, we create a Mutex<T> using the associated function new.
+To access the data inside the mutex, we use the lock method to acquire the
+lock. This call will block the current thread so it can’t do any work until
+it’s our turn to have the lock.
+
The call to lock would fail if another thread holding the lock panicked. In
+that case, no one would ever be able to get the lock, so we’ve chosen to
+unwrap and have this thread panic if we’re in that situation.
+
After we’ve acquired the lock, we can treat the return value, named num in
+this case, as a mutable reference to the data inside. The type system ensures
+that we acquire a lock before using the value in m. The type of m is
+Mutex<i32>, not i32, so we must call lock to be able to use the i32
+value. We can’t forget; the type system won’t let us access the inner i32
+otherwise.
+
As you might suspect, Mutex<T> is a smart pointer. More accurately, the call
+to lockreturns a smart pointer called MutexGuard, wrapped in a
+LockResult that we handled with the call to unwrap. The MutexGuard smart
+pointer implements Deref to point at our inner data; the smart pointer also
+has a Drop implementation that releases the lock automatically when a
+MutexGuard goes out of scope, which happens at the end of the inner scope. As
+a result, we don’t risk forgetting to release the lock and blocking the mutex
+from being used by other threads, because the lock release happens
+automatically.
+
After dropping the lock, we can print the mutex value and see that we were able
+to change the inner i32 to 6.
Now, let’s try to share a value between multiple threads using Mutex<T>.
+We’ll spin up 10 threads and have them each increment a counter value by 1, so
+the counter goes from 0 to 10. The next example in Listing 16-13 will have
+a compiler error, and we’ll use that error to learn more about using
+Mutex<T> and how Rust helps us use it correctly.
+
Filename: src/main.rs
+
use std::sync::Mutex;
+use std::thread;
+
+fn main() {
+ let counter = Mutex::new(0);
+ let mut handles = vec![];
+
+ for _ in 0..10 {
+ let handle = thread::spawn(move || {
+ let mut num = counter.lock().unwrap();
+
+ *num += 1;
+ });
+ handles.push(handle);
+ }
+
+ for handle in handles {
+ handle.join().unwrap();
+ }
+
+ println!("Result: {}", *counter.lock().unwrap());
+}
+
Listing 16-13: Ten threads each increment a counter
+guarded by a Mutex<T>
+
We create a counter variable to hold an i32 inside a Mutex<T>, as we did
+in Listing 16-12. Next, we create 10 threads by iterating over a range of
+numbers. We use thread::spawn and give all the threads the same closure: one
+that moves the counter into the thread, acquires a lock on the Mutex<T> by
+calling the lock method, and then adds 1 to the value in the mutex. When a
+thread finishes running its closure, num will go out of scope and release the
+lock so another thread can acquire it.
+
In the main thread, we collect all the join handles. Then, as we did in Listing
+16-2, we call join on each handle to make sure all the threads finish. At
+that point, the main thread will acquire the lock and print the result of this
+program.
+
We hinted that this example wouldn’t compile. Now let’s find out why!
+
$ cargo run
+ Compiling shared-state v0.1.0 (file:///projects/shared-state)
+error[E0382]: borrow of moved value: `counter`
+ --> src/main.rs:21:29
+ |
+5 | let counter = Mutex::new(0);
+ | ------- move occurs because `counter` has type `Mutex<i32>`, which does not implement the `Copy` trait
+...
+9 | let handle = thread::spawn(move || {
+ | ------- value moved into closure here, in previous iteration of loop
+...
+21 | println!("Result: {}", *counter.lock().unwrap());
+ | ^^^^^^^ value borrowed here after move
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `shared-state` (bin "shared-state") due to 1 previous error
+
+
The error message states that the counter value was moved in the previous
+iteration of the loop. Rust is telling us that we can’t move the ownership
+of counter into multiple threads. Let’s fix the compiler error with a
+multiple-ownership method we discussed in Chapter 15.
In Chapter 15, we gave a value multiple owners by using the smart pointer
+Rc<T> to create a reference counted value. Let’s do the same here and see
+what happens. We’ll wrap the Mutex<T> in Rc<T> in Listing 16-14 and clone
+the Rc<T> before moving ownership to the thread.
+
Filename: src/main.rs
+
use std::rc::Rc;
+use std::sync::Mutex;
+use std::thread;
+
+fn main() {
+ let counter = Rc::new(Mutex::new(0));
+ let mut handles = vec![];
+
+ for _ in 0..10 {
+ let counter = Rc::clone(&counter);
+ let handle = thread::spawn(move || {
+ let mut num = counter.lock().unwrap();
+
+ *num += 1;
+ });
+ handles.push(handle);
+ }
+
+ for handle in handles {
+ handle.join().unwrap();
+ }
+
+ println!("Result: {}", *counter.lock().unwrap());
+}
+
Listing 16-14: Attempting to use Rc<T> to allow
+multiple threads to own the Mutex<T>
+
Once again, we compile and get… different errors! The compiler is teaching us
+a lot.
+
$ cargo run
+ Compiling shared-state v0.1.0 (file:///projects/shared-state)
+error[E0277]: `Rc<Mutex<i32>>` cannot be sent between threads safely
+ --> src/main.rs:11:36
+ |
+11 | let handle = thread::spawn(move || {
+ | ------------- ^------
+ | | |
+ | ______________________|_____________within this `{closure@src/main.rs:11:36: 11:43}`
+ | | |
+ | | required by a bound introduced by this call
+12 | | let mut num = counter.lock().unwrap();
+13 | |
+14 | | *num += 1;
+15 | | });
+ | |_________^ `Rc<Mutex<i32>>` cannot be sent between threads safely
+ |
+ = help: within `{closure@src/main.rs:11:36: 11:43}`, the trait `Send` is not implemented for `Rc<Mutex<i32>>`, which is required by `{closure@src/main.rs:11:36: 11:43}: Send`
+note: required because it's used within this closure
+ --> src/main.rs:11:36
+ |
+11 | let handle = thread::spawn(move || {
+ | ^^^^^^^
+note: required by a bound in `spawn`
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/thread/mod.rs:677:1
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `shared-state` (bin "shared-state") due to 1 previous error
+
+
Wow, that error message is very wordy! Here’s the important part to focus on:
+`Rc<Mutex<i32>>` cannot be sent between threads safely. The compiler is
+also telling us the reason why: the trait `Send` is not implemented for `Rc<Mutex<i32>>` . We’ll talk about Send in the next section: it’s one of
+the traits that ensures the types we use with threads are meant for use in
+concurrent situations.
+
Unfortunately, Rc<T> is not safe to share across threads. When Rc<T>
+manages the reference count, it adds to the count for each call to clone and
+subtracts from the count when each clone is dropped. But it doesn’t use any
+concurrency primitives to make sure that changes to the count can’t be
+interrupted by another thread. This could lead to wrong counts—subtle bugs that
+could in turn lead to memory leaks or a value being dropped before we’re done
+with it. What we need is a type exactly like Rc<T> but one that makes changes
+to the reference count in a thread-safe way.
Fortunately, Arc<T>is a type like Rc<T> that is safe to use in
+concurrent situations. The a stands for atomic, meaning it’s an atomically
+reference counted type. Atomics are an additional kind of concurrency
+primitive that we won’t cover in detail here: see the standard library
+documentation for std::sync::atomic for more
+details. At this point, you just need to know that atomics work like primitive
+types but are safe to share across threads.
+
You might then wonder why all primitive types aren’t atomic and why standard
+library types aren’t implemented to use Arc<T> by default. The reason is that
+thread safety comes with a performance penalty that you only want to pay when
+you really need to. If you’re just performing operations on values within a
+single thread, your code can run faster if it doesn’t have to enforce the
+guarantees atomics provide.
+
Let’s return to our example: Arc<T> and Rc<T> have the same API, so we fix
+our program by changing the use line, the call to new, and the call to
+clone. The code in Listing 16-15 will finally compile and run:
+
Filename: src/main.rs
+
use std::sync::{Arc, Mutex};
+use std::thread;
+
+fn main() {
+ let counter = Arc::new(Mutex::new(0));
+ let mut handles = vec![];
+
+ for _ in 0..10 {
+ let counter = Arc::clone(&counter);
+ let handle = thread::spawn(move || {
+ let mut num = counter.lock().unwrap();
+
+ *num += 1;
+ });
+ handles.push(handle);
+ }
+
+ for handle in handles {
+ handle.join().unwrap();
+ }
+
+ println!("Result: {}", *counter.lock().unwrap());
+}
+
Listing 16-15: Using an Arc<T> to wrap the Mutex<T>
+to be able to share ownership across multiple threads
+
This code will print the following:
+
+
Result: 10
+
+
We did it! We counted from 0 to 10, which may not seem very impressive, but it
+did teach us a lot about Mutex<T> and thread safety. You could also use this
+program’s structure to do more complicated operations than just incrementing a
+counter. Using this strategy, you can divide a calculation into independent
+parts, split those parts across threads, and then use a Mutex<T> to have each
+thread update the final result with its part.
+
Note that if you are doing simple numerical operations, there are types simpler
+than Mutex<T> types provided by the std::sync::atomic module of the
+standard library. These types provide safe, concurrent,
+atomic access to primitive types. We chose to use Mutex<T> with a primitive
+type for this example so we could concentrate on how Mutex<T> works.
You might have noticed that counter is immutable but we could get a mutable
+reference to the value inside it; this means Mutex<T> provides interior
+mutability, as the Cell family does. In the same way we used RefCell<T> in
+Chapter 15 to allow us to mutate contents inside an Rc<T>, we use Mutex<T>
+to mutate contents inside an Arc<T>.
+
Another detail to note is that Rust can’t protect you from all kinds of logic
+errors when you use Mutex<T>. Recall in Chapter 15 that using Rc<T> came
+with the risk of creating reference cycles, where two Rc<T> values refer to
+each other, causing memory leaks. Similarly, Mutex<T> comes with the risk of
+creating deadlocks. These occur when an operation needs to lock two resources
+and two threads have each acquired one of the locks, causing them to wait for
+each other forever. If you’re interested in deadlocks, try creating a Rust
+program that has a deadlock; then research deadlock mitigation strategies for
+mutexes in any language and have a go at implementing them in Rust. The
+standard library API documentation for Mutex<T> and MutexGuard offers
+useful information.
+
We’ll round out this chapter by talking about the Send and Sync traits and
+how we can use them with custom types.
Interestingly, the Rust language has very few concurrency features. Almost
+every concurrency feature we’ve talked about so far in this chapter has been
+part of the standard library, not the language. Your options for handling
+concurrency are not limited to the language or the standard library; you can
+write your own concurrency features or use those written by others.
+
However, two concurrency concepts are embedded in the language: the
+std::marker traits Sync and Send.
The Send marker trait indicates that ownership of values of the type
+implementing Send can be transferred between threads. Almost every Rust type
+is Send, but there are some exceptions, including Rc<T>: this cannot be
+Send because if you cloned an Rc<T> value and tried to transfer ownership
+of the clone to another thread, both threads might update the reference count
+at the same time. For this reason, Rc<T> is implemented for use in
+single-threaded situations where you don’t want to pay the thread-safe
+performance penalty.
+
Therefore, Rust’s type system and trait bounds ensure that you can never
+accidentally send an Rc<T> value across threads unsafely. When we tried to do
+this in Listing 16-14, we got the error the trait Send is not implemented for Rc<Mutex<i32>>. When we switched to Arc<T>, which is Send, the code
+compiled.
+
Any type composed entirely of Send types is automatically marked as Send as
+well. Almost all primitive types are Send, aside from raw pointers, which
+we’ll discuss in Chapter 19.
The Sync marker trait indicates that it is safe for the type implementing
+Sync to be referenced from multiple threads. In other words, any type T is
+Sync if &T (an immutable reference to T) is Send, meaning the reference
+can be sent safely to another thread. Similar to Send, primitive types are
+Sync, and types composed entirely of types that are Sync are also Sync.
+
The smart pointer Rc<T> is also not Sync for the same reasons that it’s not
+Send. The RefCell<T> type (which we talked about in Chapter 15) and the
+family of related Cell<T> types are not Sync. The implementation of borrow
+checking that RefCell<T> does at runtime is not thread-safe. The smart
+pointer Mutex<T> is Sync and can be used to share access with multiple
+threads as you saw in the “Sharing a Mutex<T> Between Multiple
+Threads” section.
Because types that are made up of Send and Sync traits are automatically
+also Send and Sync, we don’t have to implement those traits manually. As
+marker traits, they don’t even have any methods to implement. They’re just
+useful for enforcing invariants related to concurrency.
+
Manually implementing these traits involves implementing unsafe Rust code.
+We’ll talk about using unsafe Rust code in Chapter 19; for now, the important
+information is that building new concurrent types not made up of Send and
+Sync parts requires careful thought to uphold the safety guarantees. “The
+Rustonomicon” has more information about these guarantees and how to
+uphold them.
This isn’t the last you’ll see of concurrency in this book: the project in
+Chapter 20 will use the concepts in this chapter in a more realistic situation
+than the smaller examples discussed here.
+
As mentioned earlier, because very little of how Rust handles concurrency is
+part of the language, many concurrency solutions are implemented as crates.
+These evolve more quickly than the standard library, so be sure to search
+online for the current, state-of-the-art crates to use in multithreaded
+situations.
+
The Rust standard library provides channels for message passing and smart
+pointer types, such as Mutex<T> and Arc<T>, that are safe to use in
+concurrent contexts. The type system and the borrow checker ensure that the
+code using these solutions won’t end up with data races or invalid references.
+Once you get your code to compile, you can rest assured that it will happily
+run on multiple threads without the kinds of hard-to-track-down bugs common in
+other languages. Concurrent programming is no longer a concept to be afraid of:
+go forth and make your programs concurrent, fearlessly!
+
Next, we’ll talk about idiomatic ways to model problems and structure solutions
+as your Rust programs get bigger. In addition, we’ll discuss how Rust’s idioms
+relate to those you might be familiar with from object-oriented programming.
In Chapter 16, we saw one of Rust’s approaches to concurrency: using threads.
+Since Rust 1.39, there has been another option for concurrency: asynchronous
+programming, or async.
+
In the rest of this chapter, we will:
+
+
see how to use Rust’s async and .await syntax
+
explore how to use the async model to solve some of the same challenges we
+looked at in Chapter 16
+
look at how multithreading and async provide complementary solutions, which
+you can even use together in many cases
Many operations we ask the computer to do can take a while to finish. For
+example, if you used a video editor to create a video of a family celebration,
+exporting it could take anywhere from minutes to hours. Similarly, when you
+download a video shared by someone in your family, that download process might
+take a long time. It would be nice if we could do something else while we are
+waiting for those long-running processes to complete.
+
The video export will use as much CPU and GPU power as it can. If you only had
+one CPU core, and your operating system never paused that export until it
+completed, you could not do anything else on your computer while it was running.
+That would be a pretty frustrating experience, though, so instead your computer
+can (and does!) invisibly interrupt the export often enough to let you get other
+small amounts of work done along the way.
+
The file download is different. It does not take up very much CPU time. Instead,
+you are mostly waiting on data to transfer across the network. You can start
+reading from a network socket, but it might take a while for all the data to
+arrive and be fed into the socket by the network controller. Moreover, even once
+the data has all arrived, videos can be quite large, so it might take some time
+to load all the data from the socket. Even if “some time” here is just a second
+or two, that is a very long time for a modern processor, which can do billions
+of operations every second. You could choose to wait for all of that to finish,
+but you might be waiting for a while… with your CPU doing not much! Thus, even
+if your specific program cannot do anything until it finishes reading data from
+a network socket, your computer will once again invisibly interrupt your
+program so other things can happen at the same time as the network operation.
+
+
Note: The video export is the kind of operation which is often described as
+“CPU-bound”. It is limited by the speed of the computer’s CPU (and GPU), and
+how much of that power it can use. The video download is the kind of operation
+which is often described as “IO-bound,” because it is limited by the speed of
+the computer’s input and output. It can only go as fast as the data can be
+sent across the network, which means that it can only go as fast as the data
+can be written to the socket by the network controller.
+
+
In both of these examples, the concurrency happens at the level of the whole
+program. The operating system decides to interrupt the program to let other
+programs get work done. In many cases, since we understand our programs at a
+much more granular level than the operating system does, we can lots of
+opportunities for concurrency that the operating system cannot see. For example,
+if we are building a tool to manage file downloads, it is important that the
+user interface stay responsive while a download is happening. In fact, we should
+even be able to start multiple downloads at the same time.
+
However, many operating system APIs for interacting with network sockets are
+blocking. That is, the function calls block further progress in the program
+when they are called until they return. This is how most function calls work,
+if you think about it! However, we normally reserve the term “blocking” for
+function calls which interact with files, network sockets, or other resources on
+the computer, because those are the places where an individual program would
+benefit from the operation being non-blocking.
+
When doing file downloads, we could use threads to work around the fact that the
+call to write to a network socket is blocking. If we move the data over to a
+dedicated thread which handles the write operation, it will not block the rest
+of the program. But in many ways, it would be nicer if the call were not
+blocking in the first place.
+
One way to accomplish that would be to use an API built around callbacks. For
+each blocking operation, we could pass in a function to call once the operation
+completes:
Or we could have our functions return a type with and_then method, which in
+turn accepts a callback which can do more work of the same sort (Historically,
+this was the way that Rust did async):
+
network_socket.read_non_blocking().and_then(|result| {
+ /* another non_blocking operation */
+});
+
Each of these can make the control flow for the program more complicated,
+though. You can end up with event handler callbacks scattered across the code
+base, or groups of deeply nested callbacks, or long chains of and_then calls.
+Understanding the flow of data through the program can become more difficult as
+a result, and dealing with callbacks can also complicate ownership.
+
There are also no particularly good ways to get data out of those callbacks.
+With other common types in Rust, we often use pattern-matching in scenarios like
+this. When we are using callbacks we do not yet have the data at the time we
+call read_non_blocking—and we will not have it until the callback gets called.
+That means that there is no way to match on the data it will return: it is not
+here yet!
+
As an alternative, we might try something like this, imagining a
+read_non_blocking which has exactly the kind of and_then method described
+above. If we were to try to do that, though, with code kind of like this, it
+would not even compile:
+
let mut data = None;
+network_socket.read_non_blocking().and_then(|result| {
+ data = Some(result);
+});
+println!("{data:?}");
+
The callback passed to and_then needs a mutable reference to data, but the
+load function tries to return data to the caller. Rust would helpfully tell
+us that we cannot borrow data immutably to print it because it is still
+borrowed mutably for the and_then callback. This is not just Rust being fussy,
+either: the result of this would normally always just print the None value and
+exit, but if the read happened to go fast enough, it is possible it could
+sometimes print some string data instead. That is definitely not what we
+want!
+
We also could not cancel read_non_blocking: once it has started, it will run
+till it finishes unless the whole program stops.
+
What we really want to be able to write is something much more direct, like we
+would write in blocking code, but with the benefits of getting the data when it
+is available and not blocking the rest of the program while waiting for the
+data to arrive—something like this:
+
let data = network_socket.read(&path).await;
+println!("{data}");
+
That is exactly what Rust’s async abstraction gives us. It is designed to help
+us solve all of these issues. In the next section, we will see how this works in
+practice.
First, though, we need to dig a little deeper into the differences between
+parallelism and concurrency. In the previous chapter we treated them as mostly
+interchangeable. Now we need to distinguish between the two a little more,
+because the differences will show up as we start working:
+
+
+
Parallelism is when operations can happen simultaneously.
+
+
+
Concurrency is when operations can make progress without having to wait for
+all other operations to complete.
+
+
+
One way to think about the difference between parallelism and concurrency is to
+think about working on a software project as a team. When you agree to split up
+a group of tasks between a group of people, with each person working on one task
+and delivering them separately, this is parallelism. Each person on the team
+can be making progress at the exact same time.
+
On the other hand, when an individual works on several different tasks before
+any of them is complete, this is concurrency. Maybe you have two different
+projects checked out on your computer, and when you get bored or stuck on one
+project, you switch to the other. You are just one person, and you cannot make
+progress on both tasks at the exact same time.
+
With both of these situations, you might have to coordinate between different
+tasks. Maybe you thought the task that one person was working on was totally
+independent from everyone else’s work, but it actually needs something finished
+by another person on the team. Some of the work could be done in parallel, but
+some of it was actually serial: it could only happen in a series, one thing
+after the other. Likewise, maybe with the two projects you were
+switching between yourself, you realize that one of them needs the result from
+the other, so now your concurrent work has also become serial.
+
Parallelism and concurrency can intersect with each other, too. For example, if
+it turns out your coworker is waiting on one of your projects to finish, then
+you might need to focus on that project and not give any time to the other one
+until it is done, so your own work stops being concurrent.
+
On a machine with multiple CPU cores, we can actually do work in parallel. One
+core can be doing one thing while another core does something completely
+unrelated, and those actually happen at the same time. On a machine with a
+single CPU core, the CPU can only do one operation at a time, but we can still
+have concurrency. Using tools like threads, processes, and async, the computer
+can pause one activity and switch to others before eventually cycling back to
+that first activity again. So all parallel operations are also concurrent, but
+not all concurrent operations happen in parallel!
+
When working with async in Rust, we are always dealing with concurrency.
+Depending on the hardware, the operating system, and the async runtime we are
+using, that concurrency may use some degree of parallelism under the hood, or it
+may not. Let’s dive into how async programming in Rust actually works!
Like other languages with async, Rust uses the async and await
+keywords—though with some important differences from how other languages do
+things, as we will see. Blocks and functions can be marked async, and you can
+wait on the result of an async function or block to resolve using the await
+keyword.
+
Let’s write our first async function, and call it:
+Listing 17-1: Defining a very simple async function
+
+
If we compile and run this… nothing happens, and we get a compiler warning:
+
$ cargo run
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-01)
+warning: unused implementer of `Future` that must be used
+ --> src/main.rs:2:5
+ |
+2 | hello_async();
+ | ^^^^^^^^^^^^^
+ |
+ = note: futures do nothing unless you `.await` or poll them
+ = note: `#[warn(unused_must_use)]` on by default
+
+warning: `async_await` (bin "async_await") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.11s
+ Running `target/debug/async_await`
+
+
The warning tells us that just calling hello_async() was not enough: we also
+need to .await or poll the future it returns. This raises two important
+questions:
+
+
Given there is no return type on the function, how is it returning a future?
In Rust, async fn is equivalent to writing a function which returns a future
+of the return type. That is, when the compiler sees a function like this:
Let’s break that down and see what each part means:
+
+
+
It uses the impl Trait syntax we discussed back in the “Traits as
+Parameters” section in Chapter 10 to return a Future with an
+associated type of Output. That tells us that Future is a trait, and the
+Output associated type of () matches the original return type from the
+async version of the function.
+
+
+
It wraps the whole body of the async fn in an async block. Given that
+blocks like this are expressions, and that this is expression is the one which
+is returned from the function, we can infer that an async block like this
+produces some anonymous data type which implements the Future trait.
+
+
+
Combined, those explain that when we called hello_async in main, it returned
+a Future. Then Rust warned us that we did not do anything with the future.
+This is because futures are lazy: they don’t do anything until you ask them
+to. This should remind you of our discussion of iterators back in Chapter
+13. With iterators, you have to call next to get them to do
+anything—whether by using a for loop or by using iterator methods like .iter() and .map() which ultimately call next() under the hood.
+
With futures, the same basic idea applies, although for different reasons, and
+with different syntax and methods. This is different from the behavior we saw
+when using thread::spawn in the previous chapter, and it is different from how
+many other languages approach async. This allows Rust to avoid running async
+code unless it is actually needed. We will see why that is later on. For now,
+let’s start by awaiting the future returned by hello_async to actually have it
+run.
+
+
Note: Rust’s await keyword goes after the expression you are awaiting, not
+before it—that is, it is a postfix keyword. This is different from what you
+might be used to if you have used async in languages like JavaScript or C#.
+Rust chose this because it makes chains of async and non-async methods much
+nicer to work with. As of now, await is Rust’s only postfix keyword.
+Listing 17-2: Attempting to fix a compiler warning by awaiting a future
+
+
Oh no! We have gone from a compiler warning to an actual error:
+
$ cargo run
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-02)
+error[E0728]: `await` is only allowed inside `async` functions and blocks
+ --> src/main.rs:3:19
+ |
+2 | fn main() {
+ | ---- this is not `async`
+3 | hello_async().await;
+ | ^^^^^ only allowed inside `async` functions and blocks
+
+For more information about this error, try `rustc --explain E0728`.
+error: could not compile `async_await` (bin "async_await") due to 1 previous error
+
+
This time, the compiler is informing us we cannot use .await in main,
+because main is not an async function. That is because async code needs a
+runtime: a Rust crate which manages the details of executing asynchronous
+code.
+
Most languages which support async, including C#, JavaScript, Go, Kotlin,
+Erlang, and Swift, bundle a runtime with the language. At least for now, Rust
+does not. Instead, there are many different async runtimes available, each of
+which makes different tradeoffs suitable to the use case they target. For
+example, a high-throughput web server with dozens of CPU cores and terabytes of
+RAM has very different different needs than a microcontroller with a single
+core, one gigabyte of RAM, and no ability to do heap allocations.
+
To keep this chapter focused on learning async, rather than juggling parts of
+the ecosystem, we have created the trpl crate (trpl is short for “The Rust
+Programming Language”). It re-exports all the types, traits, and functions you
+will need, and in a couple cases wires up a few things for you which are less
+relevant to the subject of the book. There is no magic involved, though! If you
+want to understand what the crate does, we encourage you to check out its
+source code. You will be able to see what crate each re-export
+comes from, and we have left extensive comments explaining what the handful of
+helper functions we supply are doing.
Whenever you see code from the trpl crate throughout the rest of the
+chapter, it will be re-exporting code from the futures and
+tokio crates.
+
+
+
The futures crate is an official home for Rust experimentation for async
+code, and is actually where the Future type was originally designed.
+
+
+
Tokio is the most widely used async runtime in Rust today, especially (but
+not only!) for web applications. There are other great options out there,
+too, and they may be more suitable for your purposes. We are using Tokio
+because it is the most widely-used runtime—not as a judgment call on whether
+it is the best runtime!
+
+
+
+
For now, go ahead and add the trpl crate to your hello-async project:
+
$ cargo add trpl
+
+
Then, in our main function, let’s wrap the call to hello_async with the
+trpl::block_on function, which takes in a Future and runs it until it
+completes.
Phew: we finally have some working async code! Now we can answer that second
+question: what is a future anyway? That will also help us understand why we need
+that trpl::block_on call to make this work.
A future is a data structure which represents the state of some async
+operation. More precisely, a Rust Future is a trait; it allows many different
+data structures to represent different async operations in different ways, but
+with a common interface. Here is the definition of the trait:
Notice that this is a normal trait. While we often interact with futures via
+async blocks, you can also implement this yourself on your own data types when
+you need to. Many of the functions we will see throughout this chapter return
+types which have their own implementations of Future. Those implementations
+can compose together nicely
+
Future has an associated type, Output, which says what the result of the
+future will be when it resolves. (This is analogous to the Item associated
+type for the Iterator trait, which we saw back in Chapter 13.) Beyond that,
+Future has only one method: poll, which takes a special Pin reference for
+its self parameter and a mutable reference to some Context type, and returns
+a Poll<Self::Output>. We will talk a little more about Pin and Context
+later in the chapter. For now, let’s focus on what the method returns, the
+Poll type:
You may notice that this Poll type is a lot like an Option: it has one
+variant which has a value (Ready(T) and Some(T)), and one which does not
+(Pending and None). Having a dedicated type lets Rust treat Poll
+differently from Option, though, which is important since they have very
+different meanings! The Pending variant indicates that the future still has
+work to do, so the caller will need to check again later. The Ready variant
+indicates that the Future has finished its work and the T value is
+available.
+
+
Note: With most futures, the caller should not call poll() again after the
+future has returned Ready. Many futures will panic if polled after becoming
+ready! Futures which are safe to poll again will say so explicitly in their
+documentation.
+
+
Under the hood, when you call .await, Rust compiles that to code which calls
+poll, kind of (although not exactly )
+like this:
+
match hello_async().poll() {
+ Ready(_) => {
+ // We’re done!
+ }
+ Pending => {
+ // But what goes here?
+ }
+}
+
As you can see from this sample, though, there is a question: what happens when
+the Future is still Pending? We need some way to try again. We would need to
+have something like this instead:
When we use .await, Rust compiles it to something fairly similar to that loop.
+If Rust compiled it to exactly that code, though, every .await would block
+the computer from doing anything else—the opposite of what we were going for!
+Instead, Rust needs makes sure that the loop can hand off control to something
+which can pause work on this future and work on other futures and check this one
+again later. That “something” is an async runtime, and this scheduling and
+coordination work is one of the main jobs for a runtime.
+
Every await point—that is, every place where the code explicitly calls
+.await—represents one of those places where control gets handed back to the
+runtime. To make that work, Rust needs to keep track of the state involved in
+the async block, so that the runtime can kick off some other work and then come
+back when it is ready to try advancing this one again. This is an invisible
+state machine, as if you wrote something like this:
+
#![allow(unused)]
+fn main() {
+enum MyAsyncStateMachine {
+ FirstAwaitPoint(/* the state used after the first await point */),
+ SecondAwaitPoint(/* the state used after the second await point */),
+ // etc. for each `.await` point...
+}
+}
+
Writing that out by hand would be tedious and error-prone—especially when making
+changes to code later. Async Rust creates that state machine for us, and it
+really is an enum like this, just an anonymous one you don’t have to name. As
+a result, the normal rules around data structures all apply, including for
+borrowing and ownership. Happily, the compiler also handles checking that for
+us, and has good error messages. We will work through a few of those later in
+the chapter!
+
Once all of that compilation work is done, though, we need a runtime to actually
+poll the futures, coordinate between different futures as they hand off control
+at await points, and even provide async versions of common functionality like
+file or network I/O.
+
Now we can understand why the compiler was stopping us in Listing 17-2 (before
+we added the trpl::block_on function). The main function is not async—and
+it really cannot be: if it were, something would need to call poll() on
+whatever main returned! Instead, we use the trpl::block_on function, which
+polls the Future returned by hello_async until it returns Ready. Every
+async program in Rust has at least one place where it sets up an executor and
+executes code.
+
+
Note: Under the hood, Rust uses generators so that it can hand off control
+between different functions. These are an implementation detail, though, and
+you never have to think about it when writing Rust.
+
The loop as written also wouldn’t compile, because it doesn’t actually satisfy
+the contract for a Future. In particular, hello_async_fut is not pinned
+with the Pin type and we did not pass along a Context argument. We will
+see a little more about Pin later in the chapter, but we will not dig into
+Context because you will not normally need them for working with futures in
+day-to-day Rust code.
+
If you want to understand how things work “under the hood,” though, the
+official Asynchronous Programming in Rust book covers them:
Now, that’s a lot of work to just print a string, but we have laid some key
+foundations for working with async in Rust! Now that you know the basics of how
+futures and runtimes work, we can see some of the things we can do with async.
In this section, we will apply async to some of the same concurrency challenges
+we tackled with threads in chapter 16. Since we already talked about a lot of
+the key ideas there, in this section we will focus on what is different between
+threads and futures.
+
In many cases, the APIs for working with concurrency using async are very
+similar to those for using threads. In other cases, they end up being shaped
+fairly differently. Even when the APIs look similar, they often have different
+behavior and they nearly always have different performance characteristics.
The first task we tackled in Chapter 16 was counting up on two separate threads.
+Let’s do the same using async. The trpl crate supplies a spawn_task function
+which looks very similar to the thread::spawn API, and a sleep function
+which is an async version of the thread::sleep API. We can use these together
+to implement the same counting example as with threads.
+
Listing 17-4 shows our starting point. We set up our main function with trpl::block_on, so that our top-level function can be async.
+
fn main() {
+ trpl::block_on(async {
+ // our implementation will go here
+ });
+}
+
+
Note: From this point forward in the chapter, every example will include this
+exact same wrapping code with trpl::block_on in main, so we will often
+skip it just like we do with main. Don’t forget to include it in your
+code!
+
+
Then we can write two loops within that block, each with a trpl::sleep call in
+them. Similar to the threading example, we put one loop in the body of a
+trpl::spawn_task, the same way we did with thread::spawn, and the other in a
+top-level for loop. Notice that we also need to add a .await after the
+sleep calls.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ trpl::spawn_task(async {
+ for i in 1..10 {
+ println!("hi number {i} from the first task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the second task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ });
+}
+Listing 17-5: Using spawn_task to count with two
+
+
This does something very similar to what the thread-based implementation did, as
+we can see from the output when we run it. (As with the threading example, you
+may see a different order in your own terminal output when you run this.)
+
+
hi number 1 from the second task!
+hi number 1 from the first task!
+hi number 2 from the first task!
+hi number 2 from the second task!
+hi number 3 from the first task!
+hi number 3 from the second task!
+hi number 4 from the first task!
+hi number 4 from the second task!
+hi number 5 from the first task!
+
+
This stops as soon as the for loop in the body of the main async block finishes,
+because the task spawned by spawn_task is shut down when the main function
+ends—just like threads are. Thus, if you want to run all the way to the
+completion of the task, you will need to use a join handle to wait for the first
+task to complete. With threads, we used the join method to “block” until the
+thread was done running. Here, we can use await to do the same thing, and
+since the handle’s output is actually a Result, we will also unwrap it.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let handle = trpl::spawn_task(async {
+ for i in 1..10 {
+ println!("hi number {i} from the first task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the second task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+
+ handle.await.unwrap();
+ });
+}
+Listing 17-6: Using .await with a join handle to run a task to completion
+
+
Now the output again looks like what we saw in the threading example. (Again,
+the exact output may look different for you.)
+
+
hi number 1 from the second task!
+hi number 1 from the first task!
+hi number 2 from the first task!
+hi number 2 from the second task!
+hi number 3 from the first task!
+hi number 3 from the second task!
+hi number 4 from the first task!
+hi number 4 from the second task!
+hi number 5 from the first task!
+hi number 6 from the first task!
+hi number 7 from the first task!
+hi number 8 from the first task!
+hi number 9 from the first task!
+
+
So far, it looks like async and threads basically give us the same basic
+behavior. However, there are a few important differences already. One was using
+.await instead of calling join on the join handle. Another is that we needed
+to await both sleep calls. Most importantly, though, we did not need to spawn
+another operating system thread to do this. We were able to get concurrency for
+just the cost of a task, which has much faster startup time and uses much less
+memory than an OS thread.
+
What is more, we actually do not need the spawn_task call at all to get
+concurrency here. Remember that each async block compiles to an anonymous
+future. That means we can put each of these two loops in an async block and then
+ask the runtime to run them both to completion using trpl::join:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let fut1 = async {
+ for i in 1..10 {
+ println!("hi number {i} from the first task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ };
+
+ let fut2 = async {
+ for i in 1..5 {
+ println!("hi number {i} from the second task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ };
+
+ trpl::join(fut1, fut2).await;
+ });
+}
+Listing 17-7: Using trpl::join to await two anonymous futures
+
+
When we run this, we see both futures run to completion:
+
+
hi number 1 from the first task!
+hi number 1 from the second task!
+hi number 2 from the first task!
+hi number 2 from the second task!
+hi number 3 from the first task!
+hi number 3 from the second task!
+hi number 4 from the first task!
+hi number 4 from the second task!
+hi number 5 from the first task!
+hi number 6 from the first task!
+hi number 7 from the first task!
+hi number 8 from the first task!
+hi number 9 from the first task!
+
+
Here, you will see the exact same order every time, which is very different from
+what we saw with threads. That is because the trpl::join function is fair,
+meaning it checks both futures equally, rather than letting one race ahead. With
+threads, the operating system decides which thread to check, and that is
+ultimately out of our control. With an async runtime, the runtime itself decides
+which future to check, so it has the final say. In practice, the details get
+complicated because an async runtime might use operating system threads under
+the hood as part of how it manages concurrency, but a runtime can still choose
+to guarantee fairness even so. However, runtimes do not have to guarantee
+fairness for any given operation, and even within a given runtime, different
+APIs sometimes exist to let you choose whether fairness is something you care
+about as a caller.
+
Try some of these different variations on awaiting the futures and see what they
+do:
+
+
Remove the async block from around either or both of the loops.
+
Await each async block immediately after defining it.
+
Wrap only the first loop in an async block, and await the resulting future
+after the body of second loop.
+
+
For an extra challenge, see if you can figure out what the output will be in
+each case before running the code!
Sharing data between futures will look familiar. We can again use async versions
+of Rust’s types for message-passing. Instead of std::sync:mpsc::channel, we
+will use a tprl::channel, for example.
+
The synchronous Receiver::recv() method in std::mpsc::channel blocks until
+it receives a message. The trpl::Receiver::recv() method, by contrast, is an
+async function. Instead of blocking, it waits until a message is received or
+the send side of the channel closes. One other difference with this particular
+recv() implementation is that it returns an Option of the type sent over the
+channel instead of a Result.
+
We can start by introducing an async version of the multiple-producer,
+single-consumer channel channel API we used with threads back in Chapter 16. The
+API is just a little different here in Listing 17-8: we have a mutable receiver
+rx. Otherwise, this looks pretty much the same as the thread-based approach.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+
+ let received = rx.recv().await.unwrap();
+ println!("Got: {received}");
+ });
+}
+Listing 17-8: Creating an async channel and assigning the two halves to tx and rx
+
+
Now we can send messages from the sender to the receiver. Again, the API is just
+a little different from the threaded version in Chapter 16, where we needed to
+spawn a separate thread to allow the message passing to happen asynchronously.
+In the version in Listing 17-9, we opt into async behavior on the receiver side
+by using .await on the rx.recv() call.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+
+ let received = rx.recv().await.unwrap();
+ println!("Got: {received}");
+ });
+}
+Listing 17-9: Sending "hi" from tx and receiving it in rx
+
+
The send call does not block, since the channel we are sending it into is
+unbounded. That was true with our threading example back in Chapter 16, too,
+though. However, there is a big difference with the rx.recv() calls. The one
+back in Chapter 16 blocked the thread it ran on—in that case, the main thread.
+This one does not block at all! Instead, once the program hits the .await on
+the rx.recv() call, it hands control back to the runtime, which can go on
+scheduling other operations until a message arrives. It might be hard to see
+that from this code, though, since the message will arrive right away!
+
+
Note: Since this is all wrapped in a trpl::block_on, this would effectively
+block anything happening outside that. That is the whole point of block_on,
+in fact: to allow you to choose where to block on some set of async code to
+transition between sync and async code. However, within this block, the
+.await does not block further operations—as we will see!
+
+
Let’s go ahead and send a whole series of messages, and sleep in between them,
+as shown in Listing 17-10:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+
+ // snip...
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+}
+Listing 17-10: Sending multiple messages over the async channel and sleeping with an .await between each message
+
+
This handles sending the messages, but so far we don’t do anything with them,
+and the code just silently runs forever. We need to actually receive the
+messages. In this case, we could do that manually, because we know how many
+messages are coming in. In the real world, though, we will generally be waiting
+on some unknown number of messages. In that case, we need to keep waiting
+until we determine that there are no more messages.
+
That sounds like a good job for a loop! In synchronous code, we might use a
+for loop to process a sequence of items, regardless of how many items are in
+the loop. However, Rust does not yet have a way to write a for loop over an
+asynchronous series of items. Instead, we need to use a new kind of loop we
+haven’t seen before, the while let conditional loop. A while let loop is the
+loop version of the if let construct we saw back in Chapter 6. It continues as
+long as the condition it relies on is true. Listing 17-11 shows how we can use
+this with rx.recv to print all the messages send by the tx transmitter.
+
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+}
+Listing 17-11: Using a while let loop with .await to receive messages asynchronously
+
+
The rx.recv() call produces a Future. The Output of the future is an
+Option of the message type. While waiting on messages, it will respond with
+Poll::Pending, so the runtime will pause it until it is time to check it
+again. Once a message arrives, it will respond with
+Poll::Ready(Some(message)). When the channel closes, it will instead respond
+with Poll::Ready(None), which we can use to know that it is done. The while let pulls all of this together. If the result of calling rx.recv().await is
+Some(message), we get access to the message and we can use it in the loop
+body, just like we could with if let. If the result is None, the loop ends.
+Every time the loop completes, it hits the await point again, so the runtime
+pauses it again until another message arrives.
+
With the while let loop in place, the code now successfully sends and receives
+the messages. Unfortunately, there are still a couple problems. For one thing,
+the messages do not arrive at one-second intervals, we see them arrive all at
+once, four seconds after we start the program. For another, this program also
+never stops! You will need to shut it down using ctrl-c.
+
Let’s start by understanding why the messages all come in at once after the full
+delay, rather than coming in with delays in between each one. This highlights an
+important point about the way that async works in Rust. Within any given async
+block, the await points are sequential: each one happens one after another. That
+is, after all, one of the big motivations for using this syntax instead of
+callbacks, event handlers, or chains of methods: the flow through the program is
+much easier to follow, because having the order that .await keywords appear in
+the code is also the order they happen when running the program.
+
With that in mind, we can see why this code behaves the way it does by looking
+at the whole thing all together, in Listing 17-12.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+}
+Listing 17-12: An async block with multiple .await points in it
+
+
There is just one async block here, so everything here will proceed linearly.
+Every one of the .await points for the trpl::sleep calls appears before the
+.await points on the rx.recv(), so all the tx.send calls happen,
+interspersed with all of the trpl::sleep calls. Only then does the while let
+loop get to go through all of the .await points on the recv calls.
+
To get the behavior we actually want, where the delay happens in between
+receiving each message, rather than before receiving any message, we need to
+give put the tx and rx operations in their own async blocks, so the runtime
+can execute each of them separately. We also need to tell the runtime to
+actually run them using trpl::join, just like we did for the counting example
+above. Listing 17-13 shows how that looks.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx_fut = async {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ trpl::join(tx_fut, rx_fut).await;
+ });
+}
+Listing 17-13: Separating send and recv into their own async blocks and awaiting the futures for those blocks
+
+
With these changes made, the messages get printed at one-second intervals,
+rather than all in a rush after four seconds.
+
The program still never stops running, though. That’s because of the combination
+of the while let loop and the trpl::join call. Let’s consider the way this
+loop works:
+
+
The trpl::join future only completes once both futures passed to it
+have completed.
+
The tx future completes once it finishes sleeping after sending the last
+message in vals.
+
The rx future will not complete until the while let loop ends.
+
The while let loop will not end until rx.recv().await produces None.
+
The rx.recv().await will only return None once the other end of the
+channel is closed.
+
The channel will only close if we call rx.close() or when the sender side,
+tx, is dropped.
+
We do not call rx.close() anywhere, and tx will not be dropped until the
+async block ends.
+
The block cannot end because it is blocked on trpl::join completing,
+which takes us back to the top of this list!
+
+
We need to make sure the channel gets closed so that trpl::join will complete.
+We could manually close rx somewhere by calling rx.close(), but that does
+not make much sense in this case. The idea is that rx should keep listening
+until tx is done sending. Stopping after handling some arbitrary number of
+messages would make the program shut down, but it would mean we could miss
+messages if the sending side changed. Given that we cannot use rx.close(), we
+need to make sure that tx gets dropped before the end of the function.
+
Right now, the async block only borrows tx. We can confirm this by adding
+another async block which uses tx, and using trpl::join3 to wait for all
+three futures to complete:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx_fut = async {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(received) = rx.recv().await {
+ println!("Got: {received}");
+ }
+ };
+
+ let tx_fut2 = async {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ trpl::join3(tx_fut, tx_fut2, rx_fut).await;
+ });
+}
+Listing 17-14: Adding another async block which borrows tx, to see that we can borrow it repeatedly
+
+
Now both blocks borrow tx, so they are both able to use it to send messages,
+which rx can then receive. When we run that code, we see the extra output from
+the new async block, and the message it sends being received by the
+rx.recv().
+
+
Got: hi
+Got: more
+Got: from
+Got: messages
+Got: the
+Got: for
+Got: future
+Got: you
+
+
As before, we also see that the program does not shut down on its own and
+requires a ctrl-c. This little exploration helps
+us understand why: it is ultimately about ownership. We need to move tx into
+the async block so that once that block ends, tx will be dropped.
+
Since we have seen how async blocks borrow the items they reference from their
+outer scope, we can go ahead and remove the extra block we just added for now,
+and switch back from join3 to join.
+
The last step here is to figure out how to get ownership of the data instead of
+just borrowing it. In Chapter 13, we learned how to use the move keyword with
+closures, and in Chapter 16, we saw that we often need to use closures marked
+with move when working with threads. As we have discovered, the same dynamics
+apply to async blocks! Hopefully this will make sense if you remember that any
+time you write a future, a runtime is ultimately responsible for executing it.
+That means that an async block might outlive the function where you write it,
+the same way a closure can. When a future takes ownership of the data it
+references this way, it needs to move that data into the future—so the move
+keyword works with async blocks just like it does with closures.
+
Thus, we can change the first async block from an async block to an async move block, like this:
+
The result is Listing 17-15, and when we run this version of the code, it
+shuts down gracefully after the last message is sent.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ eprintln!("received '{value}'");
+ }
+ };
+
+ trpl::join(tx_fut, rx_fut).await;
+ });
+}
+Listing 17-15: A working example of sending and receiving messages between futures which correctly shuts down when complete
+
+
This async channel is also a multiple-producer channel, so we can call clone
+on tx if we want to send messages from multiple futures. For example, we can
+make the code from Listing 17-16 work by cloning the tx before moving it
+into the first async block, moving the original tx into the second async
+block, and switching back to join3.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ trpl::join3(tx1_fut, tx_fut, rx_fut).await;
+ });
+}
+Listing 17-16: Using multiple producers with async blocks
+
+
Both of these blocks need to be async move blocks, or else we will end up
+back in the same infinite loop we started out in. With that done, though, we get
+all the messages we expected, with little delays between them. Notice that since
+each of the sending futures do a one-second delay after sending, the messages
+come in right after each other at one-second intervals. The delays are
+concurrent, not sequential, just as we would expect.
+
This is a good start, but it limits us to just a handful of futures: two with
+join, or three with join3. Let’s see how we might work with more futures.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch17-03-more-futures.html b/ch17-03-more-futures.html
new file mode 100644
index 0000000000..7b1c184673
--- /dev/null
+++ b/ch17-03-more-futures.html
@@ -0,0 +1,1007 @@
+
+
+
+
+
+ Working With More Futures - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
When we switched from using two futures to three in the previous section, we
+also had to switch from using join to using join3. It would be annoying to
+do this every time we changed our code. Happily, we have a macro form of join
+to which we can pass an arbitrary number of arguments. It also handles awaiting
+the futures itself. Thus, we could rewrite the code from Listing 17-16 to use
+join! instead of join3, as in Listing 17-17:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ trpl::join!(tx1_fut, tx_fut, rx_fut);
+ });
+}
+Listing 17-17: Using join! to wait for multiple futures
+
+
This is definitely a nice improvement over needing to swap between join and
+join3 and join4 and so on! However, both the function nor macro forms of
+join only work for cases where we know the number of futures ahead of time. If
+instead we have a dynamic number of futures, we need a function which works with
+a collection type which can grow and shrink dynamically at runtime, such as a
+vector. In real-world Rust, pushing futures into a collection and then waiting
+on some or all the futures in that collection to complete is a very common
+pattern.
+
The trpl::join_all function accepts any type which implements the Iterator
+trait, which we learned about back in Chapter 13, so it seems like just the
+ticket. Let’s try putting our futures in a vector, and replace join3 with
+join_all.
+
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let futures = vec![tx1_fut, rx_fut, tx_fut];
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-18: Storing anonymous futures in a vector and calling join_all
+
+
Unfortunately, this does not compile. Instead, we get this error:
This error message is admittedly not the most helpful! It only tells us that it
+expected one async block and found another—but why is it looking for the async
+blocks that it names here, and why does it only reference them by where they
+appear in the code?
+
One clue is the format of this message. Notice that it is exactly the same as if
+we had tried to create a Vec with a a number and a string in it:
+
+Filename: src/main.rs
+
fn main() {
+ let a = 1;
+ let b = "Hello";
+ let vals = vec![a, b];
+}
+Listing 17-19: Trying to construct a Vec with a number and a string
+
+
The output there would be:
+
$ cargo build
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/no-listing-type-mismatch)
+error[E0308]: mismatched types
+ --> src/main.rs:5:24
+ |
+5 | let vals = vec![a, b];
+ | ^ expected integer, found `&str`
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `async_await` (bin "async_await") due to 1 previous error
+
+
Saying “expected something, found something else” is Rust’s standard format
+for telling us about a type mismatch. As we saw with vectors in “Using an Enum
+to Store Multiple Types” back in Chapter 8, we need the type of
+each item in a collection to be the same—and tx1_fut, rx_fut, and tx_fut
+do not have the same type.
+
The underlying issue here is what we learned in the previous section: async
+blocks compile to anonymous futures. Under the hood, there is a data structure
+corresponding to each of these blocks, and it has its own unique type. This
+might be surprising. After all, none of them returns anything, so the Future
+type in each case is Future<Output = ()>. However, Future is a trait, not a
+concrete type. The actual types here are invisible from our point of view as the
+person writing the code.
+
In Chapter 8, we discussed one way to include multiple types in a single vector:
+using an enum to represent each of the different types which can appear in the
+vector. We cannot do that here, though. For one thing, we do not even have a way
+to name the different types, because they are anonymous. For another, the reason
+we reached for a vector and join_all in the first place was to be able to work
+with a dynamic collection of futures where we do not know what they will all be
+until runtime.
+
To make this work, we need to use trait objects, just as we did for returning
+different kinds of errors from the same function in “Returning Errors from the
+run function” back in Chapter 12. Again, we will cover trait objects in
+detail in Chapter 17. Here, it lets us treat each of the anonymous futures
+produced by these types as interchangeable, since all of them by definition
+implement the Future trait.
+
We can start by wrapping each of the futures in the vec! in a Box::new().
+Unfortunately, the initial way we might try this, as shown in Listing 17-20,
+still does not compile.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let futures =
+ vec![Box::new(tx1_fut), Box::new(rx_fut), Box::new(tx_fut)];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-20: Trying to use Box::new to align the types of the futures in a Vec
+
+
In fact, we have the same basic error we did before, but we get one for both the
+second and third Box::new calls, and we also get new errors referring to the
+Unpin trait.
+
We can start by fixing the type error around the Box::new calls, by telling
+the compiler explicitly that we want to use these types as trait objects. The
+clearest way to do that here is by adding a type annotation to the declaration
+of futures, as we see in Listing 17-21. The type we have to write here is a
+little involved, so let’s walk through each part of it.
+
+
The innermost type is the future itself. We note explicitly that it the output
+of the future is the unit type () by writing Future<Output = ()>.
+
Then we annotate the trait with dyn to mark it as dynamic.
+
The entire trait is wrapped in a Box.
+
Finally, we state explicitly that futures is a Vec containing these items.
+
+
+Filename: src/main.rs
+
use std::{future::Future, time::Duration};
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let futures: Vec<Box<dyn Future<Output = ()>>> =
+ vec![Box::new(tx1_fut), Box::new(rx_fut), Box::new(tx_fut)];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-21: Fixing the rest of the type mismatch errors by using an explicit type declaration
+
+
That already made a big difference. Now when we run the compiler, we only have
+the errors mentioning Unpin. Although there are three of them, notice that
+each is very similar in its contents.
+
cargo run
+ Compiling proc-macro2 v1.0.82
+ Compiling unicode-ident v1.0.12
+ Compiling autocfg v1.3.0
+ Compiling futures-core v0.3.30
+ Compiling pin-project-lite v0.2.14
+ Compiling libc v0.2.154
+ Compiling futures-sink v0.3.30
+ Compiling memchr v2.7.2
+ Compiling futures-task v0.3.30
+ Compiling futures-io v0.3.30
+ Compiling futures-channel v0.3.30
+ Compiling pin-utils v0.1.0
+ Compiling slab v0.4.9
+ Compiling num_cpus v1.16.0
+ Compiling tokio v1.37.0
+ Compiling quote v1.0.36
+ Compiling syn v2.0.63
+ Compiling futures-macro v0.3.30
+ Compiling futures-util v0.3.30
+ Compiling futures-executor v0.3.30
+ Compiling futures v0.3.30
+ Compiling trpl v0.1.0 (/Users/chris/dev/rust-lang/book/packages/trpl)
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-20)
+error[E0277]: `dyn std::future::Future<Output = ()>` cannot be unpinned
+ --> src/main.rs:47:24
+ |
+47 | trpl::join_all(futures).await;
+ | -------------- ^^^^^^^ the trait `Unpin` is not implemented for `dyn std::future::Future<Output = ()>`, which is required by `Box<dyn std::future::Future<Output = ()>>: std::future::Future`
+ | |
+ | required by a bound introduced by this call
+ |
+ = note: consider using the `pin!` macro
+ consider using `Box::pin` if you need to access the pinned value outside of the current scope
+ = note: required for `Box<dyn std::future::Future<Output = ()>>` to implement `std::future::Future`
+note: required by a bound in `join_all`
+ --> /Users/chris/.cargo/registry/src/index.crates.io-6f17d22bba15001f/futures-util-0.3.30/src/future/join_all.rs:105:14
+ |
+102 | pub fn join_all<I>(iter: I) -> JoinAll<I::Item>
+ | -------- required by a bound in this function
+...
+105 | I::Item: Future,
+ | ^^^^^^ required by this bound in `join_all`
+
+error[E0277]: `dyn std::future::Future<Output = ()>` cannot be unpinned
+ --> src/main.rs:47:9
+ |
+47 | trpl::join_all(futures).await;
+ | ^^^^^^^^^^^^^^^^^^^^^^^ the trait `Unpin` is not implemented for `dyn std::future::Future<Output = ()>`, which is required by `Box<dyn std::future::Future<Output = ()>>: std::future::Future`
+ |
+ = note: consider using the `pin!` macro
+ consider using `Box::pin` if you need to access the pinned value outside of the current scope
+ = note: required for `Box<dyn std::future::Future<Output = ()>>` to implement `std::future::Future`
+note: required by a bound in `JoinAll`
+ --> /Users/chris/.cargo/registry/src/index.crates.io-6f17d22bba15001f/futures-util-0.3.30/src/future/join_all.rs:29:8
+ |
+27 | pub struct JoinAll<F>
+ | ------- required by a bound in this struct
+28 | where
+29 | F: Future,
+ | ^^^^^^ required by this bound in `JoinAll`
+
+error[E0277]: `dyn std::future::Future<Output = ()>` cannot be unpinned
+ --> src/main.rs:47:33
+ |
+47 | trpl::join_all(futures).await;
+ | ^^^^^ the trait `Unpin` is not implemented for `dyn std::future::Future<Output = ()>`, which is required by `Box<dyn std::future::Future<Output = ()>>: std::future::Future`
+ |
+ = note: consider using the `pin!` macro
+ consider using `Box::pin` if you need to access the pinned value outside of the current scope
+ = note: required for `Box<dyn std::future::Future<Output = ()>>` to implement `std::future::Future`
+note: required by a bound in `JoinAll`
+ --> /Users/chris/.cargo/registry/src/index.crates.io-6f17d22bba15001f/futures-util-0.3.30/src/future/join_all.rs:29:8
+ |
+27 | pub struct JoinAll<F>
+ | ------- required by a bound in this struct
+28 | where
+29 | F: Future,
+ | ^^^^^^ required by this bound in `JoinAll`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `async_await` (bin "async_await") due to 3 previous errors
+
+
That is a lot to digest, so let’s pull it apart. The first part of the message
+tell us that the first async block (src/main.rs:8:23: 20:10) does not
+implement the Unpin trait, and suggests using pin! or Box::pin to resolve
+it. The rest of the message tells us why that is required: the JoinAll
+struct, which is itself a Future, is also generic over a Future, and
+Future itself requires the Unpin trait. Understanding this error means we
+need to dive into a little more of how the Future type actually works, in
+particular the idea of pinning.
When we introduced the Future trait in the previous chapter, we saw that the
+definition of its poll method has an unusual way of specifying the self
+parameter. To review, here is the full definition of Future:
We have not seen a method definition like this before, where self has a type
+annotation rather than simply being named like self, mut self, &self, or
+&mut self. This syntax means that the method can only be called when the
+instance of the type which implements Future is behind a Pin pointer type.
+This syntax is not specific to Pin; it also works with Box and other smart
+pointer types, and we will see it again in Chapter 18.
+
Here, the signature tells us that if we want to poll a future to check whether
+it is Pending or Ready(Output), the type which implements Future has to be
+behind a Pin smart pointer type. Recalling that .await is implemented in
+terms of calls to poll(), this starts to explain the error message we saw
+above—but that was in terms of Unpin, not Pin. So what exactly are Pin and
+Unpin, how do they relate, and why does Future need self to be in a Pin
+type to call poll?
+
In “Futures and Syntax: What Are Futures”, we described how
+a series of await points in a future get compiled into a state machine—and noted
+how the compiler helps make sure that state machine follows all of Rust’s normal
+rules around safety, including borrowing and ownership. Consider code which has
+a mutable Vec of strings, which asynchronously reads strings from files and
+pushes those strings into the Vec:
+
+
fn main() {
+ trpl::block_on({
+ async {
+ let mut strings = vec![];
+
+ let a = trpl::read_to_string("test-data/hello.txt").await.unwrap();
+ strings.push(a.trim());
+
+ let b = trpl::read_to_string("test-data/world.txt").await.unwrap();
+ strings.push(b.trim());
+
+ let combined = strings.join(" ");
+ println!("{combined}");
+ }
+ });
+}
+Listing 17-22: Borrowing mutable data across multiple .await points
+
+
If we think about the state machine that would get compiled to, it might be
+something kind of like this:
That is, at each .await in the source code, Rust would look at what state is
+needed between that await point and the point another .await appears or the
+async block ends, and create a corresponding variant in the AsyncStateMachine.
+Each variant has the appropriate kind of reference to the data that will be
+referenced in that section. The real implementation is not exactly like this,
+but it is close enough to give the right mental model.
+
And this could actually be fine, on its own—Rust would keep track of those
+mutable references, and if we got something wrong, the borrow checker would tell
+us. It gets a bit tricky, though, if we want to move around the future that
+corresponds to that block. Remember, we could always do something like this:
If we pass those futures into join, or return them from a function, or put
+them in a data structure to keep track of for some reason, that moves the state
+machine as well. That means the reference to Vec<String> for the values we
+read in with trpl::read_to_string moves along with it. Since references point
+to the actual memory address of the Vec, Rust needs some way to either update
+them so they are still valid after the Vec moves, or it needs some way to keep
+Vec from getting moved around so that the references do not need to be
+updated. Updating all the references to an object every time it moves could be
+quite a lot of work for the compiler to add, especially since there can be a
+whole web of references that need updating. On the other hand, making sure the
+underlying item does not move in memory can be “free” at runtime in exchange
+for keeping some promises at compile time. That is where Pin and Unpin come
+in.
+
+
Note: The specific mechanics for how Pin and Unpin work under the hood are
+covered extensively in the API documentation for std::pin, so if you would
+like to understand them more fundamentally, that is a great place to start.
+Those details are not at all necessary for working with async Rust day to day,
+though. Here, we will stick to the parts you do need to understand to work
+with them in everyday Rust!
+
+
Pin is a smart pointer, much like Box, Rc, and the others we saw in
+Chapter 15. Unlike those, however, Pin only works with other pointer types
+like reference (& and &mut) and smart pointers (Box, Rc, and so on). To
+be precise, Pin works with types which implement the Deref or DerefMut
+traits, which we covered in Chapter 15. You can think of this restriction as
+equivalent to only working with pointers, though, since implementing Deref or
+DerefMut means your type behaves like a pointer type. including references,
+other smart pointers, and so on.
+
Wrapping a pointer type in Pin enforces the exact guarantee we need: the value
+behind the pointer we wrap in Pin cannot move. It is “pinned” in its current
+spot by the Pin wrapper. Thus, if you have Pin<Box<SomeType>>, you actually
+pin the SomeType value, not the Box pointer. In fact, the pinned box
+pointer can move around freely. Remember: we care about making sure the data
+ultimately being referenced stays in its place. If a pointer moves around, but
+the data it points to is in the same place, there is no problem.
+
However, most types are perfectly safe to move around, even if they happen to be
+behind a Pin pointer. Remember: the problem Pin addresses is when data
+structures have internal references which need to maintained when the structure
+moves around, as happens with internal references in futures. Primitive values
+like numbers and booleans do not have any internal structure like that, so they
+are obviously safe. Neither do most types you normally work with in Rust. A
+Vec, for example, does not have any internal references it needs to keep up to
+date this way, so you can move it around without worrying. But what happens if
+you have a Pin<u32> or a Pin<Vec<String>>?
+
We need a way to tell the compiler that it is actually just fine to move items
+around in cases like these where there is nothing to worry about. For that, we
+have Unpin. Unpin is a marker trait, like Send and Sync, which we saw in
+Chapter 16. Recall that marker traits have no functionality of their own. They
+exist only to tell the compiler that it is safe to use the type which implements
+a given trait in a particular context. Unpin informs the compiler that a given
+type does not need to uphold any particular guarantees about whether the value
+in question can be moved.
+
Just like Send and Sync, the compiler implements Unpin automatically for
+most types, and implementing it manually is unsafe. That is because you have to
+make sure that the type for which you are implementing Unsafenever moves
+data out from a reference that needs to be stable.
+
+
Note: This combination of Pin and Unpin allows a whole class of complex
+types to be safe in Rust which are otherwise difficult to implement because
+they are self-referential. That is, they are data structures where one part
+of the structure refers to another internally. As we have seen, futures can
+match that description, so self-referential types which require Pin show up
+most commonly in async Rust today, but you might—very rarely!—see it in
+other contexts, too.
+
+
Now we know enough to understand the error message from above. The problem is
+that the futures produced by an async block are not pinned by default.
+Strictly: they implement !Unpin to opt out of being copyable by default the
+way most types are. We need to pin them explicitly.
+
Now that we have an idea what that error message was telling us, we can finally
+get our join_all call to compile! First, we need to explicitly annotate
+futures as referring to a pinned Box of futures. Second, we actually need to
+pin the futures, which we can do using the handy Box::pin API, which exists
+for exactly this. Putting that together, we end up with the code in Listing
+17-23.
+
+Filename: src/main.rs
+
use std::{
+ future::Future,
+ pin::{pin, Pin},
+ time::Duration,
+};
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = pin!(async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let rx_fut = pin!(async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+
+ let tx_fut = pin!(async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let futures: Vec<Pin<Box<dyn Future<Output = ()>>>> =
+ vec![Box::pin(tx1_fut), Box::pin(rx_fut), Box::pin(tx_fut)];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-23: Using Pin and Box::pin to make the Vec type check
+
+
If we compile and run this, we finally get the output we hoped for:
There is a bit more we can explore here. For one thing, using Pin<Box<T>>
+comes with a small amount of extra overhead from putting these futures on the
+heap with Box—and we are only doing that to get the types to line up. We don’t
+actually need the heap allocation, after all: these futures are local to this
+particular function. As noted above, Pin is itself a smart pointer, so we can
+get the benefit of having a single type in the Vec—the original reason we
+reached for Box—without doing a heap allocation. We can use Pin directly
+instead.
+
The std::pin::pin macro exists to do just that for values. However, we must
+still be explicit about the type of the pinned reference; otherwise Rust will
+still not know to interpret these as dynamic trait objects, which is what we
+need them to be in the Vec. We therefore pin! each future when we define it,
+and define futures as a Vec containing pinned mutable references to the
+dynamic Future type, as in Listing 17-24.
+
+Filename: src/main.rs
+
use std::{
+ future::Future,
+ pin::{pin, Pin},
+ time::Duration,
+};
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = pin!(async move {
+ // snip...
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let rx_fut = pin!(async {
+ // snip...
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+
+ let tx_fut = pin!(async move {
+ // snip...
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let futures: Vec<Pin<&mut dyn Future<Output = ()>>> =
+ vec![tx1_fut, rx_fut, tx_fut];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-24: Using Pin directly with the pin! macro to avoid unnecessary heap allocations
+
+
This keeps everything on the stack, which is a nice little performance win, but
+it is still a lot of explicit types, which is quite unusual for Rust!
+
There is another, more serious, issue as well. We got this far by ignoring the
+fact that we might have different Output types. For example, in Listing 17-25,
+the anonymous future type for a implements Future<Output = u32>, the
+anonymous future type for b implements Future<Output = &str>, and the
+anonymous future type for c implements Future<Output = bool>. We can use
+trpl::join! to await them together, since it accepts futures of different
+types.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let a = async { 1u32 };
+ let b = async { "Hello!" };
+ let c = async { true };
+
+ let (a_result, b_result, c_result) = trpl::join!(a, b, c);
+ println!("{a_result}, {b_result}, {c_result}");
+ });
+}
+Listing 17-25: Three futures with distinct types
+
+
We cannot use trpl::join_all with these futures, though, because
+we will never be able to make them have the same type. (Remember, that error is
+what got us started on this adventure with Pin!)
+
We have a basic tradeoff here: we can either deal with a dynamic number of
+futures with join_all, as long as they all have the same type, or we can deal
+with a set number of futures with the join functions or the join! macro,
+even if they have different types. This is the same as working with any other
+type in Rust, though: futures are not special, even though we have some nice
+syntax for working with them, and that is a good thing!
+
In practice, you will usually work directly with async and .await, and only
+as a secondary tool reach for the functions like join or join_all, or their
+corresponding macro equivalents. Likewise, you will only need to reach for pin
+now and again to use them with those APIs. These kinds of tools are mostly
+handy for building frameworks, or especially when you are building a runtime
+itself, rather than for day to day Rust code. When you see them, though, now you
+will know what to do!
Thus far, we have only used the join family of functions and macros. When we
+“join” on some collection of futures, we require all of them to finish before
+we move on. Sometimes, though, we only need some future from a set to finish
+before we move on—kind of like racing one future against another. This operation
+is often named race for exactly that reason.
+
In Listing 17-26, we use race to run two futures, slow and fast, against
+each other. Each one prints a message when it starts running, pauses for some
+amount of time by calling and awaiting sleep, and then prints another message
+when it finishes. Then we pass both to trpl::race and wait for one of them to
+finish. (The outcome here won’t be too surprising: fast wins!)
+Listing 17-26: Using race to get the result of whichever future finishes first
+
+
One other thing to notice: if you flip the order of the arguments to race, the
+order of the start messages changes, even though the fast future always
+completes first. That is because the implementation of this particular race
+function is not fair. It always runs the futures passed as arguments in the
+order they are passed. Other implementations are fair, and will randomly
+choose which future to start first.
+
Regardless of whether the implementation of race we are using is fair, though,
+one of the futures will run up to the first .await in its body before
+another task can start.
+
To see why, recall from our discussion in “What Are Futures?” that
+Rust compiles async blocks in a way that hands control back to the async runtime
+at each await point. That has an important corollary: async runtimes can only
+switch which future they are executing at await points. Everything in between
+await points is just normal synchronous Rust code. That means if you do a bunch
+of really expensive work in an async function without an .await, that future
+will block any other futures from making progress.
+
+
Note: You may sometimes hear this referred to as one future starving other
+futures. The same thing applies to threads, too!
+
+
That has another important consequence for using race, join, and other such
+helpers. Some future is going to run first, and everything up to the first
+await point in that future will run before any part of any other future gets a
+chance to run. For simple code, that may not be a big deal. However, if you are
+doing some kind of expensive setup or long-running work, or if you have a future
+which will keep doing some particular task indefinitely, you will need to think
+about when and where to hand control back to the runtime.
Let’s consider a long-running operation. Here, we will simulate it using sleep
+inside the function, but in the real world it could be any of operations which
+might take a while, and which, critically, are blocking. Our slow helper
+function “slow” will just take a number of milliseconds to run, and sleep the
+thread for that long. This is intentionally not an async function, because the
+idea is to represent work that is not async.
+
+Filename: src/main.rs
+
use std::{thread, time::Duration};
+
+fn main() {
+ trpl::block_on(async {
+ // We will call `slow` here later
+ });
+}
+
+fn slow(name: &str, ms: u64) {
+ thread::sleep(Duration::from_millis(ms));
+ println!("'{name}' ran for {ms}ms");
+}
+Listing 17-27: Using thread::sleep to simulate slow operations
+
+
In Listing 17-28, we use slow to emulate doing this kind of CPU-bound work in
+a pair of futures. To begin, each future only hands control back to the runtime
+after carrying out a bunch of slow operations.
+Listing 17-28: Using thread::sleep to simulate slow operations
+
+
If you run this, you will see this output:
+
$ cargo run
+ Compiling proc-macro2 v1.0.82
+ Compiling unicode-ident v1.0.12
+ Compiling autocfg v1.3.0
+ Compiling futures-sink v0.3.30
+ Compiling futures-core v0.3.30
+ Compiling libc v0.2.154
+ Compiling pin-project-lite v0.2.14
+ Compiling futures-io v0.3.30
+ Compiling memchr v2.7.2
+ Compiling futures-task v0.3.30
+ Compiling futures-channel v0.3.30
+ Compiling pin-utils v0.1.0
+ Compiling slab v0.4.9
+ Compiling num_cpus v1.16.0
+ Compiling tokio v1.37.0
+ Compiling quote v1.0.36
+ Compiling syn v2.0.63
+ Compiling futures-macro v0.3.30
+ Compiling futures-util v0.3.30
+ Compiling futures-executor v0.3.30
+ Compiling futures v0.3.30
+ Compiling trpl v0.1.0 (/Users/chris/dev/rust-lang/book/packages/trpl)
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-26)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 4.32s
+ Running `target/debug/async_await`
+'a' started.
+'a' ran for 300ms
+'a' ran for 100ms
+'a' ran for 200ms
+'a' ran for 900ms
+'b' started.
+'b' ran for 750ms
+'b' ran for 100ms
+'b' ran for 150ms
+'b' ran for 350ms
+'b' ran for 150ms
+'a' finished.
+
+
As with our earlier example, race still finishes when a finishes. There is
+no interleaving between the two futures, though. The a future does all of its
+work until the trpl::sleep call is awaited, then the b future does all of
+its work until its own trpl::sleep call is awaited, and then the a future
+completes. It would be better if both futures could make progress between their
+slow tasks. We need some way to hand control back to the runtime there—and we
+know that await points are the way to do that. However, that means we need
+something we can await!
+
However, we can also see the handoff happening in this very example: if we
+removed the trpl::sleep at the end of the a future, it would complete
+without the b future running at all. Given that, maybe we could use the
+sleep function as a starting point, as in Listing 17-29.
+Listing 17-29: Using sleep to let operations switch off making progress
+
+
Now the two futures’ work is interleaved, as we can see if we run it.
+
+
'a' started.
+'a' ran for 300ms
+'b' started.
+'b' ran for 750ms
+'a' ran for 100ms
+'b' ran for 100ms
+'a' ran for 200ms
+'b' ran for 150ms
+'a' ran for 900ms
+'b' ran for 350ms
+'a' finished.
+
+
The a future still runs for a bit before handing off control to b, because
+it has some expensive work to do up front, but after that they just swap back
+and forth every time one of them hits an await point. In this case, we have done
+that after every call to slow, but we could break up the work however makes
+the most sense to us.
+
However, we do not actually need to sleep to accomplish this. We just need to
+hand back control to the runtime. We can actually yield control back to the
+runtime, using a function named yield_now. It does just what it says: hands
+control back to the runtime, so that the runtime can check whether any other
+tasks are ready to make progress.
+Listing 17-30: Using yield_now to let operations switch off making progress
+
+
This is both clearer about the actual intent and can be significantly faster
+than using sleep, because timers like the one used by sleep often have
+limits to how granular they can be. The version of sleep we are using, for
+example, will always sleep for at least a millisecond, even if we pass it a
+Duration of one nanosecond. Again, modern computers are fast: they can do a
+lot in one millisecond!
+
You can see this for yourself by setting up a little benchmark, like the one in
+Listing 17-31. (This is not an especially rigorous way to do performance
+testing, but it suffices to show the difference here.) Here, we skip all the
+status printing, pass a one-nanosecond Duration to sleep, let each future
+run by itself so that they do not interfere with each other, and get rid of all
+the status printing that we did to see the back-and-forth between tasks in
+Listings 17-29 and 17-30. Then we run for 1,000 iterations and see how long
+sleep takes vs. yield_now.
+
+Filename: src/main.rs
+
use std::time::{Duration, Instant};
+
+fn main() {
+ trpl::block_on(async {
+ let one_ns = Duration::from_nanos(1);
+ let start = Instant::now();
+ async {
+ for _ in 1..1000 {
+ trpl::sleep(one_ns).await;
+ }
+ }
+ .await;
+ let time = Instant::now() - start;
+ println!(
+ "'sleep' version finished after {} seconds.",
+ time.as_secs_f32()
+ );
+
+ let start = Instant::now();
+ async {
+ for _ in 1..1000 {
+ trpl::yield_now().await;
+ }
+ }
+ .await;
+ let time = Instant::now() - start;
+ println!(
+ "'yield' version finished after {} seconds.",
+ time.as_secs_f32()
+ );
+ });
+}
+Listing 17-31: Comparing the performance of sleep and yield_now
+
+
The version with yield_now is way faster!
+
+
Note: This also means that async can be a useful tool even for CPU-bound
+tasks, depending on what else your program is doing, because it provides a
+useful tool for structuring the relationships between different parts of the
+program. This is a form of cooperative multitasking, where each future has
+both the power to determine when it hands over control via await points and
+therefore also the responsibility to avoid blocking for too long. This is
+how some Rust-based embedded operating systems work!
+
+
In real-world code, you will not usually be alternative regular function calls
+with await points on every single line, of course. The underlying dynamic is an
+important one to keep in mind, though!
Many of these patterns are common enough to warrant abstracting over. For
+example, the trpl::timeout function takes a Duration for the maximum time to
+run, but also takes a future to run, and produces a new future you can await,
+whose Output type is a Result. Listing 17-32 shows how we can use it. If
+the passed-in future finishes first, the output result will be Ok, with the
+result of that passed-in future. If the duration elapses before the passed-in
+future finishes, the result will be Err with the duration that elapsed.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let slow = async {
+ trpl::sleep(Duration::from_secs(5)).await;
+ "I finished!"
+ };
+
+ match trpl::timeout(Duration::from_secs(2), slow).await {
+ Ok(message) => println!("Succeeded with '{message}'"),
+ Err(duration) => {
+ println!("Failed after {} seconds", duration.as_secs())
+ }
+ }
+ });
+}
+Listing 17-32: Using timeout to run a slow operation with a time limit
+
+
Here we were using the timeout supplied by trpl, but we do not have to. We
+can implement it ourselves using race and sleep! To begin, let’s think about
+the API of timeout:
+
+
Its first parameter is a std::time::Duration which specifies the maximum
+time to wait.
+
Its second parameter is the future to run.
+
It returns a Result. If the future completes successfully, the Result will
+be Ok with the value produced by the future. If the timeout happens, the
+Result will be Err with the duration that the timeout waited for.
+
+
We can write the same signature ourselves, as in Listing 17-33.
+
+Filename: src/main.rs
+
use std::{future::Future, time::Duration};
+
+fn main() {
+ trpl::block_on(async {
+ let slow = async {
+ trpl::sleep(Duration::from_secs(5)).await;
+ "Finally finished"
+ };
+
+ // Here we will actually use the new `timeout` with `slow`.
+ });
+}
+
+async fn timeout<F: Future>(
+ max_time: Duration,
+ future: F,
+) -> Result<F::Output, Duration> {
+ unimplemented!()
+}
+Listing 17-33: Defining the signature of timeout
+
+
Then, in the body of the function, we can race whatever future the caller
+passes with a sleep future.
+
When we saw race earlier in Listing 17-26, we ignored its return type,
+because we were just interested in seeing the behavior of fast and slow when
+we ran the program. Here, though, its return value tells us whether the future
+or the sleep finished first. With race, both futures passed as arguments can
+legitimately “win,” so it does not make sense to use a Result to represent the
+return type. Instead, it returns a similar type called Either. Like Result,
+Either can be one of two types, but unlike Result, there is no notion of
+success or failure baked into the type. Instead, it uses Left and Right to
+indicate “one or the other”. Its implementation looks like this:
In the case of race specifically, it returns Left if the first argument
+finishes first, with that future’s output, and Right with the second future
+argument’s output if that one finishes first.
That gives us enough to be able to implement timeout ourselves using race
+and sleep.
+
+Filename: src/main.rs
+
use std::{future::Future, time::Duration};
+
+use trpl::Either;
+
+fn main() {
+ trpl::block_on(async {
+ let slow = async {
+ trpl::sleep(Duration::from_secs(5)).await;
+ "Finally finished"
+ };
+
+ // Here we will actually use the new `timeout` with `slow`.
+ });
+}
+
+// Note for maintainers: the extra space after the `ANCHOR` is intentional: it
+// makes this render more nicely!
+
+async fn timeout<F: Future>(
+ max_time: Duration,
+ future: F,
+) -> Result<F::Output, Duration> {
+ match trpl::race(future, trpl::sleep(max_time)).await {
+ Either::Left(output) => Ok(output),
+ Either::Right(_) => Err(max_time),
+ }
+}
+Listing 17-34: Defining timeout with race and sleep
+
+
Let’s walk through the details. Since we know from earlier that race is not
+fair, and will prefer the first argument to the second, we pass it the future
+first so it gets a chance to complete even if the caller passes in a very short
+value for max_time. Then we match on the result of awaiting the race. If the
+future passed in by the caller finished first, we will have Left(output),
+which we can return as a success with Ok. If the sleep finished first, we will
+have Right(()) instead, since timeout returns the unit type () if it
+succeeds. We can ignore that () by using _ and return Err with the
+duration the user passed in instead. And that’s it!
+
Back in main, we can call this new timeout function exactly like we called
+trpl::timeout before, but without the trpl:: namespace:
+Listing 17-35: Using the timeout function we defined ourselves
+
+
This pattern is quite common and useful. Futures compose with other futures, so
+you can build really powerful tools using smaller async building blocks. For
+example, you can use this same approach to combine timeouts with retries, and
+in turn use those with things like network calls—the exact example we started
+out with at the beginning of the chapter!
+
Over the last two sections, we have seen how to work with multiple futures at
+the same time. Up next, let’s look at how we can work with multiple futures in a
+sequence over time, with streams.
In Chapter 13, we looked at the Iterator trait, and we saw how we could work
+with a sequence of items in turn. So far in this chapter, we have mostly stuck
+with individual futures. The one big exception was the async channel we used.
+Recall how we used the receiver for our async channel in the “Message
+Passing” earlier in the chapter:
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+}
+
This is because the rx receiver actually represents a stream of messages: a
+sequence over time.
+
Unlike Iterator and Future, there is no definition of a Stream type in the
+standard library yet but there is a
+very common definition used throughout the ecosystem. If we start with the
+definition of the Iterator and Trait types, we can figure out what a trait
+that merges them together might look like.
+
The Iterator trait defines an associated type Item and a function next,
+which produces Some(Item) until the underlying iterator is empty, and then
+produces None.
As we saw earlier in this chapter, the Future trait defines an associated item
+Output and a function poll, which produces Poll::Pending while waiting and
+then Poll::Ready(Output) once the future is ready.
From Iterator, we have the idea of a sequence; its next method provides an
+Option<Self::Item>. From Future, we have the idea of readiness; its poll
+method provides a Poll<Self::Output>. To get a stream, a sequence of items
+which become ready over time, we can define a Stream as a trait which has all
+of those features put together:
+
+
+
An associated type Item for the type of the items, just like in Iterator.
+Unlike in Future, where there was a single Output, we use Item here to
+indicate that it is more like Iterator: there may be zero to many of these.
+
+
+
A method to get those items. We can call it poll_next, to make it clear that
+it is polling like a future and producing a sequence of items one after
+another, just like an iterator.
+
+
+
A return type from poll_next which uses both Poll and Option. The outer
+type is Poll, since it has to be checked for readiness as a kind of future.
+The inner type is Option, since it needs to signal whether there are more
+messages, just like an iterator.
+
+
+
When we put those all together, we end up with the same definition for a
+Stream trait as the one used by the Rust ecosystem:
Something very similar to this will likely end up standardized as part of Rust’s
+standard library, just the way Future was. In the meantime, it is part of the
+toolkit of most runtimes, so you can rely on it, and everything we cover below
+should generally apply!
We could work directly in terms of the poll_next API by hand-writing our own
+Stream state machines. However, just as we do not generally work with futures
+directly via their poll method, we generally also do not work directly with
+the poll_next method for streams. Instead, we usually use a next method,
+which is defined roughly like this:
Note: The actual definition we will use looks slightly different than this,
+because it supports versions of Rust which did not yet support using async
+functions in traits. As a result, it looks like this:
That Next type is just a simple struct which implements Future, so that
+.await can work with this!
+
+
Working with this API will be kind of like working with iterators without the
+convenience of a for loop. In fact, it will look a lot like the way we used
+rx.recv back in the “Message Passing” section, using while let loops.
+
Let’s start with a very simple example: using an iterator as a stream. Let’s
+start by creating a range of numbers, including every integer from 1 to 100,
+using the .. range operator. Then we can double all of those values with the
+map method, as Listing 17-36 shows:
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ });
+}
+Listing 17-36: Creating an iterator ranging over the values from 1 to 100
+
+
We can convert this iterator to a stream using the trpl::stream_from_iter
+function.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let mut stream = trpl::stream_from_iter(iter);
+ });
+}
+Listing 17-37: Converting an iterator to a stream with trpl::stream_from_iter
+
+
This gives us the stream. Now, to work with it, we want to use the next method
+with a while let loop as described above, as in Listing 17-38:
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let mut stream = trpl::stream_from_iter(iter);
+
+ while let Some(value) = stream.next().await {
+ println!("The value was: {value}");
+ }
+ });
+}
+Listing 17-38: Trying to use the next method on the newly-created stream
+
+
Unfortunately, this does not yet work. When we try to run the code, it does not
+compile. Instead, as we can see in the output, it reports that there is no
+next method available.
+
$ cargo run
+ Compiling proc-macro2 v1.0.85
+ Compiling unicode-ident v1.0.12
+ Compiling autocfg v1.3.0
+ Compiling pin-project-lite v0.2.14
+ Compiling futures-core v0.3.30
+ Compiling libc v0.2.155
+ Compiling futures-sink v0.3.30
+ Compiling futures-task v0.3.30
+ Compiling pin-utils v0.1.0
+ Compiling futures-io v0.3.30
+ Compiling memchr v2.7.4
+ Compiling futures-channel v0.3.30
+ Compiling slab v0.4.9
+ Compiling num_cpus v1.16.0
+ Compiling quote v1.0.36
+ Compiling tokio v1.38.0
+ Compiling syn v2.0.66
+ Compiling tokio-stream v0.1.15
+ Compiling futures-macro v0.3.30
+ Compiling futures-util v0.3.30
+ Compiling futures-executor v0.3.30
+ Compiling futures v0.3.30
+ Compiling trpl v0.1.0 (/Users/chris/dev/rust-lang/book/packages/trpl)
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-38)
+error[E0599]: no method named `next` found for struct `Iter` in the current scope
+ --> src/main.rs:8:40
+ |
+8 | while let Some(value) = stream.next().await {
+ | ^^^^
+ |
+ = note: the full type name has been written to '/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-38/target/debug/deps/async_await-bbd5bb8f6851cb5f.long-type-17453505919820464996.txt'
+ = note: consider using `--verbose` to print the full type name to the console
+ = help: items from traits can only be used if the trait is in scope
+help: the following traits which provide `next` are implemented but not in scope; perhaps you want to import one of them
+ |
+1 + use futures_util::stream::stream::StreamExt;
+ |
+1 + use std::iter::Iterator;
+ |
+1 + use std::str::pattern::Searcher;
+ |
+1 + use trpl::StreamExt;
+ |
+help: there is a method `try_next` with a similar name
+ |
+8 | while let Some(value) = stream.try_next().await {
+ | ~~~~~~~~
+
+For more information about this error, try `rustc --explain E0599`.
+error: could not compile `async_await` (bin "async_await") due to 1 previous error
+
+
As the output suggests, the problem is that we need the right trait in scope to
+be able to use it. In this case, that trait is StreamExt. (The Ext there is
+for “extension”: this is a common pattern in the Rust community for extending
+one trait with another.) StreamExt is automatically implemented for every type
+which implements Stream, but they are separated out so that the community can
+iterate on the foundational trait distinctly from the convenience APIs. All we
+need to do, then, is add a use statement for trpl::StreamExt, as in Listing
+17-39.
+
+Filename: src/main.rs
+
use trpl::StreamExt;
+
+fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let mut stream = trpl::stream_from_iter(iter);
+
+ while let Some(value) = stream.next().await {
+ println!("The value was: {value}");
+ }
+ });
+}
+Listing 17-39: Successfully using an iterator as the basis for a stream
+
+
With all those pieces put together, things work the way we want! There is a lot
+of output, though, since we told it to print all of the 100 numbers in the
+iterator. We can filter that down, to, say, multiples of three and five by using
+the filter method, which conveniently also comes from StreamExt.
+
+Filename: src/main.rs
+
use trpl::StreamExt;
+
+fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let stream = trpl::stream_from_iter(iter);
+
+ let mut filtered =
+ stream.filter(|value| value % 3 == 0 || value % 5 == 0);
+
+ while let Some(value) = filtered.next().await {
+ println!("The value was: {value}");
+ }
+ });
+}
+ Listing 17-40: Filtering a Stream with the StreamExt::filter method
+
+
Of course, in the real world, the only time we would be directly converting an
+iterator to a stream like this is to help break up longer chunks of work, like
+we discussed in the previous section. There are more interesting things we can
+do with streams, though!
For one thing, lots of things are naturally represented as streams—items
+becoming available in a queue over time, for example, or working with more data
+than can fit in a computer’s memory by only pulling chunks of it from the file
+system at a time, or data arriving over the network over time. For another
+thing, since streams are futures, we can use them with any other kind of
+future, and we can combine them in interesting ways.
+
In the real world, we can use this to do things like debounce events to avoid
+triggering too many network calls, set timeouts on sequences of long-running
+operations, or throttle user interface events to avoid doing needless work.
+Let’s start by building a little stream of messages. This is similar to what we
+might see from a WebSocket or some other real-time communication protocol. To
+begin, we will create a function, get_messages(), which returns impl Stream<Item = String>, and use a while let loop to print all the messages
+from the stream.
+Listing 17-41: Using the rx receiver as a ReceiverStream
+
+
In Listing 17-41, we also use a new type: ReceiverStream. This converts the
+rx receiver from the trpl::channel into a stream. This is pretty easy, since
+the API for a receiver like this already has the same basic shape as a Stream.
+
So far this will compile just fine, but we are not sending any messages, so
+nothing will happen when we run the program. We can change that by looping over
+the first ten letters of the English alphabet, and sending those across the
+channel.
+
+Filename: src/main.rs
+
use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let mut messages = get_messages();
+
+ while let Some(message) = messages.next().await {
+ println!("{message}");
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for message in messages {
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+
+ ReceiverStream::new(rx)
+}
+Listing 17-42: Sending messages through the channel to print
+
+
When we run the code in Listing 17-42, we get exactly the results we would
+expect:
Thus far, we have not seen anything we could not do with the regular recv API.
+Since this is a stream, though, we can do things like add a timeout which
+applies to every item in the stream, as in Listing 17-43.
+
+Filename: src/main.rs
+
use std::time::Duration;
+// --snip--
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+
+ let mut messages = get_messages().timeout(Duration::from_millis(200));
+
+ while let Some(result) = messages.next().await {
+ match result {
+ Ok(message) => println!("{message}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for message in messages {
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+
+ ReceiverStream::new(rx)
+}
+Listing 17-43: Using the StreamExt::timeout method to set a time limit on the items in a stream
+
+
First, we add a timeout to the stream itself, using the the timeout method,
+which is available on the stream because we already have StreamExt in scope.
+Second, we update the the while let loop because the stream now returns a
+Result, where the Ok variant indicates a message arrived in time and the
+Err variant indicates that the timeout elapsed before any message arrived. We
+can use a match to either print the message when we receive it successfully,
+or to notify about a problem if the timeout happened.
+
Unfortunately, this does not compile. It is our old friend Unpin again! Both
+the next() method and the await tell us that that type PhantomPin cannot
+be unpinned. (This PhantomPin is just a special type that the runtime is using
+to keep track of what needs to be pinned in a way that only shows up at
+compile time, but has no cost when actually running the program.) The solution
+is exactly the same as what we saw earlier in the chapter: to pin the messages
+with the pin macro. Once we add that, as in Listing 17-44, the program
+compiles again.
+
+Filename: src/main.rs
+
use std::{pin::pin, time::Duration};
+// --snip--
+
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let mut messages =
+ pin!(get_messages().timeout(Duration::from_millis(200)));
+
+ while let Some(result) = messages.next().await {
+ match result {
+ Ok(message) => println!("{message}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for message in messages {
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+
+ ReceiverStream::new(rx)
+}
+Listing 17-44: Pinning messages with the pin! macro to
+
+
However, since there are no delays between messages, this timeout does not
+change the behavior of the program yet. To see the timeout actually have an
+effect, we will add a delay to the messages we send. We will use the enumerate
+iterator method to get the index of the items we are sending, and apply a 100
+millisecond delay to even-index items and a 300 millisecond delay to odd-index
+items, to simulate the different delays we might see from a stream of messages
+in the real world.
+
+Filename: src/main.rs
+
use std::{pin::pin, time::Duration};
+
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let mut messages =
+ pin!(get_messages().timeout(Duration::from_millis(200)));
+
+ while let Some(result) = messages.next().await {
+ match result {
+ Ok(message) => println!("{message}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ trpl::spawn_task(async move {
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for (index, message) in messages.into_iter().enumerate() {
+ let time_to_sleep = if index % 2 == 0 { 100 } else { 300 };
+ trpl::sleep(Duration::from_millis(time_to_sleep)).await;
+
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+ });
+
+ ReceiverStream::new(rx)
+}
+Listing 17-45: Sending messages through tx with an async delay without making get_messages an async function
+
+
To do that without blocking the get_messages function, we need to use async.
+However, we cannot just turn get_messages itself into an async function,
+because then we would return a Future<Output = Stream<Item = String>> instead
+of just a Stream<Item = String>>. In practical terms, we would end up sending
+all the messages and sleeping repeatedly before finally returning the receiver
+stream. The caller would end up getting all the messages immediately, without
+the sleep in between them, because the caller would not even be able to start
+processing the stream until all of the await points in get_messages had been
+hit.
+
Instead, we leave get_messages as a regular function which returns a stream,
+and spawn a task to handle the async sleep calls.
+
+
Note: calling spawn_task like this works because we already set up our
+runtime. Calling this particular implementation of spawn_taskwithout
+first setting up a runtime will cause a panic. Other implementations choose
+different tradeoffs: they might spawn a new runtime and so avoid the panic but
+end up with a bit of extra overhead, or simply not provide a standalone way to
+spawn tasks without reference to a runtime. You should make sure you know what
+tradeoff your runtime has chosen and write your code accordingly!
+
+
Now our code has a much more interesting result! Between the messages, we see an
+error reported: Problem: Elapsed(()). Notice that it does not prevent the
+messages from arriving in the end—we still get all of the original messages.
+This is because our channel is unbounded: it can hold as many messages as we can
+fit in memory. If the message does not arrive before the timeout, our stream
+handler will account for that, but when it polls the stream again, the message
+may now have arrived.
You can get different behavior if needed by using other kinds of channels, or
+other kinds of streams more generally. Let’s see one of those in practice in our
+final example for this section, by combining a stream of time intervals with
+this stream of messages.
First, let’s create another stream, called get_intervals, which will emit an
+item every millisecond if we let it run directly. For simplicity, we can use the
+sleep function to send a message on that delay, and combine it with the same
+approach of creating a stream from a channel that we used for get_messages.
+(There are, of course, many other ways to build streams, including some
+dedicated to working with intervals!) The difference is that this time, we are
+going to send back the count of intervals, rather than a string, so the
+resulting stream will have the type Stream<Item = u32>.
+
In Listing 17-46, we start by defining a count in the task. (We could define
+it outside the task, too, but it is clearer to limit the scope of any given
+variable.) Then we create a an infinite loop. Each iteration of the loop
+asynchronously sleeps for one millisecond, increments the count, and then sends
+it over the channel. Since this is all wrapped in the task created by
+spawn_task, all of it will get cleaned up along with the runtime, including
+the infinite loop.
+Listing 17-46: Creating a stream with a counter that will be emitted once every millisecond
+
+
This kind of infinite loop, which only ends when the whole runtime gets torn
+down, is a fairly common pattern when dealing with many different kinds of async
+operations in Rust. That is because there are many kinds of programs which need
+to keep running until something actually ends the program.
+
Now we need to use these intervals! Back in our main function’s async block, we
+start by getting the intervals. Then we can try to create a merged stream using
+messages and intervals, and loop over that combined stream instead of over
+messages (Listing 17-47). At this point, neither messages nor intervals
+needs to be pinned or mutable, because both will be combined into the single
+merged stream. However, this call to merge does not type check! (Neither
+does the next call in the while let loop, but we will come back to that
+after fixing this first.)
The problem is that our two streams have different types. The messages stream
+has the type Timeout<impl Stream<Item = String>>. The Timeout is the type
+which implements Stream for a timeout call! Meanwhile, the intervals stream has
+the type impl Stream<Item = u32>. To merge these two streams, we need to transform one of
+them to match the other. Let’s work with the intervals, since messages is
+already in the basic format we want and has to handle timeout errors.
+
Listing 17-48 shows the transformations we need. First, we can use the map
+helper method to transform the intervals into a string. Second, we need to
+match the Timeout from messages. Since we do not actually want a timeout
+for intervals, though, we can just create a timeout which is longer than the
+other durations we are using. Here, we create a 10-second time out with
+Duration::from_secs(10). Finally, we need to make merged both mutable, so
+that the while let loop’s next calls can iterate through the stream, and
+pinned, so that it is safe to do so.
That gets us almost to where we need to be. Everything type checks! If you run
+this, though, the messages from the English alphabet will be buried in the midst
+of all the interval counter messages:
This is no good; we need to only take some of those intervals—say, once every
+hundred milliseconds. For that, we can use the throttle method. Throttling is
+a way of limiting the rate at which a function will be called—or, in this case,
+how often the stream will be polled. We also don’t want to keep going
+indefinitely! We can use the take method to limit how many items we pull from
+a stream. In Listing 17-49, we apply throttle to the intervals stream,
+because we want to avoid overwhelming the stream of messages, but we apply the
+take method to the merged messages, because we want to limit the final
+output, not just one stream or the other.
There is one last thing we need to handle: errors! With both of these
+channel-based streams, the send calls could fail when the other side of the
+channel closes—and that is just a matter of how the runtime executes the futures
+which make up the stream. Up till now we have ignored this by calling unwrap,
+but in a well-behaved app, we should explicitly handle the error, at minimum by
+ending the loop so we do not try to send any more messages! Listing 17-50 shows
+a simple error strategy: print the issue and then break from the loops. As
+usual, the correct behavior on a message send error will vary—just make sure you
+do in fact have a strategy.
+Listing 17-50: Handling errors and shutting down the loops
+
+
Notice that we do not get Interval #100 or Interval #200 or so on, but
+instead simply get Interval #1, Interval #2, and so on—even though we have a
+source stream which can produce an event every millisecond. That is because
+the throttle call produces a new stream, wrapping the original stream, so that
+the original stream only gets polled at the throttle rate, not its own “native”
+rate. We do not have a bunch of unhandled interval messages we are simply
+choosing to ignore. Instead, we never produce those interval messages in the
+first place! This is the inherent “laziness” of Rust’s futures at work again,
+allowing us to choose our performance characteristics.
+
That is a good note to turn to our final section and wrap up this walk through
+async in Rust, by discussing how futures (including streams), tasks, and threads
+relate to each other, and how you can use them together.
As we saw in the previous chapter, threads provide one approach to concurrency.
+We have seen another approach to concurrency in this chapter, using async with
+futures and streams. You might be wondering why you would choose one or the
+other. The answer is: it depends! And in many cases, it is not threads vs.
+async but rather threads and async.
+
Threads are an older and more common tool for concurrency. Many operating
+systems have supplied threading-based concurrency models for decades now, and
+many programming languages have support for them as a result. However, they are
+not without their tradeoffs. On many operating systems, they use a fair bit of
+memory for each thread, and they come with some overhead for starting up and
+shutting down. Threads are also only an option when your operating system and
+hardware support them! Unlike mainstream desktop and mobile operating systems,
+many embedded operating systems, like those used on some microcontrollers, do
+not have OS-level threads at all.
+
The async model provides a different—and ultimately complementary—set of
+tradeoffs. In the async model, concurrent operations do not require their own
+threads. Instead, they can run on tasks, as when we used trpl::spawn_task to
+kick off work from a synchronous function throughout the streams section. A task
+is a lot like a thread—but instead of being managed by the operating system, it
+is managed by library-level code: the runtime.
+
In the previous section, we saw that we could build a Stream by using a
+channel and spawning an async task which we could call from synchronous code. We
+could do the exact same thing with a thread! We’ll use a simpler version of the
+streams example so we can focus on the differences. In Listing 17-50, we used
+trpl::spawn_task and trpl::sleep. In Listing 17-51, we replace those with
+the thread::spawn and thread::sleep APIs from the standard library, in just
+the get_intervals function.
+
+Filename: src/main.rs
+
use std::{pin::pin, time::Duration};
+
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let messages = get_messages().timeout(Duration::from_millis(200));
+ let intervals = get_intervals()
+ .map(|count| format!("Interval #{count}"))
+ .throttle(Duration::from_millis(500))
+ .timeout(Duration::from_secs(10));
+
+ let mut merged = pin!(messages.merge(intervals).take(20));
+
+ while let Some(result) = merged.next().await {
+ match result {
+ Ok(item) => println!("{item}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ trpl::spawn_task(async move {
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+
+ for (index, message) in messages.into_iter().enumerate() {
+ let time_to_sleep = if index % 2 == 0 { 100 } else { 300 };
+ trpl::sleep(Duration::from_millis(time_to_sleep)).await;
+
+ if let Err(send_error) =
+ tx.send(format!("Message: '{message}' after {time_to_sleep}ms"))
+ {
+ eprintln!("Cannot send message '{message}': {send_error}");
+ break;
+ }
+ }
+ });
+
+ ReceiverStream::new(rx)
+}
+
+fn get_intervals() -> impl Stream<Item = u32> {
+ let (tx, rx) = trpl::channel();
+
+ trpl::spawn_task(async move {
+ let mut count = 0;
+ loop {
+ trpl::sleep(Duration::from_millis(1)).await;
+ count += 1;
+ if let Err(send_error) = tx.send(count) {
+ eprintln!("Could not send interval {count}: {send_error}");
+ break;
+ };
+ }
+ });
+
+ ReceiverStream::new(rx)
+}
+Listing 17-51: TODO
+
+
If you run this, the output is identical. And notice how little changes here
+from the perspective of the calling code! What is more, even though one of our
+functions spawned an async task on the runtime and the other spawned an
+operating system thread, they worked exactly the same way as far as processing
+the stream was concerned.
+
However, there is a meaningful difference in the way this system
+behaves, although we might have a hard time measuring it in this very simple
+example. We could spawn hundreds of thousands or even millions of async tasks on
+any modern personal computer. If we tried to do that with threads, we would
+literally run out of memory!
+
However, there is a reason these APIs are so similar. Threads act as a boundary
+for sets of synchronous operations; concurrency is possible between threads.
+Tasks act as a boundary for sets of asynchronous operations; concurrency is
+possible both between and within tasks. In that regard, tasks are kind of
+like lightweight, runtime-managed threads with added capabilities that come from
+being managed by a runtime instead of by the operating system.
+
However, this does not mean that async tasks are always better than threads, any
+more than that threads are always better than tasks.
+
On the one hand, concurrency with threads is in some ways a simpler programming
+model than concurrency with async. Threads are somewhat “fire and forget”, and
+they only allow interaction with the rest of the program via tools like channels
+or their final result via join. On the other hand, they have no native
+equivalent to a future, so they simply run to completion, without interruption
+except by the operating system itself. Threads also have no mechanisms for
+cancellation—a subject we have not covered in depth in this chapter, but which
+is implicit in the fact that whenever we ended a future, its state got cleaned
+up correctly.
+
These limitations make threads harder to compose than futures. It
+is much more difficult, for example, to build something like the timeout we
+built in “Building Our Own Async Abstractions”, or the
+throttle method we used with streams in “Working With Streams”. The fact
+that futures are richer data structures means they can be composed together
+more naturally, as we have seen.
+
Tasks then give additional control over futures, allowing you to choose where
+and how to group them. And it turns out that threads and tasks often work very
+well together, because tasks can (at least in some runtimes) be moved around
+between threads. We have not mentioned it up until now, but under the hood the
+Runtime we have been using, including the spawn_blocking and spawn_task
+functions, are multithreaded by default! Many runtimes can transparently move
+tasks around between threads based on the current utilization of the threads, to
+hopefully improve the overall performance of the system. To build that actually
+requires threads and tasks, and therefore futures.
Object-oriented programming (OOP) is a way of modeling programs. Objects as a
+programmatic concept were introduced in the programming language Simula in the
+1960s. Those objects influenced Alan Kay’s programming architecture in which
+objects pass messages to each other. To describe this architecture, he coined
+the term object-oriented programming in 1967. Many competing definitions
+describe what OOP is, and by some of these definitions Rust is object-oriented,
+but by others it is not. In this chapter, we’ll explore certain characteristics
+that are commonly considered object-oriented and how those characteristics
+translate to idiomatic Rust. We’ll then show you how to implement an
+object-oriented design pattern in Rust and discuss the trade-offs of doing so
+versus implementing a solution using some of Rust’s strengths instead.
There is no consensus in the programming community about what features a
+language must have to be considered object-oriented. Rust is influenced by many
+programming paradigms, including OOP; for example, we explored the features
+that came from functional programming in Chapter 13. Arguably, OOP languages
+share certain common characteristics, namely objects, encapsulation, and
+inheritance. Let’s look at what each of those characteristics means and whether
+Rust supports it.
The book Design Patterns: Elements of Reusable Object-Oriented Software by
+Erich Gamma, Richard Helm, Ralph Johnson, and John Vlissides (Addison-Wesley
+Professional, 1994), colloquially referred to as The Gang of Four book, is a
+catalog of object-oriented design patterns. It defines OOP this way:
+
+
Object-oriented programs are made up of objects. An object packages both
+data and the procedures that operate on that data. The procedures are
+typically called methods or operations.
+
+
Using this definition, Rust is object-oriented: structs and enums have data,
+and impl blocks provide methods on structs and enums. Even though structs and
+enums with methods aren’t called objects, they provide the same
+functionality, according to the Gang of Four’s definition of objects.
Another aspect commonly associated with OOP is the idea of encapsulation,
+which means that the implementation details of an object aren’t accessible to
+code using that object. Therefore, the only way to interact with an object is
+through its public API; code using the object shouldn’t be able to reach into
+the object’s internals and change data or behavior directly. This enables the
+programmer to change and refactor an object’s internals without needing to
+change the code that uses the object.
+
We discussed how to control encapsulation in Chapter 7: we can use the pub
+keyword to decide which modules, types, functions, and methods in our code
+should be public, and by default everything else is private. For example, we
+can define a struct AveragedCollection that has a field containing a vector
+of i32 values. The struct can also have a field that contains the average of
+the values in the vector, meaning the average doesn’t have to be computed
+on demand whenever anyone needs it. In other words, AveragedCollection will
+cache the calculated average for us. Listing 17-1 has the definition of the
+AveragedCollection struct:
Listing 17-1: An AveragedCollection struct that
+maintains a list of integers and the average of the items in the
+collection
+
The struct is marked pub so that other code can use it, but the fields within
+the struct remain private. This is important in this case because we want to
+ensure that whenever a value is added or removed from the list, the average is
+also updated. We do this by implementing add, remove, and average methods
+on the struct, as shown in Listing 17-2:
Listing 17-2: Implementations of the public methods
+add, remove, and average on AveragedCollection
+
The public methods add, remove, and average are the only ways to access
+or modify data in an instance of AveragedCollection. When an item is added
+to list using the add method or removed using the remove method, the
+implementations of each call the private update_average method that handles
+updating the average field as well.
+
We leave the list and average fields private so there is no way for
+external code to add or remove items to or from the list field directly;
+otherwise, the average field might become out of sync when the list
+changes. The average method returns the value in the average field,
+allowing external code to read the average but not modify it.
+
Because we’ve encapsulated the implementation details of the struct
+AveragedCollection, we can easily change aspects, such as the data structure,
+in the future. For instance, we could use a HashSet<i32> instead of a
+Vec<i32> for the list field. As long as the signatures of the add,
+remove, and average public methods stay the same, code using
+AveragedCollection wouldn’t need to change in order to compile. If we made
+list public instead, this wouldn’t necessarily be the case: HashSet<i32> and
+Vec<i32> have different methods for adding and removing items, so the external
+code would likely have to change if it were modifying list directly.
+
If encapsulation is a required aspect for a language to be considered
+object-oriented, then Rust meets that requirement. The option to use pub or
+not for different parts of code enables encapsulation of implementation details.
Inheritance is a mechanism whereby an object can inherit elements from
+another object’s definition, thus gaining the parent object’s data and behavior
+without you having to define them again.
+
If a language must have inheritance to be an object-oriented language, then
+Rust is not one. There is no way to define a struct that inherits the parent
+struct’s fields and method implementations without using a macro.
+
However, if you’re used to having inheritance in your programming toolbox, you
+can use other solutions in Rust, depending on your reason for reaching for
+inheritance in the first place.
+
You would choose inheritance for two main reasons. One is for reuse of code:
+you can implement particular behavior for one type, and inheritance enables you
+to reuse that implementation for a different type. You can do this in a limited
+way in Rust code using default trait method implementations, which you saw in
+Listing 10-14 when we added a default implementation of the summarize method
+on the Summary trait. Any type implementing the Summary trait would have
+the summarize method available on it without any further code. This is
+similar to a parent class having an implementation of a method and an
+inheriting child class also having the implementation of the method. We can
+also override the default implementation of the summarize method when we
+implement the Summary trait, which is similar to a child class overriding the
+implementation of a method inherited from a parent class.
+
The other reason to use inheritance relates to the type system: to enable a
+child type to be used in the same places as the parent type. This is also
+called polymorphism, which means that you can substitute multiple objects for
+each other at runtime if they share certain characteristics.
To many people, polymorphism is synonymous with inheritance. But it’s
+actually a more general concept that refers to code that can work with data
+of multiple types. For inheritance, those types are generally subclasses.
+
Rust instead uses generics to abstract over different possible types and
+trait bounds to impose constraints on what those types must provide. This is
+sometimes called bounded parametric polymorphism.
+
+
Inheritance has recently fallen out of favor as a programming design solution
+in many programming languages because it’s often at risk of sharing more code
+than necessary. Subclasses shouldn’t always share all characteristics of their
+parent class but will do so with inheritance. This can make a program’s design
+less flexible. It also introduces the possibility of calling methods on
+subclasses that don’t make sense or that cause errors because the methods don’t
+apply to the subclass. In addition, some languages will only allow single
+inheritance (meaning a subclass can only inherit from one class), further
+restricting the flexibility of a program’s design.
+
For these reasons, Rust takes the different approach of using trait objects
+instead of inheritance. Let’s look at how trait objects enable polymorphism in
+Rust.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch18-02-trait-objects.html b/ch18-02-trait-objects.html
new file mode 100644
index 0000000000..c776715751
--- /dev/null
+++ b/ch18-02-trait-objects.html
@@ -0,0 +1,554 @@
+
+
+
+
+
+ Using Trait Objects That Allow for Values of Different Types - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
In Chapter 8, we mentioned that one limitation of vectors is that they can
+store elements of only one type. We created a workaround in Listing 8-9 where
+we defined a SpreadsheetCell enum that had variants to hold integers, floats,
+and text. This meant we could store different types of data in each cell and
+still have a vector that represented a row of cells. This is a perfectly good
+solution when our interchangeable items are a fixed set of types that we know
+when our code is compiled.
+
However, sometimes we want our library user to be able to extend the set of
+types that are valid in a particular situation. To show how we might achieve
+this, we’ll create an example graphical user interface (GUI) tool that iterates
+through a list of items, calling a draw method on each one to draw it to the
+screen—a common technique for GUI tools. We’ll create a library crate called
+gui that contains the structure of a GUI library. This crate might include
+some types for people to use, such as Button or TextField. In addition,
+gui users will want to create their own types that can be drawn: for
+instance, one programmer might add an Image and another might add a
+SelectBox.
+
We won’t implement a fully fledged GUI library for this example but will show
+how the pieces would fit together. At the time of writing the library, we can’t
+know and define all the types other programmers might want to create. But we do
+know that gui needs to keep track of many values of different types, and it
+needs to call a draw method on each of these differently typed values. It
+doesn’t need to know exactly what will happen when we call the draw method,
+just that the value will have that method available for us to call.
+
To do this in a language with inheritance, we might define a class named
+Component that has a method named draw on it. The other classes, such as
+Button, Image, and SelectBox, would inherit from Component and thus
+inherit the draw method. They could each override the draw method to define
+their custom behavior, but the framework could treat all of the types as if
+they were Component instances and call draw on them. But because Rust
+doesn’t have inheritance, we need another way to structure the gui library to
+allow users to extend it with new types.
To implement the behavior we want gui to have, we’ll define a trait named
+Draw that will have one method named draw. Then we can define a vector that
+takes a trait object. A trait object points to both an instance of a type
+implementing our specified trait and a table used to look up trait methods on
+that type at runtime. We create a trait object by specifying some sort of
+pointer, such as a & reference or a Box<T> smart pointer, then the dyn
+keyword, and then specifying the relevant trait. (We’ll talk about the reason
+trait objects must use a pointer in Chapter 19 in the section “Dynamically
+Sized Types and the Sized Trait.”) We can
+use trait objects in place of a generic or concrete type. Wherever we use a
+trait object, Rust’s type system will ensure at compile time that any value
+used in that context will implement the trait object’s trait. Consequently, we
+don’t need to know all the possible types at compile time.
+
We’ve mentioned that, in Rust, we refrain from calling structs and enums
+“objects” to distinguish them from other languages’ objects. In a struct or
+enum, the data in the struct fields and the behavior in impl blocks are
+separated, whereas in other languages, the data and behavior combined into one
+concept is often labeled an object. However, trait objects are more like
+objects in other languages in the sense that they combine data and behavior.
+But trait objects differ from traditional objects in that we can’t add data to
+a trait object. Trait objects aren’t as generally useful as objects in other
+languages: their specific purpose is to allow abstraction across common
+behavior.
+
Listing 17-3 shows how to define a trait named Draw with one method named
+draw:
+
Filename: src/lib.rs
+
pub trait Draw {
+ fn draw(&self);
+}
+
Listing 17-3: Definition of the Draw trait
+
This syntax should look familiar from our discussions on how to define traits
+in Chapter 10. Next comes some new syntax: Listing 17-4 defines a struct named
+Screen that holds a vector named components. This vector is of type
+Box<dyn Draw>, which is a trait object; it’s a stand-in for any type inside
+a Box that implements the Draw trait.
Listing 17-5: A run method on Screen that calls the
+draw method on each component
+
This works differently from defining a struct that uses a generic type
+parameter with trait bounds. A generic type parameter can only be substituted
+with one concrete type at a time, whereas trait objects allow for multiple
+concrete types to fill in for the trait object at runtime. For example, we
+could have defined the Screen struct using a generic type and a trait bound
+as in Listing 17-6:
Listing 17-6: An alternate implementation of the Screen
+struct and its run method using generics and trait bounds
+
This restricts us to a Screen instance that has a list of components all of
+type Button or all of type TextField. If you’ll only ever have homogeneous
+collections, using generics and trait bounds is preferable because the
+definitions will be monomorphized at compile time to use the concrete types.
+
On the other hand, with the method using trait objects, one Screen instance
+can hold a Vec<T> that contains a Box<Button> as well as a
+Box<TextField>. Let’s look at how this works, and then we’ll talk about the
+runtime performance implications.
Now we’ll add some types that implement the Draw trait. We’ll provide the
+Button type. Again, actually implementing a GUI library is beyond the scope
+of this book, so the draw method won’t have any useful implementation in its
+body. To imagine what the implementation might look like, a Button struct
+might have fields for width, height, and label, as shown in Listing 17-7:
Listing 17-7: A Button struct that implements the
+Draw trait
+
The width, height, and label fields on Button will differ from the
+fields on other components; for example, a TextField type might have those
+same fields plus a placeholder field. Each of the types we want to draw on
+the screen will implement the Draw trait but will use different code in the
+draw method to define how to draw that particular type, as Button has here
+(without the actual GUI code, as mentioned). The Button type, for instance,
+might have an additional impl block containing methods related to what
+happens when a user clicks the button. These kinds of methods won’t apply to
+types like TextField.
+
If someone using our library decides to implement a SelectBox struct that has
+width, height, and options fields, they implement the Draw trait on the
+SelectBox type as well, as shown in Listing 17-8:
Listing 17-8: Another crate using gui and implementing
+the Draw trait on a SelectBox struct
+
Our library’s user can now write their main function to create a Screen
+instance. To the Screen instance, they can add a SelectBox and a Button
+by putting each in a Box<T> to become a trait object. They can then call the
+run method on the Screen instance, which will call draw on each of the
+components. Listing 17-9 shows this implementation:
Listing 17-9: Using trait objects to store values of
+different types that implement the same trait
+
When we wrote the library, we didn’t know that someone might add the
+SelectBox type, but our Screen implementation was able to operate on the
+new type and draw it because SelectBox implements the Draw trait, which
+means it implements the draw method.
+
This concept—of being concerned only with the messages a value responds to
+rather than the value’s concrete type—is similar to the concept of duck
+typing in dynamically typed languages: if it walks like a duck and quacks
+like a duck, then it must be a duck! In the implementation of run on Screen
+in Listing 17-5, run doesn’t need to know what the concrete type of each
+component is. It doesn’t check whether a component is an instance of a Button
+or a SelectBox, it just calls the draw method on the component. By
+specifying Box<dyn Draw> as the type of the values in the components
+vector, we’ve defined Screen to need values that we can call the draw
+method on.
+
The advantage of using trait objects and Rust’s type system to write code
+similar to code using duck typing is that we never have to check whether a
+value implements a particular method at runtime or worry about getting errors
+if a value doesn’t implement a method but we call it anyway. Rust won’t compile
+our code if the values don’t implement the traits that the trait objects need.
+
For example, Listing 17-10 shows what happens if we try to create a Screen
+with a String as a component:
Listing 17-10: Attempting to use a type that doesn’t
+implement the trait object’s trait
+
We’ll get this error because String doesn’t implement the Draw trait:
+
$ cargo run
+ Compiling gui v0.1.0 (file:///projects/gui)
+error[E0277]: the trait bound `String: Draw` is not satisfied
+ --> src/main.rs:5:26
+ |
+5 | components: vec![Box::new(String::from("Hi"))],
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `Draw` is not implemented for `String`
+ |
+ = help: the trait `Draw` is implemented for `Button`
+ = note: required for the cast from `Box<String>` to `Box<dyn Draw>`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `gui` (bin "gui") due to 1 previous error
+
+
This error lets us know that either we’re passing something to Screen we
+didn’t mean to pass and so should pass a different type or we should implement
+Draw on String so that Screen is able to call draw on it.
Recall in the “Performance of Code Using
+Generics” section in
+Chapter 10 our discussion on the monomorphization process performed by the
+compiler when we use trait bounds on generics: the compiler generates
+nongeneric implementations of functions and methods for each concrete type that
+we use in place of a generic type parameter. The code that results from
+monomorphization is doing static dispatch, which is when the compiler knows
+what method you’re calling at compile time. This is opposed to dynamic
+dispatch, which is when the compiler can’t tell at compile time which method
+you’re calling. In dynamic dispatch cases, the compiler emits code that at
+runtime will figure out which method to call.
+
When we use trait objects, Rust must use dynamic dispatch. The compiler doesn’t
+know all the types that might be used with the code that’s using trait objects,
+so it doesn’t know which method implemented on which type to call. Instead, at
+runtime, Rust uses the pointers inside the trait object to know which method to
+call. This lookup incurs a runtime cost that doesn’t occur with static
+dispatch. Dynamic dispatch also prevents the compiler from choosing to inline a
+method’s code, which in turn prevents some optimizations. However, we did get
+extra flexibility in the code that we wrote in Listing 17-5 and were able to
+support in Listing 17-9, so it’s a trade-off to consider.
The state pattern is an object-oriented design pattern. The crux of the
+pattern is that we define a set of states a value can have internally. The
+states are represented by a set of state objects, and the value’s behavior
+changes based on its state. We’re going to work through an example of a blog
+post struct that has a field to hold its state, which will be a state object
+from the set “draft”, “review”, or “published”.
+
The state objects share functionality: in Rust, of course, we use structs and
+traits rather than objects and inheritance. Each state object is responsible
+for its own behavior and for governing when it should change into another
+state. The value that holds a state object knows nothing about the different
+behavior of the states or when to transition between states.
+
The advantage of using the state pattern is that, when the business
+requirements of the program change, we won’t need to change the code of the
+value holding the state or the code that uses the value. We’ll only need to
+update the code inside one of the state objects to change its rules or perhaps
+add more state objects.
+
First, we’re going to implement the state pattern in a more traditional
+object-oriented way, then we’ll use an approach that’s a bit more natural in
+Rust. Let’s dig in to incrementally implementing a blog post workflow using the
+state pattern.
+
The final functionality will look like this:
+
+
A blog post starts as an empty draft.
+
When the draft is done, a review of the post is requested.
+
When the post is approved, it gets published.
+
Only published blog posts return content to print, so unapproved posts can’t
+accidentally be published.
+
+
Any other changes attempted on a post should have no effect. For example, if we
+try to approve a draft blog post before we’ve requested a review, the post
+should remain an unpublished draft.
+
Listing 17-11 shows this workflow in code form: this is an example usage of the
+API we’ll implement in a library crate named blog. This won’t compile yet
+because we haven’t implemented the blog crate.
+
Filename: src/main.rs
+
use blog::Post;
+
+fn main() {
+ let mut post = Post::new();
+
+ post.add_text("I ate a salad for lunch today");
+ assert_eq!("", post.content());
+
+ post.request_review();
+ assert_eq!("", post.content());
+
+ post.approve();
+ assert_eq!("I ate a salad for lunch today", post.content());
+}
+
Listing 17-11: Code that demonstrates the desired
+behavior we want our blog crate to have
+
We want to allow the user to create a new draft blog post with Post::new. We
+want to allow text to be added to the blog post. If we try to get the post’s
+content immediately, before approval, we shouldn’t get any text because the
+post is still a draft. We’ve added assert_eq! in the code for demonstration
+purposes. An excellent unit test for this would be to assert that a draft blog
+post returns an empty string from the content method, but we’re not going to
+write tests for this example.
+
Next, we want to enable a request for a review of the post, and we want
+content to return an empty string while waiting for the review. When the post
+receives approval, it should get published, meaning the text of the post will
+be returned when content is called.
+
Notice that the only type we’re interacting with from the crate is the Post
+type. This type will use the state pattern and will hold a value that will be
+one of three state objects representing the various states a post can be
+in—draft, waiting for review, or published. Changing from one state to another
+will be managed internally within the Post type. The states change in
+response to the methods called by our library’s users on the Post instance,
+but they don’t have to manage the state changes directly. Also, users can’t
+make a mistake with the states, like publishing a post before it’s reviewed.
Let’s get started on the implementation of the library! We know we need a
+public Post struct that holds some content, so we’ll start with the
+definition of the struct and an associated public new function to create an
+instance of Post, as shown in Listing 17-12. We’ll also make a private
+State trait that will define the behavior that all state objects for a Post
+must have.
+
Then Post will hold a trait object of Box<dyn State> inside an Option<T>
+in a private field named state to hold the state object. You’ll see why the
+Option<T> is necessary in a bit.
+
Filename: src/lib.rs
+
pub struct Post {
+ state: Option<Box<dyn State>>,
+ content: String,
+}
+
+impl Post {
+ pub fn new() -> Post {
+ Post {
+ state: Some(Box::new(Draft {})),
+ content: String::new(),
+ }
+ }
+}
+
+trait State {}
+
+struct Draft {}
+
+impl State for Draft {}
+
Listing 17-12: Definition of a Post struct and a new
+function that creates a new Post instance, a State trait, and a Draft
+struct
+
The State trait defines the behavior shared by different post states. The
+state objects are Draft, PendingReview, and Published, and they will all
+implement the State trait. For now, the trait doesn’t have any methods, and
+we’ll start by defining just the Draft state because that is the state we
+want a post to start in.
+
When we create a new Post, we set its state field to a Some value that
+holds a Box. This Box points to a new instance of the Draft struct.
+This ensures whenever we create a new instance of Post, it will start out as
+a draft. Because the state field of Post is private, there is no way to
+create a Post in any other state! In the Post::new function, we set the
+content field to a new, empty String.
We saw in Listing 17-11 that we want to be able to call a method named
+add_text and pass it a &str that is then added as the text content of the
+blog post. We implement this as a method, rather than exposing the content
+field as pub, so that later we can implement a method that will control how
+the content field’s data is read. The add_text method is pretty
+straightforward, so let’s add the implementation in Listing 17-13 to the impl Post block:
+
Filename: src/lib.rs
+
pub struct Post {
+ state: Option<Box<dyn State>>,
+ content: String,
+}
+
+impl Post {
+ // --snip--
+ pub fn new() -> Post {
+ Post {
+ state: Some(Box::new(Draft {})),
+ content: String::new(),
+ }
+ }
+
+ pub fn add_text(&mut self, text: &str) {
+ self.content.push_str(text);
+ }
+}
+
+trait State {}
+
+struct Draft {}
+
+impl State for Draft {}
+
Listing 17-13: Implementing the add_text method to add
+text to a post’s content
+
The add_text method takes a mutable reference to self, because we’re
+changing the Post instance that we’re calling add_text on. We then call
+push_str on the String in content and pass the text argument to add to
+the saved content. This behavior doesn’t depend on the state the post is in,
+so it’s not part of the state pattern. The add_text method doesn’t interact
+with the state field at all, but it is part of the behavior we want to
+support.
Even after we’ve called add_text and added some content to our post, we still
+want the content method to return an empty string slice because the post is
+still in the draft state, as shown on line 7 of Listing 17-11. For now, let’s
+implement the content method with the simplest thing that will fulfill this
+requirement: always returning an empty string slice. We’ll change this later
+once we implement the ability to change a post’s state so it can be published.
+So far, posts can only be in the draft state, so the post content should always
+be empty. Listing 17-14 shows this placeholder implementation:
Next, we need to add functionality to request a review of a post, which should
+change its state from Draft to PendingReview. Listing 17-15 shows this code:
Listing 17-15: Implementing request_review methods on
+Post and the State trait
+
We give Post a public method named request_review that will take a mutable
+reference to self. Then we call an internal request_review method on the
+current state of Post, and this second request_review method consumes the
+current state and returns a new state.
+
We add the request_review method to the State trait; all types that
+implement the trait will now need to implement the request_review method.
+Note that rather than having self, &self, or &mut self as the first
+parameter of the method, we have self: Box<Self>. This syntax means the
+method is only valid when called on a Box holding the type. This syntax takes
+ownership of Box<Self>, invalidating the old state so the state value of the
+Post can transform into a new state.
+
To consume the old state, the request_review method needs to take ownership
+of the state value. This is where the Option in the state field of Post
+comes in: we call the take method to take the Some value out of the state
+field and leave a None in its place, because Rust doesn’t let us have
+unpopulated fields in structs. This lets us move the state value out of
+Post rather than borrowing it. Then we’ll set the post’s state value to the
+result of this operation.
+
We need to set state to None temporarily rather than setting it directly
+with code like self.state = self.state.request_review(); to get ownership of
+the state value. This ensures Post can’t use the old state value after
+we’ve transformed it into a new state.
+
The request_review method on Draft returns a new, boxed instance of a new
+PendingReview struct, which represents the state when a post is waiting for a
+review. The PendingReview struct also implements the request_review method
+but doesn’t do any transformations. Rather, it returns itself, because when we
+request a review on a post already in the PendingReview state, it should stay
+in the PendingReview state.
+
Now we can start seeing the advantages of the state pattern: the
+request_review method on Post is the same no matter its state value. Each
+state is responsible for its own rules.
+
We’ll leave the content method on Post as is, returning an empty string
+slice. We can now have a Post in the PendingReview state as well as in the
+Draft state, but we want the same behavior in the PendingReview state.
+Listing 17-11 now works up to line 10!
The approve method will be similar to the request_review method: it will
+set state to the value that the current state says it should have when that
+state is approved, as shown in Listing 17-16:
Listing 17-16: Implementing the approve method on
+Post and the State trait
+
We add the approve method to the State trait and add a new struct that
+implements State, the Published state.
+
Similar to the way request_review on PendingReview works, if we call the
+approve method on a Draft, it will have no effect because approve will
+return self. When we call approve on PendingReview, it returns a new,
+boxed instance of the Published struct. The Published struct implements the
+State trait, and for both the request_review method and the approve
+method, it returns itself, because the post should stay in the Published
+state in those cases.
+
Now we need to update the content method on Post. We want the value
+returned from content to depend on the current state of the Post, so we’re
+going to have the Post delegate to a content method defined on its state,
+as shown in Listing 17-17:
Listing 17-17: Updating the content method on Post to
+delegate to a content method on State
+
Because the goal is to keep all these rules inside the structs that implement
+State, we call a content method on the value in state and pass the post
+instance (that is, self) as an argument. Then we return the value that’s
+returned from using the content method on the state value.
+
We call the as_ref method on the Option because we want a reference to the
+value inside the Option rather than ownership of the value. Because state
+is an Option<Box<dyn State>>, when we call as_ref, an Option<&Box<dyn State>> is returned. If we didn’t call as_ref, we would get an error because
+we can’t move state out of the borrowed &self of the function parameter.
+
We then call the unwrap method, which we know will never panic, because we
+know the methods on Post ensure that state will always contain a Some
+value when those methods are done. This is one of the cases we talked about in
+the “Cases In Which You Have More Information Than the
+Compiler” section of Chapter 9 when we
+know that a None value is never possible, even though the compiler isn’t able
+to understand that.
+
At this point, when we call content on the &Box<dyn State>, deref coercion
+will take effect on the & and the Box so the content method will
+ultimately be called on the type that implements the State trait. That means
+we need to add content to the State trait definition, and that is where
+we’ll put the logic for what content to return depending on which state we
+have, as shown in Listing 17-18:
Listing 17-18: Adding the content method to the State
+trait
+
We add a default implementation for the content method that returns an empty
+string slice. That means we don’t need to implement content on the Draft
+and PendingReview structs. The Published struct will override the content
+method and return the value in post.content.
+
Note that we need lifetime annotations on this method, as we discussed in
+Chapter 10. We’re taking a reference to a post as an argument and returning a
+reference to part of that post, so the lifetime of the returned reference is
+related to the lifetime of the post argument.
+
And we’re done—all of Listing 17-11 now works! We’ve implemented the state
+pattern with the rules of the blog post workflow. The logic related to the
+rules lives in the state objects rather than being scattered throughout Post.
You may have been wondering why we didn’t use an enum with the different
+possible post states as variants. That’s certainly a possible solution, try
+it and compare the end results to see which you prefer! One disadvantage of
+using an enum is every place that checks the value of the enum will need a
+match expression or similar to handle every possible variant. This could
+get more repetitive than this trait object solution.
We’ve shown that Rust is capable of implementing the object-oriented state
+pattern to encapsulate the different kinds of behavior a post should have in
+each state. The methods on Post know nothing about the various behaviors. The
+way we organized the code, we have to look in only one place to know the
+different ways a published post can behave: the implementation of the State
+trait on the Published struct.
+
If we were to create an alternative implementation that didn’t use the state
+pattern, we might instead use match expressions in the methods on Post or
+even in the main code that checks the state of the post and changes behavior
+in those places. That would mean we would have to look in several places to
+understand all the implications of a post being in the published state! This
+would only increase the more states we added: each of those match expressions
+would need another arm.
+
With the state pattern, the Post methods and the places we use Post don’t
+need match expressions, and to add a new state, we would only need to add a
+new struct and implement the trait methods on that one struct.
+
The implementation using the state pattern is easy to extend to add more
+functionality. To see the simplicity of maintaining code that uses the state
+pattern, try a few of these suggestions:
+
+
Add a reject method that changes the post’s state from PendingReview back
+to Draft.
+
Require two calls to approve before the state can be changed to Published.
+
Allow users to add text content only when a post is in the Draft state.
+Hint: have the state object responsible for what might change about the
+content but not responsible for modifying the Post.
+
+
One downside of the state pattern is that, because the states implement the
+transitions between states, some of the states are coupled to each other. If we
+add another state between PendingReview and Published, such as Scheduled,
+we would have to change the code in PendingReview to transition to
+Scheduled instead. It would be less work if PendingReview didn’t need to
+change with the addition of a new state, but that would mean switching to
+another design pattern.
+
Another downside is that we’ve duplicated some logic. To eliminate some of the
+duplication, we might try to make default implementations for the
+request_review and approve methods on the State trait that return self;
+however, this would violate object safety, because the trait doesn’t know what
+the concrete self will be exactly. We want to be able to use State as a
+trait object, so we need its methods to be object safe.
+
Other duplication includes the similar implementations of the request_review
+and approve methods on Post. Both methods delegate to the implementation of
+the same method on the value in the state field of Option and set the new
+value of the state field to the result. If we had a lot of methods on Post
+that followed this pattern, we might consider defining a macro to eliminate the
+repetition (see the “Macros” section in Chapter 19).
+
By implementing the state pattern exactly as it’s defined for object-oriented
+languages, we’re not taking as full advantage of Rust’s strengths as we could.
+Let’s look at some changes we can make to the blog crate that can make
+invalid states and transitions into compile time errors.
We’ll show you how to rethink the state pattern to get a different set of
+trade-offs. Rather than encapsulating the states and transitions completely so
+outside code has no knowledge of them, we’ll encode the states into different
+types. Consequently, Rust’s type checking system will prevent attempts to use
+draft posts where only published posts are allowed by issuing a compiler error.
+
Let’s consider the first part of main in Listing 17-11:
+
Filename: src/main.rs
+
use blog::Post;
+
+fn main() {
+ let mut post = Post::new();
+
+ post.add_text("I ate a salad for lunch today");
+ assert_eq!("", post.content());
+
+ post.request_review();
+ assert_eq!("", post.content());
+
+ post.approve();
+ assert_eq!("I ate a salad for lunch today", post.content());
+}
+
We still enable the creation of new posts in the draft state using Post::new
+and the ability to add text to the post’s content. But instead of having a
+content method on a draft post that returns an empty string, we’ll make it so
+draft posts don’t have the content method at all. That way, if we try to get
+a draft post’s content, we’ll get a compiler error telling us the method
+doesn’t exist. As a result, it will be impossible for us to accidentally
+display draft post content in production, because that code won’t even compile.
+Listing 17-19 shows the definition of a Post struct and a DraftPost struct,
+as well as methods on each:
Listing 17-19: A Post with a content method and a
+DraftPost without a content method
+
Both the Post and DraftPost structs have a private content field that
+stores the blog post text. The structs no longer have the state field because
+we’re moving the encoding of the state to the types of the structs. The Post
+struct will represent a published post, and it has a content method that
+returns the content.
+
We still have a Post::new function, but instead of returning an instance of
+Post, it returns an instance of DraftPost. Because content is private
+and there aren’t any functions that return Post, it’s not possible to create
+an instance of Post right now.
+
The DraftPost struct has an add_text method, so we can add text to
+content as before, but note that DraftPost does not have a content method
+defined! So now the program ensures all posts start as draft posts, and draft
+posts don’t have their content available for display. Any attempt to get around
+these constraints will result in a compiler error.
So how do we get a published post? We want to enforce the rule that a draft
+post has to be reviewed and approved before it can be published. A post in the
+pending review state should still not display any content. Let’s implement
+these constraints by adding another struct, PendingReviewPost, defining the
+request_review method on DraftPost to return a PendingReviewPost, and
+defining an approve method on PendingReviewPost to return a Post, as
+shown in Listing 17-20:
Listing 17-20: A PendingReviewPost that gets created by
+calling request_review on DraftPost and an approve method that turns a
+PendingReviewPost into a published Post
+
The request_review and approve methods take ownership of self, thus
+consuming the DraftPost and PendingReviewPost instances and transforming
+them into a PendingReviewPost and a published Post, respectively. This way,
+we won’t have any lingering DraftPost instances after we’ve called
+request_review on them, and so forth. The PendingReviewPost struct doesn’t
+have a content method defined on it, so attempting to read its content
+results in a compiler error, as with DraftPost. Because the only way to get a
+published Post instance that does have a content method defined is to call
+the approve method on a PendingReviewPost, and the only way to get a
+PendingReviewPost is to call the request_review method on a DraftPost,
+we’ve now encoded the blog post workflow into the type system.
+
But we also have to make some small changes to main. The request_review and
+approve methods return new instances rather than modifying the struct they’re
+called on, so we need to add more let post = shadowing assignments to save
+the returned instances. We also can’t have the assertions about the draft and
+pending review posts’ contents be empty strings, nor do we need them: we can’t
+compile code that tries to use the content of posts in those states any longer.
+The updated code in main is shown in Listing 17-21:
+
Filename: src/main.rs
+
use blog::Post;
+
+fn main() {
+ let mut post = Post::new();
+
+ post.add_text("I ate a salad for lunch today");
+
+ let post = post.request_review();
+
+ let post = post.approve();
+
+ assert_eq!("I ate a salad for lunch today", post.content());
+}
+
Listing 17-21: Modifications to main to use the new
+implementation of the blog post workflow
+
The changes we needed to make to main to reassign post mean that this
+implementation doesn’t quite follow the object-oriented state pattern anymore:
+the transformations between the states are no longer encapsulated entirely
+within the Post implementation. However, our gain is that invalid states are
+now impossible because of the type system and the type checking that happens at
+compile time! This ensures that certain bugs, such as display of the content of
+an unpublished post, will be discovered before they make it to production.
+
Try the tasks suggested at the start of this section on the blog crate as it
+is after Listing 17-21 to see what you think about the design of this version
+of the code. Note that some of the tasks might be completed already in this
+design.
+
We’ve seen that even though Rust is capable of implementing object-oriented
+design patterns, other patterns, such as encoding state into the type system,
+are also available in Rust. These patterns have different trade-offs. Although
+you might be very familiar with object-oriented patterns, rethinking the
+problem to take advantage of Rust’s features can provide benefits, such as
+preventing some bugs at compile time. Object-oriented patterns won’t always be
+the best solution in Rust due to certain features, like ownership, that
+object-oriented languages don’t have.
No matter whether or not you think Rust is an object-oriented language after
+reading this chapter, you now know that you can use trait objects to get some
+object-oriented features in Rust. Dynamic dispatch can give your code some
+flexibility in exchange for a bit of runtime performance. You can use this
+flexibility to implement object-oriented patterns that can help your code’s
+maintainability. Rust also has other features, like ownership, that
+object-oriented languages don’t have. An object-oriented pattern won’t always
+be the best way to take advantage of Rust’s strengths, but is an available
+option.
+
Next, we’ll look at patterns, which are another of Rust’s features that enable
+lots of flexibility. We’ve looked at them briefly throughout the book but
+haven’t seen their full capability yet. Let’s go!
Patterns are a special syntax in Rust for matching against the structure of
+types, both complex and simple. Using patterns in conjunction with match
+expressions and other constructs gives you more control over a program’s
+control flow. A pattern consists of some combination of the following:
+
+
Literals
+
Destructured arrays, enums, structs, or tuples
+
Variables
+
Wildcards
+
Placeholders
+
+
Some example patterns include x, (a, 3), and Some(Color::Red). In the
+contexts in which patterns are valid, these components describe the shape of
+data. Our program then matches values against the patterns to determine whether
+it has the correct shape of data to continue running a particular piece of code.
+
To use a pattern, we compare it to some value. If the pattern matches the
+value, we use the value parts in our code. Recall the match expressions in
+Chapter 6 that used patterns, such as the coin-sorting machine example. If the
+value fits the shape of the pattern, we can use the named pieces. If it
+doesn’t, the code associated with the pattern won’t run.
+
This chapter is a reference on all things related to patterns. We’ll cover the
+valid places to use patterns, the difference between refutable and irrefutable
+patterns, and the different kinds of pattern syntax that you might see. By the
+end of the chapter, you’ll know how to use patterns to express many concepts in
+a clear way.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch19-01-all-the-places-for-patterns.html b/ch19-01-all-the-places-for-patterns.html
new file mode 100644
index 0000000000..409ce80aeb
--- /dev/null
+++ b/ch19-01-all-the-places-for-patterns.html
@@ -0,0 +1,470 @@
+
+
+
+
+
+ All the Places Patterns Can Be Used - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Patterns pop up in a number of places in Rust, and you’ve been using them a lot
+without realizing it! This section discusses all the places where patterns are
+valid.
As discussed in Chapter 6, we use patterns in the arms of match expressions.
+Formally, match expressions are defined as the keyword match, a value to
+match on, and one or more match arms that consist of a pattern and an
+expression to run if the value matches that arm’s pattern, like this:
+
match VALUE {
+ PATTERN => EXPRESSION,
+ PATTERN => EXPRESSION,
+ PATTERN => EXPRESSION,
+}
+
+
For example, here’s the match expression from Listing 6-5 that matches on an
+Option<i32> value in the variable x:
+
match x {
+ None => None,
+ Some(i) => Some(i + 1),
+}
+
The patterns in this match expression are the None and Some(i) on the
+left of each arrow.
+
One requirement for match expressions is that they need to be exhaustive in
+the sense that all possibilities for the value in the match expression must
+be accounted for. One way to ensure you’ve covered every possibility is to have
+a catchall pattern for the last arm: for example, a variable name matching any
+value can never fail and thus covers every remaining case.
+
The particular pattern _ will match anything, but it never binds to a
+variable, so it’s often used in the last match arm. The _ pattern can be
+useful when you want to ignore any value not specified, for example. We’ll
+cover the _ pattern in more detail in the “Ignoring Values in a
+Pattern” section later in this
+chapter.
In Chapter 6 we discussed how to use if let expressions mainly as a shorter
+way to write the equivalent of a match that only matches one case.
+Optionally, if let can have a corresponding else containing code to run if
+the pattern in the if let doesn’t match.
+
Listing 18-1 shows that it’s also possible to mix and match if let, else if, and else if let expressions. Doing so gives us more flexibility than a
+match expression in which we can express only one value to compare with the
+patterns. Also, Rust doesn’t require that the conditions in a series of if let, else if, else if let arms relate to each other.
+
The code in Listing 18-1 determines what color to make your background based on
+a series of checks for several conditions. For this example, we’ve created
+variables with hardcoded values that a real program might receive from user
+input.
+
Filename: src/main.rs
+
fn main() {
+ let favorite_color: Option<&str> = None;
+ let is_tuesday = false;
+ let age: Result<u8, _> = "34".parse();
+
+ if let Some(color) = favorite_color {
+ println!("Using your favorite color, {color}, as the background");
+ } else if is_tuesday {
+ println!("Tuesday is green day!");
+ } else if let Ok(age) = age {
+ if age > 30 {
+ println!("Using purple as the background color");
+ } else {
+ println!("Using orange as the background color");
+ }
+ } else {
+ println!("Using blue as the background color");
+ }
+}
+
Listing 18-1: Mixing if let, else if, else if let,
+and else
+
If the user specifies a favorite color, that color is used as the background.
+If no favorite color is specified and today is Tuesday, the background color is
+green. Otherwise, if the user specifies their age as a string and we can parse
+it as a number successfully, the color is either purple or orange depending on
+the value of the number. If none of these conditions apply, the background
+color is blue.
+
This conditional structure lets us support complex requirements. With the
+hardcoded values we have here, this example will print Using purple as the background color.
+
You can see that if let can also introduce shadowed variables in the same way
+that match arms can: the line if let Ok(age) = age introduces a new
+shadowed age variable that contains the value inside the Ok variant. This
+means we need to place the if age > 30 condition within that block: we can’t
+combine these two conditions into if let Ok(age) = age && age > 30. The
+shadowed age we want to compare to 30 isn’t valid until the new scope starts
+with the curly bracket.
+
The downside of using if let expressions is that the compiler doesn’t check
+for exhaustiveness, whereas with match expressions it does. If we omitted the
+last else block and therefore missed handling some cases, the compiler would
+not alert us to the possible logic bug.
Similar in construction to if let, the while let conditional loop allows a
+while loop to run for as long as a pattern continues to match. In Listing
+18-2 we code a while let loop that uses a vector as a stack and prints the
+values in the vector in the opposite order in which they were pushed.
+
fn main() {
+ let mut stack = Vec::new();
+
+ stack.push(1);
+ stack.push(2);
+ stack.push(3);
+
+ while let Some(top) = stack.pop() {
+ println!("{top}");
+ }
+}
+
Listing 18-2: Using a while let loop to print values
+for as long as stack.pop() returns Some
+
This example prints 3, 2, and then 1. The pop method takes the last element
+out of the vector and returns Some(value). If the vector is empty, pop
+returns None. The while loop continues running the code in its block as
+long as pop returns Some. When pop returns None, the loop stops. We can
+use while let to pop every element off our stack.
In a for loop, the value that directly follows the keyword for is a
+pattern. For example, in for x in y the x is the pattern. Listing 18-3
+demonstrates how to use a pattern in a for loop to destructure, or break
+apart, a tuple as part of the for loop.
+
fn main() {
+ let v = vec!['a', 'b', 'c'];
+
+ for (index, value) in v.iter().enumerate() {
+ println!("{value} is at index {index}");
+ }
+}
+
Listing 18-3: Using a pattern in a for loop to
+destructure a tuple
+
The code in Listing 18-3 will print the following:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.52s
+ Running `target/debug/patterns`
+a is at index 0
+b is at index 1
+c is at index 2
+
+
We adapt an iterator using the enumerate method so it produces a value and
+the index for that value, placed into a tuple. The first value produced is the
+tuple (0, 'a'). When this value is matched to the pattern (index, value),
+index will be 0 and value will be 'a', printing the first line of the
+output.
Prior to this chapter, we had only explicitly discussed using patterns with
+match and if let, but in fact, we’ve used patterns in other places as well,
+including in let statements. For example, consider this straightforward
+variable assignment with let:
+
#![allow(unused)]
+fn main() {
+let x = 5;
+}
+
Every time you’ve used a let statement like this you’ve been using patterns,
+although you might not have realized it! More formally, a let statement looks
+like this:
+
let PATTERN = EXPRESSION;
+
+
In statements like let x = 5; with a variable name in the PATTERN slot, the
+variable name is just a particularly simple form of a pattern. Rust compares
+the expression against the pattern and assigns any names it finds. So in the
+let x = 5; example, x is a pattern that means “bind what matches here to
+the variable x.” Because the name x is the whole pattern, this pattern
+effectively means “bind everything to the variable x, whatever the value is.”
+
To see the pattern matching aspect of let more clearly, consider Listing
+18-4, which uses a pattern with let to destructure a tuple.
+
fn main() {
+ let (x, y, z) = (1, 2, 3);
+}
+
Listing 18-4: Using a pattern to destructure a tuple and
+create three variables at once
+
Here, we match a tuple against a pattern. Rust compares the value (1, 2, 3)
+to the pattern (x, y, z) and sees that the value matches the pattern, so Rust
+binds 1 to x, 2 to y, and 3 to z. You can think of this tuple
+pattern as nesting three individual variable patterns inside it.
+
If the number of elements in the pattern doesn’t match the number of elements
+in the tuple, the overall type won’t match and we’ll get a compiler error. For
+example, Listing 18-5 shows an attempt to destructure a tuple with three
+elements into two variables, which won’t work.
+
fn main() {
+ let (x, y) = (1, 2, 3);
+}
+
Listing 18-5: Incorrectly constructing a pattern whose
+variables don’t match the number of elements in the tuple
+
Attempting to compile this code results in this type error:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+error[E0308]: mismatched types
+ --> src/main.rs:2:9
+ |
+2 | let (x, y) = (1, 2, 3);
+ | ^^^^^^ --------- this expression has type `({integer}, {integer}, {integer})`
+ | |
+ | expected a tuple with 3 elements, found one with 2 elements
+ |
+ = note: expected tuple `({integer}, {integer}, {integer})`
+ found tuple `(_, _)`
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `patterns` (bin "patterns") due to 1 previous error
+
+
To fix the error, we could ignore one or more of the values in the tuple using
+_ or .., as you’ll see in the “Ignoring Values in a
+Pattern” section. If the problem
+is that we have too many variables in the pattern, the solution is to make the
+types match by removing variables so the number of variables equals the number
+of elements in the tuple.
Function parameters can also be patterns. The code in Listing 18-6, which
+declares a function named foo that takes one parameter named x of type
+i32, should by now look familiar.
Listing 18-6: A function signature uses patterns in the
+parameters
+
The x part is a pattern! As we did with let, we could match a tuple in a
+function’s arguments to the pattern. Listing 18-7 splits the values in a tuple
+as we pass it to a function.
Listing 18-7: A function with parameters that destructure
+a tuple
+
This code prints Current location: (3, 5). The values &(3, 5) match the
+pattern &(x, y), so x is the value 3 and y is the value 5.
+
We can also use patterns in closure parameter lists in the same way as in
+function parameter lists, because closures are similar to functions, as
+discussed in Chapter 13.
+
At this point, you’ve seen several ways of using patterns, but patterns don’t
+work the same in every place we can use them. In some places, the patterns must
+be irrefutable; in other circumstances, they can be refutable. We’ll discuss
+these two concepts next.
Patterns come in two forms: refutable and irrefutable. Patterns that will match
+for any possible value passed are irrefutable. An example would be x in the
+statement let x = 5; because x matches anything and therefore cannot fail
+to match. Patterns that can fail to match for some possible value are
+refutable. An example would be Some(x) in the expression if let Some(x) = a_value because if the value in the a_value variable is None rather than
+Some, the Some(x) pattern will not match.
+
Function parameters, let statements, and for loops can only accept
+irrefutable patterns, because the program cannot do anything meaningful when
+values don’t match. The if let and while let expressions accept
+refutable and irrefutable patterns, but the compiler warns against
+irrefutable patterns because by definition they’re intended to handle possible
+failure: the functionality of a conditional is in its ability to perform
+differently depending on success or failure.
+
In general, you shouldn’t have to worry about the distinction between refutable
+and irrefutable patterns; however, you do need to be familiar with the concept
+of refutability so you can respond when you see it in an error message. In
+those cases, you’ll need to change either the pattern or the construct you’re
+using the pattern with, depending on the intended behavior of the code.
+
Let’s look at an example of what happens when we try to use a refutable pattern
+where Rust requires an irrefutable pattern and vice versa. Listing 18-8 shows a
+let statement, but for the pattern we’ve specified Some(x), a refutable
+pattern. As you might expect, this code will not compile.
+
fn main() {
+ let some_option_value: Option<i32> = None;
+ let Some(x) = some_option_value;
+}
+
Listing 18-8: Attempting to use a refutable pattern with
+let
+
If some_option_value was a None value, it would fail to match the pattern
+Some(x), meaning the pattern is refutable. However, the let statement can
+only accept an irrefutable pattern because there is nothing valid the code can
+do with a None value. At compile time, Rust will complain that we’ve tried to
+use a refutable pattern where an irrefutable pattern is required:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+error[E0005]: refutable pattern in local binding
+ --> src/main.rs:3:9
+ |
+3 | let Some(x) = some_option_value;
+ | ^^^^^^^ pattern `None` not covered
+ |
+ = note: `let` bindings require an "irrefutable pattern", like a `struct` or an `enum` with only one variant
+ = note: for more information, visit https://doc.rust-lang.org/book/ch18-02-refutability.html
+ = note: the matched value is of type `Option<i32>`
+help: you might want to use `let else` to handle the variant that isn't matched
+ |
+3 | let Some(x) = some_option_value else { todo!() };
+ | ++++++++++++++++
+
+For more information about this error, try `rustc --explain E0005`.
+error: could not compile `patterns` (bin "patterns") due to 1 previous error
+
+
Because we didn’t cover (and couldn’t cover!) every valid value with the
+pattern Some(x), Rust rightfully produces a compiler error.
+
If we have a refutable pattern where an irrefutable pattern is needed, we can
+fix it by changing the code that uses the pattern: instead of using let, we
+can use if let. Then if the pattern doesn’t match, the code will just skip
+the code in the curly brackets, giving it a way to continue validly. Listing
+18-9 shows how to fix the code in Listing 18-8.
+
fn main() {
+ let some_option_value: Option<i32> = None;
+ if let Some(x) = some_option_value {
+ println!("{x}");
+ }
+}
+
Listing 18-9: Using if let and a block with refutable
+patterns instead of let
+
We’ve given the code an out! This code is perfectly valid now. However,
+if we give if let an irrefutable pattern (a pattern that will always
+match), such as x, as shown in Listing 18-10, the compiler will give a
+warning.
+
fn main() {
+ if let x = 5 {
+ println!("{x}");
+ };
+}
+
Listing 18-10: Attempting to use an irrefutable pattern
+with if let
+
Rust complains that it doesn’t make sense to use if let with an irrefutable
+pattern:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+warning: irrefutable `if let` pattern
+ --> src/main.rs:2:8
+ |
+2 | if let x = 5 {
+ | ^^^^^^^^^
+ |
+ = note: this pattern will always match, so the `if let` is useless
+ = help: consider replacing the `if let` with a `let`
+ = note: `#[warn(irrefutable_let_patterns)]` on by default
+
+warning: `patterns` (bin "patterns") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.39s
+ Running `target/debug/patterns`
+5
+
+
For this reason, match arms must use refutable patterns, except for the last
+arm, which should match any remaining values with an irrefutable pattern. Rust
+allows us to use an irrefutable pattern in a match with only one arm, but
+this syntax isn’t particularly useful and could be replaced with a simpler
+let statement.
+
Now that you know where to use patterns and the difference between refutable
+and irrefutable patterns, let’s cover all the syntax we can use to create
+patterns.
As you saw in Chapter 6, you can match patterns against literals directly. The
+following code gives some examples:
+
fn main() {
+ let x = 1;
+
+ match x {
+ 1 => println!("one"),
+ 2 => println!("two"),
+ 3 => println!("three"),
+ _ => println!("anything"),
+ }
+}
+
This code prints one because the value in x is 1. This syntax is useful
+when you want your code to take an action if it gets a particular concrete
+value.
Named variables are irrefutable patterns that match any value, and we’ve used
+them many times in the book. However, there is a complication when you use
+named variables in match expressions. Because match starts a new scope,
+variables declared as part of a pattern inside the match expression will
+shadow those with the same name outside the match construct, as is the case
+with all variables. In Listing 18-11, we declare a variable named x with the
+value Some(5) and a variable y with the value 10. We then create a
+match expression on the value x. Look at the patterns in the match arms and
+println! at the end, and try to figure out what the code will print before
+running this code or reading further.
+
Filename: src/main.rs
+
fn main() {
+ let x = Some(5);
+ let y = 10;
+
+ match x {
+ Some(50) => println!("Got 50"),
+ Some(y) => println!("Matched, y = {y}"),
+ _ => println!("Default case, x = {x:?}"),
+ }
+
+ println!("at the end: x = {x:?}, y = {y}");
+}
+
Listing 18-11: A match expression with an arm that
+introduces a shadowed variable y
+
Let’s walk through what happens when the match expression runs. The pattern
+in the first match arm doesn’t match the defined value of x, so the code
+continues.
+
The pattern in the second match arm introduces a new variable named y that
+will match any value inside a Some value. Because we’re in a new scope inside
+the match expression, this is a new y variable, not the y we declared at
+the beginning with the value 10. This new y binding will match any value
+inside a Some, which is what we have in x. Therefore, this new y binds to
+the inner value of the Some in x. That value is 5, so the expression for
+that arm executes and prints Matched, y = 5.
+
If x had been a None value instead of Some(5), the patterns in the first
+two arms wouldn’t have matched, so the value would have matched to the
+underscore. We didn’t introduce the x variable in the pattern of the
+underscore arm, so the x in the expression is still the outer x that hasn’t
+been shadowed. In this hypothetical case, the match would print Default case, x = None.
+
When the match expression is done, its scope ends, and so does the scope of
+the inner y. The last println! produces at the end: x = Some(5), y = 10.
+
To create a match expression that compares the values of the outer x and
+y, rather than introducing a shadowed variable, we would need to use a match
+guard conditional instead. We’ll talk about match guards later in the “Extra
+Conditionals with Match Guards” section.
In match expressions, you can match multiple patterns using the | syntax,
+which is the pattern or operator. For example, in the following code we match
+the value of x against the match arms, the first of which has an or option,
+meaning if the value of x matches either of the values in that arm, that
+arm’s code will run:
+
fn main() {
+ let x = 1;
+
+ match x {
+ 1 | 2 => println!("one or two"),
+ 3 => println!("three"),
+ _ => println!("anything"),
+ }
+}
The ..= syntax allows us to match to an inclusive range of values. In the
+following code, when a pattern matches any of the values within the given
+range, that arm will execute:
+
fn main() {
+ let x = 5;
+
+ match x {
+ 1..=5 => println!("one through five"),
+ _ => println!("something else"),
+ }
+}
+
If x is 1, 2, 3, 4, or 5, the first arm will match. This syntax is more
+convenient for multiple match values than using the | operator to express the
+same idea; if we were to use | we would have to specify 1 | 2 | 3 | 4 | 5.
+Specifying a range is much shorter, especially if we want to match, say, any
+number between 1 and 1,000!
+
The compiler checks that the range isn’t empty at compile time, and because the
+only types for which Rust can tell if a range is empty or not are char and
+numeric values, ranges are only allowed with numeric or char values.
+
Here is an example using ranges of char values:
+
fn main() {
+ let x = 'c';
+
+ match x {
+ 'a'..='j' => println!("early ASCII letter"),
+ 'k'..='z' => println!("late ASCII letter"),
+ _ => println!("something else"),
+ }
+}
+
Rust can tell that 'c' is within the first pattern’s range and prints early ASCII letter.
Listing 18-12 shows a Point struct with two fields, x and y, that we can
+break apart using a pattern with a let statement.
+
Filename: src/main.rs
+
struct Point {
+ x: i32,
+ y: i32,
+}
+
+fn main() {
+ let p = Point { x: 0, y: 7 };
+
+ let Point { x: a, y: b } = p;
+ assert_eq!(0, a);
+ assert_eq!(7, b);
+}
+
Listing 18-12: Destructuring a struct’s fields into
+separate variables
+
This code creates the variables a and b that match the values of the x
+and y fields of the p struct. This example shows that the names of the
+variables in the pattern don’t have to match the field names of the struct.
+However, it’s common to match the variable names to the field names to make it
+easier to remember which variables came from which fields. Because of this
+common usage, and because writing let Point { x: x, y: y } = p; contains a
+lot of duplication, Rust has a shorthand for patterns that match struct fields:
+you only need to list the name of the struct field, and the variables created
+from the pattern will have the same names. Listing 18-13 behaves in the same
+way as the code in Listing 18-12, but the variables created in the let
+pattern are x and y instead of a and b.
+
Filename: src/main.rs
+
struct Point {
+ x: i32,
+ y: i32,
+}
+
+fn main() {
+ let p = Point { x: 0, y: 7 };
+
+ let Point { x, y } = p;
+ assert_eq!(0, x);
+ assert_eq!(7, y);
+}
+
Listing 18-13: Destructuring struct fields using struct
+field shorthand
+
This code creates the variables x and y that match the x and y fields
+of the p variable. The outcome is that the variables x and y contain the
+values from the p struct.
+
We can also destructure with literal values as part of the struct pattern
+rather than creating variables for all the fields. Doing so allows us to test
+some of the fields for particular values while creating variables to
+destructure the other fields.
+
In Listing 18-14, we have a match expression that separates Point values
+into three cases: points that lie directly on the x axis (which is true when
+y = 0), on the y axis (x = 0), or neither.
+
Filename: src/main.rs
+
struct Point {
+ x: i32,
+ y: i32,
+}
+
+fn main() {
+ let p = Point { x: 0, y: 7 };
+
+ match p {
+ Point { x, y: 0 } => println!("On the x axis at {x}"),
+ Point { x: 0, y } => println!("On the y axis at {y}"),
+ Point { x, y } => {
+ println!("On neither axis: ({x}, {y})");
+ }
+ }
+}
+
Listing 18-14: Destructuring and matching literal values
+in one pattern
+
The first arm will match any point that lies on the x axis by specifying that
+the y field matches if its value matches the literal 0. The pattern still
+creates an x variable that we can use in the code for this arm.
+
Similarly, the second arm matches any point on the y axis by specifying that
+the x field matches if its value is 0 and creates a variable y for the
+value of the y field. The third arm doesn’t specify any literals, so it
+matches any other Point and creates variables for both the x and y fields.
+
In this example, the value p matches the second arm by virtue of x
+containing a 0, so this code will print On the y axis at 7.
+
Remember that a match expression stops checking arms once it has found the
+first matching pattern, so even though Point { x: 0, y: 0} is on the x axis
+and the y axis, this code would only print On the x axis at 0.
We’ve destructured enums in this book (for example, Listing 6-5 in Chapter 6),
+but haven’t yet explicitly discussed that the pattern to destructure an enum
+corresponds to the way the data stored within the enum is defined. As an
+example, in Listing 18-15 we use the Message enum from Listing 6-2 and write
+a match with patterns that will destructure each inner value.
+
Filename: src/main.rs
+
enum Message {
+ Quit,
+ Move { x: i32, y: i32 },
+ Write(String),
+ ChangeColor(i32, i32, i32),
+}
+
+fn main() {
+ let msg = Message::ChangeColor(0, 160, 255);
+
+ match msg {
+ Message::Quit => {
+ println!("The Quit variant has no data to destructure.");
+ }
+ Message::Move { x, y } => {
+ println!("Move in the x direction {x} and in the y direction {y}");
+ }
+ Message::Write(text) => {
+ println!("Text message: {text}");
+ }
+ Message::ChangeColor(r, g, b) => {
+ println!("Change the color to red {r}, green {g}, and blue {b}")
+ }
+ }
+}
+
Listing 18-15: Destructuring enum variants that hold
+different kinds of values
+
This code will print Change the color to red 0, green 160, and blue 255. Try
+changing the value of msg to see the code from the other arms run.
+
For enum variants without any data, like Message::Quit, we can’t destructure
+the value any further. We can only match on the literal Message::Quit value,
+and no variables are in that pattern.
+
For struct-like enum variants, such as Message::Move, we can use a pattern
+similar to the pattern we specify to match structs. After the variant name, we
+place curly brackets and then list the fields with variables so we break apart
+the pieces to use in the code for this arm. Here we use the shorthand form as
+we did in Listing 18-13.
+
For tuple-like enum variants, like Message::Write that holds a tuple with one
+element and Message::ChangeColor that holds a tuple with three elements, the
+pattern is similar to the pattern we specify to match tuples. The number of
+variables in the pattern must match the number of elements in the variant we’re
+matching.
So far, our examples have all been matching structs or enums one level deep,
+but matching can work on nested items too! For example, we can refactor the
+code in Listing 18-15 to support RGB and HSV colors in the ChangeColor
+message, as shown in Listing 18-16.
+
enum Color {
+ Rgb(i32, i32, i32),
+ Hsv(i32, i32, i32),
+}
+
+enum Message {
+ Quit,
+ Move { x: i32, y: i32 },
+ Write(String),
+ ChangeColor(Color),
+}
+
+fn main() {
+ let msg = Message::ChangeColor(Color::Hsv(0, 160, 255));
+
+ match msg {
+ Message::ChangeColor(Color::Rgb(r, g, b)) => {
+ println!("Change color to red {r}, green {g}, and blue {b}");
+ }
+ Message::ChangeColor(Color::Hsv(h, s, v)) => {
+ println!("Change color to hue {h}, saturation {s}, value {v}")
+ }
+ _ => (),
+ }
+}
+
Listing 18-16: Matching on nested enums
+
The pattern of the first arm in the match expression matches a
+Message::ChangeColor enum variant that contains a Color::Rgb variant; then
+the pattern binds to the three inner i32 values. The pattern of the second
+arm also matches a Message::ChangeColor enum variant, but the inner enum
+matches Color::Hsv instead. We can specify these complex conditions in one
+match expression, even though two enums are involved.
We can mix, match, and nest destructuring patterns in even more complex ways.
+The following example shows a complicated destructure where we nest structs and
+tuples inside a tuple and destructure all the primitive values out:
+
fn main() {
+ struct Point {
+ x: i32,
+ y: i32,
+ }
+
+ let ((feet, inches), Point { x, y }) = ((3, 10), Point { x: 3, y: -10 });
+}
+
This code lets us break complex types into their component parts so we can use
+the values we’re interested in separately.
+
Destructuring with patterns is a convenient way to use pieces of values, such
+as the value from each field in a struct, separately from each other.
You’ve seen that it’s sometimes useful to ignore values in a pattern, such as
+in the last arm of a match, to get a catchall that doesn’t actually do
+anything but does account for all remaining possible values. There are a few
+ways to ignore entire values or parts of values in a pattern: using the _
+pattern (which you’ve seen), using the _ pattern within another pattern,
+using a name that starts with an underscore, or using .. to ignore remaining
+parts of a value. Let’s explore how and why to use each of these patterns.
We’ve used the underscore as a wildcard pattern that will match any value but
+not bind to the value. This is especially useful as the last arm in a match
+expression, but we can also use it in any pattern, including function
+parameters, as shown in Listing 18-17.
+
Filename: src/main.rs
+
fn foo(_: i32, y: i32) {
+ println!("This code only uses the y parameter: {y}");
+}
+
+fn main() {
+ foo(3, 4);
+}
+
Listing 18-17: Using _ in a function signature
+
This code will completely ignore the value 3 passed as the first argument,
+and will print This code only uses the y parameter: 4.
+
In most cases when you no longer need a particular function parameter, you
+would change the signature so it doesn’t include the unused parameter. Ignoring
+a function parameter can be especially useful in cases when, for example,
+you’re implementing a trait when you need a certain type signature but the
+function body in your implementation doesn’t need one of the parameters. You
+then avoid getting a compiler warning about unused function parameters, as you
+would if you used a name instead.
We can also use _ inside another pattern to ignore just part of a value, for
+example, when we want to test for only part of a value but have no use for the
+other parts in the corresponding code we want to run. Listing 18-18 shows code
+responsible for managing a setting’s value. The business requirements are that
+the user should not be allowed to overwrite an existing customization of a
+setting but can unset the setting and give it a value if it is currently unset.
Listing 18-18: Using an underscore within patterns that
+match Some variants when we don’t need to use the value inside the
+Some
+
This code will print Can't overwrite an existing customized value and then
+setting is Some(5). In the first match arm, we don’t need to match on or use
+the values inside either Some variant, but we do need to test for the case
+when setting_value and new_setting_value are the Some variant. In that
+case, we print the reason for not changing setting_value, and it doesn’t get
+changed.
+
In all other cases (if either setting_value or new_setting_value are
+None) expressed by the _ pattern in the second arm, we want to allow
+new_setting_value to become setting_value.
+
We can also use underscores in multiple places within one pattern to ignore
+particular values. Listing 18-19 shows an example of ignoring the second and
+fourth values in a tuple of five items.
If you create a variable but don’t use it anywhere, Rust will usually issue a
+warning because an unused variable could be a bug. However, sometimes it’s
+useful to be able to create a variable you won’t use yet, such as when you’re
+prototyping or just starting a project. In this situation, you can tell Rust
+not to warn you about the unused variable by starting the name of the variable
+with an underscore. In Listing 18-20, we create two unused variables, but when
+we compile this code, we should only get a warning about one of them.
+
Filename: src/main.rs
+
fn main() {
+ let _x = 5;
+ let y = 10;
+}
+
Listing 18-20: Starting a variable name with an
+underscore to avoid getting unused variable warnings
+
Here we get a warning about not using the variable y, but we don’t get a
+warning about not using _x.
+
Note that there is a subtle difference between using only _ and using a name
+that starts with an underscore. The syntax _x still binds the value to the
+variable, whereas _ doesn’t bind at all. To show a case where this
+distinction matters, Listing 18-21 will provide us with an error.
+
fn main() {
+ let s = Some(String::from("Hello!"));
+
+ if let Some(_s) = s {
+ println!("found a string");
+ }
+
+ println!("{s:?}");
+}
+
Listing 18-21: An unused variable starting with an
+underscore still binds the value, which might take ownership of the value
+
We’ll receive an error because the s value will still be moved into _s,
+which prevents us from using s again. However, using the underscore by itself
+doesn’t ever bind to the value. Listing 18-22 will compile without any errors
+because s doesn’t get moved into _.
+
fn main() {
+ let s = Some(String::from("Hello!"));
+
+ if let Some(_) = s {
+ println!("found a string");
+ }
+
+ println!("{s:?}");
+}
+
Listing 18-22: Using an underscore does not bind the
+value
+
This code works just fine because we never bind s to anything; it isn’t moved.
With values that have many parts, we can use the .. syntax to use specific
+parts and ignore the rest, avoiding the need to list underscores for each
+ignored value. The .. pattern ignores any parts of a value that we haven’t
+explicitly matched in the rest of the pattern. In Listing 18-23, we have a
+Point struct that holds a coordinate in three-dimensional space. In the
+match expression, we want to operate only on the x coordinate and ignore
+the values in the y and z fields.
+
fn main() {
+ struct Point {
+ x: i32,
+ y: i32,
+ z: i32,
+ }
+
+ let origin = Point { x: 0, y: 0, z: 0 };
+
+ match origin {
+ Point { x, .. } => println!("x is {x}"),
+ }
+}
+
Listing 18-23: Ignoring all fields of a Point except
+for x by using ..
+
We list the x value and then just include the .. pattern. This is quicker
+than having to list y: _ and z: _, particularly when we’re working with
+structs that have lots of fields in situations where only one or two fields are
+relevant.
+
The syntax .. will expand to as many values as it needs to be. Listing 18-24
+shows how to use .. with a tuple.
Listing 18-24: Matching only the first and last values in
+a tuple and ignoring all other values
+
In this code, the first and last value are matched with first and last. The
+.. will match and ignore everything in the middle.
+
However, using .. must be unambiguous. If it is unclear which values are
+intended for matching and which should be ignored, Rust will give us an error.
+Listing 18-25 shows an example of using .. ambiguously, so it will not
+compile.
Listing 18-25: An attempt to use .. in an ambiguous
+way
+
When we compile this example, we get this error:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+error: `..` can only be used once per tuple pattern
+ --> src/main.rs:5:22
+ |
+5 | (.., second, ..) => {
+ | -- ^^ can only be used once per tuple pattern
+ | |
+ | previously used here
+
+error: could not compile `patterns` (bin "patterns") due to 1 previous error
+
+
It’s impossible for Rust to determine how many values in the tuple to ignore
+before matching a value with second and then how many further values to
+ignore thereafter. This code could mean that we want to ignore 2, bind
+second to 4, and then ignore 8, 16, and 32; or that we want to ignore
+2 and 4, bind second to 8, and then ignore 16 and 32; and so forth.
+The variable name second doesn’t mean anything special to Rust, so we get a
+compiler error because using .. in two places like this is ambiguous.
A match guard is an additional if condition, specified after the pattern in
+a match arm, that must also match for that arm to be chosen. Match guards are
+useful for expressing more complex ideas than a pattern alone allows.
+
The condition can use variables created in the pattern. Listing 18-26 shows a
+match where the first arm has the pattern Some(x) and also has a match
+guard of if x % 2 == 0 (which will be true if the number is even).
+
fn main() {
+ let num = Some(4);
+
+ match num {
+ Some(x) if x % 2 == 0 => println!("The number {x} is even"),
+ Some(x) => println!("The number {x} is odd"),
+ None => (),
+ }
+}
+
Listing 18-26: Adding a match guard to a pattern
+
This example will print The number 4 is even. When num is compared to the
+pattern in the first arm, it matches, because Some(4) matches Some(x). Then
+the match guard checks whether the remainder of dividing x by 2 is equal to
+0, and because it is, the first arm is selected.
+
If num had been Some(5) instead, the match guard in the first arm would
+have been false because the remainder of 5 divided by 2 is 1, which is not
+equal to 0. Rust would then go to the second arm, which would match because the
+second arm doesn’t have a match guard and therefore matches any Some variant.
+
There is no way to express the if x % 2 == 0 condition within a pattern, so
+the match guard gives us the ability to express this logic. The downside of
+this additional expressiveness is that the compiler doesn’t try to check for
+exhaustiveness when match guard expressions are involved.
+
In Listing 18-11, we mentioned that we could use match guards to solve our
+pattern-shadowing problem. Recall that we created a new variable inside the
+pattern in the match expression instead of using the variable outside the
+match. That new variable meant we couldn’t test against the value of the
+outer variable. Listing 18-27 shows how we can use a match guard to fix this
+problem.
+
Filename: src/main.rs
+
fn main() {
+ let x = Some(5);
+ let y = 10;
+
+ match x {
+ Some(50) => println!("Got 50"),
+ Some(n) if n == y => println!("Matched, n = {n}"),
+ _ => println!("Default case, x = {x:?}"),
+ }
+
+ println!("at the end: x = {x:?}, y = {y}");
+}
+
Listing 18-27: Using a match guard to test for equality
+with an outer variable
+
This code will now print Default case, x = Some(5). The pattern in the second
+match arm doesn’t introduce a new variable y that would shadow the outer y,
+meaning we can use the outer y in the match guard. Instead of specifying the
+pattern as Some(y), which would have shadowed the outer y, we specify
+Some(n). This creates a new variable n that doesn’t shadow anything because
+there is no n variable outside the match.
+
The match guard if n == y is not a pattern and therefore doesn’t introduce
+new variables. This yis the outer y rather than a new shadowed y, and
+we can look for a value that has the same value as the outer y by comparing
+n to y.
+
You can also use the or operator | in a match guard to specify multiple
+patterns; the match guard condition will apply to all the patterns. Listing
+18-28 shows the precedence when combining a pattern that uses | with a match
+guard. The important part of this example is that the if y match guard
+applies to 4, 5, and6, even though it might look like if y only
+applies to 6.
+
fn main() {
+ let x = 4;
+ let y = false;
+
+ match x {
+ 4 | 5 | 6 if y => println!("yes"),
+ _ => println!("no"),
+ }
+}
+
Listing 18-28: Combining multiple patterns with a match
+guard
+
The match condition states that the arm only matches if the value of x is
+equal to 4, 5, or 6and if y is true. When this code runs, the
+pattern of the first arm matches because x is 4, but the match guard if y
+is false, so the first arm is not chosen. The code moves on to the second arm,
+which does match, and this program prints no. The reason is that the if
+condition applies to the whole pattern 4 | 5 | 6, not only to the last value
+6. In other words, the precedence of a match guard in relation to a pattern
+behaves like this:
+
(4 | 5 | 6) if y => ...
+
+
rather than this:
+
4 | 5 | (6 if y) => ...
+
+
After running the code, the precedence behavior is evident: if the match guard
+were applied only to the final value in the list of values specified using the
+| operator, the arm would have matched and the program would have printed
+yes.
The at operator @ lets us create a variable that holds a value at the same
+time as we’re testing that value for a pattern match. In Listing 18-29, we want
+to test that a Message::Helloid field is within the range 3..=7. We also
+want to bind the value to the variable id_variable so we can use it in the
+code associated with the arm. We could name this variable id, the same as the
+field, but for this example we’ll use a different name.
+
fn main() {
+ enum Message {
+ Hello { id: i32 },
+ }
+
+ let msg = Message::Hello { id: 5 };
+
+ match msg {
+ Message::Hello {
+ id: id_variable @ 3..=7,
+ } => println!("Found an id in range: {id_variable}"),
+ Message::Hello { id: 10..=12 } => {
+ println!("Found an id in another range")
+ }
+ Message::Hello { id } => println!("Found some other id: {id}"),
+ }
+}
+
Listing 18-29: Using @ to bind to a value in a pattern
+while also testing it
+
This example will print Found an id in range: 5. By specifying id_variable @ before the range 3..=7, we’re capturing whatever value matched the range
+while also testing that the value matched the range pattern.
+
In the second arm, where we only have a range specified in the pattern, the code
+associated with the arm doesn’t have a variable that contains the actual value
+of the id field. The id field’s value could have been 10, 11, or 12, but
+the code that goes with that pattern doesn’t know which it is. The pattern code
+isn’t able to use the value from the id field, because we haven’t saved the
+id value in a variable.
+
In the last arm, where we’ve specified a variable without a range, we do have
+the value available to use in the arm’s code in a variable named id. The
+reason is that we’ve used the struct field shorthand syntax. But we haven’t
+applied any test to the value in the id field in this arm, as we did with the
+first two arms: any value would match this pattern.
+
Using @ lets us test a value and save it in a variable within one pattern.
Rust’s patterns are very useful in distinguishing between different kinds of
+data. When used in match expressions, Rust ensures your patterns cover every
+possible value, or your program won’t compile. Patterns in let statements and
+function parameters make those constructs more useful, enabling the
+destructuring of values into smaller parts at the same time as assigning to
+variables. We can create simple or complex patterns to suit our needs.
+
Next, for the penultimate chapter of the book, we’ll look at some advanced
+aspects of a variety of Rust’s features.
By now, you’ve learned the most commonly used parts of the Rust programming
+language. Before we do one more project in Chapter 20, we’ll look at a few
+aspects of the language you might run into every once in a while, but may not
+use every day. You can use this chapter as a reference for when you encounter
+any unknowns. The features covered here are useful in very specific situations.
+Although you might not reach for them often, we want to make sure you have a
+grasp of all the features Rust has to offer.
+
In this chapter, we’ll cover:
+
+
Unsafe Rust: how to opt out of some of Rust’s guarantees and take
+responsibility for manually upholding those guarantees
+
Advanced traits: associated types, default type parameters, fully qualified
+syntax, supertraits, and the newtype pattern in relation to traits
+
Advanced types: more about the newtype pattern, type aliases, the never type,
+and dynamically sized types
+
Advanced functions and closures: function pointers and returning closures
+
Macros: ways to define code that defines more code at compile time
+
+
It’s a panoply of Rust features with something for everyone! Let’s dive in!
All the code we’ve discussed so far has had Rust’s memory safety guarantees
+enforced at compile time. However, Rust has a second language hidden inside it
+that doesn’t enforce these memory safety guarantees: it’s called unsafe Rust
+and works just like regular Rust, but gives us extra superpowers.
+
Unsafe Rust exists because, by nature, static analysis is conservative. When
+the compiler tries to determine whether or not code upholds the guarantees,
+it’s better for it to reject some valid programs than to accept some invalid
+programs. Although the code might be okay, if the Rust compiler doesn’t have
+enough information to be confident, it will reject the code. In these cases,
+you can use unsafe code to tell the compiler, “Trust me, I know what I’m
+doing.” Be warned, however, that you use unsafe Rust at your own risk: if you
+use unsafe code incorrectly, problems can occur due to memory unsafety, such as
+null pointer dereferencing.
+
Another reason Rust has an unsafe alter ego is that the underlying computer
+hardware is inherently unsafe. If Rust didn’t let you do unsafe operations, you
+couldn’t do certain tasks. Rust needs to allow you to do low-level systems
+programming, such as directly interacting with the operating system or even
+writing your own operating system. Working with low-level systems programming
+is one of the goals of the language. Let’s explore what we can do with unsafe
+Rust and how to do it.
To switch to unsafe Rust, use the unsafe keyword and then start a new block
+that holds the unsafe code. You can take five actions in unsafe Rust that you
+can’t in safe Rust, which we call unsafe superpowers. Those superpowers
+include the ability to:
+
+
Dereference a raw pointer
+
Call an unsafe function or method
+
Access or modify a mutable static variable
+
Implement an unsafe trait
+
Access fields of a union
+
+
It’s important to understand that unsafe doesn’t turn off the borrow checker
+or disable any other of Rust’s safety checks: if you use a reference in unsafe
+code, it will still be checked. The unsafe keyword only gives you access to
+these five features that are then not checked by the compiler for memory
+safety. You’ll still get some degree of safety inside of an unsafe block.
+
In addition, unsafe does not mean the code inside the block is necessarily
+dangerous or that it will definitely have memory safety problems: the intent is
+that as the programmer, you’ll ensure the code inside an unsafe block will
+access memory in a valid way.
+
People are fallible, and mistakes will happen, but by requiring these five
+unsafe operations to be inside blocks annotated with unsafe you’ll know that
+any errors related to memory safety must be within an unsafe block. Keep
+unsafe blocks small; you’ll be thankful later when you investigate memory
+bugs.
+
To isolate unsafe code as much as possible, it’s best to enclose unsafe code
+within a safe abstraction and provide a safe API, which we’ll discuss later in
+the chapter when we examine unsafe functions and methods. Parts of the standard
+library are implemented as safe abstractions over unsafe code that has been
+audited. Wrapping unsafe code in a safe abstraction prevents uses of unsafe
+from leaking out into all the places that you or your users might want to use
+the functionality implemented with unsafe code, because using a safe
+abstraction is safe.
+
Let’s look at each of the five unsafe superpowers in turn. We’ll also look at
+some abstractions that provide a safe interface to unsafe code.
In Chapter 4, in the “Dangling References” section, we mentioned that the compiler ensures references are always
+valid. Unsafe Rust has two new types called raw pointers that are similar to
+references. As with references, raw pointers can be immutable or mutable and
+are written as *const T and *mut T, respectively. The asterisk isn’t the
+dereference operator; it’s part of the type name. In the context of raw
+pointers, immutable means that the pointer can’t be directly assigned to
+after being dereferenced.
+
Different from references and smart pointers, raw pointers:
+
+
Are allowed to ignore the borrowing rules by having both immutable and
+mutable pointers or multiple mutable pointers to the same location
+
Aren’t guaranteed to point to valid memory
+
Are allowed to be null
+
Don’t implement any automatic cleanup
+
+
By opting out of having Rust enforce these guarantees, you can give up
+guaranteed safety in exchange for greater performance or the ability to
+interface with another language or hardware where Rust’s guarantees don’t apply.
+
Listing 19-1 shows how to create an immutable and a mutable raw pointer from
+references.
+
fn main() {
+ let mut num = 5;
+
+ let r1 = &num as *const i32;
+ let r2 = &mut num as *mut i32;
+}
+
Listing 19-1: Creating raw pointers from references
+
Notice that we don’t include the unsafe keyword in this code. We can create
+raw pointers in safe code; we just can’t dereference raw pointers outside an
+unsafe block, as you’ll see in a bit.
+
We’ve created raw pointers by using as to cast an immutable and a mutable
+reference into their corresponding raw pointer types. Because we created them
+directly from references guaranteed to be valid, we know these particular raw
+pointers are valid, but we can’t make that assumption about just any raw
+pointer.
+
To demonstrate this, next we’ll create a raw pointer whose validity we can’t be
+so certain of. Listing 19-2 shows how to create a raw pointer to an arbitrary
+location in memory. Trying to use arbitrary memory is undefined: there might be
+data at that address or there might not, the compiler might optimize the code
+so there is no memory access, or the program might error with a segmentation
+fault. Usually, there is no good reason to write code like this, but it is
+possible.
+
fn main() {
+ let address = 0x012345usize;
+ let r = address as *const i32;
+}
+
Listing 19-2: Creating a raw pointer to an arbitrary
+memory address
+
Recall that we can create raw pointers in safe code, but we can’t dereference
+raw pointers and read the data being pointed to. In Listing 19-3, we use the
+dereference operator * on a raw pointer that requires an unsafe block.
+
fn main() {
+ let mut num = 5;
+
+ let r1 = &num as *const i32;
+ let r2 = &mut num as *mut i32;
+
+ unsafe {
+ println!("r1 is: {}", *r1);
+ println!("r2 is: {}", *r2);
+ }
+}
+
Listing 19-3: Dereferencing raw pointers within an
+unsafe block
+
Creating a pointer does no harm; it’s only when we try to access the value that
+it points at that we might end up dealing with an invalid value.
+
Note also that in Listing 19-1 and 19-3, we created *const i32 and *mut i32
+raw pointers that both pointed to the same memory location, where num is
+stored. If we instead tried to create an immutable and a mutable reference to
+num, the code would not have compiled because Rust’s ownership rules don’t
+allow a mutable reference at the same time as any immutable references. With
+raw pointers, we can create a mutable pointer and an immutable pointer to the
+same location and change data through the mutable pointer, potentially creating
+a data race. Be careful!
+
With all of these dangers, why would you ever use raw pointers? One major use
+case is when interfacing with C code, as you’ll see in the next section,
+“Calling an Unsafe Function or
+Method.” Another case is
+when building up safe abstractions that the borrow checker doesn’t understand.
+We’ll introduce unsafe functions and then look at an example of a safe
+abstraction that uses unsafe code.
The second type of operation you can perform in an unsafe block is calling
+unsafe functions. Unsafe functions and methods look exactly like regular
+functions and methods, but they have an extra unsafe before the rest of the
+definition. The unsafe keyword in this context indicates the function has
+requirements we need to uphold when we call this function, because Rust can’t
+guarantee we’ve met these requirements. By calling an unsafe function within an
+unsafe block, we’re saying that we’ve read this function’s documentation and
+take responsibility for upholding the function’s contracts.
+
Here is an unsafe function named dangerous that doesn’t do anything in its
+body:
We must call the dangerous function within a separate unsafe block. If we
+try to call dangerous without the unsafe block, we’ll get an error:
+
$ cargo run
+ Compiling unsafe-example v0.1.0 (file:///projects/unsafe-example)
+error[E0133]: call to unsafe function `dangerous` is unsafe and requires unsafe function or block
+ --> src/main.rs:4:5
+ |
+4 | dangerous();
+ | ^^^^^^^^^^^ call to unsafe function
+ |
+ = note: consult the function's documentation for information on how to avoid undefined behavior
+
+For more information about this error, try `rustc --explain E0133`.
+error: could not compile `unsafe-example` (bin "unsafe-example") due to 1 previous error
+
+
With the unsafe block, we’re asserting to Rust that we’ve read the function’s
+documentation, we understand how to use it properly, and we’ve verified that
+we’re fulfilling the contract of the function.
+
Bodies of unsafe functions are effectively unsafe blocks, so to perform other
+unsafe operations within an unsafe function, we don’t need to add another
+unsafe block.
Just because a function contains unsafe code doesn’t mean we need to mark the
+entire function as unsafe. In fact, wrapping unsafe code in a safe function is
+a common abstraction. As an example, let’s study the split_at_mut function
+from the standard library, which requires some unsafe code. We’ll explore how
+we might implement it. This safe method is defined on mutable slices: it takes
+one slice and makes it two by splitting the slice at the index given as an
+argument. Listing 19-4 shows how to use split_at_mut.
+
fn main() {
+ let mut v = vec![1, 2, 3, 4, 5, 6];
+
+ let r = &mut v[..];
+
+ let (a, b) = r.split_at_mut(3);
+
+ assert_eq!(a, &mut [1, 2, 3]);
+ assert_eq!(b, &mut [4, 5, 6]);
+}
+
Listing 19-4: Using the safe split_at_mut
+function
+
We can’t implement this function using only safe Rust. An attempt might look
+something like Listing 19-5, which won’t compile. For simplicity, we’ll
+implement split_at_mut as a function rather than a method and only for slices
+of i32 values rather than for a generic type T.
Listing 19-5: An attempted implementation of
+split_at_mut using only safe Rust
+
This function first gets the total length of the slice. Then it asserts that
+the index given as a parameter is within the slice by checking whether it’s
+less than or equal to the length. The assertion means that if we pass an index
+that is greater than the length to split the slice at, the function will panic
+before it attempts to use that index.
+
Then we return two mutable slices in a tuple: one from the start of the
+original slice to the mid index and another from mid to the end of the
+slice.
+
When we try to compile the code in Listing 19-5, we’ll get an error.
+
$ cargo run
+ Compiling unsafe-example v0.1.0 (file:///projects/unsafe-example)
+error[E0499]: cannot borrow `*values` as mutable more than once at a time
+ --> src/main.rs:6:31
+ |
+1 | fn split_at_mut(values: &mut [i32], mid: usize) -> (&mut [i32], &mut [i32]) {
+ | - let's call the lifetime of this reference `'1`
+...
+6 | (&mut values[..mid], &mut values[mid..])
+ | --------------------------^^^^^^--------
+ | | | |
+ | | | second mutable borrow occurs here
+ | | first mutable borrow occurs here
+ | returning this value requires that `*values` is borrowed for `'1`
+
+For more information about this error, try `rustc --explain E0499`.
+error: could not compile `unsafe-example` (bin "unsafe-example") due to 1 previous error
+
+
Rust’s borrow checker can’t understand that we’re borrowing different parts of
+the slice; it only knows that we’re borrowing from the same slice twice.
+Borrowing different parts of a slice is fundamentally okay because the two
+slices aren’t overlapping, but Rust isn’t smart enough to know this. When we
+know code is okay, but Rust doesn’t, it’s time to reach for unsafe code.
+
Listing 19-6 shows how to use an unsafe block, a raw pointer, and some calls
+to unsafe functions to make the implementation of split_at_mut work.
Listing 19-6: Using unsafe code in the implementation of
+the split_at_mut function
+
Recall from “The Slice Type” section in
+Chapter 4 that slices are a pointer to some data and the length of the slice.
+We use the len method to get the length of a slice and the as_mut_ptr
+method to access the raw pointer of a slice. In this case, because we have a
+mutable slice to i32 values, as_mut_ptr returns a raw pointer with the type
+*mut i32, which we’ve stored in the variable ptr.
+
We keep the assertion that the mid index is within the slice. Then we get to
+the unsafe code: the slice::from_raw_parts_mut function takes a raw pointer
+and a length, and it creates a slice. We use this function to create a slice
+that starts from ptr and is mid items long. Then we call the add
+method on ptr with mid as an argument to get a raw pointer that starts at
+mid, and we create a slice using that pointer and the remaining number of
+items after mid as the length.
+
The function slice::from_raw_parts_mut is unsafe because it takes a raw
+pointer and must trust that this pointer is valid. The add method on raw
+pointers is also unsafe, because it must trust that the offset location is also
+a valid pointer. Therefore, we had to put an unsafe block around our calls to
+slice::from_raw_parts_mut and add so we could call them. By looking at
+the code and by adding the assertion that mid must be less than or equal to
+len, we can tell that all the raw pointers used within the unsafe block
+will be valid pointers to data within the slice. This is an acceptable and
+appropriate use of unsafe.
+
Note that we don’t need to mark the resulting split_at_mut function as
+unsafe, and we can call this function from safe Rust. We’ve created a safe
+abstraction to the unsafe code with an implementation of the function that uses
+unsafe code in a safe way, because it creates only valid pointers from the
+data this function has access to.
+
In contrast, the use of slice::from_raw_parts_mut in Listing 19-7 would
+likely crash when the slice is used. This code takes an arbitrary memory
+location and creates a slice 10,000 items long.
+
fn main() {
+ use std::slice;
+
+ let address = 0x01234usize;
+ let r = address as *mut i32;
+
+ let values: &[i32] = unsafe { slice::from_raw_parts_mut(r, 10000) };
+}
+
Listing 19-7: Creating a slice from an arbitrary memory
+location
+
We don’t own the memory at this arbitrary location, and there is no guarantee
+that the slice this code creates contains valid i32 values. Attempting to use
+values as though it’s a valid slice results in undefined behavior.
Sometimes, your Rust code might need to interact with code written in another
+language. For this, Rust has the keyword extern that facilitates the creation
+and use of a Foreign Function Interface (FFI). An FFI is a way for a
+programming language to define functions and enable a different (foreign)
+programming language to call those functions.
+
Listing 19-8 demonstrates how to set up an integration with the abs function
+from the C standard library. Functions declared within extern blocks are
+always unsafe to call from Rust code. The reason is that other languages don’t
+enforce Rust’s rules and guarantees, and Rust can’t check them, so
+responsibility falls on the programmer to ensure safety.
+
Filename: src/main.rs
+
extern "C" {
+ fn abs(input: i32) -> i32;
+}
+
+fn main() {
+ unsafe {
+ println!("Absolute value of -3 according to C: {}", abs(-3));
+ }
+}
+
Listing 19-8: Declaring and calling an extern function
+defined in another language
+
Within the extern "C" block, we list the names and signatures of external
+functions from another language we want to call. The "C" part defines which
+application binary interface (ABI) the external function uses: the ABI
+defines how to call the function at the assembly level. The "C" ABI is the
+most common and follows the C programming language’s ABI.
We can also use extern to create an interface that allows other languages
+to call Rust functions. Instead of creating a whole extern block, we add
+the extern keyword and specify the ABI to use just before the fn keyword
+for the relevant function. We also need to add a #[no_mangle] annotation to
+tell the Rust compiler not to mangle the name of this function. Mangling is
+when a compiler changes the name we’ve given a function to a different name
+that contains more information for other parts of the compilation process to
+consume but is less human readable. Every programming language compiler
+mangles names slightly differently, so for a Rust function to be nameable by
+other languages, we must disable the Rust compiler’s name mangling.
+
In the following example, we make the call_from_c function accessible from
+C code, after it’s compiled to a shared library and linked from C:
+
#![allow(unused)]
+fn main() {
+#[no_mangle]
+pub extern "C" fn call_from_c() {
+ println!("Just called a Rust function from C!");
+}
+}
In this book, we’ve not yet talked about global variables, which Rust does
+support but can be problematic with Rust’s ownership rules. If two threads are
+accessing the same mutable global variable, it can cause a data race.
+
In Rust, global variables are called static variables. Listing 19-9 shows an
+example declaration and use of a static variable with a string slice as a
+value.
Listing 19-9: Defining and using an immutable static
+variable
+
Static variables are similar to constants, which we discussed in the
+“Differences Between Variables and
+Constants” section
+in Chapter 3. The names of static variables are in SCREAMING_SNAKE_CASE by
+convention. Static variables can only store references with the 'static
+lifetime, which means the Rust compiler can figure out the lifetime and we
+aren’t required to annotate it explicitly. Accessing an immutable static
+variable is safe.
+
A subtle difference between constants and immutable static variables is that
+values in a static variable have a fixed address in memory. Using the value
+will always access the same data. Constants, on the other hand, are allowed to
+duplicate their data whenever they’re used. Another difference is that static
+variables can be mutable. Accessing and modifying mutable static variables is
+unsafe. Listing 19-10 shows how to declare, access, and modify a mutable
+static variable named COUNTER.
Listing 19-10: Reading from or writing to a mutable
+static variable is unsafe
+
As with regular variables, we specify mutability using the mut keyword. Any
+code that reads or writes from COUNTER must be within an unsafe block. This
+code compiles and prints COUNTER: 3 as we would expect because it’s single
+threaded. Having multiple threads access COUNTER would likely result in data
+races.
+
With mutable data that is globally accessible, it’s difficult to ensure there
+are no data races, which is why Rust considers mutable static variables to be
+unsafe. Where possible, it’s preferable to use the concurrency techniques and
+thread-safe smart pointers we discussed in Chapter 16 so the compiler checks
+that data accessed from different threads is done safely.
We can use unsafe to implement an unsafe trait. A trait is unsafe when at
+least one of its methods has some invariant that the compiler can’t verify. We
+declare that a trait is unsafe by adding the unsafe keyword before trait
+and marking the implementation of the trait as unsafe too, as shown in
+Listing 19-11.
+
unsafe trait Foo {
+ // methods go here
+}
+
+unsafe impl Foo for i32 {
+ // method implementations go here
+}
+
+fn main() {}
+
Listing 19-11: Defining and implementing an unsafe
+trait
+
By using unsafe impl, we’re promising that we’ll uphold the invariants that
+the compiler can’t verify.
+
As an example, recall the Sync and Send marker traits we discussed in the
+“Extensible Concurrency with the Sync and Send
+Traits”
+section in Chapter 16: the compiler implements these traits automatically if
+our types are composed entirely of Send and Sync types. If we implement a
+type that contains a type that is not Send or Sync, such as raw pointers,
+and we want to mark that type as Send or Sync, we must use unsafe. Rust
+can’t verify that our type upholds the guarantees that it can be safely sent
+across threads or accessed from multiple threads; therefore, we need to do
+those checks manually and indicate as such with unsafe.
The final action that works only with unsafe is accessing fields of a
+union. A union is similar to a struct, but only one declared field is
+used in a particular instance at one time. Unions are primarily used to
+interface with unions in C code. Accessing union fields is unsafe because Rust
+can’t guarantee the type of the data currently being stored in the union
+instance. You can learn more about unions in the Rust Reference.
Using unsafe to take one of the five actions (superpowers) just discussed
+isn’t wrong or even frowned upon. But it is trickier to get unsafe code
+correct because the compiler can’t help uphold memory safety. When you have a
+reason to use unsafe code, you can do so, and having the explicit unsafe
+annotation makes it easier to track down the source of problems when they occur.
We first covered traits in the “Traits: Defining Shared
+Behavior” section of Chapter
+10, but we didn’t discuss the more advanced details. Now that you know more
+about Rust, we can get into the nitty-gritty.
Associated types connect a type placeholder with a trait such that the trait
+method definitions can use these placeholder types in their signatures. The
+implementor of a trait will specify the concrete type to be used instead of the
+placeholder type for the particular implementation. That way, we can define a
+trait that uses some types without needing to know exactly what those types are
+until the trait is implemented.
+
We’ve described most of the advanced features in this chapter as being rarely
+needed. Associated types are somewhere in the middle: they’re used more rarely
+than features explained in the rest of the book but more commonly than many of
+the other features discussed in this chapter.
+
One example of a trait with an associated type is the Iterator trait that the
+standard library provides. The associated type is named Item and stands in
+for the type of the values the type implementing the Iterator trait is
+iterating over. The definition of the Iterator trait is as shown in Listing
+19-12.
Listing 19-12: The definition of the Iterator trait
+that has an associated type Item
+
The type Item is a placeholder, and the next method’s definition shows that
+it will return values of type Option<Self::Item>. Implementors of the
+Iterator trait will specify the concrete type for Item, and the next
+method will return an Option containing a value of that concrete type.
+
Associated types might seem like a similar concept to generics, in that the
+latter allow us to define a function without specifying what types it can
+handle. To examine the difference between the two concepts, we’ll look at an
+implementation of the Iterator trait on a type named Counter that specifies
+the Item type is u32:
Listing 19-13: A hypothetical definition of the
+Iterator trait using generics
+
The difference is that when using generics, as in Listing 19-13, we must
+annotate the types in each implementation; because we can also implement
+Iterator<String> for Counter or any other type, we could have multiple
+implementations of Iterator for Counter. In other words, when a trait has a
+generic parameter, it can be implemented for a type multiple times, changing
+the concrete types of the generic type parameters each time. When we use the
+next method on Counter, we would have to provide type annotations to
+indicate which implementation of Iterator we want to use.
+
With associated types, we don’t need to annotate types because we can’t
+implement a trait on a type multiple times. In Listing 19-12 with the
+definition that uses associated types, we can only choose what the type of
+Item will be once, because there can only be one impl Iterator for Counter.
+We don’t have to specify that we want an iterator of u32 values everywhere
+that we call next on Counter.
+
Associated types also become part of the trait’s contract: implementors of the
+trait must provide a type to stand in for the associated type placeholder.
+Associated types often have a name that describes how the type will be used,
+and documenting the associated type in the API documentation is good practice.
When we use generic type parameters, we can specify a default concrete type for
+the generic type. This eliminates the need for implementors of the trait to
+specify a concrete type if the default type works. You specify a default type
+when declaring a generic type with the <PlaceholderType=ConcreteType> syntax.
+
A great example of a situation where this technique is useful is with operator
+overloading, in which you customize the behavior of an operator (such as +)
+in particular situations.
+
Rust doesn’t allow you to create your own operators or overload arbitrary
+operators. But you can overload the operations and corresponding traits listed
+in std::ops by implementing the traits associated with the operator. For
+example, in Listing 19-14 we overload the + operator to add two Point
+instances together. We do this by implementing the Add trait on a Point
+struct:
+
Filename: src/main.rs
+
use std::ops::Add;
+
+#[derive(Debug, Copy, Clone, PartialEq)]
+struct Point {
+ x: i32,
+ y: i32,
+}
+
+impl Add for Point {
+ type Output = Point;
+
+ fn add(self, other: Point) -> Point {
+ Point {
+ x: self.x + other.x,
+ y: self.y + other.y,
+ }
+ }
+}
+
+fn main() {
+ assert_eq!(
+ Point { x: 1, y: 0 } + Point { x: 2, y: 3 },
+ Point { x: 3, y: 3 }
+ );
+}
+
Listing 19-14: Implementing the Add trait to overload
+the + operator for Point instances
+
The add method adds the x values of two Point instances and the y
+values of two Point instances to create a new Point. The Add trait has an
+associated type named Output that determines the type returned from the add
+method.
+
The default generic type in this code is within the Add trait. Here is its
+definition:
This code should look generally familiar: a trait with one method and an
+associated type. The new part is Rhs=Self: this syntax is called default
+type parameters. The Rhs generic type parameter (short for “right hand
+side”) defines the type of the rhs parameter in the add method. If we don’t
+specify a concrete type for Rhs when we implement the Add trait, the type
+of Rhs will default to Self, which will be the type we’re implementing
+Add on.
+
When we implemented Add for Point, we used the default for Rhs because we
+wanted to add two Point instances. Let’s look at an example of implementing
+the Add trait where we want to customize the Rhs type rather than using the
+default.
+
We have two structs, Millimeters and Meters, holding values in different
+units. This thin wrapping of an existing type in another struct is known as the
+newtype pattern, which we describe in more detail in the “Using the Newtype
+Pattern to Implement External Traits on External Types” section. We want to add values in millimeters to values in meters and have
+the implementation of Add do the conversion correctly. We can implement Add
+for Millimeters with Meters as the Rhs, as shown in Listing 19-15.
Listing 19-15: Implementing the Add trait on
+Millimeters to add Millimeters to Meters
+
To add Millimeters and Meters, we specify impl Add<Meters> to set the
+value of the Rhs type parameter instead of using the default of Self.
+
You’ll use default type parameters in two main ways:
+
+
To extend a type without breaking existing code
+
To allow customization in specific cases most users won’t need
+
+
The standard library’s Add trait is an example of the second purpose:
+usually, you’ll add two like types, but the Add trait provides the ability to
+customize beyond that. Using a default type parameter in the Add trait
+definition means you don’t have to specify the extra parameter most of the
+time. In other words, a bit of implementation boilerplate isn’t needed, making
+it easier to use the trait.
+
The first purpose is similar to the second but in reverse: if you want to add a
+type parameter to an existing trait, you can give it a default to allow
+extension of the functionality of the trait without breaking the existing
+implementation code.
Nothing in Rust prevents a trait from having a method with the same name as
+another trait’s method, nor does Rust prevent you from implementing both traits
+on one type. It’s also possible to implement a method directly on the type with
+the same name as methods from traits.
+
When calling methods with the same name, you’ll need to tell Rust which one you
+want to use. Consider the code in Listing 19-16 where we’ve defined two traits,
+Pilot and Wizard, that both have a method called fly. We then implement
+both traits on a type Human that already has a method named fly implemented
+on it. Each fly method does something different.
+
Filename: src/main.rs
+
trait Pilot {
+ fn fly(&self);
+}
+
+trait Wizard {
+ fn fly(&self);
+}
+
+struct Human;
+
+impl Pilot for Human {
+ fn fly(&self) {
+ println!("This is your captain speaking.");
+ }
+}
+
+impl Wizard for Human {
+ fn fly(&self) {
+ println!("Up!");
+ }
+}
+
+impl Human {
+ fn fly(&self) {
+ println!("*waving arms furiously*");
+ }
+}
+
+fn main() {}
+
Listing 19-16: Two traits are defined to have a fly
+method and are implemented on the Human type, and a fly method is
+implemented on Human directly
+
When we call fly on an instance of Human, the compiler defaults to calling
+the method that is directly implemented on the type, as shown in Listing 19-17.
+
Filename: src/main.rs
+
trait Pilot {
+ fn fly(&self);
+}
+
+trait Wizard {
+ fn fly(&self);
+}
+
+struct Human;
+
+impl Pilot for Human {
+ fn fly(&self) {
+ println!("This is your captain speaking.");
+ }
+}
+
+impl Wizard for Human {
+ fn fly(&self) {
+ println!("Up!");
+ }
+}
+
+impl Human {
+ fn fly(&self) {
+ println!("*waving arms furiously*");
+ }
+}
+
+fn main() {
+ let person = Human;
+ person.fly();
+}
+
Listing 19-17: Calling fly on an instance of
+Human
+
Running this code will print *waving arms furiously*, showing that Rust
+called the fly method implemented on Human directly.
+
To call the fly methods from either the Pilot trait or the Wizard trait,
+we need to use more explicit syntax to specify which fly method we mean.
+Listing 19-18 demonstrates this syntax.
+
Filename: src/main.rs
+
trait Pilot {
+ fn fly(&self);
+}
+
+trait Wizard {
+ fn fly(&self);
+}
+
+struct Human;
+
+impl Pilot for Human {
+ fn fly(&self) {
+ println!("This is your captain speaking.");
+ }
+}
+
+impl Wizard for Human {
+ fn fly(&self) {
+ println!("Up!");
+ }
+}
+
+impl Human {
+ fn fly(&self) {
+ println!("*waving arms furiously*");
+ }
+}
+
+fn main() {
+ let person = Human;
+ Pilot::fly(&person);
+ Wizard::fly(&person);
+ person.fly();
+}
+
Listing 19-18: Specifying which trait’s fly method we
+want to call
+
Specifying the trait name before the method name clarifies to Rust which
+implementation of fly we want to call. We could also write
+Human::fly(&person), which is equivalent to the person.fly() that we used
+in Listing 19-18, but this is a bit longer to write if we don’t need to
+disambiguate.
+
Running this code prints the following:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.46s
+ Running `target/debug/traits-example`
+This is your captain speaking.
+Up!
+*waving arms furiously*
+
+
Because the fly method takes a self parameter, if we had two types that
+both implement one trait, Rust could figure out which implementation of a
+trait to use based on the type of self.
+
However, associated functions that are not methods don’t have a self
+parameter. When there are multiple types or traits that define non-method
+functions with the same function name, Rust doesn’t always know which type you
+mean unless you use fully qualified syntax. For example, in Listing 19-19 we
+create a trait for an animal shelter that wants to name all baby dogs Spot.
+We make an Animal trait with an associated non-method function baby_name.
+The Animal trait is implemented for the struct Dog, on which we also
+provide an associated non-method function baby_name directly.
+
Filename: src/main.rs
+
trait Animal {
+ fn baby_name() -> String;
+}
+
+struct Dog;
+
+impl Dog {
+ fn baby_name() -> String {
+ String::from("Spot")
+ }
+}
+
+impl Animal for Dog {
+ fn baby_name() -> String {
+ String::from("puppy")
+ }
+}
+
+fn main() {
+ println!("A baby dog is called a {}", Dog::baby_name());
+}
+
Listing 19-19: A trait with an associated function and a
+type with an associated function of the same name that also implements the
+trait
+
We implement the code for naming all puppies Spot in the baby_name associated
+function that is defined on Dog. The Dog type also implements the trait
+Animal, which describes characteristics that all animals have. Baby dogs are
+called puppies, and that is expressed in the implementation of the Animal
+trait on Dog in the baby_name function associated with the Animal trait.
+
In main, we call the Dog::baby_name function, which calls the associated
+function defined on Dog directly. This code prints the following:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.54s
+ Running `target/debug/traits-example`
+A baby dog is called a Spot
+
+
This output isn’t what we wanted. We want to call the baby_name function that
+is part of the Animal trait that we implemented on Dog so the code prints
+A baby dog is called a puppy. The technique of specifying the trait name that
+we used in Listing 19-18 doesn’t help here; if we change main to the code in
+Listing 19-20, we’ll get a compilation error.
+
Filename: src/main.rs
+
trait Animal {
+ fn baby_name() -> String;
+}
+
+struct Dog;
+
+impl Dog {
+ fn baby_name() -> String {
+ String::from("Spot")
+ }
+}
+
+impl Animal for Dog {
+ fn baby_name() -> String {
+ String::from("puppy")
+ }
+}
+
+fn main() {
+ println!("A baby dog is called a {}", Animal::baby_name());
+}
+
Listing 19-20: Attempting to call the baby_name
+function from the Animal trait, but Rust doesn’t know which implementation to
+use
+
Because Animal::baby_name doesn’t have a self parameter, and there could be
+other types that implement the Animal trait, Rust can’t figure out which
+implementation of Animal::baby_name we want. We’ll get this compiler error:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+error[E0790]: cannot call associated function on trait without specifying the corresponding `impl` type
+ --> src/main.rs:20:43
+ |
+2 | fn baby_name() -> String;
+ | ------------------------- `Animal::baby_name` defined here
+...
+20 | println!("A baby dog is called a {}", Animal::baby_name());
+ | ^^^^^^^^^^^^^^^^^^^ cannot call associated function of trait
+ |
+help: use the fully-qualified path to the only available implementation
+ |
+20 | println!("A baby dog is called a {}", <Dog as Animal>::baby_name());
+ | +++++++ +
+
+For more information about this error, try `rustc --explain E0790`.
+error: could not compile `traits-example` (bin "traits-example") due to 1 previous error
+
+
To disambiguate and tell Rust that we want to use the implementation of
+Animal for Dog as opposed to the implementation of Animal for some other
+type, we need to use fully qualified syntax. Listing 19-21 demonstrates how to
+use fully qualified syntax.
+
Filename: src/main.rs
+
trait Animal {
+ fn baby_name() -> String;
+}
+
+struct Dog;
+
+impl Dog {
+ fn baby_name() -> String {
+ String::from("Spot")
+ }
+}
+
+impl Animal for Dog {
+ fn baby_name() -> String {
+ String::from("puppy")
+ }
+}
+
+fn main() {
+ println!("A baby dog is called a {}", <Dog as Animal>::baby_name());
+}
+
Listing 19-21: Using fully qualified syntax to specify
+that we want to call the baby_name function from the Animal trait as
+implemented on Dog
+
We’re providing Rust with a type annotation within the angle brackets, which
+indicates we want to call the baby_name method from the Animal trait as
+implemented on Dog by saying that we want to treat the Dog type as an
+Animal for this function call. This code will now print what we want:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.48s
+ Running `target/debug/traits-example`
+A baby dog is called a puppy
+
+
In general, fully qualified syntax is defined as follows:
+
<Type as Trait>::function(receiver_if_method, next_arg, ...);
+
For associated functions that aren’t methods, there would not be a receiver:
+there would only be the list of other arguments. You could use fully qualified
+syntax everywhere that you call functions or methods. However, you’re allowed
+to omit any part of this syntax that Rust can figure out from other information
+in the program. You only need to use this more verbose syntax in cases where
+there are multiple implementations that use the same name and Rust needs help
+to identify which implementation you want to call.
Sometimes, you might write a trait definition that depends on another trait:
+for a type to implement the first trait, you want to require that type to also
+implement the second trait. You would do this so that your trait definition can
+make use of the associated items of the second trait. The trait your trait
+definition is relying on is called a supertrait of your trait.
+
For example, let’s say we want to make an OutlinePrint trait with an
+outline_print method that will print a given value formatted so that it’s
+framed in asterisks. That is, given a Point struct that implements the
+standard library trait Display to result in (x, y), when we call
+outline_print on a Point instance that has 1 for x and 3 for y, it
+should print the following:
+
**********
+* *
+* (1, 3) *
+* *
+**********
+
+
In the implementation of the outline_print method, we want to use the
+Display trait’s functionality. Therefore, we need to specify that the
+OutlinePrint trait will work only for types that also implement Display and
+provide the functionality that OutlinePrint needs. We can do that in the
+trait definition by specifying OutlinePrint: Display. This technique is
+similar to adding a trait bound to the trait. Listing 19-22 shows an
+implementation of the OutlinePrint trait.
Listing 19-22: Implementing the OutlinePrint trait that
+requires the functionality from Display
+
Because we’ve specified that OutlinePrint requires the Display trait, we
+can use the to_string function that is automatically implemented for any type
+that implements Display. If we tried to use to_string without adding a
+colon and specifying the Display trait after the trait name, we’d get an
+error saying that no method named to_string was found for the type &Self in
+the current scope.
+
Let’s see what happens when we try to implement OutlinePrint on a type that
+doesn’t implement Display, such as the Point struct:
+
Filename: src/main.rs
+
use std::fmt;
+
+trait OutlinePrint: fmt::Display {
+ fn outline_print(&self) {
+ let output = self.to_string();
+ let len = output.len();
+ println!("{}", "*".repeat(len + 4));
+ println!("*{}*", " ".repeat(len + 2));
+ println!("* {output} *");
+ println!("*{}*", " ".repeat(len + 2));
+ println!("{}", "*".repeat(len + 4));
+ }
+}
+
+struct Point {
+ x: i32,
+ y: i32,
+}
+
+impl OutlinePrint for Point {}
+
+fn main() {
+ let p = Point { x: 1, y: 3 };
+ p.outline_print();
+}
+
We get an error saying that Display is required but not implemented:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+error[E0277]: `Point` doesn't implement `std::fmt::Display`
+ --> src/main.rs:20:23
+ |
+20 | impl OutlinePrint for Point {}
+ | ^^^^^ `Point` cannot be formatted with the default formatter
+ |
+ = help: the trait `std::fmt::Display` is not implemented for `Point`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+note: required by a bound in `OutlinePrint`
+ --> src/main.rs:3:21
+ |
+3 | trait OutlinePrint: fmt::Display {
+ | ^^^^^^^^^^^^ required by this bound in `OutlinePrint`
+
+error[E0277]: `Point` doesn't implement `std::fmt::Display`
+ --> src/main.rs:24:7
+ |
+24 | p.outline_print();
+ | ^^^^^^^^^^^^^ `Point` cannot be formatted with the default formatter
+ |
+ = help: the trait `std::fmt::Display` is not implemented for `Point`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+note: required by a bound in `OutlinePrint::outline_print`
+ --> src/main.rs:3:21
+ |
+3 | trait OutlinePrint: fmt::Display {
+ | ^^^^^^^^^^^^ required by this bound in `OutlinePrint::outline_print`
+4 | fn outline_print(&self) {
+ | ------------- required by a bound in this associated function
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `traits-example` (bin "traits-example") due to 2 previous errors
+
+
To fix this, we implement Display on Point and satisfy the constraint that
+OutlinePrint requires, like so:
+
Filename: src/main.rs
+
trait OutlinePrint: fmt::Display {
+ fn outline_print(&self) {
+ let output = self.to_string();
+ let len = output.len();
+ println!("{}", "*".repeat(len + 4));
+ println!("*{}*", " ".repeat(len + 2));
+ println!("* {output} *");
+ println!("*{}*", " ".repeat(len + 2));
+ println!("{}", "*".repeat(len + 4));
+ }
+}
+
+struct Point {
+ x: i32,
+ y: i32,
+}
+
+impl OutlinePrint for Point {}
+
+use std::fmt;
+
+impl fmt::Display for Point {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ write!(f, "({}, {})", self.x, self.y)
+ }
+}
+
+fn main() {
+ let p = Point { x: 1, y: 3 };
+ p.outline_print();
+}
+
Then implementing the OutlinePrint trait on Point will compile
+successfully, and we can call outline_print on a Point instance to display
+it within an outline of asterisks.
In Chapter 10 in the “Implementing a Trait on a
+Type” section, we mentioned the
+orphan rule that states we’re only allowed to implement a trait on a type if
+either the trait or the type are local to our crate. It’s possible to get
+around this restriction using the newtype pattern, which involves creating a
+new type in a tuple struct. (We covered tuple structs in the “Using Tuple
+Structs without Named Fields to Create Different Types” section of Chapter 5.) The tuple struct will have one field and be a
+thin wrapper around the type we want to implement a trait for. Then the wrapper
+type is local to our crate, and we can implement the trait on the wrapper.
+Newtype is a term that originates from the Haskell programming language.
+There is no runtime performance penalty for using this pattern, and the wrapper
+type is elided at compile time.
+
As an example, let’s say we want to implement Display on Vec<T>, which the
+orphan rule prevents us from doing directly because the Display trait and the
+Vec<T> type are defined outside our crate. We can make a Wrapper struct
+that holds an instance of Vec<T>; then we can implement Display on
+Wrapper and use the Vec<T> value, as shown in Listing 19-23.
Listing 19-23: Creating a Wrapper type around
+Vec<String> to implement Display
+
The implementation of Display uses self.0 to access the inner Vec<T>,
+because Wrapper is a tuple struct and Vec<T> is the item at index 0 in the
+tuple. Then we can use the functionality of the Display trait on Wrapper.
+
The downside of using this technique is that Wrapper is a new type, so it
+doesn’t have the methods of the value it’s holding. We would have to implement
+all the methods of Vec<T> directly on Wrapper such that the methods
+delegate to self.0, which would allow us to treat Wrapper exactly like a
+Vec<T>. If we wanted the new type to have every method the inner type has,
+implementing the Deref trait (discussed in Chapter 15 in the “Treating Smart
+Pointers Like Regular References with the Deref
+Trait” section) on the Wrapper to return
+the inner type would be a solution. If we don’t want the Wrapper type to have
+all the methods of the inner type—for example, to restrict the Wrapper type’s
+behavior—we would have to implement just the methods we do want manually.
+
This newtype pattern is also useful even when traits are not involved. Let’s
+switch focus and look at some advanced ways to interact with Rust’s type system.
The Rust type system has some features that we’ve so far mentioned but haven’t
+yet discussed. We’ll start by discussing newtypes in general as we examine why
+newtypes are useful as types. Then we’ll move on to type aliases, a feature
+similar to newtypes but with slightly different semantics. We’ll also discuss
+the ! type and dynamically sized types.
The newtype pattern is also useful for tasks beyond those we’ve discussed so
+far, including statically enforcing that values are never confused and
+indicating the units of a value. You saw an example of using newtypes to
+indicate units in Listing 19-15: recall that the Millimeters and Meters
+structs wrapped u32 values in a newtype. If we wrote a function with a
+parameter of type Millimeters, we couldn’t compile a program that
+accidentally tried to call that function with a value of type Meters or a
+plain u32.
+
We can also use the newtype pattern to abstract away some implementation
+details of a type: the new type can expose a public API that is different from
+the API of the private inner type.
+
Newtypes can also hide internal implementation. For example, we could provide a
+People type to wrap a HashMap<i32, String> that stores a person’s ID
+associated with their name. Code using People would only interact with the
+public API we provide, such as a method to add a name string to the People
+collection; that code wouldn’t need to know that we assign an i32 ID to names
+internally. The newtype pattern is a lightweight way to achieve encapsulation
+to hide implementation details, which we discussed in the “Encapsulation that
+Hides Implementation
+Details”
+section of Chapter 17.
Rust provides the ability to declare a type alias to give an existing type
+another name. For this we use the type keyword. For example, we can create
+the alias Kilometers to i32 like so:
+
fn main() {
+ type Kilometers = i32;
+
+ let x: i32 = 5;
+ let y: Kilometers = 5;
+
+ println!("x + y = {}", x + y);
+}
+
Now, the alias Kilometers is a synonym for i32; unlike the Millimeters
+and Meters types we created in Listing 19-15, Kilometers is not a separate,
+new type. Values that have the type Kilometers will be treated the same as
+values of type i32:
+
fn main() {
+ type Kilometers = i32;
+
+ let x: i32 = 5;
+ let y: Kilometers = 5;
+
+ println!("x + y = {}", x + y);
+}
+
Because Kilometers and i32 are the same type, we can add values of both
+types and we can pass Kilometers values to functions that take i32
+parameters. However, using this method, we don’t get the type checking benefits
+that we get from the newtype pattern discussed earlier. In other words, if we
+mix up Kilometers and i32 values somewhere, the compiler will not give us
+an error.
+
The main use case for type synonyms is to reduce repetition. For example, we
+might have a lengthy type like this:
+
Box<dyn Fn() + Send + 'static>
+
Writing this lengthy type in function signatures and as type annotations all
+over the code can be tiresome and error prone. Imagine having a project full of
+code like that in Listing 19-24.
A type alias makes this code more manageable by reducing the repetition. In
+Listing 19-25, we’ve introduced an alias named Thunk for the verbose type and
+can replace all uses of the type with the shorter alias Thunk.
Listing 19-25: Introducing a type alias Thunk to reduce
+repetition
+
This code is much easier to read and write! Choosing a meaningful name for a
+type alias can help communicate your intent as well (thunk is a word for code
+to be evaluated at a later time, so it’s an appropriate name for a closure that
+gets stored).
+
Type aliases are also commonly used with the Result<T, E> type for reducing
+repetition. Consider the std::io module in the standard library. I/O
+operations often return a Result<T, E> to handle situations when operations
+fail to work. This library has a std::io::Error struct that represents all
+possible I/O errors. Many of the functions in std::io will be returning
+Result<T, E> where the E is std::io::Error, such as these functions in
+the Write trait:
Because this declaration is in the std::io module, we can use the fully
+qualified alias std::io::Result<T>; that is, a Result<T, E> with the E
+filled in as std::io::Error. The Write trait function signatures end up
+looking like this:
The type alias helps in two ways: it makes code easier to write and it gives
+us a consistent interface across all of std::io. Because it’s an alias, it’s
+just another Result<T, E>, which means we can use any methods that work on
+Result<T, E> with it, as well as special syntax like the ? operator.
Rust has a special type named ! that’s known in type theory lingo as the
+empty type because it has no values. We prefer to call it the never type
+because it stands in the place of the return type when a function will never
+return. Here is an example:
+
fn bar() -> ! {
+ // --snip--
+ panic!();
+}
+
This code is read as “the function bar returns never.” Functions that return
+never are called diverging functions. We can’t create values of the type !
+so bar can never possibly return.
+
But what use is a type you can never create values for? Recall the code from
+Listing 2-5, part of the number guessing game; we’ve reproduced a bit of it
+here in Listing 19-26.
Listing 19-26: A match with an arm that ends in
+continue
+
At the time, we skipped over some details in this code. In Chapter 6 in “The
+match Control Flow Operator”
+section, we discussed that match arms must all return the same type. So, for
+example, the following code doesn’t work:
+
fn main() {
+ let guess = "3";
+ let guess = match guess.trim().parse() {
+ Ok(_) => 5,
+ Err(_) => "hello",
+ };
+}
+
The type of guess in this code would have to be an integer and a string,
+and Rust requires that guess have only one type. So what does continue
+return? How were we allowed to return a u32 from one arm and have another arm
+that ends with continue in Listing 19-26?
+
As you might have guessed, continue has a ! value. That is, when Rust
+computes the type of guess, it looks at both match arms, the former with a
+value of u32 and the latter with a ! value. Because ! can never have a
+value, Rust decides that the type of guess is u32.
+
The formal way of describing this behavior is that expressions of type ! can
+be coerced into any other type. We’re allowed to end this match arm with
+continue because continue doesn’t return a value; instead, it moves control
+back to the top of the loop, so in the Err case, we never assign a value to
+guess.
+
The never type is useful with the panic! macro as well. Recall the unwrap
+function that we call on Option<T> values to produce a value or panic with
+this definition:
In this code, the same thing happens as in the match in Listing 19-26: Rust
+sees that val has the type T and panic! has the type !, so the result
+of the overall match expression is T. This code works because panic!
+doesn’t produce a value; it ends the program. In the None case, we won’t be
+returning a value from unwrap, so this code is valid.
+
One final expression that has the type ! is a loop:
Here, the loop never ends, so ! is the value of the expression. However, this
+wouldn’t be true if we included a break, because the loop would terminate
+when it got to the break.
Rust needs to know certain details about its types, such as how much space to
+allocate for a value of a particular type. This leaves one corner of its type
+system a little confusing at first: the concept of dynamically sized types.
+Sometimes referred to as DSTs or unsized types, these types let us write
+code using values whose size we can know only at runtime.
+
Let’s dig into the details of a dynamically sized type called str, which
+we’ve been using throughout the book. That’s right, not &str, but str on
+its own, is a DST. We can’t know how long the string is until runtime, meaning
+we can’t create a variable of type str, nor can we take an argument of type
+str. Consider the following code, which does not work:
+
fn main() {
+ let s1: str = "Hello there!";
+ let s2: str = "How's it going?";
+}
+
Rust needs to know how much memory to allocate for any value of a particular
+type, and all values of a type must use the same amount of memory. If Rust
+allowed us to write this code, these two str values would need to take up the
+same amount of space. But they have different lengths: s1 needs 12 bytes of
+storage and s2 needs 15. This is why it’s not possible to create a variable
+holding a dynamically sized type.
+
So what do we do? In this case, you already know the answer: we make the types
+of s1 and s2 a &str rather than a str. Recall from the “String
+Slices” section of Chapter 4 that the slice data
+structure just stores the starting position and the length of the slice. So
+although a &T is a single value that stores the memory address of where the
+T is located, a &str is two values: the address of the str and its
+length. As such, we can know the size of a &str value at compile time: it’s
+twice the length of a usize. That is, we always know the size of a &str, no
+matter how long the string it refers to is. In general, this is the way in
+which dynamically sized types are used in Rust: they have an extra bit of
+metadata that stores the size of the dynamic information. The golden rule of
+dynamically sized types is that we must always put values of dynamically sized
+types behind a pointer of some kind.
+
We can combine str with all kinds of pointers: for example, Box<str> or
+Rc<str>. In fact, you’ve seen this before but with a different dynamically
+sized type: traits. Every trait is a dynamically sized type we can refer to by
+using the name of the trait. In Chapter 17 in the “Using Trait Objects That
+Allow for Values of Different
+Types” section, we mentioned that to use traits as trait objects, we must
+put them behind a pointer, such as &dyn Trait or Box<dyn Trait> (Rc<dyn Trait> would work too).
+
To work with DSTs, Rust provides the Sized trait to determine whether or not
+a type’s size is known at compile time. This trait is automatically implemented
+for everything whose size is known at compile time. In addition, Rust
+implicitly adds a bound on Sized to every generic function. That is, a
+generic function definition like this:
+
fn generic<T>(t: T) {
+ // --snip--
+}
+
is actually treated as though we had written this:
+
fn generic<T: Sized>(t: T) {
+ // --snip--
+}
+
By default, generic functions will work only on types that have a known size at
+compile time. However, you can use the following special syntax to relax this
+restriction:
+
fn generic<T: ?Sized>(t: &T) {
+ // --snip--
+}
+
A trait bound on ?Sized means “T may or may not be Sized” and this
+notation overrides the default that generic types must have a known size at
+compile time. The ?Trait syntax with this meaning is only available for
+Sized, not any other traits.
+
Also note that we switched the type of the t parameter from T to &T.
+Because the type might not be Sized, we need to use it behind some kind of
+pointer. In this case, we’ve chosen a reference.
We’ve talked about how to pass closures to functions; you can also pass regular
+functions to functions! This technique is useful when you want to pass a
+function you’ve already defined rather than defining a new closure. Functions
+coerce to the type fn (with a lowercase f), not to be confused with the Fn
+closure trait. The fn type is called a function pointer. Passing functions
+with function pointers will allow you to use functions as arguments to other
+functions.
+
The syntax for specifying that a parameter is a function pointer is similar to
+that of closures, as shown in Listing 19-27, where we’ve defined a function
+add_one that adds one to its parameter. The function do_twice takes two
+parameters: a function pointer to any function that takes an i32 parameter
+and returns an i32, and one i32 value. The do_twice function calls the
+function f twice, passing it the arg value, then adds the two function call
+results together. The main function calls do_twice with the arguments
+add_one and 5.
Listing 19-27: Using the fn type to accept a function
+pointer as an argument
+
This code prints The answer is: 12. We specify that the parameter f in
+do_twice is an fn that takes one parameter of type i32 and returns an
+i32. We can then call f in the body of do_twice. In main, we can pass
+the function name add_one as the first argument to do_twice.
+
Unlike closures, fn is a type rather than a trait, so we specify fn as the
+parameter type directly rather than declaring a generic type parameter with one
+of the Fn traits as a trait bound.
+
Function pointers implement all three of the closure traits (Fn, FnMut, and
+FnOnce), meaning you can always pass a function pointer as an argument for a
+function that expects a closure. It’s best to write functions using a generic
+type and one of the closure traits so your functions can accept either
+functions or closures.
+
That said, one example of where you would want to only accept fn and not
+closures is when interfacing with external code that doesn’t have closures: C
+functions can accept functions as arguments, but C doesn’t have closures.
+
As an example of where you could use either a closure defined inline or a named
+function, let’s look at a use of the map method provided by the Iterator
+trait in the standard library. To use the map function to turn a vector of
+numbers into a vector of strings, we could use a closure, like this:
+
fn main() {
+ let list_of_numbers = vec![1, 2, 3];
+ let list_of_strings: Vec<String> =
+ list_of_numbers.iter().map(|i| i.to_string()).collect();
+}
+
Or we could name a function as the argument to map instead of the closure,
+like this:
+
fn main() {
+ let list_of_numbers = vec![1, 2, 3];
+ let list_of_strings: Vec<String> =
+ list_of_numbers.iter().map(ToString::to_string).collect();
+}
+
Note that we must use the fully qualified syntax that we talked about earlier
+in the “Advanced Traits” section because
+there are multiple functions available named to_string. Here, we’re using the
+to_string function defined in the ToString trait, which the standard
+library has implemented for any type that implements Display.
+
Recall from the “Enum values” section of Chapter
+6 that the name of each enum variant that we define also becomes an initializer
+function. We can use these initializer functions as function pointers that
+implement the closure traits, which means we can specify the initializer
+functions as arguments for methods that take closures, like so:
Here we create Status::Value instances using each u32 value in the range
+that map is called on by using the initializer function of Status::Value.
+Some people prefer this style, and some people prefer to use closures. They
+compile to the same code, so use whichever style is clearer to you.
Closures are represented by traits, which means you can’t return closures
+directly. In most cases where you might want to return a trait, you can instead
+use the concrete type that implements the trait as the return value of the
+function. However, you can’t do that with closures because they don’t have a
+concrete type that is returnable; you’re not allowed to use the function
+pointer fn as a return type, for example.
+
The following code tries to return a closure directly, but it won’t compile:
$ cargo build
+ Compiling functions-example v0.1.0 (file:///projects/functions-example)
+error[E0746]: return type cannot have an unboxed trait object
+ --> src/lib.rs:1:25
+ |
+1 | fn returns_closure() -> dyn Fn(i32) -> i32 {
+ | ^^^^^^^^^^^^^^^^^^ doesn't have a size known at compile-time
+ |
+help: return an `impl Trait` instead of a `dyn Trait`, if all returned values are the same type
+ |
+1 | fn returns_closure() -> impl Fn(i32) -> i32 {
+ | ~~~~
+help: box the return type, and wrap all of the returned values in `Box::new`
+ |
+1 ~ fn returns_closure() -> Box<dyn Fn(i32) -> i32> {
+2 ~ Box::new(|x| x + 1)
+ |
+
+For more information about this error, try `rustc --explain E0746`.
+error: could not compile `functions-example` (lib) due to 1 previous error
+
+
The error references the Sized trait again! Rust doesn’t know how much space
+it will need to store the closure. We saw a solution to this problem earlier.
+We can use a trait object:
We’ve used macros like println! throughout this book, but we haven’t fully
+explored what a macro is and how it works. The term macro refers to a family
+of features in Rust: declarative macros with macro_rules! and three kinds
+of procedural macros:
+
+
Custom #[derive] macros that specify code added with the derive attribute
+used on structs and enums
+
Attribute-like macros that define custom attributes usable on any item
+
Function-like macros that look like function calls but operate on the tokens
+specified as their argument
+
+
We’ll talk about each of these in turn, but first, let’s look at why we even
+need macros when we already have functions.
Fundamentally, macros are a way of writing code that writes other code, which
+is known as metaprogramming. In Appendix C, we discuss the derive
+attribute, which generates an implementation of various traits for you. We’ve
+also used the println! and vec! macros throughout the book. All of these
+macros expand to produce more code than the code you’ve written manually.
+
Metaprogramming is useful for reducing the amount of code you have to write and
+maintain, which is also one of the roles of functions. However, macros have
+some additional powers that functions don’t.
+
A function signature must declare the number and type of parameters the
+function has. Macros, on the other hand, can take a variable number of
+parameters: we can call println!("hello") with one argument or
+println!("hello {}", name) with two arguments. Also, macros are expanded
+before the compiler interprets the meaning of the code, so a macro can, for
+example, implement a trait on a given type. A function can’t, because it gets
+called at runtime and a trait needs to be implemented at compile time.
+
The downside to implementing a macro instead of a function is that macro
+definitions are more complex than function definitions because you’re writing
+Rust code that writes Rust code. Due to this indirection, macro definitions are
+generally more difficult to read, understand, and maintain than function
+definitions.
+
Another important difference between macros and functions is that you must
+define macros or bring them into scope before you call them in a file, as
+opposed to functions you can define anywhere and call anywhere.
The most widely used form of macros in Rust is the declarative macro. These
+are also sometimes referred to as “macros by example,” “macro_rules! macros,”
+or just plain “macros.” At their core, declarative macros allow you to write
+something similar to a Rust match expression. As discussed in Chapter 6,
+match expressions are control structures that take an expression, compare the
+resulting value of the expression to patterns, and then run the code associated
+with the matching pattern. Macros also compare a value to patterns that are
+associated with particular code: in this situation, the value is the literal
+Rust source code passed to the macro; the patterns are compared with the
+structure of that source code; and the code associated with each pattern, when
+matched, replaces the code passed to the macro. This all happens during
+compilation.
+
To define a macro, you use the macro_rules! construct. Let’s explore how to
+use macro_rules! by looking at how the vec! macro is defined. Chapter 8
+covered how we can use the vec! macro to create a new vector with particular
+values. For example, the following macro creates a new vector containing three
+integers:
We could also use the vec! macro to make a vector of two integers or a vector
+of five string slices. We wouldn’t be able to use a function to do the same
+because we wouldn’t know the number or type of values up front.
+
Listing 19-28 shows a slightly simplified definition of the vec! macro.
Listing 19-28: A simplified version of the vec! macro
+definition
+
+
Note: The actual definition of the vec! macro in the standard library
+includes code to preallocate the correct amount of memory up front. That code
+is an optimization that we don’t include here to make the example simpler.
+
+
The #[macro_export] annotation indicates that this macro should be made
+available whenever the crate in which the macro is defined is brought into
+scope. Without this annotation, the macro can’t be brought into scope.
+
We then start the macro definition with macro_rules! and the name of the
+macro we’re defining without the exclamation mark. The name, in this case
+vec, is followed by curly brackets denoting the body of the macro definition.
+
The structure in the vec! body is similar to the structure of a match
+expression. Here we have one arm with the pattern ( $( $x:expr ),* ),
+followed by => and the block of code associated with this pattern. If the
+pattern matches, the associated block of code will be emitted. Given that this
+is the only pattern in this macro, there is only one valid way to match; any
+other pattern will result in an error. More complex macros will have more than
+one arm.
+
Valid pattern syntax in macro definitions is different than the pattern syntax
+covered in Chapter 18 because macro patterns are matched against Rust code
+structure rather than values. Let’s walk through what the pattern pieces in
+Listing 19-28 mean; for the full macro pattern syntax, see the Rust
+Reference.
+
First, we use a set of parentheses to encompass the whole pattern. We use a
+dollar sign ($) to declare a variable in the macro system that will contain
+the Rust code matching the pattern. The dollar sign makes it clear this is a
+macro variable as opposed to a regular Rust variable. Next comes a set of
+parentheses that captures values that match the pattern within the parentheses
+for use in the replacement code. Within $() is $x:expr, which matches any
+Rust expression and gives the expression the name $x.
+
The comma following $() indicates that a literal comma separator character
+could optionally appear after the code that matches the code in $(). The *
+specifies that the pattern matches zero or more of whatever precedes the *.
+
When we call this macro with vec![1, 2, 3];, the $x pattern matches three
+times with the three expressions 1, 2, and 3.
+
Now let’s look at the pattern in the body of the code associated with this arm:
+temp_vec.push() within $()* is generated for each part that matches $()
+in the pattern zero or more times depending on how many times the pattern
+matches. The $x is replaced with each expression matched. When we call this
+macro with vec![1, 2, 3];, the code generated that replaces this macro call
+will be the following:
We’ve defined a macro that can take any number of arguments of any type and can
+generate code to create a vector containing the specified elements.
+
To learn more about how to write macros, consult the online documentation or
+other resources, such as “The Little Book of Rust Macros” started by
+Daniel Keep and continued by Lukas Wirth.
The second form of macros is the procedural macro, which acts more like a
+function (and is a type of procedure). Procedural macros accept some code as an
+input, operate on that code, and produce some code as an output rather than
+matching against patterns and replacing the code with other code as declarative
+macros do. The three kinds of procedural macros are custom derive,
+attribute-like, and function-like, and all work in a similar fashion.
+
When creating procedural macros, the definitions must reside in their own crate
+with a special crate type. This is for complex technical reasons that we hope
+to eliminate in the future. In Listing 19-29, we show how to define a
+procedural macro, where some_attribute is a placeholder for using a specific
+macro variety.
Listing 19-29: An example of defining a procedural
+macro
+
The function that defines a procedural macro takes a TokenStream as an input
+and produces a TokenStream as an output. The TokenStream type is defined by
+the proc_macro crate that is included with Rust and represents a sequence of
+tokens. This is the core of the macro: the source code that the macro is
+operating on makes up the input TokenStream, and the code the macro produces
+is the output TokenStream. The function also has an attribute attached to it
+that specifies which kind of procedural macro we’re creating. We can have
+multiple kinds of procedural macros in the same crate.
+
Let’s look at the different kinds of procedural macros. We’ll start with a
+custom derive macro and then explain the small dissimilarities that make the
+other forms different.
Let’s create a crate named hello_macro that defines a trait named
+HelloMacro with one associated function named hello_macro. Rather than
+making our users implement the HelloMacro trait for each of their types,
+we’ll provide a procedural macro so users can annotate their type with
+#[derive(HelloMacro)] to get a default implementation of the hello_macro
+function. The default implementation will print Hello, Macro! My name is TypeName! where TypeName is the name of the type on which this trait has
+been defined. In other words, we’ll write a crate that enables another
+programmer to write code like Listing 19-30 using our crate.
Listing 19-30: The code a user of our crate will be able
+to write when using our procedural macro
+
This code will print Hello, Macro! My name is Pancakes! when we’re done. The
+first step is to make a new library crate, like this:
+
$ cargo new hello_macro --lib
+
+
Next, we’ll define the HelloMacro trait and its associated function:
+
Filename: src/lib.rs
+
pub trait HelloMacro {
+ fn hello_macro();
+}
+
We have a trait and its function. At this point, our crate user could implement
+the trait to achieve the desired functionality, like so:
+
use hello_macro::HelloMacro;
+
+struct Pancakes;
+
+impl HelloMacro for Pancakes {
+ fn hello_macro() {
+ println!("Hello, Macro! My name is Pancakes!");
+ }
+}
+
+fn main() {
+ Pancakes::hello_macro();
+}
+
However, they would need to write the implementation block for each type they
+wanted to use with hello_macro; we want to spare them from having to do this
+work.
+
Additionally, we can’t yet provide the hello_macro function with default
+implementation that will print the name of the type the trait is implemented
+on: Rust doesn’t have reflection capabilities, so it can’t look up the type’s
+name at runtime. We need a macro to generate code at compile time.
+
The next step is to define the procedural macro. At the time of this writing,
+procedural macros need to be in their own crate. Eventually, this restriction
+might be lifted. The convention for structuring crates and macro crates is as
+follows: for a crate named foo, a custom derive procedural macro crate is
+called foo_derive. Let’s start a new crate called hello_macro_derive inside
+our hello_macro project:
+
$ cargo new hello_macro_derive --lib
+
+
Our two crates are tightly related, so we create the procedural macro crate
+within the directory of our hello_macro crate. If we change the trait
+definition in hello_macro, we’ll have to change the implementation of the
+procedural macro in hello_macro_derive as well. The two crates will need to
+be published separately, and programmers using these crates will need to add
+both as dependencies and bring them both into scope. We could instead have the
+hello_macro crate use hello_macro_derive as a dependency and re-export the
+procedural macro code. However, the way we’ve structured the project makes it
+possible for programmers to use hello_macro even if they don’t want the
+derive functionality.
+
We need to declare the hello_macro_derive crate as a procedural macro crate.
+We’ll also need functionality from the syn and quote crates, as you’ll see
+in a moment, so we need to add them as dependencies. Add the following to the
+Cargo.toml file for hello_macro_derive:
To start defining the procedural macro, place the code in Listing 19-31 into
+your src/lib.rs file for the hello_macro_derive crate. Note that this code
+won’t compile until we add a definition for the impl_hello_macro function.
+
Filename: hello_macro_derive/src/lib.rs
+
use proc_macro::TokenStream;
+use quote::quote;
+
+#[proc_macro_derive(HelloMacro)]
+pub fn hello_macro_derive(input: TokenStream) -> TokenStream {
+ // Construct a representation of Rust code as a syntax tree
+ // that we can manipulate
+ let ast = syn::parse(input).unwrap();
+
+ // Build the trait implementation
+ impl_hello_macro(&ast)
+}
+
Listing 19-31: Code that most procedural macro crates
+will require in order to process Rust code
+
Notice that we’ve split the code into the hello_macro_derive function, which
+is responsible for parsing the TokenStream, and the impl_hello_macro
+function, which is responsible for transforming the syntax tree: this makes
+writing a procedural macro more convenient. The code in the outer function
+(hello_macro_derive in this case) will be the same for almost every
+procedural macro crate you see or create. The code you specify in the body of
+the inner function (impl_hello_macro in this case) will be different
+depending on your procedural macro’s purpose.
+
We’ve introduced three new crates: proc_macro, syn, and quote. The
+proc_macro crate comes with Rust, so we didn’t need to add that to the
+dependencies in Cargo.toml. The proc_macro crate is the compiler’s API that
+allows us to read and manipulate Rust code from our code.
+
The syn crate parses Rust code from a string into a data structure that we
+can perform operations on. The quote crate turns syn data structures back
+into Rust code. These crates make it much simpler to parse any sort of Rust
+code we might want to handle: writing a full parser for Rust code is no simple
+task.
+
The hello_macro_derive function will be called when a user of our library
+specifies #[derive(HelloMacro)] on a type. This is possible because we’ve
+annotated the hello_macro_derive function here with proc_macro_derive and
+specified the name HelloMacro, which matches our trait name; this is the
+convention most procedural macros follow.
+
The hello_macro_derive function first converts the input from a
+TokenStream to a data structure that we can then interpret and perform
+operations on. This is where syn comes into play. The parse function in
+syn takes a TokenStream and returns a DeriveInput struct representing the
+parsed Rust code. Listing 19-32 shows the relevant parts of the DeriveInput
+struct we get from parsing the struct Pancakes; string:
Listing 19-32: The DeriveInput instance we get when
+parsing the code that has the macro’s attribute in Listing 19-30
+
The fields of this struct show that the Rust code we’ve parsed is a unit struct
+with the ident (identifier, meaning the name) of Pancakes. There are more
+fields on this struct for describing all sorts of Rust code; check the syn
+documentation for DeriveInput for more information.
+
Soon we’ll define the impl_hello_macro function, which is where we’ll build
+the new Rust code we want to include. But before we do, note that the output
+for our derive macro is also a TokenStream. The returned TokenStream is
+added to the code that our crate users write, so when they compile their crate,
+they’ll get the extra functionality that we provide in the modified
+TokenStream.
+
You might have noticed that we’re calling unwrap to cause the
+hello_macro_derive function to panic if the call to the syn::parse function
+fails here. It’s necessary for our procedural macro to panic on errors because
+proc_macro_derive functions must return TokenStream rather than Result to
+conform to the procedural macro API. We’ve simplified this example by using
+unwrap; in production code, you should provide more specific error messages
+about what went wrong by using panic! or expect.
+
Now that we have the code to turn the annotated Rust code from a TokenStream
+into a DeriveInput instance, let’s generate the code that implements the
+HelloMacro trait on the annotated type, as shown in Listing 19-33.
+
Filename: hello_macro_derive/src/lib.rs
+
use proc_macro::TokenStream;
+use quote::quote;
+
+#[proc_macro_derive(HelloMacro)]
+pub fn hello_macro_derive(input: TokenStream) -> TokenStream {
+ // Construct a representation of Rust code as a syntax tree
+ // that we can manipulate
+ let ast = syn::parse(input).unwrap();
+
+ // Build the trait implementation
+ impl_hello_macro(&ast)
+}
+
+fn impl_hello_macro(ast: &syn::DeriveInput) -> TokenStream {
+ let name = &ast.ident;
+ let gen = quote! {
+ impl HelloMacro for #name {
+ fn hello_macro() {
+ println!("Hello, Macro! My name is {}!", stringify!(#name));
+ }
+ }
+ };
+ gen.into()
+}
+
Listing 19-33: Implementing the HelloMacro trait using
+the parsed Rust code
+
We get an Ident struct instance containing the name (identifier) of the
+annotated type using ast.ident. The struct in Listing 19-32 shows that when
+we run the impl_hello_macro function on the code in Listing 19-30, the
+ident we get will have the ident field with a value of "Pancakes". Thus,
+the name variable in Listing 19-33 will contain an Ident struct instance
+that, when printed, will be the string "Pancakes", the name of the struct in
+Listing 19-30.
+
The quote! macro lets us define the Rust code that we want to return. The
+compiler expects something different to the direct result of the quote!
+macro’s execution, so we need to convert it to a TokenStream. We do this by
+calling the into method, which consumes this intermediate representation and
+returns a value of the required TokenStream type.
+
The quote! macro also provides some very cool templating mechanics: we can
+enter #name, and quote! will replace it with the value in the variable
+name. You can even do some repetition similar to the way regular macros work.
+Check out the quote crate’s docs for a thorough introduction.
+
We want our procedural macro to generate an implementation of our HelloMacro
+trait for the type the user annotated, which we can get by using #name. The
+trait implementation has the one function hello_macro, whose body contains the
+functionality we want to provide: printing Hello, Macro! My name is and then
+the name of the annotated type.
+
The stringify! macro used here is built into Rust. It takes a Rust
+expression, such as 1 + 2, and at compile time turns the expression into a
+string literal, such as "1 + 2". This is different than format! or
+println!, macros which evaluate the expression and then turn the result into
+a String. There is a possibility that the #name input might be an
+expression to print literally, so we use stringify!. Using stringify! also
+saves an allocation by converting #name to a string literal at compile time.
+
At this point, cargo build should complete successfully in both hello_macro
+and hello_macro_derive. Let’s hook up these crates to the code in Listing
+19-30 to see the procedural macro in action! Create a new binary project in
+your projects directory using cargo new pancakes. We need to add
+hello_macro and hello_macro_derive as dependencies in the pancakes
+crate’s Cargo.toml. If you’re publishing your versions of hello_macro and
+hello_macro_derive to crates.io, they would be regular
+dependencies; if not, you can specify them as path dependencies as follows:
Put the code in Listing 19-30 into src/main.rs, and run cargo run: it
+should print Hello, Macro! My name is Pancakes! The implementation of the
+HelloMacro trait from the procedural macro was included without the
+pancakes crate needing to implement it; the #[derive(HelloMacro)] added the
+trait implementation.
+
Next, let’s explore how the other kinds of procedural macros differ from custom
+derive macros.
Attribute-like macros are similar to custom derive macros, but instead of
+generating code for the derive attribute, they allow you to create new
+attributes. They’re also more flexible: derive only works for structs and
+enums; attributes can be applied to other items as well, such as functions.
+Here’s an example of using an attribute-like macro: say you have an attribute
+named route that annotates functions when using a web application framework:
+
#[route(GET, "/")]
+fn index() {
+
This #[route] attribute would be defined by the framework as a procedural
+macro. The signature of the macro definition function would look like this:
Here, we have two parameters of type TokenStream. The first is for the
+contents of the attribute: the GET, "/" part. The second is the body of the
+item the attribute is attached to: in this case, fn index() {} and the rest
+of the function’s body.
+
Other than that, attribute-like macros work the same way as custom derive
+macros: you create a crate with the proc-macro crate type and implement a
+function that generates the code you want!
Function-like macros define macros that look like function calls. Similarly to
+macro_rules! macros, they’re more flexible than functions; for example, they
+can take an unknown number of arguments. However, macro_rules! macros can be
+defined only using the match-like syntax we discussed in the section
+“Declarative Macros with macro_rules! for General
+Metaprogramming” earlier. Function-like macros take a
+TokenStream parameter and their definition manipulates that TokenStream
+using Rust code as the other two types of procedural macros do. An example of a
+function-like macro is an sql! macro that might be called like so:
+
let sql = sql!(SELECT * FROM posts WHERE id=1);
+
This macro would parse the SQL statement inside it and check that it’s
+syntactically correct, which is much more complex processing than a
+macro_rules! macro can do. The sql! macro would be defined like this:
This definition is similar to the custom derive macro’s signature: we receive
+the tokens that are inside the parentheses and return the code we wanted to
+generate.
Whew! Now you have some Rust features in your toolbox that you likely won’t use
+often, but you’ll know they’re available in very particular circumstances.
+We’ve introduced several complex topics so that when you encounter them in
+error message suggestions or in other peoples’ code, you’ll be able to
+recognize these concepts and syntax. Use this chapter as a reference to guide
+you to solutions.
+
Next, we’ll put everything we’ve discussed throughout the book into practice
+and do one more project!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch21-00-final-project-a-web-server.html b/ch21-00-final-project-a-web-server.html
new file mode 100644
index 0000000000..1a00fac350
--- /dev/null
+++ b/ch21-00-final-project-a-web-server.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+ Final Project: Building a Multithreaded Web Server - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
It’s been a long journey, but we’ve reached the end of the book. In this
+chapter, we’ll build one more project together to demonstrate some of the
+concepts we covered in the final chapters, as well as recap some earlier
+lessons.
+
For our final project, we’ll make a web server that says “hello” and looks like
+Figure 20-1 in a web browser.
+
+
Figure 20-1: Our final shared project
+
Here is our plan for building the web server:
+
+
Learn a bit about TCP and HTTP.
+
Listen for TCP connections on a socket.
+
Parse a small number of HTTP requests.
+
Create a proper HTTP response.
+
Improve the throughput of our server with a thread pool.
+
+
Before we get started, we should mention one detail: the method we’ll use won’t
+be the best way to build a web server with Rust. Community members have
+published a number of production-ready crates available on
+crates.io that provide more complete web server and
+thread pool implementations than we’ll build. However, our intention in this
+chapter is to help you learn, not to take the easy route. Because Rust is a
+systems programming language, we can choose the level of abstraction we want to
+work with and can go to a lower level than is possible or practical in other
+languages. We’ll therefore write the basic HTTP server and thread pool manually
+so you can learn the general ideas and techniques behind the crates you might
+use in the future.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch21-01-single-threaded.html b/ch21-01-single-threaded.html
new file mode 100644
index 0000000000..a79a70a74e
--- /dev/null
+++ b/ch21-01-single-threaded.html
@@ -0,0 +1,800 @@
+
+
+
+
+
+ Building a Single-Threaded Web Server - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
We’ll start by getting a single-threaded web server working. Before we begin,
+let’s look at a quick overview of the protocols involved in building web
+servers. The details of these protocols are beyond the scope of this book, but
+a brief overview will give you the information you need.
+
The two main protocols involved in web servers are Hypertext Transfer
+Protocol(HTTP) and Transmission Control Protocol(TCP). Both protocols
+are request-response protocols, meaning a client initiates requests and a
+server listens to the requests and provides a response to the client. The
+contents of those requests and responses are defined by the protocols.
+
TCP is the lower-level protocol that describes the details of how information
+gets from one server to another but doesn’t specify what that information is.
+HTTP builds on top of TCP by defining the contents of the requests and
+responses. It’s technically possible to use HTTP with other protocols, but in
+the vast majority of cases, HTTP sends its data over TCP. We’ll work with the
+raw bytes of TCP and HTTP requests and responses.
Our web server needs to listen to a TCP connection, so that’s the first part
+we’ll work on. The standard library offers a std::net module that lets us do
+this. Let’s make a new project in the usual fashion:
+
$ cargo new hello
+ Created binary (application) `hello` project
+$ cd hello
+
+
Now enter the code in Listing 20-1 in src/main.rs to start. This code will
+listen at the local address 127.0.0.1:7878 for incoming TCP streams. When it
+gets an incoming stream, it will print Connection established!.
+
Filename: src/main.rs
+
use std::net::TcpListener;
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ println!("Connection established!");
+ }
+}
+
Listing 20-1: Listening for incoming streams and printing
+a message when we receive a stream
+
Using TcpListener, we can listen for TCP connections at the address
+127.0.0.1:7878. In the address, the section before the colon is an IP address
+representing your computer (this is the same on every computer and doesn’t
+represent the authors’ computer specifically), and 7878 is the port. We’ve
+chosen this port for two reasons: HTTP isn’t normally accepted on this port so
+our server is unlikely to conflict with any other web server you might have
+running on your machine, and 7878 is rust typed on a telephone.
+
The bind function in this scenario works like the new function in that it
+will return a new TcpListener instance. The function is called bind
+because, in networking, connecting to a port to listen to is known as “binding
+to a port.”
+
The bind function returns a Result<T, E>, which indicates that it’s
+possible for binding to fail. For example, connecting to port 80 requires
+administrator privileges (nonadministrators can listen only on ports higher
+than 1023), so if we tried to connect to port 80 without being an
+administrator, binding wouldn’t work. Binding also wouldn’t work, for example,
+if we ran two instances of our program and so had two programs listening to the
+same port. Because we’re writing a basic server just for learning purposes, we
+won’t worry about handling these kinds of errors; instead, we use unwrap to
+stop the program if errors happen.
+
The incoming method on TcpListener returns an iterator that gives us a
+sequence of streams (more specifically, streams of type TcpStream). A single
+stream represents an open connection between the client and the server. A
+connection is the name for the full request and response process in which a
+client connects to the server, the server generates a response, and the server
+closes the connection. As such, we will read from the TcpStream to see what
+the client sent and then write our response to the stream to send data back to
+the client. Overall, this for loop will process each connection in turn and
+produce a series of streams for us to handle.
+
For now, our handling of the stream consists of calling unwrap to terminate
+our program if the stream has any errors; if there aren’t any errors, the
+program prints a message. We’ll add more functionality for the success case in
+the next listing. The reason we might receive errors from the incoming method
+when a client connects to the server is that we’re not actually iterating over
+connections. Instead, we’re iterating over connection attempts. The
+connection might not be successful for a number of reasons, many of them
+operating system specific. For example, many operating systems have a limit to
+the number of simultaneous open connections they can support; new connection
+attempts beyond that number will produce an error until some of the open
+connections are closed.
+
Let’s try running this code! Invoke cargo run in the terminal and then load
+127.0.0.1:7878 in a web browser. The browser should show an error message
+like “Connection reset,” because the server isn’t currently sending back any
+data. But when you look at your terminal, you should see several messages that
+were printed when the browser connected to the server!
Sometimes, you’ll see multiple messages printed for one browser request; the
+reason might be that the browser is making a request for the page as well as a
+request for other resources, like the favicon.ico icon that appears in the
+browser tab.
+
It could also be that the browser is trying to connect to the server multiple
+times because the server isn’t responding with any data. When stream goes out
+of scope and is dropped at the end of the loop, the connection is closed as
+part of the drop implementation. Browsers sometimes deal with closed
+connections by retrying, because the problem might be temporary. The important
+factor is that we’ve successfully gotten a handle to a TCP connection!
+
Remember to stop the program by pressing ctrl-c when
+you’re done running a particular version of the code. Then restart the program
+by invoking the cargo run command after you’ve made each set of code changes
+to make sure you’re running the newest code.
Let’s implement the functionality to read the request from the browser! To
+separate the concerns of first getting a connection and then taking some action
+with the connection, we’ll start a new function for processing connections. In
+this new handle_connection function, we’ll read data from the TCP stream and
+print it so we can see the data being sent from the browser. Change the code to
+look like Listing 20-2.
+
Filename: src/main.rs
+
use std::{
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let http_request: Vec<_> = buf_reader
+ .lines()
+ .map(|result| result.unwrap())
+ .take_while(|line| !line.is_empty())
+ .collect();
+
+ println!("Request: {http_request:#?}");
+}
+
Listing 20-2: Reading from the TcpStream and printing
+the data
+
We bring std::io::prelude and std::io::BufReader into scope to get access
+to traits and types that let us read from and write to the stream. In the for
+loop in the main function, instead of printing a message that says we made a
+connection, we now call the new handle_connection function and pass the
+stream to it.
+
In the handle_connection function, we create a new BufReader instance that
+wraps a mutable reference to the stream. BufReader adds buffering by
+managing calls to the std::io::Read trait methods for us.
+
We create a variable named http_request to collect the lines of the request
+the browser sends to our server. We indicate that we want to collect these
+lines in a vector by adding the Vec<_> type annotation.
+
BufReader implements the std::io::BufRead trait, which provides the lines
+method. The lines method returns an iterator of Result<String, std::io::Error> by splitting the stream of data whenever it sees a newline
+byte. To get each String, we map and unwrap each Result. The Result
+might be an error if the data isn’t valid UTF-8 or if there was a problem
+reading from the stream. Again, a production program should handle these errors
+more gracefully, but we’re choosing to stop the program in the error case for
+simplicity.
+
The browser signals the end of an HTTP request by sending two newline
+characters in a row, so to get one request from the stream, we take lines until
+we get a line that is the empty string. Once we’ve collected the lines into the
+vector, we’re printing them out using pretty debug formatting so we can take a
+look at the instructions the web browser is sending to our server.
+
Let’s try this code! Start the program and make a request in a web browser
+again. Note that we’ll still get an error page in the browser, but our
+program’s output in the terminal will now look similar to this:
Depending on your browser, you might get slightly different output. Now that
+we’re printing the request data, we can see why we get multiple connections
+from one browser request by looking at the path after GET in the first line
+of the request. If the repeated connections are all requesting /, we know the
+browser is trying to fetch / repeatedly because it’s not getting a response
+from our program.
+
Let’s break down this request data to understand what the browser is asking of
+our program.
The first line is the request line that holds information about what the
+client is requesting. The first part of the request line indicates the method
+being used, such as GET or POST, which describes how the client is making
+this request. Our client used a GET request, which means it is asking for
+information.
+
The next part of the request line is /, which indicates the Uniform Resource
+Identifier(URI) the client is requesting: a URI is almost, but not quite,
+the same as a Uniform Resource Locator(URL). The difference between URIs
+and URLs isn’t important for our purposes in this chapter, but the HTTP spec
+uses the term URI, so we can just mentally substitute URL for URI here.
+
The last part is the HTTP version the client uses, and then the request line
+ends in a CRLF sequence. (CRLF stands for carriage return and line feed,
+which are terms from the typewriter days!) The CRLF sequence can also be
+written as \r\n, where \r is a carriage return and \n is a line feed. The
+CRLF sequence separates the request line from the rest of the request data.
+Note that when the CRLF is printed, we see a new line start rather than \r\n.
+
Looking at the request line data we received from running our program so far,
+we see that GET is the method, / is the request URI, and HTTP/1.1 is the
+version.
+
After the request line, the remaining lines starting from Host: onward are
+headers. GET requests have no body.
+
Try making a request from a different browser or asking for a different
+address, such as 127.0.0.1:7878/test, to see how the request data changes.
+
Now that we know what the browser is asking for, let’s send back some data!
The first line is a status line that contains the HTTP version used in the
+response, a numeric status code that summarizes the result of the request, and
+a reason phrase that provides a text description of the status code. After the
+CRLF sequence are any headers, another CRLF sequence, and the body of the
+response.
+
Here is an example response that uses HTTP version 1.1, has a status code of
+200, an OK reason phrase, no headers, and no body:
+
HTTP/1.1 200 OK\r\n\r\n
+
+
The status code 200 is the standard success response. The text is a tiny
+successful HTTP response. Let’s write this to the stream as our response to a
+successful request! From the handle_connection function, remove the
+println! that was printing the request data and replace it with the code in
+Listing 20-3.
+
Filename: src/main.rs
+
use std::{
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let http_request: Vec<_> = buf_reader
+ .lines()
+ .map(|result| result.unwrap())
+ .take_while(|line| !line.is_empty())
+ .collect();
+
+ let response = "HTTP/1.1 200 OK\r\n\r\n";
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-3: Writing a tiny successful HTTP response to
+the stream
+
The first new line defines the response variable that holds the success
+message’s data. Then we call as_bytes on our response to convert the string
+data to bytes. The write_all method on stream takes a &[u8] and sends
+those bytes directly down the connection. Because the write_all operation
+could fail, we use unwrap on any error result as before. Again, in a real
+application you would add error handling here.
+
With these changes, let’s run our code and make a request. We’re no longer
+printing any data to the terminal, so we won’t see any output other than the
+output from Cargo. When you load 127.0.0.1:7878 in a web browser, you should
+get a blank page instead of an error. You’ve just hand-coded receiving an HTTP
+request and sending a response!
Let’s implement the functionality for returning more than a blank page. Create
+the new file hello.html in the root of your project directory, not in the
+src directory. You can input any HTML you want; Listing 20-4 shows one
+possibility.
Listing 20-4: A sample HTML file to return in a
+response
+
This is a minimal HTML5 document with a heading and some text. To return this
+from the server when a request is received, we’ll modify handle_connection as
+shown in Listing 20-5 to read the HTML file, add it to the response as a body,
+and send it.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+// --snip--
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let http_request: Vec<_> = buf_reader
+ .lines()
+ .map(|result| result.unwrap())
+ .take_while(|line| !line.is_empty())
+ .collect();
+
+ let status_line = "HTTP/1.1 200 OK";
+ let contents = fs::read_to_string("hello.html").unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-5: Sending the contents of hello.html as the
+body of the response
+
We’ve added fs to the use statement to bring the standard library’s
+filesystem module into scope. The code for reading the contents of a file to a
+string should look familiar; we used it in Chapter 12 when we read the contents
+of a file for our I/O project in Listing 12-4.
+
Next, we use format! to add the file’s contents as the body of the success
+response. To ensure a valid HTTP response, we add the Content-Length header
+which is set to the size of our response body, in this case the size of
+hello.html.
+
Run this code with cargo run and load 127.0.0.1:7878 in your browser; you
+should see your HTML rendered!
+
Currently, we’re ignoring the request data in http_request and just sending
+back the contents of the HTML file unconditionally. That means if you try
+requesting 127.0.0.1:7878/something-else in your browser, you’ll still get
+back this same HTML response. At the moment, our server is very limited and
+does not do what most web servers do. We want to customize our responses
+depending on the request and only send back the HTML file for a well-formed
+request to /.
Right now, our web server will return the HTML in the file no matter what the
+client requested. Let’s add functionality to check that the browser is
+requesting / before returning the HTML file and return an error if the
+browser requests anything else. For this we need to modify handle_connection,
+as shown in Listing 20-6. This new code checks the content of the request
+received against what we know a request for / looks like and adds if and
+else blocks to treat requests differently.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+// --snip--
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ if request_line == "GET / HTTP/1.1" {
+ let status_line = "HTTP/1.1 200 OK";
+ let contents = fs::read_to_string("hello.html").unwrap();
+ let length = contents.len();
+
+ let response = format!(
+ "{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}"
+ );
+
+ stream.write_all(response.as_bytes()).unwrap();
+ } else {
+ // some other request
+ }
+}
+
Listing 20-6: Handling requests to / differently from
+other requests
+
We’re only going to be looking at the first line of the HTTP request, so rather
+than reading the entire request into a vector, we’re calling next to get the
+first item from the iterator. The first unwrap takes care of the Option and
+stops the program if the iterator has no items. The second unwrap handles the
+Result and has the same effect as the unwrap that was in the map added in
+Listing 20-2.
+
Next, we check the request_line to see if it equals the request line of a GET
+request to the / path. If it does, the if block returns the contents of our
+HTML file.
+
If the request_line does not equal the GET request to the / path, it
+means we’ve received some other request. We’ll add code to the else block in
+a moment to respond to all other requests.
+
Run this code now and request 127.0.0.1:7878; you should get the HTML in
+hello.html. If you make any other request, such as
+127.0.0.1:7878/something-else, you’ll get a connection error like those you
+saw when running the code in Listing 20-1 and Listing 20-2.
+
Now let’s add the code in Listing 20-7 to the else block to return a response
+with the status code 404, which signals that the content for the request was
+not found. We’ll also return some HTML for a page to render in the browser
+indicating the response to the end user.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ if request_line == "GET / HTTP/1.1" {
+ let status_line = "HTTP/1.1 200 OK";
+ let contents = fs::read_to_string("hello.html").unwrap();
+ let length = contents.len();
+
+ let response = format!(
+ "{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}"
+ );
+
+ stream.write_all(response.as_bytes()).unwrap();
+ // --snip--
+ } else {
+ let status_line = "HTTP/1.1 404 NOT FOUND";
+ let contents = fs::read_to_string("404.html").unwrap();
+ let length = contents.len();
+
+ let response = format!(
+ "{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}"
+ );
+
+ stream.write_all(response.as_bytes()).unwrap();
+ }
+}
+
Listing 20-7: Responding with status code 404 and an
+error page if anything other than / was requested
+
Here, our response has a status line with status code 404 and the reason phrase
+NOT FOUND. The body of the response will be the HTML in the file 404.html.
+You’ll need to create a 404.html file next to hello.html for the error
+page; again feel free to use any HTML you want or use the example HTML in
+Listing 20-8.
Listing 20-8: Sample content for the page to send back
+with any 404 response
+
With these changes, run your server again. Requesting 127.0.0.1:7878 should
+return the contents of hello.html, and any other request, like
+127.0.0.1:7878/foo, should return the error HTML from 404.html.
At the moment the if and else blocks have a lot of repetition: they’re both
+reading files and writing the contents of the files to the stream. The only
+differences are the status line and the filename. Let’s make the code more
+concise by pulling out those differences into separate if and else lines
+that will assign the values of the status line and the filename to variables;
+we can then use those variables unconditionally in the code to read the file
+and write the response. Listing 20-9 shows the resulting code after replacing
+the large if and else blocks.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+// --snip--
+
+fn handle_connection(mut stream: TcpStream) {
+ // --snip--
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = if request_line == "GET / HTTP/1.1" {
+ ("HTTP/1.1 200 OK", "hello.html")
+ } else {
+ ("HTTP/1.1 404 NOT FOUND", "404.html")
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-9: Refactoring the if and else blocks to
+contain only the code that differs between the two cases
+
Now the if and else blocks only return the appropriate values for the
+status line and filename in a tuple; we then use destructuring to assign these
+two values to status_line and filename using a pattern in the let
+statement, as discussed in Chapter 18.
+
The previously duplicated code is now outside the if and else blocks and
+uses the status_line and filename variables. This makes it easier to see
+the difference between the two cases, and it means we have only one place to
+update the code if we want to change how the file reading and response writing
+work. The behavior of the code in Listing 20-9 will be the same as that in
+Listing 20-7.
+
Awesome! We now have a simple web server in approximately 40 lines of Rust code
+that responds to one request with a page of content and responds to all other
+requests with a 404 response.
+
Currently, our server runs in a single thread, meaning it can only serve one
+request at a time. Let’s examine how that can be a problem by simulating some
+slow requests. Then we’ll fix it so our server can handle multiple requests at
+once.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/ch21-02-multithreaded.html b/ch21-02-multithreaded.html
new file mode 100644
index 0000000000..d1690e47cf
--- /dev/null
+++ b/ch21-02-multithreaded.html
@@ -0,0 +1,1441 @@
+
+
+
+
+
+ Turning Our Single-Threaded Server into a Multithreaded Server - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Right now, the server will process each request in turn, meaning it won’t
+process a second connection until the first is finished processing. If the
+server received more and more requests, this serial execution would be less and
+less optimal. If the server receives a request that takes a long time to
+process, subsequent requests will have to wait until the long request is
+finished, even if the new requests can be processed quickly. We’ll need to fix
+this, but first, we’ll look at the problem in action.
We’ll look at how a slow-processing request can affect other requests made to
+our current server implementation. Listing 20-10 implements handling a request
+to /sleep with a simulated slow response that will cause the server to sleep
+for 5 seconds before responding.
Listing 20-10: Simulating a slow request by sleeping for
+5 seconds
+
We switched from if to match now that we have three cases. We need to
+explicitly match on a slice of request_line to pattern match against the
+string literal values; match doesn’t do automatic referencing and
+dereferencing like the equality method does.
+
The first arm is the same as the if block from Listing 20-9. The second arm
+matches a request to /sleep. When that request is received, the server will
+sleep for 5 seconds before rendering the successful HTML page. The third arm is
+the same as the else block from Listing 20-9.
+
You can see how primitive our server is: real libraries would handle the
+recognition of multiple requests in a much less verbose way!
+
Start the server using cargo run. Then open two browser windows: one for
+http://127.0.0.1:7878/ and the other for http://127.0.0.1:7878/sleep. If
+you enter the / URI a few times, as before, you’ll see it respond quickly.
+But if you enter /sleep and then load /, you’ll see that / waits until
+sleep has slept for its full 5 seconds before loading.
+
There are multiple techniques we could use to avoid requests backing up behind
+a slow request; the one we’ll implement is a thread pool.
A thread pool is a group of spawned threads that are waiting and ready to
+handle a task. When the program receives a new task, it assigns one of the
+threads in the pool to the task, and that thread will process the task. The
+remaining threads in the pool are available to handle any other tasks that come
+in while the first thread is processing. When the first thread is done
+processing its task, it’s returned to the pool of idle threads, ready to handle
+a new task. A thread pool allows you to process connections concurrently,
+increasing the throughput of your server.
+
We’ll limit the number of threads in the pool to a small number to protect us
+from Denial of Service (DoS) attacks; if we had our program create a new thread
+for each request as it came in, someone making 10 million requests to our
+server could create havoc by using up all our server’s resources and grinding
+the processing of requests to a halt.
+
Rather than spawning unlimited threads, then, we’ll have a fixed number of
+threads waiting in the pool. Requests that come in are sent to the pool for
+processing. The pool will maintain a queue of incoming requests. Each of the
+threads in the pool will pop off a request from this queue, handle the request,
+and then ask the queue for another request. With this design, we can process up
+to N requests concurrently, where N is the number of threads. If each
+thread is responding to a long-running request, subsequent requests can still
+back up in the queue, but we’ve increased the number of long-running requests
+we can handle before reaching that point.
+
This technique is just one of many ways to improve the throughput of a web
+server. Other options you might explore are the fork/join model, the
+single-threaded async I/O model, or the multi-threaded async I/O model. If
+you’re interested in this topic, you can read more about other solutions and
+try to implement them; with a low-level language like Rust, all of these
+options are possible.
+
Before we begin implementing a thread pool, let’s talk about what using the
+pool should look like. When you’re trying to design code, writing the client
+interface first can help guide your design. Write the API of the code so it’s
+structured in the way you want to call it; then implement the functionality
+within that structure rather than implementing the functionality and then
+designing the public API.
+
Similar to how we used test-driven development in the project in Chapter 12,
+we’ll use compiler-driven development here. We’ll write the code that calls the
+functions we want, and then we’ll look at errors from the compiler to determine
+what we should change next to get the code to work. Before we do that, however,
+we’ll explore the technique we’re not going to use as a starting point.
First, let’s explore how our code might look if it did create a new thread for
+every connection. As mentioned earlier, this isn’t our final plan due to the
+problems with potentially spawning an unlimited number of threads, but it is a
+starting point to get a working multithreaded server first. Then we’ll add the
+thread pool as an improvement, and contrasting the two solutions will be
+easier. Listing 20-11 shows the changes to make to main to spawn a new thread
+to handle each stream within the for loop.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ thread::spawn(|| {
+ handle_connection(stream);
+ });
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-11: Spawning a new thread for each
+stream
+
As you learned in Chapter 16, thread::spawn will create a new thread and then
+run the code in the closure in the new thread. If you run this code and load
+/sleep in your browser, then / in two more browser tabs, you’ll indeed see
+that the requests to / don’t have to wait for /sleep to finish. However, as
+we mentioned, this will eventually overwhelm the system because you’d be making
+new threads without any limit.
We want our thread pool to work in a similar, familiar way so switching from
+threads to a thread pool doesn’t require large changes to the code that uses
+our API. Listing 20-12 shows the hypothetical interface for a ThreadPool
+struct we want to use instead of thread::spawn.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-12: Our ideal ThreadPool interface
+
We use ThreadPool::new to create a new thread pool with a configurable number
+of threads, in this case four. Then, in the for loop, pool.execute has a
+similar interface as thread::spawn in that it takes a closure the pool should
+run for each stream. We need to implement pool.execute so it takes the
+closure and gives it to a thread in the pool to run. This code won’t yet
+compile, but we’ll try so the compiler can guide us in how to fix it.
Make the changes in Listing 20-12 to src/main.rs, and then let’s use the
+compiler errors from cargo check to drive our development. Here is the first
+error we get:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0433]: failed to resolve: use of undeclared type `ThreadPool`
+ --> src/main.rs:11:16
+ |
+11 | let pool = ThreadPool::new(4);
+ | ^^^^^^^^^^ use of undeclared type `ThreadPool`
+
+For more information about this error, try `rustc --explain E0433`.
+error: could not compile `hello` (bin "hello") due to 1 previous error
+
+
Great! This error tells us we need a ThreadPool type or module, so we’ll
+build one now. Our ThreadPool implementation will be independent of the kind
+of work our web server is doing. So, let’s switch the hello crate from a
+binary crate to a library crate to hold our ThreadPool implementation. After
+we change to a library crate, we could also use the separate thread pool
+library for any work we want to do using a thread pool, not just for serving
+web requests.
+
Create a src/lib.rs that contains the following, which is the simplest
+definition of a ThreadPool struct that we can have for now:
+
Filename: src/lib.rs
+
pub struct ThreadPool;
+
Then edit main.rs file to bring ThreadPool into scope from the library
+crate by adding the following code to the top of src/main.rs:
+
Filename: src/main.rs
+
use hello::ThreadPool;
+use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
This code still won’t work, but let’s check it again to get the next error that
+we need to address:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0599]: no function or associated item named `new` found for struct `ThreadPool` in the current scope
+ --> src/main.rs:12:28
+ |
+12 | let pool = ThreadPool::new(4);
+ | ^^^ function or associated item not found in `ThreadPool`
+
+For more information about this error, try `rustc --explain E0599`.
+error: could not compile `hello` (bin "hello") due to 1 previous error
+
+
This error indicates that next we need to create an associated function named
+new for ThreadPool. We also know that new needs to have one parameter
+that can accept 4 as an argument and should return a ThreadPool instance.
+Let’s implement the simplest new function that will have those
+characteristics:
We chose usize as the type of the size parameter, because we know that a
+negative number of threads doesn’t make any sense. We also know we’ll use this
+4 as the number of elements in a collection of threads, which is what the
+usize type is for, as discussed in the “Integer Types” section of Chapter 3.
+
Let’s check the code again:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0599]: no method named `execute` found for struct `ThreadPool` in the current scope
+ --> src/main.rs:17:14
+ |
+17 | pool.execute(|| {
+ | -----^^^^^^^ method not found in `ThreadPool`
+
+For more information about this error, try `rustc --explain E0599`.
+error: could not compile `hello` (bin "hello") due to 1 previous error
+
+
Now the error occurs because we don’t have an execute method on ThreadPool.
+Recall from the “Creating a Finite Number of
+Threads” section that we
+decided our thread pool should have an interface similar to thread::spawn. In
+addition, we’ll implement the execute function so it takes the closure it’s
+given and gives it to an idle thread in the pool to run.
+
We’ll define the execute method on ThreadPool to take a closure as a
+parameter. Recall from the “Moving Captured Values Out of the Closure and the
+Fn Traits” section in Chapter 13 that we can take
+closures as parameters with three different traits: Fn, FnMut, and
+FnOnce. We need to decide which kind of closure to use here. We know we’ll
+end up doing something similar to the standard library thread::spawn
+implementation, so we can look at what bounds the signature of thread::spawn
+has on its parameter. The documentation shows us the following:
The F type parameter is the one we’re concerned with here; the T type
+parameter is related to the return value, and we’re not concerned with that. We
+can see that spawn uses FnOnce as the trait bound on F. This is probably
+what we want as well, because we’ll eventually pass the argument we get in
+execute to spawn. We can be further confident that FnOnce is the trait we
+want to use because the thread for running a request will only execute that
+request’s closure one time, which matches the Once in FnOnce.
+
The F type parameter also has the trait bound Send and the lifetime bound
+'static, which are useful in our situation: we need Send to transfer the
+closure from one thread to another and 'static because we don’t know how long
+the thread will take to execute. Let’s create an execute method on
+ThreadPool that will take a generic parameter of type F with these bounds:
We still use the () after FnOnce because this FnOnce represents a closure
+that takes no parameters and returns the unit type (). Just like function
+definitions, the return type can be omitted from the signature, but even if we
+have no parameters, we still need the parentheses.
+
Again, this is the simplest implementation of the execute method: it does
+nothing, but we’re trying only to make our code compile. Let’s check it again:
It compiles! But note that if you try cargo run and make a request in the
+browser, you’ll see the errors in the browser that we saw at the beginning of
+the chapter. Our library isn’t actually calling the closure passed to execute
+yet!
+
+
Note: A saying you might hear about languages with strict compilers, such as
+Haskell and Rust, is “if the code compiles, it works.” But this saying is not
+universally true. Our project compiles, but it does absolutely nothing! If we
+were building a real, complete project, this would be a good time to start
+writing unit tests to check that the code compiles and has the behavior we
+want.
We aren’t doing anything with the parameters to new and execute. Let’s
+implement the bodies of these functions with the behavior we want. To start,
+let’s think about new. Earlier we chose an unsigned type for the size
+parameter, because a pool with a negative number of threads makes no sense.
+However, a pool with zero threads also makes no sense, yet zero is a perfectly
+valid usize. We’ll add code to check that size is greater than zero before
+we return a ThreadPool instance and have the program panic if it receives a
+zero by using the assert! macro, as shown in Listing 20-13.
+
Filename: src/lib.rs
+
pub struct ThreadPool;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ ThreadPool
+ }
+
+ // --snip--
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
Listing 20-13: Implementing ThreadPool::new to panic if
+size is zero
+
We’ve also added some documentation for our ThreadPool with doc comments.
+Note that we followed good documentation practices by adding a section that
+calls out the situations in which our function can panic, as discussed in
+Chapter 14. Try running cargo doc --open and clicking the ThreadPool struct
+to see what the generated docs for new look like!
+
Instead of adding the assert! macro as we’ve done here, we could change new
+into build and return a Result like we did with Config::build in the I/O
+project in Listing 12-9. But we’ve decided in this case that trying to create a
+thread pool without any threads should be an unrecoverable error. If you’re
+feeling ambitious, try to write a function named build with the following
+signature to compare with the new function:
Now that we have a way to know we have a valid number of threads to store in
+the pool, we can create those threads and store them in the ThreadPool struct
+before returning the struct. But how do we “store” a thread? Let’s take another
+look at the thread::spawn signature:
The spawn function returns a JoinHandle<T>, where T is the type that the
+closure returns. Let’s try using JoinHandle too and see what happens. In our
+case, the closures we’re passing to the thread pool will handle the connection
+and not return anything, so T will be the unit type ().
+
The code in Listing 20-14 will compile but doesn’t create any threads yet.
+We’ve changed the definition of ThreadPool to hold a vector of
+thread::JoinHandle<()> instances, initialized the vector with a capacity of
+size, set up a for loop that will run some code to create the threads, and
+returned a ThreadPool instance containing them.
+
Filename: src/lib.rs
+
use std::thread;
+
+pub struct ThreadPool {
+ threads: Vec<thread::JoinHandle<()>>,
+}
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let mut threads = Vec::with_capacity(size);
+
+ for _ in 0..size {
+ // create some threads and store them in the vector
+ }
+
+ ThreadPool { threads }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
Listing 20-14: Creating a vector for ThreadPool to hold
+the threads
+
We’ve brought std::thread into scope in the library crate, because we’re
+using thread::JoinHandle as the type of the items in the vector in
+ThreadPool.
+
Once a valid size is received, our ThreadPool creates a new vector that can
+hold size items. The with_capacity function performs the same task as
+Vec::new but with an important difference: it preallocates space in the
+vector. Because we know we need to store size elements in the vector, doing
+this allocation up front is slightly more efficient than using Vec::new,
+which resizes itself as elements are inserted.
+
When you run cargo check again, it should succeed.
We left a comment in the for loop in Listing 20-14 regarding the creation of
+threads. Here, we’ll look at how we actually create threads. The standard
+library provides thread::spawn as a way to create threads, and
+thread::spawn expects to get some code the thread should run as soon as the
+thread is created. However, in our case, we want to create the threads and have
+them wait for code that we’ll send later. The standard library’s
+implementation of threads doesn’t include any way to do that; we have to
+implement it manually.
+
We’ll implement this behavior by introducing a new data structure between the
+ThreadPool and the threads that will manage this new behavior. We’ll call
+this data structure Worker, which is a common term in pooling
+implementations. The Worker picks up code that needs to be run and runs the
+code in the Worker’s thread. Think of people working in the kitchen at a
+restaurant: the workers wait until orders come in from customers, and then
+they’re responsible for taking those orders and fulfilling them.
+
Instead of storing a vector of JoinHandle<()> instances in the thread pool,
+we’ll store instances of the Worker struct. Each Worker will store a single
+JoinHandle<()> instance. Then we’ll implement a method on Worker that will
+take a closure of code to run and send it to the already running thread for
+execution. We’ll also give each worker an id so we can distinguish between
+the different workers in the pool when logging or debugging.
+
Here is the new process that will happen when we create a ThreadPool. We’ll
+implement the code that sends the closure to the thread after we have Worker
+set up in this way:
+
+
Define a Worker struct that holds an id and a JoinHandle<()>.
+
Change ThreadPool to hold a vector of Worker instances.
+
Define a Worker::new function that takes an id number and returns a
+Worker instance that holds the id and a thread spawned with an empty
+closure.
+
In ThreadPool::new, use the for loop counter to generate an id, create
+a new Worker with that id, and store the worker in the vector.
+
+
If you’re up for a challenge, try implementing these changes on your own before
+looking at the code in Listing 20-15.
+
Ready? Here is Listing 20-15 with one way to make the preceding modifications.
+
Filename: src/lib.rs
+
use std::thread;
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+}
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id));
+ }
+
+ ThreadPool { workers }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize) -> Worker {
+ let thread = thread::spawn(|| {});
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-15: Modifying ThreadPool to hold Worker
+instances instead of holding threads directly
+
We’ve changed the name of the field on ThreadPool from threads to workers
+because it’s now holding Worker instances instead of JoinHandle<()>
+instances. We use the counter in the for loop as an argument to
+Worker::new, and we store each new Worker in the vector named workers.
+
External code (like our server in src/main.rs) doesn’t need to know the
+implementation details regarding using a Worker struct within ThreadPool,
+so we make the Worker struct and its new function private. The
+Worker::new function uses the id we give it and stores a JoinHandle<()>
+instance that is created by spawning a new thread using an empty closure.
+
+
Note: If the operating system can’t create a thread because there aren’t
+enough system resources, thread::spawn will panic. That will cause our
+whole server to panic, even though the creation of some threads might
+succeed. For simplicity’s sake, this behavior is fine, but in a production
+thread pool implementation, you’d likely want to use
+std::thread::Builder and its
+spawn method that returns Result instead.
+
+
This code will compile and will store the number of Worker instances we
+specified as an argument to ThreadPool::new. But we’re still not processing
+the closure that we get in execute. Let’s look at how to do that next.
The next problem we’ll tackle is that the closures given to thread::spawn do
+absolutely nothing. Currently, we get the closure we want to execute in the
+execute method. But we need to give thread::spawn a closure to run when we
+create each Worker during the creation of the ThreadPool.
+
We want the Worker structs that we just created to fetch the code to run from
+a queue held in the ThreadPool and send that code to its thread to run.
+
The channels we learned about in Chapter 16—a simple way to communicate between
+two threads—would be perfect for this use case. We’ll use a channel to function
+as the queue of jobs, and execute will send a job from the ThreadPool to
+the Worker instances, which will send the job to its thread. Here is the plan:
+
+
The ThreadPool will create a channel and hold on to the sender.
+
Each Worker will hold on to the receiver.
+
We’ll create a new Job struct that will hold the closures we want to send
+down the channel.
+
The execute method will send the job it wants to execute through the
+sender.
+
In its thread, the Worker will loop over its receiver and execute the
+closures of any jobs it receives.
+
+
Let’s start by creating a channel in ThreadPool::new and holding the sender
+in the ThreadPool instance, as shown in Listing 20-16. The Job struct
+doesn’t hold anything for now but will be the type of item we’re sending down
+the channel.
+
Filename: src/lib.rs
+
use std::{sync::mpsc, thread};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+struct Job;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id));
+ }
+
+ ThreadPool { workers, sender }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize) -> Worker {
+ let thread = thread::spawn(|| {});
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-16: Modifying ThreadPool to store the
+sender of a channel that transmits Job instances
+
In ThreadPool::new, we create our new channel and have the pool hold the
+sender. This will successfully compile.
+
Let’s try passing a receiver of the channel into each worker as the thread pool
+creates the channel. We know we want to use the receiver in the thread that the
+workers spawn, so we’ll reference the receiver parameter in the closure. The
+code in Listing 20-17 won’t quite compile yet.
+
Filename: src/lib.rs
+
use std::{sync::mpsc, thread};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+struct Job;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, receiver));
+ }
+
+ ThreadPool { workers, sender }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+// --snip--
+
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: mpsc::Receiver<Job>) -> Worker {
+ let thread = thread::spawn(|| {
+ receiver;
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-17: Passing the receiver to the workers
+
We’ve made some small and straightforward changes: we pass the receiver into
+Worker::new, and then we use it inside the closure.
+
When we try to check this code, we get this error:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0382]: use of moved value: `receiver`
+ --> src/lib.rs:26:42
+ |
+21 | let (sender, receiver) = mpsc::channel();
+ | -------- move occurs because `receiver` has type `std::sync::mpsc::Receiver<Job>`, which does not implement the `Copy` trait
+...
+25 | for id in 0..size {
+ | ----------------- inside of this loop
+26 | workers.push(Worker::new(id, receiver));
+ | ^^^^^^^^ value moved here, in previous iteration of loop
+ |
+note: consider changing this parameter type in method `new` to borrow instead if owning the value isn't necessary
+ --> src/lib.rs:47:33
+ |
+47 | fn new(id: usize, receiver: mpsc::Receiver<Job>) -> Worker {
+ | --- in this method ^^^^^^^^^^^^^^^^^^^ this parameter takes ownership of the value
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `hello` (lib) due to 1 previous error
+
+
The code is trying to pass receiver to multiple Worker instances. This
+won’t work, as you’ll recall from Chapter 16: the channel implementation that
+Rust provides is multiple producer, single consumer. This means we can’t
+just clone the consuming end of the channel to fix this code. We also don’t
+want to send a message multiple times to multiple consumers; we want one list
+of messages with multiple workers such that each message gets processed once.
+
Additionally, taking a job off the channel queue involves mutating the
+receiver, so the threads need a safe way to share and modify receiver;
+otherwise, we might get race conditions (as covered in Chapter 16).
+
Recall the thread-safe smart pointers discussed in Chapter 16: to share
+ownership across multiple threads and allow the threads to mutate the value, we
+need to use Arc<Mutex<T>>. The Arc type will let multiple workers own the
+receiver, and Mutex will ensure that only one worker gets a job from the
+receiver at a time. Listing 20-18 shows the changes we need to make.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+// --snip--
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+struct Job;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+// --snip--
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ // --snip--
+ let thread = thread::spawn(|| {
+ receiver;
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-18: Sharing the receiver among the workers
+using Arc and Mutex
+
In ThreadPool::new, we put the receiver in an Arc and a Mutex. For each
+new worker, we clone the Arc to bump the reference count so the workers can
+share ownership of the receiver.
+
With these changes, the code compiles! We’re getting there!
Let’s finally implement the execute method on ThreadPool. We’ll also change
+Job from a struct to a type alias for a trait object that holds the type of
+closure that execute receives. As discussed in the “Creating Type Synonyms
+with Type Aliases”
+section of Chapter 19, type aliases allow us to make long types shorter for
+ease of use. Look at Listing 20-19.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+// --snip--
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+// --snip--
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(|| {
+ receiver;
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-19: Creating a Job type alias for a Box
+that holds each closure and then sending the job down the channel
+
After creating a new Job instance using the closure we get in execute, we
+send that job down the sending end of the channel. We’re calling unwrap on
+send for the case that sending fails. This might happen if, for example, we
+stop all our threads from executing, meaning the receiving end has stopped
+receiving new messages. At the moment, we can’t stop our threads from
+executing: our threads continue executing as long as the pool exists. The
+reason we use unwrap is that we know the failure case won’t happen, but the
+compiler doesn’t know that.
+
But we’re not quite done yet! In the worker, our closure being passed to
+thread::spawn still only references the receiving end of the channel.
+Instead, we need the closure to loop forever, asking the receiving end of the
+channel for a job and running the job when it gets one. Let’s make the change
+shown in Listing 20-20 to Worker::new.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+// --snip--
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-20: Receiving and executing the jobs in the
+worker’s thread
+
Here, we first call lock on the receiver to acquire the mutex, and then we
+call unwrap to panic on any errors. Acquiring a lock might fail if the mutex
+is in a poisoned state, which can happen if some other thread panicked while
+holding the lock rather than releasing the lock. In this situation, calling
+unwrap to have this thread panic is the correct action to take. Feel free to
+change this unwrap to an expect with an error message that is meaningful to
+you.
+
If we get the lock on the mutex, we call recv to receive a Job from the
+channel. A final unwrap moves past any errors here as well, which might occur
+if the thread holding the sender has shut down, similar to how the send
+method returns Err if the receiver shuts down.
+
The call to recv blocks, so if there is no job yet, the current thread will
+wait until a job becomes available. The Mutex<T> ensures that only one
+Worker thread at a time is trying to request a job.
+
Our thread pool is now in a working state! Give it a cargo run and make some
+requests:
+
+
$ cargo run
+ Compiling hello v0.1.0 (file:///projects/hello)
+warning: field is never read: `workers`
+ --> src/lib.rs:7:5
+ |
+7 | workers: Vec<Worker>,
+ | ^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: `#[warn(dead_code)]` on by default
+
+warning: field is never read: `id`
+ --> src/lib.rs:48:5
+ |
+48 | id: usize,
+ | ^^^^^^^^^
+
+warning: field is never read: `thread`
+ --> src/lib.rs:49:5
+ |
+49 | thread: thread::JoinHandle<()>,
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+warning: `hello` (lib) generated 3 warnings
+ Finished dev [unoptimized + debuginfo] target(s) in 1.40s
+ Running `target/debug/hello`
+Worker 0 got a job; executing.
+Worker 2 got a job; executing.
+Worker 1 got a job; executing.
+Worker 3 got a job; executing.
+Worker 0 got a job; executing.
+Worker 2 got a job; executing.
+Worker 1 got a job; executing.
+Worker 3 got a job; executing.
+Worker 0 got a job; executing.
+Worker 2 got a job; executing.
+
+
Success! We now have a thread pool that executes connections asynchronously.
+There are never more than four threads created, so our system won’t get
+overloaded if the server receives a lot of requests. If we make a request to
+/sleep, the server will be able to serve other requests by having another
+thread run them.
+
+
Note: If you open /sleep in multiple browser windows simultaneously, they
+might load one at a time in 5 second intervals. Some web browsers execute
+multiple instances of the same request sequentially for caching reasons. This
+limitation is not caused by our web server.
+
+
After learning about the while let loop in Chapter 18, you might be wondering
+why we didn’t write the worker thread code as shown in Listing 20-21.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+// --snip--
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || {
+ while let Ok(job) = receiver.lock().unwrap().recv() {
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ }
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-21: An alternative implementation of
+Worker::new using while let
+
This code compiles and runs but doesn’t result in the desired threading
+behavior: a slow request will still cause other requests to wait to be
+processed. The reason is somewhat subtle: the Mutex struct has no public
+unlock method because the ownership of the lock is based on the lifetime of
+the MutexGuard<T> within the LockResult<MutexGuard<T>> that the lock
+method returns. At compile time, the borrow checker can then enforce the rule
+that a resource guarded by a Mutex cannot be accessed unless we hold the
+lock. However, this implementation can also result in the lock being held
+longer than intended if we aren’t mindful of the lifetime of the
+MutexGuard<T>.
+
The code in Listing 20-20 that uses let job = receiver.lock().unwrap().recv().unwrap(); works because with let, any
+temporary values used in the expression on the right hand side of the equals
+sign are immediately dropped when the let statement ends. However, while let (and if let and match) does not drop temporary values until the end of
+the associated block. In Listing 20-21, the lock remains held for the duration
+of the call to job(), meaning other workers cannot receive jobs.
The code in Listing 20-20 is responding to requests asynchronously through the
+use of a thread pool, as we intended. We get some warnings about the workers,
+id, and thread fields that we’re not using in a direct way that reminds us
+we’re not cleaning up anything. When we use the less elegant
+ctrl-c method to halt the main thread, all other threads
+are stopped immediately as well, even if they’re in the middle of serving a
+request.
+
Next, then, we’ll implement the Drop trait to call join on each of the
+threads in the pool so they can finish the requests they’re working on before
+closing. Then we’ll implement a way to tell the threads they should stop
+accepting new requests and shut down. To see this code in action, we’ll modify
+our server to accept only two requests before gracefully shutting down its
+thread pool.
Let’s start with implementing Drop on our thread pool. When the pool is
+dropped, our threads should all join to make sure they finish their work.
+Listing 20-22 shows a first attempt at a Drop implementation; this code won’t
+quite work yet.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ worker.thread.join().unwrap();
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-22: Joining each thread when the thread pool
+goes out of scope
+
First, we loop through each of the thread pool workers. We use &mut for
+this because self is a mutable reference, and we also need to be able to
+mutate worker. For each worker, we print a message saying that this
+particular worker is shutting down, and then we call join on that worker’s
+thread. If the call to join fails, we use unwrap to make Rust panic and go
+into an ungraceful shutdown.
+
Here is the error we get when we compile this code:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0507]: cannot move out of `worker.thread` which is behind a mutable reference
+ --> src/lib.rs:52:13
+ |
+52 | worker.thread.join().unwrap();
+ | ^^^^^^^^^^^^^ ------ `worker.thread` moved due to this method call
+ | |
+ | move occurs because `worker.thread` has type `JoinHandle<()>`, which does not implement the `Copy` trait
+ |
+note: `JoinHandle::<T>::join` takes ownership of the receiver `self`, which moves `worker.thread`
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/thread/mod.rs:1657:17
+
+For more information about this error, try `rustc --explain E0507`.
+error: could not compile `hello` (lib) due to 1 previous error
+
+
The error tells us we can’t call join because we only have a mutable borrow
+of each worker and join takes ownership of its argument. To solve this
+issue, we need to move the thread out of the Worker instance that owns
+thread so join can consume the thread. We did this in Listing 17-15: if
+Worker holds an Option<thread::JoinHandle<()>> instead, we can call the
+take method on the Option to move the value out of the Some variant and
+leave a None variant in its place. In other words, a Worker that is running
+will have a Some variant in thread, and when we want to clean up a
+Worker, we’ll replace Some with None so the Worker doesn’t have a
+thread to run.
+
So we know we want to update the definition of Worker like this:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ worker.thread.join().unwrap();
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker { id, thread }
+ }
+}
+
Now let’s lean on the compiler to find the other places that need to change.
+Checking this code, we get two errors:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0599]: no method named `join` found for enum `Option` in the current scope
+ --> src/lib.rs:52:27
+ |
+52 | worker.thread.join().unwrap();
+ | ^^^^ method not found in `Option<JoinHandle<()>>`
+ |
+note: the method `join` exists on the type `JoinHandle<()>`
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/thread/mod.rs:1657:5
+help: consider using `Option::expect` to unwrap the `JoinHandle<()>` value, panicking if the value is an `Option::None`
+ |
+52 | worker.thread.expect("REASON").join().unwrap();
+ | +++++++++++++++++
+
+error[E0308]: mismatched types
+ --> src/lib.rs:72:22
+ |
+72 | Worker { id, thread }
+ | ^^^^^^ expected `Option<JoinHandle<()>>`, found `JoinHandle<_>`
+ |
+ = note: expected enum `Option<JoinHandle<()>>`
+ found struct `JoinHandle<_>`
+help: try wrapping the expression in `Some`
+ |
+72 | Worker { id, thread: Some(thread) }
+ | +++++++++++++ +
+
+Some errors have detailed explanations: E0308, E0599.
+For more information about an error, try `rustc --explain E0308`.
+error: could not compile `hello` (lib) due to 2 previous errors
+
+
Let’s address the second error, which points to the code at the end of
+Worker::new; we need to wrap the thread value in Some when we create a
+new Worker. Make the following changes to fix this error:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ worker.thread.join().unwrap();
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ // --snip--
+
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
The first error is in our Drop implementation. We mentioned earlier that we
+intended to call take on the Option value to move thread out of worker.
+The following changes will do so:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
As discussed in Chapter 17, the take method on Option takes the Some
+variant out and leaves None in its place. We’re using if let to destructure
+the Some and get the thread; then we call join on the thread. If a worker’s
+thread is already None, we know that worker has already had its thread
+cleaned up, so nothing happens in that case.
With all the changes we’ve made, our code compiles without any warnings.
+However, the bad news is this code doesn’t function the way we want it to yet.
+The key is the logic in the closures run by the threads of the Worker
+instances: at the moment, we call join, but that won’t shut down the threads
+because they loop forever looking for jobs. If we try to drop our
+ThreadPool with our current implementation of drop, the main thread will
+block forever waiting for the first thread to finish.
+
To fix this problem, we’ll need a change in the ThreadPooldrop
+implementation and then a change in the Worker loop.
+
First, we’ll change the ThreadPooldrop implementation to explicitly drop
+the sender before waiting for the threads to finish. Listing 20-23 shows the
+changes to ThreadPool to explicitly drop sender. We use the same Option
+and take technique as we did with the thread to be able to move sender out
+of ThreadPool:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: Option<mpsc::Sender<Job>>,
+}
+// --snip--
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ // --snip--
+
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool {
+ workers,
+ sender: Some(sender),
+ }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.as_ref().unwrap().send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ drop(self.sender.take());
+
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
Listing 20-23: Explicitly drop sender before joining
+the worker threads
+
Dropping sender closes the channel, which indicates no more messages will be
+sent. When that happens, all the calls to recv that the workers do in the
+infinite loop will return an error. In Listing 20-24, we change the Worker
+loop to gracefully exit the loop in that case, which means the threads will
+finish when the ThreadPooldrop implementation calls join on them.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: Option<mpsc::Sender<Job>>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool {
+ workers,
+ sender: Some(sender),
+ }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.as_ref().unwrap().send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ drop(self.sender.take());
+
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let message = receiver.lock().unwrap().recv();
+
+ match message {
+ Ok(job) => {
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ }
+ Err(_) => {
+ println!("Worker {id} disconnected; shutting down.");
+ break;
+ }
+ }
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
Listing 20-24: Explicitly break out of the loop when
+recv returns an error
+
To see this code in action, let’s modify main to accept only two requests
+before gracefully shutting down the server, as shown in Listing 20-25.
+
Filename: src/main.rs
+
use hello::ThreadPool;
+use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming().take(2) {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+
+ println!("Shutting down.");
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-25: Shut down the server after serving two
+requests by exiting the loop
+
You wouldn’t want a real-world web server to shut down after serving only two
+requests. This code just demonstrates that the graceful shutdown and cleanup is
+in working order.
+
The take method is defined in the Iterator trait and limits the iteration
+to the first two items at most. The ThreadPool will go out of scope at the
+end of main, and the drop implementation will run.
+
Start the server with cargo run, and make three requests. The third request
+should error, and in your terminal you should see output similar to this:
+
+
$ cargo run
+ Compiling hello v0.1.0 (file:///projects/hello)
+ Finished dev [unoptimized + debuginfo] target(s) in 1.0s
+ Running `target/debug/hello`
+Worker 0 got a job; executing.
+Shutting down.
+Shutting down worker 0
+Worker 3 got a job; executing.
+Worker 1 disconnected; shutting down.
+Worker 2 disconnected; shutting down.
+Worker 3 disconnected; shutting down.
+Worker 0 disconnected; shutting down.
+Shutting down worker 1
+Shutting down worker 2
+Shutting down worker 3
+
+
You might see a different ordering of workers and messages printed. We can see
+how this code works from the messages: workers 0 and 3 got the first two
+requests. The server stopped accepting connections after the second connection,
+and the Drop implementation on ThreadPool starts executing before worker 3
+even starts its job. Dropping the sender disconnects all the workers and
+tells them to shut down. The workers each print a message when they disconnect,
+and then the thread pool calls join to wait for each worker thread to finish.
+
Notice one interesting aspect of this particular execution: the ThreadPool
+dropped the sender, and before any worker received an error, we tried to join
+worker 0. Worker 0 had not yet gotten an error from recv, so the main thread
+blocked waiting for worker 0 to finish. In the meantime, worker 3 received a
+job and then all threads received an error. When worker 0 finished, the main
+thread waited for the rest of the workers to finish. At that point, they had
+all exited their loops and stopped.
+
Congrats! We’ve now completed our project; we have a basic web server that uses
+a thread pool to respond asynchronously. We’re able to perform a graceful
+shutdown of the server, which cleans up all the threads in the pool.
+
Here’s the full code for reference:
+
Filename: src/main.rs
+
use hello::ThreadPool;
+use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming().take(2) {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+
+ println!("Shutting down.");
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: Option<mpsc::Sender<Job>>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool {
+ workers,
+ sender: Some(sender),
+ }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.as_ref().unwrap().send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ drop(self.sender.take());
+
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let message = receiver.lock().unwrap().recv();
+
+ match message {
+ Ok(job) => {
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ }
+ Err(_) => {
+ println!("Worker {id} disconnected; shutting down.");
+ break;
+ }
+ }
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
We could do more here! If you want to continue enhancing this project, here are
+some ideas:
+
+
Add more documentation to ThreadPool and its public methods.
+
Add tests of the library’s functionality.
+
Change calls to unwrap to more robust error handling.
+
Use ThreadPool to perform some task other than serving web requests.
+
Find a thread pool crate on crates.io and implement a
+similar web server using the crate instead. Then compare its API and
+robustness to the thread pool we implemented.
Well done! You’ve made it to the end of the book! We want to thank you for
+joining us on this tour of Rust. You’re now ready to implement your own Rust
+projects and help with other peoples’ projects. Keep in mind that there is a
+welcoming community of other Rustaceans who would love to help you with any
+challenges you encounter on your Rust journey.
-
-
diff --git a/fonts/OPEN-SANS-LICENSE.txt b/fonts/OPEN-SANS-LICENSE.txt
new file mode 100644
index 0000000000..d645695673
--- /dev/null
+++ b/fonts/OPEN-SANS-LICENSE.txt
@@ -0,0 +1,202 @@
+
+ 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/fonts/SOURCE-CODE-PRO-LICENSE.txt b/fonts/SOURCE-CODE-PRO-LICENSE.txt
new file mode 100644
index 0000000000..366206f549
--- /dev/null
+++ b/fonts/SOURCE-CODE-PRO-LICENSE.txt
@@ -0,0 +1,93 @@
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/fonts/fonts.css b/fonts/fonts.css
new file mode 100644
index 0000000000..858efa5980
--- /dev/null
+++ b/fonts/fonts.css
@@ -0,0 +1,100 @@
+/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
+/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
+
+/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 300;
+ src: local('Open Sans Light'), local('OpenSans-Light'),
+ url('open-sans-v17-all-charsets-300.woff2') format('woff2');
+}
+
+/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 300;
+ src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
+ url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
+}
+
+/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 400;
+ src: local('Open Sans Regular'), local('OpenSans-Regular'),
+ url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
+}
+
+/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 400;
+ src: local('Open Sans Italic'), local('OpenSans-Italic'),
+ url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
+}
+
+/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 600;
+ src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
+ url('open-sans-v17-all-charsets-600.woff2') format('woff2');
+}
+
+/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 600;
+ src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
+ url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
+}
+
+/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 700;
+ src: local('Open Sans Bold'), local('OpenSans-Bold'),
+ url('open-sans-v17-all-charsets-700.woff2') format('woff2');
+}
+
+/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 700;
+ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
+ url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
+}
+
+/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
+ url('open-sans-v17-all-charsets-800.woff2') format('woff2');
+}
+
+/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
+ url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
+}
+
+/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Source Code Pro';
+ font-style: normal;
+ font-weight: 500;
+ src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
+}
diff --git a/fonts/open-sans-v17-all-charsets-300.woff2 b/fonts/open-sans-v17-all-charsets-300.woff2
new file mode 100644
index 0000000000..9f51be370f
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-300italic.woff2 b/fonts/open-sans-v17-all-charsets-300italic.woff2
new file mode 100644
index 0000000000..2f54544841
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600.woff2 b/fonts/open-sans-v17-all-charsets-600.woff2
new file mode 100644
index 0000000000..f503d558d5
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600italic.woff2 b/fonts/open-sans-v17-all-charsets-600italic.woff2
new file mode 100644
index 0000000000..c99aabe803
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700.woff2 b/fonts/open-sans-v17-all-charsets-700.woff2
new file mode 100644
index 0000000000..421a1ab25f
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700italic.woff2 b/fonts/open-sans-v17-all-charsets-700italic.woff2
new file mode 100644
index 0000000000..12ce3d20d1
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800.woff2 b/fonts/open-sans-v17-all-charsets-800.woff2
new file mode 100644
index 0000000000..c94a223b03
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800italic.woff2 b/fonts/open-sans-v17-all-charsets-800italic.woff2
new file mode 100644
index 0000000000..eed7d3c63d
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-italic.woff2 b/fonts/open-sans-v17-all-charsets-italic.woff2
new file mode 100644
index 0000000000..398b68a085
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-regular.woff2 b/fonts/open-sans-v17-all-charsets-regular.woff2
new file mode 100644
index 0000000000..8383e94c65
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-regular.woff2 differ
diff --git a/fonts/source-code-pro-v11-all-charsets-500.woff2 b/fonts/source-code-pro-v11-all-charsets-500.woff2
new file mode 100644
index 0000000000..722245682f
Binary files /dev/null and b/fonts/source-code-pro-v11-all-charsets-500.woff2 differ
diff --git a/foreword.html b/foreword.html
new file mode 100644
index 0000000000..72eb1ff9da
--- /dev/null
+++ b/foreword.html
@@ -0,0 +1,269 @@
+
+
+
+
+
+ Foreword - The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
It wasn’t always so clear, but the Rust programming language is fundamentally
+about empowerment: no matter what kind of code you are writing now, Rust
+empowers you to reach farther, to program with confidence in a wider variety of
+domains than you did before.
+
Take, for example, “systems-level” work that deals with low-level details of
+memory management, data representation, and concurrency. Traditionally, this
+realm of programming is seen as arcane, accessible only to a select few who
+have devoted the necessary years learning to avoid its infamous pitfalls. And
+even those who practice it do so with caution, lest their code be open to
+exploits, crashes, or corruption.
+
Rust breaks down these barriers by eliminating the old pitfalls and providing a
+friendly, polished set of tools to help you along the way. Programmers who need
+to “dip down” into lower-level control can do so with Rust, without taking on
+the customary risk of crashes or security holes, and without having to learn
+the fine points of a fickle toolchain. Better yet, the language is designed to
+guide you naturally towards reliable code that is efficient in terms of speed
+and memory usage.
+
Programmers who are already working with low-level code can use Rust to raise
+their ambitions. For example, introducing parallelism in Rust is a relatively
+low-risk operation: the compiler will catch the classical mistakes for you. And
+you can tackle more aggressive optimizations in your code with the confidence
+that you won’t accidentally introduce crashes or vulnerabilities.
+
But Rust isn’t limited to low-level systems programming. It’s expressive and
+ergonomic enough to make CLI apps, web servers, and many other kinds of code
+quite pleasant to write — you’ll find simple examples of both later in the
+book. Working with Rust allows you to build skills that transfer from one
+domain to another; you can learn Rust by writing a web app, then apply those
+same skills to target your Raspberry Pi.
+
This book fully embraces the potential of Rust to empower its users. It’s a
+friendly and approachable text intended to help you level up not just your
+knowledge of Rust, but also your reach and confidence as a programmer in
+general. So dive in, get ready to learn—and welcome to the Rust community!
+
— Nicholas Matsakis and Aaron Turon
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/highlight.css b/highlight.css
new file mode 100644
index 0000000000..ba57b82b27
--- /dev/null
+++ b/highlight.css
@@ -0,0 +1,82 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/highlight.js b/highlight.js
new file mode 100644
index 0000000000..18d24345bd
--- /dev/null
+++ b/highlight.js
@@ -0,0 +1,54 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset"}function u(e){s+=""}function d(e){("start"===e.event?c:u)(e.node)}for(;e.length||n.length;){var g=l();if(s+=t(r.substring(i,g[0].offset)),i=g[0].offset,g===e){o.reverse().forEach(u);do{d(g.splice(0,1)[0]),g=l()}while(g===e&&g.length&&g[0].offset===i);o.reverse().forEach(c)}else"start"===g[0].event?o.push(g[0].node):o.pop(),d(g.splice(0,1)[0])}return s+t(r.substr(i))}});const s="",o=e=>!!e.kind;class l{constructor(e,n){this.buffer="",this.classPrefix=n.classPrefix,e.walk(this)}addText(e){this.buffer+=t(e)}openNode(e){if(!o(e))return;let n=e.kind;e.sublanguage||(n=`${this.classPrefix}${n}`),this.span(n)}closeNode(e){o(e)&&(this.buffer+=s)}value(){return this.buffer}span(e){this.buffer+=``}}class c{constructor(){this.rootNode={children:[]},this.stack=[this.rootNode]}get top(){return this.stack[this.stack.length-1]}get root(){return this.rootNode}add(e){this.top.children.push(e)}openNode(e){const n={kind:e,children:[]};this.add(n),this.stack.push(n)}closeNode(){if(this.stack.length>1)return this.stack.pop()}closeAllNodes(){for(;this.closeNode(););}toJSON(){return JSON.stringify(this.rootNode,null,4)}walk(e){return this.constructor._walk(e,this.rootNode)}static _walk(e,n){return"string"==typeof n?e.addText(n):n.children&&(e.openNode(n),n.children.forEach(n=>this._walk(e,n)),e.closeNode(n)),e}static _collapse(e){"string"!=typeof e&&e.children&&(e.children.every(e=>"string"==typeof e)?e.children=[e.children.join("")]:e.children.forEach(e=>{c._collapse(e)}))}}class u extends c{constructor(e){super(),this.options=e}addKeyword(e,n){""!==e&&(this.openNode(n),this.addText(e),this.closeNode())}addText(e){""!==e&&this.add(e)}addSublanguage(e,n){const t=e.root;t.kind=n,t.sublanguage=!0,this.add(t)}toHTML(){return new l(this,this.options).value()}finalize(){return!0}}function d(e){return e?"string"==typeof e?e:e.source:null}const g="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",h={begin:"\\\\[\\s\\S]",relevance:0},f={className:"string",begin:"'",end:"'",illegal:"\\n",contains:[h]},p={className:"string",begin:'"',end:'"',illegal:"\\n",contains:[h]},b={begin:/\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/},m=function(e,n,t={}){var a=r({className:"comment",begin:e,end:n,contains:[]},t);return a.contains.push(b),a.contains.push({className:"doctag",begin:"(?:TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):",relevance:0}),a},v=m("//","$"),x=m("/\\*","\\*/"),E=m("#","$");var _=Object.freeze({__proto__:null,IDENT_RE:"[a-zA-Z]\\w*",UNDERSCORE_IDENT_RE:"[a-zA-Z_]\\w*",NUMBER_RE:"\\b\\d+(\\.\\d+)?",C_NUMBER_RE:g,BINARY_NUMBER_RE:"\\b(0b[01]+)",RE_STARTERS_RE:"!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~",SHEBANG:(e={})=>{const n=/^#![ ]*\//;return e.binary&&(e.begin=function(...e){return e.map(e=>d(e)).join("")}(n,/.*\b/,e.binary,/\b.*/)),r({className:"meta",begin:n,end:/$/,relevance:0,"on:begin":(e,n)=>{0!==e.index&&n.ignoreMatch()}},e)},BACKSLASH_ESCAPE:h,APOS_STRING_MODE:f,QUOTE_STRING_MODE:p,PHRASAL_WORDS_MODE:b,COMMENT:m,C_LINE_COMMENT_MODE:v,C_BLOCK_COMMENT_MODE:x,HASH_COMMENT_MODE:E,NUMBER_MODE:{className:"number",begin:"\\b\\d+(\\.\\d+)?",relevance:0},C_NUMBER_MODE:{className:"number",begin:g,relevance:0},BINARY_NUMBER_MODE:{className:"number",begin:"\\b(0b[01]+)",relevance:0},CSS_NUMBER_MODE:{className:"number",begin:"\\b\\d+(\\.\\d+)?(%|em|ex|ch|rem|vw|vh|vmin|vmax|cm|mm|in|pt|pc|px|deg|grad|rad|turn|s|ms|Hz|kHz|dpi|dpcm|dppx)?",relevance:0},REGEXP_MODE:{begin:/(?=\/[^/\n]*\/)/,contains:[{className:"regexp",begin:/\//,end:/\/[gimuy]*/,illegal:/\n/,contains:[h,{begin:/\[/,end:/\]/,relevance:0,contains:[h]}]}]},TITLE_MODE:{className:"title",begin:"[a-zA-Z]\\w*",relevance:0},UNDERSCORE_TITLE_MODE:{className:"title",begin:"[a-zA-Z_]\\w*",relevance:0},METHOD_GUARD:{begin:"\\.\\s*[a-zA-Z_]\\w*",relevance:0},END_SAME_AS_BEGIN:function(e){return Object.assign(e,{"on:begin":(e,n)=>{n.data._beginMatch=e[1]},"on:end":(e,n)=>{n.data._beginMatch!==e[1]&&n.ignoreMatch()}})}}),N="of and for in not or if then".split(" ");function w(e,n){return n?+n:function(e){return N.includes(e.toLowerCase())}(e)?0:1}const R=t,y=r,{nodeStream:k,mergeStreams:O}=i,M=Symbol("nomatch");return function(t){var a=[],i={},s={},o=[],l=!0,c=/(^(<[^>]+>|\t|)+|\n)/gm,g="Could not find the language '{}', did you forget to load/include a language module?";const h={disableAutodetect:!0,name:"Plain text",contains:[]};var f={noHighlightRe:/^(no-?highlight)$/i,languageDetectRe:/\blang(?:uage)?-([\w-]+)\b/i,classPrefix:"hljs-",tabReplace:null,useBR:!1,languages:null,__emitter:u};function p(e){return f.noHighlightRe.test(e)}function b(e,n,t,r){var a={code:n,language:e};S("before:highlight",a);var i=a.result?a.result:m(a.language,a.code,t,r);return i.code=a.code,S("after:highlight",i),i}function m(e,t,a,s){var o=t;function c(e,n){var t=E.case_insensitive?n[0].toLowerCase():n[0];return Object.prototype.hasOwnProperty.call(e.keywords,t)&&e.keywords[t]}function u(){null!=y.subLanguage?function(){if(""!==A){var e=null;if("string"==typeof y.subLanguage){if(!i[y.subLanguage])return void O.addText(A);e=m(y.subLanguage,A,!0,k[y.subLanguage]),k[y.subLanguage]=e.top}else e=v(A,y.subLanguage.length?y.subLanguage:null);y.relevance>0&&(I+=e.relevance),O.addSublanguage(e.emitter,e.language)}}():function(){if(!y.keywords)return void O.addText(A);let e=0;y.keywordPatternRe.lastIndex=0;let n=y.keywordPatternRe.exec(A),t="";for(;n;){t+=A.substring(e,n.index);const r=c(y,n);if(r){const[e,a]=r;O.addText(t),t="",I+=a,O.addKeyword(n[0],e)}else t+=n[0];e=y.keywordPatternRe.lastIndex,n=y.keywordPatternRe.exec(A)}t+=A.substr(e),O.addText(t)}(),A=""}function h(e){return e.className&&O.openNode(e.className),y=Object.create(e,{parent:{value:y}})}function p(e){return 0===y.matcher.regexIndex?(A+=e[0],1):(L=!0,0)}var b={};function x(t,r){var i=r&&r[0];if(A+=t,null==i)return u(),0;if("begin"===b.type&&"end"===r.type&&b.index===r.index&&""===i){if(A+=o.slice(r.index,r.index+1),!l){const n=Error("0 width match regex");throw n.languageName=e,n.badRule=b.rule,n}return 1}if(b=r,"begin"===r.type)return function(e){var t=e[0],r=e.rule;const a=new n(r),i=[r.__beforeBegin,r["on:begin"]];for(const n of i)if(n&&(n(e,a),a.ignore))return p(t);return r&&r.endSameAsBegin&&(r.endRe=RegExp(t.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&"),"m")),r.skip?A+=t:(r.excludeBegin&&(A+=t),u(),r.returnBegin||r.excludeBegin||(A=t)),h(r),r.returnBegin?0:t.length}(r);if("illegal"===r.type&&!a){const e=Error('Illegal lexeme "'+i+'" for mode "'+(y.className||"")+'"');throw e.mode=y,e}if("end"===r.type){var s=function(e){var t=e[0],r=o.substr(e.index),a=function e(t,r,a){let i=function(e,n){var t=e&&e.exec(n);return t&&0===t.index}(t.endRe,a);if(i){if(t["on:end"]){const e=new n(t);t["on:end"](r,e),e.ignore&&(i=!1)}if(i){for(;t.endsParent&&t.parent;)t=t.parent;return t}}if(t.endsWithParent)return e(t.parent,r,a)}(y,e,r);if(!a)return M;var i=y;i.skip?A+=t:(i.returnEnd||i.excludeEnd||(A+=t),u(),i.excludeEnd&&(A=t));do{y.className&&O.closeNode(),y.skip||y.subLanguage||(I+=y.relevance),y=y.parent}while(y!==a.parent);return a.starts&&(a.endSameAsBegin&&(a.starts.endRe=a.endRe),h(a.starts)),i.returnEnd?0:t.length}(r);if(s!==M)return s}if("illegal"===r.type&&""===i)return 1;if(B>1e5&&B>3*r.index)throw Error("potential infinite loop, way more iterations than matches");return A+=i,i.length}var E=T(e);if(!E)throw console.error(g.replace("{}",e)),Error('Unknown language: "'+e+'"');var _=function(e){function n(n,t){return RegExp(d(n),"m"+(e.case_insensitive?"i":"")+(t?"g":""))}class t{constructor(){this.matchIndexes={},this.regexes=[],this.matchAt=1,this.position=0}addRule(e,n){n.position=this.position++,this.matchIndexes[this.matchAt]=n,this.regexes.push([n,e]),this.matchAt+=function(e){return RegExp(e.toString()+"|").exec("").length-1}(e)+1}compile(){0===this.regexes.length&&(this.exec=()=>null);const e=this.regexes.map(e=>e[1]);this.matcherRe=n(function(e,n="|"){for(var t=/\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./,r=0,a="",i=0;i0&&(a+=n),a+="(";o.length>0;){var l=t.exec(o);if(null==l){a+=o;break}a+=o.substring(0,l.index),o=o.substring(l.index+l[0].length),"\\"===l[0][0]&&l[1]?a+="\\"+(+l[1]+s):(a+=l[0],"("===l[0]&&r++)}a+=")"}return a}(e),!0),this.lastIndex=0}exec(e){this.matcherRe.lastIndex=this.lastIndex;const n=this.matcherRe.exec(e);if(!n)return null;const t=n.findIndex((e,n)=>n>0&&void 0!==e),r=this.matchIndexes[t];return n.splice(0,t),Object.assign(n,r)}}class a{constructor(){this.rules=[],this.multiRegexes=[],this.count=0,this.lastIndex=0,this.regexIndex=0}getMatcher(e){if(this.multiRegexes[e])return this.multiRegexes[e];const n=new t;return this.rules.slice(e).forEach(([e,t])=>n.addRule(e,t)),n.compile(),this.multiRegexes[e]=n,n}considerAll(){this.regexIndex=0}addRule(e,n){this.rules.push([e,n]),"begin"===n.type&&this.count++}exec(e){const n=this.getMatcher(this.regexIndex);n.lastIndex=this.lastIndex;const t=n.exec(e);return t&&(this.regexIndex+=t.position+1,this.regexIndex===this.count&&(this.regexIndex=0)),t}}function i(e,n){const t=e.input[e.index-1],r=e.input[e.index+e[0].length];"."!==t&&"."!==r||n.ignoreMatch()}if(e.contains&&e.contains.includes("self"))throw Error("ERR: contains `self` is not supported at the top-level of a language. See documentation.");return function t(s,o){const l=s;if(s.compiled)return l;s.compiled=!0,s.__beforeBegin=null,s.keywords=s.keywords||s.beginKeywords;let c=null;if("object"==typeof s.keywords&&(c=s.keywords.$pattern,delete s.keywords.$pattern),s.keywords&&(s.keywords=function(e,n){var t={};return"string"==typeof e?r("keyword",e):Object.keys(e).forEach((function(n){r(n,e[n])})),t;function r(e,r){n&&(r=r.toLowerCase()),r.split(" ").forEach((function(n){var r=n.split("|");t[r[0]]=[e,w(r[0],r[1])]}))}}(s.keywords,e.case_insensitive)),s.lexemes&&c)throw Error("ERR: Prefer `keywords.$pattern` to `mode.lexemes`, BOTH are not allowed. (see mode reference) ");return l.keywordPatternRe=n(s.lexemes||c||/\w+/,!0),o&&(s.beginKeywords&&(s.begin="\\b("+s.beginKeywords.split(" ").join("|")+")(?=\\b|\\s)",s.__beforeBegin=i),s.begin||(s.begin=/\B|\b/),l.beginRe=n(s.begin),s.endSameAsBegin&&(s.end=s.begin),s.end||s.endsWithParent||(s.end=/\B|\b/),s.end&&(l.endRe=n(s.end)),l.terminator_end=d(s.end)||"",s.endsWithParent&&o.terminator_end&&(l.terminator_end+=(s.end?"|":"")+o.terminator_end)),s.illegal&&(l.illegalRe=n(s.illegal)),void 0===s.relevance&&(s.relevance=1),s.contains||(s.contains=[]),s.contains=[].concat(...s.contains.map((function(e){return function(e){return e.variants&&!e.cached_variants&&(e.cached_variants=e.variants.map((function(n){return r(e,{variants:null},n)}))),e.cached_variants?e.cached_variants:function e(n){return!!n&&(n.endsWithParent||e(n.starts))}(e)?r(e,{starts:e.starts?r(e.starts):null}):Object.isFrozen(e)?r(e):e}("self"===e?s:e)}))),s.contains.forEach((function(e){t(e,l)})),s.starts&&t(s.starts,o),l.matcher=function(e){const n=new a;return e.contains.forEach(e=>n.addRule(e.begin,{rule:e,type:"begin"})),e.terminator_end&&n.addRule(e.terminator_end,{type:"end"}),e.illegal&&n.addRule(e.illegal,{type:"illegal"}),n}(l),l}(e)}(E),N="",y=s||_,k={},O=new f.__emitter(f);!function(){for(var e=[],n=y;n!==E;n=n.parent)n.className&&e.unshift(n.className);e.forEach(e=>O.openNode(e))}();var A="",I=0,S=0,B=0,L=!1;try{for(y.matcher.considerAll();;){B++,L?L=!1:(y.matcher.lastIndex=S,y.matcher.considerAll());const e=y.matcher.exec(o);if(!e)break;const n=x(o.substring(S,e.index),e);S=e.index+n}return x(o.substr(S)),O.closeAllNodes(),O.finalize(),N=O.toHTML(),{relevance:I,value:N,language:e,illegal:!1,emitter:O,top:y}}catch(n){if(n.message&&n.message.includes("Illegal"))return{illegal:!0,illegalBy:{msg:n.message,context:o.slice(S-100,S+100),mode:n.mode},sofar:N,relevance:0,value:R(o),emitter:O};if(l)return{illegal:!1,relevance:0,value:R(o),emitter:O,language:e,top:y,errorRaised:n};throw n}}function v(e,n){n=n||f.languages||Object.keys(i);var t=function(e){const n={relevance:0,emitter:new f.__emitter(f),value:R(e),illegal:!1,top:h};return n.emitter.addText(e),n}(e),r=t;return n.filter(T).filter(I).forEach((function(n){var a=m(n,e,!1);a.language=n,a.relevance>r.relevance&&(r=a),a.relevance>t.relevance&&(r=t,t=a)})),r.language&&(t.second_best=r),t}function x(e){return f.tabReplace||f.useBR?e.replace(c,e=>"\n"===e?f.useBR?" ":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(//g,"\n"):n=e;const r=n.textContent,a=t?b(t,r,!0):v(r),i=k(n);if(i.length){const e=document.createElement("div");e.innerHTML=a.value,a.value=O(i,k(e),r)}a.value=x(a.value),S("after:highlightBlock",{block:e,result:a}),e.innerHTML=a.value,e.className=function(e,n,t){var r=n?s[n]:t,a=[e.trim()];return e.match(/\bhljs\b/)||a.push("hljs"),e.includes(r)||a.push(r),a.join(" ").trim()}(e.className,t,a.language),e.result={language:a.language,re:a.relevance,relavance:a.relevance},a.second_best&&(e.second_best={language:a.second_best.language,re:a.second_best.relevance,relavance:a.second_best.relevance})}const N=()=>{if(!N.called){N.called=!0;var e=document.querySelectorAll("pre code");a.forEach.call(e,E)}};function T(e){return e=(e||"").toLowerCase(),i[e]||i[s[e]]}function A(e,{languageName:n}){"string"==typeof e&&(e=[e]),e.forEach(e=>{s[e]=n})}function I(e){var n=T(e);return n&&!n.disableAutodetect}function S(e,n){var t=e;o.forEach((function(e){e[t]&&e[t](n)}))}Object.assign(t,{highlight:b,highlightAuto:v,fixMarkup:x,highlightBlock:E,configure:function(e){f=y(f,e)},initHighlighting:N,initHighlightingOnLoad:function(){window.addEventListener("DOMContentLoaded",N,!1)},registerLanguage:function(e,n){var r=null;try{r=n(t)}catch(n){if(console.error("Language definition for '{}' could not be registered.".replace("{}",e)),!l)throw n;console.error(n),r=h}r.name||(r.name=e),i[e]=r,r.rawDefinition=n.bind(null,t),r.aliases&&A(r.aliases,{languageName:e})},listLanguages:function(){return Object.keys(i)},getLanguage:T,registerAliases:A,requireLanguage:function(e){var n=T(e);if(n)return n;throw Error("The '{}' language is required, but not loaded.".replace("{}",e))},autoDetection:I,inherit:y,addPlugin:function(e){o.push(e)}}),t.debugMode=function(){l=!1},t.safeMode=function(){l=!0},t.versionString="10.1.1";for(const n in _)"object"==typeof _[n]&&e(_[n]);return Object.assign(t,_),t}({})}();"object"==typeof exports&&"undefined"!=typeof module&&(module.exports=hljs);
+hljs.registerLanguage("apache",function(){"use strict";return function(e){var n={className:"number",begin:"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}(:\\d{1,5})?"};return{name:"Apache config",aliases:["apacheconf"],case_insensitive:!0,contains:[e.HASH_COMMENT_MODE,{className:"section",begin:"",contains:[n,{className:"number",begin:":\\d{1,5}"},e.inherit(e.QUOTE_STRING_MODE,{relevance:0})]},{className:"attribute",begin:/\w+/,relevance:0,keywords:{nomarkup:"order deny allow setenv rewriterule rewriteengine rewritecond documentroot sethandler errordocument loadmodule options header listen serverroot servername"},starts:{end:/$/,relevance:0,keywords:{literal:"on off all deny allow"},contains:[{className:"meta",begin:"\\s\\[",end:"\\]$"},{className:"variable",begin:"[\\$%]\\{",end:"\\}",contains:["self",{className:"number",begin:"[\\$%]\\d+"}]},n,{className:"number",begin:"\\d+"},e.QUOTE_STRING_MODE]}}],illegal:/\S/}}}());
+hljs.registerLanguage("bash",function(){"use strict";return function(e){const s={};Object.assign(s,{className:"variable",variants:[{begin:/\$[\w\d#@][\w\d_]*/},{begin:/\$\{/,end:/\}/,contains:[{begin:/:-/,contains:[s]}]}]});const t={className:"subst",begin:/\$\(/,end:/\)/,contains:[e.BACKSLASH_ESCAPE]},n={className:"string",begin:/"/,end:/"/,contains:[e.BACKSLASH_ESCAPE,s,t]};t.contains.push(n);const a={begin:/\$\(\(/,end:/\)\)/,contains:[{begin:/\d+#[0-9a-f]+/,className:"number"},e.NUMBER_MODE,s]},i=e.SHEBANG({binary:"(fish|bash|zsh|sh|csh|ksh|tcsh|dash|scsh)",relevance:10}),c={className:"function",begin:/\w[\w\d_]*\s*\(\s*\)\s*\{/,returnBegin:!0,contains:[e.inherit(e.TITLE_MODE,{begin:/\w[\w\d_]*/})],relevance:0};return{name:"Bash",aliases:["sh","zsh"],keywords:{$pattern:/\b-?[a-z\._]+\b/,keyword:"if then else elif fi for while in do done case esac function",literal:"true false",built_in:"break cd continue eval exec exit export getopts hash pwd readonly return shift test times trap umask unset alias bind builtin caller command declare echo enable help let local logout mapfile printf read readarray source type typeset ulimit unalias set shopt autoload bg bindkey bye cap chdir clone comparguments compcall compctl compdescribe compfiles compgroups compquote comptags comptry compvalues dirs disable disown echotc echoti emulate fc fg float functions getcap getln history integer jobs kill limit log noglob popd print pushd pushln rehash sched setcap setopt stat suspend ttyctl unfunction unhash unlimit unsetopt vared wait whence where which zcompile zformat zftp zle zmodload zparseopts zprof zpty zregexparse zsocket zstyle ztcp",_:"-ne -eq -lt -gt -f -d -e -s -l -a"},contains:[i,e.SHEBANG(),c,a,e.HASH_COMMENT_MODE,n,{className:"",begin:/\\"/},{className:"string",begin:/'/,end:/'/},s]}}}());
+hljs.registerLanguage("c-like",function(){"use strict";return function(e){function t(e){return"(?:"+e+")?"}var n="(decltype\\(auto\\)|"+t("[a-zA-Z_]\\w*::")+"[a-zA-Z_]\\w*"+t("<.*?>")+")",r={className:"keyword",begin:"\\b[a-z\\d_]*_t\\b"},a={className:"string",variants:[{begin:'(u8?|U|L)?"',end:'"',illegal:"\\n",contains:[e.BACKSLASH_ESCAPE]},{begin:"(u8?|U|L)?'(\\\\(x[0-9A-Fa-f]{2}|u[0-9A-Fa-f]{4,8}|[0-7]{3}|\\S)|.)",end:"'",illegal:"."},e.END_SAME_AS_BEGIN({begin:/(?:u8?|U|L)?R"([^()\\ ]{0,16})\(/,end:/\)([^()\\ ]{0,16})"/})]},i={className:"number",variants:[{begin:"\\b(0b[01']+)"},{begin:"(-?)\\b([\\d']+(\\.[\\d']*)?|\\.[\\d']+)(u|U|l|L|ul|UL|f|F|b|B)"},{begin:"(-?)(\\b0[xX][a-fA-F0-9']+|(\\b[\\d']+(\\.[\\d']*)?|\\.[\\d']+)([eE][-+]?[\\d']+)?)"}],relevance:0},s={className:"meta",begin:/#\s*[a-z]+\b/,end:/$/,keywords:{"meta-keyword":"if else elif endif define undef warning error line pragma _Pragma ifdef ifndef include"},contains:[{begin:/\\\n/,relevance:0},e.inherit(a,{className:"meta-string"}),{className:"meta-string",begin:/<.*?>/,end:/$/,illegal:"\\n"},e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},o={className:"title",begin:t("[a-zA-Z_]\\w*::")+e.IDENT_RE,relevance:0},c=t("[a-zA-Z_]\\w*::")+e.IDENT_RE+"\\s*\\(",l={keyword:"int float while private char char8_t char16_t char32_t catch import module export virtual operator sizeof dynamic_cast|10 typedef const_cast|10 const for static_cast|10 union namespace unsigned long volatile static protected bool template mutable if public friend do goto auto void enum else break extern using asm case typeid wchar_t short reinterpret_cast|10 default double register explicit signed typename try this switch continue inline delete alignas alignof constexpr consteval constinit decltype concept co_await co_return co_yield requires noexcept static_assert thread_local restrict final override atomic_bool atomic_char atomic_schar atomic_uchar atomic_short atomic_ushort atomic_int atomic_uint atomic_long atomic_ulong atomic_llong atomic_ullong new throw return and and_eq bitand bitor compl not not_eq or or_eq xor xor_eq",built_in:"std string wstring cin cout cerr clog stdin stdout stderr stringstream istringstream ostringstream auto_ptr deque list queue stack vector map set pair bitset multiset multimap unordered_set unordered_map unordered_multiset unordered_multimap priority_queue make_pair array shared_ptr abort terminate abs acos asin atan2 atan calloc ceil cosh cos exit exp fabs floor fmod fprintf fputs free frexp fscanf future isalnum isalpha iscntrl isdigit isgraph islower isprint ispunct isspace isupper isxdigit tolower toupper labs ldexp log10 log malloc realloc memchr memcmp memcpy memset modf pow printf putchar puts scanf sinh sin snprintf sprintf sqrt sscanf strcat strchr strcmp strcpy strcspn strlen strncat strncmp strncpy strpbrk strrchr strspn strstr tanh tan vfprintf vprintf vsprintf endl initializer_list unique_ptr _Bool complex _Complex imaginary _Imaginary",literal:"true false nullptr NULL"},d=[r,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,i,a],_={variants:[{begin:/=/,end:/;/},{begin:/\(/,end:/\)/},{beginKeywords:"new throw return else",end:/;/}],keywords:l,contains:d.concat([{begin:/\(/,end:/\)/,keywords:l,contains:d.concat(["self"]),relevance:0}]),relevance:0},u={className:"function",begin:"("+n+"[\\*&\\s]+)+"+c,returnBegin:!0,end:/[{;=]/,excludeEnd:!0,keywords:l,illegal:/[^\w\s\*&:<>]/,contains:[{begin:"decltype\\(auto\\)",keywords:l,relevance:0},{begin:c,returnBegin:!0,contains:[o],relevance:0},{className:"params",begin:/\(/,end:/\)/,keywords:l,relevance:0,contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,i,r,{begin:/\(/,end:/\)/,keywords:l,relevance:0,contains:["self",e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,i,r]}]},r,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s]};return{aliases:["c","cc","h","c++","h++","hpp","hh","hxx","cxx"],keywords:l,disableAutodetect:!0,illegal:"",keywords:l,contains:["self",r]},{begin:e.IDENT_RE+"::",keywords:l},{className:"class",beginKeywords:"class struct",end:/[{;:]/,contains:[{begin://,contains:["self"]},e.TITLE_MODE]}]),exports:{preprocessor:s,strings:a,keywords:l}}}}());
+hljs.registerLanguage("c",function(){"use strict";return function(e){var n=e.getLanguage("c-like").rawDefinition();return n.name="C",n.aliases=["c","h"],n}}());
+hljs.registerLanguage("coffeescript",function(){"use strict";const e=["as","in","of","if","for","while","finally","var","new","function","do","return","void","else","break","catch","instanceof","with","throw","case","default","try","switch","continue","typeof","delete","let","yield","const","class","debugger","async","await","static","import","from","export","extends"],n=["true","false","null","undefined","NaN","Infinity"],a=[].concat(["setInterval","setTimeout","clearInterval","clearTimeout","require","exports","eval","isFinite","isNaN","parseFloat","parseInt","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","escape","unescape"],["arguments","this","super","console","window","document","localStorage","module","global"],["Intl","DataView","Number","Math","Date","String","RegExp","Object","Function","Boolean","Error","Symbol","Set","Map","WeakSet","WeakMap","Proxy","Reflect","JSON","Promise","Float64Array","Int16Array","Int32Array","Int8Array","Uint16Array","Uint32Array","Float32Array","Array","Uint8Array","Uint8ClampedArray","ArrayBuffer"],["EvalError","InternalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError"]);return function(r){var t={keyword:e.concat(["then","unless","until","loop","by","when","and","or","is","isnt","not"]).filter((e=>n=>!e.includes(n))(["var","const","let","function","static"])).join(" "),literal:n.concat(["yes","no","on","off"]).join(" "),built_in:a.concat(["npm","print"]).join(" ")},i="[A-Za-z$_][0-9A-Za-z$_]*",s={className:"subst",begin:/#\{/,end:/}/,keywords:t},o=[r.BINARY_NUMBER_MODE,r.inherit(r.C_NUMBER_MODE,{starts:{end:"(\\s*/)?",relevance:0}}),{className:"string",variants:[{begin:/'''/,end:/'''/,contains:[r.BACKSLASH_ESCAPE]},{begin:/'/,end:/'/,contains:[r.BACKSLASH_ESCAPE]},{begin:/"""/,end:/"""/,contains:[r.BACKSLASH_ESCAPE,s]},{begin:/"/,end:/"/,contains:[r.BACKSLASH_ESCAPE,s]}]},{className:"regexp",variants:[{begin:"///",end:"///",contains:[s,r.HASH_COMMENT_MODE]},{begin:"//[gim]{0,3}(?=\\W)",relevance:0},{begin:/\/(?![ *]).*?(?![\\]).\/[gim]{0,3}(?=\W)/}]},{begin:"@"+i},{subLanguage:"javascript",excludeBegin:!0,excludeEnd:!0,variants:[{begin:"```",end:"```"},{begin:"`",end:"`"}]}];s.contains=o;var c=r.inherit(r.TITLE_MODE,{begin:i}),l={className:"params",begin:"\\([^\\(]",returnBegin:!0,contains:[{begin:/\(/,end:/\)/,keywords:t,contains:["self"].concat(o)}]};return{name:"CoffeeScript",aliases:["coffee","cson","iced"],keywords:t,illegal:/\/\*/,contains:o.concat([r.COMMENT("###","###"),r.HASH_COMMENT_MODE,{className:"function",begin:"^\\s*"+i+"\\s*=\\s*(\\(.*\\))?\\s*\\B[-=]>",end:"[-=]>",returnBegin:!0,contains:[c,l]},{begin:/[:\(,=]\s*/,relevance:0,contains:[{className:"function",begin:"(\\(.*\\))?\\s*\\B[-=]>",end:"[-=]>",returnBegin:!0,contains:[l]}]},{className:"class",beginKeywords:"class",end:"$",illegal:/[:="\[\]]/,contains:[{beginKeywords:"extends",endsWithParent:!0,illegal:/[:="\[\]]/,contains:[c]},c]},{begin:i+":",end:":",returnBegin:!0,returnEnd:!0,relevance:0}])}}}());
+hljs.registerLanguage("cpp",function(){"use strict";return function(e){var t=e.getLanguage("c-like").rawDefinition();return t.disableAutodetect=!1,t.name="C++",t.aliases=["cc","c++","h++","hpp","hh","hxx","cxx"],t}}());
+hljs.registerLanguage("csharp",function(){"use strict";return function(e){var n={keyword:"abstract as base bool break byte case catch char checked const continue decimal default delegate do double enum event explicit extern finally fixed float for foreach goto if implicit in int interface internal is lock long object operator out override params private protected public readonly ref sbyte sealed short sizeof stackalloc static string struct switch this try typeof uint ulong unchecked unsafe ushort using virtual void volatile while add alias ascending async await by descending dynamic equals from get global group into join let nameof on orderby partial remove select set value var when where yield",literal:"null false true"},i=e.inherit(e.TITLE_MODE,{begin:"[a-zA-Z](\\.?\\w)*"}),a={className:"number",variants:[{begin:"\\b(0b[01']+)"},{begin:"(-?)\\b([\\d']+(\\.[\\d']*)?|\\.[\\d']+)(u|U|l|L|ul|UL|f|F|b|B)"},{begin:"(-?)(\\b0[xX][a-fA-F0-9']+|(\\b[\\d']+(\\.[\\d']*)?|\\.[\\d']+)([eE][-+]?[\\d']+)?)"}],relevance:0},s={className:"string",begin:'@"',end:'"',contains:[{begin:'""'}]},t=e.inherit(s,{illegal:/\n/}),l={className:"subst",begin:"{",end:"}",keywords:n},r=e.inherit(l,{illegal:/\n/}),c={className:"string",begin:/\$"/,end:'"',illegal:/\n/,contains:[{begin:"{{"},{begin:"}}"},e.BACKSLASH_ESCAPE,r]},o={className:"string",begin:/\$@"/,end:'"',contains:[{begin:"{{"},{begin:"}}"},{begin:'""'},l]},g=e.inherit(o,{illegal:/\n/,contains:[{begin:"{{"},{begin:"}}"},{begin:'""'},r]});l.contains=[o,c,s,e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,a,e.C_BLOCK_COMMENT_MODE],r.contains=[g,c,t,e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,a,e.inherit(e.C_BLOCK_COMMENT_MODE,{illegal:/\n/})];var d={variants:[o,c,s,e.APOS_STRING_MODE,e.QUOTE_STRING_MODE]},E={begin:"<",end:">",contains:[{beginKeywords:"in out"},i]},_=e.IDENT_RE+"(<"+e.IDENT_RE+"(\\s*,\\s*"+e.IDENT_RE+")*>)?(\\[\\])?",b={begin:"@"+e.IDENT_RE,relevance:0};return{name:"C#",aliases:["cs","c#"],keywords:n,illegal:/::/,contains:[e.COMMENT("///","$",{returnBegin:!0,contains:[{className:"doctag",variants:[{begin:"///",relevance:0},{begin:"\x3c!--|--\x3e"},{begin:""}]}]}),e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,{className:"meta",begin:"#",end:"$",keywords:{"meta-keyword":"if else elif endif define undef warning error line region endregion pragma checksum"}},d,a,{beginKeywords:"class interface",end:/[{;=]/,illegal:/[^\s:,]/,contains:[{beginKeywords:"where class"},i,E,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{beginKeywords:"namespace",end:/[{;=]/,illegal:/[^\s:]/,contains:[i,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{className:"meta",begin:"^\\s*\\[",excludeBegin:!0,end:"\\]",excludeEnd:!0,contains:[{className:"meta-string",begin:/"/,end:/"/}]},{beginKeywords:"new return throw await else",relevance:0},{className:"function",begin:"("+_+"\\s+)+"+e.IDENT_RE+"\\s*(\\<.+\\>)?\\s*\\(",returnBegin:!0,end:/\s*[{;=]/,excludeEnd:!0,keywords:n,contains:[{begin:e.IDENT_RE+"\\s*(\\<.+\\>)?\\s*\\(",returnBegin:!0,contains:[e.TITLE_MODE,E],relevance:0},{className:"params",begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:n,relevance:0,contains:[d,a,e.C_BLOCK_COMMENT_MODE]},e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},b]}}}());
+hljs.registerLanguage("css",function(){"use strict";return function(e){var n={begin:/(?:[A-Z\_\.\-]+|--[a-zA-Z0-9_-]+)\s*:/,returnBegin:!0,end:";",endsWithParent:!0,contains:[{className:"attribute",begin:/\S/,end:":",excludeEnd:!0,starts:{endsWithParent:!0,excludeEnd:!0,contains:[{begin:/[\w-]+\(/,returnBegin:!0,contains:[{className:"built_in",begin:/[\w-]+/},{begin:/\(/,end:/\)/,contains:[e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,e.CSS_NUMBER_MODE]}]},e.CSS_NUMBER_MODE,e.QUOTE_STRING_MODE,e.APOS_STRING_MODE,e.C_BLOCK_COMMENT_MODE,{className:"number",begin:"#[0-9A-Fa-f]+"},{className:"meta",begin:"!important"}]}}]};return{name:"CSS",case_insensitive:!0,illegal:/[=\/|'\$]/,contains:[e.C_BLOCK_COMMENT_MODE,{className:"selector-id",begin:/#[A-Za-z0-9_-]+/},{className:"selector-class",begin:/\.[A-Za-z0-9_-]+/},{className:"selector-attr",begin:/\[/,end:/\]/,illegal:"$",contains:[e.APOS_STRING_MODE,e.QUOTE_STRING_MODE]},{className:"selector-pseudo",begin:/:(:)?[a-zA-Z0-9\_\-\+\(\)"'.]+/},{begin:"@(page|font-face)",lexemes:"@[a-z-]+",keywords:"@page @font-face"},{begin:"@",end:"[{;]",illegal:/:/,returnBegin:!0,contains:[{className:"keyword",begin:/@\-?\w[\w]*(\-\w+)*/},{begin:/\s/,endsWithParent:!0,excludeEnd:!0,relevance:0,keywords:"and or not only",contains:[{begin:/[a-z-]+:/,className:"attribute"},e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,e.CSS_NUMBER_MODE]}]},{className:"selector-tag",begin:"[a-zA-Z-][a-zA-Z0-9_-]*",relevance:0},{begin:"{",end:"}",illegal:/\S/,contains:[e.C_BLOCK_COMMENT_MODE,n]}]}}}());
+hljs.registerLanguage("diff",function(){"use strict";return function(e){return{name:"Diff",aliases:["patch"],contains:[{className:"meta",relevance:10,variants:[{begin:/^@@ +\-\d+,\d+ +\+\d+,\d+ +@@$/},{begin:/^\*\*\* +\d+,\d+ +\*\*\*\*$/},{begin:/^\-\-\- +\d+,\d+ +\-\-\-\-$/}]},{className:"comment",variants:[{begin:/Index: /,end:/$/},{begin:/={3,}/,end:/$/},{begin:/^\-{3}/,end:/$/},{begin:/^\*{3} /,end:/$/},{begin:/^\+{3}/,end:/$/},{begin:/^\*{15}$/}]},{className:"addition",begin:"^\\+",end:"$"},{className:"deletion",begin:"^\\-",end:"$"},{className:"addition",begin:"^\\!",end:"$"}]}}}());
+hljs.registerLanguage("go",function(){"use strict";return function(e){var n={keyword:"break default func interface select case map struct chan else goto package switch const fallthrough if range type continue for import return var go defer bool byte complex64 complex128 float32 float64 int8 int16 int32 int64 string uint8 uint16 uint32 uint64 int uint uintptr rune",literal:"true false iota nil",built_in:"append cap close complex copy imag len make new panic print println real recover delete"};return{name:"Go",aliases:["golang"],keywords:n,illegal:"e(n)).join("")}return function(a){var s={className:"number",relevance:0,variants:[{begin:/([\+\-]+)?[\d]+_[\d_]+/},{begin:a.NUMBER_RE}]},i=a.COMMENT();i.variants=[{begin:/;/,end:/$/},{begin:/#/,end:/$/}];var t={className:"variable",variants:[{begin:/\$[\w\d"][\w\d_]*/},{begin:/\$\{(.*?)}/}]},r={className:"literal",begin:/\bon|off|true|false|yes|no\b/},l={className:"string",contains:[a.BACKSLASH_ESCAPE],variants:[{begin:"'''",end:"'''",relevance:10},{begin:'"""',end:'"""',relevance:10},{begin:'"',end:'"'},{begin:"'",end:"'"}]},c={begin:/\[/,end:/\]/,contains:[i,r,t,l,s,"self"],relevance:0},g="("+[/[A-Za-z0-9_-]+/,/"(\\"|[^"])*"/,/'[^']*'/].map(n=>e(n)).join("|")+")";return{name:"TOML, also INI",aliases:["toml"],case_insensitive:!0,illegal:/\S/,contains:[i,{className:"section",begin:/\[+/,end:/\]+/},{begin:n(g,"(\\s*\\.\\s*",g,")*",n("(?=",/\s*=\s*[^#\s]/,")")),className:"attr",starts:{end:/$/,contains:[i,c,r,t,l,s]}}]}}}());
+hljs.registerLanguage("java",function(){"use strict";function e(e){return e?"string"==typeof e?e:e.source:null}function n(e){return a("(",e,")?")}function a(...n){return n.map(n=>e(n)).join("")}function s(...n){return"("+n.map(n=>e(n)).join("|")+")"}return function(e){var t="false synchronized int abstract float private char boolean var static null if const for true while long strictfp finally protected import native final void enum else break transient catch instanceof byte super volatile case assert short package default double public try this switch continue throws protected public private module requires exports do",i={className:"meta",begin:"@[À-ʸa-zA-Z_$][À-ʸa-zA-Z_$0-9]*",contains:[{begin:/\(/,end:/\)/,contains:["self"]}]},r=e=>a("[",e,"]+([",e,"_]*[",e,"]+)?"),c={className:"number",variants:[{begin:`\\b(0[bB]${r("01")})[lL]?`},{begin:`\\b(0${r("0-7")})[dDfFlL]?`},{begin:a(/\b0[xX]/,s(a(r("a-fA-F0-9"),/\./,r("a-fA-F0-9")),a(r("a-fA-F0-9"),/\.?/),a(/\./,r("a-fA-F0-9"))),/([pP][+-]?(\d+))?/,/[fFdDlL]?/)},{begin:a(/\b/,s(a(/\d*\./,r("\\d")),r("\\d")),/[eE][+-]?[\d]+[dDfF]?/)},{begin:a(/\b/,r(/\d/),n(/\.?/),n(r(/\d/)),/[dDfFlL]?/)}],relevance:0};return{name:"Java",aliases:["jsp"],keywords:t,illegal:/<\/|#/,contains:[e.COMMENT("/\\*\\*","\\*/",{relevance:0,contains:[{begin:/\w+@/,relevance:0},{className:"doctag",begin:"@[A-Za-z]+"}]}),e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,{className:"class",beginKeywords:"class interface",end:/[{;=]/,excludeEnd:!0,keywords:"class interface",illegal:/[:"\[\]]/,contains:[{beginKeywords:"extends implements"},e.UNDERSCORE_TITLE_MODE]},{beginKeywords:"new throw return else",relevance:0},{className:"function",begin:"([À-ʸa-zA-Z_$][À-ʸa-zA-Z_$0-9]*(<[À-ʸa-zA-Z_$][À-ʸa-zA-Z_$0-9]*(\\s*,\\s*[À-ʸa-zA-Z_$][À-ʸa-zA-Z_$0-9]*)*>)?\\s+)+"+e.UNDERSCORE_IDENT_RE+"\\s*\\(",returnBegin:!0,end:/[{;=]/,excludeEnd:!0,keywords:t,contains:[{begin:e.UNDERSCORE_IDENT_RE+"\\s*\\(",returnBegin:!0,relevance:0,contains:[e.UNDERSCORE_TITLE_MODE]},{className:"params",begin:/\(/,end:/\)/,keywords:t,relevance:0,contains:[i,e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,e.C_NUMBER_MODE,e.C_BLOCK_COMMENT_MODE]},e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},c,i]}}}());
+hljs.registerLanguage("javascript",function(){"use strict";const e=["as","in","of","if","for","while","finally","var","new","function","do","return","void","else","break","catch","instanceof","with","throw","case","default","try","switch","continue","typeof","delete","let","yield","const","class","debugger","async","await","static","import","from","export","extends"],n=["true","false","null","undefined","NaN","Infinity"],a=[].concat(["setInterval","setTimeout","clearInterval","clearTimeout","require","exports","eval","isFinite","isNaN","parseFloat","parseInt","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","escape","unescape"],["arguments","this","super","console","window","document","localStorage","module","global"],["Intl","DataView","Number","Math","Date","String","RegExp","Object","Function","Boolean","Error","Symbol","Set","Map","WeakSet","WeakMap","Proxy","Reflect","JSON","Promise","Float64Array","Int16Array","Int32Array","Int8Array","Uint16Array","Uint32Array","Float32Array","Array","Uint8Array","Uint8ClampedArray","ArrayBuffer"],["EvalError","InternalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError"]);function s(e){return r("(?=",e,")")}function r(...e){return e.map(e=>(function(e){return e?"string"==typeof e?e:e.source:null})(e)).join("")}return function(t){var i="[A-Za-z$_][0-9A-Za-z$_]*",c={begin:/<[A-Za-z0-9\\._:-]+/,end:/\/[A-Za-z0-9\\._:-]+>|\/>/},o={$pattern:"[A-Za-z$_][0-9A-Za-z$_]*",keyword:e.join(" "),literal:n.join(" "),built_in:a.join(" ")},l={className:"number",variants:[{begin:"\\b(0[bB][01]+)n?"},{begin:"\\b(0[oO][0-7]+)n?"},{begin:t.C_NUMBER_RE+"n?"}],relevance:0},E={className:"subst",begin:"\\$\\{",end:"\\}",keywords:o,contains:[]},d={begin:"html`",end:"",starts:{end:"`",returnEnd:!1,contains:[t.BACKSLASH_ESCAPE,E],subLanguage:"xml"}},g={begin:"css`",end:"",starts:{end:"`",returnEnd:!1,contains:[t.BACKSLASH_ESCAPE,E],subLanguage:"css"}},u={className:"string",begin:"`",end:"`",contains:[t.BACKSLASH_ESCAPE,E]};E.contains=[t.APOS_STRING_MODE,t.QUOTE_STRING_MODE,d,g,u,l,t.REGEXP_MODE];var b=E.contains.concat([{begin:/\(/,end:/\)/,contains:["self"].concat(E.contains,[t.C_BLOCK_COMMENT_MODE,t.C_LINE_COMMENT_MODE])},t.C_BLOCK_COMMENT_MODE,t.C_LINE_COMMENT_MODE]),_={className:"params",begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,contains:b};return{name:"JavaScript",aliases:["js","jsx","mjs","cjs"],keywords:o,contains:[t.SHEBANG({binary:"node",relevance:5}),{className:"meta",relevance:10,begin:/^\s*['"]use (strict|asm)['"]/},t.APOS_STRING_MODE,t.QUOTE_STRING_MODE,d,g,u,t.C_LINE_COMMENT_MODE,t.COMMENT("/\\*\\*","\\*/",{relevance:0,contains:[{className:"doctag",begin:"@[A-Za-z]+",contains:[{className:"type",begin:"\\{",end:"\\}",relevance:0},{className:"variable",begin:i+"(?=\\s*(-)|$)",endsParent:!0,relevance:0},{begin:/(?=[^\n])\s/,relevance:0}]}]}),t.C_BLOCK_COMMENT_MODE,l,{begin:r(/[{,\n]\s*/,s(r(/(((\/\/.*)|(\/\*(.|\n)*\*\/))\s*)*/,i+"\\s*:"))),relevance:0,contains:[{className:"attr",begin:i+s("\\s*:"),relevance:0}]},{begin:"("+t.RE_STARTERS_RE+"|\\b(case|return|throw)\\b)\\s*",keywords:"return throw case",contains:[t.C_LINE_COMMENT_MODE,t.C_BLOCK_COMMENT_MODE,t.REGEXP_MODE,{className:"function",begin:"(\\([^(]*(\\([^(]*(\\([^(]*\\))?\\))?\\)|"+t.UNDERSCORE_IDENT_RE+")\\s*=>",returnBegin:!0,end:"\\s*=>",contains:[{className:"params",variants:[{begin:t.UNDERSCORE_IDENT_RE},{className:null,begin:/\(\s*\)/,skip:!0},{begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:o,contains:b}]}]},{begin:/,/,relevance:0},{className:"",begin:/\s/,end:/\s*/,skip:!0},{variants:[{begin:"<>",end:""},{begin:c.begin,end:c.end}],subLanguage:"xml",contains:[{begin:c.begin,end:c.end,skip:!0,contains:["self"]}]}],relevance:0},{className:"function",beginKeywords:"function",end:/\{/,excludeEnd:!0,contains:[t.inherit(t.TITLE_MODE,{begin:i}),_],illegal:/\[|%/},{begin:/\$[(.]/},t.METHOD_GUARD,{className:"class",beginKeywords:"class",end:/[{;=]/,excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"extends"},t.UNDERSCORE_TITLE_MODE]},{beginKeywords:"constructor",end:/\{/,excludeEnd:!0},{begin:"(get|set)\\s+(?="+i+"\\()",end:/{/,keywords:"get set",contains:[t.inherit(t.TITLE_MODE,{begin:i}),{begin:/\(\)/},_]}],illegal:/#(?!!)/}}}());
+hljs.registerLanguage("json",function(){"use strict";return function(n){var e={literal:"true false null"},i=[n.C_LINE_COMMENT_MODE,n.C_BLOCK_COMMENT_MODE],t=[n.QUOTE_STRING_MODE,n.C_NUMBER_MODE],a={end:",",endsWithParent:!0,excludeEnd:!0,contains:t,keywords:e},l={begin:"{",end:"}",contains:[{className:"attr",begin:/"/,end:/"/,contains:[n.BACKSLASH_ESCAPE],illegal:"\\n"},n.inherit(a,{begin:/:/})].concat(i),illegal:"\\S"},s={begin:"\\[",end:"\\]",contains:[n.inherit(a)],illegal:"\\S"};return t.push(l,s),i.forEach((function(n){t.push(n)})),{name:"JSON",contains:t,keywords:e,illegal:"\\S"}}}());
+hljs.registerLanguage("kotlin",function(){"use strict";return function(e){var n={keyword:"abstract as val var vararg get set class object open private protected public noinline crossinline dynamic final enum if else do while for when throw try catch finally import package is in fun override companion reified inline lateinit init interface annotation data sealed internal infix operator out by constructor super tailrec where const inner suspend typealias external expect actual trait volatile transient native default",built_in:"Byte Short Char Int Long Boolean Float Double Void Unit Nothing",literal:"true false null"},a={className:"symbol",begin:e.UNDERSCORE_IDENT_RE+"@"},i={className:"subst",begin:"\\${",end:"}",contains:[e.C_NUMBER_MODE]},s={className:"variable",begin:"\\$"+e.UNDERSCORE_IDENT_RE},t={className:"string",variants:[{begin:'"""',end:'"""(?=[^"])',contains:[s,i]},{begin:"'",end:"'",illegal:/\n/,contains:[e.BACKSLASH_ESCAPE]},{begin:'"',end:'"',illegal:/\n/,contains:[e.BACKSLASH_ESCAPE,s,i]}]};i.contains.push(t);var r={className:"meta",begin:"@(?:file|property|field|get|set|receiver|param|setparam|delegate)\\s*:(?:\\s*"+e.UNDERSCORE_IDENT_RE+")?"},l={className:"meta",begin:"@"+e.UNDERSCORE_IDENT_RE,contains:[{begin:/\(/,end:/\)/,contains:[e.inherit(t,{className:"meta-string"})]}]},c=e.COMMENT("/\\*","\\*/",{contains:[e.C_BLOCK_COMMENT_MODE]}),o={variants:[{className:"type",begin:e.UNDERSCORE_IDENT_RE},{begin:/\(/,end:/\)/,contains:[]}]},d=o;return d.variants[1].contains=[o],o.variants[1].contains=[d],{name:"Kotlin",aliases:["kt"],keywords:n,contains:[e.COMMENT("/\\*\\*","\\*/",{relevance:0,contains:[{className:"doctag",begin:"@[A-Za-z]+"}]}),e.C_LINE_COMMENT_MODE,c,{className:"keyword",begin:/\b(break|continue|return|this)\b/,starts:{contains:[{className:"symbol",begin:/@\w+/}]}},a,r,l,{className:"function",beginKeywords:"fun",end:"[(]|$",returnBegin:!0,excludeEnd:!0,keywords:n,illegal:/fun\s+(<.*>)?[^\s\(]+(\s+[^\s\(]+)\s*=/,relevance:5,contains:[{begin:e.UNDERSCORE_IDENT_RE+"\\s*\\(",returnBegin:!0,relevance:0,contains:[e.UNDERSCORE_TITLE_MODE]},{className:"type",begin://,keywords:"reified",relevance:0},{className:"params",begin:/\(/,end:/\)/,endsParent:!0,keywords:n,relevance:0,contains:[{begin:/:/,end:/[=,\/]/,endsWithParent:!0,contains:[o,e.C_LINE_COMMENT_MODE,c],relevance:0},e.C_LINE_COMMENT_MODE,c,r,l,t,e.C_NUMBER_MODE]},c]},{className:"class",beginKeywords:"class interface trait",end:/[:\{(]|$/,excludeEnd:!0,illegal:"extends implements",contains:[{beginKeywords:"public protected internal private constructor"},e.UNDERSCORE_TITLE_MODE,{className:"type",begin://,excludeBegin:!0,excludeEnd:!0,relevance:0},{className:"type",begin:/[,:]\s*/,end:/[<\(,]|$/,excludeBegin:!0,returnEnd:!0},r,l]},t,{className:"meta",begin:"^#!/usr/bin/env",end:"$",illegal:"\n"},{className:"number",begin:"\\b(0[bB]([01]+[01_]+[01]+|[01]+)|0[xX]([a-fA-F0-9]+[a-fA-F0-9_]+[a-fA-F0-9]+|[a-fA-F0-9]+)|(([\\d]+[\\d_]+[\\d]+|[\\d]+)(\\.([\\d]+[\\d_]+[\\d]+|[\\d]+))?|\\.([\\d]+[\\d_]+[\\d]+|[\\d]+))([eE][-+]?\\d+)?)[lLfF]?",relevance:0}]}}}());
+hljs.registerLanguage("less",function(){"use strict";return function(e){var n="([\\w-]+|@{[\\w-]+})",a=[],s=[],t=function(e){return{className:"string",begin:"~?"+e+".*?"+e}},r=function(e,n,a){return{className:e,begin:n,relevance:a}},i={begin:"\\(",end:"\\)",contains:s,relevance:0};s.push(e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,t("'"),t('"'),e.CSS_NUMBER_MODE,{begin:"(url|data-uri)\\(",starts:{className:"string",end:"[\\)\\n]",excludeEnd:!0}},r("number","#[0-9A-Fa-f]+\\b"),i,r("variable","@@?[\\w-]+",10),r("variable","@{[\\w-]+}"),r("built_in","~?`[^`]*?`"),{className:"attribute",begin:"[\\w-]+\\s*:",end:":",returnBegin:!0,excludeEnd:!0},{className:"meta",begin:"!important"});var c=s.concat({begin:"{",end:"}",contains:a}),l={beginKeywords:"when",endsWithParent:!0,contains:[{beginKeywords:"and not"}].concat(s)},o={begin:n+"\\s*:",returnBegin:!0,end:"[;}]",relevance:0,contains:[{className:"attribute",begin:n,end:":",excludeEnd:!0,starts:{endsWithParent:!0,illegal:"[<=$]",relevance:0,contains:s}}]},g={className:"keyword",begin:"@(import|media|charset|font-face|(-[a-z]+-)?keyframes|supports|document|namespace|page|viewport|host)\\b",starts:{end:"[;{}]",returnEnd:!0,contains:s,relevance:0}},d={className:"variable",variants:[{begin:"@[\\w-]+\\s*:",relevance:15},{begin:"@[\\w-]+"}],starts:{end:"[;}]",returnEnd:!0,contains:c}},b={variants:[{begin:"[\\.#:&\\[>]",end:"[;{}]"},{begin:n,end:"{"}],returnBegin:!0,returnEnd:!0,illegal:"[<='$\"]",relevance:0,contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,l,r("keyword","all\\b"),r("variable","@{[\\w-]+}"),r("selector-tag",n+"%?",0),r("selector-id","#"+n),r("selector-class","\\."+n,0),r("selector-tag","&",0),{className:"selector-attr",begin:"\\[",end:"\\]"},{className:"selector-pseudo",begin:/:(:)?[a-zA-Z0-9\_\-\+\(\)"'.]+/},{begin:"\\(",end:"\\)",contains:c},{begin:"!important"}]};return a.push(e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,g,d,o,b),{name:"Less",case_insensitive:!0,illegal:"[=>'/<($\"]",contains:a}}}());
+hljs.registerLanguage("lua",function(){"use strict";return function(e){var t={begin:"\\[=*\\[",end:"\\]=*\\]",contains:["self"]},a=[e.COMMENT("--(?!\\[=*\\[)","$"),e.COMMENT("--\\[=*\\[","\\]=*\\]",{contains:[t],relevance:10})];return{name:"Lua",keywords:{$pattern:e.UNDERSCORE_IDENT_RE,literal:"true false nil",keyword:"and break do else elseif end for goto if in local not or repeat return then until while",built_in:"_G _ENV _VERSION __index __newindex __mode __call __metatable __tostring __len __gc __add __sub __mul __div __mod __pow __concat __unm __eq __lt __le assert collectgarbage dofile error getfenv getmetatable ipairs load loadfile loadstring module next pairs pcall print rawequal rawget rawset require select setfenv setmetatable tonumber tostring type unpack xpcall arg self coroutine resume yield status wrap create running debug getupvalue debug sethook getmetatable gethook setmetatable setlocal traceback setfenv getinfo setupvalue getlocal getregistry getfenv io lines write close flush open output type read stderr stdin input stdout popen tmpfile math log max acos huge ldexp pi cos tanh pow deg tan cosh sinh random randomseed frexp ceil floor rad abs sqrt modf asin min mod fmod log10 atan2 exp sin atan os exit setlocale date getenv difftime remove time clock tmpname rename execute package preload loadlib loaded loaders cpath config path seeall string sub upper len gfind rep find match char dump gmatch reverse byte format gsub lower table setn insert getn foreachi maxn foreach concat sort remove"},contains:a.concat([{className:"function",beginKeywords:"function",end:"\\)",contains:[e.inherit(e.TITLE_MODE,{begin:"([_a-zA-Z]\\w*\\.)*([_a-zA-Z]\\w*:)?[_a-zA-Z]\\w*"}),{className:"params",begin:"\\(",endsWithParent:!0,contains:a}].concat(a)},e.C_NUMBER_MODE,e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,{className:"string",begin:"\\[=*\\[",end:"\\]=*\\]",contains:[t],relevance:5}])}}}());
+hljs.registerLanguage("makefile",function(){"use strict";return function(e){var i={className:"variable",variants:[{begin:"\\$\\("+e.UNDERSCORE_IDENT_RE+"\\)",contains:[e.BACKSLASH_ESCAPE]},{begin:/\$[@%`]+/}]}]}]};return{name:"HTML, XML",aliases:["html","xhtml","rss","atom","xjb","xsd","xsl","plist","wsf","svg"],case_insensitive:!0,contains:[{className:"meta",begin:"",relevance:10,contains:[a,i,t,s,{begin:"\\[",end:"\\]",contains:[{className:"meta",begin:"",contains:[a,s,i,t]}]}]},e.COMMENT("\x3c!--","--\x3e",{relevance:10}),{begin:"<\\!\\[CDATA\\[",end:"\\]\\]>",relevance:10},n,{className:"meta",begin:/<\?xml/,end:/\?>/,relevance:10},{className:"tag",begin:")",end:">",keywords:{name:"style"},contains:[c],starts:{end:"",returnEnd:!0,subLanguage:["css","xml"]}},{className:"tag",begin:")",end:">",keywords:{name:"script"},contains:[c],starts:{end:"<\/script>",returnEnd:!0,subLanguage:["javascript","handlebars","xml"]}},{className:"tag",begin:"",contains:[{className:"name",begin:/[^\/><\s]+/,relevance:0},c]}]}}}());
+hljs.registerLanguage("markdown",function(){"use strict";return function(n){const e={begin:"<",end:">",subLanguage:"xml",relevance:0},a={begin:"\\[.+?\\][\\(\\[].*?[\\)\\]]",returnBegin:!0,contains:[{className:"string",begin:"\\[",end:"\\]",excludeBegin:!0,returnEnd:!0,relevance:0},{className:"link",begin:"\\]\\(",end:"\\)",excludeBegin:!0,excludeEnd:!0},{className:"symbol",begin:"\\]\\[",end:"\\]",excludeBegin:!0,excludeEnd:!0}],relevance:10},i={className:"strong",contains:[],variants:[{begin:/_{2}/,end:/_{2}/},{begin:/\*{2}/,end:/\*{2}/}]},s={className:"emphasis",contains:[],variants:[{begin:/\*(?!\*)/,end:/\*/},{begin:/_(?!_)/,end:/_/,relevance:0}]};i.contains.push(s),s.contains.push(i);var c=[e,a];return i.contains=i.contains.concat(c),s.contains=s.contains.concat(c),{name:"Markdown",aliases:["md","mkdown","mkd"],contains:[{className:"section",variants:[{begin:"^#{1,6}",end:"$",contains:c=c.concat(i,s)},{begin:"(?=^.+?\\n[=-]{2,}$)",contains:[{begin:"^[=-]*$"},{begin:"^",end:"\\n",contains:c}]}]},e,{className:"bullet",begin:"^[ \t]*([*+-]|(\\d+\\.))(?=\\s+)",end:"\\s+",excludeEnd:!0},i,s,{className:"quote",begin:"^>\\s+",contains:c,end:"$"},{className:"code",variants:[{begin:"(`{3,})(.|\\n)*?\\1`*[ ]*"},{begin:"(~{3,})(.|\\n)*?\\1~*[ ]*"},{begin:"```",end:"```+[ ]*$"},{begin:"~~~",end:"~~~+[ ]*$"},{begin:"`.+?`"},{begin:"(?=^( {4}|\\t))",contains:[{begin:"^( {4}|\\t)",end:"(\\n)$"}],relevance:0}]},{begin:"^[-\\*]{3,}",end:"$"},a,{begin:/^\[[^\n]+\]:/,returnBegin:!0,contains:[{className:"symbol",begin:/\[/,end:/\]/,excludeBegin:!0,excludeEnd:!0},{className:"link",begin:/:\s*/,end:/$/,excludeBegin:!0}]}]}}}());
+hljs.registerLanguage("nginx",function(){"use strict";return function(e){var n={className:"variable",variants:[{begin:/\$\d+/},{begin:/\$\{/,end:/}/},{begin:"[\\$\\@]"+e.UNDERSCORE_IDENT_RE}]},a={endsWithParent:!0,keywords:{$pattern:"[a-z/_]+",literal:"on off yes no true false none blocked debug info notice warn error crit select break last permanent redirect kqueue rtsig epoll poll /dev/poll"},relevance:0,illegal:"=>",contains:[e.HASH_COMMENT_MODE,{className:"string",contains:[e.BACKSLASH_ESCAPE,n],variants:[{begin:/"/,end:/"/},{begin:/'/,end:/'/}]},{begin:"([a-z]+):/",end:"\\s",endsWithParent:!0,excludeEnd:!0,contains:[n]},{className:"regexp",contains:[e.BACKSLASH_ESCAPE,n],variants:[{begin:"\\s\\^",end:"\\s|{|;",returnEnd:!0},{begin:"~\\*?\\s+",end:"\\s|{|;",returnEnd:!0},{begin:"\\*(\\.[a-z\\-]+)+"},{begin:"([a-z\\-]+\\.)+\\*"}]},{className:"number",begin:"\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}(:\\d{1,5})?\\b"},{className:"number",begin:"\\b\\d+[kKmMgGdshdwy]*\\b",relevance:0},n]};return{name:"Nginx config",aliases:["nginxconf"],contains:[e.HASH_COMMENT_MODE,{begin:e.UNDERSCORE_IDENT_RE+"\\s+{",returnBegin:!0,end:"{",contains:[{className:"section",begin:e.UNDERSCORE_IDENT_RE}],relevance:0},{begin:e.UNDERSCORE_IDENT_RE+"\\s",end:";|{",returnBegin:!0,contains:[{className:"attribute",begin:e.UNDERSCORE_IDENT_RE,starts:a}],relevance:0}],illegal:"[^\\s\\}]"}}}());
+hljs.registerLanguage("objectivec",function(){"use strict";return function(e){var n=/[a-zA-Z@][a-zA-Z0-9_]*/,_={$pattern:n,keyword:"@interface @class @protocol @implementation"};return{name:"Objective-C",aliases:["mm","objc","obj-c"],keywords:{$pattern:n,keyword:"int float while char export sizeof typedef const struct for union unsigned long volatile static bool mutable if do return goto void enum else break extern asm case short default double register explicit signed typename this switch continue wchar_t inline readonly assign readwrite self @synchronized id typeof nonatomic super unichar IBOutlet IBAction strong weak copy in out inout bycopy byref oneway __strong __weak __block __autoreleasing @private @protected @public @try @property @end @throw @catch @finally @autoreleasepool @synthesize @dynamic @selector @optional @required @encode @package @import @defs @compatibility_alias __bridge __bridge_transfer __bridge_retained __bridge_retain __covariant __contravariant __kindof _Nonnull _Nullable _Null_unspecified __FUNCTION__ __PRETTY_FUNCTION__ __attribute__ getter setter retain unsafe_unretained nonnull nullable null_unspecified null_resettable class instancetype NS_DESIGNATED_INITIALIZER NS_UNAVAILABLE NS_REQUIRES_SUPER NS_RETURNS_INNER_POINTER NS_INLINE NS_AVAILABLE NS_DEPRECATED NS_ENUM NS_OPTIONS NS_SWIFT_UNAVAILABLE NS_ASSUME_NONNULL_BEGIN NS_ASSUME_NONNULL_END NS_REFINED_FOR_SWIFT NS_SWIFT_NAME NS_SWIFT_NOTHROW NS_DURING NS_HANDLER NS_ENDHANDLER NS_VALUERETURN NS_VOIDRETURN",literal:"false true FALSE TRUE nil YES NO NULL",built_in:"BOOL dispatch_once_t dispatch_queue_t dispatch_sync dispatch_async dispatch_once"},illegal:"/,end:/$/,illegal:"\\n"},e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{className:"class",begin:"("+_.keyword.split(" ").join("|")+")\\b",end:"({|$)",excludeEnd:!0,keywords:_,contains:[e.UNDERSCORE_TITLE_MODE]},{begin:"\\."+e.UNDERSCORE_IDENT_RE,relevance:0}]}}}());
+hljs.registerLanguage("perl",function(){"use strict";return function(e){var n={$pattern:/[\w.]+/,keyword:"getpwent getservent quotemeta msgrcv scalar kill dbmclose undef lc ma syswrite tr send umask sysopen shmwrite vec qx utime local oct semctl localtime readpipe do return format read sprintf dbmopen pop getpgrp not getpwnam rewinddir qq fileno qw endprotoent wait sethostent bless s|0 opendir continue each sleep endgrent shutdown dump chomp connect getsockname die socketpair close flock exists index shmget sub for endpwent redo lstat msgctl setpgrp abs exit select print ref gethostbyaddr unshift fcntl syscall goto getnetbyaddr join gmtime symlink semget splice x|0 getpeername recv log setsockopt cos last reverse gethostbyname getgrnam study formline endhostent times chop length gethostent getnetent pack getprotoent getservbyname rand mkdir pos chmod y|0 substr endnetent printf next open msgsnd readdir use unlink getsockopt getpriority rindex wantarray hex system getservbyport endservent int chr untie rmdir prototype tell listen fork shmread ucfirst setprotoent else sysseek link getgrgid shmctl waitpid unpack getnetbyname reset chdir grep split require caller lcfirst until warn while values shift telldir getpwuid my getprotobynumber delete and sort uc defined srand accept package seekdir getprotobyname semop our rename seek if q|0 chroot sysread setpwent no crypt getc chown sqrt write setnetent setpriority foreach tie sin msgget map stat getlogin unless elsif truncate exec keys glob tied closedir ioctl socket readlink eval xor readline binmode setservent eof ord bind alarm pipe atan2 getgrent exp time push setgrent gt lt or ne m|0 break given say state when"},t={className:"subst",begin:"[$@]\\{",end:"\\}",keywords:n},s={begin:"->{",end:"}"},r={variants:[{begin:/\$\d/},{begin:/[\$%@](\^\w\b|#\w+(::\w+)*|{\w+}|\w+(::\w*)*)/},{begin:/[\$%@][^\s\w{]/,relevance:0}]},i=[e.BACKSLASH_ESCAPE,t,r],a=[r,e.HASH_COMMENT_MODE,e.COMMENT("^\\=\\w","\\=cut",{endsWithParent:!0}),s,{className:"string",contains:i,variants:[{begin:"q[qwxr]?\\s*\\(",end:"\\)",relevance:5},{begin:"q[qwxr]?\\s*\\[",end:"\\]",relevance:5},{begin:"q[qwxr]?\\s*\\{",end:"\\}",relevance:5},{begin:"q[qwxr]?\\s*\\|",end:"\\|",relevance:5},{begin:"q[qwxr]?\\s*\\<",end:"\\>",relevance:5},{begin:"qw\\s+q",end:"q",relevance:5},{begin:"'",end:"'",contains:[e.BACKSLASH_ESCAPE]},{begin:'"',end:'"'},{begin:"`",end:"`",contains:[e.BACKSLASH_ESCAPE]},{begin:"{\\w+}",contains:[],relevance:0},{begin:"-?\\w+\\s*\\=\\>",contains:[],relevance:0}]},{className:"number",begin:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",relevance:0},{begin:"(\\/\\/|"+e.RE_STARTERS_RE+"|\\b(split|return|print|reverse|grep)\\b)\\s*",keywords:"split return print reverse grep",relevance:0,contains:[e.HASH_COMMENT_MODE,{className:"regexp",begin:"(s|tr|y)/(\\\\.|[^/])*/(\\\\.|[^/])*/[a-z]*",relevance:10},{className:"regexp",begin:"(m|qr)?/",end:"/[a-z]*",contains:[e.BACKSLASH_ESCAPE],relevance:0}]},{className:"function",beginKeywords:"sub",end:"(\\s*\\(.*?\\))?[;{]",excludeEnd:!0,relevance:5,contains:[e.TITLE_MODE]},{begin:"-\\w\\b",relevance:0},{begin:"^__DATA__$",end:"^__END__$",subLanguage:"mojolicious",contains:[{begin:"^@@.*",end:"$",className:"comment"}]}];return t.contains=a,s.contains=a,{name:"Perl",aliases:["pl","pm"],keywords:n,contains:a}}}());
+hljs.registerLanguage("php",function(){"use strict";return function(e){var r={begin:"\\$+[a-zA-Z_-ÿ][a-zA-Z0-9_-ÿ]*"},t={className:"meta",variants:[{begin:/<\?php/,relevance:10},{begin:/<\?[=]?/},{begin:/\?>/}]},a={className:"string",contains:[e.BACKSLASH_ESCAPE,t],variants:[{begin:'b"',end:'"'},{begin:"b'",end:"'"},e.inherit(e.APOS_STRING_MODE,{illegal:null}),e.inherit(e.QUOTE_STRING_MODE,{illegal:null})]},n={variants:[e.BINARY_NUMBER_MODE,e.C_NUMBER_MODE]},i={keyword:"__CLASS__ __DIR__ __FILE__ __FUNCTION__ __LINE__ __METHOD__ __NAMESPACE__ __TRAIT__ die echo exit include include_once print require require_once array abstract and as binary bool boolean break callable case catch class clone const continue declare default do double else elseif empty enddeclare endfor endforeach endif endswitch endwhile eval extends final finally float for foreach from global goto if implements instanceof insteadof int integer interface isset iterable list new object or private protected public real return string switch throw trait try unset use var void while xor yield",literal:"false null true",built_in:"Error|0 AppendIterator ArgumentCountError ArithmeticError ArrayIterator ArrayObject AssertionError BadFunctionCallException BadMethodCallException CachingIterator CallbackFilterIterator CompileError Countable DirectoryIterator DivisionByZeroError DomainException EmptyIterator ErrorException Exception FilesystemIterator FilterIterator GlobIterator InfiniteIterator InvalidArgumentException IteratorIterator LengthException LimitIterator LogicException MultipleIterator NoRewindIterator OutOfBoundsException OutOfRangeException OuterIterator OverflowException ParentIterator ParseError RangeException RecursiveArrayIterator RecursiveCachingIterator RecursiveCallbackFilterIterator RecursiveDirectoryIterator RecursiveFilterIterator RecursiveIterator RecursiveIteratorIterator RecursiveRegexIterator RecursiveTreeIterator RegexIterator RuntimeException SeekableIterator SplDoublyLinkedList SplFileInfo SplFileObject SplFixedArray SplHeap SplMaxHeap SplMinHeap SplObjectStorage SplObserver SplObserver SplPriorityQueue SplQueue SplStack SplSubject SplSubject SplTempFileObject TypeError UnderflowException UnexpectedValueException ArrayAccess Closure Generator Iterator IteratorAggregate Serializable Throwable Traversable WeakReference Directory __PHP_Incomplete_Class parent php_user_filter self static stdClass"};return{aliases:["php","php3","php4","php5","php6","php7"],case_insensitive:!0,keywords:i,contains:[e.HASH_COMMENT_MODE,e.COMMENT("//","$",{contains:[t]}),e.COMMENT("/\\*","\\*/",{contains:[{className:"doctag",begin:"@[A-Za-z]+"}]}),e.COMMENT("__halt_compiler.+?;",!1,{endsWithParent:!0,keywords:"__halt_compiler"}),{className:"string",begin:/<<<['"]?\w+['"]?$/,end:/^\w+;?$/,contains:[e.BACKSLASH_ESCAPE,{className:"subst",variants:[{begin:/\$\w+/},{begin:/\{\$/,end:/\}/}]}]},t,{className:"keyword",begin:/\$this\b/},r,{begin:/(::|->)+[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/},{className:"function",beginKeywords:"fn function",end:/[;{]/,excludeEnd:!0,illegal:"[$%\\[]",contains:[e.UNDERSCORE_TITLE_MODE,{className:"params",begin:"\\(",end:"\\)",excludeBegin:!0,excludeEnd:!0,keywords:i,contains:["self",r,e.C_BLOCK_COMMENT_MODE,a,n]}]},{className:"class",beginKeywords:"class interface",end:"{",excludeEnd:!0,illegal:/[:\(\$"]/,contains:[{beginKeywords:"extends implements"},e.UNDERSCORE_TITLE_MODE]},{beginKeywords:"namespace",end:";",illegal:/[\.']/,contains:[e.UNDERSCORE_TITLE_MODE]},{beginKeywords:"use",end:";",contains:[e.UNDERSCORE_TITLE_MODE]},{begin:"=>"},a,n]}}}());
+hljs.registerLanguage("php-template",function(){"use strict";return function(n){return{name:"PHP template",subLanguage:"xml",contains:[{begin:/<\?(php|=)?/,end:/\?>/,subLanguage:"php",contains:[{begin:"/\\*",end:"\\*/",skip:!0},{begin:'b"',end:'"',skip:!0},{begin:"b'",end:"'",skip:!0},n.inherit(n.APOS_STRING_MODE,{illegal:null,className:null,contains:null,skip:!0}),n.inherit(n.QUOTE_STRING_MODE,{illegal:null,className:null,contains:null,skip:!0})]}]}}}());
+hljs.registerLanguage("plaintext",function(){"use strict";return function(t){return{name:"Plain text",aliases:["text","txt"],disableAutodetect:!0}}}());
+hljs.registerLanguage("properties",function(){"use strict";return function(e){var n="[ \\t\\f]*",t="("+n+"[:=]"+n+"|[ \\t\\f]+)",a="([^\\\\:= \\t\\f\\n]|\\\\.)+",s={end:t,relevance:0,starts:{className:"string",end:/$/,relevance:0,contains:[{begin:"\\\\\\n"}]}};return{name:".properties",case_insensitive:!0,illegal:/\S/,contains:[e.COMMENT("^\\s*[!#]","$"),{begin:"([^\\\\\\W:= \\t\\f\\n]|\\\\.)+"+t,returnBegin:!0,contains:[{className:"attr",begin:"([^\\\\\\W:= \\t\\f\\n]|\\\\.)+",endsParent:!0,relevance:0}],starts:s},{begin:a+t,returnBegin:!0,relevance:0,contains:[{className:"meta",begin:a,endsParent:!0,relevance:0}],starts:s},{className:"attr",relevance:0,begin:a+n+"$"}]}}}());
+hljs.registerLanguage("python",function(){"use strict";return function(e){var n={keyword:"and elif is global as in if from raise for except finally print import pass return exec else break not with class assert yield try while continue del or def lambda async await nonlocal|10",built_in:"Ellipsis NotImplemented",literal:"False None True"},a={className:"meta",begin:/^(>>>|\.\.\.) /},i={className:"subst",begin:/\{/,end:/\}/,keywords:n,illegal:/#/},s={begin:/\{\{/,relevance:0},r={className:"string",contains:[e.BACKSLASH_ESCAPE],variants:[{begin:/(u|b)?r?'''/,end:/'''/,contains:[e.BACKSLASH_ESCAPE,a],relevance:10},{begin:/(u|b)?r?"""/,end:/"""/,contains:[e.BACKSLASH_ESCAPE,a],relevance:10},{begin:/(fr|rf|f)'''/,end:/'''/,contains:[e.BACKSLASH_ESCAPE,a,s,i]},{begin:/(fr|rf|f)"""/,end:/"""/,contains:[e.BACKSLASH_ESCAPE,a,s,i]},{begin:/(u|r|ur)'/,end:/'/,relevance:10},{begin:/(u|r|ur)"/,end:/"/,relevance:10},{begin:/(b|br)'/,end:/'/},{begin:/(b|br)"/,end:/"/},{begin:/(fr|rf|f)'/,end:/'/,contains:[e.BACKSLASH_ESCAPE,s,i]},{begin:/(fr|rf|f)"/,end:/"/,contains:[e.BACKSLASH_ESCAPE,s,i]},e.APOS_STRING_MODE,e.QUOTE_STRING_MODE]},l={className:"number",relevance:0,variants:[{begin:e.BINARY_NUMBER_RE+"[lLjJ]?"},{begin:"\\b(0o[0-7]+)[lLjJ]?"},{begin:e.C_NUMBER_RE+"[lLjJ]?"}]},t={className:"params",variants:[{begin:/\(\s*\)/,skip:!0,className:null},{begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,contains:["self",a,l,r,e.HASH_COMMENT_MODE]}]};return i.contains=[r,l,a],{name:"Python",aliases:["py","gyp","ipython"],keywords:n,illegal:/(<\/|->|\?)|=>/,contains:[a,l,{beginKeywords:"if",relevance:0},r,e.HASH_COMMENT_MODE,{variants:[{className:"function",beginKeywords:"def"},{className:"class",beginKeywords:"class"}],end:/:/,illegal:/[${=;\n,]/,contains:[e.UNDERSCORE_TITLE_MODE,t,{begin:/->/,endsWithParent:!0,keywords:"None"}]},{className:"meta",begin:/^[\t ]*@/,end:/$/},{begin:/\b(print|exec)\(/}]}}}());
+hljs.registerLanguage("python-repl",function(){"use strict";return function(n){return{aliases:["pycon"],contains:[{className:"meta",starts:{end:/ |$/,starts:{end:"$",subLanguage:"python"}},variants:[{begin:/^>>>(?=[ ]|$)/},{begin:/^\.\.\.(?=[ ]|$)/}]}]}}}());
+hljs.registerLanguage("ruby",function(){"use strict";return function(e){var n="[a-zA-Z_]\\w*[!?=]?|[-+~]\\@|<<|>>|=~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~`|]|\\[\\]=?",a={keyword:"and then defined module in return redo if BEGIN retry end for self when next until do begin unless END rescue else break undef not super class case require yield alias while ensure elsif or include attr_reader attr_writer attr_accessor",literal:"true false nil"},s={className:"doctag",begin:"@[A-Za-z]+"},i={begin:"#<",end:">"},r=[e.COMMENT("#","$",{contains:[s]}),e.COMMENT("^\\=begin","^\\=end",{contains:[s],relevance:10}),e.COMMENT("^__END__","\\n$")],c={className:"subst",begin:"#\\{",end:"}",keywords:a},t={className:"string",contains:[e.BACKSLASH_ESCAPE,c],variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/`/,end:/`/},{begin:"%[qQwWx]?\\(",end:"\\)"},{begin:"%[qQwWx]?\\[",end:"\\]"},{begin:"%[qQwWx]?{",end:"}"},{begin:"%[qQwWx]?<",end:">"},{begin:"%[qQwWx]?/",end:"/"},{begin:"%[qQwWx]?%",end:"%"},{begin:"%[qQwWx]?-",end:"-"},{begin:"%[qQwWx]?\\|",end:"\\|"},{begin:/\B\?(\\\d{1,3}|\\x[A-Fa-f0-9]{1,2}|\\u[A-Fa-f0-9]{4}|\\?\S)\b/},{begin:/<<[-~]?'?(\w+)(?:.|\n)*?\n\s*\1\b/,returnBegin:!0,contains:[{begin:/<<[-~]?'?/},e.END_SAME_AS_BEGIN({begin:/(\w+)/,end:/(\w+)/,contains:[e.BACKSLASH_ESCAPE,c]})]}]},b={className:"params",begin:"\\(",end:"\\)",endsParent:!0,keywords:a},d=[t,i,{className:"class",beginKeywords:"class module",end:"$|;",illegal:/=/,contains:[e.inherit(e.TITLE_MODE,{begin:"[A-Za-z_]\\w*(::\\w+)*(\\?|\\!)?"}),{begin:"<\\s*",contains:[{begin:"("+e.IDENT_RE+"::)?"+e.IDENT_RE}]}].concat(r)},{className:"function",beginKeywords:"def",end:"$|;",contains:[e.inherit(e.TITLE_MODE,{begin:n}),b].concat(r)},{begin:e.IDENT_RE+"::"},{className:"symbol",begin:e.UNDERSCORE_IDENT_RE+"(\\!|\\?)?:",relevance:0},{className:"symbol",begin:":(?!\\s)",contains:[t,{begin:n}],relevance:0},{className:"number",begin:"(\\b0[0-7_]+)|(\\b0x[0-9a-fA-F_]+)|(\\b[1-9][0-9_]*(\\.[0-9_]+)?)|[0_]\\b",relevance:0},{begin:"(\\$\\W)|((\\$|\\@\\@?)(\\w+))"},{className:"params",begin:/\|/,end:/\|/,keywords:a},{begin:"("+e.RE_STARTERS_RE+"|unless)\\s*",keywords:"unless",contains:[i,{className:"regexp",contains:[e.BACKSLASH_ESCAPE,c],illegal:/\n/,variants:[{begin:"/",end:"/[a-z]*"},{begin:"%r{",end:"}[a-z]*"},{begin:"%r\\(",end:"\\)[a-z]*"},{begin:"%r!",end:"![a-z]*"},{begin:"%r\\[",end:"\\][a-z]*"}]}].concat(r),relevance:0}].concat(r);c.contains=d,b.contains=d;var g=[{begin:/^\s*=>/,starts:{end:"$",contains:d}},{className:"meta",begin:"^([>?]>|[\\w#]+\\(\\w+\\):\\d+:\\d+>|(\\w+-)?\\d+\\.\\d+\\.\\d(p\\d+)?[^>]+>)",starts:{end:"$",contains:d}}];return{name:"Ruby",aliases:["rb","gemspec","podspec","thor","irb"],keywords:a,illegal:/\/\*/,contains:r.concat(g).concat(d)}}}());
+hljs.registerLanguage("rust",function(){"use strict";return function(e){var n="([ui](8|16|32|64|128|size)|f(32|64))?",t="drop i8 i16 i32 i64 i128 isize u8 u16 u32 u64 u128 usize f32 f64 str char bool Box Option Result String Vec Copy Send Sized Sync Drop Fn FnMut FnOnce ToOwned Clone Debug PartialEq PartialOrd Eq Ord AsRef AsMut Into From Default Iterator Extend IntoIterator DoubleEndedIterator ExactSizeIterator SliceConcatExt ToString assert! assert_eq! bitflags! bytes! cfg! col! concat! concat_idents! debug_assert! debug_assert_eq! env! panic! file! format! format_args! include_bin! include_str! line! local_data_key! module_path! option_env! print! println! select! stringify! try! unimplemented! unreachable! vec! write! writeln! macro_rules! assert_ne! debug_assert_ne!";return{name:"Rust",aliases:["rs"],keywords:{$pattern:e.IDENT_RE+"!?",keyword:"abstract as async await become box break const continue crate do dyn else enum extern false final fn for if impl in let loop macro match mod move mut override priv pub ref return self Self static struct super trait true try type typeof unsafe unsized use virtual where while yield",literal:"true false Some None Ok Err",built_in:t},illegal:""}]}}}());
+hljs.registerLanguage("scss",function(){"use strict";return function(e){var t={className:"variable",begin:"(\\$[a-zA-Z-][a-zA-Z0-9_-]*)\\b"},i={className:"number",begin:"#[0-9A-Fa-f]+"};return e.CSS_NUMBER_MODE,e.QUOTE_STRING_MODE,e.APOS_STRING_MODE,e.C_BLOCK_COMMENT_MODE,{name:"SCSS",case_insensitive:!0,illegal:"[=/|']",contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,{className:"selector-id",begin:"\\#[A-Za-z0-9_-]+",relevance:0},{className:"selector-class",begin:"\\.[A-Za-z0-9_-]+",relevance:0},{className:"selector-attr",begin:"\\[",end:"\\]",illegal:"$"},{className:"selector-tag",begin:"\\b(a|abbr|acronym|address|area|article|aside|audio|b|base|big|blockquote|body|br|button|canvas|caption|cite|code|col|colgroup|command|datalist|dd|del|details|dfn|div|dl|dt|em|embed|fieldset|figcaption|figure|footer|form|frame|frameset|(h[1-6])|head|header|hgroup|hr|html|i|iframe|img|input|ins|kbd|keygen|label|legend|li|link|map|mark|meta|meter|nav|noframes|noscript|object|ol|optgroup|option|output|p|param|pre|progress|q|rp|rt|ruby|samp|script|section|select|small|span|strike|strong|style|sub|sup|table|tbody|td|textarea|tfoot|th|thead|time|title|tr|tt|ul|var|video)\\b",relevance:0},{className:"selector-pseudo",begin:":(visited|valid|root|right|required|read-write|read-only|out-range|optional|only-of-type|only-child|nth-of-type|nth-last-of-type|nth-last-child|nth-child|not|link|left|last-of-type|last-child|lang|invalid|indeterminate|in-range|hover|focus|first-of-type|first-line|first-letter|first-child|first|enabled|empty|disabled|default|checked|before|after|active)"},{className:"selector-pseudo",begin:"::(after|before|choices|first-letter|first-line|repeat-index|repeat-item|selection|value)"},t,{className:"attribute",begin:"\\b(src|z-index|word-wrap|word-spacing|word-break|width|widows|white-space|visibility|vertical-align|unicode-bidi|transition-timing-function|transition-property|transition-duration|transition-delay|transition|transform-style|transform-origin|transform|top|text-underline-position|text-transform|text-shadow|text-rendering|text-overflow|text-indent|text-decoration-style|text-decoration-line|text-decoration-color|text-decoration|text-align-last|text-align|tab-size|table-layout|right|resize|quotes|position|pointer-events|perspective-origin|perspective|page-break-inside|page-break-before|page-break-after|padding-top|padding-right|padding-left|padding-bottom|padding|overflow-y|overflow-x|overflow-wrap|overflow|outline-width|outline-style|outline-offset|outline-color|outline|orphans|order|opacity|object-position|object-fit|normal|none|nav-up|nav-right|nav-left|nav-index|nav-down|min-width|min-height|max-width|max-height|mask|marks|margin-top|margin-right|margin-left|margin-bottom|margin|list-style-type|list-style-position|list-style-image|list-style|line-height|letter-spacing|left|justify-content|initial|inherit|ime-mode|image-orientation|image-resolution|image-rendering|icon|hyphens|height|font-weight|font-variant-ligatures|font-variant|font-style|font-stretch|font-size-adjust|font-size|font-language-override|font-kerning|font-feature-settings|font-family|font|float|flex-wrap|flex-shrink|flex-grow|flex-flow|flex-direction|flex-basis|flex|filter|empty-cells|display|direction|cursor|counter-reset|counter-increment|content|column-width|column-span|column-rule-width|column-rule-style|column-rule-color|column-rule|column-gap|column-fill|column-count|columns|color|clip-path|clip|clear|caption-side|break-inside|break-before|break-after|box-sizing|box-shadow|box-decoration-break|bottom|border-width|border-top-width|border-top-style|border-top-right-radius|border-top-left-radius|border-top-color|border-top|border-style|border-spacing|border-right-width|border-right-style|border-right-color|border-right|border-radius|border-left-width|border-left-style|border-left-color|border-left|border-image-width|border-image-source|border-image-slice|border-image-repeat|border-image-outset|border-image|border-color|border-collapse|border-bottom-width|border-bottom-style|border-bottom-right-radius|border-bottom-left-radius|border-bottom-color|border-bottom|border|background-size|background-repeat|background-position|background-origin|background-image|background-color|background-clip|background-attachment|background-blend-mode|background|backface-visibility|auto|animation-timing-function|animation-play-state|animation-name|animation-iteration-count|animation-fill-mode|animation-duration|animation-direction|animation-delay|animation|align-self|align-items|align-content)\\b",illegal:"[^\\s]"},{begin:"\\b(whitespace|wait|w-resize|visible|vertical-text|vertical-ideographic|uppercase|upper-roman|upper-alpha|underline|transparent|top|thin|thick|text|text-top|text-bottom|tb-rl|table-header-group|table-footer-group|sw-resize|super|strict|static|square|solid|small-caps|separate|se-resize|scroll|s-resize|rtl|row-resize|ridge|right|repeat|repeat-y|repeat-x|relative|progress|pointer|overline|outside|outset|oblique|nowrap|not-allowed|normal|none|nw-resize|no-repeat|no-drop|newspaper|ne-resize|n-resize|move|middle|medium|ltr|lr-tb|lowercase|lower-roman|lower-alpha|loose|list-item|line|line-through|line-edge|lighter|left|keep-all|justify|italic|inter-word|inter-ideograph|inside|inset|inline|inline-block|inherit|inactive|ideograph-space|ideograph-parenthesis|ideograph-numeric|ideograph-alpha|horizontal|hidden|help|hand|groove|fixed|ellipsis|e-resize|double|dotted|distribute|distribute-space|distribute-letter|distribute-all-lines|disc|disabled|default|decimal|dashed|crosshair|collapse|col-resize|circle|char|center|capitalize|break-word|break-all|bottom|both|bolder|bold|block|bidi-override|below|baseline|auto|always|all-scroll|absolute|table|table-cell)\\b"},{begin:":",end:";",contains:[t,i,e.CSS_NUMBER_MODE,e.QUOTE_STRING_MODE,e.APOS_STRING_MODE,{className:"meta",begin:"!important"}]},{begin:"@(page|font-face)",lexemes:"@[a-z-]+",keywords:"@page @font-face"},{begin:"@",end:"[{;]",returnBegin:!0,keywords:"and or not only",contains:[{begin:"@[a-z-]+",className:"keyword"},t,e.QUOTE_STRING_MODE,e.APOS_STRING_MODE,i,e.CSS_NUMBER_MODE]}]}}}());
+hljs.registerLanguage("shell",function(){"use strict";return function(s){return{name:"Shell Session",aliases:["console"],contains:[{className:"meta",begin:"^\\s{0,3}[/\\w\\d\\[\\]()@-]*[>%$#]",starts:{end:"$",subLanguage:"bash"}}]}}}());
+hljs.registerLanguage("sql",function(){"use strict";return function(e){var t=e.COMMENT("--","$");return{name:"SQL",case_insensitive:!0,illegal:/[<>{}*]/,contains:[{beginKeywords:"begin end start commit rollback savepoint lock alter create drop rename call delete do handler insert load replace select truncate update set show pragma grant merge describe use explain help declare prepare execute deallocate release unlock purge reset change stop analyze cache flush optimize repair kill install uninstall checksum restore check backup revoke comment values with",end:/;/,endsWithParent:!0,keywords:{$pattern:/[\w\.]+/,keyword:"as abort abs absolute acc acce accep accept access accessed accessible account acos action activate add addtime admin administer advanced advise aes_decrypt aes_encrypt after agent aggregate ali alia alias all allocate allow alter always analyze ancillary and anti any anydata anydataset anyschema anytype apply archive archived archivelog are as asc ascii asin assembly assertion associate asynchronous at atan atn2 attr attri attrib attribu attribut attribute attributes audit authenticated authentication authid authors auto autoallocate autodblink autoextend automatic availability avg backup badfile basicfile before begin beginning benchmark between bfile bfile_base big bigfile bin binary_double binary_float binlog bit_and bit_count bit_length bit_or bit_xor bitmap blob_base block blocksize body both bound bucket buffer_cache buffer_pool build bulk by byte byteordermark bytes cache caching call calling cancel capacity cascade cascaded case cast catalog category ceil ceiling chain change changed char_base char_length character_length characters characterset charindex charset charsetform charsetid check checksum checksum_agg child choose chr chunk class cleanup clear client clob clob_base clone close cluster_id cluster_probability cluster_set clustering coalesce coercibility col collate collation collect colu colum column column_value columns columns_updated comment commit compact compatibility compiled complete composite_limit compound compress compute concat concat_ws concurrent confirm conn connec connect connect_by_iscycle connect_by_isleaf connect_by_root connect_time connection consider consistent constant constraint constraints constructor container content contents context contributors controlfile conv convert convert_tz corr corr_k corr_s corresponding corruption cos cost count count_big counted covar_pop covar_samp cpu_per_call cpu_per_session crc32 create creation critical cross cube cume_dist curdate current current_date current_time current_timestamp current_user cursor curtime customdatum cycle data database databases datafile datafiles datalength date_add date_cache date_format date_sub dateadd datediff datefromparts datename datepart datetime2fromparts day day_to_second dayname dayofmonth dayofweek dayofyear days db_role_change dbtimezone ddl deallocate declare decode decompose decrement decrypt deduplicate def defa defau defaul default defaults deferred defi defin define degrees delayed delegate delete delete_all delimited demand dense_rank depth dequeue des_decrypt des_encrypt des_key_file desc descr descri describ describe descriptor deterministic diagnostics difference dimension direct_load directory disable disable_all disallow disassociate discardfile disconnect diskgroup distinct distinctrow distribute distributed div do document domain dotnet double downgrade drop dumpfile duplicate duration each edition editionable editions element ellipsis else elsif elt empty enable enable_all enclosed encode encoding encrypt end end-exec endian enforced engine engines enqueue enterprise entityescaping eomonth error errors escaped evalname evaluate event eventdata events except exception exceptions exchange exclude excluding execu execut execute exempt exists exit exp expire explain explode export export_set extended extent external external_1 external_2 externally extract failed failed_login_attempts failover failure far fast feature_set feature_value fetch field fields file file_name_convert filesystem_like_logging final finish first first_value fixed flash_cache flashback floor flush following follows for forall force foreign form forma format found found_rows freelist freelists freepools fresh from from_base64 from_days ftp full function general generated get get_format get_lock getdate getutcdate global global_name globally go goto grant grants greatest group group_concat group_id grouping grouping_id groups gtid_subtract guarantee guard handler hash hashkeys having hea head headi headin heading heap help hex hierarchy high high_priority hosts hour hours http id ident_current ident_incr ident_seed identified identity idle_time if ifnull ignore iif ilike ilm immediate import in include including increment index indexes indexing indextype indicator indices inet6_aton inet6_ntoa inet_aton inet_ntoa infile initial initialized initially initrans inmemory inner innodb input insert install instance instantiable instr interface interleaved intersect into invalidate invisible is is_free_lock is_ipv4 is_ipv4_compat is_not is_not_null is_used_lock isdate isnull isolation iterate java join json json_exists keep keep_duplicates key keys kill language large last last_day last_insert_id last_value lateral lax lcase lead leading least leaves left len lenght length less level levels library like like2 like4 likec limit lines link list listagg little ln load load_file lob lobs local localtime localtimestamp locate locator lock locked log log10 log2 logfile logfiles logging logical logical_reads_per_call logoff logon logs long loop low low_priority lower lpad lrtrim ltrim main make_set makedate maketime managed management manual map mapping mask master master_pos_wait match matched materialized max maxextents maximize maxinstances maxlen maxlogfiles maxloghistory maxlogmembers maxsize maxtrans md5 measures median medium member memcompress memory merge microsecond mid migration min minextents minimum mining minus minute minutes minvalue missing mod mode model modification modify module monitoring month months mount move movement multiset mutex name name_const names nan national native natural nav nchar nclob nested never new newline next nextval no no_write_to_binlog noarchivelog noaudit nobadfile nocheck nocompress nocopy nocycle nodelay nodiscardfile noentityescaping noguarantee nokeep nologfile nomapping nomaxvalue nominimize nominvalue nomonitoring none noneditionable nonschema noorder nopr nopro noprom nopromp noprompt norely noresetlogs noreverse normal norowdependencies noschemacheck noswitch not nothing notice notnull notrim novalidate now nowait nth_value nullif nulls num numb numbe nvarchar nvarchar2 object ocicoll ocidate ocidatetime ociduration ociinterval ociloblocator ocinumber ociref ocirefcursor ocirowid ocistring ocitype oct octet_length of off offline offset oid oidindex old on online only opaque open operations operator optimal optimize option optionally or oracle oracle_date oradata ord ordaudio orddicom orddoc order ordimage ordinality ordvideo organization orlany orlvary out outer outfile outline output over overflow overriding package pad parallel parallel_enable parameters parent parse partial partition partitions pascal passing password password_grace_time password_lock_time password_reuse_max password_reuse_time password_verify_function patch path patindex pctincrease pctthreshold pctused pctversion percent percent_rank percentile_cont percentile_disc performance period period_add period_diff permanent physical pi pipe pipelined pivot pluggable plugin policy position post_transaction pow power pragma prebuilt precedes preceding precision prediction prediction_cost prediction_details prediction_probability prediction_set prepare present preserve prior priority private private_sga privileges procedural procedure procedure_analyze processlist profiles project prompt protection public publishingservername purge quarter query quick quiesce quota quotename radians raise rand range rank raw read reads readsize rebuild record records recover recovery recursive recycle redo reduced ref reference referenced references referencing refresh regexp_like register regr_avgx regr_avgy regr_count regr_intercept regr_r2 regr_slope regr_sxx regr_sxy reject rekey relational relative relaylog release release_lock relies_on relocate rely rem remainder rename repair repeat replace replicate replication required reset resetlogs resize resource respect restore restricted result result_cache resumable resume retention return returning returns reuse reverse revoke right rlike role roles rollback rolling rollup round row row_count rowdependencies rowid rownum rows rtrim rules safe salt sample save savepoint sb1 sb2 sb4 scan schema schemacheck scn scope scroll sdo_georaster sdo_topo_geometry search sec_to_time second seconds section securefile security seed segment select self semi sequence sequential serializable server servererror session session_user sessions_per_user set sets settings sha sha1 sha2 share shared shared_pool short show shrink shutdown si_averagecolor si_colorhistogram si_featurelist si_positionalcolor si_stillimage si_texture siblings sid sign sin size size_t sizes skip slave sleep smalldatetimefromparts smallfile snapshot some soname sort soundex source space sparse spfile split sql sql_big_result sql_buffer_result sql_cache sql_calc_found_rows sql_small_result sql_variant_property sqlcode sqldata sqlerror sqlname sqlstate sqrt square standalone standby start starting startup statement static statistics stats_binomial_test stats_crosstab stats_ks_test stats_mode stats_mw_test stats_one_way_anova stats_t_test_ stats_t_test_indep stats_t_test_one stats_t_test_paired stats_wsr_test status std stddev stddev_pop stddev_samp stdev stop storage store stored str str_to_date straight_join strcmp strict string struct stuff style subdate subpartition subpartitions substitutable substr substring subtime subtring_index subtype success sum suspend switch switchoffset switchover sync synchronous synonym sys sys_xmlagg sysasm sysaux sysdate sysdatetimeoffset sysdba sysoper system system_user sysutcdatetime table tables tablespace tablesample tan tdo template temporary terminated tertiary_weights test than then thread through tier ties time time_format time_zone timediff timefromparts timeout timestamp timestampadd timestampdiff timezone_abbr timezone_minute timezone_region to to_base64 to_date to_days to_seconds todatetimeoffset trace tracking transaction transactional translate translation treat trigger trigger_nestlevel triggers trim truncate try_cast try_convert try_parse type ub1 ub2 ub4 ucase unarchived unbounded uncompress under undo unhex unicode uniform uninstall union unique unix_timestamp unknown unlimited unlock unnest unpivot unrecoverable unsafe unsigned until untrusted unusable unused update updated upgrade upped upper upsert url urowid usable usage use use_stored_outlines user user_data user_resources users using utc_date utc_timestamp uuid uuid_short validate validate_password_strength validation valist value values var var_samp varcharc vari varia variab variabl variable variables variance varp varraw varrawc varray verify version versions view virtual visible void wait wallet warning warnings week weekday weekofyear wellformed when whene whenev wheneve whenever where while whitespace window with within without work wrapped xdb xml xmlagg xmlattributes xmlcast xmlcolattval xmlelement xmlexists xmlforest xmlindex xmlnamespaces xmlpi xmlquery xmlroot xmlschema xmlserialize xmltable xmltype xor year year_to_month years yearweek",literal:"true false null unknown",built_in:"array bigint binary bit blob bool boolean char character date dec decimal float int int8 integer interval number numeric real record serial serial8 smallint text time timestamp tinyint varchar varchar2 varying void"},contains:[{className:"string",begin:"'",end:"'",contains:[{begin:"''"}]},{className:"string",begin:'"',end:'"',contains:[{begin:'""'}]},{className:"string",begin:"`",end:"`"},e.C_NUMBER_MODE,e.C_BLOCK_COMMENT_MODE,t,e.HASH_COMMENT_MODE]},e.C_BLOCK_COMMENT_MODE,t,e.HASH_COMMENT_MODE]}}}());
+hljs.registerLanguage("swift",function(){"use strict";return function(e){var i={keyword:"#available #colorLiteral #column #else #elseif #endif #file #fileLiteral #function #if #imageLiteral #line #selector #sourceLocation _ __COLUMN__ __FILE__ __FUNCTION__ __LINE__ Any as as! as? associatedtype associativity break case catch class continue convenience default defer deinit didSet do dynamic dynamicType else enum extension fallthrough false fileprivate final for func get guard if import in indirect infix init inout internal is lazy left let mutating nil none nonmutating open operator optional override postfix precedence prefix private protocol Protocol public repeat required rethrows return right self Self set static struct subscript super switch throw throws true try try! try? Type typealias unowned var weak where while willSet",literal:"true false nil",built_in:"abs advance alignof alignofValue anyGenerator assert assertionFailure bridgeFromObjectiveC bridgeFromObjectiveCUnconditional bridgeToObjectiveC bridgeToObjectiveCUnconditional c compactMap contains count countElements countLeadingZeros debugPrint debugPrintln distance dropFirst dropLast dump encodeBitsAsWords enumerate equal fatalError filter find getBridgedObjectiveCType getVaList indices insertionSort isBridgedToObjectiveC isBridgedVerbatimToObjectiveC isUniquelyReferenced isUniquelyReferencedNonObjC join lazy lexicographicalCompare map max maxElement min minElement numericCast overlaps partition posix precondition preconditionFailure print println quickSort readLine reduce reflect reinterpretCast reverse roundUpToAlignment sizeof sizeofValue sort split startsWith stride strideof strideofValue swap toString transcode underestimateCount unsafeAddressOf unsafeBitCast unsafeDowncast unsafeUnwrap unsafeReflect withExtendedLifetime withObjectAtPlusZero withUnsafePointer withUnsafePointerToObject withUnsafeMutablePointer withUnsafeMutablePointers withUnsafePointer withUnsafePointers withVaList zip"},n=e.COMMENT("/\\*","\\*/",{contains:["self"]}),t={className:"subst",begin:/\\\(/,end:"\\)",keywords:i,contains:[]},a={className:"string",contains:[e.BACKSLASH_ESCAPE,t],variants:[{begin:/"""/,end:/"""/},{begin:/"/,end:/"/}]},r={className:"number",begin:"\\b([\\d_]+(\\.[\\deE_]+)?|0x[a-fA-F0-9_]+(\\.[a-fA-F0-9p_]+)?|0b[01_]+|0o[0-7_]+)\\b",relevance:0};return t.contains=[r],{name:"Swift",keywords:i,contains:[a,e.C_LINE_COMMENT_MODE,n,{className:"type",begin:"\\b[A-Z][\\wÀ-ʸ']*[!?]"},{className:"type",begin:"\\b[A-Z][\\wÀ-ʸ']*",relevance:0},r,{className:"function",beginKeywords:"func",end:"{",excludeEnd:!0,contains:[e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/}),{begin://},{className:"params",begin:/\(/,end:/\)/,endsParent:!0,keywords:i,contains:["self",r,a,e.C_BLOCK_COMMENT_MODE,{begin:":"}],illegal:/["']/}],illegal:/\[|%/},{className:"class",beginKeywords:"struct protocol class extension enum",keywords:i,end:"\\{",excludeEnd:!0,contains:[e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][\u00C0-\u02B80-9A-Za-z$_]*/})]},{className:"meta",begin:"(@discardableResult|@warn_unused_result|@exported|@lazy|@noescape|@NSCopying|@NSManaged|@objc|@objcMembers|@convention|@required|@noreturn|@IBAction|@IBDesignable|@IBInspectable|@IBOutlet|@infix|@prefix|@postfix|@autoclosure|@testable|@available|@nonobjc|@NSApplicationMain|@UIApplicationMain|@dynamicMemberLookup|@propertyWrapper)\\b"},{beginKeywords:"import",end:/$/,contains:[e.C_LINE_COMMENT_MODE,n]}]}}}());
+hljs.registerLanguage("typescript",function(){"use strict";const e=["as","in","of","if","for","while","finally","var","new","function","do","return","void","else","break","catch","instanceof","with","throw","case","default","try","switch","continue","typeof","delete","let","yield","const","class","debugger","async","await","static","import","from","export","extends"],n=["true","false","null","undefined","NaN","Infinity"],a=[].concat(["setInterval","setTimeout","clearInterval","clearTimeout","require","exports","eval","isFinite","isNaN","parseFloat","parseInt","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","escape","unescape"],["arguments","this","super","console","window","document","localStorage","module","global"],["Intl","DataView","Number","Math","Date","String","RegExp","Object","Function","Boolean","Error","Symbol","Set","Map","WeakSet","WeakMap","Proxy","Reflect","JSON","Promise","Float64Array","Int16Array","Int32Array","Int8Array","Uint16Array","Uint32Array","Float32Array","Array","Uint8Array","Uint8ClampedArray","ArrayBuffer"],["EvalError","InternalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError"]);return function(r){var t={$pattern:"[A-Za-z$_][0-9A-Za-z$_]*",keyword:e.concat(["type","namespace","typedef","interface","public","private","protected","implements","declare","abstract","readonly"]).join(" "),literal:n.join(" "),built_in:a.concat(["any","void","number","boolean","string","object","never","enum"]).join(" ")},s={className:"meta",begin:"@[A-Za-z$_][0-9A-Za-z$_]*"},i={className:"number",variants:[{begin:"\\b(0[bB][01]+)n?"},{begin:"\\b(0[oO][0-7]+)n?"},{begin:r.C_NUMBER_RE+"n?"}],relevance:0},o={className:"subst",begin:"\\$\\{",end:"\\}",keywords:t,contains:[]},c={begin:"html`",end:"",starts:{end:"`",returnEnd:!1,contains:[r.BACKSLASH_ESCAPE,o],subLanguage:"xml"}},l={begin:"css`",end:"",starts:{end:"`",returnEnd:!1,contains:[r.BACKSLASH_ESCAPE,o],subLanguage:"css"}},E={className:"string",begin:"`",end:"`",contains:[r.BACKSLASH_ESCAPE,o]};o.contains=[r.APOS_STRING_MODE,r.QUOTE_STRING_MODE,c,l,E,i,r.REGEXP_MODE];var d={begin:"\\(",end:/\)/,keywords:t,contains:["self",r.QUOTE_STRING_MODE,r.APOS_STRING_MODE,r.NUMBER_MODE]},u={className:"params",begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:t,contains:[r.C_LINE_COMMENT_MODE,r.C_BLOCK_COMMENT_MODE,s,d]};return{name:"TypeScript",aliases:["ts"],keywords:t,contains:[r.SHEBANG(),{className:"meta",begin:/^\s*['"]use strict['"]/},r.APOS_STRING_MODE,r.QUOTE_STRING_MODE,c,l,E,r.C_LINE_COMMENT_MODE,r.C_BLOCK_COMMENT_MODE,i,{begin:"("+r.RE_STARTERS_RE+"|\\b(case|return|throw)\\b)\\s*",keywords:"return throw case",contains:[r.C_LINE_COMMENT_MODE,r.C_BLOCK_COMMENT_MODE,r.REGEXP_MODE,{className:"function",begin:"(\\([^(]*(\\([^(]*(\\([^(]*\\))?\\))?\\)|"+r.UNDERSCORE_IDENT_RE+")\\s*=>",returnBegin:!0,end:"\\s*=>",contains:[{className:"params",variants:[{begin:r.UNDERSCORE_IDENT_RE},{className:null,begin:/\(\s*\)/,skip:!0},{begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:t,contains:d.contains}]}]}],relevance:0},{className:"function",beginKeywords:"function",end:/[\{;]/,excludeEnd:!0,keywords:t,contains:["self",r.inherit(r.TITLE_MODE,{begin:"[A-Za-z$_][0-9A-Za-z$_]*"}),u],illegal:/%/,relevance:0},{beginKeywords:"constructor",end:/[\{;]/,excludeEnd:!0,contains:["self",u]},{begin:/module\./,keywords:{built_in:"module"},relevance:0},{beginKeywords:"module",end:/\{/,excludeEnd:!0},{beginKeywords:"interface",end:/\{/,excludeEnd:!0,keywords:"interface extends"},{begin:/\$[(.]/},{begin:"\\."+r.IDENT_RE,relevance:0},s,d]}}}());
+hljs.registerLanguage("yaml",function(){"use strict";return function(e){var n="true false yes no null",a="[\\w#;/?:@&=+$,.~*\\'()[\\]]+",s={className:"string",relevance:0,variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/\S+/}],contains:[e.BACKSLASH_ESCAPE,{className:"template-variable",variants:[{begin:"{{",end:"}}"},{begin:"%{",end:"}"}]}]},i=e.inherit(s,{variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/[^\s,{}[\]]+/}]}),l={end:",",endsWithParent:!0,excludeEnd:!0,contains:[],keywords:n,relevance:0},t={begin:"{",end:"}",contains:[l],illegal:"\\n",relevance:0},g={begin:"\\[",end:"\\]",contains:[l],illegal:"\\n",relevance:0},b=[{className:"attr",variants:[{begin:"\\w[\\w :\\/.-]*:(?=[ \t]|$)"},{begin:'"\\w[\\w :\\/.-]*":(?=[ \t]|$)'},{begin:"'\\w[\\w :\\/.-]*':(?=[ \t]|$)"}]},{className:"meta",begin:"^---s*$",relevance:10},{className:"string",begin:"[\\|>]([0-9]?[+-])?[ ]*\\n( *)[\\S ]+\\n(\\2[\\S ]+\\n?)*"},{begin:"<%[%=-]?",end:"[%-]?%>",subLanguage:"ruby",excludeBegin:!0,excludeEnd:!0,relevance:0},{className:"type",begin:"!\\w+!"+a},{className:"type",begin:"!<"+a+">"},{className:"type",begin:"!"+a},{className:"type",begin:"!!"+a},{className:"meta",begin:"&"+e.UNDERSCORE_IDENT_RE+"$"},{className:"meta",begin:"\\*"+e.UNDERSCORE_IDENT_RE+"$"},{className:"bullet",begin:"\\-(?=[ ]|$)",relevance:0},e.HASH_COMMENT_MODE,{beginKeywords:n,keywords:{literal:n}},{className:"number",begin:"\\b[0-9]{4}(-[0-9][0-9]){0,2}([Tt \\t][0-9][0-9]?(:[0-9][0-9]){2})?(\\.[0-9]*)?([ \\t])*(Z|[-+][0-9][0-9]?(:[0-9][0-9])?)?\\b"},{className:"number",begin:e.C_NUMBER_RE+"\\b"},t,g,s],c=[...b];return c.pop(),c.push(i),l.contains=c,{name:"YAML",case_insensitive:!0,aliases:["yml","YAML"],contains:b}}}());
+hljs.registerLanguage("armasm",function(){"use strict";return function(s){const e={variants:[s.COMMENT("^[ \\t]*(?=#)","$",{relevance:0,excludeBegin:!0}),s.COMMENT("[;@]","$",{relevance:0}),s.C_LINE_COMMENT_MODE,s.C_BLOCK_COMMENT_MODE]};return{name:"ARM Assembly",case_insensitive:!0,aliases:["arm"],keywords:{$pattern:"\\.?"+s.IDENT_RE,meta:".2byte .4byte .align .ascii .asciz .balign .byte .code .data .else .end .endif .endm .endr .equ .err .exitm .extern .global .hword .if .ifdef .ifndef .include .irp .long .macro .rept .req .section .set .skip .space .text .word .arm .thumb .code16 .code32 .force_thumb .thumb_func .ltorg ALIAS ALIGN ARM AREA ASSERT ATTR CN CODE CODE16 CODE32 COMMON CP DATA DCB DCD DCDU DCDO DCFD DCFDU DCI DCQ DCQU DCW DCWU DN ELIF ELSE END ENDFUNC ENDIF ENDP ENTRY EQU EXPORT EXPORTAS EXTERN FIELD FILL FUNCTION GBLA GBLL GBLS GET GLOBAL IF IMPORT INCBIN INCLUDE INFO KEEP LCLA LCLL LCLS LTORG MACRO MAP MEND MEXIT NOFP OPT PRESERVE8 PROC QN READONLY RELOC REQUIRE REQUIRE8 RLIST FN ROUT SETA SETL SETS SN SPACE SUBT THUMB THUMBX TTL WHILE WEND ",built_in:"r0 r1 r2 r3 r4 r5 r6 r7 r8 r9 r10 r11 r12 r13 r14 r15 pc lr sp ip sl sb fp a1 a2 a3 a4 v1 v2 v3 v4 v5 v6 v7 v8 f0 f1 f2 f3 f4 f5 f6 f7 p0 p1 p2 p3 p4 p5 p6 p7 p8 p9 p10 p11 p12 p13 p14 p15 c0 c1 c2 c3 c4 c5 c6 c7 c8 c9 c10 c11 c12 c13 c14 c15 q0 q1 q2 q3 q4 q5 q6 q7 q8 q9 q10 q11 q12 q13 q14 q15 cpsr_c cpsr_x cpsr_s cpsr_f cpsr_cx cpsr_cxs cpsr_xs cpsr_xsf cpsr_sf cpsr_cxsf spsr_c spsr_x spsr_s spsr_f spsr_cx spsr_cxs spsr_xs spsr_xsf spsr_sf spsr_cxsf s0 s1 s2 s3 s4 s5 s6 s7 s8 s9 s10 s11 s12 s13 s14 s15 s16 s17 s18 s19 s20 s21 s22 s23 s24 s25 s26 s27 s28 s29 s30 s31 d0 d1 d2 d3 d4 d5 d6 d7 d8 d9 d10 d11 d12 d13 d14 d15 d16 d17 d18 d19 d20 d21 d22 d23 d24 d25 d26 d27 d28 d29 d30 d31 {PC} {VAR} {TRUE} {FALSE} {OPT} {CONFIG} {ENDIAN} {CODESIZE} {CPU} {FPU} {ARCHITECTURE} {PCSTOREOFFSET} {ARMASM_VERSION} {INTER} {ROPI} {RWPI} {SWST} {NOSWST} . @"},contains:[{className:"keyword",begin:"\\b(adc|(qd?|sh?|u[qh]?)?add(8|16)?|usada?8|(q|sh?|u[qh]?)?(as|sa)x|and|adrl?|sbc|rs[bc]|asr|b[lx]?|blx|bxj|cbn?z|tb[bh]|bic|bfc|bfi|[su]bfx|bkpt|cdp2?|clz|clrex|cmp|cmn|cpsi[ed]|cps|setend|dbg|dmb|dsb|eor|isb|it[te]{0,3}|lsl|lsr|ror|rrx|ldm(([id][ab])|f[ds])?|ldr((s|ex)?[bhd])?|movt?|mvn|mra|mar|mul|[us]mull|smul[bwt][bt]|smu[as]d|smmul|smmla|mla|umlaal|smlal?([wbt][bt]|d)|mls|smlsl?[ds]|smc|svc|sev|mia([bt]{2}|ph)?|mrr?c2?|mcrr2?|mrs|msr|orr|orn|pkh(tb|bt)|rbit|rev(16|sh)?|sel|[su]sat(16)?|nop|pop|push|rfe([id][ab])?|stm([id][ab])?|str(ex)?[bhd]?|(qd?)?sub|(sh?|q|u[qh]?)?sub(8|16)|[su]xt(a?h|a?b(16)?)|srs([id][ab])?|swpb?|swi|smi|tst|teq|wfe|wfi|yield)(eq|ne|cs|cc|mi|pl|vs|vc|hi|ls|ge|lt|gt|le|al|hs|lo)?[sptrx]?(?=\\s)"},e,s.QUOTE_STRING_MODE,{className:"string",begin:"'",end:"[^\\\\]'",relevance:0},{className:"title",begin:"\\|",end:"\\|",illegal:"\\n",relevance:0},{className:"number",variants:[{begin:"[#$=]?0x[0-9a-f]+"},{begin:"[#$=]?0b[01]+"},{begin:"[#$=]\\d+"},{begin:"\\b\\d+"}],relevance:0},{className:"symbol",variants:[{begin:"^[ \\t]*[a-z_\\.\\$][a-z0-9_\\.\\$]+:"},{begin:"^[a-z_\\.\\$][a-z0-9_\\.\\$]+"},{begin:"[=#]\\w+"}],relevance:0}]}}}());
+hljs.registerLanguage("d",function(){"use strict";return function(e){var a={$pattern:e.UNDERSCORE_IDENT_RE,keyword:"abstract alias align asm assert auto body break byte case cast catch class const continue debug default delete deprecated do else enum export extern final finally for foreach foreach_reverse|10 goto if immutable import in inout int interface invariant is lazy macro mixin module new nothrow out override package pragma private protected public pure ref return scope shared static struct super switch synchronized template this throw try typedef typeid typeof union unittest version void volatile while with __FILE__ __LINE__ __gshared|10 __thread __traits __DATE__ __EOF__ __TIME__ __TIMESTAMP__ __VENDOR__ __VERSION__",built_in:"bool cdouble cent cfloat char creal dchar delegate double dstring float function idouble ifloat ireal long real short string ubyte ucent uint ulong ushort wchar wstring",literal:"false null true"},d="((0|[1-9][\\d_]*)|0[bB][01_]+|0[xX]([\\da-fA-F][\\da-fA-F_]*|_[\\da-fA-F][\\da-fA-F_]*))",n="\\\\(['\"\\?\\\\abfnrtv]|u[\\dA-Fa-f]{4}|[0-7]{1,3}|x[\\dA-Fa-f]{2}|U[\\dA-Fa-f]{8})|&[a-zA-Z\\d]{2,};",t={className:"number",begin:"\\b"+d+"(L|u|U|Lu|LU|uL|UL)?",relevance:0},_={className:"number",begin:"\\b(((0[xX](([\\da-fA-F][\\da-fA-F_]*|_[\\da-fA-F][\\da-fA-F_]*)\\.([\\da-fA-F][\\da-fA-F_]*|_[\\da-fA-F][\\da-fA-F_]*)|\\.?([\\da-fA-F][\\da-fA-F_]*|_[\\da-fA-F][\\da-fA-F_]*))[pP][+-]?(0|[1-9][\\d_]*|\\d[\\d_]*|[\\d_]+?\\d))|((0|[1-9][\\d_]*|\\d[\\d_]*|[\\d_]+?\\d)(\\.\\d*|([eE][+-]?(0|[1-9][\\d_]*|\\d[\\d_]*|[\\d_]+?\\d)))|\\d+\\.(0|[1-9][\\d_]*|\\d[\\d_]*|[\\d_]+?\\d)(0|[1-9][\\d_]*|\\d[\\d_]*|[\\d_]+?\\d)|\\.(0|[1-9][\\d_]*)([eE][+-]?(0|[1-9][\\d_]*|\\d[\\d_]*|[\\d_]+?\\d))?))([fF]|L|i|[fF]i|Li)?|"+d+"(i|[fF]i|Li))",relevance:0},r={className:"string",begin:"'("+n+"|.)",end:"'",illegal:"."},i={className:"string",begin:'"',contains:[{begin:n,relevance:0}],end:'"[cwd]?'},s=e.COMMENT("\\/\\+","\\+\\/",{contains:["self"],relevance:10});return{name:"D",keywords:a,contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,{className:"string",begin:'x"[\\da-fA-F\\s\\n\\r]*"[cwd]?',relevance:10},i,{className:"string",begin:'[rq]"',end:'"[cwd]?',relevance:5},{className:"string",begin:"`",end:"`[cwd]?"},{className:"string",begin:'q"\\{',end:'\\}"'},_,t,r,{className:"meta",begin:"^#!",end:"$",relevance:5},{className:"meta",begin:"#(line)",end:"$",relevance:5},{className:"keyword",begin:"@[a-zA-Z_][a-zA-Z_\\d]*"}]}}}());
+hljs.registerLanguage("handlebars",function(){"use strict";function e(...e){return e.map(e=>(function(e){return e?"string"==typeof e?e:e.source:null})(e)).join("")}return function(n){const a={"builtin-name":"action bindattr collection component concat debugger each each-in get hash if in input link-to loc log lookup mut outlet partial query-params render template textarea unbound unless view with yield"},t=/\[.*?\]/,s=/[^\s!"#%&'()*+,.\/;<=>@\[\\\]^`{|}~]+/,i=e("(",/'.*?'/,"|",/".*?"/,"|",t,"|",s,"|",/\.|\//,")+"),r=e("(",t,"|",s,")(?==)"),l={begin:i,lexemes:/[\w.\/]+/},c=n.inherit(l,{keywords:{literal:"true false undefined null"}}),o={begin:/\(/,end:/\)/},m={className:"attr",begin:r,relevance:0,starts:{begin:/=/,end:/=/,starts:{contains:[n.NUMBER_MODE,n.QUOTE_STRING_MODE,n.APOS_STRING_MODE,c,o]}}},d={contains:[n.NUMBER_MODE,n.QUOTE_STRING_MODE,n.APOS_STRING_MODE,{begin:/as\s+\|/,keywords:{keyword:"as"},end:/\|/,contains:[{begin:/\w+/}]},m,c,o],returnEnd:!0},g=n.inherit(l,{className:"name",keywords:a,starts:n.inherit(d,{end:/\)/})});o.contains=[g];const u=n.inherit(l,{keywords:a,className:"name",starts:n.inherit(d,{end:/}}/})}),b=n.inherit(l,{keywords:a,className:"name"}),h=n.inherit(l,{className:"name",keywords:a,starts:n.inherit(d,{end:/}}/})});return{name:"Handlebars",aliases:["hbs","html.hbs","html.handlebars","htmlbars"],case_insensitive:!0,subLanguage:"xml",contains:[{begin:/\\\{\{/,skip:!0},{begin:/\\\\(?=\{\{)/,skip:!0},n.COMMENT(/\{\{!--/,/--\}\}/),n.COMMENT(/\{\{!/,/\}\}/),{className:"template-tag",begin:/\{\{\{\{(?!\/)/,end:/\}\}\}\}/,contains:[u],starts:{end:/\{\{\{\{\//,returnEnd:!0,subLanguage:"xml"}},{className:"template-tag",begin:/\{\{\{\{\//,end:/\}\}\}\}/,contains:[b]},{className:"template-tag",begin:/\{\{#/,end:/\}\}/,contains:[u]},{className:"template-tag",begin:/\{\{(?=else\}\})/,end:/\}\}/,keywords:"else"},{className:"template-tag",begin:/\{\{\//,end:/\}\}/,contains:[b]},{className:"template-variable",begin:/\{\{\{/,end:/\}\}\}/,contains:[h]},{className:"template-variable",begin:/\{\{/,end:/\}\}/,contains:[h]}]}}}());
+hljs.registerLanguage("haskell",function(){"use strict";return function(e){var n={variants:[e.COMMENT("--","$"),e.COMMENT("{-","-}",{contains:["self"]})]},i={className:"meta",begin:"{-#",end:"#-}"},a={className:"meta",begin:"^#",end:"$"},s={className:"type",begin:"\\b[A-Z][\\w']*",relevance:0},l={begin:"\\(",end:"\\)",illegal:'"',contains:[i,a,{className:"type",begin:"\\b[A-Z][\\w]*(\\((\\.\\.|,|\\w+)\\))?"},e.inherit(e.TITLE_MODE,{begin:"[_a-z][\\w']*"}),n]};return{name:"Haskell",aliases:["hs"],keywords:"let in if then else case of where do module import hiding qualified type data newtype deriving class instance as default infix infixl infixr foreign export ccall stdcall cplusplus jvm dotnet safe unsafe family forall mdo proc rec",contains:[{beginKeywords:"module",end:"where",keywords:"module where",contains:[l,n],illegal:"\\W\\.|;"},{begin:"\\bimport\\b",end:"$",keywords:"import qualified as hiding",contains:[l,n],illegal:"\\W\\.|;"},{className:"class",begin:"^(\\s*)?(class|instance)\\b",end:"where",keywords:"class family instance where",contains:[s,l,n]},{className:"class",begin:"\\b(data|(new)?type)\\b",end:"$",keywords:"data family type newtype deriving",contains:[i,s,l,{begin:"{",end:"}",contains:l.contains},n]},{beginKeywords:"default",end:"$",contains:[s,l,n]},{beginKeywords:"infix infixl infixr",end:"$",contains:[e.C_NUMBER_MODE,n]},{begin:"\\bforeign\\b",end:"$",keywords:"foreign import export ccall stdcall cplusplus jvm dotnet safe unsafe",contains:[s,e.QUOTE_STRING_MODE,n]},{className:"meta",begin:"#!\\/usr\\/bin\\/env runhaskell",end:"$"},i,a,e.QUOTE_STRING_MODE,e.C_NUMBER_MODE,s,e.inherit(e.TITLE_MODE,{begin:"^[_a-z][\\w']*"}),n,{begin:"->|<-"}]}}}());
+hljs.registerLanguage("julia",function(){"use strict";return function(e){var r="[A-Za-z_\\u00A1-\\uFFFF][A-Za-z_0-9\\u00A1-\\uFFFF]*",t={$pattern:r,keyword:"in isa where baremodule begin break catch ccall const continue do else elseif end export false finally for function global if import importall let local macro module quote return true try using while type immutable abstract bitstype typealias ",literal:"true false ARGS C_NULL DevNull ENDIAN_BOM ENV I Inf Inf16 Inf32 Inf64 InsertionSort JULIA_HOME LOAD_PATH MergeSort NaN NaN16 NaN32 NaN64 PROGRAM_FILE QuickSort RoundDown RoundFromZero RoundNearest RoundNearestTiesAway RoundNearestTiesUp RoundToZero RoundUp STDERR STDIN STDOUT VERSION catalan e|0 eu|0 eulergamma golden im nothing pi γ π φ ",built_in:"ANY AbstractArray AbstractChannel AbstractFloat AbstractMatrix AbstractRNG AbstractSerializer AbstractSet AbstractSparseArray AbstractSparseMatrix AbstractSparseVector AbstractString AbstractUnitRange AbstractVecOrMat AbstractVector Any ArgumentError Array AssertionError Associative Base64DecodePipe Base64EncodePipe Bidiagonal BigFloat BigInt BitArray BitMatrix BitVector Bool BoundsError BufferStream CachingPool CapturedException CartesianIndex CartesianRange Cchar Cdouble Cfloat Channel Char Cint Cintmax_t Clong Clonglong ClusterManager Cmd CodeInfo Colon Complex Complex128 Complex32 Complex64 CompositeException Condition ConjArray ConjMatrix ConjVector Cptrdiff_t Cshort Csize_t Cssize_t Cstring Cuchar Cuint Cuintmax_t Culong Culonglong Cushort Cwchar_t Cwstring DataType Date DateFormat DateTime DenseArray DenseMatrix DenseVecOrMat DenseVector Diagonal Dict DimensionMismatch Dims DirectIndexString Display DivideError DomainError EOFError EachLine Enum Enumerate ErrorException Exception ExponentialBackOff Expr Factorization FileMonitor Float16 Float32 Float64 Function Future GlobalRef GotoNode HTML Hermitian IO IOBuffer IOContext IOStream IPAddr IPv4 IPv6 IndexCartesian IndexLinear IndexStyle InexactError InitError Int Int128 Int16 Int32 Int64 Int8 IntSet Integer InterruptException InvalidStateException Irrational KeyError LabelNode LinSpace LineNumberNode LoadError LowerTriangular MIME Matrix MersenneTwister Method MethodError MethodTable Module NTuple NewvarNode NullException Nullable Number ObjectIdDict OrdinalRange OutOfMemoryError OverflowError Pair ParseError PartialQuickSort PermutedDimsArray Pipe PollingFileWatcher ProcessExitedException Ptr QuoteNode RandomDevice Range RangeIndex Rational RawFD ReadOnlyMemoryError Real ReentrantLock Ref Regex RegexMatch RemoteChannel RemoteException RevString RoundingMode RowVector SSAValue SegmentationFault SerializationState Set SharedArray SharedMatrix SharedVector Signed SimpleVector Slot SlotNumber SparseMatrixCSC SparseVector StackFrame StackOverflowError StackTrace StepRange StepRangeLen StridedArray StridedMatrix StridedVecOrMat StridedVector String SubArray SubString SymTridiagonal Symbol Symmetric SystemError TCPSocket Task Text TextDisplay Timer Tridiagonal Tuple Type TypeError TypeMapEntry TypeMapLevel TypeName TypeVar TypedSlot UDPSocket UInt UInt128 UInt16 UInt32 UInt64 UInt8 UndefRefError UndefVarError UnicodeError UniformScaling Union UnionAll UnitRange Unsigned UpperTriangular Val Vararg VecElement VecOrMat Vector VersionNumber Void WeakKeyDict WeakRef WorkerConfig WorkerPool "},a={keywords:t,illegal:/<\//},n={className:"subst",begin:/\$\(/,end:/\)/,keywords:t},o={className:"variable",begin:"\\$"+r},i={className:"string",contains:[e.BACKSLASH_ESCAPE,n,o],variants:[{begin:/\w*"""/,end:/"""\w*/,relevance:10},{begin:/\w*"/,end:/"\w*/}]},l={className:"string",contains:[e.BACKSLASH_ESCAPE,n,o],begin:"`",end:"`"},s={className:"meta",begin:"@"+r};return a.name="Julia",a.contains=[{className:"number",begin:/(\b0x[\d_]*(\.[\d_]*)?|0x\.\d[\d_]*)p[-+]?\d+|\b0[box][a-fA-F0-9][a-fA-F0-9_]*|(\b\d[\d_]*(\.[\d_]*)?|\.\d[\d_]*)([eEfF][-+]?\d+)?/,relevance:0},{className:"string",begin:/'(.|\\[xXuU][a-zA-Z0-9]+)'/},i,l,s,{className:"comment",variants:[{begin:"#=",end:"=#",relevance:10},{begin:"#",end:"$"}]},e.HASH_COMMENT_MODE,{className:"keyword",begin:"\\b(((abstract|primitive)\\s+)type|(mutable\\s+)?struct)\\b"},{begin:/<:/}],n.contains=a.contains,a}}());
+hljs.registerLanguage("nim",function(){"use strict";return function(e){return{name:"Nim",aliases:["nim"],keywords:{keyword:"addr and as asm bind block break case cast const continue converter discard distinct div do elif else end enum except export finally for from func generic if import in include interface is isnot iterator let macro method mixin mod nil not notin object of or out proc ptr raise ref return shl shr static template try tuple type using var when while with without xor yield",literal:"shared guarded stdin stdout stderr result true false",built_in:"int int8 int16 int32 int64 uint uint8 uint16 uint32 uint64 float float32 float64 bool char string cstring pointer expr stmt void auto any range array openarray varargs seq set clong culong cchar cschar cshort cint csize clonglong cfloat cdouble clongdouble cuchar cushort cuint culonglong cstringarray semistatic"},contains:[{className:"meta",begin:/{\./,end:/\.}/,relevance:10},{className:"string",begin:/[a-zA-Z]\w*"/,end:/"/,contains:[{begin:/""/}]},{className:"string",begin:/([a-zA-Z]\w*)?"""/,end:/"""/},e.QUOTE_STRING_MODE,{className:"type",begin:/\b[A-Z]\w+\b/,relevance:0},{className:"number",relevance:0,variants:[{begin:/\b(0[xX][0-9a-fA-F][_0-9a-fA-F]*)('?[iIuU](8|16|32|64))?/},{begin:/\b(0o[0-7][_0-7]*)('?[iIuUfF](8|16|32|64))?/},{begin:/\b(0(b|B)[01][_01]*)('?[iIuUfF](8|16|32|64))?/},{begin:/\b(\d[_\d]*)('?[iIuUfF](8|16|32|64))?/}]},e.HASH_COMMENT_MODE]}}}());
+hljs.registerLanguage("nix",function(){"use strict";return function(e){var n={keyword:"rec with let in inherit assert if else then",literal:"true false or and null",built_in:"import abort baseNameOf dirOf isNull builtins map removeAttrs throw toString derivation"},i={className:"subst",begin:/\$\{/,end:/}/,keywords:n},t={className:"string",contains:[i],variants:[{begin:"''",end:"''"},{begin:'"',end:'"'}]},s=[e.NUMBER_MODE,e.HASH_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,t,{begin:/[a-zA-Z0-9-_]+(\s*=)/,returnBegin:!0,relevance:0,contains:[{className:"attr",begin:/\S+/}]}];return i.contains=s,{name:"Nix",aliases:["nixos"],keywords:n,contains:s}}}());
+hljs.registerLanguage("r",function(){"use strict";return function(e){var n="([a-zA-Z]|\\.[a-zA-Z.])[a-zA-Z0-9._]*";return{name:"R",contains:[e.HASH_COMMENT_MODE,{begin:n,keywords:{$pattern:n,keyword:"function if in break next repeat else for return switch while try tryCatch stop warning require library attach detach source setMethod setGeneric setGroupGeneric setClass ...",literal:"NULL NA TRUE FALSE T F Inf NaN NA_integer_|10 NA_real_|10 NA_character_|10 NA_complex_|10"},relevance:0},{className:"number",begin:"0[xX][0-9a-fA-F]+[Li]?\\b",relevance:0},{className:"number",begin:"\\d+(?:[eE][+\\-]?\\d*)?L\\b",relevance:0},{className:"number",begin:"\\d+\\.(?!\\d)(?:i\\b)?",relevance:0},{className:"number",begin:"\\d+(?:\\.\\d*)?(?:[eE][+\\-]?\\d*)?i?\\b",relevance:0},{className:"number",begin:"\\.\\d+(?:[eE][+\\-]?\\d*)?i?\\b",relevance:0},{begin:"`",end:"`",relevance:0},{className:"string",contains:[e.BACKSLASH_ESCAPE],variants:[{begin:'"',end:'"'},{begin:"'",end:"'"}]}]}}}());
+hljs.registerLanguage("scala",function(){"use strict";return function(e){var n={className:"subst",variants:[{begin:"\\$[A-Za-z0-9_]+"},{begin:"\\${",end:"}"}]},a={className:"string",variants:[{begin:'"',end:'"',illegal:"\\n",contains:[e.BACKSLASH_ESCAPE]},{begin:'"""',end:'"""',relevance:10},{begin:'[a-z]+"',end:'"',illegal:"\\n",contains:[e.BACKSLASH_ESCAPE,n]},{className:"string",begin:'[a-z]+"""',end:'"""',contains:[n],relevance:10}]},s={className:"type",begin:"\\b[A-Z][A-Za-z0-9_]*",relevance:0},t={className:"title",begin:/[^0-9\n\t "'(),.`{}\[\]:;][^\n\t "'(),.`{}\[\]:;]+|[^0-9\n\t "'(),.`{}\[\]:;=]/,relevance:0},i={className:"class",beginKeywords:"class object trait type",end:/[:={\[\n;]/,excludeEnd:!0,contains:[{beginKeywords:"extends with",relevance:10},{begin:/\[/,end:/\]/,excludeBegin:!0,excludeEnd:!0,relevance:0,contains:[s]},{className:"params",begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,relevance:0,contains:[s]},t]},l={className:"function",beginKeywords:"def",end:/[:={\[(\n;]/,excludeEnd:!0,contains:[t]};return{name:"Scala",keywords:{literal:"true false null",keyword:"type yield lazy override def with val var sealed abstract private trait object if forSome for while throw finally protected extends import final return else break new catch super class case package default try this match continue throws implicit"},contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,{className:"symbol",begin:"'\\w[\\w\\d_]*(?!')"},s,l,i,e.C_NUMBER_MODE,{className:"meta",begin:"@[A-Za-z]+"}]}}}());
+hljs.registerLanguage("x86asm",function(){"use strict";return function(s){return{name:"Intel x86 Assembly",case_insensitive:!0,keywords:{$pattern:"[.%]?"+s.IDENT_RE,keyword:"lock rep repe repz repne repnz xaquire xrelease bnd nobnd aaa aad aam aas adc add and arpl bb0_reset bb1_reset bound bsf bsr bswap bt btc btr bts call cbw cdq cdqe clc cld cli clts cmc cmp cmpsb cmpsd cmpsq cmpsw cmpxchg cmpxchg486 cmpxchg8b cmpxchg16b cpuid cpu_read cpu_write cqo cwd cwde daa das dec div dmint emms enter equ f2xm1 fabs fadd faddp fbld fbstp fchs fclex fcmovb fcmovbe fcmove fcmovnb fcmovnbe fcmovne fcmovnu fcmovu fcom fcomi fcomip fcomp fcompp fcos fdecstp fdisi fdiv fdivp fdivr fdivrp femms feni ffree ffreep fiadd ficom ficomp fidiv fidivr fild fimul fincstp finit fist fistp fisttp fisub fisubr fld fld1 fldcw fldenv fldl2e fldl2t fldlg2 fldln2 fldpi fldz fmul fmulp fnclex fndisi fneni fninit fnop fnsave fnstcw fnstenv fnstsw fpatan fprem fprem1 fptan frndint frstor fsave fscale fsetpm fsin fsincos fsqrt fst fstcw fstenv fstp fstsw fsub fsubp fsubr fsubrp ftst fucom fucomi fucomip fucomp fucompp fxam fxch fxtract fyl2x fyl2xp1 hlt ibts icebp idiv imul in inc incbin insb insd insw int int01 int1 int03 int3 into invd invpcid invlpg invlpga iret iretd iretq iretw jcxz jecxz jrcxz jmp jmpe lahf lar lds lea leave les lfence lfs lgdt lgs lidt lldt lmsw loadall loadall286 lodsb lodsd lodsq lodsw loop loope loopne loopnz loopz lsl lss ltr mfence monitor mov movd movq movsb movsd movsq movsw movsx movsxd movzx mul mwait neg nop not or out outsb outsd outsw packssdw packsswb packuswb paddb paddd paddsb paddsiw paddsw paddusb paddusw paddw pand pandn pause paveb pavgusb pcmpeqb pcmpeqd pcmpeqw pcmpgtb pcmpgtd pcmpgtw pdistib pf2id pfacc pfadd pfcmpeq pfcmpge pfcmpgt pfmax pfmin pfmul pfrcp pfrcpit1 pfrcpit2 pfrsqit1 pfrsqrt pfsub pfsubr pi2fd pmachriw pmaddwd pmagw pmulhriw pmulhrwa pmulhrwc pmulhw pmullw pmvgezb pmvlzb pmvnzb pmvzb pop popa popad popaw popf popfd popfq popfw por prefetch prefetchw pslld psllq psllw psrad psraw psrld psrlq psrlw psubb psubd psubsb psubsiw psubsw psubusb psubusw psubw punpckhbw punpckhdq punpckhwd punpcklbw punpckldq punpcklwd push pusha pushad pushaw pushf pushfd pushfq pushfw pxor rcl rcr rdshr rdmsr rdpmc rdtsc rdtscp ret retf retn rol ror rdm rsdc rsldt rsm rsts sahf sal salc sar sbb scasb scasd scasq scasw sfence sgdt shl shld shr shrd sidt sldt skinit smi smint smintold smsw stc std sti stosb stosd stosq stosw str sub svdc svldt svts swapgs syscall sysenter sysexit sysret test ud0 ud1 ud2b ud2 ud2a umov verr verw fwait wbinvd wrshr wrmsr xadd xbts xchg xlatb xlat xor cmove cmovz cmovne cmovnz cmova cmovnbe cmovae cmovnb cmovb cmovnae cmovbe cmovna cmovg cmovnle cmovge cmovnl cmovl cmovnge cmovle cmovng cmovc cmovnc cmovo cmovno cmovs cmovns cmovp cmovpe cmovnp cmovpo je jz jne jnz ja jnbe jae jnb jb jnae jbe jna jg jnle jge jnl jl jnge jle jng jc jnc jo jno js jns jpo jnp jpe jp sete setz setne setnz seta setnbe setae setnb setnc setb setnae setcset setbe setna setg setnle setge setnl setl setnge setle setng sets setns seto setno setpe setp setpo setnp addps addss andnps andps cmpeqps cmpeqss cmpleps cmpless cmpltps cmpltss cmpneqps cmpneqss cmpnleps cmpnless cmpnltps cmpnltss cmpordps cmpordss cmpunordps cmpunordss cmpps cmpss comiss cvtpi2ps cvtps2pi cvtsi2ss cvtss2si cvttps2pi cvttss2si divps divss ldmxcsr maxps maxss minps minss movaps movhps movlhps movlps movhlps movmskps movntps movss movups mulps mulss orps rcpps rcpss rsqrtps rsqrtss shufps sqrtps sqrtss stmxcsr subps subss ucomiss unpckhps unpcklps xorps fxrstor fxrstor64 fxsave fxsave64 xgetbv xsetbv xsave xsave64 xsaveopt xsaveopt64 xrstor xrstor64 prefetchnta prefetcht0 prefetcht1 prefetcht2 maskmovq movntq pavgb pavgw pextrw pinsrw pmaxsw pmaxub pminsw pminub pmovmskb pmulhuw psadbw pshufw pf2iw pfnacc pfpnacc pi2fw pswapd maskmovdqu clflush movntdq movnti movntpd movdqa movdqu movdq2q movq2dq paddq pmuludq pshufd pshufhw pshuflw pslldq psrldq psubq punpckhqdq punpcklqdq addpd addsd andnpd andpd cmpeqpd cmpeqsd cmplepd cmplesd cmpltpd cmpltsd cmpneqpd cmpneqsd cmpnlepd cmpnlesd cmpnltpd cmpnltsd cmpordpd cmpordsd cmpunordpd cmpunordsd cmppd comisd cvtdq2pd cvtdq2ps cvtpd2dq cvtpd2pi cvtpd2ps cvtpi2pd cvtps2dq cvtps2pd cvtsd2si cvtsd2ss cvtsi2sd cvtss2sd cvttpd2pi cvttpd2dq cvttps2dq cvttsd2si divpd divsd maxpd maxsd minpd minsd movapd movhpd movlpd movmskpd movupd mulpd mulsd orpd shufpd sqrtpd sqrtsd subpd subsd ucomisd unpckhpd unpcklpd xorpd addsubpd addsubps haddpd haddps hsubpd hsubps lddqu movddup movshdup movsldup clgi stgi vmcall vmclear vmfunc vmlaunch vmload vmmcall vmptrld vmptrst vmread vmresume vmrun vmsave vmwrite vmxoff vmxon invept invvpid pabsb pabsw pabsd palignr phaddw phaddd phaddsw phsubw phsubd phsubsw pmaddubsw pmulhrsw pshufb psignb psignw psignd extrq insertq movntsd movntss lzcnt blendpd blendps blendvpd blendvps dppd dpps extractps insertps movntdqa mpsadbw packusdw pblendvb pblendw pcmpeqq pextrb pextrd pextrq phminposuw pinsrb pinsrd pinsrq pmaxsb pmaxsd pmaxud pmaxuw pminsb pminsd pminud pminuw pmovsxbw pmovsxbd pmovsxbq pmovsxwd pmovsxwq pmovsxdq pmovzxbw pmovzxbd pmovzxbq pmovzxwd pmovzxwq pmovzxdq pmuldq pmulld ptest roundpd roundps roundsd roundss crc32 pcmpestri pcmpestrm pcmpistri pcmpistrm pcmpgtq popcnt getsec pfrcpv pfrsqrtv movbe aesenc aesenclast aesdec aesdeclast aesimc aeskeygenassist vaesenc vaesenclast vaesdec vaesdeclast vaesimc vaeskeygenassist vaddpd vaddps vaddsd vaddss vaddsubpd vaddsubps vandpd vandps vandnpd vandnps vblendpd vblendps vblendvpd vblendvps vbroadcastss vbroadcastsd vbroadcastf128 vcmpeq_ospd vcmpeqpd vcmplt_ospd vcmpltpd vcmple_ospd vcmplepd vcmpunord_qpd vcmpunordpd vcmpneq_uqpd vcmpneqpd vcmpnlt_uspd vcmpnltpd vcmpnle_uspd vcmpnlepd vcmpord_qpd vcmpordpd vcmpeq_uqpd vcmpnge_uspd vcmpngepd vcmpngt_uspd vcmpngtpd vcmpfalse_oqpd vcmpfalsepd vcmpneq_oqpd vcmpge_ospd vcmpgepd vcmpgt_ospd vcmpgtpd vcmptrue_uqpd vcmptruepd vcmplt_oqpd vcmple_oqpd vcmpunord_spd vcmpneq_uspd vcmpnlt_uqpd vcmpnle_uqpd vcmpord_spd vcmpeq_uspd vcmpnge_uqpd vcmpngt_uqpd vcmpfalse_ospd vcmpneq_ospd vcmpge_oqpd vcmpgt_oqpd vcmptrue_uspd vcmppd vcmpeq_osps vcmpeqps vcmplt_osps vcmpltps vcmple_osps vcmpleps vcmpunord_qps vcmpunordps vcmpneq_uqps vcmpneqps vcmpnlt_usps vcmpnltps vcmpnle_usps vcmpnleps vcmpord_qps vcmpordps vcmpeq_uqps vcmpnge_usps vcmpngeps vcmpngt_usps vcmpngtps vcmpfalse_oqps vcmpfalseps vcmpneq_oqps vcmpge_osps vcmpgeps vcmpgt_osps vcmpgtps vcmptrue_uqps vcmptrueps vcmplt_oqps vcmple_oqps vcmpunord_sps vcmpneq_usps vcmpnlt_uqps vcmpnle_uqps vcmpord_sps vcmpeq_usps vcmpnge_uqps vcmpngt_uqps vcmpfalse_osps vcmpneq_osps vcmpge_oqps vcmpgt_oqps vcmptrue_usps vcmpps vcmpeq_ossd vcmpeqsd vcmplt_ossd vcmpltsd vcmple_ossd vcmplesd vcmpunord_qsd vcmpunordsd vcmpneq_uqsd vcmpneqsd vcmpnlt_ussd vcmpnltsd vcmpnle_ussd vcmpnlesd vcmpord_qsd vcmpordsd vcmpeq_uqsd vcmpnge_ussd vcmpngesd vcmpngt_ussd vcmpngtsd vcmpfalse_oqsd vcmpfalsesd vcmpneq_oqsd vcmpge_ossd vcmpgesd vcmpgt_ossd vcmpgtsd vcmptrue_uqsd vcmptruesd vcmplt_oqsd vcmple_oqsd vcmpunord_ssd vcmpneq_ussd vcmpnlt_uqsd vcmpnle_uqsd vcmpord_ssd vcmpeq_ussd vcmpnge_uqsd vcmpngt_uqsd vcmpfalse_ossd vcmpneq_ossd vcmpge_oqsd vcmpgt_oqsd vcmptrue_ussd vcmpsd vcmpeq_osss vcmpeqss vcmplt_osss vcmpltss vcmple_osss vcmpless vcmpunord_qss vcmpunordss vcmpneq_uqss vcmpneqss vcmpnlt_usss vcmpnltss vcmpnle_usss vcmpnless vcmpord_qss vcmpordss vcmpeq_uqss vcmpnge_usss vcmpngess vcmpngt_usss vcmpngtss vcmpfalse_oqss vcmpfalsess vcmpneq_oqss vcmpge_osss vcmpgess vcmpgt_osss vcmpgtss vcmptrue_uqss vcmptruess vcmplt_oqss vcmple_oqss vcmpunord_sss vcmpneq_usss vcmpnlt_uqss vcmpnle_uqss vcmpord_sss vcmpeq_usss vcmpnge_uqss vcmpngt_uqss vcmpfalse_osss vcmpneq_osss vcmpge_oqss vcmpgt_oqss vcmptrue_usss vcmpss vcomisd vcomiss vcvtdq2pd vcvtdq2ps vcvtpd2dq vcvtpd2ps vcvtps2dq vcvtps2pd vcvtsd2si vcvtsd2ss vcvtsi2sd vcvtsi2ss vcvtss2sd vcvtss2si vcvttpd2dq vcvttps2dq vcvttsd2si vcvttss2si vdivpd vdivps vdivsd vdivss vdppd vdpps vextractf128 vextractps vhaddpd vhaddps vhsubpd vhsubps vinsertf128 vinsertps vlddqu vldqqu vldmxcsr vmaskmovdqu vmaskmovps vmaskmovpd vmaxpd vmaxps vmaxsd vmaxss vminpd vminps vminsd vminss vmovapd vmovaps vmovd vmovq vmovddup vmovdqa vmovqqa vmovdqu vmovqqu vmovhlps vmovhpd vmovhps vmovlhps vmovlpd vmovlps vmovmskpd vmovmskps vmovntdq vmovntqq vmovntdqa vmovntpd vmovntps vmovsd vmovshdup vmovsldup vmovss vmovupd vmovups vmpsadbw vmulpd vmulps vmulsd vmulss vorpd vorps vpabsb vpabsw vpabsd vpacksswb vpackssdw vpackuswb vpackusdw vpaddb vpaddw vpaddd vpaddq vpaddsb vpaddsw vpaddusb vpaddusw vpalignr vpand vpandn vpavgb vpavgw vpblendvb vpblendw vpcmpestri vpcmpestrm vpcmpistri vpcmpistrm vpcmpeqb vpcmpeqw vpcmpeqd vpcmpeqq vpcmpgtb vpcmpgtw vpcmpgtd vpcmpgtq vpermilpd vpermilps vperm2f128 vpextrb vpextrw vpextrd vpextrq vphaddw vphaddd vphaddsw vphminposuw vphsubw vphsubd vphsubsw vpinsrb vpinsrw vpinsrd vpinsrq vpmaddwd vpmaddubsw vpmaxsb vpmaxsw vpmaxsd vpmaxub vpmaxuw vpmaxud vpminsb vpminsw vpminsd vpminub vpminuw vpminud vpmovmskb vpmovsxbw vpmovsxbd vpmovsxbq vpmovsxwd vpmovsxwq vpmovsxdq vpmovzxbw vpmovzxbd vpmovzxbq vpmovzxwd vpmovzxwq vpmovzxdq vpmulhuw vpmulhrsw vpmulhw vpmullw vpmulld vpmuludq vpmuldq vpor vpsadbw vpshufb vpshufd vpshufhw vpshuflw vpsignb vpsignw vpsignd vpslldq vpsrldq vpsllw vpslld vpsllq vpsraw vpsrad vpsrlw vpsrld vpsrlq vptest vpsubb vpsubw vpsubd vpsubq vpsubsb vpsubsw vpsubusb vpsubusw vpunpckhbw vpunpckhwd vpunpckhdq vpunpckhqdq vpunpcklbw vpunpcklwd vpunpckldq vpunpcklqdq vpxor vrcpps vrcpss vrsqrtps vrsqrtss vroundpd vroundps vroundsd vroundss vshufpd vshufps vsqrtpd vsqrtps vsqrtsd vsqrtss vstmxcsr vsubpd vsubps vsubsd vsubss vtestps vtestpd vucomisd vucomiss vunpckhpd vunpckhps vunpcklpd vunpcklps vxorpd vxorps vzeroall vzeroupper pclmullqlqdq pclmulhqlqdq pclmullqhqdq pclmulhqhqdq pclmulqdq vpclmullqlqdq vpclmulhqlqdq vpclmullqhqdq vpclmulhqhqdq vpclmulqdq vfmadd132ps vfmadd132pd vfmadd312ps vfmadd312pd vfmadd213ps vfmadd213pd vfmadd123ps vfmadd123pd vfmadd231ps vfmadd231pd vfmadd321ps vfmadd321pd vfmaddsub132ps vfmaddsub132pd vfmaddsub312ps vfmaddsub312pd vfmaddsub213ps vfmaddsub213pd vfmaddsub123ps vfmaddsub123pd vfmaddsub231ps vfmaddsub231pd vfmaddsub321ps vfmaddsub321pd vfmsub132ps vfmsub132pd vfmsub312ps vfmsub312pd vfmsub213ps vfmsub213pd vfmsub123ps vfmsub123pd vfmsub231ps vfmsub231pd vfmsub321ps vfmsub321pd vfmsubadd132ps vfmsubadd132pd vfmsubadd312ps vfmsubadd312pd vfmsubadd213ps vfmsubadd213pd vfmsubadd123ps vfmsubadd123pd vfmsubadd231ps vfmsubadd231pd vfmsubadd321ps vfmsubadd321pd vfnmadd132ps vfnmadd132pd vfnmadd312ps vfnmadd312pd vfnmadd213ps vfnmadd213pd vfnmadd123ps vfnmadd123pd vfnmadd231ps vfnmadd231pd vfnmadd321ps vfnmadd321pd vfnmsub132ps vfnmsub132pd vfnmsub312ps vfnmsub312pd vfnmsub213ps vfnmsub213pd vfnmsub123ps vfnmsub123pd vfnmsub231ps vfnmsub231pd vfnmsub321ps vfnmsub321pd vfmadd132ss vfmadd132sd vfmadd312ss vfmadd312sd vfmadd213ss vfmadd213sd vfmadd123ss vfmadd123sd vfmadd231ss vfmadd231sd vfmadd321ss vfmadd321sd vfmsub132ss vfmsub132sd vfmsub312ss vfmsub312sd vfmsub213ss vfmsub213sd vfmsub123ss vfmsub123sd vfmsub231ss vfmsub231sd vfmsub321ss vfmsub321sd vfnmadd132ss vfnmadd132sd vfnmadd312ss vfnmadd312sd vfnmadd213ss vfnmadd213sd vfnmadd123ss vfnmadd123sd vfnmadd231ss vfnmadd231sd vfnmadd321ss vfnmadd321sd vfnmsub132ss vfnmsub132sd vfnmsub312ss vfnmsub312sd vfnmsub213ss vfnmsub213sd vfnmsub123ss vfnmsub123sd vfnmsub231ss vfnmsub231sd vfnmsub321ss vfnmsub321sd rdfsbase rdgsbase rdrand wrfsbase wrgsbase vcvtph2ps vcvtps2ph adcx adox rdseed clac stac xstore xcryptecb xcryptcbc xcryptctr xcryptcfb xcryptofb montmul xsha1 xsha256 llwpcb slwpcb lwpval lwpins vfmaddpd vfmaddps vfmaddsd vfmaddss vfmaddsubpd vfmaddsubps vfmsubaddpd vfmsubaddps vfmsubpd vfmsubps vfmsubsd vfmsubss vfnmaddpd vfnmaddps vfnmaddsd vfnmaddss vfnmsubpd vfnmsubps vfnmsubsd vfnmsubss vfrczpd vfrczps vfrczsd vfrczss vpcmov vpcomb vpcomd vpcomq vpcomub vpcomud vpcomuq vpcomuw vpcomw vphaddbd vphaddbq vphaddbw vphadddq vphaddubd vphaddubq vphaddubw vphaddudq vphadduwd vphadduwq vphaddwd vphaddwq vphsubbw vphsubdq vphsubwd vpmacsdd vpmacsdqh vpmacsdql vpmacssdd vpmacssdqh vpmacssdql vpmacsswd vpmacssww vpmacswd vpmacsww vpmadcsswd vpmadcswd vpperm vprotb vprotd vprotq vprotw vpshab vpshad vpshaq vpshaw vpshlb vpshld vpshlq vpshlw vbroadcasti128 vpblendd vpbroadcastb vpbroadcastw vpbroadcastd vpbroadcastq vpermd vpermpd vpermps vpermq vperm2i128 vextracti128 vinserti128 vpmaskmovd vpmaskmovq vpsllvd vpsllvq vpsravd vpsrlvd vpsrlvq vgatherdpd vgatherqpd vgatherdps vgatherqps vpgatherdd vpgatherqd vpgatherdq vpgatherqq xabort xbegin xend xtest andn bextr blci blcic blsi blsic blcfill blsfill blcmsk blsmsk blsr blcs bzhi mulx pdep pext rorx sarx shlx shrx tzcnt tzmsk t1mskc valignd valignq vblendmpd vblendmps vbroadcastf32x4 vbroadcastf64x4 vbroadcasti32x4 vbroadcasti64x4 vcompresspd vcompressps vcvtpd2udq vcvtps2udq vcvtsd2usi vcvtss2usi vcvttpd2udq vcvttps2udq vcvttsd2usi vcvttss2usi vcvtudq2pd vcvtudq2ps vcvtusi2sd vcvtusi2ss vexpandpd vexpandps vextractf32x4 vextractf64x4 vextracti32x4 vextracti64x4 vfixupimmpd vfixupimmps vfixupimmsd vfixupimmss vgetexppd vgetexpps vgetexpsd vgetexpss vgetmantpd vgetmantps vgetmantsd vgetmantss vinsertf32x4 vinsertf64x4 vinserti32x4 vinserti64x4 vmovdqa32 vmovdqa64 vmovdqu32 vmovdqu64 vpabsq vpandd vpandnd vpandnq vpandq vpblendmd vpblendmq vpcmpltd vpcmpled vpcmpneqd vpcmpnltd vpcmpnled vpcmpd vpcmpltq vpcmpleq vpcmpneqq vpcmpnltq vpcmpnleq vpcmpq vpcmpequd vpcmpltud vpcmpleud vpcmpnequd vpcmpnltud vpcmpnleud vpcmpud vpcmpequq vpcmpltuq vpcmpleuq vpcmpnequq vpcmpnltuq vpcmpnleuq vpcmpuq vpcompressd vpcompressq vpermi2d vpermi2pd vpermi2ps vpermi2q vpermt2d vpermt2pd vpermt2ps vpermt2q vpexpandd vpexpandq vpmaxsq vpmaxuq vpminsq vpminuq vpmovdb vpmovdw vpmovqb vpmovqd vpmovqw vpmovsdb vpmovsdw vpmovsqb vpmovsqd vpmovsqw vpmovusdb vpmovusdw vpmovusqb vpmovusqd vpmovusqw vpord vporq vprold vprolq vprolvd vprolvq vprord vprorq vprorvd vprorvq vpscatterdd vpscatterdq vpscatterqd vpscatterqq vpsraq vpsravq vpternlogd vpternlogq vptestmd vptestmq vptestnmd vptestnmq vpxord vpxorq vrcp14pd vrcp14ps vrcp14sd vrcp14ss vrndscalepd vrndscaleps vrndscalesd vrndscaless vrsqrt14pd vrsqrt14ps vrsqrt14sd vrsqrt14ss vscalefpd vscalefps vscalefsd vscalefss vscatterdpd vscatterdps vscatterqpd vscatterqps vshuff32x4 vshuff64x2 vshufi32x4 vshufi64x2 kandnw kandw kmovw knotw kortestw korw kshiftlw kshiftrw kunpckbw kxnorw kxorw vpbroadcastmb2q vpbroadcastmw2d vpconflictd vpconflictq vplzcntd vplzcntq vexp2pd vexp2ps vrcp28pd vrcp28ps vrcp28sd vrcp28ss vrsqrt28pd vrsqrt28ps vrsqrt28sd vrsqrt28ss vgatherpf0dpd vgatherpf0dps vgatherpf0qpd vgatherpf0qps vgatherpf1dpd vgatherpf1dps vgatherpf1qpd vgatherpf1qps vscatterpf0dpd vscatterpf0dps vscatterpf0qpd vscatterpf0qps vscatterpf1dpd vscatterpf1dps vscatterpf1qpd vscatterpf1qps prefetchwt1 bndmk bndcl bndcu bndcn bndmov bndldx bndstx sha1rnds4 sha1nexte sha1msg1 sha1msg2 sha256rnds2 sha256msg1 sha256msg2 hint_nop0 hint_nop1 hint_nop2 hint_nop3 hint_nop4 hint_nop5 hint_nop6 hint_nop7 hint_nop8 hint_nop9 hint_nop10 hint_nop11 hint_nop12 hint_nop13 hint_nop14 hint_nop15 hint_nop16 hint_nop17 hint_nop18 hint_nop19 hint_nop20 hint_nop21 hint_nop22 hint_nop23 hint_nop24 hint_nop25 hint_nop26 hint_nop27 hint_nop28 hint_nop29 hint_nop30 hint_nop31 hint_nop32 hint_nop33 hint_nop34 hint_nop35 hint_nop36 hint_nop37 hint_nop38 hint_nop39 hint_nop40 hint_nop41 hint_nop42 hint_nop43 hint_nop44 hint_nop45 hint_nop46 hint_nop47 hint_nop48 hint_nop49 hint_nop50 hint_nop51 hint_nop52 hint_nop53 hint_nop54 hint_nop55 hint_nop56 hint_nop57 hint_nop58 hint_nop59 hint_nop60 hint_nop61 hint_nop62 hint_nop63",built_in:"ip eip rip al ah bl bh cl ch dl dh sil dil bpl spl r8b r9b r10b r11b r12b r13b r14b r15b ax bx cx dx si di bp sp r8w r9w r10w r11w r12w r13w r14w r15w eax ebx ecx edx esi edi ebp esp eip r8d r9d r10d r11d r12d r13d r14d r15d rax rbx rcx rdx rsi rdi rbp rsp r8 r9 r10 r11 r12 r13 r14 r15 cs ds es fs gs ss st st0 st1 st2 st3 st4 st5 st6 st7 mm0 mm1 mm2 mm3 mm4 mm5 mm6 mm7 xmm0 xmm1 xmm2 xmm3 xmm4 xmm5 xmm6 xmm7 xmm8 xmm9 xmm10 xmm11 xmm12 xmm13 xmm14 xmm15 xmm16 xmm17 xmm18 xmm19 xmm20 xmm21 xmm22 xmm23 xmm24 xmm25 xmm26 xmm27 xmm28 xmm29 xmm30 xmm31 ymm0 ymm1 ymm2 ymm3 ymm4 ymm5 ymm6 ymm7 ymm8 ymm9 ymm10 ymm11 ymm12 ymm13 ymm14 ymm15 ymm16 ymm17 ymm18 ymm19 ymm20 ymm21 ymm22 ymm23 ymm24 ymm25 ymm26 ymm27 ymm28 ymm29 ymm30 ymm31 zmm0 zmm1 zmm2 zmm3 zmm4 zmm5 zmm6 zmm7 zmm8 zmm9 zmm10 zmm11 zmm12 zmm13 zmm14 zmm15 zmm16 zmm17 zmm18 zmm19 zmm20 zmm21 zmm22 zmm23 zmm24 zmm25 zmm26 zmm27 zmm28 zmm29 zmm30 zmm31 k0 k1 k2 k3 k4 k5 k6 k7 bnd0 bnd1 bnd2 bnd3 cr0 cr1 cr2 cr3 cr4 cr8 dr0 dr1 dr2 dr3 dr8 tr3 tr4 tr5 tr6 tr7 r0 r1 r2 r3 r4 r5 r6 r7 r0b r1b r2b r3b r4b r5b r6b r7b r0w r1w r2w r3w r4w r5w r6w r7w r0d r1d r2d r3d r4d r5d r6d r7d r0h r1h r2h r3h r0l r1l r2l r3l r4l r5l r6l r7l r8l r9l r10l r11l r12l r13l r14l r15l db dw dd dq dt ddq do dy dz resb resw resd resq rest resdq reso resy resz incbin equ times byte word dword qword nosplit rel abs seg wrt strict near far a32 ptr",meta:"%define %xdefine %+ %undef %defstr %deftok %assign %strcat %strlen %substr %rotate %elif %else %endif %if %ifmacro %ifctx %ifidn %ifidni %ifid %ifnum %ifstr %iftoken %ifempty %ifenv %error %warning %fatal %rep %endrep %include %push %pop %repl %pathsearch %depend %use %arg %stacksize %local %line %comment %endcomment .nolist __FILE__ __LINE__ __SECT__ __BITS__ __OUTPUT_FORMAT__ __DATE__ __TIME__ __DATE_NUM__ __TIME_NUM__ __UTC_DATE__ __UTC_TIME__ __UTC_DATE_NUM__ __UTC_TIME_NUM__ __PASS__ struc endstruc istruc at iend align alignb sectalign daz nodaz up down zero default option assume public bits use16 use32 use64 default section segment absolute extern global common cpu float __utf16__ __utf16le__ __utf16be__ __utf32__ __utf32le__ __utf32be__ __float8__ __float16__ __float32__ __float64__ __float80m__ __float80e__ __float128l__ __float128h__ __Infinity__ __QNaN__ __SNaN__ Inf NaN QNaN SNaN float8 float16 float32 float64 float80m float80e float128l float128h __FLOAT_DAZ__ __FLOAT_ROUND__ __FLOAT__"},contains:[s.COMMENT(";","$",{relevance:0}),{className:"number",variants:[{begin:"\\b(?:([0-9][0-9_]*)?\\.[0-9_]*(?:[eE][+-]?[0-9_]+)?|(0[Xx])?[0-9][0-9_]*\\.?[0-9_]*(?:[pP](?:[+-]?[0-9_]+)?)?)\\b",relevance:0},{begin:"\\$[0-9][0-9A-Fa-f]*",relevance:0},{begin:"\\b(?:[0-9A-Fa-f][0-9A-Fa-f_]*[Hh]|[0-9][0-9_]*[DdTt]?|[0-7][0-7_]*[QqOo]|[0-1][0-1_]*[BbYy])\\b"},{begin:"\\b(?:0[Xx][0-9A-Fa-f_]+|0[DdTt][0-9_]+|0[QqOo][0-7_]+|0[BbYy][0-1_]+)\\b"}]},s.QUOTE_STRING_MODE,{className:"string",variants:[{begin:"'",end:"[^\\\\]'"},{begin:"`",end:"[^\\\\]`"}],relevance:0},{className:"symbol",variants:[{begin:"^\\s*[A-Za-z._?][A-Za-z0-9_$#@~.?]*(:|\\s+label)"},{begin:"^\\s*%%[A-Za-z0-9_$#@~.?]*:"}],relevance:0},{className:"subst",begin:"%[0-9]+",relevance:0},{className:"subst",begin:"%!S+",relevance:0},{className:"meta",begin:/^\s*\.[\w_-]+/}]}}}());
\ No newline at end of file
diff --git a/img/ferris/does_not_compile.svg b/img/ferris/does_not_compile.svg
new file mode 100644
index 0000000000..48b7b4d3a4
--- /dev/null
+++ b/img/ferris/does_not_compile.svg
@@ -0,0 +1,72 @@
+
+
+
+
diff --git a/img/ferris/not_desired_behavior.svg b/img/ferris/not_desired_behavior.svg
new file mode 100644
index 0000000000..47f402455f
--- /dev/null
+++ b/img/ferris/not_desired_behavior.svg
@@ -0,0 +1,75 @@
+
+
+
+
diff --git a/img/ferris/panics.svg b/img/ferris/panics.svg
new file mode 100644
index 0000000000..be55f5e09b
--- /dev/null
+++ b/img/ferris/panics.svg
@@ -0,0 +1,70 @@
+
+
+
+
diff --git a/img/trpl04-01.svg b/img/trpl04-01.svg
new file mode 100644
index 0000000000..314f53ba12
--- /dev/null
+++ b/img/trpl04-01.svg
@@ -0,0 +1,68 @@
+
+
+
+
+
diff --git a/img/trpl04-02.svg b/img/trpl04-02.svg
new file mode 100644
index 0000000000..70d490f0bc
--- /dev/null
+++ b/img/trpl04-02.svg
@@ -0,0 +1,95 @@
+
+
+
+
+
diff --git a/img/trpl04-03.svg b/img/trpl04-03.svg
new file mode 100644
index 0000000000..7c153e23a3
--- /dev/null
+++ b/img/trpl04-03.svg
@@ -0,0 +1,123 @@
+
+
+
+
+
diff --git a/img/trpl04-04.svg b/img/trpl04-04.svg
new file mode 100644
index 0000000000..a0513abd90
--- /dev/null
+++ b/img/trpl04-04.svg
@@ -0,0 +1,96 @@
+
+
+
+
+
diff --git a/img/trpl04-05.svg b/img/trpl04-05.svg
new file mode 100644
index 0000000000..b4bf2ebee8
--- /dev/null
+++ b/img/trpl04-05.svg
@@ -0,0 +1,87 @@
+
+
+
+
+
diff --git a/img/trpl04-06.svg b/img/trpl04-06.svg
new file mode 100644
index 0000000000..e64415fe43
--- /dev/null
+++ b/img/trpl04-06.svg
@@ -0,0 +1,115 @@
+
+
+
+
+
diff --git a/img/trpl14-01.png b/img/trpl14-01.png
new file mode 100644
index 0000000000..d7deaaf952
Binary files /dev/null and b/img/trpl14-01.png differ
diff --git a/img/trpl14-02.png b/img/trpl14-02.png
new file mode 100644
index 0000000000..121801b763
Binary files /dev/null and b/img/trpl14-02.png differ
diff --git a/img/trpl14-03.png b/img/trpl14-03.png
new file mode 100644
index 0000000000..cf5a15c41a
Binary files /dev/null and b/img/trpl14-03.png differ
diff --git a/img/trpl14-04.png b/img/trpl14-04.png
new file mode 100644
index 0000000000..dc1caaba9c
Binary files /dev/null and b/img/trpl14-04.png differ
diff --git a/img/trpl15-01.svg b/img/trpl15-01.svg
new file mode 100644
index 0000000000..bbeef968a2
--- /dev/null
+++ b/img/trpl15-01.svg
@@ -0,0 +1,43 @@
+
+
+
+
+
diff --git a/img/trpl15-02.svg b/img/trpl15-02.svg
new file mode 100644
index 0000000000..4454df8c38
--- /dev/null
+++ b/img/trpl15-02.svg
@@ -0,0 +1,26 @@
+
+
+
+
+
diff --git a/img/trpl15-03.svg b/img/trpl15-03.svg
new file mode 100644
index 0000000000..dbc3b5cdb0
--- /dev/null
+++ b/img/trpl15-03.svg
@@ -0,0 +1,109 @@
+
+
+
+
+
diff --git a/img/trpl15-04.svg b/img/trpl15-04.svg
new file mode 100644
index 0000000000..7285ae6735
--- /dev/null
+++ b/img/trpl15-04.svg
@@ -0,0 +1,84 @@
+
+
+
+
+
diff --git a/img/trpl20-01.png b/img/trpl20-01.png
new file mode 100644
index 0000000000..19e2cbc0ac
Binary files /dev/null and b/img/trpl20-01.png differ
diff --git a/index.html b/index.html
index 5448307d43..5f45587f42 100644
--- a/index.html
+++ b/index.html
@@ -1,14 +1,245 @@
-
-
-
-
- The Rust Programming Language
-
-
-
-
by Steve Klabnik and Carol Nichols, with contributions from the Rust Community
+
This version of the text assumes you’re using Rust 1.78.0 (released 2024-05-02)
+or later. See the “Installation” section of Chapter 1
+to install or update Rust.
+
The HTML format is available online at
+https://doc.rust-lang.org/stable/book/
+and offline with installations of Rust made with rustup; run rustup doc --book to open.
+
Several community translations are also available.
🚨 Want a more interactive learning experience? Try out a different version
+of the Rust Book, featuring: quizzes, highlighting, visualizations, and
+more: https://rust-book.cs.brown.edu
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 0000000000..1636231883
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n1&&void 0!==arguments[1])||arguments[1],i=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=n,this.iframes=r,this.exclude=i,this.iframesTimeout=o}return n(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach(function(t){var n=e.filter(function(e){return e.contains(t)}).length>0;-1!==e.indexOf(t)||n||e.push(t)}),e}},{key:"getIframeContents",value:function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},r=void 0;try{var i=e.contentWindow;if(r=i.document,!i||!r)throw new Error("iframe inaccessible")}catch(e){n()}r&&t(r)}},{key:"isIframeBlank",value:function(e){var t="about:blank",n=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&n!==t&&n}},{key:"observeIframeLoad",value:function(e,t,n){var r=this,i=!1,o=null,a=function a(){if(!i){i=!0,clearTimeout(o);try{r.isIframeBlank(e)||(e.removeEventListener("load",a),r.getIframeContents(e,t,n))}catch(e){n()}}};e.addEventListener("load",a),o=setTimeout(a,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,n){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,n):this.getIframeContents(e,t,n):this.observeIframeLoad(e,t,n)}catch(e){n()}}},{key:"waitForIframes",value:function(e,t){var n=this,r=0;this.forEachIframe(e,function(){return!0},function(e){r++,n.waitForIframes(e.querySelector("html"),function(){--r||t()})},function(e){e||t()})}},{key:"forEachIframe",value:function(t,n,r){var i=this,o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},a=t.querySelectorAll("iframe"),s=a.length,c=0;a=Array.prototype.slice.call(a);var u=function(){--s<=0&&o(c)};s||u(),a.forEach(function(t){e.matches(t,i.exclude)?u():i.onIframeReady(t,function(e){n(t)&&(c++,r(e)),u()},u)})}},{key:"createIterator",value:function(e,t,n){return document.createNodeIterator(e,t,n,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,n){if(e.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:null===t?e.nextNode():e.nextNode()&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,n,r){var i=!1,o=!1;return r.forEach(function(e,t){e.val===n&&(i=t,o=e.handled)}),this.compareNodeIframe(e,t,n)?(!1!==i||o?!1===i||o||(r[i].handled=!0):r.push({val:n,handled:!0}),!0):(!1===i&&r.push({val:n,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,n,r){var i=this;e.forEach(function(e){e.handled||i.getIframeContents(e.val,function(e){i.createInstanceOnIframe(e).forEachNode(t,n,r)})})}},{key:"iterateThroughNodes",value:function(e,t,n,r,i){for(var o,a=this,s=this.createIterator(t,e,r),c=[],u=[],l=void 0,h=void 0;void 0,o=a.getIteratorNode(s),h=o.prevNode,l=o.node;)this.iframes&&this.forEachIframe(t,function(e){return a.checkIframeFilter(l,h,e,c)},function(t){a.createInstanceOnIframe(t).forEachNode(e,function(e){return u.push(e)},r)}),u.push(l);u.forEach(function(e){n(e)}),this.iframes&&this.handleOpenIframes(c,e,n,r),i()}},{key:"forEachNode",value:function(e,t,n){var r=this,i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},o=this.getContexts(),a=o.length;a||i(),o.forEach(function(o){var s=function(){r.iterateThroughNodes(e,o,t,n,function(){--a<=0&&i()})};r.iframes?r.waitForIframes(o,s):s()})}}],[{key:"matches",value:function(e,t){var n="string"==typeof t?[t]:t,r=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(r){var i=!1;return n.every(function(t){return!r.call(e,t)||(i=!0,!1)}),i}return!1}}]),e}(),o=function(){function e(n){t(this,e),this.opt=r({},{diacritics:!0,synonyms:{},accuracy:"partially",caseSensitive:!1,ignoreJoiners:!1,ignorePunctuation:[],wildcards:"disabled"},n)}return n(e,[{key:"create",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),e=this.createAccuracyRegExp(e),new RegExp(e,"gm"+(this.opt.caseSensitive?"":"i"))}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,n=this.opt.caseSensitive?"":"i",r=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var i in t)if(t.hasOwnProperty(i)){var o=t[i],a="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(i):this.escapeStr(i),s="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(o):this.escapeStr(o);""!==a&&""!==s&&(e=e.replace(new RegExp("("+this.escapeStr(a)+"|"+this.escapeStr(s)+")","gm"+n),r+"("+this.processSynonyms(a)+"|"+this.processSynonyms(s)+")"+r))}return e}},{key:"processSynonyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,function(e){return"\\"===e.charAt(0)?"?":""})).replace(/(?:\\)*\*/g,function(e){return"\\"===e.charAt(0)?"*":""})}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,function(e,t,n){var r=n.charAt(t+1);return/[(|)\\]/.test(r)||""===r?e:e+"\0"})}},{key:"createJoinersRegExp",value:function(e){var t=[],n=this.opt.ignorePunctuation;return Array.isArray(n)&&n.length&&t.push(this.escapeStr(n.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",n=this.opt.caseSensitive?["aàáảãạăằắẳẵặâầấẩẫậäåāą","AÀÁẢÃẠĂẰẮẲẴẶÂẦẤẨẪẬÄÅĀĄ","cçćč","CÇĆČ","dđď","DĐĎ","eèéẻẽẹêềếểễệëěēę","EÈÉẺẼẸÊỀẾỂỄỆËĚĒĘ","iìíỉĩịîïī","IÌÍỈĨỊÎÏĪ","lł","LŁ","nñňń","NÑŇŃ","oòóỏõọôồốổỗộơởỡớờợöøō","OÒÓỎÕỌÔỒỐỔỖỘƠỞỠỚỜỢÖØŌ","rř","RŘ","sšśșş","SŠŚȘŞ","tťțţ","TŤȚŢ","uùúủũụưừứửữựûüůū","UÙÚỦŨỤƯỪỨỬỮỰÛÜŮŪ","yýỳỷỹỵÿ","YÝỲỶỸỴŸ","zžżź","ZŽŻŹ"]:["aàáảãạăằắẳẵặâầấẩẫậäåāąAÀÁẢÃẠĂẰẮẲẴẶÂẦẤẨẪẬÄÅĀĄ","cçćčCÇĆČ","dđďDĐĎ","eèéẻẽẹêềếểễệëěēęEÈÉẺẼẸÊỀẾỂỄỆËĚĒĘ","iìíỉĩịîïīIÌÍỈĨỊÎÏĪ","lłLŁ","nñňńNÑŇŃ","oòóỏõọôồốổỗộơởỡớờợöøōOÒÓỎÕỌÔỒỐỔỖỘƠỞỠỚỜỢÖØŌ","rřRŘ","sšśșşSŠŚȘŞ","tťțţTŤȚŢ","uùúủũụưừứửữựûüůūUÙÚỦŨỤƯỪỨỬỮỰÛÜŮŪ","yýỳỷỹỵÿYÝỲỶỸỴŸ","zžżźZŽŻŹ"],r=[];return e.split("").forEach(function(i){n.every(function(n){if(-1!==n.indexOf(i)){if(r.indexOf(n)>-1)return!1;e=e.replace(new RegExp("["+n+"]","gm"+t),"["+n+"]"),r.push(n)}return!0})}),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,n=this.opt.accuracy,r="string"==typeof n?n:n.value,i="";switch(("string"==typeof n?[]:n.limiters).forEach(function(e){i+="|"+t.escapeStr(e)}),r){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(i="\\s"+(i||this.escapeStr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~¡¿")))+"]*"+e+"[^"+i+"]*)";case"exactly":return"(^|\\s"+i+")("+e+")(?=$|\\s"+i+")"}}}]),e}(),a=function(){function a(e){t(this,a),this.ctx=e,this.ie=!1;var n=window.navigator.userAgent;(n.indexOf("MSIE")>-1||n.indexOf("Trident")>-1)&&(this.ie=!0)}return n(a,[{key:"log",value:function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",r=this.opt.log;this.opt.debug&&"object"===(void 0===r?"undefined":e(r))&&"function"==typeof r[n]&&r[n]("mark.js: "+t)}},{key:"getSeparatedKeywords",value:function(e){var t=this,n=[];return e.forEach(function(e){t.opt.separateWordSearch?e.split(" ").forEach(function(e){e.trim()&&-1===n.indexOf(e)&&n.push(e)}):e.trim()&&-1===n.indexOf(e)&&n.push(e)}),{keywords:n.sort(function(e,t){return t.length-e.length}),length:n.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var n=[],r=0;return e.sort(function(e,t){return e.start-t.start}).forEach(function(e){var i=t.callNoMatchOnInvalidRanges(e,r),o=i.start,a=i.end;i.valid&&(e.start=o,e.length=a-o,n.push(e),r=a)}),n}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var n=void 0,r=void 0,i=!1;return e&&void 0!==e.start?(r=(n=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&r-t>0&&r-n>0?i=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:n,end:r,valid:i}}},{key:"checkWhitespaceRanges",value:function(e,t,n){var r=void 0,i=!0,o=n.length,a=t-o,s=parseInt(e.start,10)-a;return(r=(s=s>o?o:s)+parseInt(e.length,10))>o&&(r=o,this.log("End range automatically set to the max value of "+o)),s<0||r-s<0||s>o||r>o?(i=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===n.substring(s,r).replace(/\s+/g,"")&&(i=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:s,end:r,valid:i}}},{key:"getTextNodes",value:function(e){var t=this,n="",r=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,function(e){r.push({start:n.length,end:(n+=e.textContent).length,node:e})},function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT},function(){e({value:n,nodes:r})})}},{key:"matchesExclude",value:function(e){return i.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,n){var r=this.opt.element?this.opt.element:"mark",i=e.splitText(t),o=i.splitText(n-t),a=document.createElement(r);return a.setAttribute("data-markjs","true"),this.opt.className&&a.setAttribute("class",this.opt.className),a.textContent=i.textContent,i.parentNode.replaceChild(a,i),o}},{key:"wrapRangeInMappedTextNode",value:function(e,t,n,r,i){var o=this;e.nodes.every(function(a,s){var c=e.nodes[s+1];if(void 0===c||c.start>t){if(!r(a.node))return!1;var u=t-a.start,l=(n>a.end?a.end:n)-a.start,h=e.value.substr(0,a.start),f=e.value.substr(l+a.start);if(a.node=o.wrapRangeInTextNode(a.node,u,l),e.value=h+f,e.nodes.forEach(function(t,n){n>=s&&(e.nodes[n].start>0&&n!==s&&(e.nodes[n].start-=l),e.nodes[n].end-=l)}),n-=l,i(a.node.previousSibling,a.start),!(n>a.end))return!1;t=a.end}return!0})}},{key:"wrapGroups",value:function(e,t,n,r){return r((e=this.wrapRangeInTextNode(e,t,t+n)).previousSibling),e}},{key:"separateGroups",value:function(e,t,n,r,i){for(var o=t.length,a=1;a-1&&r(t[a],e)&&(e=this.wrapGroups(e,s,t[a].length,i))}return e}},{key:"wrapMatches",value:function(e,t,n,r,i){var o=this,a=0===t?0:t+1;this.getTextNodes(function(t){t.nodes.forEach(function(t){t=t.node;for(var i=void 0;null!==(i=e.exec(t.textContent))&&""!==i[a];){if(o.opt.separateGroups)t=o.separateGroups(t,i,a,n,r);else{if(!n(i[a],t))continue;var s=i.index;if(0!==a)for(var c=1;c
+
+
+
+
+ The Rust Programming Language
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
by Steve Klabnik and Carol Nichols, with contributions from the Rust Community
+
This version of the text assumes you’re using Rust 1.78.0 (released 2024-05-02)
+or later. See the “Installation” section of Chapter 1
+to install or update Rust.
+
The HTML format is available online at
+https://doc.rust-lang.org/stable/book/
+and offline with installations of Rust made with rustup; run rustup doc --book to open.
+
Several community translations are also available.
🚨 Want a more interactive learning experience? Try out a different version
+of the Rust Book, featuring: quizzes, highlighting, visualizations, and
+more: https://rust-book.cs.brown.edu
It wasn’t always so clear, but the Rust programming language is fundamentally
+about empowerment: no matter what kind of code you are writing now, Rust
+empowers you to reach farther, to program with confidence in a wider variety of
+domains than you did before.
+
Take, for example, “systems-level” work that deals with low-level details of
+memory management, data representation, and concurrency. Traditionally, this
+realm of programming is seen as arcane, accessible only to a select few who
+have devoted the necessary years learning to avoid its infamous pitfalls. And
+even those who practice it do so with caution, lest their code be open to
+exploits, crashes, or corruption.
+
Rust breaks down these barriers by eliminating the old pitfalls and providing a
+friendly, polished set of tools to help you along the way. Programmers who need
+to “dip down” into lower-level control can do so with Rust, without taking on
+the customary risk of crashes or security holes, and without having to learn
+the fine points of a fickle toolchain. Better yet, the language is designed to
+guide you naturally towards reliable code that is efficient in terms of speed
+and memory usage.
+
Programmers who are already working with low-level code can use Rust to raise
+their ambitions. For example, introducing parallelism in Rust is a relatively
+low-risk operation: the compiler will catch the classical mistakes for you. And
+you can tackle more aggressive optimizations in your code with the confidence
+that you won’t accidentally introduce crashes or vulnerabilities.
+
But Rust isn’t limited to low-level systems programming. It’s expressive and
+ergonomic enough to make CLI apps, web servers, and many other kinds of code
+quite pleasant to write — you’ll find simple examples of both later in the
+book. Working with Rust allows you to build skills that transfer from one
+domain to another; you can learn Rust by writing a web app, then apply those
+same skills to target your Raspberry Pi.
+
This book fully embraces the potential of Rust to empower its users. It’s a
+friendly and approachable text intended to help you level up not just your
+knowledge of Rust, but also your reach and confidence as a programmer in
+general. So dive in, get ready to learn—and welcome to the Rust community!
Welcome to The Rust Programming Language, an introductory book about Rust.
+The Rust programming language helps you write faster, more reliable software.
+High-level ergonomics and low-level control are often at odds in programming
+language design; Rust challenges that conflict. Through balancing powerful
+technical capacity and a great developer experience, Rust gives you the option
+to control low-level details (such as memory usage) without all the hassle
+traditionally associated with such control.
Rust is proving to be a productive tool for collaborating among large teams of
+developers with varying levels of systems programming knowledge. Low-level code
+is prone to various subtle bugs, which in most other languages can be caught
+only through extensive testing and careful code review by experienced
+developers. In Rust, the compiler plays a gatekeeper role by refusing to
+compile code with these elusive bugs, including concurrency bugs. By working
+alongside the compiler, the team can spend their time focusing on the program’s
+logic rather than chasing down bugs.
+
Rust also brings contemporary developer tools to the systems programming world:
+
+
Cargo, the included dependency manager and build tool, makes adding,
+compiling, and managing dependencies painless and consistent across the Rust
+ecosystem.
+
The Rustfmt formatting tool ensures a consistent coding style across
+developers.
+
The rust-analyzer powers Integrated Development Environment (IDE)
+integration for code completion and inline error messages.
+
+
By using these and other tools in the Rust ecosystem, developers can be
+productive while writing systems-level code.
Rust is for students and those who are interested in learning about systems
+concepts. Using Rust, many people have learned about topics like operating
+systems development. The community is very welcoming and happy to answer
+student questions. Through efforts such as this book, the Rust teams want to
+make systems concepts more accessible to more people, especially those new to
+programming.
Hundreds of companies, large and small, use Rust in production for a variety of
+tasks, including command line tools, web services, DevOps tooling, embedded
+devices, audio and video analysis and transcoding, cryptocurrencies,
+bioinformatics, search engines, Internet of Things applications, machine
+learning, and even major parts of the Firefox web browser.
Rust is for people who want to build the Rust programming language, community,
+developer tools, and libraries. We’d love to have you contribute to the Rust
+language.
Rust is for people who crave speed and stability in a language. By speed, we
+mean both how quickly Rust code can run and the speed at which Rust lets you
+write programs. The Rust compiler’s checks ensure stability through feature
+additions and refactoring. This is in contrast to the brittle legacy code in
+languages without these checks, which developers are often afraid to modify. By
+striving for zero-cost abstractions, higher-level features that compile to
+lower-level code as fast as code written manually, Rust endeavors to make safe
+code be fast code as well.
+
The Rust language hopes to support many other users as well; those mentioned
+here are merely some of the biggest stakeholders. Overall, Rust’s greatest
+ambition is to eliminate the trade-offs that programmers have accepted for
+decades by providing safety and productivity, speed and ergonomics. Give
+Rust a try and see if its choices work for you.
This book assumes that you’ve written code in another programming language but
+doesn’t make any assumptions about which one. We’ve tried to make the material
+broadly accessible to those from a wide variety of programming backgrounds. We
+don’t spend a lot of time talking about what programming is or how to think
+about it. If you’re entirely new to programming, you would be better served by
+reading a book that specifically provides an introduction to programming.
In general, this book assumes that you’re reading it in sequence from front to
+back. Later chapters build on concepts in earlier chapters, and earlier
+chapters might not delve into details on a particular topic but will revisit
+the topic in a later chapter.
+
You’ll find two kinds of chapters in this book: concept chapters and project
+chapters. In concept chapters, you’ll learn about an aspect of Rust. In project
+chapters, we’ll build small programs together, applying what you’ve learned so
+far. Chapters 2, 12, and 20 are project chapters; the rest are concept chapters.
+
Chapter 1 explains how to install Rust, how to write a “Hello, world!” program,
+and how to use Cargo, Rust’s package manager and build tool. Chapter 2 is a
+hands-on introduction to writing a program in Rust, having you build up a
+number guessing game. Here we cover concepts at a high level, and later
+chapters will provide additional detail. If you want to get your hands dirty
+right away, Chapter 2 is the place for that. Chapter 3 covers Rust features
+that are similar to those of other programming languages, and in Chapter 4
+you’ll learn about Rust’s ownership system. If you’re a particularly meticulous
+learner who prefers to learn every detail before moving on to the next, you
+might want to skip Chapter 2 and go straight to Chapter 3, returning to Chapter
+2 when you’d like to work on a project applying the details you’ve learned.
+
Chapter 5 discusses structs and methods, and Chapter 6 covers enums, match
+expressions, and the if let control flow construct. You’ll use structs and
+enums to make custom types in Rust.
+
In Chapter 7, you’ll learn about Rust’s module system and about privacy rules
+for organizing your code and its public Application Programming Interface
+(API). Chapter 8 discusses some common collection data structures that the
+standard library provides, such as vectors, strings, and hash maps. Chapter 9
+explores Rust’s error-handling philosophy and techniques.
+
Chapter 10 digs into generics, traits, and lifetimes, which give you the power
+to define code that applies to multiple types. Chapter 11 is all about testing,
+which even with Rust’s safety guarantees is necessary to ensure your program’s
+logic is correct. In Chapter 12, we’ll build our own implementation of a subset
+of functionality from the grep command line tool that searches for text
+within files. For this, we’ll use many of the concepts we discussed in the
+previous chapters.
+
Chapter 13 explores closures and iterators: features of Rust that come from
+functional programming languages. In Chapter 14, we’ll examine Cargo in more
+depth and talk about best practices for sharing your libraries with others.
+Chapter 15 discusses smart pointers that the standard library provides and the
+traits that enable their functionality.
+
In Chapter 16, we’ll walk through different models of concurrent programming
+and talk about how Rust helps you to program in multiple threads fearlessly.
+Chapter 17 looks at how Rust idioms compare to object-oriented programming
+principles you might be familiar with.
+
Chapter 18 is a reference on patterns and pattern matching, which are powerful
+ways of expressing ideas throughout Rust programs. Chapter 19 contains a
+smorgasbord of advanced topics of interest, including unsafe Rust, macros, and
+more about lifetimes, traits, types, functions, and closures.
+
In Chapter 20, we’ll complete a project in which we’ll implement a low-level
+multithreaded web server!
+
Finally, some appendices contain useful information about the language in a
+more reference-like format. Appendix A covers Rust’s keywords, Appendix B
+covers Rust’s operators and symbols, Appendix C covers derivable traits
+provided by the standard library, Appendix D covers some useful development
+tools, and Appendix E explains Rust editions. In Appendix F, you can find
+translations of the book, and in Appendix G we’ll cover how Rust is made and
+what nightly Rust is.
+
There is no wrong way to read this book: if you want to skip ahead, go for it!
+You might have to jump back to earlier chapters if you experience any
+confusion. But do whatever works for you.
+
+
An important part of the process of learning Rust is learning how to read the
+error messages the compiler displays: these will guide you toward working code.
+As such, we’ll provide many examples that don’t compile along with the error
+message the compiler will show you in each situation. Know that if you enter
+and run a random example, it may not compile! Make sure you read the
+surrounding text to see whether the example you’re trying to run is meant to
+error. Ferris will also help you distinguish code that isn’t meant to work:
+
Ferris
Meaning
+
This code does not compile!
+
This code panics!
+
This code does not produce the desired behavior.
+
+
+
In most situations, we’ll lead you to the correct version of any code that
+doesn’t compile.
The first step is to install Rust. We’ll download Rust through rustup, a
+command line tool for managing Rust versions and associated tools. You’ll need
+an internet connection for the download.
The following steps install the latest stable version of the Rust compiler.
+Rust’s stability guarantees ensure that all the examples in the book that
+compile will continue to compile with newer Rust versions. The output might
+differ slightly between versions because Rust often improves error messages and
+warnings. In other words, any newer, stable version of Rust you install using
+these steps should work as expected with the content of this book.
In this chapter and throughout the book, we’ll show some commands used in the
+terminal. Lines that you should enter in a terminal all start with $. You
+don’t need to type the $ character; it’s the command line prompt shown to
+indicate the start of each command. Lines that don’t start with $ typically
+show the output of the previous command. Additionally, PowerShell-specific
+examples will use > rather than $.
If you’re using Linux or macOS, open a terminal and enter the following command:
+
$ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
+
+
The command downloads a script and starts the installation of the rustup
+tool, which installs the latest stable version of Rust. You might be prompted
+for your password. If the install is successful, the following line will appear:
+
Rust is installed now. Great!
+
+
You will also need a linker, which is a program that Rust uses to join its
+compiled outputs into one file. It is likely you already have one. If you get
+linker errors, you should install a C compiler, which will typically include a
+linker. A C compiler is also useful because some common Rust packages depend on
+C code and will need a C compiler.
+
On macOS, you can get a C compiler by running:
+
$ xcode-select --install
+
+
Linux users should generally install GCC or Clang, according to their
+distribution’s documentation. For example, if you use Ubuntu, you can install
+the build-essential package.
To check whether you have Rust installed correctly, open a shell and enter this
+line:
+
$ rustc --version
+
+
You should see the version number, commit hash, and commit date for the latest
+stable version that has been released, in the following format:
+
rustc x.y.z (abcabcabc yyyy-mm-dd)
+
+
If you see this information, you have installed Rust successfully! If you don’t
+see this information, check that Rust is in your %PATH% system variable as
+follows.
+
In Windows CMD, use:
+
> echo %PATH%
+
+
In PowerShell, use:
+
> echo $env:Path
+
+
In Linux and macOS, use:
+
$ echo $PATH
+
+
If that’s all correct and Rust still isn’t working, there are a number of
+places you can get help. Find out how to get in touch with other Rustaceans (a
+silly nickname we call ourselves) on the community page.
The installation of Rust also includes a local copy of the documentation so
+that you can read it offline. Run rustup doc to open the local documentation
+in your browser.
+
Any time a type or function is provided by the standard library and you’re not
+sure what it does or how to use it, use the application programming interface
+(API) documentation to find out!
Now that you’ve installed Rust, it’s time to write your first Rust program.
+It’s traditional when learning a new language to write a little program that
+prints the text Hello, world! to the screen, so we’ll do the same here!
+
+
Note: This book assumes basic familiarity with the command line. Rust makes
+no specific demands about your editing or tooling or where your code lives, so
+if you prefer to use an integrated development environment (IDE) instead of
+the command line, feel free to use your favorite IDE. Many IDEs now have some
+degree of Rust support; check the IDE’s documentation for details. The Rust
+team has been focusing on enabling great IDE support via rust-analyzer. See
+Appendix D for more details.
You’ll start by making a directory to store your Rust code. It doesn’t matter
+to Rust where your code lives, but for the exercises and projects in this book,
+we suggest making a projects directory in your home directory and keeping all
+your projects there.
+
Open a terminal and enter the following commands to make a projects directory
+and a directory for the “Hello, world!” project within the projects directory.
+
For Linux, macOS, and PowerShell on Windows, enter this:
+
$ mkdir ~/projects
+$ cd ~/projects
+$ mkdir hello_world
+$ cd hello_world
+
+
For Windows CMD, enter this:
+
> mkdir "%USERPROFILE%\projects"
+> cd /d "%USERPROFILE%\projects"
+> mkdir hello_world
+> cd hello_world
+
Next, make a new source file and call it main.rs. Rust files always end with
+the .rs extension. If you’re using more than one word in your filename, the
+convention is to use an underscore to separate them. For example, use
+hello_world.rs rather than helloworld.rs.
+
Now open the main.rs file you just created and enter the code in Listing 1-1.
+
+Filename: main.rs
+
fn main() {
+ println!("Hello, world!");
+}
+Listing 1-1: A program that prints Hello, world!
+
+
Save the file and go back to your terminal window in the
+~/projects/hello_world directory. On Linux or macOS, enter the following
+commands to compile and run the file:
+
$ rustc main.rs
+$ ./main
+Hello, world!
+
+
On Windows, enter the command .\main.exe instead of ./main:
+
> rustc main.rs
+> .\main.exe
+Hello, world!
+
+
Regardless of your operating system, the string Hello, world! should print to
+the terminal. If you don’t see this output, refer back to the
+“Troubleshooting” part of the Installation
+section for ways to get help.
+
If Hello, world! did print, congratulations! You’ve officially written a Rust
+program. That makes you a Rust programmer—welcome!
Let’s review this “Hello, world!” program in detail. Here’s the first piece of
+the puzzle:
+
fn main() {
+
+}
+
These lines define a function named main. The main function is special: it
+is always the first code that runs in every executable Rust program. Here, the
+first line declares a function named main that has no parameters and returns
+nothing. If there were parameters, they would go inside the parentheses ().
+
The function body is wrapped in {}. Rust requires curly brackets around all
+function bodies. It’s good style to place the opening curly bracket on the same
+line as the function declaration, adding one space in between.
+
+
Note: If you want to stick to a standard style across Rust projects, you can
+use an automatic formatter tool called rustfmt to format your code in a
+particular style (more on rustfmt in
+Appendix D). The Rust team has included this tool
+with the standard Rust distribution, as rustc is, so it should already be
+installed on your computer!
+
+
The body of the main function holds the following code:
This line does all the work in this little program: it prints text to the
+screen. There are four important details to notice here.
+
First, Rust style is to indent with four spaces, not a tab.
+
Second, println! calls a Rust macro. If it had called a function instead, it
+would be entered as println (without the !). We’ll discuss Rust macros in
+more detail in Chapter 19. For now, you just need to know that using a !
+means that you’re calling a macro instead of a normal function and that macros
+don’t always follow the same rules as functions.
+
Third, you see the "Hello, world!" string. We pass this string as an argument
+to println!, and the string is printed to the screen.
+
Fourth, we end the line with a semicolon (;), which indicates that this
+expression is over and the next one is ready to begin. Most lines of Rust code
+end with a semicolon.
You’ve just run a newly created program, so let’s examine each step in the
+process.
+
Before running a Rust program, you must compile it using the Rust compiler by
+entering the rustc command and passing it the name of your source file, like
+this:
+
$ rustc main.rs
+
+
If you have a C or C++ background, you’ll notice that this is similar to gcc
+or clang. After compiling successfully, Rust outputs a binary executable.
+
On Linux, macOS, and PowerShell on Windows, you can see the executable by
+entering the ls command in your shell:
+
$ ls
+main main.rs
+
+
On Linux and macOS, you’ll see two files. With PowerShell on Windows, you’ll
+see the same three files that you would see using CMD. With CMD on Windows, you
+would enter the following:
+
> dir /B %= the /B option says to only show the file names =%
+main.exe
+main.pdb
+main.rs
+
+
This shows the source code file with the .rs extension, the executable file
+(main.exe on Windows, but main on all other platforms), and, when using
+Windows, a file containing debugging information with the .pdb extension.
+From here, you run the main or main.exe file, like this:
+
$ ./main # or .\main.exe on Windows
+
+
If your main.rs is your “Hello, world!” program, this line prints Hello, world! to your terminal.
+
If you’re more familiar with a dynamic language, such as Ruby, Python, or
+JavaScript, you might not be used to compiling and running a program as
+separate steps. Rust is an ahead-of-time compiled language, meaning you can
+compile a program and give the executable to someone else, and they can run it
+even without having Rust installed. If you give someone a .rb, .py, or
+.js file, they need to have a Ruby, Python, or JavaScript implementation
+installed (respectively). But in those languages, you only need one command to
+compile and run your program. Everything is a trade-off in language design.
+
Just compiling with rustc is fine for simple programs, but as your project
+grows, you’ll want to manage all the options and make it easy to share your
+code. Next, we’ll introduce you to the Cargo tool, which will help you write
+real-world Rust programs.
Cargo is Rust’s build system and package manager. Most Rustaceans use this tool
+to manage their Rust projects because Cargo handles a lot of tasks for you,
+such as building your code, downloading the libraries your code depends on, and
+building those libraries. (We call the libraries that your code needs
+dependencies.)
+
The simplest Rust programs, like the one we’ve written so far, don’t have any
+dependencies. If we had built the “Hello, world!” project with Cargo, it would
+only use the part of Cargo that handles building your code. As you write more
+complex Rust programs, you’ll add dependencies, and if you start a project
+using Cargo, adding dependencies will be much easier to do.
+
Because the vast majority of Rust projects use Cargo, the rest of this book
+assumes that you’re using Cargo too. Cargo comes installed with Rust if you
+used the official installers discussed in the
+“Installation” section. If you installed Rust
+through some other means, check whether Cargo is installed by entering the
+following in your terminal:
+
$ cargo --version
+
+
If you see a version number, you have it! If you see an error, such as command not found, look at the documentation for your method of installation to
+determine how to install Cargo separately.
Let’s create a new project using Cargo and look at how it differs from our
+original “Hello, world!” project. Navigate back to your projects directory
+(or wherever you decided to store your code). Then, on any operating system,
+run the following:
+
$ cargo new hello_cargo
+$ cd hello_cargo
+
+
The first command creates a new directory and project called hello_cargo.
+We’ve named our project hello_cargo, and Cargo creates its files in a
+directory of the same name.
+
Go into the hello_cargo directory and list the files. You’ll see that Cargo
+has generated two files and one directory for us: a Cargo.toml file and a
+src directory with a main.rs file inside.
+
It has also initialized a new Git repository along with a .gitignore file.
+Git files won’t be generated if you run cargo new within an existing Git
+repository; you can override this behavior by using cargo new --vcs=git.
+
+
Note: Git is a common version control system. You can change cargo new to
+use a different version control system or no version control system by using
+the --vcs flag. Run cargo new --help to see the available options.
+
+
Open Cargo.toml in your text editor of choice. It should look similar to the
+code in Listing 1-2.
+
+Filename: Cargo.toml
+
[package]
+name = "hello_cargo"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+Listing 1-2: Contents of Cargo.toml generated by cargo new
+
+
This file is in the TOML (Tom’s Obvious, Minimal
+Language) format, which is Cargo’s configuration format.
+
The first line, [package], is a section heading that indicates that the
+following statements are configuring a package. As we add more information to
+this file, we’ll add other sections.
+
The next three lines set the configuration information Cargo needs to compile
+your program: the name, the version, and the edition of Rust to use. We’ll talk
+about the edition key in Appendix E.
+
The last line, [dependencies], is the start of a section for you to list any
+of your project’s dependencies. In Rust, packages of code are referred to as
+crates. We won’t need any other crates for this project, but we will in the
+first project in Chapter 2, so we’ll use this dependencies section then.
+
Now open src/main.rs and take a look:
+
Filename: src/main.rs
+
fn main() {
+ println!("Hello, world!");
+}
+
Cargo has generated a “Hello, world!” program for you, just like the one we
+wrote in Listing 1-1! So far, the differences between our project and the
+project Cargo generated are that Cargo placed the code in the src directory
+and we have a Cargo.toml configuration file in the top directory.
+
Cargo expects your source files to live inside the src directory. The
+top-level project directory is just for README files, license information,
+configuration files, and anything else not related to your code. Using Cargo
+helps you organize your projects. There’s a place for everything, and
+everything is in its place.
+
If you started a project that doesn’t use Cargo, as we did with the “Hello,
+world!” project, you can convert it to a project that does use Cargo. Move the
+project code into the src directory and create an appropriate Cargo.toml
+file.
Now let’s look at what’s different when we build and run the “Hello, world!”
+program with Cargo! From your hello_cargo directory, build your project by
+entering the following command:
+
$ cargo build
+ Compiling hello_cargo v0.1.0 (file:///projects/hello_cargo)
+ Finished dev [unoptimized + debuginfo] target(s) in 2.85 secs
+
+
This command creates an executable file in target/debug/hello_cargo (or
+target\debug\hello_cargo.exe on Windows) rather than in your current
+directory. Because the default build is a debug build, Cargo puts the binary in
+a directory named debug. You can run the executable with this command:
+
$ ./target/debug/hello_cargo # or .\target\debug\hello_cargo.exe on Windows
+Hello, world!
+
+
If all goes well, Hello, world! should print to the terminal. Running cargo build for the first time also causes Cargo to create a new file at the top
+level: Cargo.lock. This file keeps track of the exact versions of
+dependencies in your project. This project doesn’t have dependencies, so the
+file is a bit sparse. You won’t ever need to change this file manually; Cargo
+manages its contents for you.
+
We just built a project with cargo build and ran it with
+./target/debug/hello_cargo, but we can also use cargo run to compile the
+code and then run the resultant executable all in one command:
+
$ cargo run
+ Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
+ Running `target/debug/hello_cargo`
+Hello, world!
+
+
Using cargo run is more convenient than having to remember to run cargo build and then use the whole path to the binary, so most developers use cargo run.
+
Notice that this time we didn’t see output indicating that Cargo was compiling
+hello_cargo. Cargo figured out that the files hadn’t changed, so it didn’t
+rebuild but just ran the binary. If you had modified your source code, Cargo
+would have rebuilt the project before running it, and you would have seen this
+output:
+
$ cargo run
+ Compiling hello_cargo v0.1.0 (file:///projects/hello_cargo)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.33 secs
+ Running `target/debug/hello_cargo`
+Hello, world!
+
+
Cargo also provides a command called cargo check. This command quickly checks
+your code to make sure it compiles but doesn’t produce an executable:
+
$ cargo check
+ Checking hello_cargo v0.1.0 (file:///projects/hello_cargo)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.32 secs
+
+
Why would you not want an executable? Often, cargo check is much faster than
+cargo build because it skips the step of producing an executable. If you’re
+continually checking your work while writing the code, using cargo check will
+speed up the process of letting you know if your project is still compiling! As
+such, many Rustaceans run cargo check periodically as they write their
+program to make sure it compiles. Then they run cargo build when they’re
+ready to use the executable.
+
Let’s recap what we’ve learned so far about Cargo:
+
+
We can create a project using cargo new.
+
We can build a project using cargo build.
+
We can build and run a project in one step using cargo run.
+
We can build a project without producing a binary to check for errors using
+cargo check.
+
Instead of saving the result of the build in the same directory as our code,
+Cargo stores it in the target/debug directory.
+
+
An additional advantage of using Cargo is that the commands are the same no
+matter which operating system you’re working on. So, at this point, we’ll no
+longer provide specific instructions for Linux and macOS versus Windows.
When your project is finally ready for release, you can use cargo build --release to compile it with optimizations. This command will create an
+executable in target/release instead of target/debug. The optimizations
+make your Rust code run faster, but turning them on lengthens the time it takes
+for your program to compile. This is why there are two different profiles: one
+for development, when you want to rebuild quickly and often, and another for
+building the final program you’ll give to a user that won’t be rebuilt
+repeatedly and that will run as fast as possible. If you’re benchmarking your
+code’s running time, be sure to run cargo build --release and benchmark with
+the executable in target/release.
With simple projects, Cargo doesn’t provide a lot of value over just using
+rustc, but it will prove its worth as your programs become more intricate.
+Once programs grow to multiple files or need a dependency, it’s much easier to
+let Cargo coordinate the build.
+
Even though the hello_cargo project is simple, it now uses much of the real
+tooling you’ll use in the rest of your Rust career. In fact, to work on any
+existing projects, you can use the following commands to check out the code
+using Git, change to that project’s directory, and build:
You’re already off to a great start on your Rust journey! In this chapter,
+you’ve learned how to:
+
+
Install the latest stable version of Rust using rustup
+
Update to a newer Rust version
+
Open locally installed documentation
+
Write and run a “Hello, world!” program using rustc directly
+
Create and run a new project using the conventions of Cargo
+
+
This is a great time to build a more substantial program to get used to reading
+and writing Rust code. So, in Chapter 2, we’ll build a guessing game program.
+If you would rather start by learning how common programming concepts work in
+Rust, see Chapter 3 and then return to Chapter 2.
Let’s jump into Rust by working through a hands-on project together! This
+chapter introduces you to a few common Rust concepts by showing you how to use
+them in a real program. You’ll learn about let, match, methods, associated
+functions, external crates, and more! In the following chapters, we’ll explore
+these ideas in more detail. In this chapter, you’ll just practice the
+fundamentals.
+
We’ll implement a classic beginner programming problem: a guessing game. Here’s
+how it works: the program will generate a random integer between 1 and 100. It
+will then prompt the player to enter a guess. After a guess is entered, the
+program will indicate whether the guess is too low or too high. If the guess is
+correct, the game will print a congratulatory message and exit.
To set up a new project, go to the projects directory that you created in
+Chapter 1 and make a new project using Cargo, like so:
+
$ cargo new guessing_game
+$ cd guessing_game
+
+
The first command, cargo new, takes the name of the project (guessing_game)
+as the first argument. The second command changes to the new project’s
+directory.
+
Look at the generated Cargo.toml file:
+
+
Filename: Cargo.toml
+
[package]
+name = "guessing_game"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+
As you saw in Chapter 1, cargo new generates a “Hello, world!” program for
+you. Check out the src/main.rs file:
+
Filename: src/main.rs
+
fn main() {
+ println!("Hello, world!");
+}
+
Now let’s compile this “Hello, world!” program and run it in the same step
+using the cargo run command:
The run command comes in handy when you need to rapidly iterate on a project,
+as we’ll do in this game, quickly testing each iteration before moving on to
+the next one.
+
Reopen the src/main.rs file. You’ll be writing all the code in this file.
The first part of the guessing game program will ask for user input, process
+that input, and check that the input is in the expected form. To start, we’ll
+allow the player to input a guess. Enter the code in Listing 2-1 into
+src/main.rs.
+
+Filename: src/main.rs
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+Listing 2-1: Code that gets a guess from the user and prints it
+
+
This code contains a lot of information, so let’s go over it line by line. To
+obtain user input and then print the result as output, we need to bring the
+io input/output library into scope. The io library comes from the standard
+library, known as std:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
By default, Rust has a set of items defined in the standard library that it
+brings into the scope of every program. This set is called the prelude, and
+you can see everything in it in the standard library documentation.
+
If a type you want to use isn’t in the prelude, you have to bring that type
+into scope explicitly with a use statement. Using the std::io library
+provides you with a number of useful features, including the ability to accept
+user input.
+
As you saw in Chapter 1, the main function is the entry point into the
+program:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
The fn syntax declares a new function; the parentheses, (), indicate there
+are no parameters; and the curly bracket, {, starts the body of the function.
+
As you also learned in Chapter 1, println! is a macro that prints a string to
+the screen:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
This code is printing a prompt stating what the game is and requesting input
+from the user.
Next, we’ll create a variable to store the user input, like this:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
Now the program is getting interesting! There’s a lot going on in this little
+line. We use the let statement to create the variable. Here’s another example:
+
let apples = 5;
+
This line creates a new variable named apples and binds it to the value 5. In
+Rust, variables are immutable by default, meaning once we give the variable a
+value, the value won’t change. We’ll be discussing this concept in detail in
+the “Variables and Mutability”
+section in Chapter 3. To make a variable mutable, we add mut before the
+variable name:
+
let apples = 5; // immutable
+let mut bananas = 5; // mutable
+
+
Note: The // syntax starts a comment that continues until the end of the
+line. Rust ignores everything in comments. We’ll discuss comments in more
+detail in Chapter 3.
+
+
Returning to the guessing game program, you now know that let mut guess will
+introduce a mutable variable named guess. The equal sign (=) tells Rust we
+want to bind something to the variable now. On the right of the equal sign is
+the value that guess is bound to, which is the result of calling
+String::new, a function that returns a new instance of a String.
+String is a string type provided by the standard
+library that is a growable, UTF-8 encoded bit of text.
+
The :: syntax in the ::new line indicates that new is an associated
+function of the String type. An associated function is a function that’s
+implemented on a type, in this case String. This new function creates a
+new, empty string. You’ll find a new function on many types because it’s a
+common name for a function that makes a new value of some kind.
+
In full, the let mut guess = String::new(); line has created a mutable
+variable that is currently bound to a new, empty instance of a String. Whew!
Recall that we included the input/output functionality from the standard
+library with use std::io; on the first line of the program. Now we’ll call
+the stdin function from the io module, which will allow us to handle user
+input:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
If we hadn’t imported the io library with use std::io; at the beginning of
+the program, we could still use the function by writing this function call as
+std::io::stdin. The stdin function returns an instance of
+std::io::Stdin, which is a type that represents a
+handle to the standard input for your terminal.
+
Next, the line .read_line(&mut guess) calls the read_line method on the standard input handle to get input from the user.
+We’re also passing &mut guess as the argument to read_line to tell it what
+string to store the user input in. The full job of read_line is to take
+whatever the user types into standard input and append that into a string
+(without overwriting its contents), so we therefore pass that string as an
+argument. The string argument needs to be mutable so the method can change the
+string’s content.
+
The & indicates that this argument is a reference, which gives you a way to
+let multiple parts of your code access one piece of data without needing to
+copy that data into memory multiple times. References are a complex feature,
+and one of Rust’s major advantages is how safe and easy it is to use
+references. You don’t need to know a lot of those details to finish this
+program. For now, all you need to know is that, like variables, references are
+immutable by default. Hence, you need to write &mut guess rather than
+&guess to make it mutable. (Chapter 4 will explain references more
+thoroughly.)
We’re still working on this line of code. We’re now discussing a third line of
+text, but note that it’s still part of a single logical line of code. The next
+part is this method:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
We could have written this code as:
+
io::stdin().read_line(&mut guess).expect("Failed to read line");
+
However, one long line is difficult to read, so it’s best to divide it. It’s
+often wise to introduce a newline and other whitespace to help break up long
+lines when you call a method with the .method_name() syntax. Now let’s
+discuss what this line does.
+
As mentioned earlier, read_line puts whatever the user enters into the string
+we pass to it, but it also returns a Result value. Result is an enumeration, often called an enum,
+which is a type that can be in one of multiple possible states. We call each
+possible state a variant.
+
Chapter 6 will cover enums in more detail. The purpose
+of these Result types is to encode error-handling information.
+
Result’s variants are Ok and Err. The Ok variant indicates the
+operation was successful, and inside Ok is the successfully generated value.
+The Err variant means the operation failed, and Err contains information
+about how or why the operation failed.
+
Values of the Result type, like values of any type, have methods defined on
+them. An instance of Result has an expect method
+that you can call. If this instance of Result is an Err value, expect
+will cause the program to crash and display the message that you passed as an
+argument to expect. If the read_line method returns an Err, it would
+likely be the result of an error coming from the underlying operating system.
+If this instance of Result is an Ok value, expect will take the return
+value that Ok is holding and return just that value to you so you can use it.
+In this case, that value is the number of bytes in the user’s input.
+
If you don’t call expect, the program will compile, but you’ll get a warning:
+
$ cargo build
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+warning: unused `Result` that must be used
+ --> src/main.rs:10:5
+ |
+10 | io::stdin().read_line(&mut guess);
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: this `Result` may be an `Err` variant, which should be handled
+ = note: `#[warn(unused_must_use)]` on by default
+help: use `let _ = ...` to ignore the resulting value
+ |
+10 | let _ = io::stdin().read_line(&mut guess);
+ | +++++++
+
+warning: `guessing_game` (bin "guessing_game") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.59s
+
+
Rust warns that you haven’t used the Result value returned from read_line,
+indicating that the program hasn’t handled a possible error.
+
The right way to suppress the warning is to actually write error-handling code,
+but in our case we just want to crash this program when a problem occurs, so we
+can use expect. You’ll learn about recovering from errors in Chapter
+9.
Aside from the closing curly bracket, there’s only one more line to discuss in
+the code so far:
+
use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {}", guess);
+}
+
This line prints the string that now contains the user’s input. The {} set of
+curly brackets is a placeholder: think of {} as little crab pincers that hold
+a value in place. When printing the value of a variable, the variable name can
+go inside the curly brackets. When printing the result of evaluating an
+expression, place empty curly brackets in the format string, then follow the
+format string with a comma-separated list of expressions to print in each empty
+curly bracket placeholder in the same order. Printing a variable and the result
+of an expression in one call to println! would look like this:
+
#![allow(unused)]
+fn main() {
+let x = 5;
+let y = 10;
+
+println!("x = {x} and y + 2 = {}", y + 2);
+}
Next, we need to generate a secret number that the user will try to guess. The
+secret number should be different every time so the game is fun to play more
+than once. We’ll use a random number between 1 and 100 so the game isn’t too
+difficult. Rust doesn’t yet include random number functionality in its standard
+library. However, the Rust team does provide a rand crate with
+said functionality.
Remember that a crate is a collection of Rust source code files. The project
+we’ve been building is a binary crate, which is an executable. The rand
+crate is a library crate, which contains code that is intended to be used in
+other programs and can’t be executed on its own.
+
Cargo’s coordination of external crates is where Cargo really shines. Before we
+can write code that uses rand, we need to modify the Cargo.toml file to
+include the rand crate as a dependency. Open that file now and add the
+following line to the bottom, beneath the [dependencies] section header that
+Cargo created for you. Be sure to specify rand exactly as we have here, with
+this version number, or the code examples in this tutorial may not work:
+
+
Filename: Cargo.toml
+
[dependencies]
+rand = "0.8.5"
+
+
In the Cargo.toml file, everything that follows a header is part of that
+section that continues until another section starts. In [dependencies] you
+tell Cargo which external crates your project depends on and which versions of
+those crates you require. In this case, we specify the rand crate with the
+semantic version specifier 0.8.5. Cargo understands Semantic
+Versioning (sometimes called SemVer), which is a
+standard for writing version numbers. The specifier 0.8.5 is actually
+shorthand for ^0.8.5, which means any version that is at least 0.8.5 but
+below 0.9.0.
+
Cargo considers these versions to have public APIs compatible with version
+0.8.5, and this specification ensures you’ll get the latest patch release that
+will still compile with the code in this chapter. Any version 0.9.0 or greater
+is not guaranteed to have the same API as what the following examples use.
+
Now, without changing any of the code, let’s build the project, as shown in
+Listing 2-2.
+Listing 2-2: The output from running cargo build after adding the rand crate as a dependency
+
+
You may see different version numbers (but they will all be compatible with the
+code, thanks to SemVer!) and different lines (depending on the operating
+system), and the lines may be in a different order.
+
When we include an external dependency, Cargo fetches the latest versions of
+everything that dependency needs from the registry, which is a copy of data
+from Crates.io. Crates.io is where people in the Rust ecosystem
+post their open source Rust projects for others to use.
+
After updating the registry, Cargo checks the [dependencies] section and
+downloads any crates listed that aren’t already downloaded. In this case,
+although we only listed rand as a dependency, Cargo also grabbed other crates
+that rand depends on to work. After downloading the crates, Rust compiles
+them and then compiles the project with the dependencies available.
+
If you immediately run cargo build again without making any changes, you
+won’t get any output aside from the Finished line. Cargo knows it has already
+downloaded and compiled the dependencies, and you haven’t changed anything
+about them in your Cargo.toml file. Cargo also knows that you haven’t changed
+anything about your code, so it doesn’t recompile that either. With nothing to
+do, it simply exits.
+
If you open the src/main.rs file, make a trivial change, and then save it and
+build again, you’ll only see two lines of output:
+
+
$ cargo build
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 2.53 secs
+
+
These lines show that Cargo only updates the build with your tiny change to the
+src/main.rs file. Your dependencies haven’t changed, so Cargo knows it can
+reuse what it has already downloaded and compiled for those.
Cargo has a mechanism that ensures you can rebuild the same artifact every time
+you or anyone else builds your code: Cargo will use only the versions of the
+dependencies you specified until you indicate otherwise. For example, say that
+next week version 0.8.6 of the rand crate comes out, and that version
+contains an important bug fix, but it also contains a regression that will
+break your code. To handle this, Rust creates the Cargo.lock file the first
+time you run cargo build, so we now have this in the guessing_game
+directory.
+
When you build a project for the first time, Cargo figures out all the versions
+of the dependencies that fit the criteria and then writes them to the
+Cargo.lock file. When you build your project in the future, Cargo will see
+that the Cargo.lock file exists and will use the versions specified there
+rather than doing all the work of figuring out versions again. This lets you
+have a reproducible build automatically. In other words, your project will
+remain at 0.8.5 until you explicitly upgrade, thanks to the Cargo.lock file.
+Because the Cargo.lock file is important for reproducible builds, it’s often
+checked into source control with the rest of the code in your project.
When you do want to update a crate, Cargo provides the command update,
+which will ignore the Cargo.lock file and figure out all the latest versions
+that fit your specifications in Cargo.toml. Cargo will then write those
+versions to the Cargo.lock file. In this case, Cargo will only look for
+versions greater than 0.8.5 and less than 0.9.0. If the rand crate has
+released the two new versions 0.8.6 and 0.9.0, you would see the following if
+you ran cargo update:
Cargo ignores the 0.9.0 release. At this point, you would also notice a change
+in your Cargo.lock file noting that the version of the rand crate you are
+now using is 0.8.6. To use rand version 0.9.0 or any version in the 0.9.x
+series, you’d have to update the Cargo.toml file to look like this instead:
+
[dependencies]
+rand = "0.9.0"
+
+
The next time you run cargo build, Cargo will update the registry of crates
+available and reevaluate your rand requirements according to the new version
+you have specified.
+
There’s a lot more to say about Cargo and its
+ecosystem, which we’ll discuss in Chapter 14, but
+for now, that’s all you need to know. Cargo makes it very easy to reuse
+libraries, so Rustaceans are able to write smaller projects that are assembled
+from a number of packages.
Let’s start using rand to generate a number to guess. The next step is to
+update src/main.rs, as shown in Listing 2-3.
+
+Filename: src/main.rs
+
use std::io;
+use rand::Rng;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+}
+Listing 2-3: Adding code to generate a random number
+
+
First we add the line use rand::Rng;. The Rng trait defines methods that
+random number generators implement, and this trait must be in scope for us to
+use those methods. Chapter 10 will cover traits in detail.
+
Next, we’re adding two lines in the middle. In the first line, we call the
+rand::thread_rng function that gives us the particular random number
+generator we’re going to use: one that is local to the current thread of
+execution and is seeded by the operating system. Then we call the gen_range
+method on the random number generator. This method is defined by the Rng
+trait that we brought into scope with the use rand::Rng; statement. The
+gen_range method takes a range expression as an argument and generates a
+random number in the range. The kind of range expression we’re using here takes
+the form start..=end and is inclusive on the lower and upper bounds, so we
+need to specify 1..=100 to request a number between 1 and 100.
+
+
Note: You won’t just know which traits to use and which methods and functions
+to call from a crate, so each crate has documentation with instructions for
+using it. Another neat feature of Cargo is that running the cargo doc --open command will build documentation provided by all your dependencies
+locally and open it in your browser. If you’re interested in other
+functionality in the rand crate, for example, run cargo doc --open and
+click rand in the sidebar on the left.
+
+
The second new line prints the secret number. This is useful while we’re
+developing the program to be able to test it, but we’ll delete it from the
+final version. It’s not much of a game if the program prints the answer as soon
+as it starts!
+
Try running the program a few times:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 2.53s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 7
+Please input your guess.
+4
+You guessed: 4
+
+$ cargo run
+ Finished dev [unoptimized + debuginfo] target(s) in 0.02s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 83
+Please input your guess.
+5
+You guessed: 5
+
+
You should get different random numbers, and they should all be numbers between
+1 and 100. Great job!
Now that we have user input and a random number, we can compare them. That step
+is shown in Listing 2-4. Note that this code won’t compile just yet, as we will
+explain.
+
+Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ // --snip--
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+Listing 2-4: Handling the possible return values of comparing two numbers
+
+
First we add another use statement, bringing a type called
+std::cmp::Ordering into scope from the standard library. The Ordering type
+is another enum and has the variants Less, Greater, and Equal. These are
+the three outcomes that are possible when you compare two values.
+
Then we add five new lines at the bottom that use the Ordering type. The
+cmp method compares two values and can be called on anything that can be
+compared. It takes a reference to whatever you want to compare with: here it’s
+comparing guess to secret_number. Then it returns a variant of the
+Ordering enum we brought into scope with the use statement. We use a
+match expression to decide what to do next based on
+which variant of Ordering was returned from the call to cmp with the values
+in guess and secret_number.
+
A match expression is made up of arms. An arm consists of a pattern to
+match against, and the code that should be run if the value given to match
+fits that arm’s pattern. Rust takes the value given to match and looks
+through each arm’s pattern in turn. Patterns and the match construct are
+powerful Rust features: they let you express a variety of situations your code
+might encounter and they make sure you handle them all. These features will be
+covered in detail in Chapter 6 and Chapter 18, respectively.
+
Let’s walk through an example with the match expression we use here. Say that
+the user has guessed 50 and the randomly generated secret number this time is
+38.
+
When the code compares 50 to 38, the cmp method will return
+Ordering::Greater because 50 is greater than 38. The match expression gets
+the Ordering::Greater value and starts checking each arm’s pattern. It looks
+at the first arm’s pattern, Ordering::Less, and sees that the value
+Ordering::Greater does not match Ordering::Less, so it ignores the code in
+that arm and moves to the next arm. The next arm’s pattern is
+Ordering::Greater, which does match Ordering::Greater! The associated
+code in that arm will execute and print Too big! to the screen. The match
+expression ends after the first successful match, so it won’t look at the last
+arm in this scenario.
+
However, the code in Listing 2-4 won’t compile yet. Let’s try it:
+
+
$ cargo build
+ Compiling libc v0.2.86
+ Compiling getrandom v0.2.2
+ Compiling cfg-if v1.0.0
+ Compiling ppv-lite86 v0.2.10
+ Compiling rand_core v0.6.2
+ Compiling rand_chacha v0.3.0
+ Compiling rand v0.8.5
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+error[E0308]: mismatched types
+ --> src/main.rs:22:21
+ |
+22 | match guess.cmp(&secret_number) {
+ | --- ^^^^^^^^^^^^^^ expected `&String`, found `&{integer}`
+ | |
+ | arguments to this method are incorrect
+ |
+ = note: expected reference `&String`
+ found reference `&{integer}`
+note: method defined here
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/cmp.rs:836:8
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `guessing_game` (bin "guessing_game") due to 1 previous error
+
+
The core of the error states that there are mismatched types. Rust has a
+strong, static type system. However, it also has type inference. When we wrote
+let mut guess = String::new(), Rust was able to infer that guess should be
+a String and didn’t make us write the type. The secret_number, on the other
+hand, is a number type. A few of Rust’s number types can have a value between 1
+and 100: i32, a 32-bit number; u32, an unsigned 32-bit number; i64, a
+64-bit number; as well as others. Unless otherwise specified, Rust defaults to
+an i32, which is the type of secret_number unless you add type information
+elsewhere that would cause Rust to infer a different numerical type. The reason
+for the error is that Rust cannot compare a string and a number type.
+
Ultimately, we want to convert the String the program reads as input into a
+number type so we can compare it numerically to the secret number. We do so by
+adding this line to the main function body:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ // --snip--
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+
The line is:
+
let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
We create a variable named guess. But wait, doesn’t the program already have
+a variable named guess? It does, but helpfully Rust allows us to shadow the
+previous value of guess with a new one. Shadowing lets us reuse the guess
+variable name rather than forcing us to create two unique variables, such as
+guess_str and guess, for example. We’ll cover this in more detail in
+Chapter 3, but for now, know that this feature is
+often used when you want to convert a value from one type to another type.
+
We bind this new variable to the expression guess.trim().parse(). The guess
+in the expression refers to the original guess variable that contained the
+input as a string. The trim method on a String instance will eliminate any
+whitespace at the beginning and end, which we must do to be able to compare the
+string to the u32, which can only contain numerical data. The user must press
+enter to satisfy read_line and input their guess, which adds a
+newline character to the string. For example, if the user types 5 and
+presses enter, guess looks like this: 5\n. The \n represents
+“newline.” (On Windows, pressing enter results in a carriage return
+and a newline, \r\n.) The trim method eliminates \n or \r\n, resulting
+in just 5.
+
The parse method on strings converts a string to
+another type. Here, we use it to convert from a string to a number. We need to
+tell Rust the exact number type we want by using let guess: u32. The colon
+(:) after guess tells Rust we’ll annotate the variable’s type. Rust has a
+few built-in number types; the u32 seen here is an unsigned, 32-bit integer.
+It’s a good default choice for a small positive number. You’ll learn about
+other number types in Chapter 3.
+
Additionally, the u32 annotation in this example program and the comparison
+with secret_number means Rust will infer that secret_number should be a
+u32 as well. So now the comparison will be between two values of the same
+type!
+
The parse method will only work on characters that can logically be converted
+into numbers and so can easily cause errors. If, for example, the string
+contained A👍%, there would be no way to convert that to a number. Because it
+might fail, the parse method returns a Result type, much as the read_line
+method does (discussed earlier in “Handling Potential Failure with
+Result”). We’ll treat
+this Result the same way by using the expect method again. If parse
+returns an ErrResult variant because it couldn’t create a number from the
+string, the expect call will crash the game and print the message we give it.
+If parse can successfully convert the string to a number, it will return the
+Ok variant of Result, and expect will return the number that we want from
+the Ok value.
+
Let’s run the program now:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.43s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 58
+Please input your guess.
+ 76
+You guessed: 76
+Too big!
+
+
Nice! Even though spaces were added before the guess, the program still figured
+out that the user guessed 76. Run the program a few times to verify the
+different behavior with different kinds of input: guess the number correctly,
+guess a number that is too high, and guess a number that is too low.
+
We have most of the game working now, but the user can make only one guess.
+Let’s change that by adding a loop!
The loop keyword creates an infinite loop. We’ll add a loop to give users
+more chances at guessing the number:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ // --snip--
+
+ println!("The secret number is: {secret_number}");
+
+ loop {
+ println!("Please input your guess.");
+
+ // --snip--
+
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+ }
+}
+
As you can see, we’ve moved everything from the guess input prompt onward into
+a loop. Be sure to indent the lines inside the loop another four spaces each
+and run the program again. The program will now ask for another guess forever,
+which actually introduces a new problem. It doesn’t seem like the user can quit!
+
The user could always interrupt the program by using the keyboard shortcut
+ctrl-c. But there’s another way to escape this insatiable
+monster, as mentioned in the parse discussion in “Comparing the Guess to the
+Secret Number”: if
+the user enters a non-number answer, the program will crash. We can take
+advantage of that to allow the user to quit, as shown here:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 1.50s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 59
+Please input your guess.
+45
+You guessed: 45
+Too small!
+Please input your guess.
+60
+You guessed: 60
+Too big!
+Please input your guess.
+59
+You guessed: 59
+You win!
+Please input your guess.
+quit
+thread 'main' panicked at 'Please type a number!: ParseIntError { kind: InvalidDigit }', src/main.rs:28:47
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
Typing quit will quit the game, but as you’ll notice, so will entering any
+other non-number input. This is suboptimal, to say the least; we want the game
+to also stop when the correct number is guessed.
Let’s program the game to quit when the user wins by adding a break statement:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ loop {
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ // --snip--
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => {
+ println!("You win!");
+ break;
+ }
+ }
+ }
+}
+
Adding the break line after You win! makes the program exit the loop when
+the user guesses the secret number correctly. Exiting the loop also means
+exiting the program, because the loop is the last part of main.
To further refine the game’s behavior, rather than crashing the program when
+the user inputs a non-number, let’s make the game ignore a non-number so the
+user can continue guessing. We can do that by altering the line where guess
+is converted from a String to a u32, as shown in Listing 2-5.
+Listing 2-5: Ignoring a non-number guess and asking for another guess instead of crashing the program
+
+
We switch from an expect call to a match expression to move from crashing
+on an error to handling the error. Remember that parse returns a Result
+type and Result is an enum that has the variants Ok and Err. We’re using
+a match expression here, as we did with the Ordering result of the cmp
+method.
+
If parse is able to successfully turn the string into a number, it will
+return an Ok value that contains the resultant number. That Ok value will
+match the first arm’s pattern, and the match expression will just return the
+num value that parse produced and put inside the Ok value. That number
+will end up right where we want it in the new guess variable we’re creating.
+
If parse is not able to turn the string into a number, it will return an
+Err value that contains more information about the error. The Err value
+does not match the Ok(num) pattern in the first match arm, but it does
+match the Err(_) pattern in the second arm. The underscore, _, is a
+catchall value; in this example, we’re saying we want to match all Err
+values, no matter what information they have inside them. So the program will
+execute the second arm’s code, continue, which tells the program to go to the
+next iteration of the loop and ask for another guess. So, effectively, the
+program ignores all errors that parse might encounter!
+
Now everything in the program should work as expected. Let’s try it:
+
+
$ cargo run
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished dev [unoptimized + debuginfo] target(s) in 4.45s
+ Running `target/debug/guessing_game`
+Guess the number!
+The secret number is: 61
+Please input your guess.
+10
+You guessed: 10
+Too small!
+Please input your guess.
+99
+You guessed: 99
+Too big!
+Please input your guess.
+foo
+Please input your guess.
+61
+You guessed: 61
+You win!
+
+
Awesome! With one tiny final tweak, we will finish the guessing game. Recall
+that the program is still printing the secret number. That worked well for
+testing, but it ruins the game. Let’s delete the println! that outputs the
+secret number. Listing 2-6 shows the final code.
This project was a hands-on way to introduce you to many new Rust concepts:
+let, match, functions, the use of external crates, and more. In the next
+few chapters, you’ll learn about these concepts in more detail. Chapter 3
+covers concepts that most programming languages have, such as variables, data
+types, and functions, and shows how to use them in Rust. Chapter 4 explores
+ownership, a feature that makes Rust different from other languages. Chapter 5
+discusses structs and method syntax, and Chapter 6 explains how enums work.
This chapter covers concepts that appear in almost every programming language
+and how they work in Rust. Many programming languages have much in common at
+their core. None of the concepts presented in this chapter are unique to Rust,
+but we’ll discuss them in the context of Rust and explain the conventions
+around using these concepts.
+
Specifically, you’ll learn about variables, basic types, functions, comments,
+and control flow. These foundations will be in every Rust program, and learning
+them early will give you a strong core to start from.
The Rust language has a set of keywords that are reserved for use by the
+language only, much as in other languages. Keep in mind that you cannot use
+these words as names of variables or functions. Most of the keywords have
+special meanings, and you’ll be using them to do various tasks in your Rust
+programs; a few have no current functionality associated with them but have
+been reserved for functionality that might be added to Rust in the future. You
+can find a list of the keywords in Appendix A.
As mentioned in the “Storing Values with
+Variables” section, by default,
+variables are immutable. This is one of many nudges Rust gives you to write
+your code in a way that takes advantage of the safety and easy concurrency that
+Rust offers. However, you still have the option to make your variables mutable.
+Let’s explore how and why Rust encourages you to favor immutability and why
+sometimes you might want to opt out.
+
When a variable is immutable, once a value is bound to a name, you can’t change
+that value. To illustrate this, generate a new project called variables in
+your projects directory by using cargo new variables.
+
Then, in your new variables directory, open src/main.rs and replace its
+code with the following code, which won’t compile just yet:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+ println!("The value of x is: {x}");
+ x = 6;
+ println!("The value of x is: {x}");
+}
+
Save and run the program using cargo run. You should receive an error message
+regarding an immutability error, as shown in this output:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+error[E0384]: cannot assign twice to immutable variable `x`
+ --> src/main.rs:4:5
+ |
+2 | let x = 5;
+ | -
+ | |
+ | first assignment to `x`
+ | help: consider making this binding mutable: `mut x`
+3 | println!("The value of x is: {x}");
+4 | x = 6;
+ | ^^^^^ cannot assign twice to immutable variable
+
+For more information about this error, try `rustc --explain E0384`.
+error: could not compile `variables` (bin "variables") due to 1 previous error
+
+
This example shows how the compiler helps you find errors in your programs.
+Compiler errors can be frustrating, but really they only mean your program
+isn’t safely doing what you want it to do yet; they do not mean that you’re
+not a good programmer! Experienced Rustaceans still get compiler errors.
+
You received the error message cannot assign twice to immutable variable `x` because you tried to assign a second value to the immutable x variable.
+
It’s important that we get compile-time errors when we attempt to change a
+value that’s designated as immutable because this very situation can lead to
+bugs. If one part of our code operates on the assumption that a value will
+never change and another part of our code changes that value, it’s possible
+that the first part of the code won’t do what it was designed to do. The cause
+of this kind of bug can be difficult to track down after the fact, especially
+when the second piece of code changes the value only sometimes. The Rust
+compiler guarantees that when you state that a value won’t change, it really
+won’t change, so you don’t have to keep track of it yourself. Your code is thus
+easier to reason through.
+
But mutability can be very useful, and can make code more convenient to write.
+Although variables are immutable by default, you can make them mutable by
+adding mut in front of the variable name as you did in Chapter
+2. Adding mut also conveys
+intent to future readers of the code by indicating that other parts of the code
+will be changing this variable’s value.
+
For example, let’s change src/main.rs to the following:
+
Filename: src/main.rs
+
fn main() {
+ let mut x = 5;
+ println!("The value of x is: {x}");
+ x = 6;
+ println!("The value of x is: {x}");
+}
+
When we run the program now, we get this:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.30s
+ Running `target/debug/variables`
+The value of x is: 5
+The value of x is: 6
+
+
We’re allowed to change the value bound to x from 5 to 6 when mut is
+used. Ultimately, deciding whether to use mutability or not is up to you and
+depends on what you think is clearest in that particular situation.
Like immutable variables, constants are values that are bound to a name and
+are not allowed to change, but there are a few differences between constants
+and variables.
+
First, you aren’t allowed to use mut with constants. Constants aren’t just
+immutable by default—they’re always immutable. You declare constants using the
+const keyword instead of the let keyword, and the type of the value must
+be annotated. We’ll cover types and type annotations in the next section,
+“Data Types”, so don’t worry about the details
+right now. Just know that you must always annotate the type.
+
Constants can be declared in any scope, including the global scope, which makes
+them useful for values that many parts of code need to know about.
+
The last difference is that constants may be set only to a constant expression,
+not the result of a value that could only be computed at runtime.
The constant’s name is THREE_HOURS_IN_SECONDS and its value is set to the
+result of multiplying 60 (the number of seconds in a minute) by 60 (the number
+of minutes in an hour) by 3 (the number of hours we want to count in this
+program). Rust’s naming convention for constants is to use all uppercase with
+underscores between words. The compiler is able to evaluate a limited set of
+operations at compile time, which lets us choose to write out this value in a
+way that’s easier to understand and verify, rather than setting this constant
+to the value 10,800. See the Rust Reference’s section on constant
+evaluation for more information on what operations can be used
+when declaring constants.
+
Constants are valid for the entire time a program runs, within the scope in
+which they were declared. This property makes constants useful for values in
+your application domain that multiple parts of the program might need to know
+about, such as the maximum number of points any player of a game is allowed to
+earn, or the speed of light.
+
Naming hardcoded values used throughout your program as constants is useful in
+conveying the meaning of that value to future maintainers of the code. It also
+helps to have only one place in your code you would need to change if the
+hardcoded value needed to be updated in the future.
As you saw in the guessing game tutorial in Chapter
+2, you can declare a
+new variable with the same name as a previous variable. Rustaceans say that the
+first variable is shadowed by the second, which means that the second
+variable is what the compiler will see when you use the name of the variable.
+In effect, the second variable overshadows the first, taking any uses of the
+variable name to itself until either it itself is shadowed or the scope ends.
+We can shadow a variable by using the same variable’s name and repeating the
+use of the let keyword as follows:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+
+ let x = x + 1;
+
+ {
+ let x = x * 2;
+ println!("The value of x in the inner scope is: {x}");
+ }
+
+ println!("The value of x is: {x}");
+}
+
This program first binds x to a value of 5. Then it creates a new variable
+x by repeating let x =, taking the original value and adding 1 so the
+value of x is then 6. Then, within an inner scope created with the curly
+brackets, the third let statement also shadows x and creates a new
+variable, multiplying the previous value by 2 to give x a value of 12.
+When that scope is over, the inner shadowing ends and x returns to being 6.
+When we run this program, it will output the following:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/variables`
+The value of x in the inner scope is: 12
+The value of x is: 6
+
+
Shadowing is different from marking a variable as mut because we’ll get a
+compile-time error if we accidentally try to reassign to this variable without
+using the let keyword. By using let, we can perform a few transformations
+on a value but have the variable be immutable after those transformations have
+been completed.
+
The other difference between mut and shadowing is that because we’re
+effectively creating a new variable when we use the let keyword again, we can
+change the type of the value but reuse the same name. For example, say our
+program asks a user to show how many spaces they want between some text by
+inputting space characters, and then we want to store that input as a number:
+
fn main() {
+ let spaces = " ";
+ let spaces = spaces.len();
+}
+
The first spaces variable is a string type and the second spaces variable
+is a number type. Shadowing thus spares us from having to come up with
+different names, such as spaces_str and spaces_num; instead, we can reuse
+the simpler spaces name. However, if we try to use mut for this, as shown
+here, we’ll get a compile-time error:
The error says we’re not allowed to mutate a variable’s type:
+
$ cargo run
+ Compiling variables v0.1.0 (file:///projects/variables)
+error[E0308]: mismatched types
+ --> src/main.rs:3:14
+ |
+2 | let mut spaces = " ";
+ | ----- expected due to this value
+3 | spaces = spaces.len();
+ | ^^^^^^^^^^^^ expected `&str`, found `usize`
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `variables` (bin "variables") due to 1 previous error
+
+
Now that we’ve explored how variables work, let’s look at more data types they
+can have.
Every value in Rust is of a certain data type, which tells Rust what kind of
+data is being specified so it knows how to work with that data. We’ll look at
+two data type subsets: scalar and compound.
+
Keep in mind that Rust is a statically typed language, which means that it
+must know the types of all variables at compile time. The compiler can usually
+infer what type we want to use based on the value and how we use it. In cases
+when many types are possible, such as when we converted a String to a numeric
+type using parse in the “Comparing the Guess to the Secret
+Number” section in
+Chapter 2, we must add a type annotation, like this:
If we don’t add the : u32 type annotation shown in the preceding code, Rust
+will display the following error, which means the compiler needs more
+information from us to know which type we want to use:
+
$ cargo build
+ Compiling no_type_annotations v0.1.0 (file:///projects/no_type_annotations)
+error[E0284]: type annotations needed
+ --> src/main.rs:2:9
+ |
+2 | let guess = "42".parse().expect("Not a number!");
+ | ^^^^^ ----- type must be known at this point
+ |
+ = note: cannot satisfy `<_ as FromStr>::Err == _`
+help: consider giving `guess` an explicit type
+ |
+2 | let guess: /* Type */ = "42".parse().expect("Not a number!");
+ | ++++++++++++
+
+For more information about this error, try `rustc --explain E0284`.
+error: could not compile `no_type_annotations` (bin "no_type_annotations") due to 1 previous error
+
+
You’ll see different type annotations for other data types.
A scalar type represents a single value. Rust has four primary scalar types:
+integers, floating-point numbers, Booleans, and characters. You may recognize
+these from other programming languages. Let’s jump into how they work in Rust.
An integer is a number without a fractional component. We used one integer
+type in Chapter 2, the u32 type. This type declaration indicates that the
+value it’s associated with should be an unsigned integer (signed integer types
+start with i instead of u) that takes up 32 bits of space. Table 3-1 shows
+the built-in integer types in Rust. We can use any of these variants to declare
+the type of an integer value.
+
Table 3-1: Integer Types in Rust
+
Length
Signed
Unsigned
+
8-bit
i8
u8
+
16-bit
i16
u16
+
32-bit
i32
u32
+
64-bit
i64
u64
+
128-bit
i128
u128
+
arch
isize
usize
+
+
+
Each variant can be either signed or unsigned and has an explicit size.
+Signed and unsigned refer to whether it’s possible for the number to be
+negative—in other words, whether the number needs to have a sign with it
+(signed) or whether it will only ever be positive and can therefore be
+represented without a sign (unsigned). It’s like writing numbers on paper: when
+the sign matters, a number is shown with a plus sign or a minus sign; however,
+when it’s safe to assume the number is positive, it’s shown with no sign.
+Signed numbers are stored using two’s complement representation.
+
Each signed variant can store numbers from -(2n - 1) to 2n -
+1 - 1 inclusive, where n is the number of bits that variant uses. So an
+i8 can store numbers from -(27) to 27 - 1, which equals
+-128 to 127. Unsigned variants can store numbers from 0 to 2n - 1,
+so a u8 can store numbers from 0 to 28 - 1, which equals 0 to 255.
+
Additionally, the isize and usize types depend on the architecture of the
+computer your program is running on, which is denoted in the table as “arch”:
+64 bits if you’re on a 64-bit architecture and 32 bits if you’re on a 32-bit
+architecture.
+
You can write integer literals in any of the forms shown in Table 3-2. Note
+that number literals that can be multiple numeric types allow a type suffix,
+such as 57u8, to designate the type. Number literals can also use _ as a
+visual separator to make the number easier to read, such as 1_000, which will
+have the same value as if you had specified 1000.
+
Table 3-2: Integer Literals in Rust
+
Number literals
Example
+
Decimal
98_222
+
Hex
0xff
+
Octal
0o77
+
Binary
0b1111_0000
+
Byte (u8 only)
b'A'
+
+
+
So how do you know which type of integer to use? If you’re unsure, Rust’s
+defaults are generally good places to start: integer types default to i32.
+The primary situation in which you’d use isize or usize is when indexing
+some sort of collection.
Let’s say you have a variable of type u8 that can hold values between 0 and
+255. If you try to change the variable to a value outside that range, such as
+256, integer overflow will occur, which can result in one of two behaviors.
+When you’re compiling in debug mode, Rust includes checks for integer overflow
+that cause your program to panic at runtime if this behavior occurs. Rust
+uses the term panicking when a program exits with an error; we’ll discuss
+panics in more depth in the “Unrecoverable Errors with
+panic!” section in Chapter
+9.
+
When you’re compiling in release mode with the --release flag, Rust does
+not include checks for integer overflow that cause panics. Instead, if
+overflow occurs, Rust performs two’s complement wrapping. In short, values
+greater than the maximum value the type can hold “wrap around” to the minimum
+of the values the type can hold. In the case of a u8, the value 256 becomes
+0, the value 257 becomes 1, and so on. The program won’t panic, but the
+variable will have a value that probably isn’t what you were expecting it to
+have. Relying on integer overflow’s wrapping behavior is considered an error.
+
To explicitly handle the possibility of overflow, you can use these families
+of methods provided by the standard library for primitive numeric types:
+
+
Wrap in all modes with the wrapping_* methods, such as wrapping_add.
+
Return the None value if there is overflow with the checked_* methods.
+
Return the value and a boolean indicating whether there was overflow with
+the overflowing_* methods.
+
Saturate at the value’s minimum or maximum values with the saturating_*
+methods.
Rust also has two primitive types for floating-point numbers, which are
+numbers with decimal points. Rust’s floating-point types are f32 and f64,
+which are 32 bits and 64 bits in size, respectively. The default type is f64
+because on modern CPUs, it’s roughly the same speed as f32 but is capable of
+more precision. All floating-point types are signed.
+
Here’s an example that shows floating-point numbers in action:
+
Filename: src/main.rs
+
fn main() {
+ let x = 2.0; // f64
+
+ let y: f32 = 3.0; // f32
+}
+
Floating-point numbers are represented according to the IEEE-754 standard. The
+f32 type is a single-precision float, and f64 has double precision.
Rust supports the basic mathematical operations you’d expect for all the number
+types: addition, subtraction, multiplication, division, and remainder. Integer
+division truncates toward zero to the nearest integer. The following code shows
+how you’d use each numeric operation in a let statement:
+
Filename: src/main.rs
+
fn main() {
+ // addition
+ let sum = 5 + 10;
+
+ // subtraction
+ let difference = 95.5 - 4.3;
+
+ // multiplication
+ let product = 4 * 30;
+
+ // division
+ let quotient = 56.7 / 32.2;
+ let truncated = -5 / 3; // Results in -1
+
+ // remainder
+ let remainder = 43 % 5;
+}
+
Each expression in these statements uses a mathematical operator and evaluates
+to a single value, which is then bound to a variable. Appendix
+B contains a list of all operators that Rust
+provides.
As in most other programming languages, a Boolean type in Rust has two possible
+values: true and false. Booleans are one byte in size. The Boolean type in
+Rust is specified using bool. For example:
+
Filename: src/main.rs
+
fn main() {
+ let t = true;
+
+ let f: bool = false; // with explicit type annotation
+}
+
The main way to use Boolean values is through conditionals, such as an if
+expression. We’ll cover how if expressions work in Rust in the “Control
+Flow” section.
Rust’s char type is the language’s most primitive alphabetic type. Here are
+some examples of declaring char values:
+
Filename: src/main.rs
+
fn main() {
+ let c = 'z';
+ let z: char = 'ℤ'; // with explicit type annotation
+ let heart_eyed_cat = '😻';
+}
+
Note that we specify char literals with single quotes, as opposed to string
+literals, which use double quotes. Rust’s char type is four bytes in size and
+represents a Unicode Scalar Value, which means it can represent a lot more than
+just ASCII. Accented letters; Chinese, Japanese, and Korean characters; emoji;
+and zero-width spaces are all valid char values in Rust. Unicode Scalar
+Values range from U+0000 to U+D7FF and U+E000 to U+10FFFF inclusive.
+However, a “character” isn’t really a concept in Unicode, so your human
+intuition for what a “character” is may not match up with what a char is in
+Rust. We’ll discuss this topic in detail in “Storing UTF-8 Encoded Text with
+Strings” in Chapter 8.
A tuple is a general way of grouping together a number of values with a
+variety of types into one compound type. Tuples have a fixed length: once
+declared, they cannot grow or shrink in size.
+
We create a tuple by writing a comma-separated list of values inside
+parentheses. Each position in the tuple has a type, and the types of the
+different values in the tuple don’t have to be the same. We’ve added optional
+type annotations in this example:
The variable tup binds to the entire tuple because a tuple is considered a
+single compound element. To get the individual values out of a tuple, we can
+use pattern matching to destructure a tuple value, like this:
+
Filename: src/main.rs
+
fn main() {
+ let tup = (500, 6.4, 1);
+
+ let (x, y, z) = tup;
+
+ println!("The value of y is: {y}");
+}
+
This program first creates a tuple and binds it to the variable tup. It then
+uses a pattern with let to take tup and turn it into three separate
+variables, x, y, and z. This is called destructuring because it breaks
+the single tuple into three parts. Finally, the program prints the value of
+y, which is 6.4.
+
We can also access a tuple element directly by using a period (.) followed by
+the index of the value we want to access. For example:
+
Filename: src/main.rs
+
fn main() {
+ let x: (i32, f64, u8) = (500, 6.4, 1);
+
+ let five_hundred = x.0;
+
+ let six_point_four = x.1;
+
+ let one = x.2;
+}
+
This program creates the tuple x and then accesses each element of the tuple
+using their respective indices. As with most programming languages, the first
+index in a tuple is 0.
+
The tuple without any values has a special name, unit. This value and its
+corresponding type are both written () and represent an empty value or an
+empty return type. Expressions implicitly return the unit value if they don’t
+return any other value.
Another way to have a collection of multiple values is with an array. Unlike
+a tuple, every element of an array must have the same type. Unlike arrays in
+some other languages, arrays in Rust have a fixed length.
+
We write the values in an array as a comma-separated list inside square
+brackets:
+
Filename: src/main.rs
+
fn main() {
+ let a = [1, 2, 3, 4, 5];
+}
+
Arrays are useful when you want your data allocated on the stack rather than
+the heap (we will discuss the stack and the heap more in Chapter
+4) or when you want to ensure you always have a
+fixed number of elements. An array isn’t as flexible as the vector type,
+though. A vector is a similar collection type provided by the standard
+library that is allowed to grow or shrink in size. If you’re unsure whether
+to use an array or a vector, chances are you should use a vector. Chapter
+8 discusses vectors in more detail.
+
However, arrays are more useful when you know the number of elements will not
+need to change. For example, if you were using the names of the month in a
+program, you would probably use an array rather than a vector because you know
+it will always contain 12 elements:
Here, i32 is the type of each element. After the semicolon, the number 5
+indicates the array contains five elements.
+
You can also initialize an array to contain the same value for each element by
+specifying the initial value, followed by a semicolon, and then the length of
+the array in square brackets, as shown here:
+
#![allow(unused)]
+fn main() {
+let a = [3; 5];
+}
+
The array named a will contain 5 elements that will all be set to the value
+3 initially. This is the same as writing let a = [3, 3, 3, 3, 3]; but in a
+more concise way.
An array is a single chunk of memory of a known, fixed size that can be
+allocated on the stack. You can access elements of an array using indexing,
+like this:
+
Filename: src/main.rs
+
fn main() {
+ let a = [1, 2, 3, 4, 5];
+
+ let first = a[0];
+ let second = a[1];
+}
+
In this example, the variable named first will get the value 1 because that
+is the value at index [0] in the array. The variable named second will get
+the value 2 from index [1] in the array.
Let’s see what happens if you try to access an element of an array that is past
+the end of the array. Say you run this code, similar to the guessing game in
+Chapter 2, to get an array index from the user:
+
Filename: src/main.rs
+
use std::io;
+
+fn main() {
+ let a = [1, 2, 3, 4, 5];
+
+ println!("Please enter an array index.");
+
+ let mut index = String::new();
+
+ io::stdin()
+ .read_line(&mut index)
+ .expect("Failed to read line");
+
+ let index: usize = index
+ .trim()
+ .parse()
+ .expect("Index entered was not a number");
+
+ let element = a[index];
+
+ println!("The value of the element at index {index} is: {element}");
+}
+
This code compiles successfully. If you run this code using cargo run and
+enter 0, 1, 2, 3, or 4, the program will print out the corresponding
+value at that index in the array. If you instead enter a number past the end of
+the array, such as 10, you’ll see output like this:
+
+
thread 'main' panicked at src/main.rs:19:19:
+index out of bounds: the len is 5 but the index is 10
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
The program resulted in a runtime error at the point of using an invalid
+value in the indexing operation. The program exited with an error message and
+didn’t execute the final println! statement. When you attempt to access an
+element using indexing, Rust will check that the index you’ve specified is less
+than the array length. If the index is greater than or equal to the length,
+Rust will panic. This check has to happen at runtime, especially in this case,
+because the compiler can’t possibly know what value a user will enter when they
+run the code later.
+
This is an example of Rust’s memory safety principles in action. In many
+low-level languages, this kind of check is not done, and when you provide an
+incorrect index, invalid memory can be accessed. Rust protects you against this
+kind of error by immediately exiting instead of allowing the memory access and
+continuing. Chapter 9 discusses more of Rust’s error handling and how you can
+write readable, safe code that neither panics nor allows invalid memory access.
Functions are prevalent in Rust code. You’ve already seen one of the most
+important functions in the language: the main function, which is the entry
+point of many programs. You’ve also seen the fn keyword, which allows you to
+declare new functions.
+
Rust code uses snake case as the conventional style for function and variable
+names, in which all letters are lowercase and underscores separate words.
+Here’s a program that contains an example function definition:
We define a function in Rust by entering fn followed by a function name and a
+set of parentheses. The curly brackets tell the compiler where the function
+body begins and ends.
+
We can call any function we’ve defined by entering its name followed by a set
+of parentheses. Because another_function is defined in the program, it can be
+called from inside the main function. Note that we defined another_function
+after the main function in the source code; we could have defined it before
+as well. Rust doesn’t care where you define your functions, only that they’re
+defined somewhere in a scope that can be seen by the caller.
+
Let’s start a new binary project named functions to explore functions
+further. Place the another_function example in src/main.rs and run it. You
+should see the following output:
The lines execute in the order in which they appear in the main function.
+First the “Hello, world!” message prints, and then another_function is called
+and its message is printed.
We can define functions to have parameters, which are special variables that
+are part of a function’s signature. When a function has parameters, you can
+provide it with concrete values for those parameters. Technically, the concrete
+values are called arguments, but in casual conversation, people tend to use
+the words parameter and argument interchangeably for either the variables
+in a function’s definition or the concrete values passed in when you call a
+function.
+
In this version of another_function we add a parameter:
+
Filename: src/main.rs
+
fn main() {
+ another_function(5);
+}
+
+fn another_function(x: i32) {
+ println!("The value of x is: {x}");
+}
+
Try running this program; you should get the following output:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.21s
+ Running `target/debug/functions`
+The value of x is: 5
+
+
The declaration of another_function has one parameter named x. The type of
+x is specified as i32. When we pass 5 in to another_function, the
+println! macro puts 5 where the pair of curly brackets containing x was
+in the format string.
+
In function signatures, you must declare the type of each parameter. This is
+a deliberate decision in Rust’s design: requiring type annotations in function
+definitions means the compiler almost never needs you to use them elsewhere in
+the code to figure out what type you mean. The compiler is also able to give
+more helpful error messages if it knows what types the function expects.
+
When defining multiple parameters, separate the parameter declarations with
+commas, like this:
This example creates a function named print_labeled_measurement with two
+parameters. The first parameter is named value and is an i32. The second is
+named unit_label and is type char. The function then prints text containing
+both the value and the unit_label.
+
Let’s try running this code. Replace the program currently in your functions
+project’s src/main.rs file with the preceding example and run it using cargo run:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/functions`
+The measurement is: 5h
+
+
Because we called the function with 5 as the value for value and 'h' as
+the value for unit_label, the program output contains those values.
Function bodies are made up of a series of statements optionally ending in an
+expression. So far, the functions we’ve covered haven’t included an ending
+expression, but you have seen an expression as part of a statement. Because
+Rust is an expression-based language, this is an important distinction to
+understand. Other languages don’t have the same distinctions, so let’s look at
+what statements and expressions are and how their differences affect the bodies
+of functions.
+
+
Statements are instructions that perform some action and do not return
+a value.
+
Expressions evaluate to a resultant value. Let’s look at some examples.
+
+
We’ve actually already used statements and expressions. Creating a variable and
+assigning a value to it with the let keyword is a statement. In Listing 3-1,
+let y = 6; is a statement.
+
+Filename: src/main.rs
+
fn main() {
+ let y = 6;
+}
+Listing 3-1: A main function declaration containing one statement
+
+
Function definitions are also statements; the entire preceding example is a
+statement in itself.
+
Statements do not return values. Therefore, you can’t assign a let statement
+to another variable, as the following code tries to do; you’ll get an error:
+
Filename: src/main.rs
+
fn main() {
+ let x = (let y = 6);
+}
+
When you run this program, the error you’ll get looks like this:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+error: expected expression, found `let` statement
+ --> src/main.rs:2:14
+ |
+2 | let x = (let y = 6);
+ | ^^^
+ |
+ = note: only supported directly in conditions of `if` and `while` expressions
+
+warning: unnecessary parentheses around assigned value
+ --> src/main.rs:2:13
+ |
+2 | let x = (let y = 6);
+ | ^ ^
+ |
+ = note: `#[warn(unused_parens)]` on by default
+help: remove these parentheses
+ |
+2 - let x = (let y = 6);
+2 + let x = let y = 6;
+ |
+
+warning: `functions` (bin "functions") generated 1 warning
+error: could not compile `functions` (bin "functions") due to 1 previous error; 1 warning emitted
+
+
The let y = 6 statement does not return a value, so there isn’t anything for
+x to bind to. This is different from what happens in other languages, such as
+C and Ruby, where the assignment returns the value of the assignment. In those
+languages, you can write x = y = 6 and have both x and y have the value
+6; that is not the case in Rust.
+
Expressions evaluate to a value and make up most of the rest of the code that
+you’ll write in Rust. Consider a math operation, such as 5 + 6, which is an
+expression that evaluates to the value 11. Expressions can be part of
+statements: in Listing 3-1, the 6 in the statement let y = 6; is an
+expression that evaluates to the value 6. Calling a function is an
+expression. Calling a macro is an expression. A new scope block created with
+curly brackets is an expression, for example:
+
Filename: src/main.rs
+
fn main() {
+ let y = {
+ let x = 3;
+ x + 1
+ };
+
+ println!("The value of y is: {y}");
+}
+
This expression:
+
{
+ let x = 3;
+ x + 1
+}
+
is a block that, in this case, evaluates to 4. That value gets bound to y
+as part of the let statement. Note that the x + 1 line doesn’t have a
+semicolon at the end, which is unlike most of the lines you’ve seen so far.
+Expressions do not include ending semicolons. If you add a semicolon to the end
+of an expression, you turn it into a statement, and it will then not return a
+value. Keep this in mind as you explore function return values and expressions
+next.
Functions can return values to the code that calls them. We don’t name return
+values, but we must declare their type after an arrow (->). In Rust, the
+return value of the function is synonymous with the value of the final
+expression in the block of the body of a function. You can return early from a
+function by using the return keyword and specifying a value, but most
+functions return the last expression implicitly. Here’s an example of a
+function that returns a value:
+
Filename: src/main.rs
+
fn five() -> i32 {
+ 5
+}
+
+fn main() {
+ let x = five();
+
+ println!("The value of x is: {x}");
+}
+
There are no function calls, macros, or even let statements in the five
+function—just the number 5 by itself. That’s a perfectly valid function in
+Rust. Note that the function’s return type is specified too, as -> i32. Try
+running this code; the output should look like this:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.30s
+ Running `target/debug/functions`
+The value of x is: 5
+
+
The 5 in five is the function’s return value, which is why the return type
+is i32. Let’s examine this in more detail. There are two important bits:
+first, the line let x = five(); shows that we’re using the return value of a
+function to initialize a variable. Because the function five returns a 5,
+that line is the same as the following:
+
#![allow(unused)]
+fn main() {
+let x = 5;
+}
+
Second, the five function has no parameters and defines the type of the
+return value, but the body of the function is a lonely 5 with no semicolon
+because it’s an expression whose value we want to return.
+
Let’s look at another example:
+
Filename: src/main.rs
+
fn main() {
+ let x = plus_one(5);
+
+ println!("The value of x is: {x}");
+}
+
+fn plus_one(x: i32) -> i32 {
+ x + 1
+}
+
Running this code will print The value of x is: 6. But if we place a
+semicolon at the end of the line containing x + 1, changing it from an
+expression to a statement, we’ll get an error:
+
Filename: src/main.rs
+
fn main() {
+ let x = plus_one(5);
+
+ println!("The value of x is: {x}");
+}
+
+fn plus_one(x: i32) -> i32 {
+ x + 1;
+}
+
Compiling this code produces an error, as follows:
+
$ cargo run
+ Compiling functions v0.1.0 (file:///projects/functions)
+error[E0308]: mismatched types
+ --> src/main.rs:7:24
+ |
+7 | fn plus_one(x: i32) -> i32 {
+ | -------- ^^^ expected `i32`, found `()`
+ | |
+ | implicitly returns `()` as its body has no tail or `return` expression
+8 | x + 1;
+ | - help: remove this semicolon to return this value
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `functions` (bin "functions") due to 1 previous error
+
+
The main error message, mismatched types, reveals the core issue with this
+code. The definition of the function plus_one says that it will return an
+i32, but statements don’t evaluate to a value, which is expressed by (),
+the unit type. Therefore, nothing is returned, which contradicts the function
+definition and results in an error. In this output, Rust provides a message to
+possibly help rectify this issue: it suggests removing the semicolon, which
+would fix the error.
All programmers strive to make their code easy to understand, but sometimes
+extra explanation is warranted. In these cases, programmers leave comments in
+their source code that the compiler will ignore but people reading the source
+code may find useful.
+
Here’s a simple comment:
+
#![allow(unused)]
+fn main() {
+// hello, world
+}
+
In Rust, the idiomatic comment style starts a comment with two slashes, and the
+comment continues until the end of the line. For comments that extend beyond a
+single line, you’ll need to include // on each line, like this:
+
#![allow(unused)]
+fn main() {
+// So we’re doing something complicated here, long enough that we need
+// multiple lines of comments to do it! Whew! Hopefully, this comment will
+// explain what’s going on.
+}
+
Comments can also be placed at the end of lines containing code:
The ability to run some code depending on whether a condition is true and to
+run some code repeatedly while a condition is true are basic building blocks
+in most programming languages. The most common constructs that let you control
+the flow of execution of Rust code are if expressions and loops.
An if expression allows you to branch your code depending on conditions. You
+provide a condition and then state, “If this condition is met, run this block
+of code. If the condition is not met, do not run this block of code.”
+
Create a new project called branches in your projects directory to explore
+the if expression. In the src/main.rs file, input the following:
+
Filename: src/main.rs
+
fn main() {
+ let number = 3;
+
+ if number < 5 {
+ println!("condition was true");
+ } else {
+ println!("condition was false");
+ }
+}
+
All if expressions start with the keyword if, followed by a condition. In
+this case, the condition checks whether or not the variable number has a
+value less than 5. We place the block of code to execute if the condition is
+true immediately after the condition inside curly brackets. Blocks of code
+associated with the conditions in if expressions are sometimes called arms,
+just like the arms in match expressions that we discussed in the “Comparing
+the Guess to the Secret Number” section of Chapter 2.
+
Optionally, we can also include an else expression, which we chose to do
+here, to give the program an alternative block of code to execute should the
+condition evaluate to false. If you don’t provide an else expression and
+the condition is false, the program will just skip the if block and move on
+to the next bit of code.
+
Try running this code; you should see the following output:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/branches`
+condition was true
+
+
Let’s try changing the value of number to a value that makes the condition
+false to see what happens:
+
fn main() {
+ let number = 7;
+
+ if number < 5 {
+ println!("condition was true");
+ } else {
+ println!("condition was false");
+ }
+}
+
Run the program again, and look at the output:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/branches`
+condition was false
+
+
It’s also worth noting that the condition in this code must be a bool. If
+the condition isn’t a bool, we’ll get an error. For example, try running the
+following code:
+
Filename: src/main.rs
+
fn main() {
+ let number = 3;
+
+ if number {
+ println!("number was three");
+ }
+}
+
The if condition evaluates to a value of 3 this time, and Rust throws an
+error:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+error[E0308]: mismatched types
+ --> src/main.rs:4:8
+ |
+4 | if number {
+ | ^^^^^^ expected `bool`, found integer
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `branches` (bin "branches") due to 1 previous error
+
+
The error indicates that Rust expected a bool but got an integer. Unlike
+languages such as Ruby and JavaScript, Rust will not automatically try to
+convert non-Boolean types to a Boolean. You must be explicit and always provide
+if with a Boolean as its condition. If we want the if code block to run
+only when a number is not equal to 0, for example, we can change the if
+expression to the following:
+
Filename: src/main.rs
+
fn main() {
+ let number = 3;
+
+ if number != 0 {
+ println!("number was something other than zero");
+ }
+}
+
Running this code will print number was something other than zero.
You can use multiple conditions by combining if and else in an else if
+expression. For example:
+
Filename: src/main.rs
+
fn main() {
+ let number = 6;
+
+ if number % 4 == 0 {
+ println!("number is divisible by 4");
+ } else if number % 3 == 0 {
+ println!("number is divisible by 3");
+ } else if number % 2 == 0 {
+ println!("number is divisible by 2");
+ } else {
+ println!("number is not divisible by 4, 3, or 2");
+ }
+}
+
This program has four possible paths it can take. After running it, you should
+see the following output:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
+ Running `target/debug/branches`
+number is divisible by 3
+
+
When this program executes, it checks each if expression in turn and executes
+the first body for which the condition evaluates to true. Note that even
+though 6 is divisible by 2, we don’t see the output number is divisible by 2,
+nor do we see the number is not divisible by 4, 3, or 2 text from the else
+block. That’s because Rust only executes the block for the first true
+condition, and once it finds one, it doesn’t even check the rest.
+
Using too many else if expressions can clutter your code, so if you have more
+than one, you might want to refactor your code. Chapter 6 describes a powerful
+Rust branching construct called match for these cases.
Because if is an expression, we can use it on the right side of a let
+statement to assign the outcome to a variable, as in Listing 3-2.
+
+Filename: src/main.rs
+
fn main() {
+ let condition = true;
+ let number = if condition { 5 } else { 6 };
+
+ println!("The value of number is: {number}");
+}
+Listing 3-2: Assigning the result of an if expression to a variable
+
+
The number variable will be bound to a value based on the outcome of the if
+expression. Run this code to see what happens:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.30s
+ Running `target/debug/branches`
+The value of number is: 5
+
+
Remember that blocks of code evaluate to the last expression in them, and
+numbers by themselves are also expressions. In this case, the value of the
+whole if expression depends on which block of code executes. This means the
+values that have the potential to be results from each arm of the if must be
+the same type; in Listing 3-2, the results of both the if arm and the else
+arm were i32 integers. If the types are mismatched, as in the following
+example, we’ll get an error:
+
Filename: src/main.rs
+
fn main() {
+ let condition = true;
+
+ let number = if condition { 5 } else { "six" };
+
+ println!("The value of number is: {number}");
+}
+
When we try to compile this code, we’ll get an error. The if and else arms
+have value types that are incompatible, and Rust indicates exactly where to
+find the problem in the program:
+
$ cargo run
+ Compiling branches v0.1.0 (file:///projects/branches)
+error[E0308]: `if` and `else` have incompatible types
+ --> src/main.rs:4:44
+ |
+4 | let number = if condition { 5 } else { "six" };
+ | - ^^^^^ expected integer, found `&str`
+ | |
+ | expected because of this
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `branches` (bin "branches") due to 1 previous error
+
+
The expression in the if block evaluates to an integer, and the expression in
+the else block evaluates to a string. This won’t work because variables must
+have a single type, and Rust needs to know at compile time what type the
+number variable is, definitively. Knowing the type of number lets the
+compiler verify the type is valid everywhere we use number. Rust wouldn’t be
+able to do that if the type of number was only determined at runtime; the
+compiler would be more complex and would make fewer guarantees about the code
+if it had to keep track of multiple hypothetical types for any variable.
It’s often useful to execute a block of code more than once. For this task,
+Rust provides several loops, which will run through the code inside the loop
+body to the end and then start immediately back at the beginning. To experiment
+with loops, let’s make a new project called loops.
+
Rust has three kinds of loops: loop, while, and for. Let’s try each one.
The loop keyword tells Rust to execute a block of code over and over again
+forever or until you explicitly tell it to stop.
+
As an example, change the src/main.rs file in your loops directory to look
+like this:
+
Filename: src/main.rs
+
fn main() {
+ loop {
+ println!("again!");
+ }
+}
+
When we run this program, we’ll see again! printed over and over continuously
+until we stop the program manually. Most terminals support the keyboard shortcut
+ctrl-c to interrupt a program that is stuck in a continual
+loop. Give it a try:
+
+
$ cargo run
+ Compiling loops v0.1.0 (file:///projects/loops)
+ Finished dev [unoptimized + debuginfo] target(s) in 0.29s
+ Running `target/debug/loops`
+again!
+again!
+again!
+again!
+^Cagain!
+
+
The symbol ^C represents where you pressed ctrl-c. You
+may or may not see the word again! printed after the ^C, depending on where
+the code was in the loop when it received the interrupt signal.
+
Fortunately, Rust also provides a way to break out of a loop using code. You
+can place the break keyword within the loop to tell the program when to stop
+executing the loop. Recall that we did this in the guessing game in the
+“Quitting After a Correct Guess” section of Chapter 2 to exit the program when the user won the game by
+guessing the correct number.
+
We also used continue in the guessing game, which in a loop tells the program
+to skip over any remaining code in this iteration of the loop and go to the
+next iteration.
One of the uses of a loop is to retry an operation you know might fail, such
+as checking whether a thread has completed its job. You might also need to pass
+the result of that operation out of the loop to the rest of your code. To do
+this, you can add the value you want returned after the break expression you
+use to stop the loop; that value will be returned out of the loop so you can
+use it, as shown here:
+
fn main() {
+ let mut counter = 0;
+
+ let result = loop {
+ counter += 1;
+
+ if counter == 10 {
+ break counter * 2;
+ }
+ };
+
+ println!("The result is {result}");
+}
+
Before the loop, we declare a variable named counter and initialize it to
+0. Then we declare a variable named result to hold the value returned from
+the loop. On every iteration of the loop, we add 1 to the counter variable,
+and then check whether the counter is equal to 10. When it is, we use the
+break keyword with the value counter * 2. After the loop, we use a
+semicolon to end the statement that assigns the value to result. Finally, we
+print the value in result, which in this case is 20.
+
You can also return from inside a loop. While break only exits the current
+loop, return always exits the current function.
If you have loops within loops, break and continue apply to the innermost
+loop at that point. You can optionally specify a loop label on a loop that
+you can then use with break or continue to specify that those keywords
+apply to the labeled loop instead of the innermost loop. Loop labels must begin
+with a single quote. Here’s an example with two nested loops:
The outer loop has the label 'counting_up, and it will count up from 0 to 2.
+The inner loop without a label counts down from 10 to 9. The first break that
+doesn’t specify a label will exit the inner loop only. The break 'counting_up; statement will exit the outer loop. This code prints:
A program will often need to evaluate a condition within a loop. While the
+condition is true, the loop runs. When the condition ceases to be true, the
+program calls break, stopping the loop. It’s possible to implement behavior
+like this using a combination of loop, if, else, and break; you could
+try that now in a program, if you’d like. However, this pattern is so common
+that Rust has a built-in language construct for it, called a while loop. In
+Listing 3-3, we use while to loop the program three times, counting down each
+time, and then, after the loop, print a message and exit.
+
+Filename: src/main.rs
+
fn main() {
+ let mut number = 3;
+
+ while number != 0 {
+ println!("{number}!");
+
+ number -= 1;
+ }
+
+ println!("LIFTOFF!!!");
+}
+Listing 3-3: Using a while loop to run code while a condition holds true
+
+
This construct eliminates a lot of nesting that would be necessary if you used
+loop, if, else, and break, and it’s clearer. While a condition
+evaluates to true, the code runs; otherwise, it exits the loop.
You can also use the while construct to loop over the elements of a
+collection, such as an array. For example, the loop in Listing 3-4 prints each
+element in the array a.
+
+Filename: src/main.rs
+
fn main() {
+ let a = [10, 20, 30, 40, 50];
+ let mut index = 0;
+
+ while index < 5 {
+ println!("the value is: {}", a[index]);
+
+ index += 1;
+ }
+}
+Listing 3-4: Looping through each element of a collection using a while loop
+
+
Here, the code counts up through the elements in the array. It starts at index
+0, and then loops until it reaches the final index in the array (that is,
+when index < 5 is no longer true). Running this code will print every
+element in the array:
+
$ cargo run
+ Compiling loops v0.1.0 (file:///projects/loops)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.32s
+ Running `target/debug/loops`
+the value is: 10
+the value is: 20
+the value is: 30
+the value is: 40
+the value is: 50
+
+
All five array values appear in the terminal, as expected. Even though index
+will reach a value of 5 at some point, the loop stops executing before trying
+to fetch a sixth value from the array.
+
However, this approach is error prone; we could cause the program to panic if
+the index value or test condition is incorrect. For example, if you changed the
+definition of the a array to have four elements but forgot to update the
+condition to while index < 4, the code would panic. It’s also slow, because
+the compiler adds runtime code to perform the conditional check of whether the
+index is within the bounds of the array on every iteration through the loop.
+
As a more concise alternative, you can use a for loop and execute some code
+for each item in a collection. A for loop looks like the code in Listing 3-5.
+
+Filename: src/main.rs
+
fn main() {
+ let a = [10, 20, 30, 40, 50];
+
+ for element in a {
+ println!("the value is: {element}");
+ }
+}
+Listing 3-5: Looping through each element of a collection using a for loop
+
+
When we run this code, we’ll see the same output as in Listing 3-4. More
+importantly, we’ve now increased the safety of the code and eliminated the
+chance of bugs that might result from going beyond the end of the array or not
+going far enough and missing some items.
+
Using the for loop, you wouldn’t need to remember to change any other code if
+you changed the number of values in the array, as you would with the method
+used in Listing 3-4.
+
The safety and conciseness of for loops make them the most commonly used loop
+construct in Rust. Even in situations in which you want to run some code a
+certain number of times, as in the countdown example that used a while loop
+in Listing 3-3, most Rustaceans would use a for loop. The way to do that
+would be to use a Range, provided by the standard library, which generates
+all numbers in sequence starting from one number and ending before another
+number.
+
Here’s what the countdown would look like using a for loop and another method
+we’ve not yet talked about, rev, to reverse the range:
+
Filename: src/main.rs
+
fn main() {
+ for number in (1..4).rev() {
+ println!("{number}!");
+ }
+ println!("LIFTOFF!!!");
+}
You made it! This was a sizable chapter: you learned about variables, scalar
+and compound data types, functions, comments, if expressions, and loops! To
+practice with the concepts discussed in this chapter, try building programs to
+do the following:
+
+
Convert temperatures between Fahrenheit and Celsius.
+
Generate the nth Fibonacci number.
+
Print the lyrics to the Christmas carol “The Twelve Days of Christmas,”
+taking advantage of the repetition in the song.
+
+
When you’re ready to move on, we’ll talk about a concept in Rust that doesn’t
+commonly exist in other programming languages: ownership.
Ownership is Rust’s most unique feature and has deep implications for the rest
+of the language. It enables Rust to make memory safety guarantees without
+needing a garbage collector, so it’s important to understand how ownership
+works. In this chapter, we’ll talk about ownership as well as several related
+features: borrowing, slices, and how Rust lays data out in memory.
Ownership is a set of rules that govern how a Rust program manages memory.
+All programs have to manage the way they use a computer’s memory while running.
+Some languages have garbage collection that regularly looks for no-longer-used
+memory as the program runs; in other languages, the programmer must explicitly
+allocate and free the memory. Rust uses a third approach: memory is managed
+through a system of ownership with a set of rules that the compiler checks. If
+any of the rules are violated, the program won’t compile. None of the features
+of ownership will slow down your program while it’s running.
+
Because ownership is a new concept for many programmers, it does take some time
+to get used to. The good news is that the more experienced you become with Rust
+and the rules of the ownership system, the easier you’ll find it to naturally
+develop code that is safe and efficient. Keep at it!
+
When you understand ownership, you’ll have a solid foundation for understanding
+the features that make Rust unique. In this chapter, you’ll learn ownership by
+working through some examples that focus on a very common data structure:
+strings.
Many programming languages don’t require you to think about the stack and the
+heap very often. But in a systems programming language like Rust, whether a
+value is on the stack or the heap affects how the language behaves and why
+you have to make certain decisions. Parts of ownership will be described in
+relation to the stack and the heap later in this chapter, so here is a brief
+explanation in preparation.
+
Both the stack and the heap are parts of memory available to your code to use
+at runtime, but they are structured in different ways. The stack stores
+values in the order it gets them and removes the values in the opposite
+order. This is referred to as last in, first out. Think of a stack of
+plates: when you add more plates, you put them on top of the pile, and when
+you need a plate, you take one off the top. Adding or removing plates from
+the middle or bottom wouldn’t work as well! Adding data is called pushing
+onto the stack, and removing data is called popping off the stack. All
+data stored on the stack must have a known, fixed size. Data with an unknown
+size at compile time or a size that might change must be stored on the heap
+instead.
+
The heap is less organized: when you put data on the heap, you request a
+certain amount of space. The memory allocator finds an empty spot in the heap
+that is big enough, marks it as being in use, and returns a pointer, which
+is the address of that location. This process is called allocating on the
+heap and is sometimes abbreviated as just allocating (pushing values onto
+the stack is not considered allocating). Because the pointer to the heap is a
+known, fixed size, you can store the pointer on the stack, but when you want
+the actual data, you must follow the pointer. Think of being seated at a
+restaurant. When you enter, you state the number of people in your group, and
+the host finds an empty table that fits everyone and leads you there. If
+someone in your group comes late, they can ask where you’ve been seated to
+find you.
+
Pushing to the stack is faster than allocating on the heap because the
+allocator never has to search for a place to store new data; that location is
+always at the top of the stack. Comparatively, allocating space on the heap
+requires more work because the allocator must first find a big enough space
+to hold the data and then perform bookkeeping to prepare for the next
+allocation.
+
Accessing data in the heap is slower than accessing data on the stack because
+you have to follow a pointer to get there. Contemporary processors are faster
+if they jump around less in memory. Continuing the analogy, consider a server
+at a restaurant taking orders from many tables. It’s most efficient to get
+all the orders at one table before moving on to the next table. Taking an
+order from table A, then an order from table B, then one from A again, and
+then one from B again would be a much slower process. By the same token, a
+processor can do its job better if it works on data that’s close to other
+data (as it is on the stack) rather than farther away (as it can be on the
+heap).
+
When your code calls a function, the values passed into the function
+(including, potentially, pointers to data on the heap) and the function’s
+local variables get pushed onto the stack. When the function is over, those
+values get popped off the stack.
+
Keeping track of what parts of code are using what data on the heap,
+minimizing the amount of duplicate data on the heap, and cleaning up unused
+data on the heap so you don’t run out of space are all problems that ownership
+addresses. Once you understand ownership, you won’t need to think about the
+stack and the heap very often, but knowing that the main purpose of ownership
+is to manage heap data can help explain why it works the way it does.
Now that we’re past basic Rust syntax, we won’t include all the fn main() {
+code in examples, so if you’re following along, make sure to put the following
+examples inside a main function manually. As a result, our examples will be a
+bit more concise, letting us focus on the actual details rather than
+boilerplate code.
+
As a first example of ownership, we’ll look at the scope of some variables. A
+scope is the range within a program for which an item is valid. Take the
+following variable:
+
#![allow(unused)]
+fn main() {
+let s = "hello";
+}
+
The variable s refers to a string literal, where the value of the string is
+hardcoded into the text of our program. The variable is valid from the point at
+which it’s declared until the end of the current scope. Listing 4-1 shows a
+program with comments annotating where the variable s would be valid.
+
fn main() {
+ { // s is not valid here, it’s not yet declared
+ let s = "hello"; // s is valid from this point forward
+
+ // do stuff with s
+ } // this scope is now over, and s is no longer valid
+}
+
Listing 4-1: A variable and the scope in which it is
+valid
+
In other words, there are two important points in time here:
+
+
When s comes into scope, it is valid.
+
It remains valid until it goes out of scope.
+
+
At this point, the relationship between scopes and when variables are valid is
+similar to that in other programming languages. Now we’ll build on top of this
+understanding by introducing the String type.
To illustrate the rules of ownership, we need a data type that is more complex
+than those we covered in the “Data Types” section
+of Chapter 3. The types covered previously are of a known size, can be stored
+on the stack and popped off the stack when their scope is over, and can be
+quickly and trivially copied to make a new, independent instance if another
+part of code needs to use the same value in a different scope. But we want to
+look at data that is stored on the heap and explore how Rust knows when to
+clean up that data, and the String type is a great example.
+
We’ll concentrate on the parts of String that relate to ownership. These
+aspects also apply to other complex data types, whether they are provided by
+the standard library or created by you. We’ll discuss String in more depth in
+Chapter 8.
+
We’ve already seen string literals, where a string value is hardcoded into our
+program. String literals are convenient, but they aren’t suitable for every
+situation in which we may want to use text. One reason is that they’re
+immutable. Another is that not every string value can be known when we write
+our code: for example, what if we want to take user input and store it? For
+these situations, Rust has a second string type, String. This type manages
+data allocated on the heap and as such is able to store an amount of text that
+is unknown to us at compile time. You can create a String from a string
+literal using the from function, like so:
+
#![allow(unused)]
+fn main() {
+let s = String::from("hello");
+}
+
The double colon :: operator allows us to namespace this particular from
+function under the String type rather than using some sort of name like
+string_from. We’ll discuss this syntax more in the “Method
+Syntax” section of Chapter 5, and when we talk
+about namespacing with modules in “Paths for Referring to an Item in the
+Module Tree” in Chapter 7.
+
This kind of string can be mutated:
+
fn main() {
+ let mut s = String::from("hello");
+
+ s.push_str(", world!"); // push_str() appends a literal to a String
+
+ println!("{s}"); // This will print `hello, world!`
+}
+
So, what’s the difference here? Why can String be mutated but literals
+cannot? The difference is in how these two types deal with memory.
In the case of a string literal, we know the contents at compile time, so the
+text is hardcoded directly into the final executable. This is why string
+literals are fast and efficient. But these properties only come from the string
+literal’s immutability. Unfortunately, we can’t put a blob of memory into the
+binary for each piece of text whose size is unknown at compile time and whose
+size might change while running the program.
+
With the String type, in order to support a mutable, growable piece of text,
+we need to allocate an amount of memory on the heap, unknown at compile time,
+to hold the contents. This means:
+
+
The memory must be requested from the memory allocator at runtime.
+
We need a way of returning this memory to the allocator when we’re done with
+our String.
+
+
That first part is done by us: when we call String::from, its implementation
+requests the memory it needs. This is pretty much universal in programming
+languages.
+
However, the second part is different. In languages with a garbage collector
+(GC), the GC keeps track of and cleans up memory that isn’t being used
+anymore, and we don’t need to think about it. In most languages without a GC,
+it’s our responsibility to identify when memory is no longer being used and to
+call code to explicitly free it, just as we did to request it. Doing this
+correctly has historically been a difficult programming problem. If we forget,
+we’ll waste memory. If we do it too early, we’ll have an invalid variable. If
+we do it twice, that’s a bug too. We need to pair exactly one allocate with
+exactly one free.
+
Rust takes a different path: the memory is automatically returned once the
+variable that owns it goes out of scope. Here’s a version of our scope example
+from Listing 4-1 using a String instead of a string literal:
+
fn main() {
+ {
+ let s = String::from("hello"); // s is valid from this point forward
+
+ // do stuff with s
+ } // this scope is now over, and s is no
+ // longer valid
+}
+
There is a natural point at which we can return the memory our String needs
+to the allocator: when s goes out of scope. When a variable goes out of
+scope, Rust calls a special function for us. This function is called
+drop, and it’s where the author of String can put
+the code to return the memory. Rust calls drop automatically at the closing
+curly bracket.
+
+
Note: In C++, this pattern of deallocating resources at the end of an item’s
+lifetime is sometimes called Resource Acquisition Is Initialization (RAII).
+The drop function in Rust will be familiar to you if you’ve used RAII
+patterns.
+
+
This pattern has a profound impact on the way Rust code is written. It may seem
+simple right now, but the behavior of code can be unexpected in more
+complicated situations when we want to have multiple variables use the data
+we’ve allocated on the heap. Let’s explore some of those situations now.
Multiple variables can interact with the same data in different ways in Rust.
+Let’s look at an example using an integer in Listing 4-2.
+
fn main() {
+ let x = 5;
+ let y = x;
+}
+
Listing 4-2: Assigning the integer value of variable x
+to y
+
We can probably guess what this is doing: “bind the value 5 to x; then make
+a copy of the value in x and bind it to y.” We now have two variables, x
+and y, and both equal 5. This is indeed what is happening, because integers
+are simple values with a known, fixed size, and these two 5 values are pushed
+onto the stack.
+
Now let’s look at the String version:
+
fn main() {
+ let s1 = String::from("hello");
+ let s2 = s1;
+}
+
This looks very similar, so we might assume that the way it works would be the
+same: that is, the second line would make a copy of the value in s1 and bind
+it to s2. But this isn’t quite what happens.
+
Take a look at Figure 4-1 to see what is happening to String under the
+covers. A String is made up of three parts, shown on the left: a pointer to
+the memory that holds the contents of the string, a length, and a capacity.
+This group of data is stored on the stack. On the right is the memory on the
+heap that holds the contents.
+
+
Figure 4-1: Representation in memory of a String
+holding the value "hello" bound to s1
+
The length is how much memory, in bytes, the contents of the String are
+currently using. The capacity is the total amount of memory, in bytes, that the
+String has received from the allocator. The difference between length and
+capacity matters, but not in this context, so for now, it’s fine to ignore the
+capacity.
+
When we assign s1 to s2, the String data is copied, meaning we copy the
+pointer, the length, and the capacity that are on the stack. We do not copy the
+data on the heap that the pointer refers to. In other words, the data
+representation in memory looks like Figure 4-2.
+
+
Figure 4-2: Representation in memory of the variable s2
+that has a copy of the pointer, length, and capacity of s1
+
The representation does not look like Figure 4-3, which is what memory would
+look like if Rust instead copied the heap data as well. If Rust did this, the
+operation s2 = s1 could be very expensive in terms of runtime performance if
+the data on the heap were large.
+
+
Figure 4-3: Another possibility for what s2 = s1 might
+do if Rust copied the heap data as well
+
Earlier, we said that when a variable goes out of scope, Rust automatically
+calls the drop function and cleans up the heap memory for that variable. But
+Figure 4-2 shows both data pointers pointing to the same location. This is a
+problem: when s2 and s1 go out of scope, they will both try to free the
+same memory. This is known as a double free error and is one of the memory
+safety bugs we mentioned previously. Freeing memory twice can lead to memory
+corruption, which can potentially lead to security vulnerabilities.
+
To ensure memory safety, after the line let s2 = s1;, Rust considers s1 as
+no longer valid. Therefore, Rust doesn’t need to free anything when s1 goes
+out of scope. Check out what happens when you try to use s1 after s2 is
+created; it won’t work:
+
fn main() {
+ let s1 = String::from("hello");
+ let s2 = s1;
+
+ println!("{s1}, world!");
+}
+
You’ll get an error like this because Rust prevents you from using the
+invalidated reference:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0382]: borrow of moved value: `s1`
+ --> src/main.rs:5:15
+ |
+2 | let s1 = String::from("hello");
+ | -- move occurs because `s1` has type `String`, which does not implement the `Copy` trait
+3 | let s2 = s1;
+ | -- value moved here
+4 |
+5 | println!("{s1}, world!");
+ | ^^^^ value borrowed here after move
+ |
+ = note: this error originates in the macro `$crate::format_args_nl` which comes from the expansion of the macro `println` (in Nightly builds, run with -Z macro-backtrace for more info)
+help: consider cloning the value if the performance cost is acceptable
+ |
+3 | let s2 = s1.clone();
+ | ++++++++
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
If you’ve heard the terms shallow copy and deep copy while working with
+other languages, the concept of copying the pointer, length, and capacity
+without copying the data probably sounds like making a shallow copy. But
+because Rust also invalidates the first variable, instead of being called a
+shallow copy, it’s known as a move. In this example, we would say that s1
+was moved into s2. So, what actually happens is shown in Figure 4-4.
+
+
Figure 4-4: Representation in memory after s1 has been
+invalidated
+
That solves our problem! With only s2 valid, when it goes out of scope it
+alone will free the memory, and we’re done.
+
In addition, there’s a design choice that’s implied by this: Rust will never
+automatically create “deep” copies of your data. Therefore, any automatic
+copying can be assumed to be inexpensive in terms of runtime performance.
If we do want to deeply copy the heap data of the String, not just the
+stack data, we can use a common method called clone. We’ll discuss method
+syntax in Chapter 5, but because methods are a common feature in many
+programming languages, you’ve probably seen them before.
This works just fine and explicitly produces the behavior shown in Figure 4-3,
+where the heap data does get copied.
+
When you see a call to clone, you know that some arbitrary code is being
+executed and that code may be expensive. It’s a visual indicator that something
+different is going on.
There’s another wrinkle we haven’t talked about yet. This code using
+integers—part of which was shown in Listing 4-2—works and is valid:
+
fn main() {
+ let x = 5;
+ let y = x;
+
+ println!("x = {x}, y = {y}");
+}
+
But this code seems to contradict what we just learned: we don’t have a call to
+clone, but x is still valid and wasn’t moved into y.
+
The reason is that types such as integers that have a known size at compile
+time are stored entirely on the stack, so copies of the actual values are quick
+to make. That means there’s no reason we would want to prevent x from being
+valid after we create the variable y. In other words, there’s no difference
+between deep and shallow copying here, so calling clone wouldn’t do anything
+different from the usual shallow copying, and we can leave it out.
+
Rust has a special annotation called the Copy trait that we can place on
+types that are stored on the stack, as integers are (we’ll talk more about
+traits in Chapter 10). If a type implements the Copy
+trait, variables that use it do not move, but rather are trivially copied,
+making them still valid after assignment to another variable.
+
Rust won’t let us annotate a type with Copy if the type, or any of its parts,
+has implemented the Drop trait. If the type needs something special to happen
+when the value goes out of scope and we add the Copy annotation to that type,
+we’ll get a compile-time error. To learn about how to add the Copy annotation
+to your type to implement the trait, see “Derivable
+Traits” in Appendix C.
+
So, what types implement the Copy trait? You can check the documentation for
+the given type to be sure, but as a general rule, any group of simple scalar
+values can implement Copy, and nothing that requires allocation or is some
+form of resource can implement Copy. Here are some of the types that
+implement Copy:
+
+
All the integer types, such as u32.
+
The Boolean type, bool, with values true and false.
+
All the floating-point types, such as f64.
+
The character type, char.
+
Tuples, if they only contain types that also implement Copy. For example,
+(i32, i32) implements Copy, but (i32, String) does not.
The mechanics of passing a value to a function are similar to those when
+assigning a value to a variable. Passing a variable to a function will move or
+copy, just as assignment does. Listing 4-3 has an example with some annotations
+showing where variables go into and out of scope.
+
Filename: src/main.rs
+
fn main() {
+ let s = String::from("hello"); // s comes into scope
+
+ takes_ownership(s); // s's value moves into the function...
+ // ... and so is no longer valid here
+
+ let x = 5; // x comes into scope
+
+ makes_copy(x); // x would move into the function,
+ // but i32 is Copy, so it's okay to still
+ // use x afterward
+
+} // Here, x goes out of scope, then s. But because s's value was moved, nothing
+ // special happens.
+
+fn takes_ownership(some_string: String) { // some_string comes into scope
+ println!("{some_string}");
+} // Here, some_string goes out of scope and `drop` is called. The backing
+ // memory is freed.
+
+fn makes_copy(some_integer: i32) { // some_integer comes into scope
+ println!("{some_integer}");
+} // Here, some_integer goes out of scope. Nothing special happens.
+
Listing 4-3: Functions with ownership and scope
+annotated
+
If we tried to use s after the call to takes_ownership, Rust would throw a
+compile-time error. These static checks protect us from mistakes. Try adding
+code to main that uses s and x to see where you can use them and where
+the ownership rules prevent you from doing so.
Returning values can also transfer ownership. Listing 4-4 shows an example of a
+function that returns some value, with similar annotations as those in Listing
+4-3.
+
Filename: src/main.rs
+
fn main() {
+ let s1 = gives_ownership(); // gives_ownership moves its return
+ // value into s1
+
+ let s2 = String::from("hello"); // s2 comes into scope
+
+ let s3 = takes_and_gives_back(s2); // s2 is moved into
+ // takes_and_gives_back, which also
+ // moves its return value into s3
+} // Here, s3 goes out of scope and is dropped. s2 was moved, so nothing
+ // happens. s1 goes out of scope and is dropped.
+
+fn gives_ownership() -> String { // gives_ownership will move its
+ // return value into the function
+ // that calls it
+
+ let some_string = String::from("yours"); // some_string comes into scope
+
+ some_string // some_string is returned and
+ // moves out to the calling
+ // function
+}
+
+// This function takes a String and returns one
+fn takes_and_gives_back(a_string: String) -> String { // a_string comes into
+ // scope
+
+ a_string // a_string is returned and moves out to the calling function
+}
+
Listing 4-4: Transferring ownership of return
+values
+
The ownership of a variable follows the same pattern every time: assigning a
+value to another variable moves it. When a variable that includes data on the
+heap goes out of scope, the value will be cleaned up by drop unless ownership
+of the data has been moved to another variable.
+
While this works, taking ownership and then returning ownership with every
+function is a bit tedious. What if we want to let a function use a value but
+not take ownership? It’s quite annoying that anything we pass in also needs to
+be passed back if we want to use it again, in addition to any data resulting
+from the body of the function that we might want to return as well.
+
Rust does let us return multiple values using a tuple, as shown in Listing 4-5.
+
Filename: src/main.rs
+
fn main() {
+ let s1 = String::from("hello");
+
+ let (s2, len) = calculate_length(s1);
+
+ println!("The length of '{s2}' is {len}.");
+}
+
+fn calculate_length(s: String) -> (String, usize) {
+ let length = s.len(); // len() returns the length of a String
+
+ (s, length)
+}
+
Listing 4-5: Returning ownership of parameters
+
But this is too much ceremony and a lot of work for a concept that should be
+common. Luckily for us, Rust has a feature for using a value without
+transferring ownership, called references.
The issue with the tuple code in Listing 4-5 is that we have to return the
+String to the calling function so we can still use the String after the
+call to calculate_length, because the String was moved into
+calculate_length. Instead, we can provide a reference to the String value.
+A reference is like a pointer in that it’s an address we can follow to access
+the data stored at that address; that data is owned by some other variable.
+Unlike a pointer, a reference is guaranteed to point to a valid value of a
+particular type for the life of that reference.
+
Here is how you would define and use a calculate_length function that has a
+reference to an object as a parameter instead of taking ownership of the value:
+
Filename: src/main.rs
+
fn main() {
+ let s1 = String::from("hello");
+
+ let len = calculate_length(&s1);
+
+ println!("The length of '{s1}' is {len}.");
+}
+
+fn calculate_length(s: &String) -> usize {
+ s.len()
+}
+
First, notice that all the tuple code in the variable declaration and the
+function return value is gone. Second, note that we pass &s1 into
+calculate_length and, in its definition, we take &String rather than
+String. These ampersands represent references, and they allow you to refer
+to some value without taking ownership of it. Figure 4-5 depicts this concept.
+
+
Figure 4-5: A diagram of &String s pointing at String s1
+
+
Note: The opposite of referencing by using & is dereferencing, which is
+accomplished with the dereference operator, *. We’ll see some uses of the
+dereference operator in Chapter 8 and discuss details of dereferencing in
+Chapter 15.
+
+
Let’s take a closer look at the function call here:
+
fn main() {
+ let s1 = String::from("hello");
+
+ let len = calculate_length(&s1);
+
+ println!("The length of '{s1}' is {len}.");
+}
+
+fn calculate_length(s: &String) -> usize {
+ s.len()
+}
+
The &s1 syntax lets us create a reference that refers to the value of s1
+but does not own it. Because it does not own it, the value it points to will
+not be dropped when the reference stops being used.
+
Likewise, the signature of the function uses & to indicate that the type of
+the parameter s is a reference. Let’s add some explanatory annotations:
+
fn main() {
+ let s1 = String::from("hello");
+
+ let len = calculate_length(&s1);
+
+ println!("The length of '{s1}' is {len}.");
+}
+
+fn calculate_length(s: &String) -> usize { // s is a reference to a String
+ s.len()
+} // Here, s goes out of scope. But because it does not have ownership of what
+ // it refers to, it is not dropped.
+
The scope in which the variable s is valid is the same as any function
+parameter’s scope, but the value pointed to by the reference is not dropped
+when s stops being used, because s doesn’t have ownership. When functions
+have references as parameters instead of the actual values, we won’t need to
+return the values in order to give back ownership, because we never had
+ownership.
+
We call the action of creating a reference borrowing. As in real life, if a
+person owns something, you can borrow it from them. When you’re done, you have
+to give it back. You don’t own it.
+
So, what happens if we try to modify something we’re borrowing? Try the code in
+Listing 4-6. Spoiler alert: it doesn’t work!
Listing 4-6: Attempting to modify a borrowed value
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0596]: cannot borrow `*some_string` as mutable, as it is behind a `&` reference
+ --> src/main.rs:8:5
+ |
+8 | some_string.push_str(", world");
+ | ^^^^^^^^^^^ `some_string` is a `&` reference, so the data it refers to cannot be borrowed as mutable
+ |
+help: consider changing this to be a mutable reference
+ |
+7 | fn change(some_string: &mut String) {
+ | +++
+
+For more information about this error, try `rustc --explain E0596`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
Just as variables are immutable by default, so are references. We’re not
+allowed to modify something we have a reference to.
First we change s to be mut. Then we create a mutable reference with &mut s where we call the change function, and update the function signature to
+accept a mutable reference with some_string: &mut String. This makes it very
+clear that the change function will mutate the value it borrows.
+
Mutable references have one big restriction: if you have a mutable reference to
+a value, you can have no other references to that value. This code that
+attempts to create two mutable references to s will fail:
+
Filename: src/main.rs
+
fn main() {
+ let mut s = String::from("hello");
+
+ let r1 = &mut s;
+ let r2 = &mut s;
+
+ println!("{}, {}", r1, r2);
+}
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0499]: cannot borrow `s` as mutable more than once at a time
+ --> src/main.rs:5:14
+ |
+4 | let r1 = &mut s;
+ | ------ first mutable borrow occurs here
+5 | let r2 = &mut s;
+ | ^^^^^^ second mutable borrow occurs here
+6 |
+7 | println!("{}, {}", r1, r2);
+ | -- first borrow later used here
+
+For more information about this error, try `rustc --explain E0499`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
This error says that this code is invalid because we cannot borrow s as
+mutable more than once at a time. The first mutable borrow is in r1 and must
+last until it’s used in the println!, but between the creation of that
+mutable reference and its usage, we tried to create another mutable reference
+in r2 that borrows the same data as r1.
+
The restriction preventing multiple mutable references to the same data at the
+same time allows for mutation but in a very controlled fashion. It’s something
+that new Rustaceans struggle with because most languages let you mutate
+whenever you’d like. The benefit of having this restriction is that Rust can
+prevent data races at compile time. A data race is similar to a race
+condition and happens when these three behaviors occur:
+
+
Two or more pointers access the same data at the same time.
+
At least one of the pointers is being used to write to the data.
+
There’s no mechanism being used to synchronize access to the data.
+
+
Data races cause undefined behavior and can be difficult to diagnose and fix
+when you’re trying to track them down at runtime; Rust prevents this problem by
+refusing to compile code with data races!
+
As always, we can use curly brackets to create a new scope, allowing for
+multiple mutable references, just not simultaneous ones:
+
fn main() {
+ let mut s = String::from("hello");
+
+ {
+ let r1 = &mut s;
+ } // r1 goes out of scope here, so we can make a new reference with no problems.
+
+ let r2 = &mut s;
+}
+
Rust enforces a similar rule for combining mutable and immutable references.
+This code results in an error:
+
fn main() {
+ let mut s = String::from("hello");
+
+ let r1 = &s; // no problem
+ let r2 = &s; // no problem
+ let r3 = &mut s; // BIG PROBLEM
+
+ println!("{}, {}, and {}", r1, r2, r3);
+}
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0502]: cannot borrow `s` as mutable because it is also borrowed as immutable
+ --> src/main.rs:6:14
+ |
+4 | let r1 = &s; // no problem
+ | -- immutable borrow occurs here
+5 | let r2 = &s; // no problem
+6 | let r3 = &mut s; // BIG PROBLEM
+ | ^^^^^^ mutable borrow occurs here
+7 |
+8 | println!("{}, {}, and {}", r1, r2, r3);
+ | -- immutable borrow later used here
+
+For more information about this error, try `rustc --explain E0502`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
Whew! We also cannot have a mutable reference while we have an immutable one
+to the same value.
+
Users of an immutable reference don’t expect the value to suddenly change out
+from under them! However, multiple immutable references are allowed because no
+one who is just reading the data has the ability to affect anyone else’s
+reading of the data.
+
Note that a reference’s scope starts from where it is introduced and continues
+through the last time that reference is used. For instance, this code will
+compile because the last usage of the immutable references, the println!,
+occurs before the mutable reference is introduced:
+
fn main() {
+ let mut s = String::from("hello");
+
+ let r1 = &s; // no problem
+ let r2 = &s; // no problem
+ println!("{r1} and {r2}");
+ // variables r1 and r2 will not be used after this point
+
+ let r3 = &mut s; // no problem
+ println!("{r3}");
+}
+
The scopes of the immutable references r1 and r2 end after the println!
+where they are last used, which is before the mutable reference r3 is
+created. These scopes don’t overlap, so this code is allowed: the compiler can
+tell that the reference is no longer being used at a point before the end of
+the scope.
+
Even though borrowing errors may be frustrating at times, remember that it’s
+the Rust compiler pointing out a potential bug early (at compile time rather
+than at runtime) and showing you exactly where the problem is. Then you don’t
+have to track down why your data isn’t what you thought it was.
In languages with pointers, it’s easy to erroneously create a dangling
+pointer—a pointer that references a location in memory that may have been
+given to someone else—by freeing some memory while preserving a pointer to that
+memory. In Rust, by contrast, the compiler guarantees that references will
+never be dangling references: if you have a reference to some data, the
+compiler will ensure that the data will not go out of scope before the
+reference to the data does.
+
Let’s try to create a dangling reference to see how Rust prevents them with a
+compile-time error:
+
Filename: src/main.rs
+
fn main() {
+ let reference_to_nothing = dangle();
+}
+
+fn dangle() -> &String {
+ let s = String::from("hello");
+
+ &s
+}
+
Here’s the error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:5:16
+ |
+5 | fn dangle() -> &String {
+ | ^ expected named lifetime parameter
+ |
+ = help: this function's return type contains a borrowed value, but there is no value for it to be borrowed from
+help: consider using the `'static` lifetime, but this is uncommon unless you're returning a borrowed value from a `const` or a `static`
+ |
+5 | fn dangle() -> &'static String {
+ | +++++++
+help: instead, you are more likely to want to return an owned value
+ |
+5 - fn dangle() -> &String {
+5 + fn dangle() -> String {
+ |
+
+error[E0515]: cannot return reference to local variable `s`
+ --> src/main.rs:8:5
+ |
+8 | &s
+ | ^^ returns a reference to data owned by the current function
+
+Some errors have detailed explanations: E0106, E0515.
+For more information about an error, try `rustc --explain E0106`.
+error: could not compile `ownership` (bin "ownership") due to 2 previous errors
+
+
This error message refers to a feature we haven’t covered yet: lifetimes. We’ll
+discuss lifetimes in detail in Chapter 10. But, if you disregard the parts
+about lifetimes, the message does contain the key to why this code is a problem:
+
this function's return type contains a borrowed value, but there is no value
+for it to be borrowed from
+
+
Let’s take a closer look at exactly what’s happening at each stage of our
+dangle code:
+
Filename: src/main.rs
+
fn main() {
+ let reference_to_nothing = dangle();
+}
+
+fn dangle() -> &String { // dangle returns a reference to a String
+
+ let s = String::from("hello"); // s is a new String
+
+ &s // we return a reference to the String, s
+} // Here, s goes out of scope, and is dropped. Its memory goes away.
+ // Danger!
+
Because s is created inside dangle, when the code of dangle is finished,
+s will be deallocated. But we tried to return a reference to it. That means
+this reference would be pointing to an invalid String. That’s no good! Rust
+won’t let us do this.
+
The solution here is to return the String directly:
+
fn main() {
+ let string = no_dangle();
+}
+
+fn no_dangle() -> String {
+ let s = String::from("hello");
+
+ s
+}
+
This works without any problems. Ownership is moved out, and nothing is
+deallocated.
Slices let you reference a contiguous sequence of elements in a
+collection rather than the whole collection. A
+slice is a kind of reference, so it does not have ownership.
+
Here’s a small programming problem: write a function that takes a string of
+words separated by spaces and returns the first word it finds in that string.
+If the function doesn’t find a space in the string, the whole string must be
+one word, so the entire string should be returned.
+
Let’s work through how we’d write the signature of this function without using
+slices, to understand the problem that slices will solve:
+
fn first_word(s: &String) -> ?
+
The first_word function has a &String as a parameter. We don’t want
+ownership, so this is fine. But what should we return? We don’t really have a
+way to talk about part of a string. However, we could return the index of the
+end of the word, indicated by a space. Let’s try that, as shown in Listing 4-7.
+
Filename: src/main.rs
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
Listing 4-7: The first_word function that returns a
+byte index value into the String parameter
+
Because we need to go through the String element by element and check whether
+a value is a space, we’ll convert our String to an array of bytes using the
+as_bytes method.
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
Next, we create an iterator over the array of bytes using the iter method:
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
We’ll discuss iterators in more detail in Chapter 13.
+For now, know that iter is a method that returns each element in a collection
+and that enumerate wraps the result of iter and returns each element as
+part of a tuple instead. The first element of the tuple returned from
+enumerate is the index, and the second element is a reference to the element.
+This is a bit more convenient than calculating the index ourselves.
+
Because the enumerate method returns a tuple, we can use patterns to
+destructure that tuple. We’ll be discussing patterns more in Chapter
+6. In the for loop, we specify a pattern that has i
+for the index in the tuple and &item for the single byte in the tuple.
+Because we get a reference to the element from .iter().enumerate(), we use
+& in the pattern.
+
Inside the for loop, we search for the byte that represents the space by
+using the byte literal syntax. If we find a space, we return the position.
+Otherwise, we return the length of the string by using s.len().
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {}
+
We now have a way to find out the index of the end of the first word in the
+string, but there’s a problem. We’re returning a usize on its own, but it’s
+only a meaningful number in the context of the &String. In other words,
+because it’s a separate value from the String, there’s no guarantee that it
+will still be valid in the future. Consider the program in Listing 4-8 that
+uses the first_word function from Listing 4-7.
+
Filename: src/main.rs
+
fn first_word(s: &String) -> usize {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return i;
+ }
+ }
+
+ s.len()
+}
+
+fn main() {
+ let mut s = String::from("hello world");
+
+ let word = first_word(&s); // word will get the value 5
+
+ s.clear(); // this empties the String, making it equal to ""
+
+ // word still has the value 5 here, but there's no more string that
+ // we could meaningfully use the value 5 with. word is now totally invalid!
+}
+
Listing 4-8: Storing the result from calling the
+first_word function and then changing the String contents
+
This program compiles without any errors and would also do so if we used word
+after calling s.clear(). Because word isn’t connected to the state of s
+at all, word still contains the value 5. We could use that value 5 with
+the variable s to try to extract the first word out, but this would be a bug
+because the contents of s have changed since we saved 5 in word.
+
Having to worry about the index in word getting out of sync with the data in
+s is tedious and error prone! Managing these indices is even more brittle if
+we write a second_word function. Its signature would have to look like this:
+
fn second_word(s: &String) -> (usize, usize) {
+
Now we’re tracking a starting and an ending index, and we have even more
+values that were calculated from data in a particular state but aren’t tied to
+that state at all. We have three unrelated variables floating around that need
+to be kept in sync.
+
Luckily, Rust has a solution to this problem: string slices.
A string slice is a reference to part of a String, and it looks like this:
+
fn main() {
+ let s = String::from("hello world");
+
+ let hello = &s[0..5];
+ let world = &s[6..11];
+}
+
Rather than a reference to the entire String, hello is a reference to a
+portion of the String, specified in the extra [0..5] bit. We create slices
+using a range within brackets by specifying [starting_index..ending_index],
+where starting_index is the first position in the slice and ending_index is
+one more than the last position in the slice. Internally, the slice data
+structure stores the starting position and the length of the slice, which
+corresponds to ending_index minus starting_index. So, in the case of let world = &s[6..11];, world would be a slice that contains a pointer to the
+byte at index 6 of s with a length value of 5.
+
Figure 4-6 shows this in a diagram.
+
+
Figure 4-6: String slice referring to part of a
+String
+
With Rust’s .. range syntax, if you want to start at index 0, you can drop
+the value before the two periods. In other words, these are equal:
Note: String slice range indices must occur at valid UTF-8 character
+boundaries. If you attempt to create a string slice in the middle of a
+multibyte character, your program will exit with an error. For the purposes
+of introducing string slices, we are assuming ASCII only in this section; a
+more thorough discussion of UTF-8 handling is in the “Storing UTF-8 Encoded
+Text with Strings” section of Chapter 8.
+
+
With all this information in mind, let’s rewrite first_word to return a
+slice. The type that signifies “string slice” is written as &str:
+
Filename: src/main.rs
+
fn first_word(s: &String) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {}
+
We get the index for the end of the word the same way we did in Listing 4-7, by
+looking for the first occurrence of a space. When we find a space, we return a
+string slice using the start of the string and the index of the space as the
+starting and ending indices.
+
Now when we call first_word, we get back a single value that is tied to the
+underlying data. The value is made up of a reference to the starting point of
+the slice and the number of elements in the slice.
+
Returning a slice would also work for a second_word function:
+
fn second_word(s: &String) -> &str {
+
We now have a straightforward API that’s much harder to mess up because the
+compiler will ensure the references into the String remain valid. Remember
+the bug in the program in Listing 4-8, when we got the index to the end of the
+first word but then cleared the string so our index was invalid? That code was
+logically incorrect but didn’t show any immediate errors. The problems would
+show up later if we kept trying to use the first word index with an emptied
+string. Slices make this bug impossible and let us know we have a problem with
+our code much sooner. Using the slice version of first_word will throw a
+compile-time error:
+
Filename: src/main.rs
+
fn first_word(s: &String) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let mut s = String::from("hello world");
+
+ let word = first_word(&s);
+
+ s.clear(); // error!
+
+ println!("the first word is: {word}");
+}
+
Here’s the compiler error:
+
$ cargo run
+ Compiling ownership v0.1.0 (file:///projects/ownership)
+error[E0502]: cannot borrow `s` as mutable because it is also borrowed as immutable
+ --> src/main.rs:18:5
+ |
+16 | let word = first_word(&s);
+ | -- immutable borrow occurs here
+17 |
+18 | s.clear(); // error!
+ | ^^^^^^^^^ mutable borrow occurs here
+19 |
+20 | println!("the first word is: {word}");
+ | ------ immutable borrow later used here
+
+For more information about this error, try `rustc --explain E0502`.
+error: could not compile `ownership` (bin "ownership") due to 1 previous error
+
+
Recall from the borrowing rules that if we have an immutable reference to
+something, we cannot also take a mutable reference. Because clear needs to
+truncate the String, it needs to get a mutable reference. The println!
+after the call to clear uses the reference in word, so the immutable
+reference must still be active at that point. Rust disallows the mutable
+reference in clear and the immutable reference in word from existing at the
+same time, and compilation fails. Not only has Rust made our API easier to use,
+but it has also eliminated an entire class of errors at compile time!
Recall that we talked about string literals being stored inside the binary. Now
+that we know about slices, we can properly understand string literals:
+
#![allow(unused)]
+fn main() {
+let s = "Hello, world!";
+}
+
The type of s here is &str: it’s a slice pointing to that specific point of
+the binary. This is also why string literals are immutable; &str is an
+immutable reference.
Knowing that you can take slices of literals and String values leads us to
+one more improvement on first_word, and that’s its signature:
+
fn first_word(s: &String) -> &str {
+
A more experienced Rustacean would write the signature shown in Listing 4-9
+instead because it allows us to use the same function on both &String values
+and &str values.
+
fn first_word(s: &str) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let my_string = String::from("hello world");
+
+ // `first_word` works on slices of `String`s, whether partial or whole
+ let word = first_word(&my_string[0..6]);
+ let word = first_word(&my_string[..]);
+ // `first_word` also works on references to `String`s, which are equivalent
+ // to whole slices of `String`s
+ let word = first_word(&my_string);
+
+ let my_string_literal = "hello world";
+
+ // `first_word` works on slices of string literals, whether partial or whole
+ let word = first_word(&my_string_literal[0..6]);
+ let word = first_word(&my_string_literal[..]);
+
+ // Because string literals *are* string slices already,
+ // this works too, without the slice syntax!
+ let word = first_word(my_string_literal);
+}
+
Listing 4-9: Improving the first_word function by using
+a string slice for the type of the s parameter
+
If we have a string slice, we can pass that directly. If we have a String, we
+can pass a slice of the String or a reference to the String. This
+flexibility takes advantage of deref coercions, a feature we will cover in the
+“Implicit Deref Coercions with Functions and
+Methods” section of Chapter 15.
+
Defining a function to take a string slice instead of a reference to a String
+makes our API more general and useful without losing any functionality:
+
Filename: src/main.rs
+
fn first_word(s: &str) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let my_string = String::from("hello world");
+
+ // `first_word` works on slices of `String`s, whether partial or whole
+ let word = first_word(&my_string[0..6]);
+ let word = first_word(&my_string[..]);
+ // `first_word` also works on references to `String`s, which are equivalent
+ // to whole slices of `String`s
+ let word = first_word(&my_string);
+
+ let my_string_literal = "hello world";
+
+ // `first_word` works on slices of string literals, whether partial or whole
+ let word = first_word(&my_string_literal[0..6]);
+ let word = first_word(&my_string_literal[..]);
+
+ // Because string literals *are* string slices already,
+ // this works too, without the slice syntax!
+ let word = first_word(my_string_literal);
+}
This slice has the type &[i32]. It works the same way as string slices do, by
+storing a reference to the first element and a length. You’ll use this kind of
+slice for all sorts of other collections. We’ll discuss these collections in
+detail when we talk about vectors in Chapter 8.
The concepts of ownership, borrowing, and slices ensure memory safety in Rust
+programs at compile time. The Rust language gives you control over your memory
+usage in the same way as other systems programming languages, but having the
+owner of data automatically clean up that data when the owner goes out of scope
+means you don’t have to write and debug extra code to get this control.
+
Ownership affects how lots of other parts of Rust work, so we’ll talk about
+these concepts further throughout the rest of the book. Let’s move on to
+Chapter 5 and look at grouping pieces of data together in a struct.
A struct, or structure, is a custom data type that lets you package
+together and name multiple related values that make up a meaningful group. If
+you’re familiar with an object-oriented language, a struct is like an
+object’s data attributes. In this chapter, we’ll compare and contrast tuples
+with structs to build on what you already know and demonstrate when structs are
+a better way to group data.
+
We’ll demonstrate how to define and instantiate structs. We’ll discuss how to
+define associated functions, especially the kind of associated functions called
+methods, to specify behavior associated with a struct type. Structs and enums
+(discussed in Chapter 6) are the building blocks for creating new types in your
+program’s domain to take full advantage of Rust’s compile-time type checking.
Structs are similar to tuples, discussed in “The Tuple Type” section, in that both hold multiple related values. Like tuples, the
+pieces of a struct can be different types. Unlike with tuples, in a struct
+you’ll name each piece of data so it’s clear what the values mean. Adding these
+names means that structs are more flexible than tuples: you don’t have to rely
+on the order of the data to specify or access the values of an instance.
+
To define a struct, we enter the keyword struct and name the entire struct. A
+struct’s name should describe the significance of the pieces of data being
+grouped together. Then, inside curly brackets, we define the names and types of
+the pieces of data, which we call fields. For example, Listing 5-1 shows a
+struct that stores information about a user account.
To use a struct after we’ve defined it, we create an instance of that struct
+by specifying concrete values for each of the fields. We create an instance by
+stating the name of the struct and then add curly brackets containing key:
+value pairs, where the keys are the names of the fields and the values are the
+data we want to store in those fields. We don’t have to specify the fields in
+the same order in which we declared them in the struct. In other words, the
+struct definition is like a general template for the type, and instances fill
+in that template with particular data to create values of the type. For
+example, we can declare a particular user as shown in Listing 5-2.
Listing 5-2: Creating an instance of the User
+struct
+
To get a specific value from a struct, we use dot notation. For example, to
+access this user’s email address, we use user1.email. If the instance is
+mutable, we can change a value by using the dot notation and assigning into a
+particular field. Listing 5-3 shows how to change the value in the email
+field of a mutable User instance.
Listing 5-3: Changing the value in the email field of a
+User instance
+
Note that the entire instance must be mutable; Rust doesn’t allow us to mark
+only certain fields as mutable. As with any expression, we can construct a new
+instance of the struct as the last expression in the function body to
+implicitly return that new instance.
+
Listing 5-4 shows a build_user function that returns a User instance with
+the given email and username. The active field gets the value of true, and
+the sign_in_count gets a value of 1.
Listing 5-4: A build_user function that takes an email
+and username and returns a User instance
+
It makes sense to name the function parameters with the same name as the struct
+fields, but having to repeat the email and username field names and
+variables is a bit tedious. If the struct had more fields, repeating each name
+would get even more annoying. Luckily, there’s a convenient shorthand!
Because the parameter names and the struct field names are exactly the same in
+Listing 5-4, we can use the field init shorthand syntax to rewrite
+build_user so it behaves exactly the same but doesn’t have the repetition of
+username and email, as shown in Listing 5-5.
Listing 5-5: A build_user function that uses field init
+shorthand because the username and email parameters have the same name as
+struct fields
+
Here, we’re creating a new instance of the User struct, which has a field
+named email. We want to set the email field’s value to the value in the
+email parameter of the build_user function. Because the email field and
+the email parameter have the same name, we only need to write email rather
+than email: email.
It’s often useful to create a new instance of a struct that includes most of
+the values from another instance, but changes some. You can do this using
+struct update syntax.
+
First, in Listing 5-6 we show how to create a new User instance in user2
+regularly, without the update syntax. We set a new value for email but
+otherwise use the same values from user1 that we created in Listing 5-2.
Listing 5-6: Creating a new User instance using all but one of
+the values from user1
+
Using struct update syntax, we can achieve the same effect with less code, as
+shown in Listing 5-7. The syntax .. specifies that the remaining fields not
+explicitly set should have the same value as the fields in the given instance.
Listing 5-7: Using struct update syntax to set a new
+email value for a User instance but to use the rest of the values from
+user1
+
The code in Listing 5-7 also creates an instance in user2 that has a
+different value for email but has the same values for the username,
+active, and sign_in_count fields from user1. The ..user1 must come last
+to specify that any remaining fields should get their values from the
+corresponding fields in user1, but we can choose to specify values for as
+many fields as we want in any order, regardless of the order of the fields in
+the struct’s definition.
+
Note that the struct update syntax uses = like an assignment; this is because
+it moves the data, just as we saw in the “Variables and Data Interacting with
+Move” section. In this example, we can no longer use
+user1 as a whole after creating user2 because the String in the
+username field of user1 was moved into user2. If we had given user2 new
+String values for both email and username, and thus only used the
+active and sign_in_count values from user1, then user1 would still be
+valid after creating user2. Both active and sign_in_count are types that
+implement the Copy trait, so the behavior we discussed in the “Stack-Only
+Data: Copy” section would apply.
Rust also supports structs that look similar to tuples, called tuple structs.
+Tuple structs have the added meaning the struct name provides but don’t have
+names associated with their fields; rather, they just have the types of the
+fields. Tuple structs are useful when you want to give the whole tuple a name
+and make the tuple a different type from other tuples, and when naming each
+field as in a regular struct would be verbose or redundant.
+
To define a tuple struct, start with the struct keyword and the struct name
+followed by the types in the tuple. For example, here we define and use two
+tuple structs named Color and Point:
+
Filename: src/main.rs
+
struct Color(i32, i32, i32);
+struct Point(i32, i32, i32);
+
+fn main() {
+ let black = Color(0, 0, 0);
+ let origin = Point(0, 0, 0);
+}
+
Note that the black and origin values are different types because they’re
+instances of different tuple structs. Each struct you define is its own type,
+even though the fields within the struct might have the same types. For
+example, a function that takes a parameter of type Color cannot take a
+Point as an argument, even though both types are made up of three i32
+values. Otherwise, tuple struct instances are similar to tuples in that you can
+destructure them into their individual pieces, and you can use a . followed
+by the index to access an individual value.
You can also define structs that don’t have any fields! These are called
+unit-like structs because they behave similarly to (), the unit type that
+we mentioned in “The Tuple Type” section. Unit-like
+structs can be useful when you need to implement a trait on some type but don’t
+have any data that you want to store in the type itself. We’ll discuss traits
+in Chapter 10. Here’s an example of declaring and instantiating a unit struct
+named AlwaysEqual:
To define AlwaysEqual, we use the struct keyword, the name we want, and
+then a semicolon. No need for curly brackets or parentheses! Then we can get an
+instance of AlwaysEqual in the subject variable in a similar way: using the
+name we defined, without any curly brackets or parentheses. Imagine that later
+we’ll implement behavior for this type such that every instance of
+AlwaysEqual is always equal to every instance of any other type, perhaps to
+have a known result for testing purposes. We wouldn’t need any data to
+implement that behavior! You’ll see in Chapter 10 how to define traits and
+implement them on any type, including unit-like structs.
In the User struct definition in Listing 5-1, we used the owned String
+type rather than the &str string slice type. This is a deliberate choice
+because we want each instance of this struct to own all of its data and for
+that data to be valid for as long as the entire struct is valid.
+
It’s also possible for structs to store references to data owned by something
+else, but to do so requires the use of lifetimes, a Rust feature that we’ll
+discuss in Chapter 10. Lifetimes ensure that the data referenced by a struct
+is valid for as long as the struct is. Let’s say you try to store a reference
+in a struct without specifying lifetimes, like the following; this won’t work:
The compiler will complain that it needs lifetime specifiers:
+
$ cargo run
+ Compiling structs v0.1.0 (file:///projects/structs)
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:3:15
+ |
+3 | username: &str,
+ | ^ expected named lifetime parameter
+ |
+help: consider introducing a named lifetime parameter
+ |
+1 ~ struct User<'a> {
+2 | active: bool,
+3 ~ username: &'a str,
+ |
+
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:4:12
+ |
+4 | email: &str,
+ | ^ expected named lifetime parameter
+ |
+help: consider introducing a named lifetime parameter
+ |
+1 ~ struct User<'a> {
+2 | active: bool,
+3 | username: &str,
+4 ~ email: &'a str,
+ |
+
+For more information about this error, try `rustc --explain E0106`.
+error: could not compile `structs` (bin "structs") due to 2 previous errors
+
+
In Chapter 10, we’ll discuss how to fix these errors so you can store
+references in structs, but for now, we’ll fix errors like these using owned
+types like String instead of references like &str.
To understand when we might want to use structs, let’s write a program that
+calculates the area of a rectangle. We’ll start by using single variables, and
+then refactor the program until we’re using structs instead.
+
Let’s make a new binary project with Cargo called rectangles that will take
+the width and height of a rectangle specified in pixels and calculate the area
+of the rectangle. Listing 5-8 shows a short program with one way of doing
+exactly that in our project’s src/main.rs.
+
Filename: src/main.rs
+
fn main() {
+ let width1 = 30;
+ let height1 = 50;
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(width1, height1)
+ );
+}
+
+fn area(width: u32, height: u32) -> u32 {
+ width * height
+}
+
Listing 5-8: Calculating the area of a rectangle
+specified by separate width and height variables
+
Now, run this program using cargo run:
+
$ cargo run
+ Compiling rectangles v0.1.0 (file:///projects/rectangles)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.42s
+ Running `target/debug/rectangles`
+The area of the rectangle is 1500 square pixels.
+
+
This code succeeds in figuring out the area of the rectangle by calling the
+area function with each dimension, but we can do more to make this code clear
+and readable.
+
The issue with this code is evident in the signature of area:
+
fn main() {
+ let width1 = 30;
+ let height1 = 50;
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(width1, height1)
+ );
+}
+
+fn area(width: u32, height: u32) -> u32 {
+ width * height
+}
+
The area function is supposed to calculate the area of one rectangle, but the
+function we wrote has two parameters, and it’s not clear anywhere in our
+program that the parameters are related. It would be more readable and more
+manageable to group width and height together. We’ve already discussed one way
+we might do that in “The Tuple Type” section
+of Chapter 3: by using tuples.
Listing 5-9 shows another version of our program that uses tuples.
+
Filename: src/main.rs
+
fn main() {
+ let rect1 = (30, 50);
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(rect1)
+ );
+}
+
+fn area(dimensions: (u32, u32)) -> u32 {
+ dimensions.0 * dimensions.1
+}
+
Listing 5-9: Specifying the width and height of the
+rectangle with a tuple
+
In one way, this program is better. Tuples let us add a bit of structure, and
+we’re now passing just one argument. But in another way, this version is less
+clear: tuples don’t name their elements, so we have to index into the parts of
+the tuple, making our calculation less obvious.
+
Mixing up the width and height wouldn’t matter for the area calculation, but if
+we want to draw the rectangle on the screen, it would matter! We would have to
+keep in mind that width is the tuple index 0 and height is the tuple
+index 1. This would be even harder for someone else to figure out and keep in
+mind if they were to use our code. Because we haven’t conveyed the meaning of
+our data in our code, it’s now easier to introduce errors.
We use structs to add meaning by labeling the data. We can transform the tuple
+we’re using into a struct with a name for the whole as well as names for the
+parts, as shown in Listing 5-10.
+
Filename: src/main.rs
+
struct Rectangle {
+ width: u32,
+ height: u32,
+}
+
+fn main() {
+ let rect1 = Rectangle {
+ width: 30,
+ height: 50,
+ };
+
+ println!(
+ "The area of the rectangle is {} square pixels.",
+ area(&rect1)
+ );
+}
+
+fn area(rectangle: &Rectangle) -> u32 {
+ rectangle.width * rectangle.height
+}
+
Listing 5-10: Defining a Rectangle struct
+
Here we’ve defined a struct and named it Rectangle. Inside the curly
+brackets, we defined the fields as width and height, both of which have
+type u32. Then, in main, we created a particular instance of Rectangle
+that has a width of 30 and a height of 50.
+
Our area function is now defined with one parameter, which we’ve named
+rectangle, whose type is an immutable borrow of a struct Rectangle
+instance. As mentioned in Chapter 4, we want to borrow the struct rather than
+take ownership of it. This way, main retains its ownership and can continue
+using rect1, which is the reason we use the & in the function signature and
+where we call the function.
+
The area function accesses the width and height fields of the Rectangle
+instance (note that accessing fields of a borrowed struct instance does not
+move the field values, which is why you often see borrows of structs). Our
+function signature for area now says exactly what we mean: calculate the area
+of Rectangle, using its width and height fields. This conveys that the
+width and height are related to each other, and it gives descriptive names to
+the values rather than using the tuple index values of 0 and 1. This is a
+win for clarity.
It’d be useful to be able to print an instance of Rectangle while we’re
+debugging our program and see the values for all its fields. Listing 5-11 tries
+using the println! macro as we have used in
+previous chapters. This won’t work, however.
The println! macro can do many kinds of formatting, and by default, the curly
+brackets tell println! to use formatting known as Display: output intended
+for direct end user consumption. The primitive types we’ve seen so far
+implement Display by default because there’s only one way you’d want to show
+a 1 or any other primitive type to a user. But with structs, the way
+println! should format the output is less clear because there are more
+display possibilities: Do you want commas or not? Do you want to print the
+curly brackets? Should all the fields be shown? Due to this ambiguity, Rust
+doesn’t try to guess what we want, and structs don’t have a provided
+implementation of Display to use with println! and the {} placeholder.
+
If we continue reading the errors, we’ll find this helpful note:
+
= help: the trait `std::fmt::Display` is not implemented for `Rectangle`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+
+
Let’s try it! The println! macro call will now look like println!("rect1 is {rect1:?}");. Putting the specifier :? inside the curly brackets tells
+println! we want to use an output format called Debug. The Debug trait
+enables us to print our struct in a way that is useful for developers so we can
+see its value while we’re debugging our code.
+
Compile the code with this change. Drat! We still get an error:
= help: the trait `Debug` is not implemented for `Rectangle`
+ = note: add `#[derive(Debug)]` to `Rectangle` or manually `impl Debug for Rectangle`
+
+
Rust does include functionality to print out debugging information, but we
+have to explicitly opt in to make that functionality available for our struct.
+To do that, we add the outer attribute #[derive(Debug)] just before the
+struct definition, as shown in Listing 5-12.
Nice! It’s not the prettiest output, but it shows the values of all the fields
+for this instance, which would definitely help during debugging. When we have
+larger structs, it’s useful to have output that’s a bit easier to read; in
+those cases, we can use {:#?} instead of {:?} in the println! string. In
+this example, using the {:#?} style will output the following:
Another way to print out a value using the Debug format is to use the dbg!
+macro, which takes ownership of an expression (as opposed
+to println!, which takes a reference), prints the file and line number of
+where that dbg! macro call occurs in your code along with the resultant value
+of that expression, and returns ownership of the value.
We can put dbg! around the expression 30 * scale and, because dbg!
+returns ownership of the expression’s value, the width field will get the
+same value as if we didn’t have the dbg! call there. We don’t want dbg! to
+take ownership of rect1, so we use a reference to rect1 in the next call.
+Here’s what the output of this example looks like:
We can see the first bit of output came from src/main.rs line 10 where we’re
+debugging the expression 30 * scale, and its resultant value is 60 (the
+Debug formatting implemented for integers is to print only their value). The
+dbg! call on line 14 of src/main.rs outputs the value of &rect1, which is
+the Rectangle struct. This output uses the pretty Debug formatting of the
+Rectangle type. The dbg! macro can be really helpful when you’re trying to
+figure out what your code is doing!
+
In addition to the Debug trait, Rust has provided a number of traits for us
+to use with the derive attribute that can add useful behavior to our custom
+types. Those traits and their behaviors are listed in Appendix C. We’ll cover how to implement these traits with custom behavior as
+well as how to create your own traits in Chapter 10. There are also many
+attributes other than derive; for more information, see the “Attributes”
+section of the Rust Reference.
+
Our area function is very specific: it only computes the area of rectangles.
+It would be helpful to tie this behavior more closely to our Rectangle struct
+because it won’t work with any other type. Let’s look at how we can continue to
+refactor this code by turning the area function into an areamethod
+defined on our Rectangle type.
Methods are similar to functions: we declare them with the fn keyword and a
+name, they can have parameters and a return value, and they contain some code
+that’s run when the method is called from somewhere else. Unlike functions,
+methods are defined within the context of a struct (or an enum or a trait
+object, which we cover in Chapter 6 and Chapter
+17, respectively), and their first parameter is
+always self, which represents the instance of the struct the method is being
+called on.
Let’s change the area function that has a Rectangle instance as a parameter
+and instead make an area method defined on the Rectangle struct, as shown
+in Listing 5-13.
Listing 5-13: Defining an area method on the
+Rectangle struct
+
To define the function within the context of Rectangle, we start an impl
+(implementation) block for Rectangle. Everything within this impl block
+will be associated with the Rectangle type. Then we move the area function
+within the impl curly brackets and change the first (and in this case, only)
+parameter to be self in the signature and everywhere within the body. In
+main, where we called the area function and passed rect1 as an argument,
+we can instead use method syntax to call the area method on our Rectangle
+instance. The method syntax goes after an instance: we add a dot followed by
+the method name, parentheses, and any arguments.
+
In the signature for area, we use &self instead of rectangle: &Rectangle.
+The &self is actually short for self: &Self. Within an impl block, the
+type Self is an alias for the type that the impl block is for. Methods must
+have a parameter named self of type Self for their first parameter, so Rust
+lets you abbreviate this with only the name self in the first parameter spot.
+Note that we still need to use the & in front of the self shorthand to
+indicate that this method borrows the Self instance, just as we did in
+rectangle: &Rectangle. Methods can take ownership of self, borrow self
+immutably, as we’ve done here, or borrow self mutably, just as they can any
+other parameter.
+
We chose &self here for the same reason we used &Rectangle in the function
+version: we don’t want to take ownership, and we just want to read the data in
+the struct, not write to it. If we wanted to change the instance that we’ve
+called the method on as part of what the method does, we’d use &mut self as
+the first parameter. Having a method that takes ownership of the instance by
+using just self as the first parameter is rare; this technique is usually
+used when the method transforms self into something else and you want to
+prevent the caller from using the original instance after the transformation.
+
The main reason for using methods instead of functions, in addition to
+providing method syntax and not having to repeat the type of self in every
+method’s signature, is for organization. We’ve put all the things we can do
+with an instance of a type in one impl block rather than making future users
+of our code search for capabilities of Rectangle in various places in the
+library we provide.
+
Note that we can choose to give a method the same name as one of the struct’s
+fields. For example, we can define a method on Rectangle that is also named
+width:
Here, we’re choosing to make the width method return true if the value in
+the instance’s width field is greater than 0 and false if the value is
+0: we can use a field within a method of the same name for any purpose. In
+main, when we follow rect1.width with parentheses, Rust knows we mean the
+method width. When we don’t use parentheses, Rust knows we mean the field
+width.
+
Often, but not always, when we give a method the same name as a field we want
+it to only return the value in the field and do nothing else. Methods like this
+are called getters, and Rust does not implement them automatically for struct
+fields as some other languages do. Getters are useful because you can make the
+field private but the method public, and thus enable read-only access to that
+field as part of the type’s public API. We will discuss what public and private
+are and how to designate a field or method as public or private in Chapter
+7.
In C and C++, two different operators are used for calling methods: you use
+. if you’re calling a method on the object directly and -> if you’re
+calling the method on a pointer to the object and need to dereference the
+pointer first. In other words, if object is a pointer,
+object->something() is similar to (*object).something().
+
Rust doesn’t have an equivalent to the -> operator; instead, Rust has a
+feature called automatic referencing and dereferencing. Calling methods is
+one of the few places in Rust that has this behavior.
+
Here’s how it works: when you call a method with object.something(), Rust
+automatically adds in &, &mut, or * so object matches the signature of
+the method. In other words, the following are the same:
The first one looks much cleaner. This automatic referencing behavior works
+because methods have a clear receiver—the type of self. Given the receiver
+and name of a method, Rust can figure out definitively whether the method is
+reading (&self), mutating (&mut self), or consuming (self). The fact
+that Rust makes borrowing implicit for method receivers is a big part of
+making ownership ergonomic in practice.
Let’s practice using methods by implementing a second method on the Rectangle
+struct. This time we want an instance of Rectangle to take another instance
+of Rectangle and return true if the second Rectangle can fit completely
+within self (the first Rectangle); otherwise, it should return false.
+That is, once we’ve defined the can_hold method, we want to be able to write
+the program shown in Listing 5-14.
Listing 5-14: Using the as-yet-unwritten can_hold
+method
+
The expected output would look like the following because both dimensions of
+rect2 are smaller than the dimensions of rect1, but rect3 is wider than
+rect1:
+
Can rect1 hold rect2? true
+Can rect1 hold rect3? false
+
+
We know we want to define a method, so it will be within the impl Rectangle
+block. The method name will be can_hold, and it will take an immutable borrow
+of another Rectangle as a parameter. We can tell what the type of the
+parameter will be by looking at the code that calls the method:
+rect1.can_hold(&rect2) passes in &rect2, which is an immutable borrow to
+rect2, an instance of Rectangle. This makes sense because we only need to
+read rect2 (rather than write, which would mean we’d need a mutable borrow),
+and we want main to retain ownership of rect2 so we can use it again after
+calling the can_hold method. The return value of can_hold will be a
+Boolean, and the implementation will check whether the width and height of
+self are greater than the width and height of the other Rectangle,
+respectively. Let’s add the new can_hold method to the impl block from
+Listing 5-13, shown in Listing 5-15.
Listing 5-15: Implementing the can_hold method on
+Rectangle that takes another Rectangle instance as a parameter
+
When we run this code with the main function in Listing 5-14, we’ll get our
+desired output. Methods can take multiple parameters that we add to the
+signature after the self parameter, and those parameters work just like
+parameters in functions.
All functions defined within an impl block are called associated functions
+because they’re associated with the type named after the impl. We can define
+associated functions that don’t have self as their first parameter (and thus
+are not methods) because they don’t need an instance of the type to work with.
+We’ve already used one function like this: the String::from function that’s
+defined on the String type.
+
Associated functions that aren’t methods are often used for constructors that
+will return a new instance of the struct. These are often called new, but
+new isn’t a special name and isn’t built into the language. For example, we
+could choose to provide an associated function named square that would have
+one dimension parameter and use that as both width and height, thus making it
+easier to create a square Rectangle rather than having to specify the same
+value twice:
The Self keywords in the return type and in the body of the function are
+aliases for the type that appears after the impl keyword, which in this case
+is Rectangle.
+
To call this associated function, we use the :: syntax with the struct name;
+let sq = Rectangle::square(3); is an example. This function is namespaced by
+the struct: the :: syntax is used for both associated functions and
+namespaces created by modules. We’ll discuss modules in Chapter
+7.
Each struct is allowed to have multiple impl blocks. For example, Listing
+5-15 is equivalent to the code shown in Listing 5-16, which has each method in
+its own impl block.
Listing 5-16: Rewriting Listing 5-15 using multiple impl
+blocks
+
There’s no reason to separate these methods into multiple impl blocks here,
+but this is valid syntax. We’ll see a case in which multiple impl blocks are
+useful in Chapter 10, where we discuss generic types and traits.
Structs let you create custom types that are meaningful for your domain. By
+using structs, you can keep associated pieces of data connected to each other
+and name each piece to make your code clear. In impl blocks, you can define
+functions that are associated with your type, and methods are a kind of
+associated function that let you specify the behavior that instances of your
+structs have.
+
But structs aren’t the only way you can create custom types: let’s turn to
+Rust’s enum feature to add another tool to your toolbox.
In this chapter, we’ll look at enumerations, also referred to as enums.
+Enums allow you to define a type by enumerating its possible variants. First
+we’ll define and use an enum to show how an enum can encode meaning along with
+data. Next, we’ll explore a particularly useful enum, called Option, which
+expresses that a value can be either something or nothing. Then we’ll look at
+how pattern matching in the match expression makes it easy to run different
+code for different values of an enum. Finally, we’ll cover how the if let
+construct is another convenient and concise idiom available to handle enums in
+your code.
Where structs give you a way of grouping together related fields and data, like
+a Rectangle with its width and height, enums give you a way of saying a
+value is one of a possible set of values. For example, we may want to say that
+Rectangle is one of a set of possible shapes that also includes Circle and
+Triangle. To do this, Rust allows us to encode these possibilities as an enum.
+
Let’s look at a situation we might want to express in code and see why enums
+are useful and more appropriate than structs in this case. Say we need to work
+with IP addresses. Currently, two major standards are used for IP addresses:
+version four and version six. Because these are the only possibilities for an
+IP address that our program will come across, we can enumerate all possible
+variants, which is where enumeration gets its name.
+
Any IP address can be either a version four or a version six address, but not
+both at the same time. That property of IP addresses makes the enum data
+structure appropriate because an enum value can only be one of its variants.
+Both version four and version six addresses are still fundamentally IP
+addresses, so they should be treated as the same type when the code is handling
+situations that apply to any kind of IP address.
+
We can express this concept in code by defining an IpAddrKind enumeration and
+listing the possible kinds an IP address can be, V4 and V6. These are the
+variants of the enum:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
IpAddrKind is now a custom data type that we can use elsewhere in our code.
We can create instances of each of the two variants of IpAddrKind like this:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
Note that the variants of the enum are namespaced under its identifier, and we
+use a double colon to separate the two. This is useful because now both values
+IpAddrKind::V4 and IpAddrKind::V6 are of the same type: IpAddrKind. We
+can then, for instance, define a function that takes any IpAddrKind:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
And we can call this function with either variant:
+
enum IpAddrKind {
+ V4,
+ V6,
+}
+
+fn main() {
+ let four = IpAddrKind::V4;
+ let six = IpAddrKind::V6;
+
+ route(IpAddrKind::V4);
+ route(IpAddrKind::V6);
+}
+
+fn route(ip_kind: IpAddrKind) {}
+
Using enums has even more advantages. Thinking more about our IP address type,
+at the moment we don’t have a way to store the actual IP address data; we
+only know what kind it is. Given that you just learned about structs in
+Chapter 5, you might be tempted to tackle this problem with structs as shown in
+Listing 6-1.
Listing 6-1: Storing the data and IpAddrKind variant of
+an IP address using a struct
+
Here, we’ve defined a struct IpAddr that has two fields: a kind field that
+is of type IpAddrKind (the enum we defined previously) and an address field
+of type String. We have two instances of this struct. The first is home,
+and it has the value IpAddrKind::V4 as its kind with associated address
+data of 127.0.0.1. The second instance is loopback. It has the other
+variant of IpAddrKind as its kind value, V6, and has address ::1
+associated with it. We’ve used a struct to bundle the kind and address
+values together, so now the variant is associated with the value.
+
However, representing the same concept using just an enum is more concise:
+rather than an enum inside a struct, we can put data directly into each enum
+variant. This new definition of the IpAddr enum says that both V4 and V6
+variants will have associated String values:
+
fn main() {
+ enum IpAddr {
+ V4(String),
+ V6(String),
+ }
+
+ let home = IpAddr::V4(String::from("127.0.0.1"));
+
+ let loopback = IpAddr::V6(String::from("::1"));
+}
+
We attach data to each variant of the enum directly, so there is no need for an
+extra struct. Here, it’s also easier to see another detail of how enums work:
+the name of each enum variant that we define also becomes a function that
+constructs an instance of the enum. That is, IpAddr::V4() is a function call
+that takes a String argument and returns an instance of the IpAddr type. We
+automatically get this constructor function defined as a result of defining the
+enum.
+
There’s another advantage to using an enum rather than a struct: each variant
+can have different types and amounts of associated data. Version four IP
+addresses will always have four numeric components that will have values
+between 0 and 255. If we wanted to store V4 addresses as four u8 values but
+still express V6 addresses as one String value, we wouldn’t be able to with
+a struct. Enums handle this case with ease:
We’ve shown several different ways to define data structures to store version
+four and version six IP addresses. However, as it turns out, wanting to store
+IP addresses and encode which kind they are is so common that the standard
+library has a definition we can use! Let’s look at how
+the standard library defines IpAddr: it has the exact enum and variants that
+we’ve defined and used, but it embeds the address data inside the variants in
+the form of two different structs, which are defined differently for each
+variant:
This code illustrates that you can put any kind of data inside an enum variant:
+strings, numeric types, or structs, for example. You can even include another
+enum! Also, standard library types are often not much more complicated than
+what you might come up with.
+
Note that even though the standard library contains a definition for IpAddr,
+we can still create and use our own definition without conflict because we
+haven’t brought the standard library’s definition into our scope. We’ll talk
+more about bringing types into scope in Chapter 7.
+
Let’s look at another example of an enum in Listing 6-2: this one has a wide
+variety of types embedded in its variants.
Listing 6-2: A Message enum whose variants each store
+different amounts and types of values
+
This enum has four variants with different types:
+
+
Quit has no data associated with it at all.
+
Move has named fields, like a struct does.
+
Write includes a single String.
+
ChangeColor includes three i32 values.
+
+
Defining an enum with variants such as the ones in Listing 6-2 is similar to
+defining different kinds of struct definitions, except the enum doesn’t use the
+struct keyword and all the variants are grouped together under the Message
+type. The following structs could hold the same data that the preceding enum
+variants hold:
But if we used the different structs, each of which has its own type, we
+couldn’t as easily define a function to take any of these kinds of messages as
+we could with the Message enum defined in Listing 6-2, which is a single type.
+
There is one more similarity between enums and structs: just as we’re able to
+define methods on structs using impl, we’re also able to define methods on
+enums. Here’s a method named call that we could define on our Message enum:
+
fn main() {
+ enum Message {
+ Quit,
+ Move { x: i32, y: i32 },
+ Write(String),
+ ChangeColor(i32, i32, i32),
+ }
+
+ impl Message {
+ fn call(&self) {
+ // method body would be defined here
+ }
+ }
+
+ let m = Message::Write(String::from("hello"));
+ m.call();
+}
+
The body of the method would use self to get the value that we called the
+method on. In this example, we’ve created a variable m that has the value
+Message::Write(String::from("hello")), and that is what self will be in the
+body of the call method when m.call() runs.
+
Let’s look at another enum in the standard library that is very common and
+useful: Option.
This section explores a case study of Option, which is another enum defined
+by the standard library. The Option type encodes the very common scenario in
+which a value could be something or it could be nothing.
+
For example, if you request the first item in a non-empty list, you would get
+a value. If you request the first item in an empty list, you would get nothing.
+Expressing this concept in terms of the type system means the compiler can
+check whether you’ve handled all the cases you should be handling; this
+functionality can prevent bugs that are extremely common in other programming
+languages.
+
Programming language design is often thought of in terms of which features you
+include, but the features you exclude are important too. Rust doesn’t have the
+null feature that many other languages have. Null is a value that means there
+is no value there. In languages with null, variables can always be in one of
+two states: null or not-null.
+
In his 2009 presentation “Null References: The Billion Dollar Mistake,” Tony
+Hoare, the inventor of null, has this to say:
+
+
I call it my billion-dollar mistake. At that time, I was designing the first
+comprehensive type system for references in an object-oriented language. My
+goal was to ensure that all use of references should be absolutely safe, with
+checking performed automatically by the compiler. But I couldn’t resist the
+temptation to put in a null reference, simply because it was so easy to
+implement. This has led to innumerable errors, vulnerabilities, and system
+crashes, which have probably caused a billion dollars of pain and damage in
+the last forty years.
+
+
The problem with null values is that if you try to use a null value as a
+not-null value, you’ll get an error of some kind. Because this null or not-null
+property is pervasive, it’s extremely easy to make this kind of error.
+
However, the concept that null is trying to express is still a useful one: a
+null is a value that is currently invalid or absent for some reason.
+
The problem isn’t really with the concept but with the particular
+implementation. As such, Rust does not have nulls, but it does have an enum
+that can encode the concept of a value being present or absent. This enum is
+Option<T>, and it is defined by the standard library
+as follows:
The Option<T> enum is so useful that it’s even included in the prelude; you
+don’t need to bring it into scope explicitly. Its variants are also included in
+the prelude: you can use Some and None directly without the Option::
+prefix. The Option<T> enum is still just a regular enum, and Some(T) and
+None are still variants of type Option<T>.
+
The <T> syntax is a feature of Rust we haven’t talked about yet. It’s a
+generic type parameter, and we’ll cover generics in more detail in Chapter 10.
+For now, all you need to know is that <T> means that the Some variant of
+the Option enum can hold one piece of data of any type, and that each
+concrete type that gets used in place of T makes the overall Option<T> type
+a different type. Here are some examples of using Option values to hold
+number types and string types:
+
fn main() {
+ let some_number = Some(5);
+ let some_char = Some('e');
+
+ let absent_number: Option<i32> = None;
+}
+
The type of some_number is Option<i32>. The type of some_char is
+Option<char>, which is a different type. Rust can infer these types because
+we’ve specified a value inside the Some variant. For absent_number, Rust
+requires us to annotate the overall Option type: the compiler can’t infer the
+type that the corresponding Some variant will hold by looking only at a
+None value. Here, we tell Rust that we mean for absent_number to be of type
+Option<i32>.
+
When we have a Some value, we know that a value is present and the value is
+held within the Some. When we have a None value, in some sense it means the
+same thing as null: we don’t have a valid value. So why is having Option<T>
+any better than having null?
+
In short, because Option<T> and T (where T can be any type) are different
+types, the compiler won’t let us use an Option<T> value as if it were
+definitely a valid value. For example, this code won’t compile, because it’s
+trying to add an i8 to an Option<i8>:
+
fn main() {
+ let x: i8 = 5;
+ let y: Option<i8> = Some(5);
+
+ let sum = x + y;
+}
+
If we run this code, we get an error message like this one:
+
$ cargo run
+ Compiling enums v0.1.0 (file:///projects/enums)
+error[E0277]: cannot add `Option<i8>` to `i8`
+ --> src/main.rs:5:17
+ |
+5 | let sum = x + y;
+ | ^ no implementation for `i8 + Option<i8>`
+ |
+ = help: the trait `Add<Option<i8>>` is not implemented for `i8`
+ = help: the following other types implement trait `Add<Rhs>`:
+ <i8 as Add>
+ <i8 as Add<&i8>>
+ <&'a i8 as Add<i8>>
+ <&i8 as Add<&i8>>
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `enums` (bin "enums") due to 1 previous error
+
+
Intense! In effect, this error message means that Rust doesn’t understand how
+to add an i8 and an Option<i8>, because they’re different types. When we
+have a value of a type like i8 in Rust, the compiler will ensure that we
+always have a valid value. We can proceed confidently without having to check
+for null before using that value. Only when we have an Option<i8> (or
+whatever type of value we’re working with) do we have to worry about possibly
+not having a value, and the compiler will make sure we handle that case before
+using the value.
+
In other words, you have to convert an Option<T> to a T before you can
+perform T operations with it. Generally, this helps catch one of the most
+common issues with null: assuming that something isn’t null when it actually is.
+
Eliminating the risk of incorrectly assuming a not-null value helps you to be
+more confident in your code. In order to have a value that can possibly be
+null, you must explicitly opt in by making the type of that value Option<T>.
+Then, when you use that value, you are required to explicitly handle the case
+when the value is null. Everywhere that a value has a type that isn’t an
+Option<T>, you can safely assume that the value isn’t null. This was a
+deliberate design decision for Rust to limit null’s pervasiveness and increase
+the safety of Rust code.
+
So how do you get the T value out of a Some variant when you have a value
+of type Option<T> so that you can use that value? The Option<T> enum has a
+large number of methods that are useful in a variety of situations; you can
+check them out in its documentation. Becoming familiar
+with the methods on Option<T> will be extremely useful in your journey with
+Rust.
+
In general, in order to use an Option<T> value, you want to have code that
+will handle each variant. You want some code that will run only when you have a
+Some(T) value, and this code is allowed to use the inner T. You want some
+other code to run only if you have a None value, and that code doesn’t have a
+T value available. The match expression is a control flow construct that
+does just this when used with enums: it will run different code depending on
+which variant of the enum it has, and that code can use the data inside the
+matching value.
Rust has an extremely powerful control flow construct called match that
+allows you to compare a value against a series of patterns and then execute
+code based on which pattern matches. Patterns can be made up of literal values,
+variable names, wildcards, and many other things; Chapter
+18 covers all the different kinds of patterns
+and what they do. The power of match comes from the expressiveness of the
+patterns and the fact that the compiler confirms that all possible cases are
+handled.
+
Think of a match expression as being like a coin-sorting machine: coins slide
+down a track with variously sized holes along it, and each coin falls through
+the first hole it encounters that it fits into. In the same way, values go
+through each pattern in a match, and at the first pattern the value “fits,”
+the value falls into the associated code block to be used during execution.
+
Speaking of coins, let’s use them as an example using match! We can write a
+function that takes an unknown US coin and, in a similar way as the counting
+machine, determines which coin it is and returns its value in cents, as shown
+in Listing 6-3.
Listing 6-3: An enum and a match expression that has
+the variants of the enum as its patterns
+
Let’s break down the match in the value_in_cents function. First we list
+the match keyword followed by an expression, which in this case is the value
+coin. This seems very similar to a conditional expression used with if, but
+there’s a big difference: with if, the condition needs to evaluate to a
+Boolean value, but here it can be any type. The type of coin in this example
+is the Coin enum that we defined on the first line.
+
Next are the match arms. An arm has two parts: a pattern and some code. The
+first arm here has a pattern that is the value Coin::Penny and then the =>
+operator that separates the pattern and the code to run. The code in this case
+is just the value 1. Each arm is separated from the next with a comma.
+
When the match expression executes, it compares the resultant value against
+the pattern of each arm, in order. If a pattern matches the value, the code
+associated with that pattern is executed. If that pattern doesn’t match the
+value, execution continues to the next arm, much as in a coin-sorting machine.
+We can have as many arms as we need: in Listing 6-3, our match has four arms.
+
The code associated with each arm is an expression, and the resultant value of
+the expression in the matching arm is the value that gets returned for the
+entire match expression.
+
We don’t typically use curly brackets if the match arm code is short, as it is
+in Listing 6-3 where each arm just returns a value. If you want to run multiple
+lines of code in a match arm, you must use curly brackets, and the comma
+following the arm is then optional. For example, the following code prints
+“Lucky penny!” every time the method is called with a Coin::Penny, but still
+returns the last value of the block, 1:
Another useful feature of match arms is that they can bind to the parts of the
+values that match the pattern. This is how we can extract values out of enum
+variants.
+
As an example, let’s change one of our enum variants to hold data inside it.
+From 1999 through 2008, the United States minted quarters with different
+designs for each of the 50 states on one side. No other coins got state
+designs, so only quarters have this extra value. We can add this information to
+our enum by changing the Quarter variant to include a UsState value
+stored inside it, which we’ve done in Listing 6-4.
+
#[derive(Debug)] // so we can inspect the state in a minute
+enum UsState {
+ Alabama,
+ Alaska,
+ // --snip--
+}
+
+enum Coin {
+ Penny,
+ Nickel,
+ Dime,
+ Quarter(UsState),
+}
+
+fn main() {}
+
Listing 6-4: A Coin enum in which the Quarter variant
+also holds a UsState value
+
Let’s imagine that a friend is trying to collect all 50 state quarters. While
+we sort our loose change by coin type, we’ll also call out the name of the
+state associated with each quarter so that if it’s one our friend doesn’t have,
+they can add it to their collection.
+
In the match expression for this code, we add a variable called state to the
+pattern that matches values of the variant Coin::Quarter. When a
+Coin::Quarter matches, the state variable will bind to the value of that
+quarter’s state. Then we can use state in the code for that arm, like so:
If we were to call value_in_cents(Coin::Quarter(UsState::Alaska)), coin
+would be Coin::Quarter(UsState::Alaska). When we compare that value with each
+of the match arms, none of them match until we reach Coin::Quarter(state). At
+that point, the binding for state will be the value UsState::Alaska. We can
+then use that binding in the println! expression, thus getting the inner
+state value out of the Coin enum variant for Quarter.
In the previous section, we wanted to get the inner T value out of the Some
+case when using Option<T>; we can also handle Option<T> using match, as
+we did with the Coin enum! Instead of comparing coins, we’ll compare the
+variants of Option<T>, but the way the match expression works remains the
+same.
+
Let’s say we want to write a function that takes an Option<i32> and, if
+there’s a value inside, adds 1 to that value. If there isn’t a value inside,
+the function should return the None value and not attempt to perform any
+operations.
+
This function is very easy to write, thanks to match, and will look like
+Listing 6-5.
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
Listing 6-5: A function that uses a match expression on
+an Option<i32>
+
Let’s examine the first execution of plus_one in more detail. When we call
+plus_one(five), the variable x in the body of plus_one will have the
+value Some(5). We then compare that against each match arm:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
The Some(5) value doesn’t match the pattern None, so we continue to the
+next arm:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
Does Some(5) match Some(i)? It does! We have the same variant. The i
+binds to the value contained in Some, so i takes the value 5. The code in
+the match arm is then executed, so we add 1 to the value of i and create a
+new Some value with our total 6 inside.
+
Now let’s consider the second call of plus_one in Listing 6-5, where x is
+None. We enter the match and compare to the first arm:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ None => None,
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
It matches! There’s no value to add to, so the program stops and returns the
+None value on the right side of =>. Because the first arm matched, no other
+arms are compared.
+
Combining match and enums is useful in many situations. You’ll see this
+pattern a lot in Rust code: match against an enum, bind a variable to the
+data inside, and then execute code based on it. It’s a bit tricky at first, but
+once you get used to it, you’ll wish you had it in all languages. It’s
+consistently a user favorite.
There’s one other aspect of match we need to discuss: the arms’ patterns must
+cover all possibilities. Consider this version of our plus_one function,
+which has a bug and won’t compile:
+
fn main() {
+ fn plus_one(x: Option<i32>) -> Option<i32> {
+ match x {
+ Some(i) => Some(i + 1),
+ }
+ }
+
+ let five = Some(5);
+ let six = plus_one(five);
+ let none = plus_one(None);
+}
+
We didn’t handle the None case, so this code will cause a bug. Luckily, it’s
+a bug Rust knows how to catch. If we try to compile this code, we’ll get this
+error:
+
$ cargo run
+ Compiling enums v0.1.0 (file:///projects/enums)
+error[E0004]: non-exhaustive patterns: `None` not covered
+ --> src/main.rs:3:15
+ |
+3 | match x {
+ | ^ pattern `None` not covered
+ |
+note: `Option<i32>` defined here
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/option.rs:572:1
+ ::: /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/option.rs:576:5
+ |
+ = note: not covered
+ = note: the matched value is of type `Option<i32>`
+help: ensure that all possible cases are being handled by adding a match arm with a wildcard pattern or an explicit pattern as shown
+ |
+4 ~ Some(i) => Some(i + 1),
+5 ~ None => todo!(),
+ |
+
+For more information about this error, try `rustc --explain E0004`.
+error: could not compile `enums` (bin "enums") due to 1 previous error
+
+
Rust knows that we didn’t cover every possible case, and even knows which
+pattern we forgot! Matches in Rust are exhaustive: we must exhaust every last
+possibility in order for the code to be valid. Especially in the case of
+Option<T>, when Rust prevents us from forgetting to explicitly handle the
+None case, it protects us from assuming that we have a value when we might
+have null, thus making the billion-dollar mistake discussed earlier impossible.
Using enums, we can also take special actions for a few particular values, but
+for all other values take one default action. Imagine we’re implementing a game
+where, if you roll a 3 on a dice roll, your player doesn’t move, but instead
+gets a new fancy hat. If you roll a 7, your player loses a fancy hat. For all
+other values, your player moves that number of spaces on the game board. Here’s
+a match that implements that logic, with the result of the dice roll
+hardcoded rather than a random value, and all other logic represented by
+functions without bodies because actually implementing them is out of scope for
+this example:
For the first two arms, the patterns are the literal values 3 and 7. For
+the last arm that covers every other possible value, the pattern is the
+variable we’ve chosen to name other. The code that runs for the other arm
+uses the variable by passing it to the move_player function.
+
This code compiles, even though we haven’t listed all the possible values a
+u8 can have, because the last pattern will match all values not specifically
+listed. This catch-all pattern meets the requirement that match must be
+exhaustive. Note that we have to put the catch-all arm last because the
+patterns are evaluated in order. If we put the catch-all arm earlier, the other
+arms would never run, so Rust will warn us if we add arms after a catch-all!
+
Rust also has a pattern we can use when we want a catch-all but don’t want to
+use the value in the catch-all pattern: _ is a special pattern that matches
+any value and does not bind to that value. This tells Rust we aren’t going to
+use the value, so Rust won’t warn us about an unused variable.
+
Let’s change the rules of the game: now, if you roll anything other than a 3 or
+a 7, you must roll again. We no longer need to use the catch-all value, so we
+can change our code to use _ instead of the variable named other:
This example also meets the exhaustiveness requirement because we’re explicitly
+ignoring all other values in the last arm; we haven’t forgotten anything.
+
Finally, we’ll change the rules of the game one more time so that nothing else
+happens on your turn if you roll anything other than a 3 or a 7. We can express
+that by using the unit value (the empty tuple type we mentioned in “The Tuple
+Type” section) as the code that goes with the _ arm:
Here, we’re telling Rust explicitly that we aren’t going to use any other value
+that doesn’t match a pattern in an earlier arm, and we don’t want to run any
+code in this case.
+
There’s more about patterns and matching that we’ll cover in Chapter
+18. For now, we’re going to move on to the
+if let syntax, which can be useful in situations where the match expression
+is a bit wordy.
The if let syntax lets you combine if and let into a less verbose way to
+handle values that match one pattern while ignoring the rest. Consider the
+program in Listing 6-6 that matches on an Option<u8> value in the
+config_max variable but only wants to execute code if the value is the Some
+variant.
+
fn main() {
+ let config_max = Some(3u8);
+ match config_max {
+ Some(max) => println!("The maximum is configured to be {max}"),
+ _ => (),
+ }
+}
+
Listing 6-6: A match that only cares about executing
+code when the value is Some
+
If the value is Some, we print out the value in the Some variant by binding
+the value to the variable max in the pattern. We don’t want to do anything
+with the None value. To satisfy the match expression, we have to add _ => () after processing just one variant, which is annoying boilerplate code to
+add.
+
Instead, we could write this in a shorter way using if let. The following
+code behaves the same as the match in Listing 6-6:
+
fn main() {
+ let config_max = Some(3u8);
+ if let Some(max) = config_max {
+ println!("The maximum is configured to be {max}");
+ }
+}
+
The syntax if let takes a pattern and an expression separated by an equal
+sign. It works the same way as a match, where the expression is given to the
+match and the pattern is its first arm. In this case, the pattern is
+Some(max), and the max binds to the value inside the Some. We can then
+use max in the body of the if let block in the same way we used max in
+the corresponding match arm. The code in the if let block isn’t run if the
+value doesn’t match the pattern.
+
Using if let means less typing, less indentation, and less boilerplate code.
+However, you lose the exhaustive checking that match enforces. Choosing
+between match and if let depends on what you’re doing in your particular
+situation and whether gaining conciseness is an appropriate trade-off for
+losing exhaustive checking.
+
In other words, you can think of if let as syntax sugar for a match that
+runs code when the value matches one pattern and then ignores all other values.
+
We can include an else with an if let. The block of code that goes with the
+else is the same as the block of code that would go with the _ case in the
+match expression that is equivalent to the if let and else. Recall the
+Coin enum definition in Listing 6-4, where the Quarter variant also held a
+UsState value. If we wanted to count all non-quarter coins we see while also
+announcing the state of the quarters, we could do that with a match
+expression, like this:
If you have a situation in which your program has logic that is too verbose to
+express using a match, remember that if let is in your Rust toolbox as well.
We’ve now covered how to use enums to create custom types that can be one of a
+set of enumerated values. We’ve shown how the standard library’s Option<T>
+type helps you use the type system to prevent errors. When enum values have
+data inside them, you can use match or if let to extract and use those
+values, depending on how many cases you need to handle.
+
Your Rust programs can now express concepts in your domain using structs and
+enums. Creating custom types to use in your API ensures type safety: the
+compiler will make certain your functions only get values of the type each
+function expects.
+
In order to provide a well-organized API to your users that is straightforward
+to use and only exposes exactly what your users will need, let’s now turn to
+Rust’s modules.
As you write large programs, organizing your code will become increasingly
+important. By grouping related functionality and separating code with distinct
+features, you’ll clarify where to find code that implements a particular
+feature and where to go to change how a feature works.
+
The programs we’ve written so far have been in one module in one file. As a
+project grows, you should organize code by splitting it into multiple modules
+and then multiple files. A package can contain multiple binary crates and
+optionally one library crate. As a package grows, you can extract parts into
+separate crates that become external dependencies. This chapter covers all
+these techniques. For very large projects comprising a set of interrelated
+packages that evolve together, Cargo provides workspaces, which we’ll cover
+in the “Cargo Workspaces” section in Chapter 14.
+
We’ll also discuss encapsulating implementation details, which lets you reuse
+code at a higher level: once you’ve implemented an operation, other code can
+call your code via its public interface without having to know how the
+implementation works. The way you write code defines which parts are public for
+other code to use and which parts are private implementation details that you
+reserve the right to change. This is another way to limit the amount of detail
+you have to keep in your head.
+
A related concept is scope: the nested context in which code is written has a
+set of names that are defined as “in scope.” When reading, writing, and
+compiling code, programmers and compilers need to know whether a particular
+name at a particular spot refers to a variable, function, struct, enum, module,
+constant, or other item and what that item means. You can create scopes and
+change which names are in or out of scope. You can’t have two items with the
+same name in the same scope; tools are available to resolve name conflicts.
+
Rust has a number of features that allow you to manage your code’s
+organization, including which details are exposed, which details are private,
+and what names are in each scope in your programs. These features, sometimes
+collectively referred to as the module system, include:
+
+
Packages: A Cargo feature that lets you build, test, and share crates
+
Crates: A tree of modules that produces a library or executable
+
Modules and use: Let you control the organization, scope, and
+privacy of paths
+
Paths: A way of naming an item, such as a struct, function, or module
+
+
In this chapter, we’ll cover all these features, discuss how they interact, and
+explain how to use them to manage scope. By the end, you should have a solid
+understanding of the module system and be able to work with scopes like a pro!
The first parts of the module system we’ll cover are packages and crates.
+
A crate is the smallest amount of code that the Rust compiler considers at a
+time. Even if you run rustc rather than cargo and pass a single source code
+file (as we did all the way back in the “Writing and Running a Rust Program”
+section of Chapter 1), the compiler considers that file to be a crate. Crates
+can contain modules, and the modules may be defined in other files that get
+compiled with the crate, as we’ll see in the coming sections.
+
A crate can come in one of two forms: a binary crate or a library crate.
+Binary crates are programs you can compile to an executable that you can run,
+such as a command-line program or a server. Each must have a function called
+main that defines what happens when the executable runs. All the crates we’ve
+created so far have been binary crates.
+
Library crates don’t have a main function, and they don’t compile to an
+executable. Instead, they define functionality intended to be shared with
+multiple projects. For example, the rand crate we used in Chapter
+2 provides functionality that generates random numbers.
+Most of the time when Rustaceans say “crate”, they mean library crate, and they
+use “crate” interchangeably with the general programming concept of a “library“.
+
The crate root is a source file that the Rust compiler starts from and makes
+up the root module of your crate (we’ll explain modules in depth in the
+“Defining Modules to Control Scope and Privacy”
+section).
+
A package is a bundle of one or more crates that provides a set of
+functionality. A package contains a Cargo.toml file that describes how to
+build those crates. Cargo is actually a package that contains the binary crate
+for the command-line tool you’ve been using to build your code. The Cargo
+package also contains a library crate that the binary crate depends on. Other
+projects can depend on the Cargo library crate to use the same logic the Cargo
+command-line tool uses.
+
A crate can come in one of two forms: a binary crate or a library crate. A
+package can contain as many binary crates as you like, but at most only one
+library crate. A package must contain at least one crate, whether that’s a
+library or binary crate.
+
Let’s walk through what happens when we create a package. First we enter the
+command cargo new my-project:
+
$ cargo new my-project
+ Created binary (application) `my-project` package
+$ ls my-project
+Cargo.toml
+src
+$ ls my-project/src
+main.rs
+
+
After we run cargo new my-project, we use ls to see what Cargo creates. In
+the project directory, there’s a Cargo.toml file, giving us a package.
+There’s also a src directory that contains main.rs. Open Cargo.toml in
+your text editor, and note there’s no mention of src/main.rs. Cargo follows a
+convention that src/main.rs is the crate root of a binary crate with the same
+name as the package. Likewise, Cargo knows that if the package directory
+contains src/lib.rs, the package contains a library crate with the same name
+as the package, and src/lib.rs is its crate root. Cargo passes the crate root
+files to rustc to build the library or binary.
+
Here, we have a package that only contains src/main.rs, meaning it only
+contains a binary crate named my-project. If a package contains src/main.rs
+and src/lib.rs, it has two crates: a binary and a library, both with the same
+name as the package. A package can have multiple binary crates by placing files
+in the src/bin directory: each file will be a separate binary crate.
In this section, we’ll talk about modules and other parts of the module system,
+namely paths, which allow you to name items; the use keyword that brings a
+path into scope; and the pub keyword to make items public. We’ll also discuss
+the as keyword, external packages, and the glob operator.
Before we get to the details of modules and paths, here we provide a quick
+reference on how modules, paths, the use keyword, and the pub keyword work
+in the compiler, and how most developers organize their code. We’ll be going
+through examples of each of these rules throughout this chapter, but this is a
+great place to refer to as a reminder of how modules work.
+
+
Start from the crate root: When compiling a crate, the compiler first
+looks in the crate root file (usually src/lib.rs for a library crate or
+src/main.rs for a binary crate) for code to compile.
+
Declaring modules: In the crate root file, you can declare new modules;
+say you declare a “garden” module with mod garden;. The compiler will look
+for the module’s code in these places:
+
+
Inline, within curly brackets that replace the semicolon following mod garden
+
In the file src/garden.rs
+
In the file src/garden/mod.rs
+
+
+
Declaring submodules: In any file other than the crate root, you can
+declare submodules. For example, you might declare mod vegetables; in
+src/garden.rs. The compiler will look for the submodule’s code within the
+directory named for the parent module in these places:
+
+
Inline, directly following mod vegetables, within curly brackets instead
+of the semicolon
+
In the file src/garden/vegetables.rs
+
In the file src/garden/vegetables/mod.rs
+
+
+
Paths to code in modules: Once a module is part of your crate, you can
+refer to code in that module from anywhere else in that same crate, as long
+as the privacy rules allow, using the path to the code. For example, an
+Asparagus type in the garden vegetables module would be found at
+crate::garden::vegetables::Asparagus.
+
Private vs. public: Code within a module is private from its parent
+modules by default. To make a module public, declare it with pub mod
+instead of mod. To make items within a public module public as well, use
+pub before their declarations.
+
The use keyword: Within a scope, the use keyword creates shortcuts to
+items to reduce repetition of long paths. In any scope that can refer to
+crate::garden::vegetables::Asparagus, you can create a shortcut with use crate::garden::vegetables::Asparagus; and from then on you only need to
+write Asparagus to make use of that type in the scope.
+
+
Here, we create a binary crate named backyard that illustrates these rules.
+The crate’s directory, also named backyard, contains these files and
+directories:
Modules let us organize code within a crate for readability and easy reuse.
+Modules also allow us to control the privacy of items because code within a
+module is private by default. Private items are internal implementation details
+not available for outside use. We can choose to make modules and the items
+within them public, which exposes them to allow external code to use and depend
+on them.
+
As an example, let’s write a library crate that provides the functionality of a
+restaurant. We’ll define the signatures of functions but leave their bodies
+empty to concentrate on the organization of the code rather than the
+implementation of a restaurant.
+
In the restaurant industry, some parts of a restaurant are referred to as
+front of house and others as back of house. Front of house is where
+customers are; this encompasses where the hosts seat customers, servers take
+orders and payment, and bartenders make drinks. Back of house is where the
+chefs and cooks work in the kitchen, dishwashers clean up, and managers do
+administrative work.
+
To structure our crate in this way, we can organize its functions into nested
+modules. Create a new library named restaurant by running cargo new restaurant --lib. Then enter the code in Listing 7-1 into src/lib.rs to
+define some modules and function signatures; this code is the front of house
+section.
Listing 7-1: A front_of_house module containing other
+modules that then contain functions
+
We define a module with the mod keyword followed by the name of the module
+(in this case, front_of_house). The body of the module then goes inside curly
+brackets. Inside modules, we can place other modules, as in this case with the
+modules hosting and serving. Modules can also hold definitions for other
+items, such as structs, enums, constants, traits, and—as in Listing
+7-1—functions.
+
By using modules, we can group related definitions together and name why
+they’re related. Programmers using this code can navigate the code based on the
+groups rather than having to read through all the definitions, making it easier
+to find the definitions relevant to them. Programmers adding new functionality
+to this code would know where to place the code to keep the program organized.
+
Earlier, we mentioned that src/main.rs and src/lib.rs are called crate
+roots. The reason for their name is that the contents of either of these two
+files form a module named crate at the root of the crate’s module structure,
+known as the module tree.
+
Listing 7-2 shows the module tree for the structure in Listing 7-1.
Listing 7-2: The module tree for the code in Listing
+7-1
+
This tree shows how some of the modules nest inside other modules; for example,
+hosting nests inside front_of_house. The tree also shows that some modules
+are siblings, meaning they’re defined in the same module; hosting and
+serving are siblings defined within front_of_house. If module A is
+contained inside module B, we say that module A is the child of module B and
+that module B is the parent of module A. Notice that the entire module tree
+is rooted under the implicit module named crate.
+
The module tree might remind you of the filesystem’s directory tree on your
+computer; this is a very apt comparison! Just like directories in a filesystem,
+you use modules to organize your code. And just like files in a directory, we
+need a way to find our modules.
To show Rust where to find an item in a module tree, we use a path in the same
+way we use a path when navigating a filesystem. To call a function, we need to
+know its path.
+
A path can take two forms:
+
+
An absolute path is the full path starting from a crate root; for code
+from an external crate, the absolute path begins with the crate name, and for
+code from the current crate, it starts with the literal crate.
+
A relative path starts from the current module and uses self, super, or
+an identifier in the current module.
+
+
Both absolute and relative paths are followed by one or more identifiers
+separated by double colons (::).
+
Returning to Listing 7-1, say we want to call the add_to_waitlist function.
+This is the same as asking: what’s the path of the add_to_waitlist function?
+Listing 7-3 contains Listing 7-1 with some of the modules and functions
+removed.
+
We’ll show two ways to call the add_to_waitlist function from a new function,
+eat_at_restaurant, defined in the crate root. These paths are correct, but
+there’s another problem remaining that will prevent this example from compiling
+as is. We’ll explain why in a bit.
+
The eat_at_restaurant function is part of our library crate’s public API, so
+we mark it with the pub keyword. In the “Exposing Paths with the pub
+Keyword” section, we’ll go into more detail about pub.
Listing 7-3: Calling the add_to_waitlist function using
+absolute and relative paths
+
The first time we call the add_to_waitlist function in eat_at_restaurant,
+we use an absolute path. The add_to_waitlist function is defined in the same
+crate as eat_at_restaurant, which means we can use the crate keyword to
+start an absolute path. We then include each of the successive modules until we
+make our way to add_to_waitlist. You can imagine a filesystem with the same
+structure: we’d specify the path /front_of_house/hosting/add_to_waitlist to
+run the add_to_waitlist program; using the crate name to start from the
+crate root is like using / to start from the filesystem root in your shell.
+
The second time we call add_to_waitlist in eat_at_restaurant, we use a
+relative path. The path starts with front_of_house, the name of the module
+defined at the same level of the module tree as eat_at_restaurant. Here the
+filesystem equivalent would be using the path
+front_of_house/hosting/add_to_waitlist. Starting with a module name means
+that the path is relative.
+
Choosing whether to use a relative or absolute path is a decision you’ll make
+based on your project, and it depends on whether you’re more likely to move
+item definition code separately from or together with the code that uses the
+item. For example, if we moved the front_of_house module and the
+eat_at_restaurant function into a module named customer_experience, we’d
+need to update the absolute path to add_to_waitlist, but the relative path
+would still be valid. However, if we moved the eat_at_restaurant function
+separately into a module named dining, the absolute path to the
+add_to_waitlist call would stay the same, but the relative path would need to
+be updated. Our preference in general is to specify absolute paths because it’s
+more likely we’ll want to move code definitions and item calls independently of
+each other.
+
Let’s try to compile Listing 7-3 and find out why it won’t compile yet! The
+errors we get are shown in Listing 7-4.
+
$ cargo build
+ Compiling restaurant v0.1.0 (file:///projects/restaurant)
+error[E0603]: module `hosting` is private
+ --> src/lib.rs:9:28
+ |
+9 | crate::front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^ --------------- function `add_to_waitlist` is not publicly re-exported
+ | |
+ | private module
+ |
+note: the module `hosting` is defined here
+ --> src/lib.rs:2:5
+ |
+2 | mod hosting {
+ | ^^^^^^^^^^^
+
+error[E0603]: module `hosting` is private
+ --> src/lib.rs:12:21
+ |
+12 | front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^ --------------- function `add_to_waitlist` is not publicly re-exported
+ | |
+ | private module
+ |
+note: the module `hosting` is defined here
+ --> src/lib.rs:2:5
+ |
+2 | mod hosting {
+ | ^^^^^^^^^^^
+
+For more information about this error, try `rustc --explain E0603`.
+error: could not compile `restaurant` (lib) due to 2 previous errors
+
+
Listing 7-4: Compiler errors from building the code in
+Listing 7-3
+
The error messages say that module hosting is private. In other words, we
+have the correct paths for the hosting module and the add_to_waitlist
+function, but Rust won’t let us use them because it doesn’t have access to the
+private sections. In Rust, all items (functions, methods, structs, enums,
+modules, and constants) are private to parent modules by default. If you want
+to make an item like a function or struct private, you put it in a module.
+
Items in a parent module can’t use the private items inside child modules, but
+items in child modules can use the items in their ancestor modules. This is
+because child modules wrap and hide their implementation details, but the child
+modules can see the context in which they’re defined. To continue with our
+metaphor, think of the privacy rules as being like the back office of a
+restaurant: what goes on in there is private to restaurant customers, but
+office managers can see and do everything in the restaurant they operate.
+
Rust chose to have the module system function this way so that hiding inner
+implementation details is the default. That way, you know which parts of the
+inner code you can change without breaking outer code. However, Rust does give
+you the option to expose inner parts of child modules’ code to outer ancestor
+modules by using the pub keyword to make an item public.
Let’s return to the error in Listing 7-4 that told us the hosting module is
+private. We want the eat_at_restaurant function in the parent module to have
+access to the add_to_waitlist function in the child module, so we mark the
+hosting module with the pub keyword, as shown in Listing 7-5.
Listing 7-5: Declaring the hosting module as pub to
+use it from eat_at_restaurant
+
Unfortunately, the code in Listing 7-5 still results in compiler errors, as
+shown in Listing 7-6.
+
$ cargo build
+ Compiling restaurant v0.1.0 (file:///projects/restaurant)
+error[E0603]: function `add_to_waitlist` is private
+ --> src/lib.rs:9:37
+ |
+9 | crate::front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^^^^^^^^^ private function
+ |
+note: the function `add_to_waitlist` is defined here
+ --> src/lib.rs:3:9
+ |
+3 | fn add_to_waitlist() {}
+ | ^^^^^^^^^^^^^^^^^^^^
+
+error[E0603]: function `add_to_waitlist` is private
+ --> src/lib.rs:12:30
+ |
+12 | front_of_house::hosting::add_to_waitlist();
+ | ^^^^^^^^^^^^^^^ private function
+ |
+note: the function `add_to_waitlist` is defined here
+ --> src/lib.rs:3:9
+ |
+3 | fn add_to_waitlist() {}
+ | ^^^^^^^^^^^^^^^^^^^^
+
+For more information about this error, try `rustc --explain E0603`.
+error: could not compile `restaurant` (lib) due to 2 previous errors
+
+
Listing 7-6: Compiler errors from building the code in
+Listing 7-5
+
What happened? Adding the pub keyword in front of mod hosting makes the
+module public. With this change, if we can access front_of_house, we can
+access hosting. But the contents of hosting are still private; making the
+module public doesn’t make its contents public. The pub keyword on a module
+only lets code in its ancestor modules refer to it, not access its inner code.
+Because modules are containers, there’s not much we can do by only making the
+module public; we need to go further and choose to make one or more of the
+items within the module public as well.
+
The errors in Listing 7-6 say that the add_to_waitlist function is private.
+The privacy rules apply to structs, enums, functions, and methods as well as
+modules.
+
Let’s also make the add_to_waitlist function public by adding the pub
+keyword before its definition, as in Listing 7-7.
Listing 7-7: Adding the pub keyword to mod hosting
+and fn add_to_waitlist lets us call the function from
+eat_at_restaurant
+
Now the code will compile! To see why adding the pub keyword lets us use
+these paths in eat_at_restaurant with respect to the privacy rules, let’s look
+at the absolute and the relative paths.
+
In the absolute path, we start with crate, the root of our crate’s module
+tree. The front_of_house module is defined in the crate root. While
+front_of_house isn’t public, because the eat_at_restaurant function is
+defined in the same module as front_of_house (that is, eat_at_restaurant
+and front_of_house are siblings), we can refer to front_of_house from
+eat_at_restaurant. Next is the hosting module marked with pub. We can
+access the parent module of hosting, so we can access hosting. Finally, the
+add_to_waitlist function is marked with pub and we can access its parent
+module, so this function call works!
+
In the relative path, the logic is the same as the absolute path except for the
+first step: rather than starting from the crate root, the path starts from
+front_of_house. The front_of_house module is defined within the same module
+as eat_at_restaurant, so the relative path starting from the module in which
+eat_at_restaurant is defined works. Then, because hosting and
+add_to_waitlist are marked with pub, the rest of the path works, and this
+function call is valid!
+
If you plan on sharing your library crate so other projects can use your code,
+your public API is your contract with users of your crate that determines how
+they can interact with your code. There are many considerations around managing
+changes to your public API to make it easier for people to depend on your
+crate. These considerations are out of the scope of this book; if you’re
+interested in this topic, see The Rust API Guidelines.
We mentioned that a package can contain both a src/main.rs binary crate
+root as well as a src/lib.rs library crate root, and both crates will have
+the package name by default. Typically, packages with this pattern of
+containing both a library and a binary crate will have just enough code in the
+binary crate to start an executable that calls code within the library crate.
+This lets other projects benefit from most of the functionality that the
+package provides because the library crate’s code can be shared.
+
The module tree should be defined in src/lib.rs. Then, any public items can
+be used in the binary crate by starting paths with the name of the package.
+The binary crate becomes a user of the library crate just like a completely
+external crate would use the library crate: it can only use the public API.
+This helps you design a good API; not only are you the author, you’re also a
+client!
+
In Chapter 12, we’ll demonstrate this organizational
+practice with a command-line program that will contain both a binary crate
+and a library crate.
We can construct relative paths that begin in the parent module, rather than
+the current module or the crate root, by using super at the start of the
+path. This is like starting a filesystem path with the .. syntax. Using
+super allows us to reference an item that we know is in the parent module,
+which can make rearranging the module tree easier when the module is closely
+related to the parent but the parent might be moved elsewhere in the module
+tree someday.
+
Consider the code in Listing 7-8 that models the situation in which a chef
+fixes an incorrect order and personally brings it out to the customer. The
+function fix_incorrect_order defined in the back_of_house module calls the
+function deliver_order defined in the parent module by specifying the path to
+deliver_order, starting with super.
Listing 7-8: Calling a function using a relative path
+starting with super
+
The fix_incorrect_order function is in the back_of_house module, so we can
+use super to go to the parent module of back_of_house, which in this case
+is crate, the root. From there, we look for deliver_order and find it.
+Success! We think the back_of_house module and the deliver_order function
+are likely to stay in the same relationship to each other and get moved
+together should we decide to reorganize the crate’s module tree. Therefore, we
+used super so we’ll have fewer places to update code in the future if this
+code gets moved to a different module.
We can also use pub to designate structs and enums as public, but there are a
+few extra details to the usage of pub with structs and enums. If we use pub
+before a struct definition, we make the struct public, but the struct’s fields
+will still be private. We can make each field public or not on a case-by-case
+basis. In Listing 7-9, we’ve defined a public back_of_house::Breakfast struct
+with a public toast field but a private seasonal_fruit field. This models
+the case in a restaurant where the customer can pick the type of bread that
+comes with a meal, but the chef decides which fruit accompanies the meal based
+on what’s in season and in stock. The available fruit changes quickly, so
+customers can’t choose the fruit or even see which fruit they’ll get.
+
Filename: src/lib.rs
+
mod back_of_house {
+ pub struct Breakfast {
+ pub toast: String,
+ seasonal_fruit: String,
+ }
+
+ impl Breakfast {
+ pub fn summer(toast: &str) -> Breakfast {
+ Breakfast {
+ toast: String::from(toast),
+ seasonal_fruit: String::from("peaches"),
+ }
+ }
+ }
+}
+
+pub fn eat_at_restaurant() {
+ // Order a breakfast in the summer with Rye toast
+ let mut meal = back_of_house::Breakfast::summer("Rye");
+ // Change our mind about what bread we'd like
+ meal.toast = String::from("Wheat");
+ println!("I'd like {} toast please", meal.toast);
+
+ // The next line won't compile if we uncomment it; we're not allowed
+ // to see or modify the seasonal fruit that comes with the meal
+ // meal.seasonal_fruit = String::from("blueberries");
+}
+
Listing 7-9: A struct with some public fields and some
+private fields
+
Because the toast field in the back_of_house::Breakfast struct is public,
+in eat_at_restaurant we can write and read to the toast field using dot
+notation. Notice that we can’t use the seasonal_fruit field in
+eat_at_restaurant, because seasonal_fruit is private. Try uncommenting the
+line modifying the seasonal_fruit field value to see what error you get!
+
Also, note that because back_of_house::Breakfast has a private field, the
+struct needs to provide a public associated function that constructs an
+instance of Breakfast (we’ve named it summer here). If Breakfast didn’t
+have such a function, we couldn’t create an instance of Breakfast in
+eat_at_restaurant because we couldn’t set the value of the private
+seasonal_fruit field in eat_at_restaurant.
+
In contrast, if we make an enum public, all of its variants are then public. We
+only need the pub before the enum keyword, as shown in Listing 7-10.
Listing 7-10: Designating an enum as public makes all its
+variants public
+
Because we made the Appetizer enum public, we can use the Soup and Salad
+variants in eat_at_restaurant.
+
Enums aren’t very useful unless their variants are public; it would be annoying
+to have to annotate all enum variants with pub in every case, so the default
+for enum variants is to be public. Structs are often useful without their
+fields being public, so struct fields follow the general rule of everything
+being private by default unless annotated with pub.
+
There’s one more situation involving pub that we haven’t covered, and that is
+our last module system feature: the use keyword. We’ll cover use by itself
+first, and then we’ll show how to combine pub and use.
Having to write out the paths to call functions can feel inconvenient and
+repetitive. In Listing 7-7, whether we chose the absolute or relative path to
+the add_to_waitlist function, every time we wanted to call add_to_waitlist
+we had to specify front_of_house and hosting too. Fortunately, there’s a
+way to simplify this process: we can create a shortcut to a path with the use
+keyword once, and then use the shorter name everywhere else in the scope.
+
In Listing 7-11, we bring the crate::front_of_house::hosting module into the
+scope of the eat_at_restaurant function so we only have to specify
+hosting::add_to_waitlist to call the add_to_waitlist function in
+eat_at_restaurant.
Listing 7-11: Bringing a module into scope with
+use
+
Adding use and a path in a scope is similar to creating a symbolic link in
+the filesystem. By adding use crate::front_of_house::hosting in the crate
+root, hosting is now a valid name in that scope, just as though the hosting
+module had been defined in the crate root. Paths brought into scope with use
+also check privacy, like any other paths.
+
Note that use only creates the shortcut for the particular scope in which the
+use occurs. Listing 7-12 moves the eat_at_restaurant function into a new
+child module named customer, which is then a different scope than the use
+statement, so the function body won’t compile.
Listing 7-12: A use statement only applies in the scope
+it’s in
+
The compiler error shows that the shortcut no longer applies within the
+customer module:
+
$ cargo build
+ Compiling restaurant v0.1.0 (file:///projects/restaurant)
+error[E0433]: failed to resolve: use of undeclared crate or module `hosting`
+ --> src/lib.rs:11:9
+ |
+11 | hosting::add_to_waitlist();
+ | ^^^^^^^ use of undeclared crate or module `hosting`
+ |
+help: consider importing this module through its public re-export
+ |
+10 + use crate::hosting;
+ |
+
+warning: unused import: `crate::front_of_house::hosting`
+ --> src/lib.rs:7:5
+ |
+7 | use crate::front_of_house::hosting;
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: `#[warn(unused_imports)]` on by default
+
+For more information about this error, try `rustc --explain E0433`.
+warning: `restaurant` (lib) generated 1 warning
+error: could not compile `restaurant` (lib) due to 1 previous error; 1 warning emitted
+
+
Notice there’s also a warning that the use is no longer used in its scope! To
+fix this problem, move the use within the customer module too, or reference
+the shortcut in the parent module with super::hosting within the child
+customer module.
In Listing 7-11, you might have wondered why we specified use crate::front_of_house::hosting and then called hosting::add_to_waitlist in
+eat_at_restaurant, rather than specifying the use path all the way out to
+the add_to_waitlist function to achieve the same result, as in Listing 7-13.
Listing 7-13: Bringing the add_to_waitlist function
+into scope with use, which is unidiomatic
+
Although both Listing 7-11 and Listing 7-13 accomplish the same task, Listing
+7-11 is the idiomatic way to bring a function into scope with use. Bringing
+the function’s parent module into scope with use means we have to specify the
+parent module when calling the function. Specifying the parent module when
+calling the function makes it clear that the function isn’t locally defined
+while still minimizing repetition of the full path. The code in Listing 7-13 is
+unclear as to where add_to_waitlist is defined.
+
On the other hand, when bringing in structs, enums, and other items with use,
+it’s idiomatic to specify the full path. Listing 7-14 shows the idiomatic way
+to bring the standard library’s HashMap struct into the scope of a binary
+crate.
+
Filename: src/main.rs
+
use std::collections::HashMap;
+
+fn main() {
+ let mut map = HashMap::new();
+ map.insert(1, 2);
+}
+
Listing 7-14: Bringing HashMap into scope in an
+idiomatic way
+
There’s no strong reason behind this idiom: it’s just the convention that has
+emerged, and folks have gotten used to reading and writing Rust code this way.
+
The exception to this idiom is if we’re bringing two items with the same name
+into scope with use statements, because Rust doesn’t allow that. Listing 7-15
+shows how to bring two Result types into scope that have the same name but
+different parent modules, and how to refer to them.
Listing 7-15: Bringing two types with the same name into
+the same scope requires using their parent modules.
+
As you can see, using the parent modules distinguishes the two Result types.
+If instead we specified use std::fmt::Result and use std::io::Result, we’d
+have two Result types in the same scope, and Rust wouldn’t know which one we
+meant when we used Result.
There’s another solution to the problem of bringing two types of the same name
+into the same scope with use: after the path, we can specify as and a new
+local name, or alias, for the type. Listing 7-16 shows another way to write
+the code in Listing 7-15 by renaming one of the two Result types using as.
+
Filename: src/lib.rs
+
use std::fmt::Result;
+use std::io::Result as IoResult;
+
+fn function1() -> Result {
+ // --snip--
+ Ok(())
+}
+
+fn function2() -> IoResult<()> {
+ // --snip--
+ Ok(())
+}
+
Listing 7-16: Renaming a type when it’s brought into
+scope with the as keyword
+
In the second use statement, we chose the new name IoResult for the
+std::io::Result type, which won’t conflict with the Result from std::fmt
+that we’ve also brought into scope. Listing 7-15 and Listing 7-16 are
+considered idiomatic, so the choice is up to you!
When we bring a name into scope with the use keyword, the name available in
+the new scope is private. To enable the code that calls our code to refer to
+that name as if it had been defined in that code’s scope, we can combine pub
+and use. This technique is called re-exporting because we’re bringing an
+item into scope but also making that item available for others to bring into
+their scope.
+
Listing 7-17 shows the code in Listing 7-11 with use in the root module
+changed to pub use.
+
Filename: src/lib.rs
+
mod front_of_house {
+ pub mod hosting {
+ pub fn add_to_waitlist() {}
+ }
+}
+
+pub use crate::front_of_house::hosting;
+
+pub fn eat_at_restaurant() {
+ hosting::add_to_waitlist();
+}
+
Listing 7-17: Making a name available for any code to use
+from a new scope with pub use
+
Before this change, external code would have to call the add_to_waitlist
+function by using the path
+restaurant::front_of_house::hosting::add_to_waitlist(), which also would have
+required the front_of_house module to be marked as pub. Now that this pub use has re-exported the hosting module from the root module, external code
+can use the path restaurant::hosting::add_to_waitlist() instead.
+
Re-exporting is useful when the internal structure of your code is different
+from how programmers calling your code would think about the domain. For
+example, in this restaurant metaphor, the people running the restaurant think
+about “front of house” and “back of house.” But customers visiting a restaurant
+probably won’t think about the parts of the restaurant in those terms. With
+pub use, we can write our code with one structure but expose a different
+structure. Doing so makes our library well organized for programmers working on
+the library and programmers calling the library. We’ll look at another example
+of pub use and how it affects your crate’s documentation in the “Exporting a
+Convenient Public API with pub use” section of
+Chapter 14.
In Chapter 2, we programmed a guessing game project that used an external
+package called rand to get random numbers. To use rand in our project, we
+added this line to Cargo.toml:
+
+
Filename: Cargo.toml
+
rand = "0.8.5"
+
+
Adding rand as a dependency in Cargo.toml tells Cargo to download the
+rand package and any dependencies from crates.io and
+make rand available to our project.
+
Then, to bring rand definitions into the scope of our package, we added a
+use line starting with the name of the crate, rand, and listed the items
+we wanted to bring into scope. Recall that in the “Generating a Random
+Number” section in Chapter 2, we brought the Rng trait
+into scope and called the rand::thread_rng function:
+
use std::io;
+use rand::Rng;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+}
+
Members of the Rust community have made many packages available at
+crates.io, and pulling any of them into your package
+involves these same steps: listing them in your package’s Cargo.toml file and
+using use to bring items from their crates into scope.
+
Note that the standard std library is also a crate that’s external to our
+package. Because the standard library is shipped with the Rust language, we
+don’t need to change Cargo.toml to include std. But we do need to refer to
+it with use to bring items from there into our package’s scope. For example,
+with HashMap we would use this line:
If we’re using multiple items defined in the same crate or same module, listing
+each item on its own line can take up a lot of vertical space in our files. For
+example, these two use statements we had in the guessing game in Listing 2-4
+bring items from std into scope:
+
Filename: src/main.rs
+
use rand::Rng;
+// --snip--
+use std::cmp::Ordering;
+use std::io;
+// --snip--
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+
Instead, we can use nested paths to bring the same items into scope in one
+line. We do this by specifying the common part of the path, followed by two
+colons, and then curly brackets around a list of the parts of the paths that
+differ, as shown in Listing 7-18.
+
Filename: src/main.rs
+
use rand::Rng;
+// --snip--
+use std::{cmp::Ordering, io};
+// --snip--
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ println!("The secret number is: {secret_number}");
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: u32 = guess.trim().parse().expect("Please type a number!");
+
+ println!("You guessed: {guess}");
+
+ match guess.cmp(&secret_number) {
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => println!("You win!"),
+ }
+}
+
Listing 7-18: Specifying a nested path to bring multiple
+items with the same prefix into scope
+
In bigger programs, bringing many items into scope from the same crate or
+module using nested paths can reduce the number of separate use statements
+needed by a lot!
+
We can use a nested path at any level in a path, which is useful when combining
+two use statements that share a subpath. For example, Listing 7-19 shows two
+use statements: one that brings std::io into scope and one that brings
+std::io::Write into scope.
+
Filename: src/lib.rs
+
use std::io;
+use std::io::Write;
+
Listing 7-19: Two use statements where one is a subpath
+of the other
+
The common part of these two paths is std::io, and that’s the complete first
+path. To merge these two paths into one use statement, we can use self in
+the nested path, as shown in Listing 7-20.
+
Filename: src/lib.rs
+
use std::io::{self, Write};
+
Listing 7-20: Combining the paths in Listing 7-19 into
+one use statement
+
This line brings std::io and std::io::Write into scope.
This use statement brings all public items defined in std::collections into
+the current scope. Be careful when using the glob operator! Glob can make it
+harder to tell what names are in scope and where a name used in your program
+was defined.
+
The glob operator is often used when testing to bring everything under test
+into the tests module; we’ll talk about that in the “How to Write
+Tests” section in Chapter 11. The glob operator
+is also sometimes used as part of the prelude pattern: see the standard
+library documentation
+for more information on that pattern.
So far, all the examples in this chapter defined multiple modules in one file.
+When modules get large, you might want to move their definitions to a separate
+file to make the code easier to navigate.
+
For example, let’s start from the code in Listing 7-17 that had multiple
+restaurant modules. We’ll extract modules into files instead of having all the
+modules defined in the crate root file. In this case, the crate root file is
+src/lib.rs, but this procedure also works with binary crates whose crate root
+file is src/main.rs.
+
First we’ll extract the front_of_house module to its own file. Remove the
+code inside the curly brackets for the front_of_house module, leaving only
+the mod front_of_house; declaration, so that src/lib.rs contains the code
+shown in Listing 7-21. Note that this won’t compile until we create the
+src/front_of_house.rs file in Listing 7-22.
+
Filename: src/lib.rs
+
mod front_of_house;
+
+pub use crate::front_of_house::hosting;
+
+pub fn eat_at_restaurant() {
+ hosting::add_to_waitlist();
+}
+
Listing 7-21: Declaring the front_of_house module whose
+body will be in src/front_of_house.rs
+
Next, place the code that was in the curly brackets into a new file named
+src/front_of_house.rs, as shown in Listing 7-22. The compiler knows to look
+in this file because it came across the module declaration in the crate root
+with the name front_of_house.
+
Filename: src/front_of_house.rs
+
pub mod hosting {
+ pub fn add_to_waitlist() {}
+}
+
Listing 7-22: Definitions inside the front_of_house
+module in src/front_of_house.rs
+
Note that you only need to load a file using a mod declaration once in your
+module tree. Once the compiler knows the file is part of the project (and knows
+where in the module tree the code resides because of where you’ve put the mod
+statement), other files in your project should refer to the loaded file’s code
+using a path to where it was declared, as covered in the “Paths for Referring
+to an Item in the Module Tree” section. In other words,
+mod is not an “include” operation that you may have seen in other
+programming languages.
+
Next, we’ll extract the hosting module to its own file. The process is a bit
+different because hosting is a child module of front_of_house, not of the
+root module. We’ll place the file for hosting in a new directory that will be
+named for its ancestors in the module tree, in this case src/front_of_house.
+
To start moving hosting, we change src/front_of_house.rs to contain only
+the declaration of the hosting module:
+
Filename: src/front_of_house.rs
+
pub mod hosting;
+
Then we create a src/front_of_house directory and a hosting.rs file to
+contain the definitions made in the hosting module:
+
Filename: src/front_of_house/hosting.rs
+
pub fn add_to_waitlist() {}
+
If we instead put hosting.rs in the src directory, the compiler would
+expect the hosting.rs code to be in a hosting module declared in the crate
+root, and not declared as a child of the front_of_house module. The
+compiler’s rules for which files to check for which modules’ code mean the
+directories and files more closely match the module tree.
So far we’ve covered the most idiomatic file paths the Rust compiler uses,
+but Rust also supports an older style of file path. For a module named
+front_of_house declared in the crate root, the compiler will look for the
+module’s code in:
+
+
src/front_of_house.rs (what we covered)
+
src/front_of_house/mod.rs (older style, still supported path)
+
+
For a module named hosting that is a submodule of front_of_house, the
+compiler will look for the module’s code in:
+
+
src/front_of_house/hosting.rs (what we covered)
+
src/front_of_house/hosting/mod.rs (older style, still supported path)
+
+
If you use both styles for the same module, you’ll get a compiler error.
+Using a mix of both styles for different modules in the same project is
+allowed, but might be confusing for people navigating your project.
+
The main downside to the style that uses files named mod.rs is that your
+project can end up with many files named mod.rs, which can get confusing
+when you have them open in your editor at the same time.
+
+
We’ve moved each module’s code to a separate file, and the module tree remains
+the same. The function calls in eat_at_restaurant will work without any
+modification, even though the definitions live in different files. This
+technique lets you move modules to new files as they grow in size.
+
Note that the pub use crate::front_of_house::hosting statement in
+src/lib.rs also hasn’t changed, nor does use have any impact on what files
+are compiled as part of the crate. The mod keyword declares modules, and Rust
+looks in a file with the same name as the module for the code that goes into
+that module.
Rust lets you split a package into multiple crates and a crate into modules so
+you can refer to items defined in one module from another module. You can do
+this by specifying absolute or relative paths. These paths can be brought into
+scope with a use statement so you can use a shorter path for multiple uses of
+the item in that scope. Module code is private by default, but you can make
+definitions public by adding the pub keyword.
+
In the next chapter, we’ll look at some collection data structures in the
+standard library that you can use in your neatly organized code.
Rust’s standard library includes a number of very useful data structures called
+collections. Most other data types represent one specific value, but
+collections can contain multiple values. Unlike the built-in array and tuple
+types, the data these collections point to is stored on the heap, which means
+the amount of data does not need to be known at compile time and can grow or
+shrink as the program runs. Each kind of collection has different capabilities
+and costs, and choosing an appropriate one for your current situation is a
+skill you’ll develop over time. In this chapter, we’ll discuss three
+collections that are used very often in Rust programs:
+
+
A vector allows you to store a variable number of values next to each other.
+
A string is a collection of characters. We’ve mentioned the String type
+previously, but in this chapter we’ll talk about it in depth.
+
A hash map allows you to associate a value with a specific key. It’s a
+particular implementation of the more general data structure called a map.
+
+
To learn about the other kinds of collections provided by the standard library,
+see the documentation.
+
We’ll discuss how to create and update vectors, strings, and hash maps, as well
+as what makes each special.
The first collection type we’ll look at is Vec<T>, also known as a vector.
+Vectors allow you to store more than one value in a single data structure that
+puts all the values next to each other in memory. Vectors can only store values
+of the same type. They are useful when you have a list of items, such as the
+lines of text in a file or the prices of items in a shopping cart.
To create a new empty vector, we call the Vec::new function, as shown in
+Listing 8-1.
+
fn main() {
+ let v: Vec<i32> = Vec::new();
+}
+
Listing 8-1: Creating a new, empty vector to hold values
+of type i32
+
Note that we added a type annotation here. Because we aren’t inserting any
+values into this vector, Rust doesn’t know what kind of elements we intend to
+store. This is an important point. Vectors are implemented using generics;
+we’ll cover how to use generics with your own types in Chapter 10. For now,
+know that the Vec<T> type provided by the standard library can hold any type.
+When we create a vector to hold a specific type, we can specify the type within
+angle brackets. In Listing 8-1, we’ve told Rust that the Vec<T> in v will
+hold elements of the i32 type.
+
More often, you’ll create a Vec<T> with initial values and Rust will infer
+the type of value you want to store, so you rarely need to do this type
+annotation. Rust conveniently provides the vec! macro, which will create a
+new vector that holds the values you give it. Listing 8-2 creates a new
+Vec<i32> that holds the values 1, 2, and 3. The integer type is i32
+because that’s the default integer type, as we discussed in the “Data
+Types” section of Chapter 3.
+
fn main() {
+ let v = vec![1, 2, 3];
+}
+
Listing 8-2: Creating a new vector containing
+values
+
Because we’ve given initial i32 values, Rust can infer that the type of v
+is Vec<i32>, and the type annotation isn’t necessary. Next, we’ll look at how
+to modify a vector.
To create a vector and then add elements to it, we can use the push method,
+as shown in Listing 8-3.
+
fn main() {
+ let mut v = Vec::new();
+
+ v.push(5);
+ v.push(6);
+ v.push(7);
+ v.push(8);
+}
+
Listing 8-3: Using the push method to add values to a
+vector
+
As with any variable, if we want to be able to change its value, we need to
+make it mutable using the mut keyword, as discussed in Chapter 3. The numbers
+we place inside are all of type i32, and Rust infers this from the data, so
+we don’t need the Vec<i32> annotation.
There are two ways to reference a value stored in a vector: via indexing or by
+using the get method. In the following examples, we’ve annotated the types of
+the values that are returned from these functions for extra clarity.
+
Listing 8-4 shows both methods of accessing a value in a vector, with indexing
+syntax and the get method.
+
fn main() {
+ let v = vec![1, 2, 3, 4, 5];
+
+ let third: &i32 = &v[2];
+ println!("The third element is {third}");
+
+ let third: Option<&i32> = v.get(2);
+ match third {
+ Some(third) => println!("The third element is {third}"),
+ None => println!("There is no third element."),
+ }
+}
+
Listing 8-4: Using indexing syntax and using the get
+method to access an item in a vector
+
Note a few details here. We use the index value of 2 to get the third element
+because vectors are indexed by number, starting at zero. Using & and []
+gives us a reference to the element at the index value. When we use the get
+method with the index passed as an argument, we get an Option<&T> that we can
+use with match.
+
Rust provides these two ways to reference an element so you can choose how the
+program behaves when you try to use an index value outside the range of
+existing elements. As an example, let’s see what happens when we have a vector
+of five elements and then we try to access an element at index 100 with each
+technique, as shown in Listing 8-5.
+
fn main() {
+ let v = vec![1, 2, 3, 4, 5];
+
+ let does_not_exist = &v[100];
+ let does_not_exist = v.get(100);
+}
+
Listing 8-5: Attempting to access the element at index
+100 in a vector containing five elements
+
When we run this code, the first [] method will cause the program to panic
+because it references a nonexistent element. This method is best used when you
+want your program to crash if there’s an attempt to access an element past the
+end of the vector.
+
When the get method is passed an index that is outside the vector, it returns
+None without panicking. You would use this method if accessing an element
+beyond the range of the vector may happen occasionally under normal
+circumstances. Your code will then have logic to handle having either
+Some(&element) or None, as discussed in Chapter 6. For example, the index
+could be coming from a person entering a number. If they accidentally enter a
+number that’s too large and the program gets a None value, you could tell the
+user how many items are in the current vector and give them another chance to
+enter a valid value. That would be more user-friendly than crashing the program
+due to a typo!
+
When the program has a valid reference, the borrow checker enforces the
+ownership and borrowing rules (covered in Chapter 4) to ensure this reference
+and any other references to the contents of the vector remain valid. Recall the
+rule that states you can’t have mutable and immutable references in the same
+scope. That rule applies in Listing 8-6, where we hold an immutable reference
+to the first element in a vector and try to add an element to the end. This
+program won’t work if we also try to refer to that element later in the
+function.
+
fn main() {
+ let mut v = vec![1, 2, 3, 4, 5];
+
+ let first = &v[0];
+
+ v.push(6);
+
+ println!("The first element is: {first}");
+}
+
Listing 8-6: Attempting to add an element to a vector
+while holding a reference to an item
+
Compiling this code will result in this error:
+
$ cargo run
+ Compiling collections v0.1.0 (file:///projects/collections)
+error[E0502]: cannot borrow `v` as mutable because it is also borrowed as immutable
+ --> src/main.rs:6:5
+ |
+4 | let first = &v[0];
+ | - immutable borrow occurs here
+5 |
+6 | v.push(6);
+ | ^^^^^^^^^ mutable borrow occurs here
+7 |
+8 | println!("The first element is: {first}");
+ | ------- immutable borrow later used here
+
+For more information about this error, try `rustc --explain E0502`.
+error: could not compile `collections` (bin "collections") due to 1 previous error
+
+
The code in Listing 8-6 might look like it should work: why should a reference
+to the first element care about changes at the end of the vector? This error is
+due to the way vectors work: because vectors put the values next to each other
+in memory, adding a new element onto the end of the vector might require
+allocating new memory and copying the old elements to the new space, if there
+isn’t enough room to put all the elements next to each other where the vector
+is currently stored. In that case, the reference to the first element would be
+pointing to deallocated memory. The borrowing rules prevent programs from
+ending up in that situation.
+
+
Note: For more on the implementation details of the Vec<T> type, see “The
+Rustonomicon”.
To access each element in a vector in turn, we would iterate through all of the
+elements rather than use indices to access one at a time. Listing 8-7 shows how
+to use a for loop to get immutable references to each element in a vector of
+i32 values and print them.
+
fn main() {
+ let v = vec![100, 32, 57];
+ for i in &v {
+ println!("{i}");
+ }
+}
+
Listing 8-7: Printing each element in a vector by
+iterating over the elements using a for loop
+
We can also iterate over mutable references to each element in a mutable vector
+in order to make changes to all the elements. The for loop in Listing 8-8
+will add 50 to each element.
+
fn main() {
+ let mut v = vec![100, 32, 57];
+ for i in &mut v {
+ *i += 50;
+ }
+}
+
Listing 8-8: Iterating over mutable references to
+elements in a vector
+
To change the value that the mutable reference refers to, we have to use the
+* dereference operator to get to the value in i before we can use the +=
+operator. We’ll talk more about the dereference operator in the “Following the
+Pointer to the Value with the Dereference Operator”
+section of Chapter 15.
+
Iterating over a vector, whether immutably or mutably, is safe because of the
+borrow checker’s rules. If we attempted to insert or remove items in the for
+loop bodies in Listing 8-7 and Listing 8-8, we would get a compiler error
+similar to the one we got with the code in Listing 8-6. The reference to the
+vector that the for loop holds prevents simultaneous modification of the
+whole vector.
Vectors can only store values that are of the same type. This can be
+inconvenient; there are definitely use cases for needing to store a list of
+items of different types. Fortunately, the variants of an enum are defined
+under the same enum type, so when we need one type to represent elements of
+different types, we can define and use an enum!
+
For example, say we want to get values from a row in a spreadsheet in which
+some of the columns in the row contain integers, some floating-point numbers,
+and some strings. We can define an enum whose variants will hold the different
+value types, and all the enum variants will be considered the same type: that
+of the enum. Then we can create a vector to hold that enum and so, ultimately,
+hold different types. We’ve demonstrated this in Listing 8-9.
Listing 8-9: Defining an enum to store values of
+different types in one vector
+
Rust needs to know what types will be in the vector at compile time so it knows
+exactly how much memory on the heap will be needed to store each element. We
+must also be explicit about what types are allowed in this vector. If Rust
+allowed a vector to hold any type, there would be a chance that one or more of
+the types would cause errors with the operations performed on the elements of
+the vector. Using an enum plus a match expression means that Rust will ensure
+at compile time that every possible case is handled, as discussed in Chapter 6.
+
If you don’t know the exhaustive set of types a program will get at runtime to
+store in a vector, the enum technique won’t work. Instead, you can use a trait
+object, which we’ll cover in Chapter 17.
+
Now that we’ve discussed some of the most common ways to use vectors, be sure
+to review the API documentation for all of the many
+useful methods defined on Vec<T> by the standard library. For example, in
+addition to push, a pop method removes and returns the last element.
Like any other struct, a vector is freed when it goes out of scope, as
+annotated in Listing 8-10.
+
fn main() {
+ {
+ let v = vec![1, 2, 3, 4];
+
+ // do stuff with v
+ } // <- v goes out of scope and is freed here
+}
+
Listing 8-10: Showing where the vector and its elements
+are dropped
+
When the vector gets dropped, all of its contents are also dropped, meaning the
+integers it holds will be cleaned up. The borrow checker ensures that any
+references to contents of a vector are only used while the vector itself is
+valid.
+
Let’s move on to the next collection type: String!
We talked about strings in Chapter 4, but we’ll look at them in more depth now.
+New Rustaceans commonly get stuck on strings for a combination of three
+reasons: Rust’s propensity for exposing possible errors, strings being a more
+complicated data structure than many programmers give them credit for, and
+UTF-8. These factors combine in a way that can seem difficult when you’re
+coming from other programming languages.
+
We discuss strings in the context of collections because strings are
+implemented as a collection of bytes, plus some methods to provide useful
+functionality when those bytes are interpreted as text. In this section, we’ll
+talk about the operations on String that every collection type has, such as
+creating, updating, and reading. We’ll also discuss the ways in which String
+is different from the other collections, namely how indexing into a String is
+complicated by the differences between how people and computers interpret
+String data.
We’ll first define what we mean by the term string. Rust has only one string
+type in the core language, which is the string slice str that is usually seen
+in its borrowed form &str. In Chapter 4, we talked about string slices,
+which are references to some UTF-8 encoded string data stored elsewhere. String
+literals, for example, are stored in the program’s binary and are therefore
+string slices.
+
The String type, which is provided by Rust’s standard library rather than
+coded into the core language, is a growable, mutable, owned, UTF-8 encoded
+string type. When Rustaceans refer to “strings” in Rust, they might be
+referring to either the String or the string slice &str types, not just one
+of those types. Although this section is largely about String, both types are
+used heavily in Rust’s standard library, and both String and string slices
+are UTF-8 encoded.
Many of the same operations available with Vec<T> are available with String
+as well because String is actually implemented as a wrapper around a vector
+of bytes with some extra guarantees, restrictions, and capabilities. An example
+of a function that works the same way with Vec<T> and String is the new
+function to create an instance, shown in Listing 8-11.
+
fn main() {
+ let mut s = String::new();
+}
+
Listing 8-11: Creating a new, empty String
+
This line creates a new, empty string called s, into which we can then load
+data. Often, we’ll have some initial data with which we want to start the
+string. For that, we use the to_string method, which is available on any type
+that implements the Display trait, as string literals do. Listing 8-12 shows
+two examples.
+
fn main() {
+ let data = "initial contents";
+
+ let s = data.to_string();
+
+ // the method also works on a literal directly:
+ let s = "initial contents".to_string();
+}
+
Listing 8-12: Using the to_string method to create a
+String from a string literal
+
This code creates a string containing initial contents.
+
We can also use the function String::from to create a String from a string
+literal. The code in Listing 8-13 is equivalent to the code in Listing 8-12
+that uses to_string.
+
fn main() {
+ let s = String::from("initial contents");
+}
+
Listing 8-13: Using the String::from function to create
+a String from a string literal
+
Because strings are used for so many things, we can use many different generic
+APIs for strings, providing us with a lot of options. Some of them can seem
+redundant, but they all have their place! In this case, String::from and
+to_string do the same thing, so which one you choose is a matter of style and
+readability.
+
Remember that strings are UTF-8 encoded, so we can include any properly encoded
+data in them, as shown in Listing 8-14.
+
fn main() {
+ let hello = String::from("السلام عليكم");
+ let hello = String::from("Dobrý den");
+ let hello = String::from("Hello");
+ let hello = String::from("שלום");
+ let hello = String::from("नमस्ते");
+ let hello = String::from("こんにちは");
+ let hello = String::from("안녕하세요");
+ let hello = String::from("你好");
+ let hello = String::from("Olá");
+ let hello = String::from("Здравствуйте");
+ let hello = String::from("Hola");
+}
+
Listing 8-14: Storing greetings in different languages in
+strings
A String can grow in size and its contents can change, just like the contents
+of a Vec<T>, if you push more data into it. In addition, you can conveniently
+use the + operator or the format! macro to concatenate String values.
We can grow a String by using the push_str method to append a string slice,
+as shown in Listing 8-15.
+
fn main() {
+ let mut s = String::from("foo");
+ s.push_str("bar");
+}
+
Listing 8-15: Appending a string slice to a String
+using the push_str method
+
After these two lines, s will contain foobar. The push_str method takes a
+string slice because we don’t necessarily want to take ownership of the
+parameter. For example, in the code in Listing 8-16, we want to be able to use
+s2 after appending its contents to s1.
+
fn main() {
+ let mut s1 = String::from("foo");
+ let s2 = "bar";
+ s1.push_str(s2);
+ println!("s2 is {s2}");
+}
+
Listing 8-16: Using a string slice after appending its
+contents to a String
+
If the push_str method took ownership of s2, we wouldn’t be able to print
+its value on the last line. However, this code works as we’d expect!
+
The push method takes a single character as a parameter and adds it to the
+String. Listing 8-17 adds the letter l to a String using the push
+method.
+
fn main() {
+ let mut s = String::from("lo");
+ s.push('l');
+}
+
Listing 8-17: Adding one character to a String value
+using push
Often, you’ll want to combine two existing strings. One way to do so is to use
+the + operator, as shown in Listing 8-18.
+
fn main() {
+ let s1 = String::from("Hello, ");
+ let s2 = String::from("world!");
+ let s3 = s1 + &s2; // note s1 has been moved here and can no longer be used
+}
+
Listing 8-18: Using the + operator to combine two
+String values into a new String value
+
The string s3 will contain Hello, world!. The reason s1 is no longer
+valid after the addition, and the reason we used a reference to s2, has to do
+with the signature of the method that’s called when we use the + operator.
+The + operator uses the add method, whose signature looks something like
+this:
+
fn add(self, s: &str) -> String {
+
In the standard library, you’ll see add defined using generics and associated
+types. Here, we’ve substituted in concrete types, which is what happens when we
+call this method with String values. We’ll discuss generics in Chapter 10.
+This signature gives us the clues we need in order to understand the tricky
+bits of the + operator.
+
First, s2 has an &, meaning that we’re adding a reference of the second
+string to the first string. This is because of the s parameter in the add
+function: we can only add a &str to a String; we can’t add two String
+values together. But wait—the type of &s2 is &String, not &str, as
+specified in the second parameter to add. So why does Listing 8-18 compile?
+
The reason we’re able to use &s2 in the call to add is that the compiler
+can coerce the &String argument into a &str. When we call the add
+method, Rust uses a deref coercion, which here turns &s2 into &s2[..].
+We’ll discuss deref coercion in more depth in Chapter 15. Because add does
+not take ownership of the s parameter, s2 will still be a valid String
+after this operation.
+
Second, we can see in the signature that add takes ownership of self
+because self does not have an &. This means s1 in Listing 8-18 will be
+moved into the add call and will no longer be valid after that. So, although
+let s3 = s1 + &s2; looks like it will copy both strings and create a new one,
+this statement actually takes ownership of s1, appends a copy of the contents
+of s2, and then returns ownership of the result. In other words, it looks
+like it’s making a lot of copies, but it isn’t; the implementation is more
+efficient than copying.
+
If we need to concatenate multiple strings, the behavior of the + operator
+gets unwieldy:
+
fn main() {
+ let s1 = String::from("tic");
+ let s2 = String::from("tac");
+ let s3 = String::from("toe");
+
+ let s = s1 + "-" + &s2 + "-" + &s3;
+}
+
At this point, s will be tic-tac-toe. With all of the + and "
+characters, it’s difficult to see what’s going on. For combining strings in
+more complicated ways, we can instead use the format! macro:
+
fn main() {
+ let s1 = String::from("tic");
+ let s2 = String::from("tac");
+ let s3 = String::from("toe");
+
+ let s = format!("{s1}-{s2}-{s3}");
+}
+
This code also sets s to tic-tac-toe. The format! macro works like
+println!, but instead of printing the output to the screen, it returns a
+String with the contents. The version of the code using format! is much
+easier to read, and the code generated by the format! macro uses references
+so that this call doesn’t take ownership of any of its parameters.
In many other programming languages, accessing individual characters in a
+string by referencing them by index is a valid and common operation. However,
+if you try to access parts of a String using indexing syntax in Rust, you’ll
+get an error. Consider the invalid code in Listing 8-19.
+
fn main() {
+ let s1 = String::from("hello");
+ let h = s1[0];
+}
+
Listing 8-19: Attempting to use indexing syntax with a
+String
+
This code will result in the following error:
+
$ cargo run
+ Compiling collections v0.1.0 (file:///projects/collections)
+error[E0277]: the type `str` cannot be indexed by `{integer}`
+ --> src/main.rs:3:16
+ |
+3 | let h = s1[0];
+ | ^ string indices are ranges of `usize`
+ |
+ = help: the trait `SliceIndex<str>` is not implemented for `{integer}`, which is required by `String: Index<_>`
+ = note: you can use `.chars().nth()` or `.bytes().nth()`
+ for more information, see chapter 8 in The Book: <https://doc.rust-lang.org/book/ch08-02-strings.html#indexing-into-strings>
+ = help: the trait `SliceIndex<[_]>` is implemented for `usize`
+ = help: for that trait implementation, expected `[_]`, found `str`
+ = note: required for `String` to implement `Index<{integer}>`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `collections` (bin "collections") due to 1 previous error
+
+
The error and the note tell the story: Rust strings don’t support indexing. But
+why not? To answer that question, we need to discuss how Rust stores strings in
+memory.
A String is a wrapper over a Vec<u8>. Let’s look at some of our properly
+encoded UTF-8 example strings from Listing 8-14. First, this one:
+
fn main() {
+ let hello = String::from("السلام عليكم");
+ let hello = String::from("Dobrý den");
+ let hello = String::from("Hello");
+ let hello = String::from("שלום");
+ let hello = String::from("नमस्ते");
+ let hello = String::from("こんにちは");
+ let hello = String::from("안녕하세요");
+ let hello = String::from("你好");
+ let hello = String::from("Olá");
+ let hello = String::from("Здравствуйте");
+ let hello = String::from("Hola");
+}
+
In this case, len will be 4, which means the vector storing the string
+"Hola" is 4 bytes long. Each of these letters takes one byte when encoded in
+UTF-8. The following line, however, may surprise you (note that this string
+begins with the capital Cyrillic letter Ze, not the number 3):
+
fn main() {
+ let hello = String::from("السلام عليكم");
+ let hello = String::from("Dobrý den");
+ let hello = String::from("Hello");
+ let hello = String::from("שלום");
+ let hello = String::from("नमस्ते");
+ let hello = String::from("こんにちは");
+ let hello = String::from("안녕하세요");
+ let hello = String::from("你好");
+ let hello = String::from("Olá");
+ let hello = String::from("Здравствуйте");
+ let hello = String::from("Hola");
+}
+
If you were asked how long the string is, you might say 12. In fact, Rust’s
+answer is 24: that’s the number of bytes it takes to encode “Здравствуйте” in
+UTF-8, because each Unicode scalar value in that string takes 2 bytes of
+storage. Therefore, an index into the string’s bytes will not always correlate
+to a valid Unicode scalar value. To demonstrate, consider this invalid Rust
+code:
+
let hello = "Здравствуйте";
+let answer = &hello[0];
+
You already know that answer will not be З, the first letter. When encoded
+in UTF-8, the first byte of З is 208 and the second is 151, so it would
+seem that answer should in fact be 208, but 208 is not a valid character
+on its own. Returning 208 is likely not what a user would want if they asked
+for the first letter of this string; however, that’s the only data that Rust
+has at byte index 0. Users generally don’t want the byte value returned, even
+if the string contains only Latin letters: if &"hello"[0] were valid code
+that returned the byte value, it would return 104, not h.
+
The answer, then, is that to avoid returning an unexpected value and causing
+bugs that might not be discovered immediately, Rust doesn’t compile this code
+at all and prevents misunderstandings early in the development process.
Another point about UTF-8 is that there are actually three relevant ways to
+look at strings from Rust’s perspective: as bytes, scalar values, and grapheme
+clusters (the closest thing to what we would call letters).
+
If we look at the Hindi word “नमस्ते” written in the Devanagari script, it is
+stored as a vector of u8 values that looks like this:
That’s 18 bytes and is how computers ultimately store this data. If we look at
+them as Unicode scalar values, which are what Rust’s char type is, those
+bytes look like this:
+
['न', 'म', 'स', '्', 'त', 'े']
+
+
There are six char values here, but the fourth and sixth are not letters:
+they’re diacritics that don’t make sense on their own. Finally, if we look at
+them as grapheme clusters, we’d get what a person would call the four letters
+that make up the Hindi word:
+
["न", "म", "स्", "ते"]
+
+
Rust provides different ways of interpreting the raw string data that computers
+store so that each program can choose the interpretation it needs, no matter
+what human language the data is in.
+
A final reason Rust doesn’t allow us to index into a String to get a
+character is that indexing operations are expected to always take constant time
+(O(1)). But it isn’t possible to guarantee that performance with a String,
+because Rust would have to walk through the contents from the beginning to the
+index to determine how many valid characters there were.
Indexing into a string is often a bad idea because it’s not clear what the
+return type of the string-indexing operation should be: a byte value, a
+character, a grapheme cluster, or a string slice. If you really need to use
+indices to create string slices, therefore, Rust asks you to be more specific.
+
Rather than indexing using [] with a single number, you can use [] with a
+range to create a string slice containing particular bytes:
Here, s will be a &str that contains the first four bytes of the string.
+Earlier, we mentioned that each of these characters was two bytes, which means
+s will be Зд.
+
If we were to try to slice only part of a character’s bytes with something like
+&hello[0..1], Rust would panic at runtime in the same way as if an invalid
+index were accessed in a vector:
+
$ cargo run
+ Compiling collections v0.1.0 (file:///projects/collections)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.43s
+ Running `target/debug/collections`
+thread 'main' panicked at src/main.rs:4:19:
+byte index 1 is not a char boundary; it is inside 'З' (bytes 0..2) of `Здравствуйте`
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
You should use caution when creating string slices with ranges, because doing
+so can crash your program.
The best way to operate on pieces of strings is to be explicit about whether
+you want characters or bytes. For individual Unicode scalar values, use the
+chars method. Calling chars on “Зд” separates out and returns two values of
+type char, and you can iterate over the result to access each element:
+
#![allow(unused)]
+fn main() {
+for c in "Зд".chars() {
+ println!("{c}");
+}
+}
+
This code will print the following:
+
З
+д
+
+
Alternatively, the bytes method returns each raw byte, which might be
+appropriate for your domain:
+
#![allow(unused)]
+fn main() {
+for b in "Зд".bytes() {
+ println!("{b}");
+}
+}
+
This code will print the four bytes that make up this string:
+
208
+151
+208
+180
+
+
But be sure to remember that valid Unicode scalar values may be made up of more
+than one byte.
+
Getting grapheme clusters from strings, as with the Devanagari script, is
+complex, so this functionality is not provided by the standard library. Crates
+are available on crates.io if this is the
+functionality you need.
To summarize, strings are complicated. Different programming languages make
+different choices about how to present this complexity to the programmer. Rust
+has chosen to make the correct handling of String data the default behavior
+for all Rust programs, which means programmers have to put more thought into
+handling UTF-8 data up front. This trade-off exposes more of the complexity of
+strings than is apparent in other programming languages, but it prevents you
+from having to handle errors involving non-ASCII characters later in your
+development life cycle.
+
The good news is that the standard library offers a lot of functionality built
+off the String and &str types to help handle these complex situations
+correctly. Be sure to check out the documentation for useful methods like
+contains for searching in a string and replace for substituting parts of a
+string with another string.
+
Let’s switch to something a bit less complex: hash maps!
The last of our common collections is the hash map. The type HashMap<K, V>
+stores a mapping of keys of type K to values of type V using a hashing
+function, which determines how it places these keys and values into memory.
+Many programming languages support this kind of data structure, but they often
+use a different name, such as hash, map, object, hash table,
+dictionary, or associative array, just to name a few.
+
Hash maps are useful when you want to look up data not by using an index, as
+you can with vectors, but by using a key that can be of any type. For example,
+in a game, you could keep track of each team’s score in a hash map in which
+each key is a team’s name and the values are each team’s score. Given a team
+name, you can retrieve its score.
+
We’ll go over the basic API of hash maps in this section, but many more goodies
+are hiding in the functions defined on HashMap<K, V> by the standard library.
+As always, check the standard library documentation for more information.
One way to create an empty hash map is to use new and to add elements with
+insert. In Listing 8-20, we’re keeping track of the scores of two teams whose
+names are Blue and Yellow. The Blue team starts with 10 points, and the
+Yellow team starts with 50.
Listing 8-20: Creating a new hash map and inserting some
+keys and values
+
Note that we need to first use the HashMap from the collections portion of
+the standard library. Of our three common collections, this one is the least
+often used, so it’s not included in the features brought into scope
+automatically in the prelude. Hash maps also have less support from the
+standard library; there’s no built-in macro to construct them, for example.
+
Just like vectors, hash maps store their data on the heap. This HashMap has
+keys of type String and values of type i32. Like vectors, hash maps are
+homogeneous: all of the keys must have the same type, and all of the values
+must have the same type.
We can get a value out of the hash map by providing its key to the get
+method, as shown in Listing 8-21.
+
fn main() {
+ use std::collections::HashMap;
+
+ let mut scores = HashMap::new();
+
+ scores.insert(String::from("Blue"), 10);
+ scores.insert(String::from("Yellow"), 50);
+
+ let team_name = String::from("Blue");
+ let score = scores.get(&team_name).copied().unwrap_or(0);
+}
+
Listing 8-21: Accessing the score for the Blue team
+stored in the hash map
+
Here, score will have the value that’s associated with the Blue team, and the
+result will be 10. The get method returns an Option<&V>; if there’s no
+value for that key in the hash map, get will return None. This program
+handles the Option by calling copied to get an Option<i32> rather than an
+Option<&i32>, then unwrap_or to set score to zero if scores doesn’t
+have an entry for the key.
+
We can iterate over each key–value pair in a hash map in a similar manner as we
+do with vectors, using a for loop:
+
fn main() {
+ use std::collections::HashMap;
+
+ let mut scores = HashMap::new();
+
+ scores.insert(String::from("Blue"), 10);
+ scores.insert(String::from("Yellow"), 50);
+
+ for (key, value) in &scores {
+ println!("{key}: {value}");
+ }
+}
+
This code will print each pair in an arbitrary order:
For types that implement the Copy trait, like i32, the values are copied
+into the hash map. For owned values like String, the values will be moved and
+the hash map will be the owner of those values, as demonstrated in Listing 8-22.
+
fn main() {
+ use std::collections::HashMap;
+
+ let field_name = String::from("Favorite color");
+ let field_value = String::from("Blue");
+
+ let mut map = HashMap::new();
+ map.insert(field_name, field_value);
+ // field_name and field_value are invalid at this point, try using them and
+ // see what compiler error you get!
+}
+
Listing 8-22: Showing that keys and values are owned by
+the hash map once they’re inserted
+
We aren’t able to use the variables field_name and field_value after
+they’ve been moved into the hash map with the call to insert.
+
If we insert references to values into the hash map, the values won’t be moved
+into the hash map. The values that the references point to must be valid for at
+least as long as the hash map is valid. We’ll talk more about these issues in
+the “Validating References with
+Lifetimes” section in
+Chapter 10.
Although the number of key and value pairs is growable, each unique key can
+only have one value associated with it at a time (but not vice versa: for
+example, both the Blue team and the Yellow team could have the value 10
+stored in the scores hash map).
+
When you want to change the data in a hash map, you have to decide how to
+handle the case when a key already has a value assigned. You could replace the
+old value with the new value, completely disregarding the old value. You could
+keep the old value and ignore the new value, only adding the new value if the
+key doesn’t already have a value. Or you could combine the old value and the
+new value. Let’s look at how to do each of these!
If we insert a key and a value into a hash map and then insert that same key
+with a different value, the value associated with that key will be replaced.
+Even though the code in Listing 8-23 calls insert twice, the hash map will
+only contain one key–value pair because we’re inserting the value for the Blue
+team’s key both times.
It’s common to check whether a particular key already exists in the hash map
+with a value and then to take the following actions: if the key does exist in
+the hash map, the existing value should remain the way it is; if the key
+doesn’t exist, insert it and a value for it.
+
Hash maps have a special API for this called entry that takes the key you
+want to check as a parameter. The return value of the entry method is an enum
+called Entry that represents a value that might or might not exist. Let’s say
+we want to check whether the key for the Yellow team has a value associated
+with it. If it doesn’t, we want to insert the value 50, and the same for the
+Blue team. Using the entry API, the code looks like Listing 8-24.
Listing 8-24: Using the entry method to only insert if
+the key does not already have a value
+
The or_insert method on Entry is defined to return a mutable reference to
+the value for the corresponding Entry key if that key exists, and if not, it
+inserts the parameter as the new value for this key and returns a mutable
+reference to the new value. This technique is much cleaner than writing the
+logic ourselves and, in addition, plays more nicely with the borrow checker.
+
Running the code in Listing 8-24 will print {"Yellow": 50, "Blue": 10}. The
+first call to entry will insert the key for the Yellow team with the value
+50 because the Yellow team doesn’t have a value already. The second call to
+entry will not change the hash map because the Blue team already has the
+value 10.
Another common use case for hash maps is to look up a key’s value and then
+update it based on the old value. For instance, Listing 8-25 shows code that
+counts how many times each word appears in some text. We use a hash map with
+the words as keys and increment the value to keep track of how many times we’ve
+seen that word. If it’s the first time we’ve seen a word, we’ll first insert
+the value 0.
+
fn main() {
+ use std::collections::HashMap;
+
+ let text = "hello world wonderful world";
+
+ let mut map = HashMap::new();
+
+ for word in text.split_whitespace() {
+ let count = map.entry(word).or_insert(0);
+ *count += 1;
+ }
+
+ println!("{map:?}");
+}
+
Listing 8-25: Counting occurrences of words using a hash
+map that stores words and counts
+
This code will print {"world": 2, "hello": 1, "wonderful": 1}. You might see
+the same key–value pairs printed in a different order: recall from the
+“Accessing Values in a Hash Map” section that
+iterating over a hash map happens in an arbitrary order.
+
The split_whitespace method returns an iterator over subslices, separated by
+whitespace, of the value in text. The or_insert method returns a mutable
+reference (&mut V) to the value for the specified key. Here, we store that
+mutable reference in the count variable, so in order to assign to that value,
+we must first dereference count using the asterisk (*). The mutable
+reference goes out of scope at the end of the for loop, so all of these
+changes are safe and allowed by the borrowing rules.
By default, HashMap uses a hashing function called SipHash that can provide
+resistance to denial-of-service (DoS) attacks involving hash
+tables1. This is not the fastest hashing algorithm
+available, but the trade-off for better security that comes with the drop in
+performance is worth it. If you profile your code and find that the default
+hash function is too slow for your purposes, you can switch to another function
+by specifying a different hasher. A hasher is a type that implements the
+BuildHasher trait. We’ll talk about traits and how to implement them in
+Chapter 10. You don’t necessarily have to implement
+your own hasher from scratch; crates.io
+has libraries shared by other Rust users that provide hashers implementing many
+common hashing algorithms.
Vectors, strings, and hash maps will provide a large amount of functionality
+necessary in programs when you need to store, access, and modify data. Here are
+some exercises you should now be equipped to solve:
+
+
Given a list of integers, use a vector and return the median (when sorted,
+the value in the middle position) and mode (the value that occurs most
+often; a hash map will be helpful here) of the list.
+
Convert strings to pig latin. The first consonant of each word is moved to
+the end of the word and ay is added, so first becomes irst-fay. Words
+that start with a vowel have hay added to the end instead (apple becomes
+apple-hay). Keep in mind the details about UTF-8 encoding!
+
Using a hash map and vectors, create a text interface to allow a user to add
+employee names to a department in a company; for example, “Add Sally to
+Engineering” or “Add Amir to Sales.” Then let the user retrieve a list of all
+people in a department or all people in the company by department, sorted
+alphabetically.
+
+
The standard library API documentation describes methods that vectors, strings,
+and hash maps have that will be helpful for these exercises!
+
We’re getting into more complex programs in which operations can fail, so it’s
+a perfect time to discuss error handling. We’ll do that next!
Errors are a fact of life in software, so Rust has a number of features for
+handling situations in which something goes wrong. In many cases, Rust requires
+you to acknowledge the possibility of an error and take some action before your
+code will compile. This requirement makes your program more robust by ensuring
+that you’ll discover errors and handle them appropriately before you’ve
+deployed your code to production!
+
Rust groups errors into two major categories: recoverable and unrecoverable
+errors. For a recoverable error, such as a file not found error, we most
+likely just want to report the problem to the user and retry the operation.
+Unrecoverable errors are always symptoms of bugs, such as trying to access a
+location beyond the end of an array, and so we want to immediately stop the
+program.
+
Most languages don’t distinguish between these two kinds of errors and handle
+both in the same way, using mechanisms such as exceptions. Rust doesn’t have
+exceptions. Instead, it has the type Result<T, E> for recoverable errors and
+the panic! macro that stops execution when the program encounters an
+unrecoverable error. This chapter covers calling panic! first and then talks
+about returning Result<T, E> values. Additionally, we’ll explore
+considerations when deciding whether to try to recover from an error or to stop
+execution.
Sometimes bad things happen in your code, and there’s nothing you can do about
+it. In these cases, Rust has the panic! macro. There are two ways to cause a
+panic in practice: by taking an action that causes our code to panic (such as
+accessing an array past the end) or by explicitly calling the panic! macro.
+In both cases, we cause a panic in our program. By default, these panics will
+print a failure message, unwind, clean up the stack, and quit. Via an
+environment variable, you can also have Rust display the call stack when a
+panic occurs to make it easier to track down the source of the panic.
By default, when a panic occurs the program starts unwinding, which means
+Rust walks back up the stack and cleans up the data from each function it
+encounters. However, walking back and cleaning up is a lot of work. Rust,
+therefore, allows you to choose the alternative of immediately aborting,
+which ends the program without cleaning up.
+
Memory that the program was using will then need to be cleaned up by the
+operating system. If in your project you need to make the resultant binary as
+small as possible, you can switch from unwinding to aborting upon a panic by
+adding panic = 'abort' to the appropriate [profile] sections in your
+Cargo.toml file. For example, if you want to abort on panic in release mode,
+add this:
+
[profile.release]
+panic = 'abort'
+
+
+
Let’s try calling panic! in a simple program:
+
Filename: src/main.rs
+
fn main() {
+ panic!("crash and burn");
+}
+
When you run the program, you’ll see something like this:
+
$ cargo run
+ Compiling panic v0.1.0 (file:///projects/panic)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.25s
+ Running `target/debug/panic`
+thread 'main' panicked at src/main.rs:2:5:
+crash and burn
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
The call to panic! causes the error message contained in the last two lines.
+The first line shows our panic message and the place in our source code where
+the panic occurred: src/main.rs:2:5 indicates that it’s the second line,
+fifth character of our src/main.rs file.
+
In this case, the line indicated is part of our code, and if we go to that
+line, we see the panic! macro call. In other cases, the panic! call might
+be in code that our code calls, and the filename and line number reported by
+the error message will be someone else’s code where the panic! macro is
+called, not the line of our code that eventually led to the panic! call.
+
+
+
We can use the backtrace of the functions the panic! call came from to figure
+out the part of our code that is causing the problem. To understand how to use
+a panic! backtrace, let’s look at another example and see what it’s like when
+a panic! call comes from a library because of a bug in our code instead of
+from our code calling the macro directly. Listing 9-1 has some code that
+attempts to access an index in a vector beyond the range of valid indexes.
+
Filename: src/main.rs
+
fn main() {
+ let v = vec![1, 2, 3];
+
+ v[99];
+}
+
Listing 9-1: Attempting to access an element beyond the
+end of a vector, which will cause a call to panic!
+
Here, we’re attempting to access the 100th element of our vector (which is at
+index 99 because indexing starts at zero), but the vector has only three
+elements. In this situation, Rust will panic. Using [] is supposed to return
+an element, but if you pass an invalid index, there’s no element that Rust
+could return here that would be correct.
+
In C, attempting to read beyond the end of a data structure is undefined
+behavior. You might get whatever is at the location in memory that would
+correspond to that element in the data structure, even though the memory
+doesn’t belong to that structure. This is called a buffer overread and can
+lead to security vulnerabilities if an attacker is able to manipulate the index
+in such a way as to read data they shouldn’t be allowed to that is stored after
+the data structure.
+
To protect your program from this sort of vulnerability, if you try to read an
+element at an index that doesn’t exist, Rust will stop execution and refuse to
+continue. Let’s try it and see:
+
$ cargo run
+ Compiling panic v0.1.0 (file:///projects/panic)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
+ Running `target/debug/panic`
+thread 'main' panicked at src/main.rs:4:6:
+index out of bounds: the len is 3 but the index is 99
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
This error points at line 4 of our main.rs where we attempt to access index
+99 of the vector in v.
+
The note: line tells us that we can set the RUST_BACKTRACE environment
+variable to get a backtrace of exactly what happened to cause the error. A
+backtrace is a list of all the functions that have been called to get to this
+point. Backtraces in Rust work as they do in other languages: the key to
+reading the backtrace is to start from the top and read until you see files you
+wrote. That’s the spot where the problem originated. The lines above that spot
+are code that your code has called; the lines below are code that called your
+code. These before-and-after lines might include core Rust code, standard
+library code, or crates that you’re using. Let’s try getting a backtrace by
+setting the RUST_BACKTRACE environment variable to any value except 0.
+Listing 9-2 shows output similar to what you’ll see.
+
+
$ RUST_BACKTRACE=1 cargo run
+thread 'main' panicked at src/main.rs:4:6:
+index out of bounds: the len is 3 but the index is 99
+stack backtrace:
+ 0: rust_begin_unwind
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/std/src/panicking.rs:645:5
+ 1: core::panicking::panic_fmt
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/panicking.rs:72:14
+ 2: core::panicking::panic_bounds_check
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/panicking.rs:208:5
+ 3: <usize as core::slice::index::SliceIndex<[T]>>::index
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/slice/index.rs:255:10
+ 4: core::slice::index::<impl core::ops::index::Index<I> for [T]>::index
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/slice/index.rs:18:9
+ 5: <alloc::vec::Vec<T,A> as core::ops::index::Index<I>>::index
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/alloc/src/vec/mod.rs:2770:9
+ 6: panic::main
+ at ./src/main.rs:4:6
+ 7: core::ops::function::FnOnce::call_once
+ at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/ops/function.rs:250:5
+note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
+
+
Listing 9-2: The backtrace generated by a call to
+panic! displayed when the environment variable RUST_BACKTRACE is set
+
That’s a lot of output! The exact output you see might be different depending
+on your operating system and Rust version. In order to get backtraces with this
+information, debug symbols must be enabled. Debug symbols are enabled by
+default when using cargo build or cargo run without the --release flag,
+as we have here.
+
In the output in Listing 9-2, line 6 of the backtrace points to the line in our
+project that’s causing the problem: line 4 of src/main.rs. If we don’t want
+our program to panic, we should start our investigation at the location pointed
+to by the first line mentioning a file we wrote. In Listing 9-1, where we
+deliberately wrote code that would panic, the way to fix the panic is to not
+request an element beyond the range of the vector indexes. When your code
+panics in the future, you’ll need to figure out what action the code is taking
+with what values to cause the panic and what the code should do instead.
+
We’ll come back to panic! and when we should and should not use panic! to
+handle error conditions in the “To panic! or Not to
+panic!” section later in this
+chapter. Next, we’ll look at how to recover from an error using Result.
Most errors aren’t serious enough to require the program to stop entirely.
+Sometimes when a function fails it’s for a reason that you can easily interpret
+and respond to. For example, if you try to open a file and that operation fails
+because the file doesn’t exist, you might want to create the file instead of
+terminating the process.
The T and E are generic type parameters: we’ll discuss generics in more
+detail in Chapter 10. What you need to know right now is that T represents
+the type of the value that will be returned in a success case within the Ok
+variant, and E represents the type of the error that will be returned in a
+failure case within the Err variant. Because Result has these generic type
+parameters, we can use the Result type and the functions defined on it in
+many different situations where the success value and error value we want to
+return may differ.
+
Let’s call a function that returns a Result value because the function could
+fail. In Listing 9-3 we try to open a file.
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file_result = File::open("hello.txt");
+}
+
Listing 9-3: Opening a file
+
The return type of File::open is a Result<T, E>. The generic parameter T
+has been filled in by the implementation of File::open with the type of the
+success value, std::fs::File, which is a file handle. The type of E used in
+the error value is std::io::Error. This return type means the call to
+File::open might succeed and return a file handle that we can read from or
+write to. The function call also might fail: for example, the file might not
+exist, or we might not have permission to access the file. The File::open
+function needs to have a way to tell us whether it succeeded or failed and at
+the same time give us either the file handle or error information. This
+information is exactly what the Result enum conveys.
+
In the case where File::open succeeds, the value in the variable
+greeting_file_result will be an instance of Ok that contains a file handle.
+In the case where it fails, the value in greeting_file_result will be an
+instance of Err that contains more information about the kind of error that
+occurred.
+
We need to add to the code in Listing 9-3 to take different actions depending
+on the value File::open returns. Listing 9-4 shows one way to handle the
+Result using a basic tool, the match expression that we discussed in
+Chapter 6.
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file_result = File::open("hello.txt");
+
+ let greeting_file = match greeting_file_result {
+ Ok(file) => file,
+ Err(error) => panic!("Problem opening the file: {error:?}"),
+ };
+}
+
Listing 9-4: Using a match expression to handle the
+Result variants that might be returned
+
Note that, like the Option enum, the Result enum and its variants have been
+brought into scope by the prelude, so we don’t need to specify Result::
+before the Ok and Err variants in the match arms.
+
When the result is Ok, this code will return the inner file value out of
+the Ok variant, and we then assign that file handle value to the variable
+greeting_file. After the match, we can use the file handle for reading or
+writing.
+
The other arm of the match handles the case where we get an Err value from
+File::open. In this example, we’ve chosen to call the panic! macro. If
+there’s no file named hello.txt in our current directory and we run this
+code, we’ll see the following output from the panic! macro:
+
$ cargo run
+ Compiling error-handling v0.1.0 (file:///projects/error-handling)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.73s
+ Running `target/debug/error-handling`
+thread 'main' panicked at src/main.rs:8:23:
+Problem opening the file: Os { code: 2, kind: NotFound, message: "No such file or directory" }
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
As usual, this output tells us exactly what has gone wrong.
The code in Listing 9-4 will panic! no matter why File::open failed.
+However, we want to take different actions for different failure reasons. If
+File::open failed because the file doesn’t exist, we want to create the file
+and return the handle to the new file. If File::open failed for any other
+reason—for example, because we didn’t have permission to open the file—we still
+want the code to panic! in the same way it did in Listing 9-4. For this, we
+add an inner match expression, shown in Listing 9-5.
+
Filename: src/main.rs
+
+
use std::fs::File;
+use std::io::ErrorKind;
+
+fn main() {
+ let greeting_file_result = File::open("hello.txt");
+
+ let greeting_file = match greeting_file_result {
+ Ok(file) => file,
+ Err(error) => match error.kind() {
+ ErrorKind::NotFound => match File::create("hello.txt") {
+ Ok(fc) => fc,
+ Err(e) => panic!("Problem creating the file: {e:?}"),
+ },
+ other_error => {
+ panic!("Problem opening the file: {other_error:?}");
+ }
+ },
+ };
+}
+
Listing 9-5: Handling different kinds of errors in
+different ways
+
The type of the value that File::open returns inside the Err variant is
+io::Error, which is a struct provided by the standard library. This struct
+has a method kind that we can call to get an io::ErrorKind value. The enum
+io::ErrorKind is provided by the standard library and has variants
+representing the different kinds of errors that might result from an io
+operation. The variant we want to use is ErrorKind::NotFound, which indicates
+the file we’re trying to open doesn’t exist yet. So we match on
+greeting_file_result, but we also have an inner match on error.kind().
+
The condition we want to check in the inner match is whether the value returned
+by error.kind() is the NotFound variant of the ErrorKind enum. If it is,
+we try to create the file with File::create. However, because File::create
+could also fail, we need a second arm in the inner match expression. When the
+file can’t be created, a different error message is printed. The second arm of
+the outer match stays the same, so the program panics on any error besides
+the missing file error.
That’s a lot of match! The match expression is very useful but also very
+much a primitive. In Chapter 13, you’ll learn about closures, which are used
+with many of the methods defined on Result<T, E>. These methods can be more
+concise than using match when handling Result<T, E> values in your code.
+
For example, here’s another way to write the same logic as shown in Listing
+9-5, this time using closures and the unwrap_or_else method:
+
+
use std::fs::File;
+use std::io::ErrorKind;
+
+fn main() {
+ let greeting_file = File::open("hello.txt").unwrap_or_else(|error| {
+ if error.kind() == ErrorKind::NotFound {
+ File::create("hello.txt").unwrap_or_else(|error| {
+ panic!("Problem creating the file: {error:?}");
+ })
+ } else {
+ panic!("Problem opening the file: {error:?}");
+ }
+ });
+}
+
Although this code has the same behavior as Listing 9-5, it doesn’t contain
+any match expressions and is cleaner to read. Come back to this example
+after you’ve read Chapter 13, and look up the unwrap_or_else method in the
+standard library documentation. Many more of these methods can clean up huge
+nested match expressions when you’re dealing with errors.
Using match works well enough, but it can be a bit verbose and doesn’t always
+communicate intent well. The Result<T, E> type has many helper methods
+defined on it to do various, more specific tasks. The unwrap method is a
+shortcut method implemented just like the match expression we wrote in
+Listing 9-4. If the Result value is the Ok variant, unwrap will return
+the value inside the Ok. If the Result is the Err variant, unwrap will
+call the panic! macro for us. Here is an example of unwrap in action:
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file = File::open("hello.txt").unwrap();
+}
+
If we run this code without a hello.txt file, we’ll see an error message from
+the panic! call that the unwrap method makes:
+
+
thread 'main' panicked at src/main.rs:4:49:
+called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }
+
+
Similarly, the expect method lets us also choose the panic! error message.
+Using expect instead of unwrap and providing good error messages can convey
+your intent and make tracking down the source of a panic easier. The syntax of
+expect looks like this:
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file = File::open("hello.txt")
+ .expect("hello.txt should be included in this project");
+}
+
We use expect in the same way as unwrap: to return the file handle or call
+the panic! macro. The error message used by expect in its call to panic!
+will be the parameter that we pass to expect, rather than the default
+panic! message that unwrap uses. Here’s what it looks like:
+
+
thread 'main' panicked at src/main.rs:5:10:
+hello.txt should be included in this project: Os { code: 2, kind: NotFound, message: "No such file or directory" }
+
+
In production-quality code, most Rustaceans choose expect rather than
+unwrap and give more context about why the operation is expected to always
+succeed. That way, if your assumptions are ever proven wrong, you have more
+information to use in debugging.
When a function’s implementation calls something that might fail, instead of
+handling the error within the function itself you can return the error to the
+calling code so that it can decide what to do. This is known as propagating
+the error and gives more control to the calling code, where there might be more
+information or logic that dictates how the error should be handled than what
+you have available in the context of your code.
+
For example, Listing 9-6 shows a function that reads a username from a file. If
+the file doesn’t exist or can’t be read, this function will return those errors
+to the code that called the function.
Listing 9-6: A function that returns errors to the
+calling code using match
+
This function can be written in a much shorter way, but we’re going to start by
+doing a lot of it manually in order to explore error handling; at the end,
+we’ll show the shorter way. Let’s look at the return type of the function
+first: Result<String, io::Error>. This means the function is returning a
+value of the type Result<T, E>, where the generic parameter T has been
+filled in with the concrete type String and the generic type E has been
+filled in with the concrete type io::Error.
+
If this function succeeds without any problems, the code that calls this
+function will receive an Ok value that holds a String—the username that
+this function read from the file. If this function encounters any problems, the
+calling code will receive an Err value that holds an instance of io::Error
+that contains more information about what the problems were. We chose
+io::Error as the return type of this function because that happens to be the
+type of the error value returned from both of the operations we’re calling in
+this function’s body that might fail: the File::open function and the
+read_to_string method.
+
The body of the function starts by calling the File::open function. Then we
+handle the Result value with a match similar to the match in Listing 9-4.
+If File::open succeeds, the file handle in the pattern variable file
+becomes the value in the mutable variable username_file and the function
+continues. In the Err case, instead of calling panic!, we use the return
+keyword to return early out of the function entirely and pass the error value
+from File::open, now in the pattern variable e, back to the calling code as
+this function’s error value.
+
So, if we have a file handle in username_file, the function then creates a
+new String in variable username and calls the read_to_string method on
+the file handle in username_file to read the contents of the file into
+username. The read_to_string method also returns a Result because it
+might fail, even though File::open succeeded. So we need another match to
+handle that Result: if read_to_string succeeds, then our function has
+succeeded, and we return the username from the file that’s now in username
+wrapped in an Ok. If read_to_string fails, we return the error value in the
+same way that we returned the error value in the match that handled the
+return value of File::open. However, we don’t need to explicitly say
+return, because this is the last expression in the function.
+
The code that calls this code will then handle getting either an Ok value
+that contains a username or an Err value that contains an io::Error. It’s
+up to the calling code to decide what to do with those values. If the calling
+code gets an Err value, it could call panic! and crash the program, use a
+default username, or look up the username from somewhere other than a file, for
+example. We don’t have enough information on what the calling code is actually
+trying to do, so we propagate all the success or error information upward for
+it to handle appropriately.
+
This pattern of propagating errors is so common in Rust that Rust provides the
+question mark operator ? to make this easier.
Listing 9-7 shows an implementation of read_username_from_file that has the
+same functionality as in Listing 9-6, but this implementation uses the ?
+operator.
Listing 9-7: A function that returns errors to the
+calling code using the ? operator
+
The ? placed after a Result value is defined to work in almost the same way
+as the match expressions we defined to handle the Result values in Listing
+9-6. If the value of the Result is an Ok, the value inside the Ok will
+get returned from this expression, and the program will continue. If the value
+is an Err, the Err will be returned from the whole function as if we had
+used the return keyword so the error value gets propagated to the calling
+code.
+
There is a difference between what the match expression from Listing 9-6 does
+and what the ? operator does: error values that have the ? operator called
+on them go through the from function, defined in the From trait in the
+standard library, which is used to convert values from one type into another.
+When the ? operator calls the from function, the error type received is
+converted into the error type defined in the return type of the current
+function. This is useful when a function returns one error type to represent
+all the ways a function might fail, even if parts might fail for many different
+reasons.
+
For example, we could change the read_username_from_file function in Listing
+9-7 to return a custom error type named OurError that we define. If we also
+define impl From<io::Error> for OurError to construct an instance of
+OurError from an io::Error, then the ? operator calls in the body of
+read_username_from_file will call from and convert the error types without
+needing to add any more code to the function.
+
In the context of Listing 9-7, the ? at the end of the File::open call will
+return the value inside an Ok to the variable username_file. If an error
+occurs, the ? operator will return early out of the whole function and give
+any Err value to the calling code. The same thing applies to the ? at the
+end of the read_to_string call.
+
The ? operator eliminates a lot of boilerplate and makes this function’s
+implementation simpler. We could even shorten this code further by chaining
+method calls immediately after the ?, as shown in Listing 9-8.
Listing 9-8: Chaining method calls after the ?
+operator
+
We’ve moved the creation of the new String in username to the beginning of
+the function; that part hasn’t changed. Instead of creating a variable
+username_file, we’ve chained the call to read_to_string directly onto the
+result of File::open("hello.txt")?. We still have a ? at the end of the
+read_to_string call, and we still return an Ok value containing username
+when both File::open and read_to_string succeed rather than returning
+errors. The functionality is again the same as in Listing 9-6 and Listing 9-7;
+this is just a different, more ergonomic way to write it.
+
Listing 9-9 shows a way to make this even shorter using fs::read_to_string.
Listing 9-9: Using fs::read_to_string instead of
+opening and then reading the file
+
Reading a file into a string is a fairly common operation, so the standard
+library provides the convenient fs::read_to_string function that opens the
+file, creates a new String, reads the contents of the file, puts the contents
+into that String, and returns it. Of course, using fs::read_to_string
+doesn’t give us the opportunity to explain all the error handling, so we did it
+the longer way first.
The ? operator can only be used in functions whose return type is compatible
+with the value the ? is used on. This is because the ? operator is defined
+to perform an early return of a value out of the function, in the same manner
+as the match expression we defined in Listing 9-6. In Listing 9-6, the
+match was using a Result value, and the early return arm returned an
+Err(e) value. The return type of the function has to be a Result so that
+it’s compatible with this return.
+
In Listing 9-10, let’s look at the error we’ll get if we use the ? operator
+in a main function with a return type that is incompatible with the type of
+the value we use ? on.
+
Filename: src/main.rs
+
use std::fs::File;
+
+fn main() {
+ let greeting_file = File::open("hello.txt")?;
+}
+
Listing 9-10: Attempting to use the ? in the main
+function that returns () won’t compile.
+
This code opens a file, which might fail. The ? operator follows the Result
+value returned by File::open, but this main function has the return type of
+(), not Result. When we compile this code, we get the following error
+message:
+
$ cargo run
+ Compiling error-handling v0.1.0 (file:///projects/error-handling)
+error[E0277]: the `?` operator can only be used in a function that returns `Result` or `Option` (or another type that implements `FromResidual`)
+ --> src/main.rs:4:48
+ |
+3 | fn main() {
+ | --------- this function should return `Result` or `Option` to accept `?`
+4 | let greeting_file = File::open("hello.txt")?;
+ | ^ cannot use the `?` operator in a function that returns `()`
+ |
+ = help: the trait `FromResidual<Result<Infallible, std::io::Error>>` is not implemented for `()`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `error-handling` (bin "error-handling") due to 1 previous error
+
+
This error points out that we’re only allowed to use the ? operator in a
+function that returns Result, Option, or another type that implements
+FromResidual.
+
To fix the error, you have two choices. One choice is to change the return type
+of your function to be compatible with the value you’re using the ? operator
+on as long as you have no restrictions preventing that. The other choice is to
+use a match or one of the Result<T, E> methods to handle the Result<T, E>
+in whatever way is appropriate.
+
The error message also mentioned that ? can be used with Option<T> values
+as well. As with using ? on Result, you can only use ? on Option in a
+function that returns an Option. The behavior of the ? operator when called
+on an Option<T> is similar to its behavior when called on a Result<T, E>:
+if the value is None, the None will be returned early from the function at
+that point. If the value is Some, the value inside the Some is the
+resultant value of the expression, and the function continues. Listing 9-11 has
+an example of a function that finds the last character of the first line in the
+given text.
Listing 9-11: Using the ? operator on an Option<T>
+value
+
This function returns Option<char> because it’s possible that there is a
+character there, but it’s also possible that there isn’t. This code takes the
+text string slice argument and calls the lines method on it, which returns
+an iterator over the lines in the string. Because this function wants to
+examine the first line, it calls next on the iterator to get the first value
+from the iterator. If text is the empty string, this call to next will
+return None, in which case we use ? to stop and return None from
+last_char_of_first_line. If text is not the empty string, next will
+return a Some value containing a string slice of the first line in text.
+
The ? extracts the string slice, and we can call chars on that string slice
+to get an iterator of its characters. We’re interested in the last character in
+this first line, so we call last to return the last item in the iterator.
+This is an Option because it’s possible that the first line is the empty
+string; for example, if text starts with a blank line but has characters on
+other lines, as in "\nhi". However, if there is a last character on the first
+line, it will be returned in the Some variant. The ? operator in the middle
+gives us a concise way to express this logic, allowing us to implement the
+function in one line. If we couldn’t use the ? operator on Option, we’d
+have to implement this logic using more method calls or a match expression.
+
Note that you can use the ? operator on a Result in a function that returns
+Result, and you can use the ? operator on an Option in a function that
+returns Option, but you can’t mix and match. The ? operator won’t
+automatically convert a Result to an Option or vice versa; in those cases,
+you can use methods like the ok method on Result or the ok_or method on
+Option to do the conversion explicitly.
+
So far, all the main functions we’ve used return (). The main function is
+special because it’s the entry point and exit point of an executable program,
+and there are restrictions on what its return type can be for the program to
+behave as expected.
+
Luckily, main can also return a Result<(), E>. Listing 9-12 has the code
+from Listing 9-10, but we’ve changed the return type of main to be
+Result<(), Box<dyn Error>> and added a return value Ok(()) to the end. This
+code will now compile.
Listing 9-12: Changing main to return Result<(), E>
+allows the use of the ? operator on Result values.
+
The Box<dyn Error> type is a trait object, which we’ll talk about in the
+“Using Trait Objects that Allow for Values of Different
+Types” section in Chapter 17. For now, you can
+read Box<dyn Error> to mean “any kind of error.” Using ? on a Result
+value in a main function with the error type Box<dyn Error> is allowed
+because it allows any Err value to be returned early. Even though the body of
+this main function will only ever return errors of type std::io::Error, by
+specifying Box<dyn Error>, this signature will continue to be correct even if
+more code that returns other errors is added to the body of main.
+
When a main function returns a Result<(), E>, the executable will exit with
+a value of 0 if main returns Ok(()) and will exit with a nonzero value if
+main returns an Err value. Executables written in C return integers when
+they exit: programs that exit successfully return the integer 0, and programs
+that error return some integer other than 0. Rust also returns integers from
+executables to be compatible with this convention.
+
The main function may return any types that implement the
+std::process::Termination trait, which contains
+a function report that returns an ExitCode. Consult the standard library
+documentation for more information on implementing the Termination trait for
+your own types.
+
Now that we’ve discussed the details of calling panic! or returning Result,
+let’s return to the topic of how to decide which is appropriate to use in which
+cases.
So how do you decide when you should call panic! and when you should return
+Result? When code panics, there’s no way to recover. You could call panic!
+for any error situation, whether there’s a possible way to recover or not, but
+then you’re making the decision that a situation is unrecoverable on behalf of
+the calling code. When you choose to return a Result value, you give the
+calling code options. The calling code could choose to attempt to recover in a
+way that’s appropriate for its situation, or it could decide that an Err
+value in this case is unrecoverable, so it can call panic! and turn your
+recoverable error into an unrecoverable one. Therefore, returning Result is a
+good default choice when you’re defining a function that might fail.
+
In situations such as examples, prototype code, and tests, it’s more
+appropriate to write code that panics instead of returning a Result. Let’s
+explore why, then discuss situations in which the compiler can’t tell that
+failure is impossible, but you as a human can. The chapter will conclude with
+some general guidelines on how to decide whether to panic in library code.
When you’re writing an example to illustrate some concept, also including
+robust error-handling code can make the example less clear. In examples, it’s
+understood that a call to a method like unwrap that could panic is meant as a
+placeholder for the way you’d want your application to handle errors, which can
+differ based on what the rest of your code is doing.
+
Similarly, the unwrap and expect methods are very handy when prototyping,
+before you’re ready to decide how to handle errors. They leave clear markers in
+your code for when you’re ready to make your program more robust.
+
If a method call fails in a test, you’d want the whole test to fail, even if
+that method isn’t the functionality under test. Because panic! is how a test
+is marked as a failure, calling unwrap or expect is exactly what should
+happen.
It would also be appropriate to call unwrap or expect when you have some
+other logic that ensures the Result will have an Ok value, but the logic
+isn’t something the compiler understands. You’ll still have a Result value
+that you need to handle: whatever operation you’re calling still has the
+possibility of failing in general, even though it’s logically impossible in
+your particular situation. If you can ensure by manually inspecting the code
+that you’ll never have an Err variant, it’s perfectly acceptable to call
+unwrap, and even better to document the reason you think you’ll never have an
+Err variant in the expect text. Here’s an example:
+
fn main() {
+ use std::net::IpAddr;
+
+ let home: IpAddr = "127.0.0.1"
+ .parse()
+ .expect("Hardcoded IP address should be valid");
+}
+
We’re creating an IpAddr instance by parsing a hardcoded string. We can see
+that 127.0.0.1 is a valid IP address, so it’s acceptable to use expect
+here. However, having a hardcoded, valid string doesn’t change the return type
+of the parse method: we still get a Result value, and the compiler will
+still make us handle the Result as if the Err variant is a possibility
+because the compiler isn’t smart enough to see that this string is always a
+valid IP address. If the IP address string came from a user rather than being
+hardcoded into the program and therefore did have a possibility of failure,
+we’d definitely want to handle the Result in a more robust way instead.
+Mentioning the assumption that this IP address is hardcoded will prompt us to
+change expect to better error-handling code if, in the future, we need to get
+the IP address from some other source instead.
It’s advisable to have your code panic when it’s possible that your code could
+end up in a bad state. In this context, a bad state is when some assumption,
+guarantee, contract, or invariant has been broken, such as when invalid values,
+contradictory values, or missing values are passed to your code—plus one or
+more of the following:
+
+
The bad state is something that is unexpected, as opposed to something that
+will likely happen occasionally, like a user entering data in the wrong
+format.
+
Your code after this point needs to rely on not being in this bad state,
+rather than checking for the problem at every step.
+
There’s not a good way to encode this information in the types you use. We’ll
+work through an example of what we mean in the “Encoding States and Behavior
+as Types” section of Chapter 17.
+
+
If someone calls your code and passes in values that don’t make sense, it’s
+best to return an error if you can so the user of the library can decide what
+they want to do in that case. However, in cases where continuing could be
+insecure or harmful, the best choice might be to call panic! and alert the
+person using your library to the bug in their code so they can fix it during
+development. Similarly, panic! is often appropriate if you’re calling
+external code that is out of your control and it returns an invalid state that
+you have no way of fixing.
+
However, when failure is expected, it’s more appropriate to return a Result
+than to make a panic! call. Examples include a parser being given malformed
+data or an HTTP request returning a status that indicates you have hit a rate
+limit. In these cases, returning a Result indicates that failure is an
+expected possibility that the calling code must decide how to handle.
+
When your code performs an operation that could put a user at risk if it’s
+called using invalid values, your code should verify the values are valid first
+and panic if the values aren’t valid. This is mostly for safety reasons:
+attempting to operate on invalid data can expose your code to vulnerabilities.
+This is the main reason the standard library will call panic! if you attempt
+an out-of-bounds memory access: trying to access memory that doesn’t belong to
+the current data structure is a common security problem. Functions often have
+contracts: their behavior is only guaranteed if the inputs meet particular
+requirements. Panicking when the contract is violated makes sense because a
+contract violation always indicates a caller-side bug, and it’s not a kind of
+error you want the calling code to have to explicitly handle. In fact, there’s
+no reasonable way for calling code to recover; the calling programmers need
+to fix the code. Contracts for a function, especially when a violation will
+cause a panic, should be explained in the API documentation for the function.
+
However, having lots of error checks in all of your functions would be verbose
+and annoying. Fortunately, you can use Rust’s type system (and thus the type
+checking done by the compiler) to do many of the checks for you. If your
+function has a particular type as a parameter, you can proceed with your code’s
+logic knowing that the compiler has already ensured you have a valid value. For
+example, if you have a type rather than an Option, your program expects to
+have something rather than nothing. Your code then doesn’t have to handle
+two cases for the Some and None variants: it will only have one case for
+definitely having a value. Code trying to pass nothing to your function won’t
+even compile, so your function doesn’t have to check for that case at runtime.
+Another example is using an unsigned integer type such as u32, which ensures
+the parameter is never negative.
Let’s take the idea of using Rust’s type system to ensure we have a valid value
+one step further and look at creating a custom type for validation. Recall the
+guessing game in Chapter 2 in which our code asked the user to guess a number
+between 1 and 100. We never validated that the user’s guess was between those
+numbers before checking it against our secret number; we only validated that
+the guess was positive. In this case, the consequences were not very dire: our
+output of “Too high” or “Too low” would still be correct. But it would be a
+useful enhancement to guide the user toward valid guesses and have different
+behavior when the user guesses a number that’s out of range versus when the
+user types, for example, letters instead.
+
One way to do this would be to parse the guess as an i32 instead of only a
+u32 to allow potentially negative numbers, and then add a check for the
+number being in range, like so:
+
Filename: src/main.rs
+
use rand::Rng;
+use std::cmp::Ordering;
+use std::io;
+
+fn main() {
+ println!("Guess the number!");
+
+ let secret_number = rand::thread_rng().gen_range(1..=100);
+
+ loop {
+ // --snip--
+
+ println!("Please input your guess.");
+
+ let mut guess = String::new();
+
+ io::stdin()
+ .read_line(&mut guess)
+ .expect("Failed to read line");
+
+ let guess: i32 = match guess.trim().parse() {
+ Ok(num) => num,
+ Err(_) => continue,
+ };
+
+ if guess < 1 || guess > 100 {
+ println!("The secret number will be between 1 and 100.");
+ continue;
+ }
+
+ match guess.cmp(&secret_number) {
+ // --snip--
+ Ordering::Less => println!("Too small!"),
+ Ordering::Greater => println!("Too big!"),
+ Ordering::Equal => {
+ println!("You win!");
+ break;
+ }
+ }
+ }
+}
+
The if expression checks whether our value is out of range, tells the user
+about the problem, and calls continue to start the next iteration of the loop
+and ask for another guess. After the if expression, we can proceed with the
+comparisons between guess and the secret number knowing that guess is
+between 1 and 100.
+
However, this is not an ideal solution: if it were absolutely critical that the
+program only operated on values between 1 and 100, and it had many functions
+with this requirement, having a check like this in every function would be
+tedious (and might impact performance).
+
Instead, we can make a new type and put the validations in a function to create
+an instance of the type rather than repeating the validations everywhere. That
+way, it’s safe for functions to use the new type in their signatures and
+confidently use the values they receive. Listing 9-13 shows one way to define a
+Guess type that will only create an instance of Guess if the new function
+receives a value between 1 and 100.
+
Filename: src/lib.rs
+
#![allow(unused)]
+fn main() {
+pub struct Guess {
+ value: i32,
+}
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 || value > 100 {
+ panic!("Guess value must be between 1 and 100, got {value}.");
+ }
+
+ Guess { value }
+ }
+
+ pub fn value(&self) -> i32 {
+ self.value
+ }
+}
+}
+
Listing 9-13: A Guess type that will only continue with
+values between 1 and 100
+
First we define a struct named Guess that has a field named value that
+holds an i32. This is where the number will be stored.
+
Then we implement an associated function named new on Guess that creates
+instances of Guess values. The new function is defined to have one
+parameter named value of type i32 and to return a Guess. The code in the
+body of the new function tests value to make sure it’s between 1 and 100.
+If value doesn’t pass this test, we make a panic! call, which will alert
+the programmer who is writing the calling code that they have a bug they need
+to fix, because creating a Guess with a value outside this range would
+violate the contract that Guess::new is relying on. The conditions in which
+Guess::new might panic should be discussed in its public-facing API
+documentation; we’ll cover documentation conventions indicating the possibility
+of a panic! in the API documentation that you create in Chapter 14. If
+value does pass the test, we create a new Guess with its value field set
+to the value parameter and return the Guess.
+
Next, we implement a method named value that borrows self, doesn’t have any
+other parameters, and returns an i32. This kind of method is sometimes called
+a getter because its purpose is to get some data from its fields and return
+it. This public method is necessary because the value field of the Guess
+struct is private. It’s important that the value field be private so code
+using the Guess struct is not allowed to set value directly: code outside
+the module must use the Guess::new function to create an instance of
+Guess, thereby ensuring there’s no way for a Guess to have a value that
+hasn’t been checked by the conditions in the Guess::new function.
+
A function that has a parameter or returns only numbers between 1 and 100 could
+then declare in its signature that it takes or returns a Guess rather than an
+i32 and wouldn’t need to do any additional checks in its body.
Rust’s error-handling features are designed to help you write more robust code.
+The panic! macro signals that your program is in a state it can’t handle and
+lets you tell the process to stop instead of trying to proceed with invalid or
+incorrect values. The Result enum uses Rust’s type system to indicate that
+operations might fail in a way that your code could recover from. You can use
+Result to tell code that calls your code that it needs to handle potential
+success or failure as well. Using panic! and Result in the appropriate
+situations will make your code more reliable in the face of inevitable problems.
+
Now that you’ve seen useful ways that the standard library uses generics with
+the Option and Result enums, we’ll talk about how generics work and how you
+can use them in your code.
Every programming language has tools for effectively handling the duplication
+of concepts. In Rust, one such tool is generics: abstract stand-ins for
+concrete types or other properties. We can express the behavior of generics or
+how they relate to other generics without knowing what will be in their place
+when compiling and running the code.
+
Functions can take parameters of some generic type, instead of a concrete type
+like i32 or String, in the same way they take parameters with unknown
+values to run the same code on multiple concrete values. In fact, we’ve already
+used generics in Chapter 6 with Option<T>, in Chapter 8 with Vec<T> and
+HashMap<K, V>, and in Chapter 9 with Result<T, E>. In this chapter, you’ll
+explore how to define your own types, functions, and methods with generics!
+
First we’ll review how to extract a function to reduce code duplication. We’ll
+then use the same technique to make a generic function from two functions that
+differ only in the types of their parameters. We’ll also explain how to use
+generic types in struct and enum definitions.
+
Then you’ll learn how to use traits to define behavior in a generic way. You
+can combine traits with generic types to constrain a generic type to accept
+only those types that have a particular behavior, as opposed to just any type.
+
Finally, we’ll discuss lifetimes: a variety of generics that give the
+compiler information about how references relate to each other. Lifetimes allow
+us to give the compiler enough information about borrowed values so that it can
+ensure references will be valid in more situations than it could without our
+help.
Generics allow us to replace specific types with a placeholder that represents
+multiple types to remove code duplication. Before diving into generics syntax,
+let’s first look at how to remove duplication in a way that doesn’t involve
+generic types by extracting a function that replaces specific values with a
+placeholder that represents multiple values. Then we’ll apply the same
+technique to extract a generic function! By looking at how to recognize
+duplicated code you can extract into a function, you’ll start to recognize
+duplicated code that can use generics.
+
We’ll begin with the short program in Listing 10-1 that finds the largest
+number in a list.
+
Filename: src/main.rs
+
fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let mut largest = &number_list[0];
+
+ for number in &number_list {
+ if number > largest {
+ largest = number;
+ }
+ }
+
+ println!("The largest number is {largest}");
+ assert_eq!(*largest, 100);
+}
+
Listing 10-1: Finding the largest number in a list of
+numbers
+
We store a list of integers in the variable number_list and place a reference
+to the first number in the list in a variable named largest. We then iterate
+through all the numbers in the list, and if the current number is greater than
+the number stored in largest, we replace the reference in that variable.
+However, if the current number is less than or equal to the largest number seen
+so far, the variable doesn’t change, and the code moves on to the next number
+in the list. After considering all the numbers in the list, largest should
+refer to the largest number, which in this case is 100.
+
We’ve now been tasked with finding the largest number in two different lists of
+numbers. To do so, we can choose to duplicate the code in Listing 10-1 and use
+the same logic at two different places in the program, as shown in Listing 10-2.
+
Filename: src/main.rs
+
fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let mut largest = &number_list[0];
+
+ for number in &number_list {
+ if number > largest {
+ largest = number;
+ }
+ }
+
+ println!("The largest number is {largest}");
+
+ let number_list = vec![102, 34, 6000, 89, 54, 2, 43, 8];
+
+ let mut largest = &number_list[0];
+
+ for number in &number_list {
+ if number > largest {
+ largest = number;
+ }
+ }
+
+ println!("The largest number is {largest}");
+}
+
Listing 10-2: Code to find the largest number in two
+lists of numbers
+
Although this code works, duplicating code is tedious and error prone. We also
+have to remember to update the code in multiple places when we want to change
+it.
+
To eliminate this duplication, we’ll create an abstraction by defining a
+function that operates on any list of integers passed in as a parameter. This
+solution makes our code clearer and lets us express the concept of finding the
+largest number in a list abstractly.
+
In Listing 10-3, we extract the code that finds the largest number into a
+function named largest. Then we call the function to find the largest number
+in the two lists from Listing 10-2. We could also use the function on any other
+list of i32 values we might have in the future.
+
Filename: src/main.rs
+
fn largest(list: &[i32]) -> &i32 {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let result = largest(&number_list);
+ println!("The largest number is {result}");
+ assert_eq!(*result, 100);
+
+ let number_list = vec![102, 34, 6000, 89, 54, 2, 43, 8];
+
+ let result = largest(&number_list);
+ println!("The largest number is {result}");
+ assert_eq!(*result, 6000);
+}
+
Listing 10-3: Abstracted code to find the largest number
+in two lists
+
The largest function has a parameter called list, which represents any
+concrete slice of i32 values we might pass into the function. As a result,
+when we call the function, the code runs on the specific values that we pass
+in.
+
In summary, here are the steps we took to change the code from Listing 10-2 to
+Listing 10-3:
+
+
Identify duplicate code.
+
Extract the duplicate code into the body of the function, and specify the
+inputs and return values of that code in the function signature.
+
Update the two instances of duplicated code to call the function instead.
+
+
Next, we’ll use these same steps with generics to reduce code duplication. In
+the same way that the function body can operate on an abstract list instead
+of specific values, generics allow code to operate on abstract types.
+
For example, say we had two functions: one that finds the largest item in a
+slice of i32 values and one that finds the largest item in a slice of char
+values. How would we eliminate that duplication? Let’s find out!
We use generics to create definitions for items like function signatures or
+structs, which we can then use with many different concrete data types. Let’s
+first look at how to define functions, structs, enums, and methods using
+generics. Then we’ll discuss how generics affect code performance.
When defining a function that uses generics, we place the generics in the
+signature of the function where we would usually specify the data types of the
+parameters and return value. Doing so makes our code more flexible and provides
+more functionality to callers of our function while preventing code duplication.
+
Continuing with our largest function, Listing 10-4 shows two functions that
+both find the largest value in a slice. We’ll then combine these into a single
+function that uses generics.
+
Filename: src/main.rs
+
fn largest_i32(list: &[i32]) -> &i32 {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn largest_char(list: &[char]) -> &char {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let result = largest_i32(&number_list);
+ println!("The largest number is {result}");
+ assert_eq!(*result, 100);
+
+ let char_list = vec!['y', 'm', 'a', 'q'];
+
+ let result = largest_char(&char_list);
+ println!("The largest char is {result}");
+ assert_eq!(*result, 'y');
+}
+
Listing 10-4: Two functions that differ only in their
+names and in the types in their signatures
+
The largest_i32 function is the one we extracted in Listing 10-3 that finds
+the largest i32 in a slice. The largest_char function finds the largest
+char in a slice. The function bodies have the same code, so let’s eliminate
+the duplication by introducing a generic type parameter in a single function.
+
To parameterize the types in a new single function, we need to name the type
+parameter, just as we do for the value parameters to a function. You can use
+any identifier as a type parameter name. But we’ll use T because, by
+convention, type parameter names in Rust are short, often just one letter, and
+Rust’s type-naming convention is UpperCamelCase. Short for type, T is the
+default choice of most Rust programmers.
+
When we use a parameter in the body of the function, we have to declare the
+parameter name in the signature so the compiler knows what that name means.
+Similarly, when we use a type parameter name in a function signature, we have
+to declare the type parameter name before we use it. To define the generic
+largest function, we place type name declarations inside angle brackets,
+<>, between the name of the function and the parameter list, like this:
+
fn largest<T>(list: &[T]) -> &T {
+
We read this definition as: the function largest is generic over some type
+T. This function has one parameter named list, which is a slice of values
+of type T. The largest function will return a reference to a value of the
+same type T.
+
Listing 10-5 shows the combined largest function definition using the generic
+data type in its signature. The listing also shows how we can call the function
+with either a slice of i32 values or char values. Note that this code won’t
+compile yet, but we’ll fix it later in this chapter.
+
Filename: src/main.rs
+
fn largest<T>(list: &[T]) -> &T {
+ let mut largest = &list[0];
+
+ for item in list {
+ if item > largest {
+ largest = item;
+ }
+ }
+
+ largest
+}
+
+fn main() {
+ let number_list = vec![34, 50, 25, 100, 65];
+
+ let result = largest(&number_list);
+ println!("The largest number is {result}");
+
+ let char_list = vec!['y', 'm', 'a', 'q'];
+
+ let result = largest(&char_list);
+ println!("The largest char is {result}");
+}
+
Listing 10-5: The largest function using generic type
+parameters; this doesn’t compile yet
+
If we compile this code right now, we’ll get this error:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0369]: binary operation `>` cannot be applied to type `&T`
+ --> src/main.rs:5:17
+ |
+5 | if item > largest {
+ | ---- ^ ------- &T
+ | |
+ | &T
+ |
+help: consider restricting type parameter `T`
+ |
+1 | fn largest<T: std::cmp::PartialOrd>(list: &[T]) -> &T {
+ | ++++++++++++++++++++++
+
+For more information about this error, try `rustc --explain E0369`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The help text mentions std::cmp::PartialOrd, which is a trait, and we’re
+going to talk about traits in the next section. For now, know that this error
+states that the body of largest won’t work for all possible types that T
+could be. Because we want to compare values of type T in the body, we can
+only use types whose values can be ordered. To enable comparisons, the standard
+library has the std::cmp::PartialOrd trait that you can implement on types
+(see Appendix C for more on this trait). By following the help text’s
+suggestion, we restrict the types valid for T to only those that implement
+PartialOrd and this example will compile, because the standard library
+implements PartialOrd on both i32 and char.
We can also define structs to use a generic type parameter in one or more
+fields using the <> syntax. Listing 10-6 defines a Point<T> struct to hold
+x and y coordinate values of any type.
+
Filename: src/main.rs
+
struct Point<T> {
+ x: T,
+ y: T,
+}
+
+fn main() {
+ let integer = Point { x: 5, y: 10 };
+ let float = Point { x: 1.0, y: 4.0 };
+}
+
Listing 10-6: A Point<T> struct that holds x and y
+values of type T
+
The syntax for using generics in struct definitions is similar to that used in
+function definitions. First we declare the name of the type parameter inside
+angle brackets just after the name of the struct. Then we use the generic
+type in the struct definition where we would otherwise specify concrete data
+types.
+
Note that because we’ve used only one generic type to define Point<T>, this
+definition says that the Point<T> struct is generic over some type T, and
+the fields x and y are both that same type, whatever that type may be. If
+we create an instance of a Point<T> that has values of different types, as in
+Listing 10-7, our code won’t compile.
Listing 10-7: The fields x and y must be the same
+type because both have the same generic data type T.
+
In this example, when we assign the integer value 5 to x, we let the
+compiler know that the generic type T will be an integer for this instance of
+Point<T>. Then when we specify 4.0 for y, which we’ve defined to have the
+same type as x, we’ll get a type mismatch error like this:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0308]: mismatched types
+ --> src/main.rs:7:38
+ |
+7 | let wont_work = Point { x: 5, y: 4.0 };
+ | ^^^ expected integer, found floating-point number
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
To define a Point struct where x and y are both generics but could have
+different types, we can use multiple generic type parameters. For example, in
+Listing 10-8, we change the definition of Point to be generic over types T
+and U where x is of type T and y is of type U.
+
Filename: src/main.rs
+
struct Point<T, U> {
+ x: T,
+ y: U,
+}
+
+fn main() {
+ let both_integer = Point { x: 5, y: 10 };
+ let both_float = Point { x: 1.0, y: 4.0 };
+ let integer_and_float = Point { x: 5, y: 4.0 };
+}
+
Listing 10-8: A Point<T, U> generic over two types so
+that x and y can be values of different types
+
Now all the instances of Point shown are allowed! You can use as many generic
+type parameters in a definition as you want, but using more than a few makes
+your code hard to read. If you’re finding you need lots of generic types in
+your code, it could indicate that your code needs restructuring into smaller
+pieces.
As we did with structs, we can define enums to hold generic data types in their
+variants. Let’s take another look at the Option<T> enum that the standard
+library provides, which we used in Chapter 6:
This definition should now make more sense to you. As you can see, the
+Option<T> enum is generic over type T and has two variants: Some, which
+holds one value of type T, and a None variant that doesn’t hold any value.
+By using the Option<T> enum, we can express the abstract concept of an
+optional value, and because Option<T> is generic, we can use this abstraction
+no matter what the type of the optional value is.
+
Enums can use multiple generic types as well. The definition of the Result
+enum that we used in Chapter 9 is one example:
The Result enum is generic over two types, T and E, and has two variants:
+Ok, which holds a value of type T, and Err, which holds a value of type
+E. This definition makes it convenient to use the Result enum anywhere we
+have an operation that might succeed (return a value of some type T) or fail
+(return an error of some type E). In fact, this is what we used to open a
+file in Listing 9-3, where T was filled in with the type std::fs::File when
+the file was opened successfully and E was filled in with the type
+std::io::Error when there were problems opening the file.
+
When you recognize situations in your code with multiple struct or enum
+definitions that differ only in the types of the values they hold, you can
+avoid duplication by using generic types instead.
We can implement methods on structs and enums (as we did in Chapter 5) and use
+generic types in their definitions too. Listing 10-9 shows the Point<T>
+struct we defined in Listing 10-6 with a method named x implemented on it.
Listing 10-9: Implementing a method named x on the
+Point<T> struct that will return a reference to the x field of type
+T
+
Here, we’ve defined a method named x on Point<T> that returns a reference
+to the data in the field x.
+
Note that we have to declare T just after impl so we can use T to specify
+that we’re implementing methods on the type Point<T>. By declaring T as a
+generic type after impl, Rust can identify that the type in the angle
+brackets in Point is a generic type rather than a concrete type. We could
+have chosen a different name for this generic parameter than the generic
+parameter declared in the struct definition, but using the same name is
+conventional. Methods written within an impl that declares the generic type
+will be defined on any instance of the type, no matter what concrete type ends
+up substituting for the generic type.
+
We can also specify constraints on generic types when defining methods on the
+type. We could, for example, implement methods only on Point<f32> instances
+rather than on Point<T> instances with any generic type. In Listing 10-10 we
+use the concrete type f32, meaning we don’t declare any types after impl.
Listing 10-10: An impl block that only applies to a
+struct with a particular concrete type for the generic type parameter T
+
This code means the type Point<f32> will have a distance_from_origin
+method; other instances of Point<T> where T is not of type f32 will not
+have this method defined. The method measures how far our point is from the
+point at coordinates (0.0, 0.0) and uses mathematical operations that are
+available only for floating-point types.
+
Generic type parameters in a struct definition aren’t always the same as those
+you use in that same struct’s method signatures. Listing 10-11 uses the generic
+types X1 and Y1 for the Point struct and X2Y2 for the mixup method
+signature to make the example clearer. The method creates a new Point
+instance with the x value from the selfPoint (of type X1) and the y
+value from the passed-in Point (of type Y2).
Listing 10-11: A method that uses generic types different
+from its struct’s definition
+
In main, we’ve defined a Point that has an i32 for x (with value 5)
+and an f64 for y (with value 10.4). The p2 variable is a Point struct
+that has a string slice for x (with value "Hello") and a char for y
+(with value c). Calling mixup on p1 with the argument p2 gives us p3,
+which will have an i32 for x because x came from p1. The p3 variable
+will have a char for y because y came from p2. The println! macro
+call will print p3.x = 5, p3.y = c.
+
The purpose of this example is to demonstrate a situation in which some generic
+parameters are declared with impl and some are declared with the method
+definition. Here, the generic parameters X1 and Y1 are declared after
+impl because they go with the struct definition. The generic parameters X2
+and Y2 are declared after fn mixup because they’re only relevant to the
+method.
You might be wondering whether there is a runtime cost when using generic type
+parameters. The good news is that using generic types won’t make your program
+run any slower than it would with concrete types.
+
Rust accomplishes this by performing monomorphization of the code using
+generics at compile time. Monomorphization is the process of turning generic
+code into specific code by filling in the concrete types that are used when
+compiled. In this process, the compiler does the opposite of the steps we used
+to create the generic function in Listing 10-5: the compiler looks at all the
+places where generic code is called and generates code for the concrete types
+the generic code is called with.
+
Let’s look at how this works by using the standard library’s generic
+Option<T> enum:
When Rust compiles this code, it performs monomorphization. During that
+process, the compiler reads the values that have been used in Option<T>
+instances and identifies two kinds of Option<T>: one is i32 and the other
+is f64. As such, it expands the generic definition of Option<T> into two
+definitions specialized to i32 and f64, thereby replacing the generic
+definition with the specific ones.
+
The monomorphized version of the code looks similar to the following (the
+compiler uses different names than what we’re using here for illustration):
The generic Option<T> is replaced with the specific definitions created by
+the compiler. Because Rust compiles generic code into code that specifies the
+type in each instance, we pay no runtime cost for using generics. When the code
+runs, it performs just as it would if we had duplicated each definition by
+hand. The process of monomorphization makes Rust’s generics extremely efficient
+at runtime.
A trait defines the functionality a particular type has and can share with
+other types. We can use traits to define shared behavior in an abstract way. We
+can use trait bounds to specify that a generic type can be any type that has
+certain behavior.
+
+
Note: Traits are similar to a feature often called interfaces in other
+languages, although with some differences.
A type’s behavior consists of the methods we can call on that type. Different
+types share the same behavior if we can call the same methods on all of those
+types. Trait definitions are a way to group method signatures together to
+define a set of behaviors necessary to accomplish some purpose.
+
For example, let’s say we have multiple structs that hold various kinds and
+amounts of text: a NewsArticle struct that holds a news story filed in a
+particular location and a Tweet that can have, at most, 280 characters along
+with metadata that indicates whether it was a new tweet, a retweet, or a reply
+to another tweet.
+
We want to make a media aggregator library crate named aggregator that can
+display summaries of data that might be stored in a NewsArticle or Tweet
+instance. To do this, we need a summary from each type, and we’ll request that
+summary by calling a summarize method on an instance. Listing 10-12 shows the
+definition of a public Summary trait that expresses this behavior.
Listing 10-12: A Summary trait that consists of the
+behavior provided by a summarize method
+
Here, we declare a trait using the trait keyword and then the trait’s name,
+which is Summary in this case. We also declare the trait as pub so that
+crates depending on this crate can make use of this trait too, as we’ll see in
+a few examples. Inside the curly brackets, we declare the method signatures
+that describe the behaviors of the types that implement this trait, which in
+this case is fn summarize(&self) -> String.
+
After the method signature, instead of providing an implementation within curly
+brackets, we use a semicolon. Each type implementing this trait must provide
+its own custom behavior for the body of the method. The compiler will enforce
+that any type that has the Summary trait will have the method summarize
+defined with this signature exactly.
+
A trait can have multiple methods in its body: the method signatures are listed
+one per line, and each line ends in a semicolon.
Now that we’ve defined the desired signatures of the Summary trait’s methods,
+we can implement it on the types in our media aggregator. Listing 10-13 shows
+an implementation of the Summary trait on the NewsArticle struct that uses
+the headline, the author, and the location to create the return value of
+summarize. For the Tweet struct, we define summarize as the username
+followed by the entire text of the tweet, assuming that the tweet content is
+already limited to 280 characters.
Listing 10-13: Implementing the Summary trait on the
+NewsArticle and Tweet types
+
Implementing a trait on a type is similar to implementing regular methods. The
+difference is that after impl, we put the trait name we want to implement,
+then use the for keyword, and then specify the name of the type we want to
+implement the trait for. Within the impl block, we put the method signatures
+that the trait definition has defined. Instead of adding a semicolon after each
+signature, we use curly brackets and fill in the method body with the specific
+behavior that we want the methods of the trait to have for the particular type.
+
Now that the library has implemented the Summary trait on NewsArticle and
+Tweet, users of the crate can call the trait methods on instances of
+NewsArticle and Tweet in the same way we call regular methods. The only
+difference is that the user must bring the trait into scope as well as the
+types. Here’s an example of how a binary crate could use our aggregator
+library crate:
+
use aggregator::{Summary, Tweet};
+
+fn main() {
+ let tweet = Tweet {
+ username: String::from("horse_ebooks"),
+ content: String::from(
+ "of course, as you probably already know, people",
+ ),
+ reply: false,
+ retweet: false,
+ };
+
+ println!("1 new tweet: {}", tweet.summarize());
+}
+
This code prints 1 new tweet: horse_ebooks: of course, as you probably already know, people.
+
Other crates that depend on the aggregator crate can also bring the Summary
+trait into scope to implement Summary on their own types. One restriction to
+note is that we can implement a trait on a type only if either the trait or the
+type, or both, are local to our crate. For example, we can implement standard
+library traits like Display on a custom type like Tweet as part of our
+aggregator crate functionality because the type Tweet is local to our
+aggregator crate. We can also implement Summary on Vec<T> in our
+aggregator crate because the trait Summary is local to our aggregator
+crate.
+
But we can’t implement external traits on external types. For example, we can’t
+implement the Display trait on Vec<T> within our aggregator crate because
+Display and Vec<T> are both defined in the standard library and aren’t
+local to our aggregator crate. This restriction is part of a property called
+coherence, and more specifically the orphan rule, so named because the
+parent type is not present. This rule ensures that other people’s code can’t
+break your code and vice versa. Without the rule, two crates could implement
+the same trait for the same type, and Rust wouldn’t know which implementation
+to use.
Sometimes it’s useful to have default behavior for some or all of the methods
+in a trait instead of requiring implementations for all methods on every type.
+Then, as we implement the trait on a particular type, we can keep or override
+each method’s default behavior.
+
In Listing 10-14, we specify a default string for the summarize method of the
+Summary trait instead of only defining the method signature, as we did in
+Listing 10-12.
Listing 10-14: Defining a Summary trait with a default
+implementation of the summarize method
+
To use a default implementation to summarize instances of NewsArticle, we
+specify an empty impl block with impl Summary for NewsArticle {}.
+
Even though we’re no longer defining the summarize method on NewsArticle
+directly, we’ve provided a default implementation and specified that
+NewsArticle implements the Summary trait. As a result, we can still call
+the summarize method on an instance of NewsArticle, like this:
+
use aggregator::{self, NewsArticle, Summary};
+
+fn main() {
+ let article = NewsArticle {
+ headline: String::from("Penguins win the Stanley Cup Championship!"),
+ location: String::from("Pittsburgh, PA, USA"),
+ author: String::from("Iceburgh"),
+ content: String::from(
+ "The Pittsburgh Penguins once again are the best \
+ hockey team in the NHL.",
+ ),
+ };
+
+ println!("New article available! {}", article.summarize());
+}
+
This code prints New article available! (Read more...).
+
Creating a default implementation doesn’t require us to change anything about
+the implementation of Summary on Tweet in Listing 10-13. The reason is that
+the syntax for overriding a default implementation is the same as the syntax
+for implementing a trait method that doesn’t have a default implementation.
+
Default implementations can call other methods in the same trait, even if those
+other methods don’t have a default implementation. In this way, a trait can
+provide a lot of useful functionality and only require implementors to specify
+a small part of it. For example, we could define the Summary trait to have a
+summarize_author method whose implementation is required, and then define a
+summarize method that has a default implementation that calls the
+summarize_author method:
After we define summarize_author, we can call summarize on instances of the
+Tweet struct, and the default implementation of summarize will call the
+definition of summarize_author that we’ve provided. Because we’ve implemented
+summarize_author, the Summary trait has given us the behavior of the
+summarize method without requiring us to write any more code. Here’s what
+that looks like:
+
use aggregator::{self, Summary, Tweet};
+
+fn main() {
+ let tweet = Tweet {
+ username: String::from("horse_ebooks"),
+ content: String::from(
+ "of course, as you probably already know, people",
+ ),
+ reply: false,
+ retweet: false,
+ };
+
+ println!("1 new tweet: {}", tweet.summarize());
+}
+
This code prints 1 new tweet: (Read more from @horse_ebooks...).
+
Note that it isn’t possible to call the default implementation from an
+overriding implementation of that same method.
Now that you know how to define and implement traits, we can explore how to use
+traits to define functions that accept many different types. We’ll use the
+Summary trait we implemented on the NewsArticle and Tweet types in
+Listing 10-13 to define a notify function that calls the summarize method
+on its item parameter, which is of some type that implements the Summary
+trait. To do this, we use the impl Trait syntax, like this:
Instead of a concrete type for the item parameter, we specify the impl
+keyword and the trait name. This parameter accepts any type that implements the
+specified trait. In the body of notify, we can call any methods on item
+that come from the Summary trait, such as summarize. We can call notify
+and pass in any instance of NewsArticle or Tweet. Code that calls the
+function with any other type, such as a String or an i32, won’t compile
+because those types don’t implement Summary.
This longer form is equivalent to the example in the previous section but is
+more verbose. We place trait bounds with the declaration of the generic type
+parameter after a colon and inside angle brackets.
+
The impl Trait syntax is convenient and makes for more concise code in simple
+cases, while the fuller trait bound syntax can express more complexity in other
+cases. For example, we can have two parameters that implement Summary. Doing
+so with the impl Trait syntax looks like this:
Using impl Trait is appropriate if we want this function to allow item1 and
+item2 to have different types (as long as both types implement Summary). If
+we want to force both parameters to have the same type, however, we must use a
+trait bound, like this:
+
pub fn notify<T: Summary>(item1: &T, item2: &T) {
+
The generic type T specified as the type of the item1 and item2
+parameters constrains the function such that the concrete type of the value
+passed as an argument for item1 and item2 must be the same.
We can also specify more than one trait bound. Say we wanted notify to use
+display formatting as well as summarize on item: we specify in the notify
+definition that item must implement both Display and Summary. We can do
+so using the + syntax:
+
pub fn notify(item: &(impl Summary + Display)) {
+
The + syntax is also valid with trait bounds on generic types:
+
pub fn notify<T: Summary + Display>(item: &T) {
+
With the two trait bounds specified, the body of notify can call summarize
+and use {} to format item.
Using too many trait bounds has its downsides. Each generic has its own trait
+bounds, so functions with multiple generic type parameters can contain lots of
+trait bound information between the function’s name and its parameter list,
+making the function signature hard to read. For this reason, Rust has alternate
+syntax for specifying trait bounds inside a where clause after the function
+signature. So, instead of writing this:
This function’s signature is less cluttered: the function name, parameter list,
+and return type are close together, similar to a function without lots of trait
+bounds.
By using impl Summary for the return type, we specify that the
+returns_summarizable function returns some type that implements the Summary
+trait without naming the concrete type. In this case, returns_summarizable
+returns a Tweet, but the code calling this function doesn’t need to know that.
+
The ability to specify a return type only by the trait it implements is
+especially useful in the context of closures and iterators, which we cover in
+Chapter 13. Closures and iterators create types that only the compiler knows or
+types that are very long to specify. The impl Trait syntax lets you concisely
+specify that a function returns some type that implements the Iterator trait
+without needing to write out a very long type.
+
However, you can only use impl Trait if you’re returning a single type. For
+example, this code that returns either a NewsArticle or a Tweet with the
+return type specified as impl Summary wouldn’t work:
+
pub trait Summary {
+ fn summarize(&self) -> String;
+}
+
+pub struct NewsArticle {
+ pub headline: String,
+ pub location: String,
+ pub author: String,
+ pub content: String,
+}
+
+impl Summary for NewsArticle {
+ fn summarize(&self) -> String {
+ format!("{}, by {} ({})", self.headline, self.author, self.location)
+ }
+}
+
+pub struct Tweet {
+ pub username: String,
+ pub content: String,
+ pub reply: bool,
+ pub retweet: bool,
+}
+
+impl Summary for Tweet {
+ fn summarize(&self) -> String {
+ format!("{}: {}", self.username, self.content)
+ }
+}
+
+fn returns_summarizable(switch: bool) -> impl Summary {
+ if switch {
+ NewsArticle {
+ headline: String::from(
+ "Penguins win the Stanley Cup Championship!",
+ ),
+ location: String::from("Pittsburgh, PA, USA"),
+ author: String::from("Iceburgh"),
+ content: String::from(
+ "The Pittsburgh Penguins once again are the best \
+ hockey team in the NHL.",
+ ),
+ }
+ } else {
+ Tweet {
+ username: String::from("horse_ebooks"),
+ content: String::from(
+ "of course, as you probably already know, people",
+ ),
+ reply: false,
+ retweet: false,
+ }
+ }
+}
+
Returning either a NewsArticle or a Tweet isn’t allowed due to restrictions
+around how the impl Trait syntax is implemented in the compiler. We’ll cover
+how to write a function with this behavior in the “Using Trait Objects That
+Allow for Values of Different
+Types” section of Chapter 17.
By using a trait bound with an impl block that uses generic type parameters,
+we can implement methods conditionally for types that implement the specified
+traits. For example, the type Pair<T> in Listing 10-15 always implements the
+new function to return a new instance of Pair<T> (recall from the
+“Defining Methods” section of Chapter 5 that Self
+is a type alias for the type of the impl block, which in this case is
+Pair<T>). But in the next impl block, Pair<T> only implements the
+cmp_display method if its inner type T implements the PartialOrd trait
+that enables comparison and the Display trait that enables printing.
+
Filename: src/lib.rs
+
use std::fmt::Display;
+
+struct Pair<T> {
+ x: T,
+ y: T,
+}
+
+impl<T> Pair<T> {
+ fn new(x: T, y: T) -> Self {
+ Self { x, y }
+ }
+}
+
+impl<T: Display + PartialOrd> Pair<T> {
+ fn cmp_display(&self) {
+ if self.x >= self.y {
+ println!("The largest member is x = {}", self.x);
+ } else {
+ println!("The largest member is y = {}", self.y);
+ }
+ }
+}
+
Listing 10-15: Conditionally implementing methods on a
+generic type depending on trait bounds
+
We can also conditionally implement a trait for any type that implements
+another trait. Implementations of a trait on any type that satisfies the trait
+bounds are called blanket implementations and are used extensively in the
+Rust standard library. For example, the standard library implements the
+ToString trait on any type that implements the Display trait. The impl
+block in the standard library looks similar to this code:
+
impl<T: Display> ToString for T {
+ // --snip--
+}
+
Because the standard library has this blanket implementation, we can call the
+to_string method defined by the ToString trait on any type that implements
+the Display trait. For example, we can turn integers into their corresponding
+String values like this because integers implement Display:
+
#![allow(unused)]
+fn main() {
+let s = 3.to_string();
+}
+
Blanket implementations appear in the documentation for the trait in the
+“Implementors” section.
+
Traits and trait bounds let us write code that uses generic type parameters to
+reduce duplication but also specify to the compiler that we want the generic
+type to have particular behavior. The compiler can then use the trait bound
+information to check that all the concrete types used with our code provide the
+correct behavior. In dynamically typed languages, we would get an error at
+runtime if we called a method on a type which didn’t define the method. But
+Rust moves these errors to compile time so we’re forced to fix the problems
+before our code is even able to run. Additionally, we don’t have to write code
+that checks for behavior at runtime because we’ve already checked at compile
+time. Doing so improves performance without having to give up the flexibility
+of generics.
Lifetimes are another kind of generic that we’ve already been using. Rather
+than ensuring that a type has the behavior we want, lifetimes ensure that
+references are valid as long as we need them to be.
+
One detail we didn’t discuss in the “References and
+Borrowing” section in Chapter 4 is
+that every reference in Rust has a lifetime, which is the scope for which
+that reference is valid. Most of the time, lifetimes are implicit and inferred,
+just like most of the time, types are inferred. We must annotate types only
+when multiple types are possible. In a similar way, we must annotate lifetimes
+when the lifetimes of references could be related in a few different ways. Rust
+requires us to annotate the relationships using generic lifetime parameters to
+ensure the actual references used at runtime will definitely be valid.
+
Annotating lifetimes is not a concept most other programming languages have, so
+this is going to feel unfamiliar. Although we won’t cover lifetimes in their
+entirety in this chapter, we’ll discuss common ways you might encounter
+lifetime syntax so you can get comfortable with the concept.
The main aim of lifetimes is to prevent dangling references, which cause a
+program to reference data other than the data it’s intended to reference.
+Consider the program in Listing 10-16, which has an outer scope and an inner
+scope.
+
fn main() {
+ let r;
+
+ {
+ let x = 5;
+ r = &x;
+ }
+
+ println!("r: {r}");
+}
+
Listing 10-16: An attempt to use a reference whose value
+has gone out of scope
+
+
Note: The examples in Listing 10-16, 10-17, and 10-23 declare variables
+without giving them an initial value, so the variable name exists in the outer
+scope. At first glance, this might appear to be in conflict with Rust’s having
+no null values. However, if we try to use a variable before giving it a value,
+we’ll get a compile-time error, which shows that Rust indeed does not allow
+null values.
+
+
The outer scope declares a variable named r with no initial value, and the
+inner scope declares a variable named x with the initial value of 5. Inside
+the inner scope, we attempt to set the value of r as a reference to x. Then
+the inner scope ends, and we attempt to print the value in r. This code won’t
+compile because the value that r is referring to has gone out of scope before
+we try to use it. Here is the error message:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0597]: `x` does not live long enough
+ --> src/main.rs:6:13
+ |
+5 | let x = 5;
+ | - binding `x` declared here
+6 | r = &x;
+ | ^^ borrowed value does not live long enough
+7 | }
+ | - `x` dropped here while still borrowed
+8 |
+9 | println!("r: {r}");
+ | --- borrow later used here
+
+For more information about this error, try `rustc --explain E0597`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The error message says that the variable x “does not live long enough.” The
+reason is that x will be out of scope when the inner scope ends on line 7.
+But r is still valid for the outer scope; because its scope is larger, we say
+that it “lives longer.” If Rust allowed this code to work, r would be
+referencing memory that was deallocated when x went out of scope, and
+anything we tried to do with r wouldn’t work correctly. So how does Rust
+determine that this code is invalid? It uses a borrow checker.
The Rust compiler has a borrow checker that compares scopes to determine
+whether all borrows are valid. Listing 10-17 shows the same code as Listing
+10-16 but with annotations showing the lifetimes of the variables.
+
fn main() {
+ let r; // ---------+-- 'a
+ // |
+ { // |
+ let x = 5; // -+-- 'b |
+ r = &x; // | |
+ } // -+ |
+ // |
+ println!("r: {r}"); // |
+} // ---------+
+
Listing 10-17: Annotations of the lifetimes of r and
+x, named 'a and 'b, respectively
+
Here, we’ve annotated the lifetime of r with 'a and the lifetime of x
+with 'b. As you can see, the inner 'b block is much smaller than the outer
+'a lifetime block. At compile time, Rust compares the size of the two
+lifetimes and sees that r has a lifetime of 'a but that it refers to memory
+with a lifetime of 'b. The program is rejected because 'b is shorter than
+'a: the subject of the reference doesn’t live as long as the reference.
+
Listing 10-18 fixes the code so it doesn’t have a dangling reference and it
+compiles without any errors.
+
fn main() {
+ let x = 5; // ----------+-- 'b
+ // |
+ let r = &x; // --+-- 'a |
+ // | |
+ println!("r: {r}"); // | |
+ // --+ |
+} // ----------+
+
Listing 10-18: A valid reference because the data has a
+longer lifetime than the reference
+
Here, x has the lifetime 'b, which in this case is larger than 'a. This
+means r can reference x because Rust knows that the reference in r will
+always be valid while x is valid.
+
Now that you know what the lifetimes of references are and how Rust analyzes
+lifetimes to ensure references will always be valid, let’s explore generic
+lifetimes of parameters and return values in the context of functions.
We’ll write a function that returns the longer of two string slices. This
+function will take two string slices and return a single string slice. After
+we’ve implemented the longest function, the code in Listing 10-19 should
+print The longest string is abcd.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
Listing 10-19: A main function that calls the longest
+function to find the longer of two string slices
+
Note that we want the function to take string slices, which are references,
+rather than strings, because we don’t want the longest function to take
+ownership of its parameters. Refer to the “String Slices as
+Parameters” section in Chapter 4
+for more discussion about why the parameters we use in Listing 10-19 are the
+ones we want.
+
If we try to implement the longest function as shown in Listing 10-20, it
+won’t compile.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest(x: &str, y: &str) -> &str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-20: An implementation of the longest
+function that returns the longer of two string slices but does not yet
+compile
+
Instead, we get the following error that talks about lifetimes:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0106]: missing lifetime specifier
+ --> src/main.rs:9:33
+ |
+9 | fn longest(x: &str, y: &str) -> &str {
+ | ---- ---- ^ expected named lifetime parameter
+ |
+ = help: this function's return type contains a borrowed value, but the signature does not say whether it is borrowed from `x` or `y`
+help: consider introducing a named lifetime parameter
+ |
+9 | fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ | ++++ ++ ++ ++
+
+error: lifetime may not live long enough
+ --> src/main.rs:11:9
+ |
+9 | fn longest(x: &str, y: &str) -> &str {
+ | - let's call the lifetime of this reference `'1`
+10 | if x.len() > y.len() {
+11 | x
+ | ^ returning this value requires that `'1` must outlive `'static`
+
+error: lifetime may not live long enough
+ --> src/main.rs:13:9
+ |
+9 | fn longest(x: &str, y: &str) -> &str {
+ | - let's call the lifetime of this reference `'2`
+...
+13 | y
+ | ^ returning this value requires that `'2` must outlive `'static`
+
+For more information about this error, try `rustc --explain E0106`.
+error: could not compile `chapter10` (bin "chapter10") due to 3 previous errors
+
+
The help text reveals that the return type needs a generic lifetime parameter
+on it because Rust can’t tell whether the reference being returned refers to
+x or y. Actually, we don’t know either, because the if block in the body
+of this function returns a reference to x and the else block returns a
+reference to y!
+
When we’re defining this function, we don’t know the concrete values that will
+be passed into this function, so we don’t know whether the if case or the
+else case will execute. We also don’t know the concrete lifetimes of the
+references that will be passed in, so we can’t look at the scopes as we did in
+Listings 10-17 and 10-18 to determine whether the reference we return will
+always be valid. The borrow checker can’t determine this either, because it
+doesn’t know how the lifetimes of x and y relate to the lifetime of the
+return value. To fix this error, we’ll add generic lifetime parameters that
+define the relationship between the references so the borrow checker can
+perform its analysis.
Lifetime annotations don’t change how long any of the references live. Rather,
+they describe the relationships of the lifetimes of multiple references to each
+other without affecting the lifetimes. Just as functions can accept any type
+when the signature specifies a generic type parameter, functions can accept
+references with any lifetime by specifying a generic lifetime parameter.
+
Lifetime annotations have a slightly unusual syntax: the names of lifetime
+parameters must start with an apostrophe (') and are usually all lowercase
+and very short, like generic types. Most people use the name 'a for the first
+lifetime annotation. We place lifetime parameter annotations after the & of a
+reference, using a space to separate the annotation from the reference’s type.
+
Here are some examples: a reference to an i32 without a lifetime parameter, a
+reference to an i32 that has a lifetime parameter named 'a, and a mutable
+reference to an i32 that also has the lifetime 'a.
+
&i32 // a reference
+&'a i32 // a reference with an explicit lifetime
+&'a mut i32 // a mutable reference with an explicit lifetime
+
One lifetime annotation by itself doesn’t have much meaning because the
+annotations are meant to tell Rust how generic lifetime parameters of multiple
+references relate to each other. Let’s examine how the lifetime annotations
+relate to each other in the context of the longest function.
To use lifetime annotations in function signatures, we need to declare the
+generic lifetime parameters inside angle brackets between the function name
+and the parameter list, just as we did with generic type parameters.
+
We want the signature to express the following constraint: the returned
+reference will be valid as long as both the parameters are valid. This is the
+relationship between lifetimes of the parameters and the return value. We’ll
+name the lifetime 'a and then add it to each reference, as shown in Listing
+10-21.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-21: The longest function definition
+specifying that all the references in the signature must have the same lifetime
+'a
+
This code should compile and produce the result we want when we use it with the
+main function in Listing 10-19.
+
The function signature now tells Rust that for some lifetime 'a, the function
+takes two parameters, both of which are string slices that live at least as
+long as lifetime 'a. The function signature also tells Rust that the string
+slice returned from the function will live at least as long as lifetime 'a.
+In practice, it means that the lifetime of the reference returned by the
+longest function is the same as the smaller of the lifetimes of the values
+referred to by the function arguments. These relationships are what we want
+Rust to use when analyzing this code.
+
Remember, when we specify the lifetime parameters in this function signature,
+we’re not changing the lifetimes of any values passed in or returned. Rather,
+we’re specifying that the borrow checker should reject any values that don’t
+adhere to these constraints. Note that the longest function doesn’t need to
+know exactly how long x and y will live, only that some scope can be
+substituted for 'a that will satisfy this signature.
+
When annotating lifetimes in functions, the annotations go in the function
+signature, not in the function body. The lifetime annotations become part of
+the contract of the function, much like the types in the signature. Having
+function signatures contain the lifetime contract means the analysis the Rust
+compiler does can be simpler. If there’s a problem with the way a function is
+annotated or the way it is called, the compiler errors can point to the part of
+our code and the constraints more precisely. If, instead, the Rust compiler
+made more inferences about what we intended the relationships of the lifetimes
+to be, the compiler might only be able to point to a use of our code many steps
+away from the cause of the problem.
+
When we pass concrete references to longest, the concrete lifetime that is
+substituted for 'a is the part of the scope of x that overlaps with the
+scope of y. In other words, the generic lifetime 'a will get the concrete
+lifetime that is equal to the smaller of the lifetimes of x and y. Because
+we’ve annotated the returned reference with the same lifetime parameter 'a,
+the returned reference will also be valid for the length of the smaller of the
+lifetimes of x and y.
+
Let’s look at how the lifetime annotations restrict the longest function by
+passing in references that have different concrete lifetimes. Listing 10-22 is
+a straightforward example.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("long string is long");
+
+ {
+ let string2 = String::from("xyz");
+ let result = longest(string1.as_str(), string2.as_str());
+ println!("The longest string is {result}");
+ }
+}
+
+fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-22: Using the longest function with
+references to String values that have different concrete lifetimes
+
In this example, string1 is valid until the end of the outer scope, string2
+is valid until the end of the inner scope, and result references something
+that is valid until the end of the inner scope. Run this code and you’ll see
+that the borrow checker approves; it will compile and print The longest string is long string is long.
+
Next, let’s try an example that shows that the lifetime of the reference in
+result must be the smaller lifetime of the two arguments. We’ll move the
+declaration of the result variable outside the inner scope but leave the
+assignment of the value to the result variable inside the scope with
+string2. Then we’ll move the println! that uses result to outside the
+inner scope, after the inner scope has ended. The code in Listing 10-23 will
+not compile.
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("long string is long");
+ let result;
+ {
+ let string2 = String::from("xyz");
+ result = longest(string1.as_str(), string2.as_str());
+ }
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
Listing 10-23: Attempting to use result after string2
+has gone out of scope
+
When we try to compile this code, we get this error:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0597]: `string2` does not live long enough
+ --> src/main.rs:6:44
+ |
+5 | let string2 = String::from("xyz");
+ | ------- binding `string2` declared here
+6 | result = longest(string1.as_str(), string2.as_str());
+ | ^^^^^^^ borrowed value does not live long enough
+7 | }
+ | - `string2` dropped here while still borrowed
+8 | println!("The longest string is {result}");
+ | -------- borrow later used here
+
+For more information about this error, try `rustc --explain E0597`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The error shows that for result to be valid for the println! statement,
+string2 would need to be valid until the end of the outer scope. Rust knows
+this because we annotated the lifetimes of the function parameters and return
+values using the same lifetime parameter 'a.
+
As humans, we can look at this code and see that string1 is longer than
+string2, and therefore, result will contain a reference to string1.
+Because string1 has not gone out of scope yet, a reference to string1 will
+still be valid for the println! statement. However, the compiler can’t see
+that the reference is valid in this case. We’ve told Rust that the lifetime of
+the reference returned by the longest function is the same as the smaller of
+the lifetimes of the references passed in. Therefore, the borrow checker
+disallows the code in Listing 10-23 as possibly having an invalid reference.
+
Try designing more experiments that vary the values and lifetimes of the
+references passed in to the longest function and how the returned reference
+is used. Make hypotheses about whether or not your experiments will pass the
+borrow checker before you compile; then check to see if you’re right!
The way in which you need to specify lifetime parameters depends on what your
+function is doing. For example, if we changed the implementation of the
+longest function to always return the first parameter rather than the longest
+string slice, we wouldn’t need to specify a lifetime on the y parameter. The
+following code will compile:
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "efghijklmnopqrstuvwxyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &'a str, y: &str) -> &'a str {
+ x
+}
+
We’ve specified a lifetime parameter 'a for the parameter x and the return
+type, but not for the parameter y, because the lifetime of y does not have
+any relationship with the lifetime of x or the return value.
+
When returning a reference from a function, the lifetime parameter for the
+return type needs to match the lifetime parameter for one of the parameters. If
+the reference returned does not refer to one of the parameters, it must refer
+to a value created within this function. However, this would be a dangling
+reference because the value will go out of scope at the end of the function.
+Consider this attempted implementation of the longest function that won’t
+compile:
+
Filename: src/main.rs
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest(string1.as_str(), string2);
+ println!("The longest string is {result}");
+}
+
+fn longest<'a>(x: &str, y: &str) -> &'a str {
+ let result = String::from("really long string");
+ result.as_str()
+}
+
Here, even though we’ve specified a lifetime parameter 'a for the return
+type, this implementation will fail to compile because the return value
+lifetime is not related to the lifetime of the parameters at all. Here is the
+error message we get:
+
$ cargo run
+ Compiling chapter10 v0.1.0 (file:///projects/chapter10)
+error[E0515]: cannot return value referencing local variable `result`
+ --> src/main.rs:11:5
+ |
+11 | result.as_str()
+ | ------^^^^^^^^^
+ | |
+ | returns a value referencing data owned by the current function
+ | `result` is borrowed here
+
+For more information about this error, try `rustc --explain E0515`.
+error: could not compile `chapter10` (bin "chapter10") due to 1 previous error
+
+
The problem is that result goes out of scope and gets cleaned up at the end
+of the longest function. We’re also trying to return a reference to result
+from the function. There is no way we can specify lifetime parameters that
+would change the dangling reference, and Rust won’t let us create a dangling
+reference. In this case, the best fix would be to return an owned data type
+rather than a reference so the calling function is then responsible for
+cleaning up the value.
+
Ultimately, lifetime syntax is about connecting the lifetimes of various
+parameters and return values of functions. Once they’re connected, Rust has
+enough information to allow memory-safe operations and disallow operations that
+would create dangling pointers or otherwise violate memory safety.
So far, the structs we’ve defined all hold owned types. We can define structs
+to hold references, but in that case we would need to add a lifetime annotation
+on every reference in the struct’s definition. Listing 10-24 has a struct named
+ImportantExcerpt that holds a string slice.
+
Filename: src/main.rs
+
struct ImportantExcerpt<'a> {
+ part: &'a str,
+}
+
+fn main() {
+ let novel = String::from("Call me Ishmael. Some years ago...");
+ let first_sentence = novel.split('.').next().unwrap();
+ let i = ImportantExcerpt {
+ part: first_sentence,
+ };
+}
+
Listing 10-24: A struct that holds a reference, requiring
+a lifetime annotation
+
This struct has the single field part that holds a string slice, which is a
+reference. As with generic data types, we declare the name of the generic
+lifetime parameter inside angle brackets after the name of the struct so we can
+use the lifetime parameter in the body of the struct definition. This
+annotation means an instance of ImportantExcerpt can’t outlive the reference
+it holds in its part field.
+
The main function here creates an instance of the ImportantExcerpt struct
+that holds a reference to the first sentence of the String owned by the
+variable novel. The data in novel exists before the ImportantExcerpt
+instance is created. In addition, novel doesn’t go out of scope until after
+the ImportantExcerpt goes out of scope, so the reference in the
+ImportantExcerpt instance is valid.
You’ve learned that every reference has a lifetime and that you need to specify
+lifetime parameters for functions or structs that use references. However, we
+had a function in Listing 4-9, shown again in Listing 10-25, that compiled
+without lifetime annotations.
+
Filename: src/lib.rs
+
fn first_word(s: &str) -> &str {
+ let bytes = s.as_bytes();
+
+ for (i, &item) in bytes.iter().enumerate() {
+ if item == b' ' {
+ return &s[0..i];
+ }
+ }
+
+ &s[..]
+}
+
+fn main() {
+ let my_string = String::from("hello world");
+
+ // first_word works on slices of `String`s
+ let word = first_word(&my_string[..]);
+
+ let my_string_literal = "hello world";
+
+ // first_word works on slices of string literals
+ let word = first_word(&my_string_literal[..]);
+
+ // Because string literals *are* string slices already,
+ // this works too, without the slice syntax!
+ let word = first_word(my_string_literal);
+}
+
Listing 10-25: A function we defined in Listing 4-9 that
+compiled without lifetime annotations, even though the parameter and return
+type are references
+
The reason this function compiles without lifetime annotations is historical:
+in early versions (pre-1.0) of Rust, this code wouldn’t have compiled because
+every reference needed an explicit lifetime. At that time, the function
+signature would have been written like this:
+
fn first_word<'a>(s: &'a str) -> &'a str {
+
After writing a lot of Rust code, the Rust team found that Rust programmers
+were entering the same lifetime annotations over and over in particular
+situations. These situations were predictable and followed a few deterministic
+patterns. The developers programmed these patterns into the compiler’s code so
+the borrow checker could infer the lifetimes in these situations and wouldn’t
+need explicit annotations.
+
This piece of Rust history is relevant because it’s possible that more
+deterministic patterns will emerge and be added to the compiler. In the future,
+even fewer lifetime annotations might be required.
+
The patterns programmed into Rust’s analysis of references are called the
+lifetime elision rules. These aren’t rules for programmers to follow; they’re
+a set of particular cases that the compiler will consider, and if your code
+fits these cases, you don’t need to write the lifetimes explicitly.
+
The elision rules don’t provide full inference. If there is still ambiguity as
+to what lifetimes the references have after Rust applies the rules, the
+compiler won’t guess what the lifetime of the remaining references should be.
+Instead of guessing, the compiler will give you an error that you can resolve
+by adding the lifetime annotations.
+
Lifetimes on function or method parameters are called input lifetimes, and
+lifetimes on return values are called output lifetimes.
+
The compiler uses three rules to figure out the lifetimes of the references
+when there aren’t explicit annotations. The first rule applies to input
+lifetimes, and the second and third rules apply to output lifetimes. If the
+compiler gets to the end of the three rules and there are still references for
+which it can’t figure out lifetimes, the compiler will stop with an error.
+These rules apply to fn definitions as well as impl blocks.
+
The first rule is that the compiler assigns a lifetime parameter to each
+parameter that’s a reference. In other words, a function with one parameter
+gets one lifetime parameter: fn foo<'a>(x: &'a i32); a function with two
+parameters gets two separate lifetime parameters: fn foo<'a, 'b>(x: &'a i32, y: &'b i32); and so on.
+
The second rule is that, if there is exactly one input lifetime parameter, that
+lifetime is assigned to all output lifetime parameters: fn foo<'a>(x: &'a i32) -> &'a i32.
+
The third rule is that, if there are multiple input lifetime parameters, but
+one of them is &self or &mut self because this is a method, the lifetime of
+self is assigned to all output lifetime parameters. This third rule makes
+methods much nicer to read and write because fewer symbols are necessary.
+
Let’s pretend we’re the compiler. We’ll apply these rules to figure out the
+lifetimes of the references in the signature of the first_word function in
+Listing 10-25. The signature starts without any lifetimes associated with the
+references:
+
fn first_word(s: &str) -> &str {
+
Then the compiler applies the first rule, which specifies that each parameter
+gets its own lifetime. We’ll call it 'a as usual, so now the signature is
+this:
+
fn first_word<'a>(s: &'a str) -> &str {
+
The second rule applies because there is exactly one input lifetime. The second
+rule specifies that the lifetime of the one input parameter gets assigned to
+the output lifetime, so the signature is now this:
+
fn first_word<'a>(s: &'a str) -> &'a str {
+
Now all the references in this function signature have lifetimes, and the
+compiler can continue its analysis without needing the programmer to annotate
+the lifetimes in this function signature.
+
Let’s look at another example, this time using the longest function that had
+no lifetime parameters when we started working with it in Listing 10-20:
+
fn longest(x: &str, y: &str) -> &str {
+
Let’s apply the first rule: each parameter gets its own lifetime. This time we
+have two parameters instead of one, so we have two lifetimes:
You can see that the second rule doesn’t apply because there is more than one
+input lifetime. The third rule doesn’t apply either, because longest is a
+function rather than a method, so none of the parameters are self. After
+working through all three rules, we still haven’t figured out what the return
+type’s lifetime is. This is why we got an error trying to compile the code in
+Listing 10-20: the compiler worked through the lifetime elision rules but still
+couldn’t figure out all the lifetimes of the references in the signature.
+
Because the third rule really only applies in method signatures, we’ll look at
+lifetimes in that context next to see why the third rule means we don’t have to
+annotate lifetimes in method signatures very often.
When we implement methods on a struct with lifetimes, we use the same syntax as
+that of generic type parameters shown in Listing 10-11. Where we declare and
+use the lifetime parameters depends on whether they’re related to the struct
+fields or the method parameters and return values.
+
Lifetime names for struct fields always need to be declared after the impl
+keyword and then used after the struct’s name because those lifetimes are part
+of the struct’s type.
+
In method signatures inside the impl block, references might be tied to the
+lifetime of references in the struct’s fields, or they might be independent. In
+addition, the lifetime elision rules often make it so that lifetime annotations
+aren’t necessary in method signatures. Let’s look at some examples using the
+struct named ImportantExcerpt that we defined in Listing 10-24.
+
First we’ll use a method named level whose only parameter is a reference to
+self and whose return value is an i32, which is not a reference to anything:
The lifetime parameter declaration after impl and its use after the type name
+are required, but we’re not required to annotate the lifetime of the reference
+to self because of the first elision rule.
+
Here is an example where the third lifetime elision rule applies:
There are two input lifetimes, so Rust applies the first lifetime elision rule
+and gives both &self and announcement their own lifetimes. Then, because
+one of the parameters is &self, the return type gets the lifetime of &self,
+and all lifetimes have been accounted for.
One special lifetime we need to discuss is 'static, which denotes that the
+affected reference can live for the entire duration of the program. All
+string literals have the 'static lifetime, which we can annotate as follows:
+
#![allow(unused)]
+fn main() {
+let s: &'static str = "I have a static lifetime.";
+}
+
The text of this string is stored directly in the program’s binary, which is
+always available. Therefore, the lifetime of all string literals is 'static.
+
You might see suggestions to use the 'static lifetime in error messages. But
+before specifying 'static as the lifetime for a reference, think about
+whether the reference you have actually lives the entire lifetime of your
+program or not, and whether you want it to. Most of the time, an error message
+suggesting the 'static lifetime results from attempting to create a dangling
+reference or a mismatch of the available lifetimes. In such cases, the solution
+is to fix those problems, not to specify the 'static lifetime.
Let’s briefly look at the syntax of specifying generic type parameters, trait
+bounds, and lifetimes all in one function!
+
fn main() {
+ let string1 = String::from("abcd");
+ let string2 = "xyz";
+
+ let result = longest_with_an_announcement(
+ string1.as_str(),
+ string2,
+ "Today is someone's birthday!",
+ );
+ println!("The longest string is {result}");
+}
+
+use std::fmt::Display;
+
+fn longest_with_an_announcement<'a, T>(
+ x: &'a str,
+ y: &'a str,
+ ann: T,
+) -> &'a str
+where
+ T: Display,
+{
+ println!("Announcement! {ann}");
+ if x.len() > y.len() {
+ x
+ } else {
+ y
+ }
+}
+
This is the longest function from Listing 10-21 that returns the longer of
+two string slices. But now it has an extra parameter named ann of the generic
+type T, which can be filled in by any type that implements the Display
+trait as specified by the where clause. This extra parameter will be printed
+using {}, which is why the Display trait bound is necessary. Because
+lifetimes are a type of generic, the declarations of the lifetime parameter
+'a and the generic type parameter T go in the same list inside the angle
+brackets after the function name.
We covered a lot in this chapter! Now that you know about generic type
+parameters, traits and trait bounds, and generic lifetime parameters, you’re
+ready to write code without repetition that works in many different situations.
+Generic type parameters let you apply the code to different types. Traits and
+trait bounds ensure that even though the types are generic, they’ll have the
+behavior the code needs. You learned how to use lifetime annotations to ensure
+that this flexible code won’t have any dangling references. And all of this
+analysis happens at compile time, which doesn’t affect runtime performance!
+
Believe it or not, there is much more to learn on the topics we discussed in
+this chapter: Chapter 17 discusses trait objects, which are another way to use
+traits. There are also more complex scenarios involving lifetime annotations
+that you will only need in very advanced scenarios; for those, you should read
+the Rust Reference. But next, you’ll learn how to write tests in
+Rust so you can make sure your code is working the way it should.
In his 1972 essay “The Humble Programmer,” Edsger W. Dijkstra said that
+“Program testing can be a very effective way to show the presence of bugs, but
+it is hopelessly inadequate for showing their absence.” That doesn’t mean we
+shouldn’t try to test as much as we can!
+
Correctness in our programs is the extent to which our code does what we intend
+it to do. Rust is designed with a high degree of concern about the correctness
+of programs, but correctness is complex and not easy to prove. Rust’s type
+system shoulders a huge part of this burden, but the type system cannot catch
+everything. As such, Rust includes support for writing automated software tests.
+
Say we write a function add_two that adds 2 to whatever number is passed to
+it. This function’s signature accepts an integer as a parameter and returns an
+integer as a result. When we implement and compile that function, Rust does all
+the type checking and borrow checking that you’ve learned so far to ensure
+that, for instance, we aren’t passing a String value or an invalid reference
+to this function. But Rust can’t check that this function will do precisely
+what we intend, which is return the parameter plus 2 rather than, say, the
+parameter plus 10 or the parameter minus 50! That’s where tests come in.
+
We can write tests that assert, for example, that when we pass 3 to the
+add_two function, the returned value is 5. We can run these tests whenever
+we make changes to our code to make sure any existing correct behavior has not
+changed.
+
Testing is a complex skill: although we can’t cover every detail about how to
+write good tests in one chapter, we’ll discuss the mechanics of Rust’s testing
+facilities. We’ll talk about the annotations and macros available to you when
+writing your tests, the default behavior and options provided for running your
+tests, and how to organize tests into unit tests and integration tests.
Tests are Rust functions that verify that the non-test code is functioning in
+the expected manner. The bodies of test functions typically perform these three
+actions:
+
+
Set up any needed data or state.
+
Run the code you want to test.
+
Assert the results are what you expect.
+
+
Let’s look at the features Rust provides specifically for writing tests that
+take these actions, which include the test attribute, a few macros, and the
+should_panic attribute.
At its simplest, a test in Rust is a function that’s annotated with the test
+attribute. Attributes are metadata about pieces of Rust code; one example is
+the derive attribute we used with structs in Chapter 5. To change a function
+into a test function, add #[test] on the line before fn. When you run your
+tests with the cargo test command, Rust builds a test runner binary that runs
+the annotated functions and reports on whether each
+test function passes or fails.
+
Whenever we make a new library project with Cargo, a test module with a test
+function in it is automatically generated for us. This module gives you a
+template for writing your tests so you don’t have to look up the exact
+structure and syntax every time you start a new project. You can add as many
+additional test functions and as many test modules as you want!
+
We’ll explore some aspects of how tests work by experimenting with the template
+test before we actually test any code. Then we’ll write some real-world tests
+that call some code that we’ve written and assert that its behavior is correct.
+
Let’s create a new library project called adder that will add two numbers:
+
$ cargo new adder --lib
+ Created library `adder` project
+$ cd adder
+
+
The contents of the src/lib.rs file in your adder library should look like
+Listing 11-1.
+
+Filename: src/lib.rs
+
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn it_works() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+}
+Listing 11-1: The test module and function generated automatically by cargo new
+
+
For now, let’s focus solely on the it_works() function. Note the
+#[test] annotation: this attribute indicates this is a test function, so the
+test runner knows to treat this function as a test. We might also have non-test
+functions in the tests module to help set up common scenarios or perform
+common operations, so we always need to indicate which functions are tests.
+
The example function body uses the assert_eq! macro to assert that result,
+which contains the result of adding 2 and 2, equals 4. This assertion serves as
+an example of the format for a typical test. Let’s run it to see that this test
+passes.
+
The cargo test command runs all tests in our project, as shown in Listing
+11-2.
+
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.57s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::it_works ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+Listing 11-2: The output from running the automatically generated test
+
+
Cargo compiled and ran the test. We see the line running 1 test. The next
+line shows the name of the generated test function, called it_works, and that
+the result of running that test is ok. The overall summary test result: ok.
+means that all the tests passed, and the portion that reads 1 passed; 0 failed totals the number of tests that passed or failed.
+
It’s possible to mark a test as ignored so it doesn’t run in a particular
+instance; we’ll cover that in the “Ignoring Some Tests Unless Specifically
+Requested” section later in this chapter. Because we
+haven’t done that here, the summary shows 0 ignored. We can also pass an
+argument to the cargo test command to run only tests whose name matches a
+string; this is called filtering and we’ll cover that in the “Running a
+Subset of Tests by Name” section. We also haven’t
+filtered the tests being run, so the end of the summary shows 0 filtered out.
+
The 0 measured statistic is for benchmark tests that measure performance.
+Benchmark tests are, as of this writing, only available in nightly Rust. See
+the documentation about benchmark tests to learn more.
+
The next part of the test output starting at Doc-tests adder is for the
+results of any documentation tests. We don’t have any documentation tests yet,
+but Rust can compile any code examples that appear in our API documentation.
+This feature helps keep your docs and your code in sync! We’ll discuss how to
+write documentation tests in the “Documentation Comments as
+Tests” section of Chapter 14. For now, we’ll
+ignore the Doc-tests output.
+
Let’s start to customize the test to our own needs. First change the name of
+the it_works function to a different name, such as exploration, like so:
+
Filename: src/lib.rs
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn exploration() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+}
+
Then run cargo test again. The output now shows exploration instead of
+it_works:
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.59s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::exploration ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
Now we’ll add another test, but this time we’ll make a test that fails! Tests
+fail when something in the test function panics. Each test is run in a new
+thread, and when the main thread sees that a test thread has died, the test is
+marked as failed. In Chapter 9, we talked about how the simplest way to panic
+is to call the panic! macro. Enter the new test as a function named
+another, so your src/lib.rs file looks like Listing 11-3.
+
+Filename: src/lib.rs
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn exploration() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+
+ #[test]
+ fn another() {
+ panic!("Make this test fail");
+ }
+}
+Listing 11-3: Adding a second test that will fail because we call the panic! macro
+
+
Run the tests again using cargo test. The output should look like Listing
+11-4, which shows that our exploration test passed and another failed.
+
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.72s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 2 tests
+test tests::another ... FAILED
+test tests::exploration ... ok
+
+failures:
+
+---- tests::another stdout ----
+thread 'tests::another' panicked at src/lib.rs:17:9:
+Make this test fail
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::another
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+Listing 11-4: Test results when one test passes and one test fails
+
+
Instead of ok, the line test tests::another shows FAILED. Two new
+sections appear between the individual results and the summary: the first
+displays the detailed reason for each test failure. In this case, we get the
+details that another failed because it panicked at 'Make this test fail' on
+line 10 in the src/lib.rs file. The next section lists just the names of all
+the failing tests, which is useful when there are lots of tests and lots of
+detailed failing test output. We can use the name of a failing test to run just
+that test to more easily debug it; we’ll talk more about ways to run tests in
+the “Controlling How Tests Are Run” section.
+
The summary line displays at the end: overall, our test result is FAILED. We
+had one test pass and one test fail.
+
Now that you’ve seen what the test results look like in different scenarios,
+let’s look at some macros other than panic! that are useful in tests.
The assert! macro, provided by the standard library, is useful when you want
+to ensure that some condition in a test evaluates to true. We give the
+assert! macro an argument that evaluates to a Boolean. If the value is
+true, nothing happens and the test passes. If the value is false, the
+assert! macro calls panic! to cause the test to fail. Using the assert!
+macro helps us check that our code is functioning in the way we intend.
+
In Chapter 5, Listing 5-15, we used a Rectangle struct and a can_hold
+method, which are repeated here in Listing 11-5. Let’s put this code in the
+src/lib.rs file, then write some tests for it using the assert! macro.
+Listing 11-5: The Rectangle struct and its can_hold method from Chapter 5
+
+
The can_hold method returns a Boolean, which means it’s a perfect use case
+for the assert! macro. In Listing 11-6, we write a test that exercises the
+can_hold method by creating a Rectangle instance that has a width of 8 and
+a height of 7 and asserting that it can hold another Rectangle instance that
+has a width of 5 and a height of 1.
+Listing 11-6: A test for can_hold that checks whether a larger rectangle can indeed hold a smaller rectangle
+
+
Note that we’ve added a new line inside the tests module: use super::*;.
+The tests module is a regular module that follows the usual visibility rules
+we covered in Chapter 7 in the “Paths for Referring to an Item in the Module
+Tree”
+section. Because the tests module is an inner module, we need to bring the
+code under test in the outer module into the scope of the inner module. We use
+a glob here so anything we define in the outer module is available to this
+tests module.
+
We’ve named our test larger_can_hold_smaller, and we’ve created the two
+Rectangle instances that we need. Then we called the assert! macro and
+passed it the result of calling larger.can_hold(&smaller). This expression is
+supposed to return true, so our test should pass. Let’s find out!
+
$ cargo test
+ Compiling rectangle v0.1.0 (file:///projects/rectangle)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
+ Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e)
+
+running 1 test
+test tests::larger_can_hold_smaller ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests rectangle
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
It does pass! Let’s add another test, this time asserting that a smaller
+rectangle cannot hold a larger rectangle:
Because the correct result of the can_hold function in this case is false,
+we need to negate that result before we pass it to the assert! macro. As a
+result, our test will pass if can_hold returns false:
Two tests that pass! Now let’s see what happens to our test results when we
+introduce a bug in our code. We’ll change the implementation of the can_hold
+method by replacing the greater-than sign with a less-than sign when it
+compares the widths:
$ cargo test
+ Compiling rectangle v0.1.0 (file:///projects/rectangle)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
+ Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e)
+
+running 2 tests
+test tests::larger_can_hold_smaller ... FAILED
+test tests::smaller_cannot_hold_larger ... ok
+
+failures:
+
+---- tests::larger_can_hold_smaller stdout ----
+thread 'tests::larger_can_hold_smaller' panicked at src/lib.rs:28:9:
+assertion failed: larger.can_hold(&smaller)
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::larger_can_hold_smaller
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Our tests caught the bug! Because larger.width is 8 and smaller.width is
+5, the comparison of the widths in can_hold now returns false: 8 is not
+less than 5.
A common way to verify functionality is to test for equality between the result
+of the code under test and the value you expect the code to return. You could
+do this using the assert! macro and passing it an expression using the ==
+operator. However, this is such a common test that the standard library
+provides a pair of macros—assert_eq! and assert_ne!—to perform this test
+more conveniently. These macros compare two arguments for equality or
+inequality, respectively. They’ll also print the two values if the assertion
+fails, which makes it easier to see why the test failed; conversely, the
+assert! macro only indicates that it got a false value for the ==
+expression, without printing the values that led to the false value.
+
In Listing 11-7, we write a function named add_two that adds 2 to its
+parameter, then we test this function using the assert_eq! macro.
+Listing 11-7: Testing the function add_two using the assert_eq! macro
+
+
Let’s check that it passes!
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
We pass 4 as the argument to assert_eq!, which is equal to the result of
+calling add_two(2). The line for this test is test tests::it_adds_two ... ok, and the ok text indicates that our test passed!
+
Let’s introduce a bug into our code to see what assert_eq! looks like when it
+fails. Change the implementation of the add_two function to instead add 3:
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::it_adds_two ... FAILED
+
+failures:
+
+---- tests::it_adds_two stdout ----
+assertion `left == right` failed
+ left: 5
+ right: 4
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::it_adds_two
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Our test caught the bug! The it_adds_two test failed, and the message tells
+us that the assertion that fails was assertion `left == right` failed
+and what the left and right values are. This message helps us start
+debugging: the left argument was 4 but the right argument, where we had
+add_two(2), was 5. You can imagine that this would be especially helpful
+when we have a lot of tests going on.
+
Note that in some languages and test frameworks, the parameters to equality
+assertion functions are called expected and actual, and the order in which
+we specify the arguments matters. However, in Rust, they’re called left and
+right, and the order in which we specify the value we expect and the value
+the code produces doesn’t matter. We could write the assertion in this test as
+assert_eq!(4, add_two(2)), which would result in the same failure message
+that displays assertion failed: `(left == right)`.
+
The assert_ne! macro will pass if the two values we give it are not equal and
+fail if they’re equal. This macro is most useful for cases when we’re not sure
+what a value will be, but we know what the value definitely shouldn’t be.
+For example, if we’re testing a function that is guaranteed to change its input
+in some way, but the way in which the input is changed depends on the day of
+the week that we run our tests, the best thing to assert might be that the
+output of the function is not equal to the input.
+
Under the surface, the assert_eq! and assert_ne! macros use the operators
+== and !=, respectively. When the assertions fail, these macros print their
+arguments using debug formatting, which means the values being compared must
+implement the PartialEq and Debug traits. All primitive types and most of
+the standard library types implement these traits. For structs and enums that
+you define yourself, you’ll need to implement PartialEq to assert equality of
+those types. You’ll also need to implement Debug to print the values when the
+assertion fails. Because both traits are derivable traits, as mentioned in
+Listing 5-12 in Chapter 5, this is usually as straightforward as adding the
+#[derive(PartialEq, Debug)] annotation to your struct or enum definition. See
+Appendix C, “Derivable Traits,” for more
+details about these and other derivable traits.
You can also add a custom message to be printed with the failure message as
+optional arguments to the assert!, assert_eq!, and assert_ne! macros. Any
+arguments specified after the required arguments are passed along to the
+format! macro (discussed in Chapter 8 in the “Concatenation with the +
+Operator or the format!
+Macro”
+section), so you can pass a format string that contains {} placeholders and
+values to go in those placeholders. Custom messages are useful for documenting
+what an assertion means; when a test fails, you’ll have a better idea of what
+the problem is with the code.
+
For example, let’s say we have a function that greets people by name and we
+want to test that the name we pass into the function appears in the output:
The requirements for this program haven’t been agreed upon yet, and we’re
+pretty sure the Hello text at the beginning of the greeting will change. We
+decided we don’t want to have to update the test when the requirements change,
+so instead of checking for exact equality to the value returned from the
+greeting function, we’ll just assert that the output contains the text of the
+input parameter.
+
Now let’s introduce a bug into this code by changing greeting to exclude
+name to see what the default test failure looks like:
$ cargo test
+ Compiling greeter v0.1.0 (file:///projects/greeter)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.91s
+ Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a)
+
+running 1 test
+test tests::greeting_contains_name ... FAILED
+
+failures:
+
+---- tests::greeting_contains_name stdout ----
+thread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:
+assertion failed: result.contains("Carol")
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::greeting_contains_name
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
This result just indicates that the assertion failed and which line the
+assertion is on. A more useful failure message would print the value from the
+greeting function. Let’s add a custom failure message composed of a format
+string with a placeholder filled in with the actual value we got from the
+greeting function:
+
pub fn greeting(name: &str) -> String {
+ String::from("Hello!")
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn greeting_contains_name() {
+ let result = greeting("Carol");
+ assert!(
+ result.contains("Carol"),
+ "Greeting did not contain name, value was `{}`",
+ result
+ );
+ }
+}
+
Now when we run the test, we’ll get a more informative error message:
+
$ cargo test
+ Compiling greeter v0.1.0 (file:///projects/greeter)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.93s
+ Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a)
+
+running 1 test
+test tests::greeting_contains_name ... FAILED
+
+failures:
+
+---- tests::greeting_contains_name stdout ----
+thread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:
+Greeting did not contain name, value was `Hello!`
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::greeting_contains_name
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
We can see the value we actually got in the test output, which would help us
+debug what happened instead of what we were expecting to happen.
In addition to checking return values, it’s important to check that our code
+handles error conditions as we expect. For example, consider the Guess type
+that we created in Chapter 9, Listing 9-13. Other code that uses Guess
+depends on the guarantee that Guess instances will contain only values
+between 1 and 100. We can write a test that ensures that attempting to create a
+Guess instance with a value outside that range panics.
+
We do this by adding the attribute should_panic to our test function. The
+test passes if the code inside the function panics; the test fails if the code
+inside the function doesn’t panic.
+
Listing 11-8 shows a test that checks that the error conditions of Guess::new
+happen when we expect them to.
+
+Filename: src/lib.rs
+
pub struct Guess {
+ value: i32,
+}
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 || value > 100 {
+ panic!("Guess value must be between 1 and 100, got {value}.");
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+Listing 11-8: Testing that a condition will cause a panic!
+
+
We place the #[should_panic] attribute after the #[test] attribute and
+before the test function it applies to. Let’s look at the result when this test
+passes:
+
$ cargo test
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
+ Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
+
+running 1 test
+test tests::greater_than_100 - should panic ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests guessing_game
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
Looks good! Now let’s introduce a bug in our code by removing the condition
+that the new function will panic if the value is greater than 100:
+
pub struct Guess {
+ value: i32,
+}
+
+// --snip--
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 {
+ panic!("Guess value must be between 1 and 100, got {value}.");
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+
When we run the test in Listing 11-8, it will fail:
+
$ cargo test
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.62s
+ Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
+
+running 1 test
+test tests::greater_than_100 - should panic ... FAILED
+
+failures:
+
+---- tests::greater_than_100 stdout ----
+note: test did not panic as expected
+
+failures:
+ tests::greater_than_100
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
We don’t get a very helpful message in this case, but when we look at the test
+function, we see that it’s annotated with #[should_panic]. The failure we got
+means that the code in the test function did not cause a panic.
+
Tests that use should_panic can be imprecise. A should_panic test would
+pass even if the test panics for a different reason from the one we were
+expecting. To make should_panic tests more precise, we can add an optional
+expected parameter to the should_panic attribute. The test harness will
+make sure that the failure message contains the provided text. For example,
+consider the modified code for Guess in Listing 11-9 where the new function
+panics with different messages depending on whether the value is too small or
+too large.
+
+Filename: src/lib.rs
+
pub struct Guess {
+ value: i32,
+}
+
+// --snip--
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 {
+ panic!(
+ "Guess value must be greater than or equal to 1, got {value}."
+ );
+ } else if value > 100 {
+ panic!(
+ "Guess value must be less than or equal to 100, got {value}."
+ );
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic(expected = "less than or equal to 100")]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+Listing 11-9: Testing for a panic! with a panic message containing a specified substring
+
+
This test will pass because the value we put in the should_panic attribute’s
+expected parameter is a substring of the message that the Guess::new
+function panics with. We could have specified the entire panic message that we
+expect, which in this case would be Guess value must be less than or equal to 100, got 200. What you choose to specify depends on how much of the panic
+message is unique or dynamic and how precise you want your test to be. In this
+case, a substring of the panic message is enough to ensure that the code in the
+test function executes the else if value > 100 case.
+
To see what happens when a should_panic test with an expected message
+fails, let’s again introduce a bug into our code by swapping the bodies of the
+if value < 1 and the else if value > 100 blocks:
+
pub struct Guess {
+ value: i32,
+}
+
+impl Guess {
+ pub fn new(value: i32) -> Guess {
+ if value < 1 {
+ panic!(
+ "Guess value must be less than or equal to 100, got {value}."
+ );
+ } else if value > 100 {
+ panic!(
+ "Guess value must be greater than or equal to 1, got {value}."
+ );
+ }
+
+ Guess { value }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic(expected = "less than or equal to 100")]
+ fn greater_than_100() {
+ Guess::new(200);
+ }
+}
+
This time when we run the should_panic test, it will fail:
+
$ cargo test
+ Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s
+ Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d)
+
+running 1 test
+test tests::greater_than_100 - should panic ... FAILED
+
+failures:
+
+---- tests::greater_than_100 stdout ----
+thread 'tests::greater_than_100' panicked at src/lib.rs:12:13:
+Guess value must be greater than or equal to 1, got 200.
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+note: panic did not contain expected string
+ panic message: `"Guess value must be greater than or equal to 1, got 200."`,
+ expected substring: `"less than or equal to 100"`
+
+failures:
+ tests::greater_than_100
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
The failure message indicates that this test did indeed panic as we expected,
+but the panic message did not include the expected string less than or equal to 100. The panic message that we did get in this case was Guess value must be greater than or equal to 1, got 200. Now we can start figuring out where
+our bug is!
Our tests so far all panic when they fail. We can also write tests that use
+Result<T, E>! Here’s the test from Listing 11-1, rewritten to use Result<T, E> and return an Err instead of panicking:
+
#[cfg(test)]
+mod tests {
+ #[test]
+ fn it_works() -> Result<(), String> {
+ if 2 + 2 == 4 {
+ Ok(())
+ } else {
+ Err(String::from("two plus two does not equal four"))
+ }
+ }
+}
+
The it_works function now has the Result<(), String> return type. In the
+body of the function, rather than calling the assert_eq! macro, we return
+Ok(()) when the test passes and an Err with a String inside when the test
+fails.
+
Writing tests so they return a Result<T, E> enables you to use the question
+mark operator in the body of tests, which can be a convenient way to write
+tests that should fail if any operation within them returns an Err variant.
+
You can’t use the #[should_panic] annotation on tests that use Result<T, E>. To assert that an operation returns an Err variant, don’t use the
+question mark operator on the Result<T, E> value. Instead, use
+assert!(value.is_err()).
+
Now that you know several ways to write tests, let’s look at what is happening
+when we run our tests and explore the different options we can use with cargo test.
Just as cargo run compiles your code and then runs the resulting binary,
+cargo test compiles your code in test mode and runs the resulting test
+binary. The default behavior of the binary produced by cargo test is to run
+all the tests in parallel and capture output generated during test runs,
+preventing the output from being displayed and making it easier to read the
+output related to the test results. You can, however, specify command line
+options to change this default behavior.
+
Some command line options go to cargo test, and some go to the resulting test
+binary. To separate these two types of arguments, you list the arguments that
+go to cargo test followed by the separator -- and then the ones that go to
+the test binary. Running cargo test --help displays the options you can use
+with cargo test, and running cargo test -- --help displays the options you
+can use after the separator.
When you run multiple tests, by default they run in parallel using threads,
+meaning they finish running faster and you get feedback quicker. Because the
+tests are running at the same time, you must make sure your tests don’t depend
+on each other or on any shared state, including a shared environment, such as
+the current working directory or environment variables.
+
For example, say each of your tests runs some code that creates a file on disk
+named test-output.txt and writes some data to that file. Then each test reads
+the data in that file and asserts that the file contains a particular value,
+which is different in each test. Because the tests run at the same time, one
+test might overwrite the file in the time between another test writing and
+reading the file. The second test will then fail, not because the code is
+incorrect but because the tests have interfered with each other while running
+in parallel. One solution is to make sure each test writes to a different file;
+another solution is to run the tests one at a time.
+
If you don’t want to run the tests in parallel or if you want more fine-grained
+control over the number of threads used, you can send the --test-threads flag
+and the number of threads you want to use to the test binary. Take a look at
+the following example:
+
$ cargo test -- --test-threads=1
+
+
We set the number of test threads to 1, telling the program not to use any
+parallelism. Running the tests using one thread will take longer than running
+them in parallel, but the tests won’t interfere with each other if they share
+state.
By default, if a test passes, Rust’s test library captures anything printed to
+standard output. For example, if we call println! in a test and the test
+passes, we won’t see the println! output in the terminal; we’ll see only the
+line that indicates the test passed. If a test fails, we’ll see whatever was
+printed to standard output with the rest of the failure message.
+
As an example, Listing 11-10 has a silly function that prints the value of its
+parameter and returns 10, as well as a test that passes and a test that fails.
+
+Filename: src/lib.rs
+
fn prints_and_returns_10(a: i32) -> i32 {
+ println!("I got the value {a}");
+ 10
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn this_test_will_pass() {
+ let value = prints_and_returns_10(4);
+ assert_eq!(10, value);
+ }
+
+ #[test]
+ fn this_test_will_fail() {
+ let value = prints_and_returns_10(8);
+ assert_eq!(5, value);
+ }
+}
+Listing 11-10: Tests for a function that calls println!
+
+
When we run these tests with cargo test, we’ll see the following output:
+
$ cargo test
+ Compiling silly-function v0.1.0 (file:///projects/silly-function)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s
+ Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
+
+running 2 tests
+test tests::this_test_will_fail ... FAILED
+test tests::this_test_will_pass ... ok
+
+failures:
+
+---- tests::this_test_will_fail stdout ----
+I got the value 8
+thread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:
+assertion `left == right` failed
+ left: 5
+ right: 10
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::this_test_will_fail
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Note that nowhere in this output do we see I got the value 4, which is what
+is printed when the test that passes runs. That output has been captured. The
+output from the test that failed, I got the value 8, appears in the section
+of the test summary output, which also shows the cause of the test failure.
+
If we want to see printed values for passing tests as well, we can tell Rust
+to also show the output of successful tests with --show-output.
+
$ cargo test -- --show-output
+
+
When we run the tests in Listing 11-10 again with the --show-output flag, we
+see the following output:
+
$ cargo test -- --show-output
+ Compiling silly-function v0.1.0 (file:///projects/silly-function)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s
+ Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166)
+
+running 2 tests
+test tests::this_test_will_fail ... FAILED
+test tests::this_test_will_pass ... ok
+
+successes:
+
+---- tests::this_test_will_pass stdout ----
+I got the value 4
+
+
+successes:
+ tests::this_test_will_pass
+
+failures:
+
+---- tests::this_test_will_fail stdout ----
+I got the value 8
+thread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:
+assertion `left == right` failed
+ left: 5
+ right: 10
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::this_test_will_fail
+
+test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
Sometimes, running a full test suite can take a long time. If you’re working on
+code in a particular area, you might want to run only the tests pertaining to
+that code. You can choose which tests to run by passing cargo test the name
+or names of the test(s) you want to run as an argument.
+
To demonstrate how to run a subset of tests, we’ll first create three tests for
+our add_two function, as shown in Listing 11-11, and choose which ones to run.
We can pass the name of any test function to cargo test to run only that test:
+
$ cargo test one_hundred
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.69s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::one_hundred ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out; finished in 0.00s
+
+
+
Only the test with the name one_hundred ran; the other two tests didn’t match
+that name. The test output lets us know we had more tests that didn’t run by
+displaying 2 filtered out at the end.
+
We can’t specify the names of multiple tests in this way; only the first value
+given to cargo test will be used. But there is a way to run multiple tests.
We can specify part of a test name, and any test whose name matches that value
+will be run. For example, because two of our tests’ names contain add, we can
+run those two by running cargo test add:
+
$ cargo test add
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 2 tests
+test tests::add_three_and_two ... ok
+test tests::add_two_and_two ... ok
+
+test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
+
+
+
This command ran all tests with add in the name and filtered out the test
+named one_hundred. Also note that the module in which a test appears becomes
+part of the test’s name, so we can run all the tests in a module by filtering
+on the module’s name.
Sometimes a few specific tests can be very time-consuming to execute, so you
+might want to exclude them during most runs of cargo test. Rather than
+listing as arguments all tests you do want to run, you can instead annotate the
+time-consuming tests using the ignore attribute to exclude them, as shown
+here:
+
Filename: src/lib.rs
+
#[test]
+fn it_works() {
+ assert_eq!(2 + 2, 4);
+}
+
+#[test]
+#[ignore]
+fn expensive_test() {
+ // code that takes an hour to run
+}
+
After #[test] we add the #[ignore] line to the test we want to exclude. Now
+when we run our tests, it_works runs, but expensive_test doesn’t:
The expensive_test function is listed as ignored. If we want to run only
+the ignored tests, we can use cargo test -- --ignored:
+
$ cargo test -- --ignored
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test expensive_test ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
By controlling which tests run, you can make sure your cargo test results
+will be fast. When you’re at a point where it makes sense to check the results
+of the ignored tests and you have time to wait for the results, you can run
+cargo test -- --ignored instead. If you want to run all tests whether they’re
+ignored or not, you can run cargo test -- --include-ignored.
As mentioned at the start of the chapter, testing is a complex discipline, and
+different people use different terminology and organization. The Rust community
+thinks about tests in terms of two main categories: unit tests and integration
+tests. Unit tests are small and more focused, testing one module in isolation
+at a time, and can test private interfaces. Integration tests are entirely
+external to your library and use your code in the same way any other external
+code would, using only the public interface and potentially exercising multiple
+modules per test.
+
Writing both kinds of tests is important to ensure that the pieces of your
+library are doing what you expect them to, separately and together.
The purpose of unit tests is to test each unit of code in isolation from the
+rest of the code to quickly pinpoint where code is and isn’t working as
+expected. You’ll put unit tests in the src directory in each file with the
+code that they’re testing. The convention is to create a module named tests
+in each file to contain the test functions and to annotate the module with
+cfg(test).
The #[cfg(test)] annotation on the tests module tells Rust to compile and run
+the test code only when you run cargo test, not when you run cargo build.
+This saves compile time when you only want to build the library and saves space
+in the resulting compiled artifact because the tests are not included. You’ll
+see that because integration tests go in a different directory, they don’t need
+the #[cfg(test)] annotation. However, because unit tests go in the same files
+as the code, you’ll use #[cfg(test)] to specify that they shouldn’t be
+included in the compiled result.
+
Recall that when we generated the new adder project in the first section of
+this chapter, Cargo generated this code for us:
+
Filename: src/lib.rs
+
pub fn add(left: usize, right: usize) -> usize {
+ left + right
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn it_works() {
+ let result = add(2, 2);
+ assert_eq!(result, 4);
+ }
+}
+
This code is the automatically generated test module. The attribute cfg
+stands for configuration and tells Rust that the following item should only
+be included given a certain configuration option. In this case, the
+configuration option is test, which is provided by Rust for compiling and
+running tests. By using the cfg attribute, Cargo compiles our test code only
+if we actively run the tests with cargo test. This includes any helper
+functions that might be within this module, in addition to the functions
+annotated with #[test].
There’s debate within the testing community about whether or not private
+functions should be tested directly, and other languages make it difficult or
+impossible to test private functions. Regardless of which testing ideology you
+adhere to, Rust’s privacy rules do allow you to test private functions.
+Consider the code in Listing 11-12 with the private function internal_adder.
Note that the internal_adder function is not marked as pub. Tests are just
+Rust code, and the tests module is just another module. As we discussed in
+the “Paths for Referring to an Item in the Module Tree”
+section, items in child modules can use the items in their ancestor modules. In
+this test, we bring all of the tests module’s parent’s items into scope with
+use super::*, and then the test can call internal_adder. If you don’t think
+private functions should be tested, there’s nothing in Rust that will compel
+you to do so.
In Rust, integration tests are entirely external to your library. They use your
+library in the same way any other code would, which means they can only call
+functions that are part of your library’s public API. Their purpose is to test
+whether many parts of your library work together correctly. Units of code that
+work correctly on their own could have problems when integrated, so test
+coverage of the integrated code is important as well. To create integration
+tests, you first need a tests directory.
We create a tests directory at the top level of our project directory, next
+to src. Cargo knows to look for integration test files in this directory. We
+can then make as many test files as we want, and Cargo will compile each of the
+files as an individual crate.
+
Let’s create an integration test. With the code in Listing 11-12 still in the
+src/lib.rs file, make a tests directory, and create a new file named
+tests/integration_test.rs. Your directory structure should look like this:
+Listing 11-13: An integration test of a function in the adder crate
+
+
Each file in the tests directory is a separate crate, so we need to bring our
+library into each test crate’s scope. For that reason we add use adder::add_two at the top of the code, which we didn’t need in the unit
+tests.
+
We don’t need to annotate any code in tests/integration_test.rs with
+#[cfg(test)]. Cargo treats the tests directory specially and compiles files
+in this directory only when we run cargo test. Run cargo test now:
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 1.31s
+ Running unittests src/lib.rs (target/debug/deps/adder-1082c4b063a8fbe6)
+
+running 1 test
+test tests::internal ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running tests/integration_test.rs (target/debug/deps/integration_test-1082c4b063a8fbe6)
+
+running 1 test
+test it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
The three sections of output include the unit tests, the integration test, and
+the doc tests. Note that if any test in a section fails, the following sections
+will not be run. For example, if a unit test fails, there won’t be any output
+for integration and doc tests because those tests will only be run if all unit
+tests are passing.
+
The first section for the unit tests is the same as we’ve been seeing: one line
+for each unit test (one named internal that we added in Listing 11-12) and
+then a summary line for the unit tests.
+
The integration tests section starts with the line Running tests/integration_test.rs. Next, there is a line for each test function in
+that integration test and a summary line for the results of the integration
+test just before the Doc-tests adder section starts.
+
Each integration test file has its own section, so if we add more files in the
+tests directory, there will be more integration test sections.
+
We can still run a particular integration test function by specifying the test
+function’s name as an argument to cargo test. To run all the tests in a
+particular integration test file, use the --test argument of cargo test
+followed by the name of the file:
+
$ cargo test --test integration_test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.64s
+ Running tests/integration_test.rs (target/debug/deps/integration_test-82e7799c1bc62298)
+
+running 1 test
+test it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
This command runs only the tests in the tests/integration_test.rs file.
As you add more integration tests, you might want to make more files in the
+tests directory to help organize them; for example, you can group the test
+functions by the functionality they’re testing. As mentioned earlier, each file
+in the tests directory is compiled as its own separate crate, which is useful
+for creating separate scopes to more closely imitate the way end users will be
+using your crate. However, this means files in the tests directory don’t
+share the same behavior as files in src do, as you learned in Chapter 7
+regarding how to separate code into modules and files.
+
The different behavior of tests directory files is most noticeable when you
+have a set of helper functions to use in multiple integration test files and
+you try to follow the steps in the “Separating Modules into Different
+Files” section of Chapter 7 to
+extract them into a common module. For example, if we create tests/common.rs
+and place a function named setup in it, we can add some code to setup that
+we want to call from multiple test functions in multiple test files:
+
Filename: tests/common.rs
+
pub fn setup() {
+ // setup code specific to your library's tests would go here
+}
+
When we run the tests again, we’ll see a new section in the test output for the
+common.rs file, even though this file doesn’t contain any test functions nor
+did we call the setup function from anywhere:
+
$ cargo test
+ Compiling adder v0.1.0 (file:///projects/adder)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.89s
+ Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4)
+
+running 1 test
+test tests::internal ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running tests/common.rs (target/debug/deps/common-92948b65e88960b4)
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running tests/integration_test.rs (target/debug/deps/integration_test-92948b65e88960b4)
+
+running 1 test
+test it_adds_two ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests adder
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
+
Having common appear in the test results with running 0 tests displayed for
+it is not what we wanted. We just wanted to share some code with the other
+integration test files.
+
To avoid having common appear in the test output, instead of creating
+tests/common.rs, we’ll create tests/common/mod.rs. The project directory
+now looks like this:
This is the older naming convention that Rust also understands that we
+mentioned in the “Alternate File Paths” section of
+Chapter 7. Naming the file this way tells Rust not to treat the common module
+as an integration test file. When we move the setup function code into
+tests/common/mod.rs and delete the tests/common.rs file, the section in the
+test output will no longer appear. Files in subdirectories of the tests
+directory don’t get compiled as separate crates or have sections in the test
+output.
+
After we’ve created tests/common/mod.rs, we can use it from any of the
+integration test files as a module. Here’s an example of calling the setup
+function from the it_adds_two test in tests/integration_test.rs:
Note that the mod common; declaration is the same as the module declaration
+we demonstrated in Listing 7-21. Then in the test function, we can call the
+common::setup() function.
If our project is a binary crate that only contains a src/main.rs file and
+doesn’t have a src/lib.rs file, we can’t create integration tests in the
+tests directory and bring functions defined in the src/main.rs file into
+scope with a use statement. Only library crates expose functions that other
+crates can use; binary crates are meant to be run on their own.
+
This is one of the reasons Rust projects that provide a binary have a
+straightforward src/main.rs file that calls logic that lives in the
+src/lib.rs file. Using that structure, integration tests can test the
+library crate with use to make the important functionality available.
+If the important functionality works, the small amount of code in the
+src/main.rs file will work as well, and that small amount of code doesn’t
+need to be tested.
Rust’s testing features provide a way to specify how code should function to
+ensure it continues to work as you expect, even as you make changes. Unit tests
+exercise different parts of a library separately and can test private
+implementation details. Integration tests check that many parts of the library
+work together correctly, and they use the library’s public API to test the code
+in the same way external code will use it. Even though Rust’s type system and
+ownership rules help prevent some kinds of bugs, tests are still important to
+reduce logic bugs having to do with how your code is expected to behave.
+
Let’s combine the knowledge you learned in this chapter and in previous
+chapters to work on a project!
This chapter is a recap of the many skills you’ve learned so far and an
+exploration of a few more standard library features. We’ll build a command line
+tool that interacts with file and command line input/output to practice some of
+the Rust concepts you now have under your belt.
+
Rust’s speed, safety, single binary output, and cross-platform support make it
+an ideal language for creating command line tools, so for our project, we’ll
+make our own version of the classic command line search tool grep
+(globally search a regular expression and print). In the
+simplest use case, grep searches a specified file for a specified string. To
+do so, grep takes as its arguments a file path and a string. Then it reads
+the file, finds lines in that file that contain the string argument, and prints
+those lines.
+
Along the way, we’ll show how to make our command line tool use the terminal
+features that many other command line tools use. We’ll read the value of an
+environment variable to allow the user to configure the behavior of our tool.
+We’ll also print error messages to the standard error console stream (stderr)
+instead of standard output (stdout), so, for example, the user can redirect
+successful output to a file while still seeing error messages onscreen.
+
One Rust community member, Andrew Gallant, has already created a fully
+featured, very fast version of grep, called ripgrep. By comparison, our
+version will be fairly simple, but this chapter will give you some of the
+background knowledge you need to understand a real-world project such as
+ripgrep.
+
Our grep project will combine a number of concepts you’ve learned so far:
+
+
Organizing code (using what you learned about modules in Chapter 7)
+
Using vectors and strings (collections, Chapter 8)
Let’s create a new project with, as always, cargo new. We’ll call our project
+minigrep to distinguish it from the grep tool that you might already have
+on your system.
+
$ cargo new minigrep
+ Created binary (application) `minigrep` project
+$ cd minigrep
+
+
The first task is to make minigrep accept its two command line arguments: the
+file path and a string to search for. That is, we want to be able to run our
+program with cargo run, two hyphens to indicate the following arguments are
+for our program rather than for cargo, a string to search for, and a path to
+a file to search in, like so:
+
$ cargo run -- searchstring example-filename.txt
+
+
Right now, the program generated by cargo new cannot process arguments we
+give it. Some existing libraries on crates.io can help
+with writing a program that accepts command line arguments, but because you’re
+just learning this concept, let’s implement this capability ourselves.
To enable minigrep to read the values of command line arguments we pass to
+it, we’ll need the std::env::args function provided in Rust’s standard
+library. This function returns an iterator of the command line arguments passed
+to minigrep. We’ll cover iterators fully in Chapter 13. For now, you only need to know two details about iterators: iterators
+produce a series of values, and we can call the collect method on an iterator
+to turn it into a collection, such as a vector, that contains all the elements
+the iterator produces.
+
The code in Listing 12-1 allows your minigrep program to read any command
+line arguments passed to it and then collect the values into a vector.
+
+Filename: src/main.rs
+
use std::env;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+ dbg!(args);
+}
+Listing 12-1: Collecting the command line arguments into a vector and printing them
+
+
First, we bring the std::env module into scope with a use statement so we
+can use its args function. Notice that the std::env::args function is
+nested in two levels of modules. As we discussed in Chapter
+7, in cases where the desired function is
+nested in more than one module, we’ve chosen to bring the parent module into
+scope rather than the function. By doing so, we can easily use other functions
+from std::env. It’s also less ambiguous than adding use std::env::args and
+then calling the function with just args, because args might easily be
+mistaken for a function that’s defined in the current module.
Note that std::env::args will panic if any argument contains invalid
+Unicode. If your program needs to accept arguments containing invalid
+Unicode, use std::env::args_os instead. That function returns an iterator
+that produces OsString values instead of String values. We’ve chosen to
+use std::env::args here for simplicity, because OsString values differ
+per platform and are more complex to work with than String values.
+
+
On the first line of main, we call env::args, and we immediately use
+collect to turn the iterator into a vector containing all the values produced
+by the iterator. We can use the collect function to create many kinds of
+collections, so we explicitly annotate the type of args to specify that we
+want a vector of strings. Although we very rarely need to annotate types in
+Rust, collect is one function you do often need to annotate because Rust
+isn’t able to infer the kind of collection you want.
+
Finally, we print the vector using the debug macro. Let’s try running the code
+first with no arguments and then with two arguments:
Notice that the first value in the vector is "target/debug/minigrep", which
+is the name of our binary. This matches the behavior of the arguments list in
+C, letting programs use the name by which they were invoked in their execution.
+It’s often convenient to have access to the program name in case you want to
+print it in messages or change behavior of the program based on what command
+line alias was used to invoke the program. But for the purposes of this
+chapter, we’ll ignore it and save only the two arguments we need.
The program is currently able to access the values specified as command line
+arguments. Now we need to save the values of the two arguments in variables so
+we can use the values throughout the rest of the program. We do that in Listing
+12-2.
+
+Filename: src/main.rs
+
use std::env;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let query = &args[1];
+ let file_path = &args[2];
+
+ println!("Searching for {query}");
+ println!("In file {file_path}");
+}
+Listing 12-2: Creating variables to hold the query argument and file path argument
+
+
As we saw when we printed the vector, the program’s name takes up the first
+value in the vector at args[0], so we’re starting arguments at index 1. The
+first argument minigrep takes is the string we’re searching for, so we put a
+reference to the first argument in the variable query. The second argument
+will be the file path, so we put a reference to the second argument in the
+variable file_path.
+
We temporarily print the values of these variables to prove that the code is
+working as we intend. Let’s run this program again with the arguments test
+and sample.txt:
+
$ cargo run -- test sample.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep test sample.txt`
+Searching for test
+In file sample.txt
+
+
Great, the program is working! The values of the arguments we need are being
+saved into the right variables. Later we’ll add some error handling to deal
+with certain potential erroneous situations, such as when the user provides no
+arguments; for now, we’ll ignore that situation and work on adding file-reading
+capabilities instead.
Now we’ll add functionality to read the file specified in the file_path
+argument. First, we need a sample file to test it with: we’ll use a file with a
+small amount of text over multiple lines with some repeated words. Listing 12-3
+has an Emily Dickinson poem that will work well! Create a file called
+poem.txt at the root level of your project, and enter the poem “I’m Nobody!
+Who are you?”
+
+Filename: poem.txt
+
I'm nobody! Who are you?
+Are you nobody, too?
+Then there's a pair of us - don't tell!
+They'd banish us, you know.
+
+How dreary to be somebody!
+How public, like a frog
+To tell your name the livelong day
+To an admiring bog!
+
+Listing 12-3: A poem by Emily Dickinson makes a good test case
+
+
With the text in place, edit src/main.rs and add code to read the file, as
+shown in Listing 12-4.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ // --snip--
+ let args: Vec<String> = env::args().collect();
+
+ let query = &args[1];
+ let file_path = &args[2];
+
+ println!("Searching for {query}");
+ println!("In file {file_path}");
+
+ let contents = fs::read_to_string(file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+Listing 12-4: Reading the contents of the file specified by the second argument
+
+
First, we bring in a relevant part of the standard library with a use
+statement: we need std::fs to handle files.
+
In main, the new statement fs::read_to_string takes the file_path, opens
+that file, and returns a std::io::Result<String> of the file’s contents.
+
After that, we again add a temporary println! statement that prints the value
+of contents after the file is read, so we can check that the program is
+working so far.
+
Let’s run this code with any string as the first command line argument (because
+we haven’t implemented the searching part yet) and the poem.txt file as the
+second argument:
+
$ cargo run -- the poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep the poem.txt`
+Searching for the
+In file poem.txt
+With text:
+I'm nobody! Who are you?
+Are you nobody, too?
+Then there's a pair of us - don't tell!
+They'd banish us, you know.
+
+How dreary to be somebody!
+How public, like a frog
+To tell your name the livelong day
+To an admiring bog!
+
+
+
Great! The code read and then printed the contents of the file. But the code
+has a few flaws. At the moment, the main function has multiple
+responsibilities: generally, functions are clearer and easier to maintain if
+each function is responsible for only one idea. The other problem is that we’re
+not handling errors as well as we could. The program is still small, so these
+flaws aren’t a big problem, but as the program grows, it will be harder to fix
+them cleanly. It’s good practice to begin refactoring early on when developing
+a program, because it’s much easier to refactor smaller amounts of code. We’ll
+do that next.
To improve our program, we’ll fix four problems that have to do with the
+program’s structure and how it’s handling potential errors. First, our main
+function now performs two tasks: it parses arguments and reads files. As our
+program grows, the number of separate tasks the main function handles will
+increase. As a function gains responsibilities, it becomes more difficult to
+reason about, harder to test, and harder to change without breaking one of its
+parts. It’s best to separate functionality so each function is responsible for
+one task.
+
This issue also ties into the second problem: although query and file_path
+are configuration variables to our program, variables like contents are used
+to perform the program’s logic. The longer main becomes, the more variables
+we’ll need to bring into scope; the more variables we have in scope, the harder
+it will be to keep track of the purpose of each. It’s best to group the
+configuration variables into one structure to make their purpose clear.
+
The third problem is that we’ve used expect to print an error message when
+reading the file fails, but the error message just prints Should have been able to read the file. Reading a file can fail in a number of ways: for
+example, the file could be missing, or we might not have permission to open it.
+Right now, regardless of the situation, we’d print the same error message for
+everything, which wouldn’t give the user any information!
+
Fourth, we use expect to handle an error, and if the user runs our program
+without specifying enough arguments, they’ll get an index out of bounds error
+from Rust that doesn’t clearly explain the problem. It would be best if all the
+error-handling code were in one place so future maintainers had only one place
+to consult the code if the error-handling logic needed to change. Having all the
+error-handling code in one place will also ensure that we’re printing messages
+that will be meaningful to our end users.
+
Let’s address these four problems by refactoring our project.
The organizational problem of allocating responsibility for multiple tasks to
+the main function is common to many binary projects. As a result, the Rust
+community has developed guidelines for splitting the separate concerns of a
+binary program when main starts getting large. This process has the following
+steps:
+
+
Split your program into a main.rs and a lib.rs and move your program’s
+logic to lib.rs.
+
As long as your command line parsing logic is small, it can remain in
+main.rs.
+
When the command line parsing logic starts getting complicated, extract it
+from main.rs and move it to lib.rs.
+
+
The responsibilities that remain in the main function after this process
+should be limited to the following:
+
+
Calling the command line parsing logic with the argument values
+
Setting up any other configuration
+
Calling a run function in lib.rs
+
Handling the error if run returns an error
+
+
This pattern is about separating concerns: main.rs handles running the
+program, and lib.rs handles all the logic of the task at hand. Because you
+can’t test the main function directly, this structure lets you test all of
+your program’s logic by moving it into functions in lib.rs. The code that
+remains in main.rs will be small enough to verify its correctness by reading
+it. Let’s rework our program by following this process.
We’ll extract the functionality for parsing arguments into a function that
+main will call to prepare for moving the command line parsing logic to
+src/lib.rs. Listing 12-5 shows the new start of main that calls a new
+function parse_config, which we’ll define in src/main.rs for the moment.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let (query, file_path) = parse_config(&args);
+
+ // --snip--
+
+ println!("Searching for {query}");
+ println!("In file {file_path}");
+
+ let contents = fs::read_to_string(file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+fn parse_config(args: &[String]) -> (&str, &str) {
+ let query = &args[1];
+ let file_path = &args[2];
+
+ (query, file_path)
+}
+Listing 12-5: Extracting a parse_config function from main
+
+
We’re still collecting the command line arguments into a vector, but instead of
+assigning the argument value at index 1 to the variable query and the
+argument value at index 2 to the variable file_path within the main
+function, we pass the whole vector to the parse_config function. The
+parse_config function then holds the logic that determines which argument
+goes in which variable and passes the values back to main. We still create
+the query and file_path variables in main, but main no longer has the
+responsibility of determining how the command line arguments and variables
+correspond.
+
This rework may seem like overkill for our small program, but we’re refactoring
+in small, incremental steps. After making this change, run the program again to
+verify that the argument parsing still works. It’s good to check your progress
+often, to help identify the cause of problems when they occur.
We can take another small step to improve the parse_config function further.
+At the moment, we’re returning a tuple, but then we immediately break that
+tuple into individual parts again. This is a sign that perhaps we don’t have
+the right abstraction yet.
+
Another indicator that shows there’s room for improvement is the config part
+of parse_config, which implies that the two values we return are related and
+are both part of one configuration value. We’re not currently conveying this
+meaning in the structure of the data other than by grouping the two values into
+a tuple; we’ll instead put the two values into one struct and give each of the
+struct fields a meaningful name. Doing so will make it easier for future
+maintainers of this code to understand how the different values relate to each
+other and what their purpose is.
+
Listing 12-6 shows the improvements to the parse_config function.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = parse_config(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ // --snip--
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+fn parse_config(args: &[String]) -> Config {
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Config { query, file_path }
+}
+Listing 12-6: Refactoring parse_config to return an instance of a Config struct
+
+
We’ve added a struct named Config defined to have fields named query and
+file_path. The signature of parse_config now indicates that it returns a
+Config value. In the body of parse_config, where we used to return
+string slices that reference String values in args, we now define Config
+to contain owned String values. The args variable in main is the owner of
+the argument values and is only letting the parse_config function borrow
+them, which means we’d violate Rust’s borrowing rules if Config tried to take
+ownership of the values in args.
+
There are a number of ways we could manage the String data; the easiest,
+though somewhat inefficient, route is to call the clone method on the values.
+This will make a full copy of the data for the Config instance to own, which
+takes more time and memory than storing a reference to the string data.
+However, cloning the data also makes our code very straightforward because we
+don’t have to manage the lifetimes of the references; in this circumstance,
+giving up a little performance to gain simplicity is a worthwhile trade-off.
There’s a tendency among many Rustaceans to avoid using clone to fix
+ownership problems because of its runtime cost. In
+Chapter 13, you’ll learn how to use more efficient
+methods in this type of situation. But for now, it’s okay to copy a few
+strings to continue making progress because you’ll make these copies only
+once and your file path and query string are very small. It’s better to have
+a working program that’s a bit inefficient than to try to hyperoptimize code
+on your first pass. As you become more experienced with Rust, it’ll be
+easier to start with the most efficient solution, but for now, it’s
+perfectly acceptable to call clone.
+
+
We’ve updated main so it places the instance of Config returned by
+parse_config into a variable named config, and we updated the code that
+previously used the separate query and file_path variables so it now uses
+the fields on the Config struct instead.
+
Now our code more clearly conveys that query and file_path are related and
+that their purpose is to configure how the program will work. Any code that
+uses these values knows to find them in the config instance in the fields
+named for their purpose.
So far, we’ve extracted the logic responsible for parsing the command line
+arguments from main and placed it in the parse_config function. Doing so
+helped us to see that the query and file_path values were related and that
+relationship should be conveyed in our code. We then added a Config struct to
+name the related purpose of query and file_path and to be able to return the
+values’ names as struct field names from the parse_config function.
+
So now that the purpose of the parse_config function is to create a Config
+instance, we can change parse_config from a plain function to a function
+named new that is associated with the Config struct. Making this change
+will make the code more idiomatic. We can create instances of types in the
+standard library, such as String, by calling String::new. Similarly, by
+changing parse_config into a new function associated with Config, we’ll
+be able to create instances of Config by calling Config::new. Listing 12-7
+shows the changes we need to make.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::new(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+
+ // --snip--
+}
+
+// --snip--
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ fn new(args: &[String]) -> Config {
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Config { query, file_path }
+ }
+}
+Listing 12-7: Changing parse_config into Config::new
+
+
We’ve updated main where we were calling parse_config to instead call
+Config::new. We’ve changed the name of parse_config to new and moved it
+within an impl block, which associates the new function with Config. Try
+compiling this code again to make sure it works.
Now we’ll work on fixing our error handling. Recall that attempting to access
+the values in the args vector at index 1 or index 2 will cause the program to
+panic if the vector contains fewer than three items. Try running the program
+without any arguments; it will look like this:
+
$ cargo run
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep`
+thread 'main' panicked at src/main.rs:27:21:
+index out of bounds: the len is 1 but the index is 1
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
The line index out of bounds: the len is 1 but the index is 1 is an error
+message intended for programmers. It won’t help our end users understand what
+they should do instead. Let’s fix that now.
In Listing 12-8, we add a check in the new function that will verify that the
+slice is long enough before accessing index 1 and 2. If the slice isn’t long
+enough, the program panics and displays a better error message.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::new(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ // --snip--
+ fn new(args: &[String]) -> Config {
+ if args.len() < 3 {
+ panic!("not enough arguments");
+ }
+ // --snip--
+
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Config { query, file_path }
+ }
+}
+Listing 12-8: Adding a check for the number of arguments
+
+
This code is similar to the Guess::new function we wrote in Listing
+9-13, where we called panic! when the
+value argument was out of the range of valid values. Instead of checking for
+a range of values here, we’re checking that the length of args is at least 3
+and the rest of the function can operate under the assumption that this
+condition has been met. If args has fewer than three items, this condition
+will be true, and we call the panic! macro to end the program immediately.
+
With these extra few lines of code in new, let’s run the program without any
+arguments again to see what the error looks like now:
+
$ cargo run
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep`
+thread 'main' panicked at src/main.rs:26:13:
+not enough arguments
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
This output is better: we now have a reasonable error message. However, we also
+have extraneous information we don’t want to give to our users. Perhaps using
+the technique we used in Listing 9-13 isn’t the best to use here: a call to
+panic! is more appropriate for a programming problem than a usage problem,
+as discussed in Chapter 9. Instead,
+we’ll use the other technique you learned about in Chapter 9—returning a
+Result that indicates either success or an error.
We can instead return a Result value that will contain a Config instance in
+the successful case and will describe the problem in the error case. We’re also
+going to change the function name from new to build because many
+programmers expect new functions to never fail. When Config::build is
+communicating to main, we can use the Result type to signal there was a
+problem. Then we can change main to convert an Err variant into a more
+practical error for our users without the surrounding text about thread 'main' and RUST_BACKTRACE that a call to panic! causes.
+
Listing 12-9 shows the changes we need to make to the return value of the
+function we’re now calling Config::build and the body of the function needed
+to return a Result. Note that this won’t compile until we update main as
+well, which we’ll do in the next listing.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::new(&args);
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ fn build(args: &[String]) -> Result<Config, &'static str> {
+ if args.len() < 3 {
+ return Err("not enough arguments");
+ }
+
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Ok(Config { query, file_path })
+ }
+}
+Listing 12-9: Returning a Result from Config::build
+
+
Our build function returns a Result with a Config instance in the success
+case and a &'static str in the error case. Our error values will always be
+string literals that have the 'static lifetime.
+
We’ve made two changes in the body of the function: instead of calling panic!
+when the user doesn’t pass enough arguments, we now return an Err value, and
+we’ve wrapped the Config return value in an Ok. These changes make the
+function conform to its new type signature.
+
Returning an Err value from Config::build allows the main function to
+handle the Result value returned from the build function and exit the
+process more cleanly in the error case.
To handle the error case and print a user-friendly message, we need to update
+main to handle the Result being returned by Config::build, as shown in
+Listing 12-10. We’ll also take the responsibility of exiting the command line
+tool with a nonzero error code away from panic! and instead implement it by
+hand. A nonzero exit status is a convention to signal to the process that
+called our program that the program exited with an error state.
+
+Filename: src/main.rs
+
use std::env;
+use std::fs;
+use std::process;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::build(&args).unwrap_or_else(|err| {
+ println!("Problem parsing arguments: {err}");
+ process::exit(1);
+ });
+
+ // --snip--
+
+ println!("Searching for {}", config.query);
+ println!("In file {}", config.file_path);
+
+ let contents = fs::read_to_string(config.file_path)
+ .expect("Should have been able to read the file");
+
+ println!("With text:\n{contents}");
+}
+
+struct Config {
+ query: String,
+ file_path: String,
+}
+
+impl Config {
+ fn build(args: &[String]) -> Result<Config, &'static str> {
+ if args.len() < 3 {
+ return Err("not enough arguments");
+ }
+
+ let query = args[1].clone();
+ let file_path = args[2].clone();
+
+ Ok(Config { query, file_path })
+ }
+}
+Listing 12-10: Exiting with an error code if building a Config fails
+
+
In this listing, we’ve used a method we haven’t covered in detail yet:
+unwrap_or_else, which is defined on Result<T, E> by the standard library.
+Using unwrap_or_else allows us to define some custom, non-panic! error
+handling. If the Result is an Ok value, this method’s behavior is similar
+to unwrap: it returns the inner value Ok is wrapping. However, if the value
+is an Err value, this method calls the code in the closure, which is an
+anonymous function we define and pass as an argument to unwrap_or_else. We’ll
+cover closures in more detail in Chapter 13. For now,
+you just need to know that unwrap_or_else will pass the inner value of the
+Err, which in this case is the static string "not enough arguments" that we
+added in Listing 12-9, to our closure in the argument err that appears
+between the vertical pipes. The code in the closure can then use the err
+value when it runs.
+
We’ve added a new use line to bring process from the standard library into
+scope. The code in the closure that will be run in the error case is only two
+lines: we print the err value and then call process::exit. The
+process::exit function will stop the program immediately and return the
+number that was passed as the exit status code. This is similar to the
+panic!-based handling we used in Listing 12-8, but we no longer get all the
+extra output. Let’s try it:
+
$ cargo run
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.48s
+ Running `target/debug/minigrep`
+Problem parsing arguments: not enough arguments
+
+
Great! This output is much friendlier for our users.
Now that we’ve finished refactoring the configuration parsing, let’s turn to
+the program’s logic. As we stated in “Separation of Concerns for Binary
+Projects”, we’ll
+extract a function named run that will hold all the logic currently in the
+main function that isn’t involved with setting up configuration or handling
+errors. When we’re done, main will be concise and easy to verify by
+inspection, and we’ll be able to write tests for all the other logic.
+
Listing 12-11 shows the extracted run function. For now, we’re just making
+the small, incremental improvement of extracting the function. We’re still
+defining the function in src/main.rs.
+Listing 12-11: Extracting a run function containing the rest of the program logic
+
+
The run function now contains all the remaining logic from main, starting
+from reading the file. The run function takes the Config instance as an
+argument.
With the remaining program logic separated into the run function, we can
+improve the error handling, as we did with Config::build in Listing 12-9.
+Instead of allowing the program to panic by calling expect, the run
+function will return a Result<T, E> when something goes wrong. This will let
+us further consolidate the logic around handling errors into main in a
+user-friendly way. Listing 12-12 shows the changes we need to make to the
+signature and body of run.
+Listing 12-12: Changing the run function to return Result
+
+
We’ve made three significant changes here. First, we changed the return type of
+the run function to Result<(), Box<dyn Error>>. This function previously
+returned the unit type, (), and we keep that as the value returned in the
+Ok case.
+
For the error type, we used the trait objectBox<dyn Error> (and we’ve
+brought std::error::Error into scope with a use statement at the top).
+We’ll cover trait objects in Chapter 17. For now, just
+know that Box<dyn Error> means the function will return a type that
+implements the Error trait, but we don’t have to specify what particular type
+the return value will be. This gives us flexibility to return error values that
+may be of different types in different error cases. The dyn keyword is short
+for “dynamic.”
+
Second, we’ve removed the call to expect in favor of the ? operator, as we
+talked about in Chapter 9. Rather than
+panic! on an error, ? will return the error value from the current function
+for the caller to handle.
+
Third, the run function now returns an Ok value in the success case.
+We’ve declared the run function’s success type as () in the signature,
+which means we need to wrap the unit type value in the Ok value. This
+Ok(()) syntax might look a bit strange at first, but using () like this is
+the idiomatic way to indicate that we’re calling run for its side effects
+only; it doesn’t return a value we need.
+
When you run this code, it will compile but will display a warning:
+
$ cargo run -- the poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+warning: unused `Result` that must be used
+ --> src/main.rs:19:5
+ |
+19 | run(config);
+ | ^^^^^^^^^^^
+ |
+ = note: this `Result` may be an `Err` variant, which should be handled
+ = note: `#[warn(unused_must_use)]` on by default
+help: use `let _ = ...` to ignore the resulting value
+ |
+19 | let _ = run(config);
+ | +++++++
+
+warning: `minigrep` (bin "minigrep") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.71s
+ Running `target/debug/minigrep the poem.txt`
+Searching for the
+In file poem.txt
+With text:
+I'm nobody! Who are you?
+Are you nobody, too?
+Then there's a pair of us - don't tell!
+They'd banish us, you know.
+
+How dreary to be somebody!
+How public, like a frog
+To tell your name the livelong day
+To an admiring bog!
+
+
+
Rust tells us that our code ignored the Result value and the Result value
+might indicate that an error occurred. But we’re not checking to see whether or
+not there was an error, and the compiler reminds us that we probably meant to
+have some error-handling code here! Let’s rectify that problem now.
We use if let rather than unwrap_or_else to check whether run returns an
+Err value and call process::exit(1) if it does. The run function doesn’t
+return a value that we want to unwrap in the same way that Config::build
+returns the Config instance. Because run returns () in the success case,
+we only care about detecting an error, so we don’t need unwrap_or_else to
+return the unwrapped value, which would only be ().
+
The bodies of the if let and the unwrap_or_else functions are the same in
+both cases: we print the error and exit.
Our minigrep project is looking good so far! Now we’ll split the
+src/main.rs file and put some code into the src/lib.rs file. That way we
+can test the code and have a src/main.rs file with fewer responsibilities.
+
Let’s move all the code that isn’t the main function from src/main.rs to
+src/lib.rs:
+
+
The run function definition
+
The relevant use statements
+
The definition of Config
+
The Config::build function definition
+
+
The contents of src/lib.rs should have the signatures shown in Listing 12-13
+(we’ve omitted the bodies of the functions for brevity). Note that this won’t
+compile until we modify src/main.rs in Listing 12-14.
+Listing 12-13: Moving Config and run into src/lib.rs
+
+
We’ve made liberal use of the pub keyword: on Config, on its fields and its
+build method, and on the run function. We now have a library crate that has
+a public API we can test!
+
Now we need to bring the code we moved to src/lib.rs into the scope of the
+binary crate in src/main.rs, as shown in Listing 12-14.
+Listing 12-14: Using the minigrep library crate in src/main.rs
+
+
We add a use minigrep::Config line to bring the Config type from the
+library crate into the binary crate’s scope, and we prefix the run function
+with our crate name. Now all the functionality should be connected and should
+work. Run the program with cargo run and make sure everything works
+correctly.
+
Whew! That was a lot of work, but we’ve set ourselves up for success in the
+future. Now it’s much easier to handle errors, and we’ve made the code more
+modular. Almost all of our work will be done in src/lib.rs from here on out.
+
Let’s take advantage of this newfound modularity by doing something that would
+have been difficult with the old code but is easy with the new code: we’ll
+write some tests!
Now that we’ve extracted the logic into src/lib.rs and left the argument
+collecting and error handling in src/main.rs, it’s much easier to write tests
+for the core functionality of our code. We can call functions directly with
+various arguments and check return values without having to call our binary
+from the command line.
+
In this section, we’ll add the searching logic to the minigrep program
+using the test-driven development (TDD) process with the following steps:
+
+
Write a test that fails and run it to make sure it fails for the reason you
+expect.
+
Write or modify just enough code to make the new test pass.
+
Refactor the code you just added or changed and make sure the tests
+continue to pass.
+
Repeat from step 1!
+
+
Though it’s just one of many ways to write software, TDD can help drive code
+design. Writing the test before you write the code that makes the test pass
+helps to maintain high test coverage throughout the process.
+
We’ll test drive the implementation of the functionality that will actually do
+the searching for the query string in the file contents and produce a list of
+lines that match the query. We’ll add this functionality in a function called
+search.
Because we don’t need them anymore, let’s remove the println! statements from
+src/lib.rs and src/main.rs that we used to check the program’s behavior.
+Then, in src/lib.rs, add a tests module with a test function, as we did in
+Chapter 11. The test function specifies the
+behavior we want the search function to have: it will take a query and the
+text to search, and it will return only the lines from the text that contain
+the query. Listing 12-15 shows this test, which won’t compile yet.
+Listing 12-15: Creating a failing test for the search function we wish we had
+
+
This test searches for the string "duct". The text we’re searching is three
+lines, only one of which contains "duct" (Note that the backslash after the
+opening double quote tells Rust not to put a newline character at the beginning
+of the contents of this string literal). We assert that the value returned from
+the search function contains only the line we expect.
+
We aren’t yet able to run this test and watch it fail because the test doesn’t
+even compile: the search function doesn’t exist yet! In accordance with TDD
+principles, we’ll add just enough code to get the test to compile and run by
+adding a definition of the search function that always returns an empty
+vector, as shown in Listing 12-16. Then the test should compile and fail
+because an empty vector doesn’t match a vector containing the line "safe, fast, productive."
+Listing 12-16: Defining just enough of the search function so our test will compile
+
+
Notice that we need to define an explicit lifetime 'a in the signature of
+search and use that lifetime with the contents argument and the return
+value. Recall in Chapter 10 that the lifetime
+parameters specify which argument lifetime is connected to the lifetime of the
+return value. In this case, we indicate that the returned vector should contain
+string slices that reference slices of the argument contents (rather than the
+argument query).
+
In other words, we tell Rust that the data returned by the search function
+will live as long as the data passed into the search function in the
+contents argument. This is important! The data referenced by a slice needs
+to be valid for the reference to be valid; if the compiler assumes we’re making
+string slices of query rather than contents, it will do its safety checking
+incorrectly.
+
If we forget the lifetime annotations and try to compile this function, we’ll
+get this error:
+
$ cargo build
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+error[E0106]: missing lifetime specifier
+ --> src/lib.rs:28:51
+ |
+28 | pub fn search(query: &str, contents: &str) -> Vec<&str> {
+ | ---- ---- ^ expected named lifetime parameter
+ |
+ = help: this function's return type contains a borrowed value, but the signature does not say whether it is borrowed from `query` or `contents`
+help: consider introducing a named lifetime parameter
+ |
+28 | pub fn search<'a>(query: &'a str, contents: &'a str) -> Vec<&'a str> {
+ | ++++ ++ ++ ++
+
+For more information about this error, try `rustc --explain E0106`.
+error: could not compile `minigrep` (lib) due to 1 previous error
+
+
Rust can’t possibly know which of the two arguments we need, so we need to tell
+it explicitly. Because contents is the argument that contains all of our text
+and we want to return the parts of that text that match, we know contents is
+the argument that should be connected to the return value using the lifetime
+syntax.
+
Other programming languages don’t require you to connect arguments to return
+values in the signature, but this practice will get easier over time. You might
+want to compare this example with the “Validating References with
+Lifetimes” section in
+Chapter 10.
+
Now let’s run the test:
+
$ cargo test
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.97s
+ Running unittests src/lib.rs (target/debug/deps/minigrep-9cd200e5fac0fc94)
+
+running 1 test
+test tests::one_result ... FAILED
+
+failures:
+
+---- tests::one_result stdout ----
+thread 'tests::one_result' panicked at src/lib.rs:44:9:
+assertion `left == right` failed
+ left: ["safe, fast, productive."]
+ right: []
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::one_result
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Great, the test fails, exactly as we expected. Let’s get the test to pass!
Rust has a helpful method to handle line-by-line iteration of strings,
+conveniently named lines, that works as shown in Listing 12-17. Note this
+won’t compile yet.
+Listing 12-17: Iterating through each line in contents
+
+
The lines method returns an iterator. We’ll talk about iterators in depth in
+Chapter 13, but recall that you saw this way
+of using an iterator in Listing 3-5, where we used a
+for loop with an iterator to run some code on each item in a collection.
Next, we’ll check whether the current line contains our query string.
+Fortunately, strings have a helpful method named contains that does this for
+us! Add a call to the contains method in the search function, as shown in
+Listing 12-18. Note this still won’t compile yet.
+Listing 12-18: Adding functionality to see whether the line contains the string in query
+
+
At the moment, we’re building up functionality. To get it to compile, we need
+to return a value from the body as we indicated we would in the function
+signature.
To finish this function, we need a way to store the matching lines that we want
+to return. For that, we can make a mutable vector before the for loop and
+call the push method to store a line in the vector. After the for loop,
+we return the vector, as shown in Listing 12-19.
At this point, we could consider opportunities for refactoring the
+implementation of the search function while keeping the tests passing to
+maintain the same functionality. The code in the search function isn’t too bad,
+but it doesn’t take advantage of some useful features of iterators. We’ll
+return to this example in Chapter 13, where
+we’ll explore iterators in detail, and look at how to improve it.
Now that the search function is working and tested, we need to call search
+from our run function. We need to pass the config.query value and the
+contents that run reads from the file to the search function. Then run
+will print each line returned from search:
We’re still using a for loop to return each line from search and print it.
+
Now the entire program should work! Let’s try it out, first with a word that
+should return exactly one line from the Emily Dickinson poem, “frog”:
+
$ cargo run -- frog poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.38s
+ Running `target/debug/minigrep frog poem.txt`
+How public, like a frog
+
+
Cool! Now let’s try a word that will match multiple lines, like “body”:
+
$ cargo run -- body poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep body poem.txt`
+I'm nobody! Who are you?
+Are you nobody, too?
+How dreary to be somebody!
+
+
And finally, let’s make sure that we don’t get any lines when we search for a
+word that isn’t anywhere in the poem, such as “monomorphization”:
Excellent! We’ve built our own mini version of a classic tool and learned a lot
+about how to structure applications. We’ve also learned a bit about file input
+and output, lifetimes, testing, and command line parsing.
+
To round out this project, we’ll briefly demonstrate how to work with
+environment variables and how to print to standard error, both of which are
+useful when you’re writing command line programs.
We’ll improve minigrep by adding an extra feature: an option for
+case-insensitive searching that the user can turn on via an environment
+variable. We could make this feature a command line option and require that
+users enter it each time they want it to apply, but by instead making it an
+environment variable, we allow our users to set the environment variable once
+and have all their searches be case insensitive in that terminal session.
We first add a new search_case_insensitive function that will be called when
+the environment variable has a value. We’ll continue to follow the TDD process,
+so the first step is again to write a failing test. We’ll add a new test for
+the new search_case_insensitive function and rename our old test from
+one_result to case_sensitive to clarify the differences between the two
+tests, as shown in Listing 12-20.
+Listing 12-20: Adding a new failing test for the case-insensitive function we’re about to add
+
+
Note that we’ve edited the old test’s contents too. We’ve added a new line
+with the text "Duct tape." using a capital D that shouldn’t match the query
+"duct" when we’re searching in a case-sensitive manner. Changing the old test
+in this way helps ensure that we don’t accidentally break the case-sensitive
+search functionality that we’ve already implemented. This test should pass now
+and should continue to pass as we work on the case-insensitive search.
+
The new test for the case-insensitive search uses "rUsT" as its query. In
+the search_case_insensitive function we’re about to add, the query "rUsT"
+should match the line containing "Rust:" with a capital R and match the line
+"Trust me." even though both have different casing from the query. This is
+our failing test, and it will fail to compile because we haven’t yet defined
+the search_case_insensitive function. Feel free to add a skeleton
+implementation that always returns an empty vector, similar to the way we did
+for the search function in Listing 12-16 to see the test compile and fail.
The search_case_insensitive function, shown in Listing 12-21, will be almost
+the same as the search function. The only difference is that we’ll lowercase
+the query and each line so whatever the case of the input arguments,
+they’ll be the same case when we check whether the line contains the query.
+Listing 12-21: Defining the search_case_insensitive function to lowercase the query and the line before comparing them
+
+
First, we lowercase the query string and store it in a shadowed variable with
+the same name. Calling to_lowercase on the query is necessary so no
+matter whether the user’s query is "rust", "RUST", "Rust", or "rUsT",
+we’ll treat the query as if it were "rust" and be insensitive to the case.
+While to_lowercase will handle basic Unicode, it won’t be 100% accurate. If
+we were writing a real application, we’d want to do a bit more work here, but
+this section is about environment variables, not Unicode, so we’ll leave it at
+that here.
+
Note that query is now a String rather than a string slice, because calling
+to_lowercase creates new data rather than referencing existing data. Say the
+query is "rUsT", as an example: that string slice doesn’t contain a lowercase
+u or t for us to use, so we have to allocate a new String containing
+"rust". When we pass query as an argument to the contains method now, we
+need to add an ampersand because the signature of contains is defined to take
+a string slice.
+
Next, we add a call to to_lowercase on each line to lowercase all
+characters. Now that we’ve converted line and query to lowercase, we’ll
+find matches no matter what the case of the query is.
+
Let’s see if this implementation passes the tests:
Great! They passed. Now, let’s call the new search_case_insensitive function
+from the run function. First, we’ll add a configuration option to the
+Config struct to switch between case-sensitive and case-insensitive search.
+Adding this field will cause compiler errors because we aren’t initializing
+this field anywhere yet:
We added the ignore_case field that holds a Boolean. Next, we need the run
+function to check the ignore_case field’s value and use that to decide
+whether to call the search function or the search_case_insensitive
+function, as shown in Listing 12-22. This still won’t compile yet.
+Listing 12-22: Calling either search or search_case_insensitive based on the value in config.ignore_case
+
+
Finally, we need to check for the environment variable. The functions for
+working with environment variables are in the env module in the standard
+library, so we bring that module into scope at the top of src/lib.rs. Then
+we’ll use the var function from the env module to check if any value
+has been set for an environment variable named IGNORE_CASE, as shown in
+Listing 12-23.
+Listing 12-23: Checking for any value in an environment variable named IGNORE_CASE
+
+
Here, we create a new variable ignore_case. To set its value, we call the
+env::var function and pass it the name of the IGNORE_CASE environment
+variable. The env::var function returns a Result that will be the
+successful Ok variant that contains the value of the environment variable if
+the environment variable is set to any value. It will return the Err variant
+if the environment variable is not set.
+
We’re using the is_ok method on the Result to check whether the environment
+variable is set, which means the program should do a case-insensitive search.
+If the IGNORE_CASE environment variable isn’t set to anything, is_ok will
+return false and the program will perform a case-sensitive search. We don’t
+care about the value of the environment variable, just whether it’s set or
+unset, so we’re checking is_ok rather than using unwrap, expect, or any
+of the other methods we’ve seen on Result.
+
We pass the value in the ignore_case variable to the Config instance so the
+run function can read that value and decide whether to call
+search_case_insensitive or search, as we implemented in Listing 12-22.
+
Let’s give it a try! First, we’ll run our program without the environment
+variable set and with the query to, which should match any line that contains
+the word “to” in all lowercase:
+
$ cargo run -- to poem.txt
+ Compiling minigrep v0.1.0 (file:///projects/minigrep)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/minigrep to poem.txt`
+Are you nobody, too?
+How dreary to be somebody!
+
+
Looks like that still works! Now, let’s run the program with IGNORE_CASE
+set to 1 but with the same query to.
+
$ IGNORE_CASE=1 cargo run -- to poem.txt
+
+
If you’re using PowerShell, you will need to set the environment variable and
+run the program as separate commands:
+
PS> $Env:IGNORE_CASE=1; cargo run -- to poem.txt
+
+
This will make IGNORE_CASE persist for the remainder of your shell
+session. It can be unset with the Remove-Item cmdlet:
+
PS> Remove-Item Env:IGNORE_CASE
+
+
We should get lines that contain “to” that might have uppercase letters:
+
+
Are you nobody, too?
+How dreary to be somebody!
+To tell your name the livelong day
+To an admiring bog!
+
+
Excellent, we also got lines containing “To”! Our minigrep program can now do
+case-insensitive searching controlled by an environment variable. Now you know
+how to manage options set using either command line arguments or environment
+variables.
+
Some programs allow arguments and environment variables for the same
+configuration. In those cases, the programs decide that one or the other takes
+precedence. For another exercise on your own, try controlling case sensitivity
+through either a command line argument or an environment variable. Decide
+whether the command line argument or the environment variable should take
+precedence if the program is run with one set to case sensitive and one set to
+ignore case.
+
The std::env module contains many more useful features for dealing with
+environment variables: check out its documentation to see what is available.
At the moment, we’re writing all of our output to the terminal using the
+println! macro. In most terminals, there are two kinds of output: standard
+output (stdout) for general information and standard error (stderr) for
+error messages. This distinction enables users to choose to direct the
+successful output of a program to a file but still print error messages to the
+screen.
+
The println! macro is only capable of printing to standard output, so we
+have to use something else to print to standard error.
First, let’s observe how the content printed by minigrep is currently being
+written to standard output, including any error messages we want to write to
+standard error instead. We’ll do that by redirecting the standard output stream
+to a file while intentionally causing an error. We won’t redirect the standard
+error stream, so any content sent to standard error will continue to display on
+the screen.
+
Command line programs are expected to send error messages to the standard error
+stream so we can still see error messages on the screen even if we redirect the
+standard output stream to a file. Our program is not currently well-behaved:
+we’re about to see that it saves the error message output to a file instead!
+
To demonstrate this behavior, we’ll run the program with > and the file path,
+output.txt, that we want to redirect the standard output stream to. We won’t
+pass any arguments, which should cause an error:
+
$ cargo run > output.txt
+
+
The > syntax tells the shell to write the contents of standard output to
+output.txt instead of the screen. We didn’t see the error message we were
+expecting printed to the screen, so that means it must have ended up in the
+file. This is what output.txt contains:
+
Problem parsing arguments: not enough arguments
+
+
Yup, our error message is being printed to standard output. It’s much more
+useful for error messages like this to be printed to standard error so only
+data from a successful run ends up in the file. We’ll change that.
We’ll use the code in Listing 12-24 to change how error messages are printed.
+Because of the refactoring we did earlier in this chapter, all the code that
+prints error messages is in one function, main. The standard library provides
+the eprintln! macro that prints to the standard error stream, so let’s change
+the two places we were calling println! to print errors to use eprintln!
+instead.
+
+Filename: src/main.rs
+
use std::env;
+use std::process;
+
+use minigrep::Config;
+
+fn main() {
+ let args: Vec<String> = env::args().collect();
+
+ let config = Config::build(&args).unwrap_or_else(|err| {
+ eprintln!("Problem parsing arguments: {err}");
+ process::exit(1);
+ });
+
+ if let Err(e) = minigrep::run(config) {
+ eprintln!("Application error: {e}");
+ process::exit(1);
+ }
+}
+Listing 12-24: Writing error messages to standard error instead of standard output using eprintln!
+
+
Let’s now run the program again in the same way, without any arguments and
+redirecting standard output with >:
+
$ cargo run > output.txt
+Problem parsing arguments: not enough arguments
+
+
Now we see the error onscreen and output.txt contains nothing, which is the
+behavior we expect of command line programs.
+
Let’s run the program again with arguments that don’t cause an error but still
+redirect standard output to a file, like so:
+
$ cargo run -- to poem.txt > output.txt
+
+
We won’t see any output to the terminal, and output.txt will contain our
+results:
+
Filename: output.txt
+
Are you nobody, too?
+How dreary to be somebody!
+
+
This demonstrates that we’re now using standard output for successful output
+and standard error for error output as appropriate.
This chapter recapped some of the major concepts you’ve learned so far and
+covered how to perform common I/O operations in Rust. By using command line
+arguments, files, environment variables, and the eprintln! macro for printing
+errors, you’re now prepared to write command line applications. Combined with
+the concepts in previous chapters, your code will be well organized, store data
+effectively in the appropriate data structures, handle errors nicely, and be
+well tested.
+
Next, we’ll explore some Rust features that were influenced by functional
+languages: closures and iterators.
Rust’s design has taken inspiration from many existing languages and
+techniques, and one significant influence is functional programming.
+Programming in a functional style often includes using functions as values by
+passing them in arguments, returning them from other functions, assigning them
+to variables for later execution, and so forth.
+
In this chapter, we won’t debate the issue of what functional programming is or
+isn’t but will instead discuss some features of Rust that are similar to
+features in many languages often referred to as functional.
+
More specifically, we’ll cover:
+
+
Closures, a function-like construct you can store in a variable
+
Iterators, a way of processing a series of elements
+
How to use closures and iterators to improve the I/O project in Chapter 12
+
The performance of closures and iterators (Spoiler alert: they’re faster than
+you might think!)
+
+
We’ve already covered some other Rust features, such as pattern matching and
+enums, that are also influenced by the functional style. Because mastering
+closures and iterators is an important part of writing idiomatic, fast Rust
+code, we’ll devote this entire chapter to them.
Rust’s closures are anonymous functions you can save in a variable or pass as
+arguments to other functions. You can create the closure in one place and then
+call the closure elsewhere to evaluate it in a different context. Unlike
+functions, closures can capture values from the scope in which they’re defined.
+We’ll demonstrate how these closure features allow for code reuse and behavior
+customization.
We’ll first examine how we can use closures to capture values from the
+environment they’re defined in for later use. Here’s the scenario: Every so
+often, our t-shirt company gives away an exclusive, limited-edition shirt to
+someone on our mailing list as a promotion. People on the mailing list can
+optionally add their favorite color to their profile. If the person chosen for
+a free shirt has their favorite color set, they get that color shirt. If the
+person hasn’t specified a favorite color, they get whatever color the company
+currently has the most of.
+
There are many ways to implement this. For this example, we’re going to use an
+enum called ShirtColor that has the variants Red and Blue (limiting the
+number of colors available for simplicity). We represent the company’s
+inventory with an Inventory struct that has a field named shirts that
+contains a Vec<ShirtColor> representing the shirt colors currently in stock.
+The method giveaway defined on Inventory gets the optional shirt
+color preference of the free shirt winner, and returns the shirt color the
+person will get. This setup is shown in Listing 13-1:
+
+Filename: src/main.rs
+
#[derive(Debug, PartialEq, Copy, Clone)]
+enum ShirtColor {
+ Red,
+ Blue,
+}
+
+struct Inventory {
+ shirts: Vec<ShirtColor>,
+}
+
+impl Inventory {
+ fn giveaway(&self, user_preference: Option<ShirtColor>) -> ShirtColor {
+ user_preference.unwrap_or_else(|| self.most_stocked())
+ }
+
+ fn most_stocked(&self) -> ShirtColor {
+ let mut num_red = 0;
+ let mut num_blue = 0;
+
+ for color in &self.shirts {
+ match color {
+ ShirtColor::Red => num_red += 1,
+ ShirtColor::Blue => num_blue += 1,
+ }
+ }
+ if num_red > num_blue {
+ ShirtColor::Red
+ } else {
+ ShirtColor::Blue
+ }
+ }
+}
+
+fn main() {
+ let store = Inventory {
+ shirts: vec![ShirtColor::Blue, ShirtColor::Red, ShirtColor::Blue],
+ };
+
+ let user_pref1 = Some(ShirtColor::Red);
+ let giveaway1 = store.giveaway(user_pref1);
+ println!(
+ "The user with preference {:?} gets {:?}",
+ user_pref1, giveaway1
+ );
+
+ let user_pref2 = None;
+ let giveaway2 = store.giveaway(user_pref2);
+ println!(
+ "The user with preference {:?} gets {:?}",
+ user_pref2, giveaway2
+ );
+}
+Listing 13-1: Shirt company giveaway situation
+
+
The store defined in main has two blue shirts and one red shirt remaining
+to distribute for this limited-edition promotion. We call the giveaway method
+for a user with a preference for a red shirt and a user without any preference.
+
Again, this code could be implemented in many ways, and here, to focus on
+closures, we’ve stuck to concepts you’ve already learned except for the body of
+the giveaway method that uses a closure. In the giveaway method, we get the
+user preference as a parameter of type Option<ShirtColor> and call the
+unwrap_or_else method on user_preference. The unwrap_or_else method on
+Option<T> is defined by the standard library.
+It takes one argument: a closure without any arguments that returns a value T
+(the same type stored in the Some variant of the Option<T>, in this case
+ShirtColor). If the Option<T> is the Some variant, unwrap_or_else
+returns the value from within the Some. If the Option<T> is the None
+variant, unwrap_or_else calls the closure and returns the value returned by
+the closure.
+
We specify the closure expression || self.most_stocked() as the argument to
+unwrap_or_else. This is a closure that takes no parameters itself (if the
+closure had parameters, they would appear between the two vertical bars). The
+body of the closure calls self.most_stocked(). We’re defining the closure
+here, and the implementation of unwrap_or_else will evaluate the closure
+later if the result is needed.
+
Running this code prints:
+
$ cargo run
+ Compiling shirt-company v0.1.0 (file:///projects/shirt-company)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
+ Running `target/debug/shirt-company`
+The user with preference Some(Red) gets Red
+The user with preference None gets Blue
+
+
One interesting aspect here is that we’ve passed a closure that calls
+self.most_stocked() on the current Inventory instance. The standard library
+didn’t need to know anything about the Inventory or ShirtColor types we
+defined, or the logic we want to use in this scenario. The closure captures an
+immutable reference to the selfInventory instance and passes it with the
+code we specify to the unwrap_or_else method. Functions, on the other hand,
+are not able to capture their environment in this way.
There are more differences between functions and closures. Closures don’t
+usually require you to annotate the types of the parameters or the return value
+like fn functions do. Type annotations are required on functions because the
+types are part of an explicit interface exposed to your users. Defining this
+interface rigidly is important for ensuring that everyone agrees on what types
+of values a function uses and returns. Closures, on the other hand, aren’t used
+in an exposed interface like this: they’re stored in variables and used without
+naming them and exposing them to users of our library.
+
Closures are typically short and relevant only within a narrow context rather
+than in any arbitrary scenario. Within these limited contexts, the compiler can
+infer the types of the parameters and the return type, similar to how it’s able
+to infer the types of most variables (there are rare cases where the compiler
+needs closure type annotations too).
+
As with variables, we can add type annotations if we want to increase
+explicitness and clarity at the cost of being more verbose than is strictly
+necessary. Annotating the types for a closure would look like the definition
+shown in Listing 13-2. In this example, we’re defining a closure and storing it
+in a variable rather than defining the closure in the spot we pass it as an
+argument as we did in Listing 13-1.
+
+Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn generate_workout(intensity: u32, random_number: u32) {
+ let expensive_closure = |num: u32| -> u32 {
+ println!("calculating slowly...");
+ thread::sleep(Duration::from_secs(2));
+ num
+ };
+
+ if intensity < 25 {
+ println!("Today, do {} pushups!", expensive_closure(intensity));
+ println!("Next, do {} situps!", expensive_closure(intensity));
+ } else {
+ if random_number == 3 {
+ println!("Take a break today! Remember to stay hydrated!");
+ } else {
+ println!(
+ "Today, run for {} minutes!",
+ expensive_closure(intensity)
+ );
+ }
+ }
+}
+
+fn main() {
+ let simulated_user_specified_value = 10;
+ let simulated_random_number = 7;
+
+ generate_workout(simulated_user_specified_value, simulated_random_number);
+}
+Listing 13-2: Adding optional type annotations of the parameter and return value types in the closure
+
+
With type annotations added, the syntax of closures looks more similar to the
+syntax of functions. Here we define a function that adds 1 to its parameter and
+a closure that has the same behavior, for comparison. We’ve added some spaces
+to line up the relevant parts. This illustrates how closure syntax is similar
+to function syntax except for the use of pipes and the amount of syntax that is
+optional:
+
fn add_one_v1 (x: u32) -> u32 { x + 1 }
+let add_one_v2 = |x: u32| -> u32 { x + 1 };
+let add_one_v3 = |x| { x + 1 };
+let add_one_v4 = |x| x + 1 ;
+
The first line shows a function definition, and the second line shows a fully
+annotated closure definition. In the third line, we remove the type annotations
+from the closure definition. In the fourth line, we remove the brackets, which
+are optional because the closure body has only one expression. These are all
+valid definitions that will produce the same behavior when they’re called. The
+add_one_v3 and add_one_v4 lines require the closures to be evaluated to be
+able to compile because the types will be inferred from their usage. This is
+similar to let v = Vec::new(); needing either type annotations or values of
+some type to be inserted into the Vec for Rust to be able to infer the type.
+
For closure definitions, the compiler will infer one concrete type for each of
+their parameters and for their return value. For instance, Listing 13-3 shows
+the definition of a short closure that just returns the value it receives as a
+parameter. This closure isn’t very useful except for the purposes of this
+example. Note that we haven’t added any type annotations to the definition.
+Because there are no type annotations, we can call the closure with any type,
+which we’ve done here with String the first time. If we then try to call
+example_closure with an integer, we’ll get an error.
+
+Filename: src/main.rs
+
fn main() {
+ let example_closure = |x| x;
+
+ let s = example_closure(String::from("hello"));
+ let n = example_closure(5);
+}
+Listing 13-3: Attempting to call a closure whose types are inferred with two different types
+
+
The compiler gives us this error:
+
$ cargo run
+ Compiling closure-example v0.1.0 (file:///projects/closure-example)
+error[E0308]: mismatched types
+ --> src/main.rs:5:29
+ |
+5 | let n = example_closure(5);
+ | --------------- ^- help: try using a conversion method: `.to_string()`
+ | | |
+ | | expected `String`, found integer
+ | arguments to this function are incorrect
+ |
+note: expected because the closure was earlier called with an argument of type `String`
+ --> src/main.rs:4:29
+ |
+4 | let s = example_closure(String::from("hello"));
+ | --------------- ^^^^^^^^^^^^^^^^^^^^^ expected because this argument is of type `String`
+ | |
+ | in this closure call
+note: closure parameter defined here
+ --> src/main.rs:2:28
+ |
+2 | let example_closure = |x| x;
+ | ^
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `closure-example` (bin "closure-example") due to 1 previous error
+
+
The first time we call example_closure with the String value, the compiler
+infers the type of x and the return type of the closure to be String. Those
+types are then locked into the closure in example_closure, and we get a type
+error when we next try to use a different type with the same closure.
Closures can capture values from their environment in three ways, which
+directly map to the three ways a function can take a parameter: borrowing
+immutably, borrowing mutably, and taking ownership. The closure will decide
+which of these to use based on what the body of the function does with the
+captured values.
+
In Listing 13-4, we define a closure that captures an immutable reference to
+the vector named list because it only needs an immutable reference to print
+the value:
+Listing 13-4: Defining and calling a closure that captures an immutable reference
+
+
This example also illustrates that a variable can bind to a closure definition,
+and we can later call the closure by using the variable name and parentheses as
+if the variable name were a function name.
+
Because we can have multiple immutable references to list at the same time,
+list is still accessible from the code before the closure definition, after
+the closure definition but before the closure is called, and after the closure
+is called. This code compiles, runs, and prints:
Note that there’s no longer a println! between the definition and the call of
+the borrows_mutably closure: when borrows_mutably is defined, it captures a
+mutable reference to list. We don’t use the closure again after the closure
+is called, so the mutable borrow ends. Between the closure definition and the
+closure call, an immutable borrow to print isn’t allowed because no other
+borrows are allowed when there’s a mutable borrow. Try adding a println!
+there to see what error message you get!
+
If you want to force the closure to take ownership of the values it uses in the
+environment even though the body of the closure doesn’t strictly need
+ownership, you can use the move keyword before the parameter list.
+
This technique is mostly useful when passing a closure to a new thread to move
+the data so that it’s owned by the new thread. We’ll discuss threads and why
+you would want to use them in detail in Chapter 16 when we talk about
+concurrency, but for now, let’s briefly explore spawning a new thread using a
+closure that needs the move keyword. Listing 13-6 shows Listing 13-4 modified
+to print the vector in a new thread rather than in the main thread:
+
+Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let list = vec![1, 2, 3];
+ println!("Before defining closure: {list:?}");
+
+ thread::spawn(move || println!("From thread: {list:?}"))
+ .join()
+ .unwrap();
+}
+Listing 13-6: Using move to force the closure for the thread to take ownership of list
+
+
We spawn a new thread, giving the thread a closure to run as an argument. The
+closure body prints out the list. In Listing 13-4, the closure only captured
+list using an immutable reference because that’s the least amount of access
+to list needed to print it. In this example, even though the closure body
+still only needs an immutable reference, we need to specify that list should
+be moved into the closure by putting the move keyword at the beginning of the
+closure definition. The new thread might finish before the rest of the main
+thread finishes, or the main thread might finish first. If the main thread
+maintained ownership of list but ended before the new thread did and dropped
+list, the immutable reference in the thread would be invalid. Therefore, the
+compiler requires that list be moved into the closure given to the new thread
+so the reference will be valid. Try removing the move keyword or using list
+in the main thread after the closure is defined to see what compiler errors you
+get!
Once a closure has captured a reference or captured ownership of a value from
+the environment where the closure is defined (thus affecting what, if anything,
+is moved into the closure), the code in the body of the closure defines what
+happens to the references or values when the closure is evaluated later (thus
+affecting what, if anything, is moved out of the closure). A closure body can
+do any of the following: move a captured value out of the closure, mutate the
+captured value, neither move nor mutate the value, or capture nothing from the
+environment to begin with.
+
The way a closure captures and handles values from the environment affects
+which traits the closure implements, and traits are how functions and structs
+can specify what kinds of closures they can use. Closures will automatically
+implement one, two, or all three of these Fn traits, in an additive fashion,
+depending on how the closure’s body handles the values:
+
+
FnOnce applies to closures that can be called once. All closures implement
+at least this trait, because all closures can be called. A closure that
+moves captured values out of its body will only implement FnOnce and none
+of the other Fn traits, because it can only be called once.
+
FnMut applies to closures that don’t move captured values out of their
+body, but that might mutate the captured values. These closures can be
+called more than once.
+
Fn applies to closures that don’t move captured values out of their body
+and that don’t mutate captured values, as well as closures that capture
+nothing from their environment. These closures can be called more than once
+without mutating their environment, which is important in cases such as
+calling a closure multiple times concurrently.
+
+
Let’s look at the definition of the unwrap_or_else method on Option<T> that
+we used in Listing 13-1:
+
impl<T> Option<T> {
+ pub fn unwrap_or_else<F>(self, f: F) -> T
+ where
+ F: FnOnce() -> T
+ {
+ match self {
+ Some(x) => x,
+ None => f(),
+ }
+ }
+}
+
Recall that T is the generic type representing the type of the value in the
+Some variant of an Option. That type T is also the return type of the
+unwrap_or_else function: code that calls unwrap_or_else on an
+Option<String>, for example, will get a String.
+
Next, notice that the unwrap_or_else function has the additional generic type
+parameter F. The F type is the type of the parameter named f, which is
+the closure we provide when calling unwrap_or_else.
+
The trait bound specified on the generic type F is FnOnce() -> T, which
+means F must be able to be called once, take no arguments, and return a T.
+Using FnOnce in the trait bound expresses the constraint that
+unwrap_or_else is only going to call f at most one time. In the body of
+unwrap_or_else, we can see that if the Option is Some, f won’t be
+called. If the Option is None, f will be called once. Because all
+closures implement FnOnce, unwrap_or_else accepts all three kinds of
+closures and is as flexible as it can be.
+
+
Note: Functions can implement all three of the Fn traits too. If what we
+want to do doesn’t require capturing a value from the environment, we can use
+the name of a function rather than a closure where we need something that
+implements one of the Fn traits. For example, on an Option<Vec<T>> value,
+we could call unwrap_or_else(Vec::new) to get a new, empty vector if the
+value is None.
+
+
Now let’s look at the standard library method sort_by_key defined on slices,
+to see how that differs from unwrap_or_else and why sort_by_key uses
+FnMut instead of FnOnce for the trait bound. The closure gets one argument
+in the form of a reference to the current item in the slice being considered,
+and returns a value of type K that can be ordered. This function is useful
+when you want to sort a slice by a particular attribute of each item. In
+Listing 13-7, we have a list of Rectangle instances and we use sort_by_key
+to order them by their width attribute from low to high:
The reason sort_by_key is defined to take an FnMut closure is that it calls
+the closure multiple times: once for each item in the slice. The closure |r| r.width doesn’t capture, mutate, or move out anything from its environment, so
+it meets the trait bound requirements.
+
In contrast, Listing 13-8 shows an example of a closure that implements just
+the FnOnce trait, because it moves a value out of the environment. The
+compiler won’t let us use this closure with sort_by_key:
+Listing 13-8: Attempting to use an FnOnce closure with sort_by_key
+
+
This is a contrived, convoluted way (that doesn’t work) to try and count the
+number of times sort_by_key calls the closure when sorting list. This code
+attempts to do this counting by pushing value—a String from the closure’s
+environment—into the sort_operations vector. The closure captures value
+then moves value out of the closure by transferring ownership of value to
+the sort_operations vector. This closure can be called once; trying to call
+it a second time wouldn’t work because value would no longer be in the
+environment to be pushed into sort_operations again! Therefore, this closure
+only implements FnOnce. When we try to compile this code, we get this error
+that value can’t be moved out of the closure because the closure must
+implement FnMut:
+
$ cargo run
+ Compiling rectangles v0.1.0 (file:///projects/rectangles)
+error[E0507]: cannot move out of `value`, a captured variable in an `FnMut` closure
+ --> src/main.rs:18:30
+ |
+15 | let value = String::from("closure called");
+ | ----- captured outer variable
+16 |
+17 | list.sort_by_key(|r| {
+ | --- captured by this `FnMut` closure
+18 | sort_operations.push(value);
+ | ^^^^^ move occurs because `value` has type `String`, which does not implement the `Copy` trait
+
+For more information about this error, try `rustc --explain E0507`.
+error: could not compile `rectangles` (bin "rectangles") due to 1 previous error
+
+
The error points to the line in the closure body that moves value out of the
+environment. To fix this, we need to change the closure body so that it doesn’t
+move values out of the environment. To count the number of times the closure
+is called, keeping a counter in the environment and incrementing its value in
+the closure body is a more straightforward way to calculate that. The closure
+in Listing 13-9 works with sort_by_key because it is only capturing a mutable
+reference to the num_sort_operations counter and can therefore be called more
+than once:
+Listing 13-9: Using an FnMut closure with sort_by_key is allowed
+
+
The Fn traits are important when defining or using functions or types that
+make use of closures. In the next section, we’ll discuss iterators. Many
+iterator methods take closure arguments, so keep these closure details in mind
+as we continue!
The iterator pattern allows you to perform some task on a sequence of items in
+turn. An iterator is responsible for the logic of iterating over each item and
+determining when the sequence has finished. When you use iterators, you don’t
+have to reimplement that logic yourself.
+
In Rust, iterators are lazy, meaning they have no effect until you call
+methods that consume the iterator to use it up. For example, the code in
+Listing 13-10 creates an iterator over the items in the vector v1 by calling
+the iter method defined on Vec<T>. This code by itself doesn’t do anything
+useful.
+
+Filename: src/main.rs
+
fn main() {
+ let v1 = vec![1, 2, 3];
+
+ let v1_iter = v1.iter();
+}
+Listing 13-10: Creating an iterator
+
+
The iterator is stored in the v1_iter variable. Once we’ve created an
+iterator, we can use it in a variety of ways. In Listing 3-5 in Chapter 3, we
+iterated over an array using a for loop to execute some code on each of its
+items. Under the hood this implicitly created and then consumed an iterator,
+but we glossed over how exactly that works until now.
+
In the example in Listing 13-11, we separate the creation of the iterator from
+the use of the iterator in the for loop. When the for loop is called using
+the iterator in v1_iter, each element in the iterator is used in one
+iteration of the loop, which prints out each value.
+
+Filename: src/main.rs
+
fn main() {
+ let v1 = vec![1, 2, 3];
+
+ let v1_iter = v1.iter();
+
+ for val in v1_iter {
+ println!("Got: {val}");
+ }
+}
+Listing 13-11: Using an iterator in a for loop
+
+
In languages that don’t have iterators provided by their standard libraries,
+you would likely write this same functionality by starting a variable at index
+0, using that variable to index into the vector to get a value, and
+incrementing the variable value in a loop until it reached the total number of
+items in the vector.
+
Iterators handle all that logic for you, cutting down on repetitive code you
+could potentially mess up. Iterators give you more flexibility to use the same
+logic with many different kinds of sequences, not just data structures you can
+index into, like vectors. Let’s examine how iterators do that.
Notice this definition uses some new syntax: type Item and Self::Item,
+which are defining an associated type with this trait. We’ll talk about
+associated types in depth in Chapter 19. For now, all you need to know is that
+this code says implementing the Iterator trait requires that you also define
+an Item type, and this Item type is used in the return type of the next
+method. In other words, the Item type will be the type returned from the
+iterator.
+
The Iterator trait only requires implementors to define one method: the
+next method, which returns one item of the iterator at a time wrapped in
+Some and, when iteration is over, returns None.
+
We can call the next method on iterators directly; Listing 13-12 demonstrates
+what values are returned from repeated calls to next on the iterator created
+from the vector.
+Listing 13-12: Calling the next method on an iterator
+
+
Note that we needed to make v1_iter mutable: calling the next method on an
+iterator changes internal state that the iterator uses to keep track of where
+it is in the sequence. In other words, this code consumes, or uses up, the
+iterator. Each call to next eats up an item from the iterator. We didn’t need
+to make v1_iter mutable when we used a for loop because the loop took
+ownership of v1_iter and made it mutable behind the scenes.
+
Also note that the values we get from the calls to next are immutable
+references to the values in the vector. The iter method produces an iterator
+over immutable references. If we want to create an iterator that takes
+ownership of v1 and returns owned values, we can call into_iter instead of
+iter. Similarly, if we want to iterate over mutable references, we can call
+iter_mut instead of iter.
The Iterator trait has a number of different methods with default
+implementations provided by the standard library; you can find out about these
+methods by looking in the standard library API documentation for the Iterator
+trait. Some of these methods call the next method in their definition, which
+is why you’re required to implement the next method when implementing the
+Iterator trait.
+
Methods that call next are called consuming adaptors, because calling them
+uses up the iterator. One example is the sum method, which takes ownership of
+the iterator and iterates through the items by repeatedly calling next, thus
+consuming the iterator. As it iterates through, it adds each item to a running
+total and returns the total when iteration is complete. Listing 13-13 has a
+test illustrating a use of the sum method:
Iterator adaptors are methods defined on the Iterator trait that don’t
+consume the iterator. Instead, they produce different iterators by changing
+some aspect of the original iterator.
+
Listing 13-14 shows an example of calling the iterator adaptor method map,
+which takes a closure to call on each item as the items are iterated through.
+The map method returns a new iterator that produces the modified items. The
+closure here creates a new iterator in which each item from the vector will be
+incremented by 1:
+
+Filename: src/main.rs
+
fn main() {
+ let v1: Vec<i32> = vec![1, 2, 3];
+
+ v1.iter().map(|x| x + 1);
+}
+Listing 13-14: Calling the iterator adaptor map to create a new iterator
+
+
However, this code produces a warning:
+
$ cargo run
+ Compiling iterators v0.1.0 (file:///projects/iterators)
+warning: unused `Map` that must be used
+ --> src/main.rs:4:5
+ |
+4 | v1.iter().map(|x| x + 1);
+ | ^^^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: iterators are lazy and do nothing unless consumed
+ = note: `#[warn(unused_must_use)]` on by default
+help: use `let _ = ...` to ignore the resulting value
+ |
+4 | let _ = v1.iter().map(|x| x + 1);
+ | +++++++
+
+warning: `iterators` (bin "iterators") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.47s
+ Running `target/debug/iterators`
+
+
The code in Listing 13-14 doesn’t do anything; the closure we’ve specified
+never gets called. The warning reminds us why: iterator adaptors are lazy, and
+we need to consume the iterator here.
+
To fix this warning and consume the iterator, we’ll use the collect method,
+which we used in Chapter 12 with env::args in Listing 12-1. This method
+consumes the iterator and collects the resulting values into a collection data
+type.
+
In Listing 13-15, we collect the results of iterating over the iterator that’s
+returned from the call to map into a vector. This vector will end up
+containing each item from the original vector incremented by 1.
+
+Filename: src/main.rs
+
fn main() {
+ let v1: Vec<i32> = vec![1, 2, 3];
+
+ let v2: Vec<_> = v1.iter().map(|x| x + 1).collect();
+
+ assert_eq!(v2, vec![2, 3, 4]);
+}
+Listing 13-15: Calling the map method to create a new iterator and then calling the collect method to consume the new iterator and create a vector
+
+
Because map takes a closure, we can specify any operation we want to perform
+on each item. This is a great example of how closures let you customize some
+behavior while reusing the iteration behavior that the Iterator trait
+provides.
+
You can chain multiple calls to iterator adaptors to perform complex actions in
+a readable way. But because all iterators are lazy, you have to call one of the
+consuming adaptor methods to get results from calls to iterator adaptors.
Many iterator adapters take closures as arguments, and commonly the closures
+we’ll specify as arguments to iterator adapters will be closures that capture
+their environment.
+
For this example, we’ll use the filter method that takes a closure. The
+closure gets an item from the iterator and returns a bool. If the closure
+returns true, the value will be included in the iteration produced by
+filter. If the closure returns false, the value won’t be included.
+
In Listing 13-16, we use filter with a closure that captures the shoe_size
+variable from its environment to iterate over a collection of Shoe struct
+instances. It will return only shoes that are the specified size.
+Listing 13-16: Using the filter method with a closure that captures shoe_size
+
+
The shoes_in_size function takes ownership of a vector of shoes and a shoe
+size as parameters. It returns a vector containing only shoes of the specified
+size.
+
In the body of shoes_in_size, we call into_iter to create an iterator
+that takes ownership of the vector. Then we call filter to adapt that
+iterator into a new iterator that only contains elements for which the closure
+returns true.
+
The closure captures the shoe_size parameter from the environment and
+compares the value with each shoe’s size, keeping only shoes of the size
+specified. Finally, calling collect gathers the values returned by the
+adapted iterator into a vector that’s returned by the function.
+
The test shows that when we call shoes_in_size, we get back only shoes
+that have the same size as the value we specified.
With this new knowledge about iterators, we can improve the I/O project in
+Chapter 12 by using iterators to make places in the code clearer and more
+concise. Let’s look at how iterators can improve our implementation of the
+Config::build function and the search function.
In Listing 12-6, we added code that took a slice of String values and created
+an instance of the Config struct by indexing into the slice and cloning the
+values, allowing the Config struct to own those values. In Listing 13-17,
+we’ve reproduced the implementation of the Config::build function as it was
+in Listing 12-23:
+Listing 13-17: Reproduction of the Config::build function from Listing 12-23
+
+
At the time, we said not to worry about the inefficient clone calls because
+we would remove them in the future. Well, that time is now!
+
We needed clone here because we have a slice with String elements in the
+parameter args, but the build function doesn’t own args. To return
+ownership of a Config instance, we had to clone the values from the query
+and file_path fields of Config so the Config instance can own its values.
+
With our new knowledge about iterators, we can change the build function to
+take ownership of an iterator as its argument instead of borrowing a slice.
+We’ll use the iterator functionality instead of the code that checks the length
+of the slice and indexes into specific locations. This will clarify what the
+Config::build function is doing because the iterator will access the values.
+
Once Config::build takes ownership of the iterator and stops using indexing
+operations that borrow, we can move the String values from the iterator into
+Config rather than calling clone and making a new allocation.
We’ll first change the start of the main function that we had in Listing
+12-24 to the code in Listing 13-18, which this time uses an iterator. This
+won’t compile until we update Config::build as well.
+Listing 13-18: Passing the return value of env::args to Config::build
+
+
The env::args function returns an iterator! Rather than collecting the
+iterator values into a vector and then passing a slice to Config::build, now
+we’re passing ownership of the iterator returned from env::args to
+Config::build directly.
+
Next, we need to update the definition of Config::build. In your I/O
+project’s src/lib.rs file, let’s change the signature of Config::build to
+look like Listing 13-19. This still won’t compile because we need to update the
+function body.
+Listing 13-19: Updating the signature of Config::build to expect an iterator
+
+
The standard library documentation for the env::args function shows that the
+type of the iterator it returns is std::env::Args, and that type implements
+the Iterator trait and returns String values.
+
We’ve updated the signature of the Config::build function so the parameter
+args has a generic type with the trait bounds impl Iterator<Item = String>
+instead of &[String]. This usage of the impl Trait syntax we discussed in
+the “Traits as Parameters” section of Chapter 10
+means that args can be any type that implements the Iterator trait and
+returns String items.
+
Because we’re taking ownership of args and we’ll be mutating args by
+iterating over it, we can add the mut keyword into the specification of the
+args parameter to make it mutable.
Next, we’ll fix the body of Config::build. Because args implements the
+Iterator trait, we know we can call the next method on it! Listing 13-20
+updates the code from Listing 12-23 to use the next method:
+Listing 13-20: Changing the body of Config::build to use iterator methods
+
+
Remember that the first value in the return value of env::args is the name of
+the program. We want to ignore that and get to the next value, so first we call
+next and do nothing with the return value. Second, we call next to get the
+value we want to put in the query field of Config. If next returns a
+Some, we use a match to extract the value. If it returns None, it means
+not enough arguments were given and we return early with an Err value. We do
+the same thing for the file_path value.
We can also take advantage of iterators in the search function in our I/O
+project, which is reproduced here in Listing 13-21 as it was in Listing 12-19:
+Listing 13-21: The implementation of the search function from Listing 12-19
+
+
We can write this code in a more concise way using iterator adaptor methods.
+Doing so also lets us avoid having a mutable intermediate results vector. The
+functional programming style prefers to minimize the amount of mutable state to
+make code clearer. Removing the mutable state might enable a future enhancement
+to make searching happen in parallel, because we wouldn’t have to manage
+concurrent access to the results vector. Listing 13-22 shows this change:
+Listing 13-22: Using iterator adaptor methods in the implementation of the search function
+
+
Recall that the purpose of the search function is to return all lines in
+contents that contain the query. Similar to the filter example in Listing
+13-16, this code uses the filter adaptor to keep only the lines that
+line.contains(query) returns true for. We then collect the matching lines
+into another vector with collect. Much simpler! Feel free to make the same
+change to use iterator methods in the search_case_insensitive function as
+well.
The next logical question is which style you should choose in your own code and
+why: the original implementation in Listing 13-21 or the version using
+iterators in Listing 13-22. Most Rust programmers prefer to use the iterator
+style. It’s a bit tougher to get the hang of at first, but once you get a feel
+for the various iterator adaptors and what they do, iterators can be easier to
+understand. Instead of fiddling with the various bits of looping and building
+new vectors, the code focuses on the high-level objective of the loop. This
+abstracts away some of the commonplace code so it’s easier to see the concepts
+that are unique to this code, such as the filtering condition each element in
+the iterator must pass.
+
But are the two implementations truly equivalent? The intuitive assumption
+might be that the more low-level loop will be faster. Let’s talk about
+performance.
To determine whether to use loops or iterators, you need to know which
+implementation is faster: the version of the search function with an explicit
+for loop or the version with iterators.
+
We ran a benchmark by loading the entire contents of The Adventures of
+Sherlock Holmes by Sir Arthur Conan Doyle into a String and looking for the
+word the in the contents. Here are the results of the benchmark on the
+version of search using the for loop and the version using iterators:
The iterator version was slightly faster! We won’t explain the benchmark code
+here, because the point is not to prove that the two versions are equivalent
+but to get a general sense of how these two implementations compare
+performance-wise.
+
For a more comprehensive benchmark, you should check using various texts of
+various sizes as the contents, different words and words of different lengths
+as the query, and all kinds of other variations. The point is this:
+iterators, although a high-level abstraction, get compiled down to roughly the
+same code as if you’d written the lower-level code yourself. Iterators are one
+of Rust’s zero-cost abstractions, by which we mean using the abstraction
+imposes no additional runtime overhead. This is analogous to how Bjarne
+Stroustrup, the original designer and implementor of C++, defines
+zero-overhead in “Foundations of C++” (2012):
+
+
In general, C++ implementations obey the zero-overhead principle: What you
+don’t use, you don’t pay for. And further: What you do use, you couldn’t hand
+code any better.
+
+
As another example, the following code is taken from an audio decoder. The
+decoding algorithm uses the linear prediction mathematical operation to
+estimate future values based on a linear function of the previous samples. This
+code uses an iterator chain to do some math on three variables in scope: a
+buffer slice of data, an array of 12 coefficients, and an amount by which
+to shift data in qlp_shift. We’ve declared the variables within this example
+but not given them any values; although this code doesn’t have much meaning
+outside of its context, it’s still a concise, real-world example of how Rust
+translates high-level ideas to low-level code.
+
let buffer: &mut [i32];
+let coefficients: [i64; 12];
+let qlp_shift: i16;
+
+for i in 12..buffer.len() {
+ let prediction = coefficients.iter()
+ .zip(&buffer[i - 12..i])
+ .map(|(&c, &s)| c * s as i64)
+ .sum::<i64>() >> qlp_shift;
+ let delta = buffer[i];
+ buffer[i] = prediction as i32 + delta;
+}
+
To calculate the value of prediction, this code iterates through each of the
+12 values in coefficients and uses the zip method to pair the coefficient
+values with the previous 12 values in buffer. Then, for each pair, we
+multiply the values together, sum all the results, and shift the bits in the
+sum qlp_shift bits to the right.
+
Calculations in applications like audio decoders often prioritize performance
+most highly. Here, we’re creating an iterator, using two adaptors, and then
+consuming the value. What assembly code would this Rust code compile to? Well,
+as of this writing, it compiles down to the same assembly you’d write by hand.
+There’s no loop at all corresponding to the iteration over the values in
+coefficients: Rust knows that there are 12 iterations, so it “unrolls” the
+loop. Unrolling is an optimization that removes the overhead of the loop
+controlling code and instead generates repetitive code for each iteration of
+the loop.
+
All of the coefficients get stored in registers, which means accessing the
+values is very fast. There are no bounds checks on the array access at runtime.
+All these optimizations that Rust is able to apply make the resulting code
+extremely efficient. Now that you know this, you can use iterators and closures
+without fear! They make code seem like it’s higher level but don’t impose a
+runtime performance penalty for doing so.
Closures and iterators are Rust features inspired by functional programming
+language ideas. They contribute to Rust’s capability to clearly express
+high-level ideas at low-level performance. The implementations of closures and
+iterators are such that runtime performance is not affected. This is part of
+Rust’s goal to strive to provide zero-cost abstractions.
+
Now that we’ve improved the expressiveness of our I/O project, let’s look at
+some more features of cargo that will help us share the project with the
+world.
So far we’ve used only the most basic features of Cargo to build, run, and test
+our code, but it can do a lot more. In this chapter, we’ll discuss some of its
+other, more advanced features to show you how to do the following:
In Rust, release profiles are predefined and customizable profiles with
+different configurations that allow a programmer to have more control over
+various options for compiling code. Each profile is configured independently of
+the others.
+
Cargo has two main profiles: the dev profile Cargo uses when you run cargo build and the release profile Cargo uses when you run cargo build --release. The dev profile is defined with good defaults for development,
+and the release profile has good defaults for release builds.
+
These profile names might be familiar from the output of your builds:
+
+
$ cargo build
+ Finished dev [unoptimized + debuginfo] target(s) in 0.0s
+$ cargo build --release
+ Finished release [optimized] target(s) in 0.0s
+
+
The dev and release are these different profiles used by the compiler.
+
Cargo has default settings for each of the profiles that apply when you haven’t
+explicitly added any [profile.*] sections in the project’s Cargo.toml file.
+By adding [profile.*] sections for any profile you want to customize, you
+override any subset of the default settings. For example, here are the default
+values for the opt-level setting for the dev and release profiles:
The opt-level setting controls the number of optimizations Rust will apply to
+your code, with a range of 0 to 3. Applying more optimizations extends
+compiling time, so if you’re in development and compiling your code often,
+you’ll want fewer optimizations to compile faster even if the resulting code
+runs slower. The default opt-level for dev is therefore 0. When you’re
+ready to release your code, it’s best to spend more time compiling. You’ll only
+compile in release mode once, but you’ll run the compiled program many times,
+so release mode trades longer compile time for code that runs faster. That is
+why the default opt-level for the release profile is 3.
+
You can override a default setting by adding a different value for it in
+Cargo.toml. For example, if we want to use optimization level 1 in the
+development profile, we can add these two lines to our project’s Cargo.toml
+file:
+
Filename: Cargo.toml
+
[profile.dev]
+opt-level = 1
+
+
This code overrides the default setting of 0. Now when we run cargo build,
+Cargo will use the defaults for the dev profile plus our customization to
+opt-level. Because we set opt-level to 1, Cargo will apply more
+optimizations than the default, but not as many as in a release build.
+
For the full list of configuration options and defaults for each profile, see
+Cargo’s documentation.
We’ve used packages from crates.io as
+dependencies of our project, but you can also share your code with other people
+by publishing your own packages. The crate registry at
+crates.io distributes the source code of
+your packages, so it primarily hosts code that is open source.
+
Rust and Cargo have features that make your published package easier for people
+to find and use. We’ll talk about some of these features next and then explain
+how to publish a package.
Accurately documenting your packages will help other users know how and when to
+use them, so it’s worth investing the time to write documentation. In Chapter
+3, we discussed how to comment Rust code using two slashes, //. Rust also has
+a particular kind of comment for documentation, known conveniently as a
+documentation comment, that will generate HTML documentation. The HTML
+displays the contents of documentation comments for public API items intended
+for programmers interested in knowing how to use your crate as opposed to how
+your crate is implemented.
+
Documentation comments use three slashes, ///, instead of two and support
+Markdown notation for formatting the text. Place documentation comments just
+before the item they’re documenting. Listing 14-1 shows documentation comments
+for an add_one function in a crate named my_crate.
+
+Filename: src/lib.rs
+
/// Adds one to the number given.
+///
+/// # Examples
+///
+/// ```
+/// let arg = 5;
+/// let answer = my_crate::add_one(arg);
+///
+/// assert_eq!(6, answer);
+/// ```
+pub fn add_one(x: i32) -> i32 {
+ x + 1
+}
+Listing 14-1: A documentation comment for a function
+
+
Here, we give a description of what the add_one function does, start a
+section with the heading Examples, and then provide code that demonstrates
+how to use the add_one function. We can generate the HTML documentation from
+this documentation comment by running cargo doc. This command runs the
+rustdoc tool distributed with Rust and puts the generated HTML documentation
+in the target/doc directory.
+
For convenience, running cargo doc --open will build the HTML for your
+current crate’s documentation (as well as the documentation for all of your
+crate’s dependencies) and open the result in a web browser. Navigate to the
+add_one function and you’ll see how the text in the documentation comments is
+rendered, as shown in Figure 14-1:
+
+
Figure 14-1: HTML documentation for the add_one
+function
We used the # Examples Markdown heading in Listing 14-1 to create a section
+in the HTML with the title “Examples.” Here are some other sections that crate
+authors commonly use in their documentation:
+
+
Panics: The scenarios in which the function being documented could
+panic. Callers of the function who don’t want their programs to panic should
+make sure they don’t call the function in these situations.
+
Errors: If the function returns a Result, describing the kinds of
+errors that might occur and what conditions might cause those errors to be
+returned can be helpful to callers so they can write code to handle the
+different kinds of errors in different ways.
+
Safety: If the function is unsafe to call (we discuss unsafety in
+Chapter 19), there should be a section explaining why the function is unsafe
+and covering the invariants that the function expects callers to uphold.
+
+
Most documentation comments don’t need all of these sections, but this is a
+good checklist to remind you of the aspects of your code users will be
+interested in knowing about.
Adding example code blocks in your documentation comments can help demonstrate
+how to use your library, and doing so has an additional bonus: running cargo test will run the code examples in your documentation as tests! Nothing is
+better than documentation with examples. But nothing is worse than examples
+that don’t work because the code has changed since the documentation was
+written. If we run cargo test with the documentation for the add_one
+function from Listing 14-1, we will see a section in the test results like this:
+
+
Doc-tests my_crate
+
+running 1 test
+test src/lib.rs - add_one (line 5) ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.27s
+
+
Now if we change either the function or the example so the assert_eq! in the
+example panics and run cargo test again, we’ll see that the doc tests catch
+that the example and the code are out of sync with each other!
The style of doc comment //! adds documentation to the item that contains the
+comments rather than to the items following the comments. We typically use
+these doc comments inside the crate root file (src/lib.rs by convention) or
+inside a module to document the crate or the module as a whole.
+
For example, to add documentation that describes the purpose of the my_crate
+crate that contains the add_one function, we add documentation comments that
+start with //! to the beginning of the src/lib.rs file, as shown in Listing
+14-2:
+
+Filename: src/lib.rs
+
//! # My Crate
+//!
+//! `my_crate` is a collection of utilities to make performing certain
+//! calculations more convenient.
+
+/// Adds one to the number given.
+// --snip--
+///
+/// # Examples
+///
+/// ```
+/// let arg = 5;
+/// let answer = my_crate::add_one(arg);
+///
+/// assert_eq!(6, answer);
+/// ```
+pub fn add_one(x: i32) -> i32 {
+ x + 1
+}
+Listing 14-2: Documentation for the my_crate crate as a whole
+
+
Notice there isn’t any code after the last line that begins with //!. Because
+we started the comments with //! instead of ///, we’re documenting the item
+that contains this comment rather than an item that follows this comment. In
+this case, that item is the src/lib.rs file, which is the crate root. These
+comments describe the entire crate.
+
When we run cargo doc --open, these comments will display on the front
+page of the documentation for my_crate above the list of public items in the
+crate, as shown in Figure 14-2:
+
+
Figure 14-2: Rendered documentation for my_crate,
+including the comment describing the crate as a whole
+
Documentation comments within items are useful for describing crates and
+modules especially. Use them to explain the overall purpose of the container to
+help your users understand the crate’s organization.
The structure of your public API is a major consideration when publishing a
+crate. People who use your crate are less familiar with the structure than you
+are and might have difficulty finding the pieces they want to use if your crate
+has a large module hierarchy.
+
In Chapter 7, we covered how to make items public using the pub keyword, and
+bring items into a scope with the use keyword. However, the structure that
+makes sense to you while you’re developing a crate might not be very convenient
+for your users. You might want to organize your structs in a hierarchy
+containing multiple levels, but then people who want to use a type you’ve
+defined deep in the hierarchy might have trouble finding out that type exists.
+They might also be annoyed at having to enter use
+my_crate::some_module::another_module::UsefulType; rather than use
+my_crate::UsefulType;.
+
The good news is that if the structure isn’t convenient for others to use
+from another library, you don’t have to rearrange your internal organization:
+instead, you can re-export items to make a public structure that’s different
+from your private structure by using pub use. Re-exporting takes a public
+item in one location and makes it public in another location, as if it were
+defined in the other location instead.
+
For example, say we made a library named art for modeling artistic concepts.
+Within this library are two modules: a kinds module containing two enums
+named PrimaryColor and SecondaryColor and a utils module containing a
+function named mix, as shown in Listing 14-3:
+
+Filename: src/lib.rs
+
//! # Art
+//!
+//! A library for modeling artistic concepts.
+
+pub mod kinds {
+ /// The primary colors according to the RYB color model.
+ pub enum PrimaryColor {
+ Red,
+ Yellow,
+ Blue,
+ }
+
+ /// The secondary colors according to the RYB color model.
+ pub enum SecondaryColor {
+ Orange,
+ Green,
+ Purple,
+ }
+}
+
+pub mod utils {
+ use crate::kinds::*;
+
+ /// Combines two primary colors in equal amounts to create
+ /// a secondary color.
+ pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
+ // --snip--
+ unimplemented!();
+ }
+}
+Listing 14-3: An art library with items organized into kinds and utils modules
+
+
Figure 14-3 shows what the front page of the documentation for this crate
+generated by cargo doc would look like:
+
+
Figure 14-3: Front page of the documentation for art
+that lists the kinds and utils modules
+
Note that the PrimaryColor and SecondaryColor types aren’t listed on the
+front page, nor is the mix function. We have to click kinds and utils to
+see them.
+
Another crate that depends on this library would need use statements that
+bring the items from art into scope, specifying the module structure that’s
+currently defined. Listing 14-4 shows an example of a crate that uses the
+PrimaryColor and mix items from the art crate:
+
+Filename: src/main.rs
+
use art::kinds::PrimaryColor;
+use art::utils::mix;
+
+fn main() {
+ let red = PrimaryColor::Red;
+ let yellow = PrimaryColor::Yellow;
+ mix(red, yellow);
+}
+Listing 14-4: A crate using the art crate’s items with its internal structure exported
+
+
The author of the code in Listing 14-4, which uses the art crate, had to
+figure out that PrimaryColor is in the kinds module and mix is in the
+utils module. The module structure of the art crate is more relevant to
+developers working on the art crate than to those using it. The internal
+structure doesn’t contain any useful information for someone trying to
+understand how to use the art crate, but rather causes confusion because
+developers who use it have to figure out where to look, and must specify the
+module names in the use statements.
+
To remove the internal organization from the public API, we can modify the
+art crate code in Listing 14-3 to add pub use statements to re-export the
+items at the top level, as shown in Listing 14-5:
+
+Filename: src/lib.rs
+
//! # Art
+//!
+//! A library for modeling artistic concepts.
+
+pub use self::kinds::PrimaryColor;
+pub use self::kinds::SecondaryColor;
+pub use self::utils::mix;
+
+pub mod kinds {
+ // --snip--
+ /// The primary colors according to the RYB color model.
+ pub enum PrimaryColor {
+ Red,
+ Yellow,
+ Blue,
+ }
+
+ /// The secondary colors according to the RYB color model.
+ pub enum SecondaryColor {
+ Orange,
+ Green,
+ Purple,
+ }
+}
+
+pub mod utils {
+ // --snip--
+ use crate::kinds::*;
+
+ /// Combines two primary colors in equal amounts to create
+ /// a secondary color.
+ pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
+ SecondaryColor::Orange
+ }
+}
+Listing 14-5: Adding pub use statements to re-export items
+
+
The API documentation that cargo doc generates for this crate will now list
+and link re-exports on the front page, as shown in Figure 14-4, making the
+PrimaryColor and SecondaryColor types and the mix function easier to find.
+
+
Figure 14-4: The front page of the documentation for art
+that lists the re-exports
+
The art crate users can still see and use the internal structure from Listing
+14-3 as demonstrated in Listing 14-4, or they can use the more convenient
+structure in Listing 14-5, as shown in Listing 14-6:
+
+Filename: src/main.rs
+
use art::mix;
+use art::PrimaryColor;
+
+fn main() {
+ // --snip--
+ let red = PrimaryColor::Red;
+ let yellow = PrimaryColor::Yellow;
+ mix(red, yellow);
+}
+Listing 14-6: A program using the re-exported items from the art crate
+
+
In cases where there are many nested modules, re-exporting the types at the top
+level with pub use can make a significant difference in the experience of
+people who use the crate. Another common use of pub use is to re-export
+definitions of a dependency in the current crate to make that crate’s
+definitions part of your crate’s public API.
+
Creating a useful public API structure is more of an art than a science, and
+you can iterate to find the API that works best for your users. Choosing pub use gives you flexibility in how you structure your crate internally and
+decouples that internal structure from what you present to your users. Look at
+some of the code of crates you’ve installed to see if their internal structure
+differs from their public API.
Before you can publish any crates, you need to create an account on
+crates.io and get an API token. To do so,
+visit the home page at crates.io and log
+in via a GitHub account. (The GitHub account is currently a requirement, but
+the site might support other ways of creating an account in the future.) Once
+you’re logged in, visit your account settings at
+https://crates.io/me/ and retrieve your
+API key. Then run the cargo login command and paste your API key when prompted, like this:
+
$ cargo login
+abcdefghijklmnopqrstuvwxyz012345
+
+
This command will inform Cargo of your API token and store it locally in
+~/.cargo/credentials. Note that this token is a secret: do not share it
+with anyone else. If you do share it with anyone for any reason, you should
+revoke it and generate a new token on crates.io.
Let’s say you have a crate you want to publish. Before publishing, you’ll need
+to add some metadata in the [package] section of the crate’s Cargo.toml
+file.
+
Your crate will need a unique name. While you’re working on a crate locally,
+you can name a crate whatever you’d like. However, crate names on
+crates.io are allocated on a first-come,
+first-served basis. Once a crate name is taken, no one else can publish a crate
+with that name. Before attempting to publish a crate, search for the name you
+want to use. If the name has been used, you will need to find another name and
+edit the name field in the Cargo.toml file under the [package] section to
+use the new name for publishing, like so:
+
Filename: Cargo.toml
+
[package]
+name = "guessing_game"
+
+
Even if you’ve chosen a unique name, when you run cargo publish to publish
+the crate at this point, you’ll get a warning and then an error:
+
+
$ cargo publish
+ Updating crates.io index
+warning: manifest has no description, license, license-file, documentation, homepage or repository.
+See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
+--snip--
+error: failed to publish to registry at https://crates.io
+
+Caused by:
+ the remote server responded with an error: missing or empty metadata fields: description, license. Please see https://doc.rust-lang.org/cargo/reference/manifest.html for how to upload metadata
+
+
This errors because you’re missing some crucial information: a description and
+license are required so people will know what your crate does and under what
+terms they can use it. In Cargo.toml, add a description that’s just a
+sentence or two, because it will appear with your crate in search results. For
+the license field, you need to give a license identifier value. The Linux
+Foundation’s Software Package Data Exchange (SPDX) lists the identifiers
+you can use for this value. For example, to specify that you’ve licensed your
+crate using the MIT License, add the MIT identifier:
If you want to use a license that doesn’t appear in the SPDX, you need to place
+the text of that license in a file, include the file in your project, and then
+use license-file to specify the name of that file instead of using the
+license key.
+
Guidance on which license is appropriate for your project is beyond the scope
+of this book. Many people in the Rust community license their projects in the
+same way as Rust by using a dual license of MIT OR Apache-2.0. This practice
+demonstrates that you can also specify multiple license identifiers separated
+by OR to have multiple licenses for your project.
+
With a unique name, the version, your description, and a license added, the
+Cargo.toml file for a project that is ready to publish might look like this:
+
Filename: Cargo.toml
+
[package]
+name = "guessing_game"
+version = "0.1.0"
+edition = "2021"
+description = "A fun game where you guess what number the computer has chosen."
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+
+
Cargo’s documentation describes other
+metadata you can specify to ensure others can discover and use your crate more
+easily.
Now that you’ve created an account, saved your API token, chosen a name for
+your crate, and specified the required metadata, you’re ready to publish!
+Publishing a crate uploads a specific version to
+crates.io for others to use.
+
Be careful, because a publish is permanent. The version can never be
+overwritten, and the code cannot be deleted. One major goal of
+crates.io is to act as a permanent archive
+of code so that builds of all projects that depend on crates from
+crates.io will continue to work. Allowing
+version deletions would make fulfilling that goal impossible. However, there is
+no limit to the number of crate versions you can publish.
+
Run the cargo publish command again. It should succeed now:
When you’ve made changes to your crate and are ready to release a new version,
+you change the version value specified in your Cargo.toml file and
+republish. Use the Semantic Versioning rules to decide what an
+appropriate next version number is based on the kinds of changes you’ve made.
+Then run cargo publish to upload the new version.
Although you can’t remove previous versions of a crate, you can prevent any
+future projects from adding them as a new dependency. This is useful when a
+crate version is broken for one reason or another. In such situations, Cargo
+supports yanking a crate version.
+
Yanking a version prevents new projects from depending on that version while
+allowing all existing projects that depend on it to continue. Essentially, a
+yank means that all projects with a Cargo.lock will not break, and any future
+Cargo.lock files generated will not use the yanked version.
+
To yank a version of a crate, in the directory of the crate that you’ve
+previously published, run cargo yank and specify which version you want to
+yank. For example, if we’ve published a crate named guessing_game version
+1.0.1 and we want to yank it, in the project directory for guessing_game we’d
+run:
A yank does not delete any code. It cannot, for example, delete accidentally
+uploaded secrets. If that happens, you must reset those secrets immediately.
In Chapter 12, we built a package that included a binary crate and a library
+crate. As your project develops, you might find that the library crate
+continues to get bigger and you want to split your package further into
+multiple library crates. Cargo offers a feature called workspaces that can
+help manage multiple related packages that are developed in tandem.
A workspace is a set of packages that share the same Cargo.lock and output
+directory. Let’s make a project using a workspace—we’ll use trivial code so we
+can concentrate on the structure of the workspace. There are multiple ways to
+structure a workspace, so we’ll just show one common way. We’ll have a
+workspace containing a binary and two libraries. The binary, which will provide
+the main functionality, will depend on the two libraries. One library will
+provide an add_one function, and a second library an add_two function.
+These three crates will be part of the same workspace. We’ll start by creating
+a new directory for the workspace:
+
$ mkdir add
+$ cd add
+
+
Next, in the add directory, we create the Cargo.toml file that will
+configure the entire workspace. This file won’t have a [package] section.
+Instead, it will start with a [workspace] section that will allow us to add
+members to the workspace by specifying the path to the package with our binary
+crate; in this case, that path is adder:
+
Filename: Cargo.toml
+
[workspace]
+
+members = [
+ "adder",
+]
+
+
Next, we’ll create the adder binary crate by running cargo new within the
+add directory:
+
+
$ cargo new adder
+ Created binary (application) `adder` package
+
+
At this point, we can build the workspace by running cargo build. The files
+in your add directory should look like this:
The workspace has one target directory at the top level that the compiled
+artifacts will be placed into; the adder package doesn’t have its own
+target directory. Even if we were to run cargo build from inside the
+adder directory, the compiled artifacts would still end up in add/target
+rather than add/adder/target. Cargo structures the target directory in a
+workspace like this because the crates in a workspace are meant to depend on
+each other. If each crate had its own target directory, each crate would have
+to recompile each of the other crates in the workspace to place the artifacts
+in its own target directory. By sharing one target directory, the crates
+can avoid unnecessary rebuilding.
Next, let’s create another member package in the workspace and call it
+add_one. Change the top-level Cargo.toml to specify the add_one path in
+the members list:
In the add_one/src/lib.rs file, let’s add an add_one function:
+
Filename: add_one/src/lib.rs
+
pub fn add_one(x: i32) -> i32 {
+ x + 1
+}
+
Now we can have the adder package with our binary depend on the add_one
+package that has our library. First, we’ll need to add a path dependency on
+add_one to adder/Cargo.toml.
Cargo doesn’t assume that crates in a workspace will depend on each other, so
+we need to be explicit about the dependency relationships.
+
Next, let’s use the add_one function (from the add_one crate) in the
+adder crate. Open the adder/src/main.rs file and add a use line at the
+top to bring the new add_one library crate into scope. Then change the main
+function to call the add_one function, as in Listing 14-7.
+
+Filename: adder/src/main.rs
+
use add_one;
+
+fn main() {
+ let num = 10;
+ println!("Hello, world! {num} plus one is {}!", add_one::add_one(num));
+}
+Listing 14-7: Using the add_one library crate from the adder crate
+
+
Let’s build the workspace by running cargo build in the top-level add
+directory!
To run the binary crate from the add directory, we can specify which
+package in the workspace we want to run by using the -p argument and the
+package name with cargo run:
+
+
$ cargo run -p adder
+ Finished dev [unoptimized + debuginfo] target(s) in 0.0s
+ Running `target/debug/adder`
+Hello, world! 10 plus one is 11!
+
+
This runs the code in adder/src/main.rs, which depends on the add_one crate.
Notice that the workspace has only one Cargo.lock file at the top level,
+rather than having a Cargo.lock in each crate’s directory. This ensures that
+all crates are using the same version of all dependencies. If we add the rand
+package to the adder/Cargo.toml and add_one/Cargo.toml files, Cargo will
+resolve both of those to one version of rand and record that in the one
+Cargo.lock. Making all crates in the workspace use the same dependencies
+means the crates will always be compatible with each other. Let’s add the
+rand crate to the [dependencies] section in the add_one/Cargo.toml file
+so we can use the rand crate in the add_one crate:
+
+
Filename: add_one/Cargo.toml
+
[dependencies]
+rand = "0.8.5"
+
+
We can now add use rand; to the add_one/src/lib.rs file, and building the
+whole workspace by running cargo build in the add directory will bring in
+and compile the rand crate. We will get one warning because we aren’t
+referring to the rand we brought into scope:
The top-level Cargo.lock now contains information about the dependency of
+add_one on rand. However, even though rand is used somewhere in the
+workspace, we can’t use it in other crates in the workspace unless we add
+rand to their Cargo.toml files as well. For example, if we add use rand;
+to the adder/src/main.rs file for the adder package, we’ll get an error:
To fix this, edit the Cargo.toml file for the adder package and indicate
+that rand is a dependency for it as well. Building the adder package will
+add rand to the list of dependencies for adder in Cargo.lock, but no
+additional copies of rand will be downloaded. Cargo will ensure that every
+crate in every package in the workspace using the rand package will be using
+the same version as long as they specify compatible versions of rand, saving
+us space and ensuring that the crates in the workspace will be compatible with
+each other.
+
If crates in the workspace specify incompatible versions of the same dependency,
+Cargo will resolve each of them, but will still try to resolve as few versions
+as possible.
Now run cargo test in the top-level add directory. Running cargo test in
+a workspace structured like this one will run the tests for all the crates in
+the workspace:
+
+
$ cargo test
+ Compiling add_one v0.1.0 (file:///projects/add/add_one)
+ Compiling adder v0.1.0 (file:///projects/add/adder)
+ Finished test [unoptimized + debuginfo] target(s) in 0.27s
+ Running unittests src/lib.rs (target/debug/deps/add_one-f0253159197f7841)
+
+running 1 test
+test tests::it_works ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Running unittests src/main.rs (target/debug/deps/adder-49979ff40686fa8e)
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests add_one
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
The first section of the output shows that the it_works test in the add_one
+crate passed. The next section shows that zero tests were found in the adder
+crate, and then the last section shows zero documentation tests were found in
+the add_one crate.
+
We can also run tests for one particular crate in a workspace from the
+top-level directory by using the -p flag and specifying the name of the crate
+we want to test:
+
+
$ cargo test -p add_one
+ Finished test [unoptimized + debuginfo] target(s) in 0.00s
+ Running unittests src/lib.rs (target/debug/deps/add_one-b3235fea9a156f74)
+
+running 1 test
+test tests::it_works ... ok
+
+test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+ Doc-tests add_one
+
+running 0 tests
+
+test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+
This output shows cargo test only ran the tests for the add_one crate and
+didn’t run the adder crate tests.
+
If you publish the crates in the workspace to crates.io,
+each crate in the workspace will need to be published separately. Like cargo test, we can publish a particular crate in our workspace by using the -p
+flag and specifying the name of the crate we want to publish.
+
For additional practice, add an add_two crate to this workspace in a similar
+way as the add_one crate!
+
As your project grows, consider using a workspace: it’s easier to understand
+smaller, individual components than one big blob of code. Furthermore, keeping
+the crates in a workspace can make coordination between crates easier if they
+are often changed at the same time.
The cargo install command allows you to install and use binary crates
+locally. This isn’t intended to replace system packages; it’s meant to be a
+convenient way for Rust developers to install tools that others have shared on
+crates.io. Note that you can only install
+packages that have binary targets. A binary target is the runnable program
+that is created if the crate has a src/main.rs file or another file specified
+as a binary, as opposed to a library target that isn’t runnable on its own but
+is suitable for including within other programs. Usually, crates have
+information in the README file about whether a crate is a library, has a
+binary target, or both.
+
All binaries installed with cargo install are stored in the installation
+root’s bin folder. If you installed Rust using rustup.rs and don’t have any
+custom configurations, this directory will be $HOME/.cargo/bin. Ensure that
+directory is in your $PATH to be able to run programs you’ve installed with
+cargo install.
+
For example, in Chapter 12 we mentioned that there’s a Rust implementation of
+the grep tool called ripgrep for searching files. To install ripgrep, we
+can run the following:
The second-to-last line of the output shows the location and the name of the
+installed binary, which in the case of ripgrep is rg. As long as the
+installation directory is in your $PATH, as mentioned previously, you can
+then run rg --help and start using a faster, rustier tool for searching files!
Cargo is designed so you can extend it with new subcommands without having to
+modify Cargo. If a binary in your $PATH is named cargo-something, you can
+run it as if it was a Cargo subcommand by running cargo something. Custom
+commands like this are also listed when you run cargo --list. Being able to
+use cargo install to install extensions and then run them just like the
+built-in Cargo tools is a super convenient benefit of Cargo’s design!
Sharing code with Cargo and crates.io is
+part of what makes the Rust ecosystem useful for many different tasks. Rust’s
+standard library is small and stable, but crates are easy to share, use, and
+improve on a timeline different from that of the language. Don’t be shy about
+sharing code that’s useful to you on crates.io; it’s likely that it will be useful to someone else as well!
A pointer is a general concept for a variable that contains an address in
+memory. This address refers to, or “points at,” some other data. The most
+common kind of pointer in Rust is a reference, which you learned about in
+Chapter 4. References are indicated by the & symbol and borrow the value they
+point to. They don’t have any special capabilities other than referring to
+data, and have no overhead.
+
Smart pointers, on the other hand, are data structures that act like a
+pointer but also have additional metadata and capabilities. The concept of
+smart pointers isn’t unique to Rust: smart pointers originated in C++ and exist
+in other languages as well. Rust has a variety of smart pointers defined in the
+standard library that provide functionality beyond that provided by references.
+To explore the general concept, we’ll look at a couple of different examples of
+smart pointers, including a reference counting smart pointer type. This
+pointer enables you to allow data to have multiple owners by keeping track of
+the number of owners and, when no owners remain, cleaning up the data.
+
Rust, with its concept of ownership and borrowing, has an additional difference
+between references and smart pointers: while references only borrow data, in
+many cases, smart pointers own the data they point to.
+
Though we didn’t call them as such at the time, we’ve already encountered a few
+smart pointers in this book, including String and Vec<T> in Chapter 8. Both
+these types count as smart pointers because they own some memory and allow you
+to manipulate it. They also have metadata and extra capabilities or guarantees.
+String, for example, stores its capacity as metadata and has the extra
+ability to ensure its data will always be valid UTF-8.
+
Smart pointers are usually implemented using structs. Unlike an ordinary
+struct, smart pointers implement the Deref and Drop traits. The Deref
+trait allows an instance of the smart pointer struct to behave like a reference
+so you can write your code to work with either references or smart pointers.
+The Drop trait allows you to customize the code that’s run when an instance
+of the smart pointer goes out of scope. In this chapter, we’ll discuss both
+traits and demonstrate why they’re important to smart pointers.
+
Given that the smart pointer pattern is a general design pattern used
+frequently in Rust, this chapter won’t cover every existing smart pointer. Many
+libraries have their own smart pointers, and you can even write your own. We’ll
+cover the most common smart pointers in the standard library:
+
+
Box<T> for allocating values on the heap
+
Rc<T>, a reference counting type that enables multiple ownership
+
Ref<T> and RefMut<T>, accessed through RefCell<T>, a type that enforces
+the borrowing rules at runtime instead of compile time
+
+
In addition, we’ll cover the interior mutability pattern where an immutable
+type exposes an API for mutating an interior value. We’ll also discuss
+reference cycles: how they can leak memory and how to prevent them.
The most straightforward smart pointer is a box, whose type is written
+Box<T>. Boxes allow you to store data on the heap rather than the stack. What
+remains on the stack is the pointer to the heap data. Refer to Chapter 4 to
+review the difference between the stack and the heap.
+
Boxes don’t have performance overhead, other than storing their data on the
+heap instead of on the stack. But they don’t have many extra capabilities
+either. You’ll use them most often in these situations:
+
+
When you have a type whose size can’t be known at compile time and you want
+to use a value of that type in a context that requires an exact size
+
When you have a large amount of data and you want to transfer ownership but
+ensure the data won’t be copied when you do so
+
When you want to own a value and you care only that it’s a type that
+implements a particular trait rather than being of a specific type
+
+
We’ll demonstrate the first situation in the “Enabling Recursive Types with
+Boxes” section. In the
+second case, transferring ownership of a large amount of data can take a long
+time because the data is copied around on the stack. To improve performance in
+this situation, we can store the large amount of data on the heap in a box.
+Then, only the small amount of pointer data is copied around on the stack,
+while the data it references stays in one place on the heap. The third case is
+known as a trait object, and Chapter 17 devotes an entire section, “Using
+Trait Objects That Allow for Values of Different Types,” just to that topic. So what you learn here you’ll apply again in
+Chapter 17!
Before we discuss the heap storage use case for Box<T>, we’ll cover the
+syntax and how to interact with values stored within a Box<T>.
+
Listing 15-1 shows how to use a box to store an i32 value on the heap:
+
Filename: src/main.rs
+
fn main() {
+ let b = Box::new(5);
+ println!("b = {b}");
+}
+
Listing 15-1: Storing an i32 value on the heap using a
+box
+
We define the variable b to have the value of a Box that points to the
+value 5, which is allocated on the heap. This program will print b = 5; in
+this case, we can access the data in the box similar to how we would if this
+data were on the stack. Just like any owned value, when a box goes out of
+scope, as b does at the end of main, it will be deallocated. The
+deallocation happens both for the box (stored on the stack) and the data it
+points to (stored on the heap).
+
Putting a single value on the heap isn’t very useful, so you won’t use boxes by
+themselves in this way very often. Having values like a single i32 on the
+stack, where they’re stored by default, is more appropriate in the majority of
+situations. Let’s look at a case where boxes allow us to define types that we
+wouldn’t be allowed to if we didn’t have boxes.
A value of recursive type can have another value of the same type as part of
+itself. Recursive types pose an issue because at compile time Rust needs to
+know how much space a type takes up. However, the nesting of values of
+recursive types could theoretically continue infinitely, so Rust can’t know how
+much space the value needs. Because boxes have a known size, we can enable
+recursive types by inserting a box in the recursive type definition.
+
As an example of a recursive type, let’s explore the cons list. This is a data
+type commonly found in functional programming languages. The cons list type
+we’ll define is straightforward except for the recursion; therefore, the
+concepts in the example we’ll work with will be useful any time you get into
+more complex situations involving recursive types.
A cons list is a data structure that comes from the Lisp programming language
+and its dialects and is made up of nested pairs, and is the Lisp version of a
+linked list. Its name comes from the cons function (short for “construct
+function”) in Lisp that constructs a new pair from its two arguments. By
+calling cons on a pair consisting of a value and another pair, we can
+construct cons lists made up of recursive pairs.
+
For example, here’s a pseudocode representation of a cons list containing the
+list 1, 2, 3 with each pair in parentheses:
+
(1, (2, (3, Nil)))
+
+
Each item in a cons list contains two elements: the value of the current item
+and the next item. The last item in the list contains only a value called Nil
+without a next item. A cons list is produced by recursively calling the cons
+function. The canonical name to denote the base case of the recursion is Nil.
+Note that this is not the same as the “null” or “nil” concept in Chapter 6,
+which is an invalid or absent value.
+
The cons list isn’t a commonly used data structure in Rust. Most of the time
+when you have a list of items in Rust, Vec<T> is a better choice to use.
+Other, more complex recursive data types are useful in various situations,
+but by starting with the cons list in this chapter, we can explore how boxes
+let us define a recursive data type without much distraction.
+
Listing 15-2 contains an enum definition for a cons list. Note that this code
+won’t compile yet because the List type doesn’t have a known size, which
+we’ll demonstrate.
Listing 15-2: The first attempt at defining an enum to
+represent a cons list data structure of i32 values
+
+
Note: We’re implementing a cons list that holds only i32 values for the
+purposes of this example. We could have implemented it using generics, as we
+discussed in Chapter 10, to define a cons list type that could store values of
+any type.
+
+
Using the List type to store the list 1, 2, 3 would look like the code in
+Listing 15-3:
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, List),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+
+fn main() {
+ let list = Cons(1, Cons(2, Cons(3, Nil)));
+}
+
Listing 15-3: Using the List enum to store the list 1, 2, 3
+
The first Cons value holds 1 and another List value. This List value is
+another Cons value that holds 2 and another List value. This List value
+is one more Cons value that holds 3 and a List value, which is finally
+Nil, the non-recursive variant that signals the end of the list.
+
If we try to compile the code in Listing 15-3, we get the error shown in
+Listing 15-4:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+error[E0072]: recursive type `List` has infinite size
+ --> src/main.rs:1:1
+ |
+1 | enum List {
+ | ^^^^^^^^^
+2 | Cons(i32, List),
+ | ---- recursive without indirection
+ |
+help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to break the cycle
+ |
+2 | Cons(i32, Box<List>),
+ | ++++ +
+
+error[E0391]: cycle detected when computing when `List` needs drop
+ --> src/main.rs:1:1
+ |
+1 | enum List {
+ | ^^^^^^^^^
+ |
+ = note: ...which immediately requires computing when `List` needs drop again
+ = note: cycle used when computing whether `List` needs drop
+ = note: see https://rustc-dev-guide.rust-lang.org/overview.html#queries and https://rustc-dev-guide.rust-lang.org/query.html for more information
+
+Some errors have detailed explanations: E0072, E0391.
+For more information about an error, try `rustc --explain E0072`.
+error: could not compile `cons-list` (bin "cons-list") due to 2 previous errors
+
+
Listing 15-4: The error we get when attempting to define
+a recursive enum
+
The error shows this type “has infinite size.” The reason is that we’ve defined
+List with a variant that is recursive: it holds another value of itself
+directly. As a result, Rust can’t figure out how much space it needs to store a
+List value. Let’s break down why we get this error. First, we’ll look at how
+Rust decides how much space it needs to store a value of a non-recursive type.
To determine how much space to allocate for a Message value, Rust goes
+through each of the variants to see which variant needs the most space. Rust
+sees that Message::Quit doesn’t need any space, Message::Move needs enough
+space to store two i32 values, and so forth. Because only one variant will be
+used, the most space a Message value will need is the space it would take to
+store the largest of its variants.
+
Contrast this with what happens when Rust tries to determine how much space a
+recursive type like the List enum in Listing 15-2 needs. The compiler starts
+by looking at the Cons variant, which holds a value of type i32 and a value
+of type List. Therefore, Cons needs an amount of space equal to the size of
+an i32 plus the size of a List. To figure out how much memory the List
+type needs, the compiler looks at the variants, starting with the Cons
+variant. The Cons variant holds a value of type i32 and a value of type
+List, and this process continues infinitely, as shown in Figure 15-1.
+
+
Figure 15-1: An infinite List consisting of infinite
+Cons variants
Because Rust can’t figure out how much space to allocate for recursively
+defined types, the compiler gives an error with this helpful suggestion:
+
+
help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to break the cycle
+ |
+2 | Cons(i32, Box<List>),
+ | ++++ +
+
+
In this suggestion, “indirection” means that instead of storing a value
+directly, we should change the data structure to store the value indirectly by
+storing a pointer to the value instead.
+
Because a Box<T> is a pointer, Rust always knows how much space a Box<T>
+needs: a pointer’s size doesn’t change based on the amount of data it’s
+pointing to. This means we can put a Box<T> inside the Cons variant instead
+of another List value directly. The Box<T> will point to the next List
+value that will be on the heap rather than inside the Cons variant.
+Conceptually, we still have a list, created with lists holding other lists, but
+this implementation is now more like placing the items next to one another
+rather than inside one another.
+
We can change the definition of the List enum in Listing 15-2 and the usage
+of the List in Listing 15-3 to the code in Listing 15-5, which will compile:
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Box<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+
+fn main() {
+ let list = Cons(1, Box::new(Cons(2, Box::new(Cons(3, Box::new(Nil))))));
+}
+
Listing 15-5: Definition of List that uses Box<T> in
+order to have a known size
+
The Cons variant needs the size of an i32 plus the space to store the
+box’s pointer data. The Nil variant stores no values, so it needs less space
+than the Cons variant. We now know that any List value will take up the
+size of an i32 plus the size of a box’s pointer data. By using a box, we’ve
+broken the infinite, recursive chain, so the compiler can figure out the size
+it needs to store a List value. Figure 15-2 shows what the Cons variant
+looks like now.
+
+
Figure 15-2: A List that is not infinitely sized
+because Cons holds a Box
+
Boxes provide only the indirection and heap allocation; they don’t have any
+other special capabilities, like those we’ll see with the other smart pointer
+types. They also don’t have the performance overhead that these special
+capabilities incur, so they can be useful in cases like the cons list where the
+indirection is the only feature we need. We’ll look at more use cases for boxes
+in Chapter 17, too.
+
The Box<T> type is a smart pointer because it implements the Deref trait,
+which allows Box<T> values to be treated like references. When a Box<T>
+value goes out of scope, the heap data that the box is pointing to is cleaned
+up as well because of the Drop trait implementation. These two traits will be
+even more important to the functionality provided by the other smart pointer
+types we’ll discuss in the rest of this chapter. Let’s explore these two traits
+in more detail.
Implementing the Deref trait allows you to customize the behavior of the
+dereference operator* (not to be confused with the multiplication or glob
+operator). By implementing Deref in such a way that a smart pointer can be
+treated like a regular reference, you can write code that operates on
+references and use that code with smart pointers too.
+
Let’s first look at how the dereference operator works with regular references.
+Then we’ll try to define a custom type that behaves like Box<T>, and see why
+the dereference operator doesn’t work like a reference on our newly defined
+type. We’ll explore how implementing the Deref trait makes it possible for
+smart pointers to work in ways similar to references. Then we’ll look at
+Rust’s deref coercion feature and how it lets us work with either references
+or smart pointers.
+
+
Note: There’s one big difference between the MyBox<T> type we’re about to
+build and the real Box<T>: our version will not store its data on the heap.
+We are focusing this example on Deref, so where the data is actually stored
+is less important than the pointer-like behavior.
A regular reference is a type of pointer, and one way to think of a pointer is
+as an arrow to a value stored somewhere else. In Listing 15-6, we create a
+reference to an i32 value and then use the dereference operator to follow the
+reference to the value:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+ let y = &x;
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-6: Using the dereference operator to follow a
+reference to an i32 value
+
The variable x holds an i32 value 5. We set y equal to a reference to
+x. We can assert that x is equal to 5. However, if we want to make an
+assertion about the value in y, we have to use *y to follow the reference
+to the value it’s pointing to (hence dereference) so the compiler can compare
+the actual value. Once we dereference y, we have access to the integer value
+y is pointing to that we can compare with 5.
+
If we tried to write assert_eq!(5, y); instead, we would get this compilation
+error:
+
$ cargo run
+ Compiling deref-example v0.1.0 (file:///projects/deref-example)
+error[E0277]: can't compare `{integer}` with `&{integer}`
+ --> src/main.rs:6:5
+ |
+6 | assert_eq!(5, y);
+ | ^^^^^^^^^^^^^^^^ no implementation for `{integer} == &{integer}`
+ |
+ = help: the trait `PartialEq<&{integer}>` is not implemented for `{integer}`
+ = note: this error originates in the macro `assert_eq` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `deref-example` (bin "deref-example") due to 1 previous error
+
+
Comparing a number and a reference to a number isn’t allowed because they’re
+different types. We must use the dereference operator to follow the reference
+to the value it’s pointing to.
We can rewrite the code in Listing 15-6 to use a Box<T> instead of a
+reference; the dereference operator used on the Box<T> in Listing 15-7
+functions in the same way as the dereference operator used on the reference in
+Listing 15-6:
+
Filename: src/main.rs
+
fn main() {
+ let x = 5;
+ let y = Box::new(x);
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-7: Using the dereference operator on a
+Box<i32>
+
The main difference between Listing 15-7 and Listing 15-6 is that here we set
+y to be an instance of a Box<T> pointing to a copied value of x rather
+than a reference pointing to the value of x. In the last assertion, we can
+use the dereference operator to follow the pointer of the Box<T> in the same
+way that we did when y was a reference. Next, we’ll explore what is special
+about Box<T> that enables us to use the dereference operator by defining our
+own type.
Let’s build a smart pointer similar to the Box<T> type provided by the
+standard library to experience how smart pointers behave differently from
+references by default. Then we’ll look at how to add the ability to use the
+dereference operator.
+
The Box<T> type is ultimately defined as a tuple struct with one element, so
+Listing 15-8 defines a MyBox<T> type in the same way. We’ll also define a
+new function to match the new function defined on Box<T>.
We define a struct named MyBox and declare a generic parameter T, because
+we want our type to hold values of any type. The MyBox type is a tuple struct
+with one element of type T. The MyBox::new function takes one parameter of
+type T and returns a MyBox instance that holds the value passed in.
+
Let’s try adding the main function in Listing 15-7 to Listing 15-8 and
+changing it to use the MyBox<T> type we’ve defined instead of Box<T>. The
+code in Listing 15-9 won’t compile because Rust doesn’t know how to dereference
+MyBox.
+
Filename: src/main.rs
+
struct MyBox<T>(T);
+
+impl<T> MyBox<T> {
+ fn new(x: T) -> MyBox<T> {
+ MyBox(x)
+ }
+}
+
+fn main() {
+ let x = 5;
+ let y = MyBox::new(x);
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-9: Attempting to use MyBox<T> in the same
+way we used references and Box<T>
+
Here’s the resulting compilation error:
+
$ cargo run
+ Compiling deref-example v0.1.0 (file:///projects/deref-example)
+error[E0614]: type `MyBox<{integer}>` cannot be dereferenced
+ --> src/main.rs:14:19
+ |
+14 | assert_eq!(5, *y);
+ | ^^
+
+For more information about this error, try `rustc --explain E0614`.
+error: could not compile `deref-example` (bin "deref-example") due to 1 previous error
+
+
Our MyBox<T> type can’t be dereferenced because we haven’t implemented that
+ability on our type. To enable dereferencing with the * operator, we
+implement the Deref trait.
As discussed in the “Implementing a Trait on a Type” section of Chapter 10, to implement a trait, we need to provide
+implementations for the trait’s required methods. The Deref trait, provided
+by the standard library, requires us to implement one method named deref that
+borrows self and returns a reference to the inner data. Listing 15-10
+contains an implementation of Deref to add to the definition of MyBox:
+
Filename: src/main.rs
+
use std::ops::Deref;
+
+impl<T> Deref for MyBox<T> {
+ type Target = T;
+
+ fn deref(&self) -> &Self::Target {
+ &self.0
+ }
+}
+
+struct MyBox<T>(T);
+
+impl<T> MyBox<T> {
+ fn new(x: T) -> MyBox<T> {
+ MyBox(x)
+ }
+}
+
+fn main() {
+ let x = 5;
+ let y = MyBox::new(x);
+
+ assert_eq!(5, x);
+ assert_eq!(5, *y);
+}
+
Listing 15-10: Implementing Deref on MyBox<T>
+
The type Target = T; syntax defines an associated type for the Deref
+trait to use. Associated types are a slightly different way of declaring a
+generic parameter, but you don’t need to worry about them for now; we’ll cover
+them in more detail in Chapter 19.
+
We fill in the body of the deref method with &self.0 so deref returns a
+reference to the value we want to access with the * operator; recall from the
+“Using Tuple Structs without Named Fields to Create Different
+Types” section of Chapter 5 that .0 accesses
+the first value in a tuple struct. The main function in Listing 15-9 that
+calls * on the MyBox<T> value now compiles, and the assertions pass!
+
Without the Deref trait, the compiler can only dereference & references.
+The deref method gives the compiler the ability to take a value of any type
+that implements Deref and call the deref method to get a & reference that
+it knows how to dereference.
+
When we entered *y in Listing 15-9, behind the scenes Rust actually ran this
+code:
+
*(y.deref())
+
Rust substitutes the * operator with a call to the deref method and then a
+plain dereference so we don’t have to think about whether or not we need to
+call the deref method. This Rust feature lets us write code that functions
+identically whether we have a regular reference or a type that implements
+Deref.
+
The reason the deref method returns a reference to a value, and that the
+plain dereference outside the parentheses in *(y.deref()) is still necessary,
+is to do with the ownership system. If the deref method returned the value
+directly instead of a reference to the value, the value would be moved out of
+self. We don’t want to take ownership of the inner value inside MyBox<T> in
+this case or in most cases where we use the dereference operator.
+
Note that the * operator is replaced with a call to the deref method and
+then a call to the * operator just once, each time we use a * in our code.
+Because the substitution of the * operator does not recurse infinitely, we
+end up with data of type i32, which matches the 5 in assert_eq! in
+Listing 15-9.
Deref coercion converts a reference to a type that implements the Deref
+trait into a reference to another type. For example, deref coercion can convert
+&String to &str because String implements the Deref trait such that it
+returns &str. Deref coercion is a convenience Rust performs on arguments to
+functions and methods, and works only on types that implement the Deref
+trait. It happens automatically when we pass a reference to a particular type’s
+value as an argument to a function or method that doesn’t match the parameter
+type in the function or method definition. A sequence of calls to the deref
+method converts the type we provided into the type the parameter needs.
+
Deref coercion was added to Rust so that programmers writing function and
+method calls don’t need to add as many explicit references and dereferences
+with & and *. The deref coercion feature also lets us write more code that
+can work for either references or smart pointers.
+
To see deref coercion in action, let’s use the MyBox<T> type we defined in
+Listing 15-8 as well as the implementation of Deref that we added in Listing
+15-10. Listing 15-11 shows the definition of a function that has a string slice
+parameter:
Listing 15-11: A hello function that has the parameter
+name of type &str
+
We can call the hello function with a string slice as an argument, such as
+hello("Rust"); for example. Deref coercion makes it possible to call hello
+with a reference to a value of type MyBox<String>, as shown in Listing 15-12:
Listing 15-12: Calling hello with a reference to a
+MyBox<String> value, which works because of deref coercion
+
Here we’re calling the hello function with the argument &m, which is a
+reference to a MyBox<String> value. Because we implemented the Deref trait
+on MyBox<T> in Listing 15-10, Rust can turn &MyBox<String> into &String
+by calling deref. The standard library provides an implementation of Deref
+on String that returns a string slice, and this is in the API documentation
+for Deref. Rust calls deref again to turn the &String into &str, which
+matches the hello function’s definition.
+
If Rust didn’t implement deref coercion, we would have to write the code in
+Listing 15-13 instead of the code in Listing 15-12 to call hello with a value
+of type &MyBox<String>.
Listing 15-13: The code we would have to write if Rust
+didn’t have deref coercion
+
The (*m) dereferences the MyBox<String> into a String. Then the & and
+[..] take a string slice of the String that is equal to the whole string to
+match the signature of hello. This code without deref coercions is harder to
+read, write, and understand with all of these symbols involved. Deref coercion
+allows Rust to handle these conversions for us automatically.
+
When the Deref trait is defined for the types involved, Rust will analyze the
+types and use Deref::deref as many times as necessary to get a reference to
+match the parameter’s type. The number of times that Deref::deref needs to be
+inserted is resolved at compile time, so there is no runtime penalty for taking
+advantage of deref coercion!
Similar to how you use the Deref trait to override the * operator on
+immutable references, you can use the DerefMut trait to override the *
+operator on mutable references.
+
Rust does deref coercion when it finds types and trait implementations in three
+cases:
+
+
From &T to &U when T: Deref<Target=U>
+
From &mut T to &mut U when T: DerefMut<Target=U>
+
From &mut T to &U when T: Deref<Target=U>
+
+
The first two cases are the same as each other except that the second
+implements mutability. The first case states that if you have a &T, and T
+implements Deref to some type U, you can get a &U transparently. The
+second case states that the same deref coercion happens for mutable references.
+
The third case is trickier: Rust will also coerce a mutable reference to an
+immutable one. But the reverse is not possible: immutable references will
+never coerce to mutable references. Because of the borrowing rules, if you have
+a mutable reference, that mutable reference must be the only reference to that
+data (otherwise, the program wouldn’t compile). Converting one mutable
+reference to one immutable reference will never break the borrowing rules.
+Converting an immutable reference to a mutable reference would require that the
+initial immutable reference is the only immutable reference to that data, but
+the borrowing rules don’t guarantee that. Therefore, Rust can’t make the
+assumption that converting an immutable reference to a mutable reference is
+possible.
The second trait important to the smart pointer pattern is Drop, which lets
+you customize what happens when a value is about to go out of scope. You can
+provide an implementation for the Drop trait on any type, and that code can
+be used to release resources like files or network connections.
+
We’re introducing Drop in the context of smart pointers because the
+functionality of the Drop trait is almost always used when implementing a
+smart pointer. For example, when a Box<T> is dropped it will deallocate the
+space on the heap that the box points to.
+
In some languages, for some types, the programmer must call code to free memory
+or resources every time they finish using an instance of those types. Examples
+include file handles, sockets, or locks. If they forget, the system might
+become overloaded and crash. In Rust, you can specify that a particular bit of
+code be run whenever a value goes out of scope, and the compiler will insert
+this code automatically. As a result, you don’t need to be careful about
+placing cleanup code everywhere in a program that an instance of a particular
+type is finished with—you still won’t leak resources!
+
You specify the code to run when a value goes out of scope by implementing the
+Drop trait. The Drop trait requires you to implement one method named
+drop that takes a mutable reference to self. To see when Rust calls drop,
+let’s implement drop with println! statements for now.
+
Listing 15-14 shows a CustomSmartPointer struct whose only custom
+functionality is that it will print Dropping CustomSmartPointer! when the
+instance goes out of scope, to show when Rust runs the drop function.
+
Filename: src/main.rs
+
struct CustomSmartPointer {
+ data: String,
+}
+
+impl Drop for CustomSmartPointer {
+ fn drop(&mut self) {
+ println!("Dropping CustomSmartPointer with data `{}`!", self.data);
+ }
+}
+
+fn main() {
+ let c = CustomSmartPointer {
+ data: String::from("my stuff"),
+ };
+ let d = CustomSmartPointer {
+ data: String::from("other stuff"),
+ };
+ println!("CustomSmartPointers created.");
+}
+
Listing 15-14: A CustomSmartPointer struct that
+implements the Drop trait where we would put our cleanup code
+
The Drop trait is included in the prelude, so we don’t need to bring it into
+scope. We implement the Drop trait on CustomSmartPointer and provide an
+implementation for the drop method that calls println!. The body of the
+drop function is where you would place any logic that you wanted to run when
+an instance of your type goes out of scope. We’re printing some text here to
+demonstrate visually when Rust will call drop.
+
In main, we create two instances of CustomSmartPointer and then print
+CustomSmartPointers created. At the end of main, our instances of
+CustomSmartPointer will go out of scope, and Rust will call the code we put
+in the drop method, printing our final message. Note that we didn’t need to
+call the drop method explicitly.
+
When we run this program, we’ll see the following output:
+
$ cargo run
+ Compiling drop-example v0.1.0 (file:///projects/drop-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.60s
+ Running `target/debug/drop-example`
+CustomSmartPointers created.
+Dropping CustomSmartPointer with data `other stuff`!
+Dropping CustomSmartPointer with data `my stuff`!
+
+
Rust automatically called drop for us when our instances went out of scope,
+calling the code we specified. Variables are dropped in the reverse order of
+their creation, so d was dropped before c. This example’s purpose is to
+give you a visual guide to how the drop method works; usually you would
+specify the cleanup code that your type needs to run rather than a print
+message.
Unfortunately, it’s not straightforward to disable the automatic drop
+functionality. Disabling drop isn’t usually necessary; the whole point of the
+Drop trait is that it’s taken care of automatically. Occasionally, however,
+you might want to clean up a value early. One example is when using smart
+pointers that manage locks: you might want to force the drop method that
+releases the lock so that other code in the same scope can acquire the lock.
+Rust doesn’t let you call the Drop trait’s drop method manually; instead
+you have to call the std::mem::drop function provided by the standard library
+if you want to force a value to be dropped before the end of its scope.
+
If we try to call the Drop trait’s drop method manually by modifying the
+main function from Listing 15-14, as shown in Listing 15-15, we’ll get a
+compiler error:
+
Filename: src/main.rs
+
struct CustomSmartPointer {
+ data: String,
+}
+
+impl Drop for CustomSmartPointer {
+ fn drop(&mut self) {
+ println!("Dropping CustomSmartPointer with data `{}`!", self.data);
+ }
+}
+
+fn main() {
+ let c = CustomSmartPointer {
+ data: String::from("some data"),
+ };
+ println!("CustomSmartPointer created.");
+ c.drop();
+ println!("CustomSmartPointer dropped before the end of main.");
+}
+
Listing 15-15: Attempting to call the drop method from
+the Drop trait manually to clean up early
+
When we try to compile this code, we’ll get this error:
+
$ cargo run
+ Compiling drop-example v0.1.0 (file:///projects/drop-example)
+error[E0040]: explicit use of destructor method
+ --> src/main.rs:16:7
+ |
+16 | c.drop();
+ | ^^^^ explicit destructor calls not allowed
+ |
+help: consider using `drop` function
+ |
+16 | drop(c);
+ | +++++ ~
+
+For more information about this error, try `rustc --explain E0040`.
+error: could not compile `drop-example` (bin "drop-example") due to 1 previous error
+
+
This error message states that we’re not allowed to explicitly call drop. The
+error message uses the term destructor, which is the general programming term
+for a function that cleans up an instance. A destructor is analogous to a
+constructor, which creates an instance. The drop function in Rust is one
+particular destructor.
+
Rust doesn’t let us call drop explicitly because Rust would still
+automatically call drop on the value at the end of main. This would cause a
+double free error because Rust would be trying to clean up the same value
+twice.
+
We can’t disable the automatic insertion of drop when a value goes out of
+scope, and we can’t call the drop method explicitly. So, if we need to force
+a value to be cleaned up early, we use the std::mem::drop function.
+
The std::mem::drop function is different from the drop method in the Drop
+trait. We call it by passing as an argument the value we want to force drop.
+The function is in the prelude, so we can modify main in Listing 15-15 to
+call the drop function, as shown in Listing 15-16:
+
Filename: src/main.rs
+
struct CustomSmartPointer {
+ data: String,
+}
+
+impl Drop for CustomSmartPointer {
+ fn drop(&mut self) {
+ println!("Dropping CustomSmartPointer with data `{}`!", self.data);
+ }
+}
+
+fn main() {
+ let c = CustomSmartPointer {
+ data: String::from("some data"),
+ };
+ println!("CustomSmartPointer created.");
+ drop(c);
+ println!("CustomSmartPointer dropped before the end of main.");
+}
+
Listing 15-16: Calling std::mem::drop to explicitly
+drop a value before it goes out of scope
+
Running this code will print the following:
+
$ cargo run
+ Compiling drop-example v0.1.0 (file:///projects/drop-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.73s
+ Running `target/debug/drop-example`
+CustomSmartPointer created.
+Dropping CustomSmartPointer with data `some data`!
+CustomSmartPointer dropped before the end of main.
+
+
The text Dropping CustomSmartPointer with data `some data`! is printed
+between the CustomSmartPointer created. and CustomSmartPointer dropped before the end of main. text, showing that the drop method code is called to
+drop c at that point.
+
You can use code specified in a Drop trait implementation in many ways to
+make cleanup convenient and safe: for instance, you could use it to create your
+own memory allocator! With the Drop trait and Rust’s ownership system, you
+don’t have to remember to clean up because Rust does it automatically.
+
You also don’t have to worry about problems resulting from accidentally
+cleaning up values still in use: the ownership system that makes sure
+references are always valid also ensures that drop gets called only once when
+the value is no longer being used.
+
Now that we’ve examined Box<T> and some of the characteristics of smart
+pointers, let’s look at a few other smart pointers defined in the standard
+library.
In the majority of cases, ownership is clear: you know exactly which variable
+owns a given value. However, there are cases when a single value might have
+multiple owners. For example, in graph data structures, multiple edges might
+point to the same node, and that node is conceptually owned by all of the edges
+that point to it. A node shouldn’t be cleaned up unless it doesn’t have any
+edges pointing to it and so has no owners.
+
You have to enable multiple ownership explicitly by using the Rust type
+Rc<T>, which is an abbreviation for reference counting. The Rc<T> type
+keeps track of the number of references to a value to determine whether or not
+the value is still in use. If there are zero references to a value, the value
+can be cleaned up without any references becoming invalid.
+
Imagine Rc<T> as a TV in a family room. When one person enters to watch TV,
+they turn it on. Others can come into the room and watch the TV. When the last
+person leaves the room, they turn off the TV because it’s no longer being used.
+If someone turns off the TV while others are still watching it, there would be
+uproar from the remaining TV watchers!
+
We use the Rc<T> type when we want to allocate some data on the heap for
+multiple parts of our program to read and we can’t determine at compile time
+which part will finish using the data last. If we knew which part would finish
+last, we could just make that part the data’s owner, and the normal ownership
+rules enforced at compile time would take effect.
+
Note that Rc<T> is only for use in single-threaded scenarios. When we discuss
+concurrency in Chapter 16, we’ll cover how to do reference counting in
+multithreaded programs.
Let’s return to our cons list example in Listing 15-5. Recall that we defined
+it using Box<T>. This time, we’ll create two lists that both share ownership
+of a third list. Conceptually, this looks similar to Figure 15-3:
+
+
Figure 15-3: Two lists, b and c, sharing ownership of
+a third list, a
+
We’ll create list a that contains 5 and then 10. Then we’ll make two more
+lists: b that starts with 3 and c that starts with 4. Both b and c
+lists will then continue on to the first a list containing 5 and 10. In other
+words, both lists will share the first list containing 5 and 10.
+
Trying to implement this scenario using our definition of List with Box<T>
+won’t work, as shown in Listing 15-17:
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Box<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+
+fn main() {
+ let a = Cons(5, Box::new(Cons(10, Box::new(Nil))));
+ let b = Cons(3, Box::new(a));
+ let c = Cons(4, Box::new(a));
+}
+
Listing 15-17: Demonstrating we’re not allowed to have
+two lists using Box<T> that try to share ownership of a third list
+
When we compile this code, we get this error:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+error[E0382]: use of moved value: `a`
+ --> src/main.rs:11:30
+ |
+9 | let a = Cons(5, Box::new(Cons(10, Box::new(Nil))));
+ | - move occurs because `a` has type `List`, which does not implement the `Copy` trait
+10 | let b = Cons(3, Box::new(a));
+ | - value moved here
+11 | let c = Cons(4, Box::new(a));
+ | ^ value used here after move
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `cons-list` (bin "cons-list") due to 1 previous error
+
+
The Cons variants own the data they hold, so when we create the b list, a
+is moved into b and b owns a. Then, when we try to use a again when
+creating c, we’re not allowed to because a has been moved.
+
We could change the definition of Cons to hold references instead, but then
+we would have to specify lifetime parameters. By specifying lifetime
+parameters, we would be specifying that every element in the list will live at
+least as long as the entire list. This is the case for the elements and lists
+in Listing 15-17, but not in every scenario.
+
Instead, we’ll change our definition of List to use Rc<T> in place of
+Box<T>, as shown in Listing 15-18. Each Cons variant will now hold a value
+and an Rc<T> pointing to a List. When we create b, instead of taking
+ownership of a, we’ll clone the Rc<List> that a is holding, thereby
+increasing the number of references from one to two and letting a and b
+share ownership of the data in that Rc<List>. We’ll also clone a when
+creating c, increasing the number of references from two to three. Every time
+we call Rc::clone, the reference count to the data within the Rc<List> will
+increase, and the data won’t be cleaned up unless there are zero references to
+it.
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Rc<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+use std::rc::Rc;
+
+fn main() {
+ let a = Rc::new(Cons(5, Rc::new(Cons(10, Rc::new(Nil)))));
+ let b = Cons(3, Rc::clone(&a));
+ let c = Cons(4, Rc::clone(&a));
+}
+
Listing 15-18: A definition of List that uses
+Rc<T>
+
We need to add a use statement to bring Rc<T> into scope because it’s not
+in the prelude. In main, we create the list holding 5 and 10 and store it in
+a new Rc<List> in a. Then when we create b and c, we call the
+Rc::clone function and pass a reference to the Rc<List> in a as an
+argument.
+
We could have called a.clone() rather than Rc::clone(&a), but Rust’s
+convention is to use Rc::clone in this case. The implementation of
+Rc::clone doesn’t make a deep copy of all the data like most types’
+implementations of clone do. The call to Rc::clone only increments the
+reference count, which doesn’t take much time. Deep copies of data can take a
+lot of time. By using Rc::clone for reference counting, we can visually
+distinguish between the deep-copy kinds of clones and the kinds of clones that
+increase the reference count. When looking for performance problems in the
+code, we only need to consider the deep-copy clones and can disregard calls to
+Rc::clone.
Let’s change our working example in Listing 15-18 so we can see the reference
+counts changing as we create and drop references to the Rc<List> in a.
+
In Listing 15-19, we’ll change main so it has an inner scope around list c;
+then we can see how the reference count changes when c goes out of scope.
+
Filename: src/main.rs
+
enum List {
+ Cons(i32, Rc<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+use std::rc::Rc;
+
+fn main() {
+ let a = Rc::new(Cons(5, Rc::new(Cons(10, Rc::new(Nil)))));
+ println!("count after creating a = {}", Rc::strong_count(&a));
+ let b = Cons(3, Rc::clone(&a));
+ println!("count after creating b = {}", Rc::strong_count(&a));
+ {
+ let c = Cons(4, Rc::clone(&a));
+ println!("count after creating c = {}", Rc::strong_count(&a));
+ }
+ println!("count after c goes out of scope = {}", Rc::strong_count(&a));
+}
+
Listing 15-19: Printing the reference count
+
At each point in the program where the reference count changes, we print the
+reference count, which we get by calling the Rc::strong_count function. This
+function is named strong_count rather than count because the Rc<T> type
+also has a weak_count; we’ll see what weak_count is used for in the
+“Preventing Reference Cycles: Turning an Rc<T> into a
+Weak<T>” section.
+
This code prints the following:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.45s
+ Running `target/debug/cons-list`
+count after creating a = 1
+count after creating b = 2
+count after creating c = 3
+count after c goes out of scope = 2
+
+
We can see that the Rc<List> in a has an initial reference count of 1; then
+each time we call clone, the count goes up by 1. When c goes out of scope,
+the count goes down by 1. We don’t have to call a function to decrease the
+reference count like we have to call Rc::clone to increase the reference
+count: the implementation of the Drop trait decreases the reference count
+automatically when an Rc<T> value goes out of scope.
+
What we can’t see in this example is that when b and then a go out of scope
+at the end of main, the count is then 0, and the Rc<List> is cleaned up
+completely. Using Rc<T> allows a single value to have multiple owners, and
+the count ensures that the value remains valid as long as any of the owners
+still exist.
+
Via immutable references, Rc<T> allows you to share data between multiple
+parts of your program for reading only. If Rc<T> allowed you to have multiple
+mutable references too, you might violate one of the borrowing rules discussed
+in Chapter 4: multiple mutable borrows to the same place can cause data races
+and inconsistencies. But being able to mutate data is very useful! In the next
+section, we’ll discuss the interior mutability pattern and the RefCell<T>
+type that you can use in conjunction with an Rc<T> to work with this
+immutability restriction.
Interior mutability is a design pattern in Rust that allows you to mutate
+data even when there are immutable references to that data; normally, this
+action is disallowed by the borrowing rules. To mutate data, the pattern uses
+unsafe code inside a data structure to bend Rust’s usual rules that govern
+mutation and borrowing. Unsafe code indicates to the compiler that we’re
+checking the rules manually instead of relying on the compiler to check them
+for us; we will discuss unsafe code more in Chapter 19.
+
We can use types that use the interior mutability pattern only when we can
+ensure that the borrowing rules will be followed at runtime, even though the
+compiler can’t guarantee that. The unsafe code involved is then wrapped in a
+safe API, and the outer type is still immutable.
+
Let’s explore this concept by looking at the RefCell<T> type that follows the
+interior mutability pattern.
Unlike Rc<T>, the RefCell<T> type represents single ownership over the data
+it holds. So, what makes RefCell<T> different from a type like Box<T>?
+Recall the borrowing rules you learned in Chapter 4:
+
+
At any given time, you can have either (but not both) one mutable reference
+or any number of immutable references.
+
References must always be valid.
+
+
With references and Box<T>, the borrowing rules’ invariants are enforced at
+compile time. With RefCell<T>, these invariants are enforced at runtime.
+With references, if you break these rules, you’ll get a compiler error. With
+RefCell<T>, if you break these rules, your program will panic and exit.
+
The advantages of checking the borrowing rules at compile time are that errors
+will be caught sooner in the development process, and there is no impact on
+runtime performance because all the analysis is completed beforehand. For those
+reasons, checking the borrowing rules at compile time is the best choice in the
+majority of cases, which is why this is Rust’s default.
+
The advantage of checking the borrowing rules at runtime instead is that
+certain memory-safe scenarios are then allowed, where they would’ve been
+disallowed by the compile-time checks. Static analysis, like the Rust compiler,
+is inherently conservative. Some properties of code are impossible to detect by
+analyzing the code: the most famous example is the Halting Problem, which is
+beyond the scope of this book but is an interesting topic to research.
+
Because some analysis is impossible, if the Rust compiler can’t be sure the
+code complies with the ownership rules, it might reject a correct program; in
+this way, it’s conservative. If Rust accepted an incorrect program, users
+wouldn’t be able to trust in the guarantees Rust makes. However, if Rust
+rejects a correct program, the programmer will be inconvenienced, but nothing
+catastrophic can occur. The RefCell<T> type is useful when you’re sure your
+code follows the borrowing rules but the compiler is unable to understand and
+guarantee that.
+
Similar to Rc<T>, RefCell<T> is only for use in single-threaded scenarios
+and will give you a compile-time error if you try using it in a multithreaded
+context. We’ll talk about how to get the functionality of RefCell<T> in a
+multithreaded program in Chapter 16.
+
Here is a recap of the reasons to choose Box<T>, Rc<T>, or RefCell<T>:
+
+
Rc<T> enables multiple owners of the same data; Box<T> and RefCell<T>
+have single owners.
+
Box<T> allows immutable or mutable borrows checked at compile time; Rc<T>
+allows only immutable borrows checked at compile time; RefCell<T> allows
+immutable or mutable borrows checked at runtime.
+
Because RefCell<T> allows mutable borrows checked at runtime, you can
+mutate the value inside the RefCell<T> even when the RefCell<T> is
+immutable.
+
+
Mutating the value inside an immutable value is the interior mutability
+pattern. Let’s look at a situation in which interior mutability is useful and
+examine how it’s possible.
A consequence of the borrowing rules is that when you have an immutable value,
+you can’t borrow it mutably. For example, this code won’t compile:
+
fn main() {
+ let x = 5;
+ let y = &mut x;
+}
+
If you tried to compile this code, you’d get the following error:
+
$ cargo run
+ Compiling borrowing v0.1.0 (file:///projects/borrowing)
+error[E0596]: cannot borrow `x` as mutable, as it is not declared as mutable
+ --> src/main.rs:3:13
+ |
+3 | let y = &mut x;
+ | ^^^^^^ cannot borrow as mutable
+ |
+help: consider changing this to be mutable
+ |
+2 | let mut x = 5;
+ | +++
+
+For more information about this error, try `rustc --explain E0596`.
+error: could not compile `borrowing` (bin "borrowing") due to 1 previous error
+
+
However, there are situations in which it would be useful for a value to mutate
+itself in its methods but appear immutable to other code. Code outside the
+value’s methods would not be able to mutate the value. Using RefCell<T> is
+one way to get the ability to have interior mutability, but RefCell<T>
+doesn’t get around the borrowing rules completely: the borrow checker in the
+compiler allows this interior mutability, and the borrowing rules are checked
+at runtime instead. If you violate the rules, you’ll get a panic! instead of
+a compiler error.
+
Let’s work through a practical example where we can use RefCell<T> to mutate
+an immutable value and see why that is useful.
Sometimes during testing a programmer will use a type in place of another type,
+in order to observe particular behavior and assert it’s implemented correctly.
+This placeholder type is called a test double. Think of it in the sense of a
+“stunt double” in filmmaking, where a person steps in and substitutes for an
+actor to do a particular tricky scene. Test doubles stand in for other types
+when we’re running tests. Mock objects are specific types of test doubles
+that record what happens during a test so you can assert that the correct
+actions took place.
+
Rust doesn’t have objects in the same sense as other languages have objects,
+and Rust doesn’t have mock object functionality built into the standard library
+as some other languages do. However, you can definitely create a struct that
+will serve the same purposes as a mock object.
+
Here’s the scenario we’ll test: we’ll create a library that tracks a value
+against a maximum value and sends messages based on how close to the maximum
+value the current value is. This library could be used to keep track of a
+user’s quota for the number of API calls they’re allowed to make, for example.
+
Our library will only provide the functionality of tracking how close to the
+maximum a value is and what the messages should be at what times. Applications
+that use our library will be expected to provide the mechanism for sending the
+messages: the application could put a message in the application, send an
+email, send a text message, or something else. The library doesn’t need to know
+that detail. All it needs is something that implements a trait we’ll provide
+called Messenger. Listing 15-20 shows the library code:
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
Listing 15-20: A library to keep track of how close a
+value is to a maximum value and warn when the value is at certain levels
+
One important part of this code is that the Messenger trait has one method
+called send that takes an immutable reference to self and the text of the
+message. This trait is the interface our mock object needs to implement so that
+the mock can be used in the same way a real object is. The other important part
+is that we want to test the behavior of the set_value method on the
+LimitTracker. We can change what we pass in for the value parameter, but
+set_value doesn’t return anything for us to make assertions on. We want to be
+able to say that if we create a LimitTracker with something that implements
+the Messenger trait and a particular value for max, when we pass different
+numbers for value, the messenger is told to send the appropriate messages.
+
We need a mock object that, instead of sending an email or text message when we
+call send, will only keep track of the messages it’s told to send. We can
+create a new instance of the mock object, create a LimitTracker that uses the
+mock object, call the set_value method on LimitTracker, and then check that
+the mock object has the messages we expect. Listing 15-21 shows an attempt to
+implement a mock object to do just that, but the borrow checker won’t allow it:
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ struct MockMessenger {
+ sent_messages: Vec<String>,
+ }
+
+ impl MockMessenger {
+ fn new() -> MockMessenger {
+ MockMessenger {
+ sent_messages: vec![],
+ }
+ }
+ }
+
+ impl Messenger for MockMessenger {
+ fn send(&self, message: &str) {
+ self.sent_messages.push(String::from(message));
+ }
+ }
+
+ #[test]
+ fn it_sends_an_over_75_percent_warning_message() {
+ let mock_messenger = MockMessenger::new();
+ let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
+
+ limit_tracker.set_value(80);
+
+ assert_eq!(mock_messenger.sent_messages.len(), 1);
+ }
+}
+
Listing 15-21: An attempt to implement a MockMessenger
+that isn’t allowed by the borrow checker
+
This test code defines a MockMessenger struct that has a sent_messages
+field with a Vec of String values to keep track of the messages it’s told
+to send. We also define an associated function new to make it convenient to
+create new MockMessenger values that start with an empty list of messages. We
+then implement the Messenger trait for MockMessenger so we can give a
+MockMessenger to a LimitTracker. In the definition of the send method, we
+take the message passed in as a parameter and store it in the MockMessenger
+list of sent_messages.
+
In the test, we’re testing what happens when the LimitTracker is told to set
+value to something that is more than 75 percent of the max value. First, we
+create a new MockMessenger, which will start with an empty list of messages.
+Then we create a new LimitTracker and give it a reference to the new
+MockMessenger and a max value of 100. We call the set_value method on the
+LimitTracker with a value of 80, which is more than 75 percent of 100. Then
+we assert that the list of messages that the MockMessenger is keeping track
+of should now have one message in it.
+
However, there’s one problem with this test, as shown here:
+
$ cargo test
+ Compiling limit-tracker v0.1.0 (file:///projects/limit-tracker)
+error[E0596]: cannot borrow `self.sent_messages` as mutable, as it is behind a `&` reference
+ --> src/lib.rs:58:13
+ |
+58 | self.sent_messages.push(String::from(message));
+ | ^^^^^^^^^^^^^^^^^^ `self` is a `&` reference, so the data it refers to cannot be borrowed as mutable
+ |
+help: consider changing this to be a mutable reference
+ |
+2 | fn send(&mut self, msg: &str);
+ | ~~~~~~~~~
+
+For more information about this error, try `rustc --explain E0596`.
+error: could not compile `limit-tracker` (lib test) due to 1 previous error
+
+
We can’t modify the MockMessenger to keep track of the messages, because the
+send method takes an immutable reference to self. We also can’t take the
+suggestion from the error text to use &mut self instead, because then the
+signature of send wouldn’t match the signature in the Messenger trait
+definition (feel free to try and see what error message you get).
+
This is a situation in which interior mutability can help! We’ll store the
+sent_messages within a RefCell<T>, and then the send method will be
+able to modify sent_messages to store the messages we’ve seen. Listing 15-22
+shows what that looks like:
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::cell::RefCell;
+
+ struct MockMessenger {
+ sent_messages: RefCell<Vec<String>>,
+ }
+
+ impl MockMessenger {
+ fn new() -> MockMessenger {
+ MockMessenger {
+ sent_messages: RefCell::new(vec![]),
+ }
+ }
+ }
+
+ impl Messenger for MockMessenger {
+ fn send(&self, message: &str) {
+ self.sent_messages.borrow_mut().push(String::from(message));
+ }
+ }
+
+ #[test]
+ fn it_sends_an_over_75_percent_warning_message() {
+ // --snip--
+ let mock_messenger = MockMessenger::new();
+ let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
+
+ limit_tracker.set_value(80);
+
+ assert_eq!(mock_messenger.sent_messages.borrow().len(), 1);
+ }
+}
+
Listing 15-22: Using RefCell<T> to mutate an inner
+value while the outer value is considered immutable
+
The sent_messages field is now of type RefCell<Vec<String>> instead of
+Vec<String>. In the new function, we create a new RefCell<Vec<String>>
+instance around the empty vector.
+
For the implementation of the send method, the first parameter is still an
+immutable borrow of self, which matches the trait definition. We call
+borrow_mut on the RefCell<Vec<String>> in self.sent_messages to get a
+mutable reference to the value inside the RefCell<Vec<String>>, which is the
+vector. Then we can call push on the mutable reference to the vector to keep
+track of the messages sent during the test.
+
The last change we have to make is in the assertion: to see how many items are
+in the inner vector, we call borrow on the RefCell<Vec<String>> to get an
+immutable reference to the vector.
+
Now that you’ve seen how to use RefCell<T>, let’s dig into how it works!
When creating immutable and mutable references, we use the & and &mut
+syntax, respectively. With RefCell<T>, we use the borrow and borrow_mut
+methods, which are part of the safe API that belongs to RefCell<T>. The
+borrow method returns the smart pointer type Ref<T>, and borrow_mut
+returns the smart pointer type RefMut<T>. Both types implement Deref, so we
+can treat them like regular references.
+
The RefCell<T> keeps track of how many Ref<T> and RefMut<T> smart
+pointers are currently active. Every time we call borrow, the RefCell<T>
+increases its count of how many immutable borrows are active. When a Ref<T>
+value goes out of scope, the count of immutable borrows goes down by one. Just
+like the compile-time borrowing rules, RefCell<T> lets us have many immutable
+borrows or one mutable borrow at any point in time.
+
If we try to violate these rules, rather than getting a compiler error as we
+would with references, the implementation of RefCell<T> will panic at
+runtime. Listing 15-23 shows a modification of the implementation of send in
+Listing 15-22. We’re deliberately trying to create two mutable borrows active
+for the same scope to illustrate that RefCell<T> prevents us from doing this
+at runtime.
+
Filename: src/lib.rs
+
pub trait Messenger {
+ fn send(&self, msg: &str);
+}
+
+pub struct LimitTracker<'a, T: Messenger> {
+ messenger: &'a T,
+ value: usize,
+ max: usize,
+}
+
+impl<'a, T> LimitTracker<'a, T>
+where
+ T: Messenger,
+{
+ pub fn new(messenger: &'a T, max: usize) -> LimitTracker<'a, T> {
+ LimitTracker {
+ messenger,
+ value: 0,
+ max,
+ }
+ }
+
+ pub fn set_value(&mut self, value: usize) {
+ self.value = value;
+
+ let percentage_of_max = self.value as f64 / self.max as f64;
+
+ if percentage_of_max >= 1.0 {
+ self.messenger.send("Error: You are over your quota!");
+ } else if percentage_of_max >= 0.9 {
+ self.messenger
+ .send("Urgent warning: You've used up over 90% of your quota!");
+ } else if percentage_of_max >= 0.75 {
+ self.messenger
+ .send("Warning: You've used up over 75% of your quota!");
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::cell::RefCell;
+
+ struct MockMessenger {
+ sent_messages: RefCell<Vec<String>>,
+ }
+
+ impl MockMessenger {
+ fn new() -> MockMessenger {
+ MockMessenger {
+ sent_messages: RefCell::new(vec![]),
+ }
+ }
+ }
+
+ impl Messenger for MockMessenger {
+ fn send(&self, message: &str) {
+ let mut one_borrow = self.sent_messages.borrow_mut();
+ let mut two_borrow = self.sent_messages.borrow_mut();
+
+ one_borrow.push(String::from(message));
+ two_borrow.push(String::from(message));
+ }
+ }
+
+ #[test]
+ fn it_sends_an_over_75_percent_warning_message() {
+ let mock_messenger = MockMessenger::new();
+ let mut limit_tracker = LimitTracker::new(&mock_messenger, 100);
+
+ limit_tracker.set_value(80);
+
+ assert_eq!(mock_messenger.sent_messages.borrow().len(), 1);
+ }
+}
+
Listing 15-23: Creating two mutable references in the
+same scope to see that RefCell<T> will panic
+
We create a variable one_borrow for the RefMut<T> smart pointer returned
+from borrow_mut. Then we create another mutable borrow in the same way in the
+variable two_borrow. This makes two mutable references in the same scope,
+which isn’t allowed. When we run the tests for our library, the code in Listing
+15-23 will compile without any errors, but the test will fail:
+
$ cargo test
+ Compiling limit-tracker v0.1.0 (file:///projects/limit-tracker)
+ Finished `test` profile [unoptimized + debuginfo] target(s) in 0.91s
+ Running unittests src/lib.rs (target/debug/deps/limit_tracker-e599811fa246dbde)
+
+running 1 test
+test tests::it_sends_an_over_75_percent_warning_message ... FAILED
+
+failures:
+
+---- tests::it_sends_an_over_75_percent_warning_message stdout ----
+thread 'tests::it_sends_an_over_75_percent_warning_message' panicked at src/lib.rs:60:53:
+already borrowed: BorrowMutError
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
+
+
+failures:
+ tests::it_sends_an_over_75_percent_warning_message
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
+
+error: test failed, to rerun pass `--lib`
+
+
Notice that the code panicked with the message already borrowed: BorrowMutError. This is how RefCell<T> handles violations of the borrowing
+rules at runtime.
+
Choosing to catch borrowing errors at runtime rather than compile time, as
+we’ve done here, means you’d potentially be finding mistakes in your code later
+in the development process: possibly not until your code was deployed to
+production. Also, your code would incur a small runtime performance penalty as
+a result of keeping track of the borrows at runtime rather than compile time.
+However, using RefCell<T> makes it possible to write a mock object that can
+modify itself to keep track of the messages it has seen while you’re using it
+in a context where only immutable values are allowed. You can use RefCell<T>
+despite its trade-offs to get more functionality than regular references
+provide.
A common way to use RefCell<T> is in combination with Rc<T>. Recall that
+Rc<T> lets you have multiple owners of some data, but it only gives immutable
+access to that data. If you have an Rc<T> that holds a RefCell<T>, you can
+get a value that can have multiple owners and that you can mutate!
+
For example, recall the cons list example in Listing 15-18 where we used
+Rc<T> to allow multiple lists to share ownership of another list. Because
+Rc<T> holds only immutable values, we can’t change any of the values in the
+list once we’ve created them. Let’s add in RefCell<T> to gain the ability to
+change the values in the lists. Listing 15-24 shows that by using a
+RefCell<T> in the Cons definition, we can modify the value stored in all
+the lists:
+
Filename: src/main.rs
+
#[derive(Debug)]
+enum List {
+ Cons(Rc<RefCell<i32>>, Rc<List>),
+ Nil,
+}
+
+use crate::List::{Cons, Nil};
+use std::cell::RefCell;
+use std::rc::Rc;
+
+fn main() {
+ let value = Rc::new(RefCell::new(5));
+
+ let a = Rc::new(Cons(Rc::clone(&value), Rc::new(Nil)));
+
+ let b = Cons(Rc::new(RefCell::new(3)), Rc::clone(&a));
+ let c = Cons(Rc::new(RefCell::new(4)), Rc::clone(&a));
+
+ *value.borrow_mut() += 10;
+
+ println!("a after = {a:?}");
+ println!("b after = {b:?}");
+ println!("c after = {c:?}");
+}
+
Listing 15-24: Using Rc<RefCell<i32>> to create a
+List that we can mutate
+
We create a value that is an instance of Rc<RefCell<i32>> and store it in a
+variable named value so we can access it directly later. Then we create a
+List in a with a Cons variant that holds value. We need to clone
+value so both a and value have ownership of the inner 5 value rather
+than transferring ownership from value to a or having a borrow from
+value.
+
We wrap the list a in an Rc<T> so when we create lists b and c, they
+can both refer to a, which is what we did in Listing 15-18.
+
After we’ve created the lists in a, b, and c, we want to add 10 to the
+value in value. We do this by calling borrow_mut on value, which uses the
+automatic dereferencing feature we discussed in Chapter 5 (see the section
+“Where’s the -> Operator?”) to
+dereference the Rc<T> to the inner RefCell<T> value. The borrow_mut
+method returns a RefMut<T> smart pointer, and we use the dereference operator
+on it and change the inner value.
+
When we print a, b, and c, we can see that they all have the modified
+value of 15 rather than 5:
This technique is pretty neat! By using RefCell<T>, we have an outwardly
+immutable List value. But we can use the methods on RefCell<T> that provide
+access to its interior mutability so we can modify our data when we need to.
+The runtime checks of the borrowing rules protect us from data races, and it’s
+sometimes worth trading a bit of speed for this flexibility in our data
+structures. Note that RefCell<T> does not work for multithreaded code!
+Mutex<T> is the thread-safe version of RefCell<T> and we’ll discuss
+Mutex<T> in Chapter 16.
Rust’s memory safety guarantees make it difficult, but not impossible, to
+accidentally create memory that is never cleaned up (known as a memory leak).
+Preventing memory leaks entirely is not one of Rust’s guarantees, meaning
+memory leaks are memory safe in Rust. We can see that Rust allows memory leaks
+by using Rc<T> and RefCell<T>: it’s possible to create references where
+items refer to each other in a cycle. This creates memory leaks because the
+reference count of each item in the cycle will never reach 0, and the values
+will never be dropped.
Let’s look at how a reference cycle might happen and how to prevent it,
+starting with the definition of the List enum and a tail method in Listing
+15-25:
Listing 15-25: A cons list definition that holds a
+RefCell<T> so we can modify what a Cons variant is referring to
+
We’re using another variation of the List definition from Listing 15-5. The
+second element in the Cons variant is now RefCell<Rc<List>>, meaning that
+instead of having the ability to modify the i32 value as we did in Listing
+15-24, we want to modify the List value a Cons variant is pointing to.
+We’re also adding a tail method to make it convenient for us to access the
+second item if we have a Cons variant.
+
In Listing 15-26, we’re adding a main function that uses the definitions in
+Listing 15-25. This code creates a list in a and a list in b that points to
+the list in a. Then it modifies the list in a to point to b, creating a
+reference cycle. There are println! statements along the way to show what the
+reference counts are at various points in this process.
+
Filename: src/main.rs
+
use crate::List::{Cons, Nil};
+use std::cell::RefCell;
+use std::rc::Rc;
+
+#[derive(Debug)]
+enum List {
+ Cons(i32, RefCell<Rc<List>>),
+ Nil,
+}
+
+impl List {
+ fn tail(&self) -> Option<&RefCell<Rc<List>>> {
+ match self {
+ Cons(_, item) => Some(item),
+ Nil => None,
+ }
+ }
+}
+
+fn main() {
+ let a = Rc::new(Cons(5, RefCell::new(Rc::new(Nil))));
+
+ println!("a initial rc count = {}", Rc::strong_count(&a));
+ println!("a next item = {:?}", a.tail());
+
+ let b = Rc::new(Cons(10, RefCell::new(Rc::clone(&a))));
+
+ println!("a rc count after b creation = {}", Rc::strong_count(&a));
+ println!("b initial rc count = {}", Rc::strong_count(&b));
+ println!("b next item = {:?}", b.tail());
+
+ if let Some(link) = a.tail() {
+ *link.borrow_mut() = Rc::clone(&b);
+ }
+
+ println!("b rc count after changing a = {}", Rc::strong_count(&b));
+ println!("a rc count after changing a = {}", Rc::strong_count(&a));
+
+ // Uncomment the next line to see that we have a cycle;
+ // it will overflow the stack
+ // println!("a next item = {:?}", a.tail());
+}
+
Listing 15-26: Creating a reference cycle of two List
+values pointing to each other
+
We create an Rc<List> instance holding a List value in the variable a
+with an initial list of 5, Nil. We then create an Rc<List> instance holding
+another List value in the variable b that contains the value 10 and points
+to the list in a.
+
We modify a so it points to b instead of Nil, creating a cycle. We do
+that by using the tail method to get a reference to the RefCell<Rc<List>>
+in a, which we put in the variable link. Then we use the borrow_mut
+method on the RefCell<Rc<List>> to change the value inside from an Rc<List>
+that holds a Nil value to the Rc<List> in b.
+
When we run this code, keeping the last println! commented out for the
+moment, we’ll get this output:
+
$ cargo run
+ Compiling cons-list v0.1.0 (file:///projects/cons-list)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.53s
+ Running `target/debug/cons-list`
+a initial rc count = 1
+a next item = Some(RefCell { value: Nil })
+a rc count after b creation = 2
+b initial rc count = 1
+b next item = Some(RefCell { value: Cons(5, RefCell { value: Nil }) })
+b rc count after changing a = 2
+a rc count after changing a = 2
+
+
The reference count of the Rc<List> instances in both a and b are 2 after
+we change the list in a to point to b. At the end of main, Rust drops the
+variable b, which decreases the reference count of the bRc<List> instance
+from 2 to 1. The memory that Rc<List> has on the heap won’t be dropped at
+this point, because its reference count is 1, not 0. Then Rust drops a, which
+decreases the reference count of the aRc<List> instance from 2 to 1 as
+well. This instance’s memory can’t be dropped either, because the other
+Rc<List> instance still refers to it. The memory allocated to the list will
+remain uncollected forever. To visualize this reference cycle, we’ve created a
+diagram in Figure 15-4.
+
+
Figure 15-4: A reference cycle of lists a and b
+pointing to each other
+
If you uncomment the last println! and run the program, Rust will try to
+print this cycle with a pointing to b pointing to a and so forth until it
+overflows the stack.
+
Compared to a real-world program, the consequences of creating a reference cycle
+in this example aren’t very dire: right after we create the reference cycle,
+the program ends. However, if a more complex program allocated lots of memory
+in a cycle and held onto it for a long time, the program would use more memory
+than it needed and might overwhelm the system, causing it to run out of
+available memory.
+
Creating reference cycles is not easily done, but it’s not impossible either.
+If you have RefCell<T> values that contain Rc<T> values or similar nested
+combinations of types with interior mutability and reference counting, you must
+ensure that you don’t create cycles; you can’t rely on Rust to catch them.
+Creating a reference cycle would be a logic bug in your program that you should
+use automated tests, code reviews, and other software development practices to
+minimize.
+
Another solution for avoiding reference cycles is reorganizing your data
+structures so that some references express ownership and some references don’t.
+As a result, you can have cycles made up of some ownership relationships and
+some non-ownership relationships, and only the ownership relationships affect
+whether or not a value can be dropped. In Listing 15-25, we always want Cons
+variants to own their list, so reorganizing the data structure isn’t possible.
+Let’s look at an example using graphs made up of parent nodes and child nodes
+to see when non-ownership relationships are an appropriate way to prevent
+reference cycles.
So far, we’ve demonstrated that calling Rc::clone increases the
+strong_count of an Rc<T> instance, and an Rc<T> instance is only cleaned
+up if its strong_count is 0. You can also create a weak reference to the
+value within an Rc<T> instance by calling Rc::downgrade and passing a
+reference to the Rc<T>. Strong references are how you can share ownership of
+an Rc<T> instance. Weak references don’t express an ownership relationship,
+and their count doesn’t affect when an Rc<T> instance is cleaned up. They
+won’t cause a reference cycle because any cycle involving some weak references
+will be broken once the strong reference count of values involved is 0.
+
When you call Rc::downgrade, you get a smart pointer of type Weak<T>.
+Instead of increasing the strong_count in the Rc<T> instance by 1, calling
+Rc::downgrade increases the weak_count by 1. The Rc<T> type uses
+weak_count to keep track of how many Weak<T> references exist, similar to
+strong_count. The difference is the weak_count doesn’t need to be 0 for the
+Rc<T> instance to be cleaned up.
+
Because the value that Weak<T> references might have been dropped, to do
+anything with the value that a Weak<T> is pointing to, you must make sure the
+value still exists. Do this by calling the upgrade method on a Weak<T>
+instance, which will return an Option<Rc<T>>. You’ll get a result of Some
+if the Rc<T> value has not been dropped yet and a result of None if the
+Rc<T> value has been dropped. Because upgrade returns an Option<Rc<T>>,
+Rust will ensure that the Some case and the None case are handled, and
+there won’t be an invalid pointer.
+
As an example, rather than using a list whose items know only about the next
+item, we’ll create a tree whose items know about their children items and
+their parent items.
To start, we’ll build a tree with nodes that know about their child nodes.
+We’ll create a struct named Node that holds its own i32 value as well as
+references to its children Node values:
We want a Node to own its children, and we want to share that ownership with
+variables so we can access each Node in the tree directly. To do this, we
+define the Vec<T> items to be values of type Rc<Node>. We also want to
+modify which nodes are children of another node, so we have a RefCell<T> in
+children around the Vec<Rc<Node>>.
+
Next, we’ll use our struct definition and create one Node instance named
+leaf with the value 3 and no children, and another instance named branch
+with the value 5 and leaf as one of its children, as shown in Listing 15-27:
Listing 15-27: Creating a leaf node with no children
+and a branch node with leaf as one of its children
+
We clone the Rc<Node> in leaf and store that in branch, meaning the
+Node in leaf now has two owners: leaf and branch. We can get from
+branch to leaf through branch.children, but there’s no way to get from
+leaf to branch. The reason is that leaf has no reference to branch and
+doesn’t know they’re related. We want leaf to know that branch is its
+parent. We’ll do that next.
To make the child node aware of its parent, we need to add a parent field to
+our Node struct definition. The trouble is in deciding what the type of
+parent should be. We know it can’t contain an Rc<T>, because that would
+create a reference cycle with leaf.parent pointing to branch and
+branch.children pointing to leaf, which would cause their strong_count
+values to never be 0.
+
Thinking about the relationships another way, a parent node should own its
+children: if a parent node is dropped, its child nodes should be dropped as
+well. However, a child should not own its parent: if we drop a child node, the
+parent should still exist. This is a case for weak references!
+
So instead of Rc<T>, we’ll make the type of parent use Weak<T>,
+specifically a RefCell<Weak<Node>>. Now our Node struct definition looks
+like this:
A node will be able to refer to its parent node but doesn’t own its parent.
+In Listing 15-28, we update main to use this new definition so the leaf
+node will have a way to refer to its parent, branch:
Listing 15-28: A leaf node with a weak reference to its
+parent node branch
+
Creating the leaf node looks similar to Listing 15-27 with the exception of
+the parent field: leaf starts out without a parent, so we create a new,
+empty Weak<Node> reference instance.
+
At this point, when we try to get a reference to the parent of leaf by using
+the upgrade method, we get a None value. We see this in the output from the
+first println! statement:
+
leaf parent = None
+
+
When we create the branch node, it will also have a new Weak<Node>
+reference in the parent field, because branch doesn’t have a parent node.
+We still have leaf as one of the children of branch. Once we have the
+Node instance in branch, we can modify leaf to give it a Weak<Node>
+reference to its parent. We use the borrow_mut method on the
+RefCell<Weak<Node>> in the parent field of leaf, and then we use the
+Rc::downgrade function to create a Weak<Node> reference to branch from
+the Rc<Node> in branch.
+
When we print the parent of leaf again, this time we’ll get a Some variant
+holding branch: now leaf can access its parent! When we print leaf, we
+also avoid the cycle that eventually ended in a stack overflow like we had in
+Listing 15-26; the Weak<Node> references are printed as (Weak):
The lack of infinite output indicates that this code didn’t create a reference
+cycle. We can also tell this by looking at the values we get from calling
+Rc::strong_count and Rc::weak_count.
Let’s look at how the strong_count and weak_count values of the Rc<Node>
+instances change by creating a new inner scope and moving the creation of
+branch into that scope. By doing so, we can see what happens when branch is
+created and then dropped when it goes out of scope. The modifications are shown
+in Listing 15-29:
Listing 15-29: Creating branch in an inner scope and
+examining strong and weak reference counts
+
After leaf is created, its Rc<Node> has a strong count of 1 and a weak
+count of 0. In the inner scope, we create branch and associate it with
+leaf, at which point when we print the counts, the Rc<Node> in branch
+will have a strong count of 1 and a weak count of 1 (for leaf.parent pointing
+to branch with a Weak<Node>). When we print the counts in leaf, we’ll see
+it will have a strong count of 2, because branch now has a clone of the
+Rc<Node> of leaf stored in branch.children, but will still have a weak
+count of 0.
+
When the inner scope ends, branch goes out of scope and the strong count of
+the Rc<Node> decreases to 0, so its Node is dropped. The weak count of 1
+from leaf.parent has no bearing on whether or not Node is dropped, so we
+don’t get any memory leaks!
+
If we try to access the parent of leaf after the end of the scope, we’ll get
+None again. At the end of the program, the Rc<Node> in leaf has a strong
+count of 1 and a weak count of 0, because the variable leaf is now the only
+reference to the Rc<Node> again.
+
All of the logic that manages the counts and value dropping is built into
+Rc<T> and Weak<T> and their implementations of the Drop trait. By
+specifying that the relationship from a child to its parent should be a
+Weak<T> reference in the definition of Node, you’re able to have parent
+nodes point to child nodes and vice versa without creating a reference cycle
+and memory leaks.
This chapter covered how to use smart pointers to make different guarantees and
+trade-offs from those Rust makes by default with regular references. The
+Box<T> type has a known size and points to data allocated on the heap. The
+Rc<T> type keeps track of the number of references to data on the heap so
+that data can have multiple owners. The RefCell<T> type with its interior
+mutability gives us a type that we can use when we need an immutable type but
+need to change an inner value of that type; it also enforces the borrowing
+rules at runtime instead of at compile time.
+
Also discussed were the Deref and Drop traits, which enable a lot of the
+functionality of smart pointers. We explored reference cycles that can cause
+memory leaks and how to prevent them using Weak<T>.
+
If this chapter has piqued your interest and you want to implement your own
+smart pointers, check out “The Rustonomicon” for more useful
+information.
+
Next, we’ll talk about concurrency in Rust. You’ll even learn about a few new
+smart pointers.
Handling concurrent programming safely and efficiently is another of Rust’s
+major goals. Concurrent programming, where different parts of a program
+execute independently, and parallel programming, where different parts of a
+program execute at the same time, are becoming increasingly important as more
+computers take advantage of their multiple processors. Historically,
+programming in these contexts has been difficult and error prone: Rust hopes to
+change that.
+
Initially, the Rust team thought that ensuring memory safety and preventing
+concurrency problems were two separate challenges to be solved with different
+methods. Over time, the team discovered that the ownership and type systems are
+a powerful set of tools to help manage memory safety and concurrency
+problems! By leveraging ownership and type checking, many concurrency errors
+are compile-time errors in Rust rather than runtime errors. Therefore, rather
+than making you spend lots of time trying to reproduce the exact circumstances
+under which a runtime concurrency bug occurs, incorrect code will refuse to
+compile and present an error explaining the problem. As a result, you can fix
+your code while you’re working on it rather than potentially after it has been
+shipped to production. We’ve nicknamed this aspect of Rust fearless
+concurrency. Fearless concurrency allows you to write code that is free of
+subtle bugs and is easy to refactor without introducing new bugs.
+
+
Note: For simplicity’s sake, we’ll refer to many of the problems as
+concurrent rather than being more precise by saying concurrent and/or
+parallel. If this book were about concurrency and/or parallelism, we’d be
+more specific. For this chapter, please mentally substitute concurrent
+and/or parallel whenever we use concurrent.
+
+
Many languages are dogmatic about the solutions they offer for handling
+concurrent problems. For example, Erlang has elegant functionality for
+message-passing concurrency but has only obscure ways to share state between
+threads. Supporting only a subset of possible solutions is a reasonable
+strategy for higher-level languages, because a higher-level language promises
+benefits from giving up some control to gain abstractions. However, lower-level
+languages are expected to provide the solution with the best performance in any
+given situation and have fewer abstractions over the hardware. Therefore, Rust
+offers a variety of tools for modeling problems in whatever way is appropriate
+for your situation and requirements.
+
Here are the topics we’ll cover in this chapter:
+
+
How to create threads to run multiple pieces of code at the same time
+
Message-passing concurrency, where channels send messages between threads
+
Shared-state concurrency, where multiple threads have access to some piece
+of data
+
The Sync and Send traits, which extend Rust’s concurrency guarantees to
+user-defined types as well as types provided by the standard library
In most current operating systems, an executed program’s code is run in a
+process, and the operating system will manage multiple processes at once.
+Within a program, you can also have independent parts that run simultaneously.
+The features that run these independent parts are called threads. For
+example, a web server could have multiple threads so that it could respond to
+more than one request at the same time.
+
Splitting the computation in your program into multiple threads to run multiple
+tasks at the same time can improve performance, but it also adds complexity.
+Because threads can run simultaneously, there’s no inherent guarantee about the
+order in which parts of your code on different threads will run. This can lead
+to problems, such as:
+
+
Race conditions, where threads are accessing data or resources in an
+inconsistent order
+
Deadlocks, where two threads are waiting for each other, preventing both
+threads from continuing
+
Bugs that happen only in certain situations and are hard to reproduce and fix
+reliably
+
+
Rust attempts to mitigate the negative effects of using threads, but
+programming in a multithreaded context still takes careful thought and requires
+a code structure that is different from that in programs running in a single
+thread.
+
Programming languages implement threads in a few different ways, and many
+operating systems provide an API the language can call for creating new threads.
+The Rust standard library uses a 1:1 model of thread implementation, whereby a
+program uses one operating system thread per one language thread. There are
+crates that implement other models of threading that make different tradeoffs to
+the 1:1 model. (Rust’s async system, which we will see in the next chapter,
+provides another approach to concurrency as well.)
To create a new thread, we call the thread::spawn function and pass it a
+closure (we talked about closures in Chapter 13) containing the code we want to
+run in the new thread. The example in Listing 16-1 prints some text from a main
+thread and other text from a new thread:
+
Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn main() {
+ thread::spawn(|| {
+ for i in 1..10 {
+ println!("hi number {i} from the spawned thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the main thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+}
+
Listing 16-1: Creating a new thread to print one thing
+while the main thread prints something else
+
Note that when the main thread of a Rust program completes, all spawned threads
+are shut down, whether or not they have finished running. The output from this
+program might be a little different every time, but it will look similar to the
+following:
+
+
hi number 1 from the main thread!
+hi number 1 from the spawned thread!
+hi number 2 from the main thread!
+hi number 2 from the spawned thread!
+hi number 3 from the main thread!
+hi number 3 from the spawned thread!
+hi number 4 from the main thread!
+hi number 4 from the spawned thread!
+hi number 5 from the spawned thread!
+
+
The calls to thread::sleep force a thread to stop its execution for a short
+duration, allowing a different thread to run. The threads will probably take
+turns, but that isn’t guaranteed: it depends on how your operating system
+schedules the threads. In this run, the main thread printed first, even though
+the print statement from the spawned thread appears first in the code. And even
+though we told the spawned thread to print until i is 9, it only got to 5
+before the main thread shut down.
+
If you run this code and only see output from the main thread, or don’t see any
+overlap, try increasing the numbers in the ranges to create more opportunities
+for the operating system to switch between the threads.
The code in Listing 16-1 not only stops the spawned thread prematurely most of
+the time due to the main thread ending, but because there is no guarantee on
+the order in which threads run, we also can’t guarantee that the spawned thread
+will get to run at all!
+
We can fix the problem of the spawned thread not running or ending prematurely
+by saving the return value of thread::spawn in a variable. The return type of
+thread::spawn is JoinHandle. A JoinHandle is an owned value that, when we
+call the join method on it, will wait for its thread to finish. Listing 16-2
+shows how to use the JoinHandle of the thread we created in Listing 16-1 and
+call join to make sure the spawned thread finishes before main exits:
+
Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn main() {
+ let handle = thread::spawn(|| {
+ for i in 1..10 {
+ println!("hi number {i} from the spawned thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the main thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+
+ handle.join().unwrap();
+}
+
Listing 16-2: Saving a JoinHandle from thread::spawn
+to guarantee the thread is run to completion
+
Calling join on the handle blocks the thread currently running until the
+thread represented by the handle terminates. Blocking a thread means that
+thread is prevented from performing work or exiting. Because we’ve put the call
+to join after the main thread’s for loop, running Listing 16-2 should
+produce output similar to this:
+
+
hi number 1 from the main thread!
+hi number 2 from the main thread!
+hi number 1 from the spawned thread!
+hi number 3 from the main thread!
+hi number 2 from the spawned thread!
+hi number 4 from the main thread!
+hi number 3 from the spawned thread!
+hi number 4 from the spawned thread!
+hi number 5 from the spawned thread!
+hi number 6 from the spawned thread!
+hi number 7 from the spawned thread!
+hi number 8 from the spawned thread!
+hi number 9 from the spawned thread!
+
+
The two threads continue alternating, but the main thread waits because of the
+call to handle.join() and does not end until the spawned thread is finished.
+
But let’s see what happens when we instead move handle.join() before the
+for loop in main, like this:
+
Filename: src/main.rs
+
use std::thread;
+use std::time::Duration;
+
+fn main() {
+ let handle = thread::spawn(|| {
+ for i in 1..10 {
+ println!("hi number {i} from the spawned thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+ });
+
+ handle.join().unwrap();
+
+ for i in 1..5 {
+ println!("hi number {i} from the main thread!");
+ thread::sleep(Duration::from_millis(1));
+ }
+}
+
The main thread will wait for the spawned thread to finish and then run its
+for loop, so the output won’t be interleaved anymore, as shown here:
+
+
hi number 1 from the spawned thread!
+hi number 2 from the spawned thread!
+hi number 3 from the spawned thread!
+hi number 4 from the spawned thread!
+hi number 5 from the spawned thread!
+hi number 6 from the spawned thread!
+hi number 7 from the spawned thread!
+hi number 8 from the spawned thread!
+hi number 9 from the spawned thread!
+hi number 1 from the main thread!
+hi number 2 from the main thread!
+hi number 3 from the main thread!
+hi number 4 from the main thread!
+
+
Small details, such as where join is called, can affect whether or not your
+threads run at the same time.
We’ll often use the move keyword with closures passed to thread::spawn
+because the closure will then take ownership of the values it uses from the
+environment, thus transferring ownership of those values from one thread to
+another. In the “Capturing References or Moving Ownership” section of Chapter 13, we discussed move in the context of closures. Now,
+we’ll concentrate more on the interaction between move and thread::spawn.
+
Notice in Listing 16-1 that the closure we pass to thread::spawn takes no
+arguments: we’re not using any data from the main thread in the spawned
+thread’s code. To use data from the main thread in the spawned thread, the
+spawned thread’s closure must capture the values it needs. Listing 16-3 shows
+an attempt to create a vector in the main thread and use it in the spawned
+thread. However, this won’t yet work, as you’ll see in a moment.
+
Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let v = vec![1, 2, 3];
+
+ let handle = thread::spawn(|| {
+ println!("Here's a vector: {v:?}");
+ });
+
+ handle.join().unwrap();
+}
+
Listing 16-3: Attempting to use a vector created by the
+main thread in another thread
+
The closure uses v, so it will capture v and make it part of the closure’s
+environment. Because thread::spawn runs this closure in a new thread, we
+should be able to access v inside that new thread. But when we compile this
+example, we get the following error:
+
$ cargo run
+ Compiling threads v0.1.0 (file:///projects/threads)
+error[E0373]: closure may outlive the current function, but it borrows `v`, which is owned by the current function
+ --> src/main.rs:6:32
+ |
+6 | let handle = thread::spawn(|| {
+ | ^^ may outlive borrowed value `v`
+7 | println!("Here's a vector: {v:?}");
+ | - `v` is borrowed here
+ |
+note: function requires argument type to outlive `'static`
+ --> src/main.rs:6:18
+ |
+6 | let handle = thread::spawn(|| {
+ | __________________^
+7 | | println!("Here's a vector: {v:?}");
+8 | | });
+ | |______^
+help: to force the closure to take ownership of `v` (and any other referenced variables), use the `move` keyword
+ |
+6 | let handle = thread::spawn(move || {
+ | ++++
+
+For more information about this error, try `rustc --explain E0373`.
+error: could not compile `threads` (bin "threads") due to 1 previous error
+
+
Rust infers how to capture v, and because println! only needs a reference
+to v, the closure tries to borrow v. However, there’s a problem: Rust can’t
+tell how long the spawned thread will run, so it doesn’t know if the reference
+to v will always be valid.
+
Listing 16-4 provides a scenario that’s more likely to have a reference to v
+that won’t be valid:
+
Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let v = vec![1, 2, 3];
+
+ let handle = thread::spawn(|| {
+ println!("Here's a vector: {v:?}");
+ });
+
+ drop(v); // oh no!
+
+ handle.join().unwrap();
+}
+
Listing 16-4: A thread with a closure that attempts to
+capture a reference to v from a main thread that drops v
+
If Rust allowed us to run this code, there’s a possibility the spawned thread
+would be immediately put in the background without running at all. The spawned
+thread has a reference to v inside, but the main thread immediately drops
+v, using the drop function we discussed in Chapter 15. Then, when the
+spawned thread starts to execute, v is no longer valid, so a reference to it
+is also invalid. Oh no!
+
To fix the compiler error in Listing 16-3, we can use the error message’s
+advice:
+
+
help: to force the closure to take ownership of `v` (and any other referenced variables), use the `move` keyword
+ |
+6 | let handle = thread::spawn(move || {
+ | ++++
+
+
By adding the move keyword before the closure, we force the closure to take
+ownership of the values it’s using rather than allowing Rust to infer that it
+should borrow the values. The modification to Listing 16-3 shown in Listing
+16-5 will compile and run as we intend:
+
Filename: src/main.rs
+
use std::thread;
+
+fn main() {
+ let v = vec![1, 2, 3];
+
+ let handle = thread::spawn(move || {
+ println!("Here's a vector: {v:?}");
+ });
+
+ handle.join().unwrap();
+}
+
Listing 16-5: Using the move keyword to force a closure
+to take ownership of the values it uses
+
We might be tempted to try the same thing to fix the code in Listing 16-4 where
+the main thread called drop by using a move closure. However, this fix will
+not work because what Listing 16-4 is trying to do is disallowed for a
+different reason. If we added move to the closure, we would move v into the
+closure’s environment, and we could no longer call drop on it in the main
+thread. We would get this compiler error instead:
+
$ cargo run
+ Compiling threads v0.1.0 (file:///projects/threads)
+error[E0382]: use of moved value: `v`
+ --> src/main.rs:10:10
+ |
+4 | let v = vec![1, 2, 3];
+ | - move occurs because `v` has type `Vec<i32>`, which does not implement the `Copy` trait
+5 |
+6 | let handle = thread::spawn(move || {
+ | ------- value moved into closure here
+7 | println!("Here's a vector: {v:?}");
+ | - variable moved due to use in closure
+...
+10 | drop(v); // oh no!
+ | ^ value used here after move
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `threads` (bin "threads") due to 1 previous error
+
+
Rust’s ownership rules have saved us again! We got an error from the code in
+Listing 16-3 because Rust was being conservative and only borrowing v for the
+thread, which meant the main thread could theoretically invalidate the spawned
+thread’s reference. By telling Rust to move ownership of v to the spawned
+thread, we’re guaranteeing Rust that the main thread won’t use v anymore. If
+we change Listing 16-4 in the same way, we’re then violating the ownership
+rules when we try to use v in the main thread. The move keyword overrides
+Rust’s conservative default of borrowing; it doesn’t let us violate the
+ownership rules.
+
With a basic understanding of threads and the thread API, let’s look at what we
+can do with threads.
One increasingly popular approach to ensuring safe concurrency is message
+passing, where threads or actors communicate by sending each other messages
+containing data. Here’s the idea in a slogan from the Go language
+documentation:
+“Do not communicate by sharing memory; instead, share memory by communicating.”
+
To accomplish message-sending concurrency, Rust’s standard library provides an
+implementation of channels. A channel is a general programming concept by
+which data is sent from one thread to another.
+
You can imagine a channel in programming as being like a directional channel of
+water, such as a stream or a river. If you put something like a rubber duck
+into a river, it will travel downstream to the end of the waterway.
+
A channel has two halves: a transmitter and a receiver. The transmitter half is
+the upstream location where you put rubber ducks into the river, and the
+receiver half is where the rubber duck ends up downstream. One part of your
+code calls methods on the transmitter with the data you want to send, and
+another part checks the receiving end for arriving messages. A channel is said
+to be closed if either the transmitter or receiver half is dropped.
+
Here, we’ll work up to a program that has one thread to generate values and
+send them down a channel, and another thread that will receive the values and
+print them out. We’ll be sending simple values between threads using a channel
+to illustrate the feature. Once you’re familiar with the technique, you could
+use channels for any threads that need to communicate between each other, such
+as a chat system or a system where many threads perform parts of a calculation
+and send the parts to one thread that aggregates the results.
+
First, in Listing 16-6, we’ll create a channel but not do anything with it.
+Note that this won’t compile yet because Rust can’t tell what type of values we
+want to send over the channel.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+}
+
Listing 16-6: Creating a channel and assigning the two
+halves to tx and rx
+
We create a new channel using the mpsc::channel function; mpsc stands for
+multiple producer, single consumer. In short, the way Rust’s standard library
+implements channels means a channel can have multiple sending ends that
+produce values but only one receiving end that consumes those values. Imagine
+multiple streams flowing together into one big river: everything sent down any
+of the streams will end up in one river at the end. We’ll start with a single
+producer for now, but we’ll add multiple producers when we get this example
+working.
+
The mpsc::channel function returns a tuple, the first element of which is the
+sending end—the transmitter—and the second element is the receiving end—the
+receiver. The abbreviations tx and rx are traditionally used in many fields
+for transmitter and receiver respectively, so we name our variables as such
+to indicate each end. We’re using a let statement with a pattern that
+destructures the tuples; we’ll discuss the use of patterns in let statements
+and destructuring in Chapter 18. For now, know that using a let statement
+this way is a convenient approach to extract the pieces of the tuple returned
+by mpsc::channel.
+
Let’s move the transmitting end into a spawned thread and have it send one
+string so the spawned thread is communicating with the main thread, as shown in
+Listing 16-7. This is like putting a rubber duck in the river upstream or
+sending a chat message from one thread to another.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+ });
+}
+
Listing 16-7: Moving tx to a spawned thread and sending
+“hi”
+
Again, we’re using thread::spawn to create a new thread and then using move
+to move tx into the closure so the spawned thread owns tx. The spawned
+thread needs to own the transmitter to be able to send messages through the
+channel. The transmitter has a send method that takes the value we want to
+send. The send method returns a Result<T, E> type, so if the receiver has
+already been dropped and there’s nowhere to send a value, the send operation
+will return an error. In this example, we’re calling unwrap to panic in case
+of an error. But in a real application, we would handle it properly: return to
+Chapter 9 to review strategies for proper error handling.
+
In Listing 16-8, we’ll get the value from the receiver in the main thread. This
+is like retrieving the rubber duck from the water at the end of the river or
+receiving a chat message.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+ });
+
+ let received = rx.recv().unwrap();
+ println!("Got: {received}");
+}
+
Listing 16-8: Receiving the value “hi” in the main thread
+and printing it
+
The receiver has two useful methods: recv and try_recv. We’re using recv,
+short for receive, which will block the main thread’s execution and wait
+until a value is sent down the channel. Once a value is sent, recv will
+return it in a Result<T, E>. When the transmitter closes, recv will return
+an error to signal that no more values will be coming.
+
The try_recv method doesn’t block, but will instead return a Result<T, E>
+immediately: an Ok value holding a message if one is available and an Err
+value if there aren’t any messages this time. Using try_recv is useful if
+this thread has other work to do while waiting for messages: we could write a
+loop that calls try_recv every so often, handles a message if one is
+available, and otherwise does other work for a little while until checking
+again.
+
We’ve used recv in this example for simplicity; we don’t have any other work
+for the main thread to do other than wait for messages, so blocking the main
+thread is appropriate.
+
When we run the code in Listing 16-8, we’ll see the value printed from the main
+thread:
The ownership rules play a vital role in message sending because they help you
+write safe, concurrent code. Preventing errors in concurrent programming is the
+advantage of thinking about ownership throughout your Rust programs. Let’s do
+an experiment to show how channels and ownership work together to prevent
+problems: we’ll try to use a val value in the spawned thread after we’ve
+sent it down the channel. Try compiling the code in Listing 16-9 to see why
+this code isn’t allowed:
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+ println!("val is {val}");
+ });
+
+ let received = rx.recv().unwrap();
+ println!("Got: {received}");
+}
+
Listing 16-9: Attempting to use val after we’ve sent it
+down the channel
+
Here, we try to print val after we’ve sent it down the channel via tx.send.
+Allowing this would be a bad idea: once the value has been sent to another
+thread, that thread could modify or drop it before we try to use the value
+again. Potentially, the other thread’s modifications could cause errors or
+unexpected results due to inconsistent or nonexistent data. However, Rust gives
+us an error if we try to compile the code in Listing 16-9:
+
$ cargo run
+ Compiling message-passing v0.1.0 (file:///projects/message-passing)
+error[E0382]: borrow of moved value: `val`
+ --> src/main.rs:10:26
+ |
+8 | let val = String::from("hi");
+ | --- move occurs because `val` has type `String`, which does not implement the `Copy` trait
+9 | tx.send(val).unwrap();
+ | --- value moved here
+10 | println!("val is {val}");
+ | ^^^^^ value borrowed here after move
+ |
+ = note: this error originates in the macro `$crate::format_args_nl` which comes from the expansion of the macro `println` (in Nightly builds, run with -Z macro-backtrace for more info)
+help: consider cloning the value if the performance cost is acceptable
+ |
+9 | tx.send(val.clone()).unwrap();
+ | ++++++++
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `message-passing` (bin "message-passing") due to 1 previous error
+
+
Our concurrency mistake has caused a compile time error. The send function
+takes ownership of its parameter, and when the value is moved, the receiver
+takes ownership of it. This stops us from accidentally using the value again
+after sending it; the ownership system checks that everything is okay.
The code in Listing 16-8 compiled and ran, but it didn’t clearly show us that
+two separate threads were talking to each other over the channel. In Listing
+16-10 we’ve made some modifications that will prove the code in Listing 16-8 is
+running concurrently: the spawned thread will now send multiple messages and
+pause for a second between each message.
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+use std::time::Duration;
+
+fn main() {
+ let (tx, rx) = mpsc::channel();
+
+ thread::spawn(move || {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("thread"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ thread::sleep(Duration::from_secs(1));
+ }
+ });
+
+ for received in rx {
+ println!("Got: {received}");
+ }
+}
+
Listing 16-10: Sending multiple messages and pausing
+between each
+
This time, the spawned thread has a vector of strings that we want to send to
+the main thread. We iterate over them, sending each individually, and pause
+between each by calling the thread::sleep function with a Duration value of
+1 second.
+
In the main thread, we’re not calling the recv function explicitly anymore:
+instead, we’re treating rx as an iterator. For each value received, we’re
+printing it. When the channel is closed, iteration will end.
+
When running the code in Listing 16-10, you should see the following output
+with a 1-second pause in between each line:
+
+
Got: hi
+Got: from
+Got: the
+Got: thread
+
+
Because we don’t have any code that pauses or delays in the for loop in the
+main thread, we can tell that the main thread is waiting to receive values from
+the spawned thread.
Earlier we mentioned that mpsc was an acronym for multiple producer,
+single consumer. Let’s put mpsc to use and expand the code in Listing 16-10
+to create multiple threads that all send values to the same receiver. We can do
+so by cloning the transmitter, as shown in Listing 16-11:
+
Filename: src/main.rs
+
use std::sync::mpsc;
+use std::thread;
+use std::time::Duration;
+
+fn main() {
+ // --snip--
+
+ let (tx, rx) = mpsc::channel();
+
+ let tx1 = tx.clone();
+ thread::spawn(move || {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("thread"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ thread::sleep(Duration::from_secs(1));
+ }
+ });
+
+ thread::spawn(move || {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ thread::sleep(Duration::from_secs(1));
+ }
+ });
+
+ for received in rx {
+ println!("Got: {received}");
+ }
+
+ // --snip--
+}
+
Listing 16-11: Sending multiple messages from multiple
+producers
+
This time, before we create the first spawned thread, we call clone on the
+transmitter. This will give us a new transmitter we can pass to the first
+spawned thread. We pass the original transmitter to a second spawned thread.
+This gives us two threads, each sending different messages to the one receiver.
+
When you run the code, your output should look something like this:
+
+
Got: hi
+Got: more
+Got: from
+Got: messages
+Got: for
+Got: the
+Got: thread
+Got: you
+
+
You might see the values in another order, depending on your system. This is
+what makes concurrency interesting as well as difficult. If you experiment with
+thread::sleep, giving it various values in the different threads, each run
+will be more nondeterministic and create different output each time.
+
Now that we’ve looked at how channels work, let’s look at a different method of
+concurrency.
Message passing is a fine way of handling concurrency, but it’s not the only
+one. Another method would be for multiple threads to access the same shared
+data. Consider this part of the slogan from the Go language documentation
+again: “do not communicate by sharing memory.”
+
What would communicating by sharing memory look like? In addition, why would
+message-passing enthusiasts caution not to use memory sharing?
+
In a way, channels in any programming language are similar to single ownership,
+because once you transfer a value down a channel, you should no longer use that
+value. Shared memory concurrency is like multiple ownership: multiple threads
+can access the same memory location at the same time. As you saw in Chapter 15,
+where smart pointers made multiple ownership possible, multiple ownership can
+add complexity because these different owners need managing. Rust’s type system
+and ownership rules greatly assist in getting this management correct. For an
+example, let’s look at mutexes, one of the more common concurrency primitives
+for shared memory.
Mutex is an abbreviation for mutual exclusion, as in, a mutex allows only
+one thread to access some data at any given time. To access the data in a
+mutex, a thread must first signal that it wants access by asking to acquire the
+mutex’s lock. The lock is a data structure that is part of the mutex that
+keeps track of who currently has exclusive access to the data. Therefore, the
+mutex is described as guarding the data it holds via the locking system.
+
Mutexes have a reputation for being difficult to use because you have to
+remember two rules:
+
+
You must attempt to acquire the lock before using the data.
+
When you’re done with the data that the mutex guards, you must unlock the
+data so other threads can acquire the lock.
+
+
For a real-world metaphor for a mutex, imagine a panel discussion at a
+conference with only one microphone. Before a panelist can speak, they have to
+ask or signal that they want to use the microphone. When they get the
+microphone, they can talk for as long as they want to and then hand the
+microphone to the next panelist who requests to speak. If a panelist forgets to
+hand the microphone off when they’re finished with it, no one else is able to
+speak. If management of the shared microphone goes wrong, the panel won’t work
+as planned!
+
Management of mutexes can be incredibly tricky to get right, which is why so
+many people are enthusiastic about channels. However, thanks to Rust’s type
+system and ownership rules, you can’t get locking and unlocking wrong.
As an example of how to use a mutex, let’s start by using a mutex in a
+single-threaded context, as shown in Listing 16-12:
+
Filename: src/main.rs
+
use std::sync::Mutex;
+
+fn main() {
+ let m = Mutex::new(5);
+
+ {
+ let mut num = m.lock().unwrap();
+ *num = 6;
+ }
+
+ println!("m = {m:?}");
+}
+
Listing 16-12: Exploring the API of Mutex<T> in a
+single-threaded context for simplicity
+
As with many types, we create a Mutex<T> using the associated function new.
+To access the data inside the mutex, we use the lock method to acquire the
+lock. This call will block the current thread so it can’t do any work until
+it’s our turn to have the lock.
+
The call to lock would fail if another thread holding the lock panicked. In
+that case, no one would ever be able to get the lock, so we’ve chosen to
+unwrap and have this thread panic if we’re in that situation.
+
After we’ve acquired the lock, we can treat the return value, named num in
+this case, as a mutable reference to the data inside. The type system ensures
+that we acquire a lock before using the value in m. The type of m is
+Mutex<i32>, not i32, so we must call lock to be able to use the i32
+value. We can’t forget; the type system won’t let us access the inner i32
+otherwise.
+
As you might suspect, Mutex<T> is a smart pointer. More accurately, the call
+to lockreturns a smart pointer called MutexGuard, wrapped in a
+LockResult that we handled with the call to unwrap. The MutexGuard smart
+pointer implements Deref to point at our inner data; the smart pointer also
+has a Drop implementation that releases the lock automatically when a
+MutexGuard goes out of scope, which happens at the end of the inner scope. As
+a result, we don’t risk forgetting to release the lock and blocking the mutex
+from being used by other threads, because the lock release happens
+automatically.
+
After dropping the lock, we can print the mutex value and see that we were able
+to change the inner i32 to 6.
Now, let’s try to share a value between multiple threads using Mutex<T>.
+We’ll spin up 10 threads and have them each increment a counter value by 1, so
+the counter goes from 0 to 10. The next example in Listing 16-13 will have
+a compiler error, and we’ll use that error to learn more about using
+Mutex<T> and how Rust helps us use it correctly.
+
Filename: src/main.rs
+
use std::sync::Mutex;
+use std::thread;
+
+fn main() {
+ let counter = Mutex::new(0);
+ let mut handles = vec![];
+
+ for _ in 0..10 {
+ let handle = thread::spawn(move || {
+ let mut num = counter.lock().unwrap();
+
+ *num += 1;
+ });
+ handles.push(handle);
+ }
+
+ for handle in handles {
+ handle.join().unwrap();
+ }
+
+ println!("Result: {}", *counter.lock().unwrap());
+}
+
Listing 16-13: Ten threads each increment a counter
+guarded by a Mutex<T>
+
We create a counter variable to hold an i32 inside a Mutex<T>, as we did
+in Listing 16-12. Next, we create 10 threads by iterating over a range of
+numbers. We use thread::spawn and give all the threads the same closure: one
+that moves the counter into the thread, acquires a lock on the Mutex<T> by
+calling the lock method, and then adds 1 to the value in the mutex. When a
+thread finishes running its closure, num will go out of scope and release the
+lock so another thread can acquire it.
+
In the main thread, we collect all the join handles. Then, as we did in Listing
+16-2, we call join on each handle to make sure all the threads finish. At
+that point, the main thread will acquire the lock and print the result of this
+program.
+
We hinted that this example wouldn’t compile. Now let’s find out why!
+
$ cargo run
+ Compiling shared-state v0.1.0 (file:///projects/shared-state)
+error[E0382]: borrow of moved value: `counter`
+ --> src/main.rs:21:29
+ |
+5 | let counter = Mutex::new(0);
+ | ------- move occurs because `counter` has type `Mutex<i32>`, which does not implement the `Copy` trait
+...
+9 | let handle = thread::spawn(move || {
+ | ------- value moved into closure here, in previous iteration of loop
+...
+21 | println!("Result: {}", *counter.lock().unwrap());
+ | ^^^^^^^ value borrowed here after move
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `shared-state` (bin "shared-state") due to 1 previous error
+
+
The error message states that the counter value was moved in the previous
+iteration of the loop. Rust is telling us that we can’t move the ownership
+of counter into multiple threads. Let’s fix the compiler error with a
+multiple-ownership method we discussed in Chapter 15.
In Chapter 15, we gave a value multiple owners by using the smart pointer
+Rc<T> to create a reference counted value. Let’s do the same here and see
+what happens. We’ll wrap the Mutex<T> in Rc<T> in Listing 16-14 and clone
+the Rc<T> before moving ownership to the thread.
+
Filename: src/main.rs
+
use std::rc::Rc;
+use std::sync::Mutex;
+use std::thread;
+
+fn main() {
+ let counter = Rc::new(Mutex::new(0));
+ let mut handles = vec![];
+
+ for _ in 0..10 {
+ let counter = Rc::clone(&counter);
+ let handle = thread::spawn(move || {
+ let mut num = counter.lock().unwrap();
+
+ *num += 1;
+ });
+ handles.push(handle);
+ }
+
+ for handle in handles {
+ handle.join().unwrap();
+ }
+
+ println!("Result: {}", *counter.lock().unwrap());
+}
+
Listing 16-14: Attempting to use Rc<T> to allow
+multiple threads to own the Mutex<T>
+
Once again, we compile and get… different errors! The compiler is teaching us
+a lot.
+
$ cargo run
+ Compiling shared-state v0.1.0 (file:///projects/shared-state)
+error[E0277]: `Rc<Mutex<i32>>` cannot be sent between threads safely
+ --> src/main.rs:11:36
+ |
+11 | let handle = thread::spawn(move || {
+ | ------------- ^------
+ | | |
+ | ______________________|_____________within this `{closure@src/main.rs:11:36: 11:43}`
+ | | |
+ | | required by a bound introduced by this call
+12 | | let mut num = counter.lock().unwrap();
+13 | |
+14 | | *num += 1;
+15 | | });
+ | |_________^ `Rc<Mutex<i32>>` cannot be sent between threads safely
+ |
+ = help: within `{closure@src/main.rs:11:36: 11:43}`, the trait `Send` is not implemented for `Rc<Mutex<i32>>`, which is required by `{closure@src/main.rs:11:36: 11:43}: Send`
+note: required because it's used within this closure
+ --> src/main.rs:11:36
+ |
+11 | let handle = thread::spawn(move || {
+ | ^^^^^^^
+note: required by a bound in `spawn`
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/thread/mod.rs:677:1
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `shared-state` (bin "shared-state") due to 1 previous error
+
+
Wow, that error message is very wordy! Here’s the important part to focus on:
+`Rc<Mutex<i32>>` cannot be sent between threads safely. The compiler is
+also telling us the reason why: the trait `Send` is not implemented for `Rc<Mutex<i32>>` . We’ll talk about Send in the next section: it’s one of
+the traits that ensures the types we use with threads are meant for use in
+concurrent situations.
+
Unfortunately, Rc<T> is not safe to share across threads. When Rc<T>
+manages the reference count, it adds to the count for each call to clone and
+subtracts from the count when each clone is dropped. But it doesn’t use any
+concurrency primitives to make sure that changes to the count can’t be
+interrupted by another thread. This could lead to wrong counts—subtle bugs that
+could in turn lead to memory leaks or a value being dropped before we’re done
+with it. What we need is a type exactly like Rc<T> but one that makes changes
+to the reference count in a thread-safe way.
Fortunately, Arc<T>is a type like Rc<T> that is safe to use in
+concurrent situations. The a stands for atomic, meaning it’s an atomically
+reference counted type. Atomics are an additional kind of concurrency
+primitive that we won’t cover in detail here: see the standard library
+documentation for std::sync::atomic for more
+details. At this point, you just need to know that atomics work like primitive
+types but are safe to share across threads.
+
You might then wonder why all primitive types aren’t atomic and why standard
+library types aren’t implemented to use Arc<T> by default. The reason is that
+thread safety comes with a performance penalty that you only want to pay when
+you really need to. If you’re just performing operations on values within a
+single thread, your code can run faster if it doesn’t have to enforce the
+guarantees atomics provide.
+
Let’s return to our example: Arc<T> and Rc<T> have the same API, so we fix
+our program by changing the use line, the call to new, and the call to
+clone. The code in Listing 16-15 will finally compile and run:
+
Filename: src/main.rs
+
use std::sync::{Arc, Mutex};
+use std::thread;
+
+fn main() {
+ let counter = Arc::new(Mutex::new(0));
+ let mut handles = vec![];
+
+ for _ in 0..10 {
+ let counter = Arc::clone(&counter);
+ let handle = thread::spawn(move || {
+ let mut num = counter.lock().unwrap();
+
+ *num += 1;
+ });
+ handles.push(handle);
+ }
+
+ for handle in handles {
+ handle.join().unwrap();
+ }
+
+ println!("Result: {}", *counter.lock().unwrap());
+}
+
Listing 16-15: Using an Arc<T> to wrap the Mutex<T>
+to be able to share ownership across multiple threads
+
This code will print the following:
+
+
Result: 10
+
+
We did it! We counted from 0 to 10, which may not seem very impressive, but it
+did teach us a lot about Mutex<T> and thread safety. You could also use this
+program’s structure to do more complicated operations than just incrementing a
+counter. Using this strategy, you can divide a calculation into independent
+parts, split those parts across threads, and then use a Mutex<T> to have each
+thread update the final result with its part.
+
Note that if you are doing simple numerical operations, there are types simpler
+than Mutex<T> types provided by the std::sync::atomic module of the
+standard library. These types provide safe, concurrent,
+atomic access to primitive types. We chose to use Mutex<T> with a primitive
+type for this example so we could concentrate on how Mutex<T> works.
You might have noticed that counter is immutable but we could get a mutable
+reference to the value inside it; this means Mutex<T> provides interior
+mutability, as the Cell family does. In the same way we used RefCell<T> in
+Chapter 15 to allow us to mutate contents inside an Rc<T>, we use Mutex<T>
+to mutate contents inside an Arc<T>.
+
Another detail to note is that Rust can’t protect you from all kinds of logic
+errors when you use Mutex<T>. Recall in Chapter 15 that using Rc<T> came
+with the risk of creating reference cycles, where two Rc<T> values refer to
+each other, causing memory leaks. Similarly, Mutex<T> comes with the risk of
+creating deadlocks. These occur when an operation needs to lock two resources
+and two threads have each acquired one of the locks, causing them to wait for
+each other forever. If you’re interested in deadlocks, try creating a Rust
+program that has a deadlock; then research deadlock mitigation strategies for
+mutexes in any language and have a go at implementing them in Rust. The
+standard library API documentation for Mutex<T> and MutexGuard offers
+useful information.
+
We’ll round out this chapter by talking about the Send and Sync traits and
+how we can use them with custom types.
Interestingly, the Rust language has very few concurrency features. Almost
+every concurrency feature we’ve talked about so far in this chapter has been
+part of the standard library, not the language. Your options for handling
+concurrency are not limited to the language or the standard library; you can
+write your own concurrency features or use those written by others.
+
However, two concurrency concepts are embedded in the language: the
+std::marker traits Sync and Send.
The Send marker trait indicates that ownership of values of the type
+implementing Send can be transferred between threads. Almost every Rust type
+is Send, but there are some exceptions, including Rc<T>: this cannot be
+Send because if you cloned an Rc<T> value and tried to transfer ownership
+of the clone to another thread, both threads might update the reference count
+at the same time. For this reason, Rc<T> is implemented for use in
+single-threaded situations where you don’t want to pay the thread-safe
+performance penalty.
+
Therefore, Rust’s type system and trait bounds ensure that you can never
+accidentally send an Rc<T> value across threads unsafely. When we tried to do
+this in Listing 16-14, we got the error the trait Send is not implemented for Rc<Mutex<i32>>. When we switched to Arc<T>, which is Send, the code
+compiled.
+
Any type composed entirely of Send types is automatically marked as Send as
+well. Almost all primitive types are Send, aside from raw pointers, which
+we’ll discuss in Chapter 19.
The Sync marker trait indicates that it is safe for the type implementing
+Sync to be referenced from multiple threads. In other words, any type T is
+Sync if &T (an immutable reference to T) is Send, meaning the reference
+can be sent safely to another thread. Similar to Send, primitive types are
+Sync, and types composed entirely of types that are Sync are also Sync.
+
The smart pointer Rc<T> is also not Sync for the same reasons that it’s not
+Send. The RefCell<T> type (which we talked about in Chapter 15) and the
+family of related Cell<T> types are not Sync. The implementation of borrow
+checking that RefCell<T> does at runtime is not thread-safe. The smart
+pointer Mutex<T> is Sync and can be used to share access with multiple
+threads as you saw in the “Sharing a Mutex<T> Between Multiple
+Threads” section.
Because types that are made up of Send and Sync traits are automatically
+also Send and Sync, we don’t have to implement those traits manually. As
+marker traits, they don’t even have any methods to implement. They’re just
+useful for enforcing invariants related to concurrency.
+
Manually implementing these traits involves implementing unsafe Rust code.
+We’ll talk about using unsafe Rust code in Chapter 19; for now, the important
+information is that building new concurrent types not made up of Send and
+Sync parts requires careful thought to uphold the safety guarantees. “The
+Rustonomicon” has more information about these guarantees and how to
+uphold them.
This isn’t the last you’ll see of concurrency in this book: the project in
+Chapter 20 will use the concepts in this chapter in a more realistic situation
+than the smaller examples discussed here.
+
As mentioned earlier, because very little of how Rust handles concurrency is
+part of the language, many concurrency solutions are implemented as crates.
+These evolve more quickly than the standard library, so be sure to search
+online for the current, state-of-the-art crates to use in multithreaded
+situations.
+
The Rust standard library provides channels for message passing and smart
+pointer types, such as Mutex<T> and Arc<T>, that are safe to use in
+concurrent contexts. The type system and the borrow checker ensure that the
+code using these solutions won’t end up with data races or invalid references.
+Once you get your code to compile, you can rest assured that it will happily
+run on multiple threads without the kinds of hard-to-track-down bugs common in
+other languages. Concurrent programming is no longer a concept to be afraid of:
+go forth and make your programs concurrent, fearlessly!
+
Next, we’ll talk about idiomatic ways to model problems and structure solutions
+as your Rust programs get bigger. In addition, we’ll discuss how Rust’s idioms
+relate to those you might be familiar with from object-oriented programming.
In Chapter 16, we saw one of Rust’s approaches to concurrency: using threads.
+Since Rust 1.39, there has been another option for concurrency: asynchronous
+programming, or async.
+
In the rest of this chapter, we will:
+
+
see how to use Rust’s async and .await syntax
+
explore how to use the async model to solve some of the same challenges we
+looked at in Chapter 16
+
look at how multithreading and async provide complementary solutions, which
+you can even use together in many cases
Many operations we ask the computer to do can take a while to finish. For
+example, if you used a video editor to create a video of a family celebration,
+exporting it could take anywhere from minutes to hours. Similarly, when you
+download a video shared by someone in your family, that download process might
+take a long time. It would be nice if we could do something else while we are
+waiting for those long-running processes to complete.
+
The video export will use as much CPU and GPU power as it can. If you only had
+one CPU core, and your operating system never paused that export until it
+completed, you could not do anything else on your computer while it was running.
+That would be a pretty frustrating experience, though, so instead your computer
+can (and does!) invisibly interrupt the export often enough to let you get other
+small amounts of work done along the way.
+
The file download is different. It does not take up very much CPU time. Instead,
+you are mostly waiting on data to transfer across the network. You can start
+reading from a network socket, but it might take a while for all the data to
+arrive and be fed into the socket by the network controller. Moreover, even once
+the data has all arrived, videos can be quite large, so it might take some time
+to load all the data from the socket. Even if “some time” here is just a second
+or two, that is a very long time for a modern processor, which can do billions
+of operations every second. You could choose to wait for all of that to finish,
+but you might be waiting for a while… with your CPU doing not much! Thus, even
+if your specific program cannot do anything until it finishes reading data from
+a network socket, your computer will once again invisibly interrupt your
+program so other things can happen at the same time as the network operation.
+
+
Note: The video export is the kind of operation which is often described as
+“CPU-bound”. It is limited by the speed of the computer’s CPU (and GPU), and
+how much of that power it can use. The video download is the kind of operation
+which is often described as “IO-bound,” because it is limited by the speed of
+the computer’s input and output. It can only go as fast as the data can be
+sent across the network, which means that it can only go as fast as the data
+can be written to the socket by the network controller.
+
+
In both of these examples, the concurrency happens at the level of the whole
+program. The operating system decides to interrupt the program to let other
+programs get work done. In many cases, since we understand our programs at a
+much more granular level than the operating system does, we can lots of
+opportunities for concurrency that the operating system cannot see. For example,
+if we are building a tool to manage file downloads, it is important that the
+user interface stay responsive while a download is happening. In fact, we should
+even be able to start multiple downloads at the same time.
+
However, many operating system APIs for interacting with network sockets are
+blocking. That is, the function calls block further progress in the program
+when they are called until they return. This is how most function calls work,
+if you think about it! However, we normally reserve the term “blocking” for
+function calls which interact with files, network sockets, or other resources on
+the computer, because those are the places where an individual program would
+benefit from the operation being non-blocking.
+
When doing file downloads, we could use threads to work around the fact that the
+call to write to a network socket is blocking. If we move the data over to a
+dedicated thread which handles the write operation, it will not block the rest
+of the program. But in many ways, it would be nicer if the call were not
+blocking in the first place.
+
One way to accomplish that would be to use an API built around callbacks. For
+each blocking operation, we could pass in a function to call once the operation
+completes:
Or we could have our functions return a type with and_then method, which in
+turn accepts a callback which can do more work of the same sort (Historically,
+this was the way that Rust did async):
+
network_socket.read_non_blocking().and_then(|result| {
+ /* another non_blocking operation */
+});
+
Each of these can make the control flow for the program more complicated,
+though. You can end up with event handler callbacks scattered across the code
+base, or groups of deeply nested callbacks, or long chains of and_then calls.
+Understanding the flow of data through the program can become more difficult as
+a result, and dealing with callbacks can also complicate ownership.
+
There are also no particularly good ways to get data out of those callbacks.
+With other common types in Rust, we often use pattern-matching in scenarios like
+this. When we are using callbacks we do not yet have the data at the time we
+call read_non_blocking—and we will not have it until the callback gets called.
+That means that there is no way to match on the data it will return: it is not
+here yet!
+
As an alternative, we might try something like this, imagining a
+read_non_blocking which has exactly the kind of and_then method described
+above. If we were to try to do that, though, with code kind of like this, it
+would not even compile:
+
let mut data = None;
+network_socket.read_non_blocking().and_then(|result| {
+ data = Some(result);
+});
+println!("{data:?}");
+
The callback passed to and_then needs a mutable reference to data, but the
+load function tries to return data to the caller. Rust would helpfully tell
+us that we cannot borrow data immutably to print it because it is still
+borrowed mutably for the and_then callback. This is not just Rust being fussy,
+either: the result of this would normally always just print the None value and
+exit, but if the read happened to go fast enough, it is possible it could
+sometimes print some string data instead. That is definitely not what we
+want!
+
We also could not cancel read_non_blocking: once it has started, it will run
+till it finishes unless the whole program stops.
+
What we really want to be able to write is something much more direct, like we
+would write in blocking code, but with the benefits of getting the data when it
+is available and not blocking the rest of the program while waiting for the
+data to arrive—something like this:
+
let data = network_socket.read(&path).await;
+println!("{data}");
+
That is exactly what Rust’s async abstraction gives us. It is designed to help
+us solve all of these issues. In the next section, we will see how this works in
+practice.
First, though, we need to dig a little deeper into the differences between
+parallelism and concurrency. In the previous chapter we treated them as mostly
+interchangeable. Now we need to distinguish between the two a little more,
+because the differences will show up as we start working:
+
+
+
Parallelism is when operations can happen simultaneously.
+
+
+
Concurrency is when operations can make progress without having to wait for
+all other operations to complete.
+
+
+
One way to think about the difference between parallelism and concurrency is to
+think about working on a software project as a team. When you agree to split up
+a group of tasks between a group of people, with each person working on one task
+and delivering them separately, this is parallelism. Each person on the team
+can be making progress at the exact same time.
+
On the other hand, when an individual works on several different tasks before
+any of them is complete, this is concurrency. Maybe you have two different
+projects checked out on your computer, and when you get bored or stuck on one
+project, you switch to the other. You are just one person, and you cannot make
+progress on both tasks at the exact same time.
+
With both of these situations, you might have to coordinate between different
+tasks. Maybe you thought the task that one person was working on was totally
+independent from everyone else’s work, but it actually needs something finished
+by another person on the team. Some of the work could be done in parallel, but
+some of it was actually serial: it could only happen in a series, one thing
+after the other. Likewise, maybe with the two projects you were
+switching between yourself, you realize that one of them needs the result from
+the other, so now your concurrent work has also become serial.
+
Parallelism and concurrency can intersect with each other, too. For example, if
+it turns out your coworker is waiting on one of your projects to finish, then
+you might need to focus on that project and not give any time to the other one
+until it is done, so your own work stops being concurrent.
+
On a machine with multiple CPU cores, we can actually do work in parallel. One
+core can be doing one thing while another core does something completely
+unrelated, and those actually happen at the same time. On a machine with a
+single CPU core, the CPU can only do one operation at a time, but we can still
+have concurrency. Using tools like threads, processes, and async, the computer
+can pause one activity and switch to others before eventually cycling back to
+that first activity again. So all parallel operations are also concurrent, but
+not all concurrent operations happen in parallel!
+
When working with async in Rust, we are always dealing with concurrency.
+Depending on the hardware, the operating system, and the async runtime we are
+using, that concurrency may use some degree of parallelism under the hood, or it
+may not. Let’s dive into how async programming in Rust actually works!
Like other languages with async, Rust uses the async and await
+keywords—though with some important differences from how other languages do
+things, as we will see. Blocks and functions can be marked async, and you can
+wait on the result of an async function or block to resolve using the await
+keyword.
+
Let’s write our first async function, and call it:
+Listing 17-1: Defining a very simple async function
+
+
If we compile and run this… nothing happens, and we get a compiler warning:
+
$ cargo run
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-01)
+warning: unused implementer of `Future` that must be used
+ --> src/main.rs:2:5
+ |
+2 | hello_async();
+ | ^^^^^^^^^^^^^
+ |
+ = note: futures do nothing unless you `.await` or poll them
+ = note: `#[warn(unused_must_use)]` on by default
+
+warning: `async_await` (bin "async_await") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.11s
+ Running `target/debug/async_await`
+
+
The warning tells us that just calling hello_async() was not enough: we also
+need to .await or poll the future it returns. This raises two important
+questions:
+
+
Given there is no return type on the function, how is it returning a future?
In Rust, async fn is equivalent to writing a function which returns a future
+of the return type. That is, when the compiler sees a function like this:
Let’s break that down and see what each part means:
+
+
+
It uses the impl Trait syntax we discussed back in the “Traits as
+Parameters” section in Chapter 10 to return a Future with an
+associated type of Output. That tells us that Future is a trait, and the
+Output associated type of () matches the original return type from the
+async version of the function.
+
+
+
It wraps the whole body of the async fn in an async block. Given that
+blocks like this are expressions, and that this is expression is the one which
+is returned from the function, we can infer that an async block like this
+produces some anonymous data type which implements the Future trait.
+
+
+
Combined, those explain that when we called hello_async in main, it returned
+a Future. Then Rust warned us that we did not do anything with the future.
+This is because futures are lazy: they don’t do anything until you ask them
+to. This should remind you of our discussion of iterators back in Chapter
+13. With iterators, you have to call next to get them to do
+anything—whether by using a for loop or by using iterator methods like .iter() and .map() which ultimately call next() under the hood.
+
With futures, the same basic idea applies, although for different reasons, and
+with different syntax and methods. This is different from the behavior we saw
+when using thread::spawn in the previous chapter, and it is different from how
+many other languages approach async. This allows Rust to avoid running async
+code unless it is actually needed. We will see why that is later on. For now,
+let’s start by awaiting the future returned by hello_async to actually have it
+run.
+
+
Note: Rust’s await keyword goes after the expression you are awaiting, not
+before it—that is, it is a postfix keyword. This is different from what you
+might be used to if you have used async in languages like JavaScript or C#.
+Rust chose this because it makes chains of async and non-async methods much
+nicer to work with. As of now, await is Rust’s only postfix keyword.
+Listing 17-2: Attempting to fix a compiler warning by awaiting a future
+
+
Oh no! We have gone from a compiler warning to an actual error:
+
$ cargo run
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-02)
+error[E0728]: `await` is only allowed inside `async` functions and blocks
+ --> src/main.rs:3:19
+ |
+2 | fn main() {
+ | ---- this is not `async`
+3 | hello_async().await;
+ | ^^^^^ only allowed inside `async` functions and blocks
+
+For more information about this error, try `rustc --explain E0728`.
+error: could not compile `async_await` (bin "async_await") due to 1 previous error
+
+
This time, the compiler is informing us we cannot use .await in main,
+because main is not an async function. That is because async code needs a
+runtime: a Rust crate which manages the details of executing asynchronous
+code.
+
Most languages which support async, including C#, JavaScript, Go, Kotlin,
+Erlang, and Swift, bundle a runtime with the language. At least for now, Rust
+does not. Instead, there are many different async runtimes available, each of
+which makes different tradeoffs suitable to the use case they target. For
+example, a high-throughput web server with dozens of CPU cores and terabytes of
+RAM has very different different needs than a microcontroller with a single
+core, one gigabyte of RAM, and no ability to do heap allocations.
+
To keep this chapter focused on learning async, rather than juggling parts of
+the ecosystem, we have created the trpl crate (trpl is short for “The Rust
+Programming Language”). It re-exports all the types, traits, and functions you
+will need, and in a couple cases wires up a few things for you which are less
+relevant to the subject of the book. There is no magic involved, though! If you
+want to understand what the crate does, we encourage you to check out its
+source code. You will be able to see what crate each re-export
+comes from, and we have left extensive comments explaining what the handful of
+helper functions we supply are doing.
Whenever you see code from the trpl crate throughout the rest of the
+chapter, it will be re-exporting code from the futures and
+tokio crates.
+
+
+
The futures crate is an official home for Rust experimentation for async
+code, and is actually where the Future type was originally designed.
+
+
+
Tokio is the most widely used async runtime in Rust today, especially (but
+not only!) for web applications. There are other great options out there,
+too, and they may be more suitable for your purposes. We are using Tokio
+because it is the most widely-used runtime—not as a judgment call on whether
+it is the best runtime!
+
+
+
+
For now, go ahead and add the trpl crate to your hello-async project:
+
$ cargo add trpl
+
+
Then, in our main function, let’s wrap the call to hello_async with the
+trpl::block_on function, which takes in a Future and runs it until it
+completes.
Phew: we finally have some working async code! Now we can answer that second
+question: what is a future anyway? That will also help us understand why we need
+that trpl::block_on call to make this work.
A future is a data structure which represents the state of some async
+operation. More precisely, a Rust Future is a trait; it allows many different
+data structures to represent different async operations in different ways, but
+with a common interface. Here is the definition of the trait:
Notice that this is a normal trait. While we often interact with futures via
+async blocks, you can also implement this yourself on your own data types when
+you need to. Many of the functions we will see throughout this chapter return
+types which have their own implementations of Future. Those implementations
+can compose together nicely
+
Future has an associated type, Output, which says what the result of the
+future will be when it resolves. (This is analogous to the Item associated
+type for the Iterator trait, which we saw back in Chapter 13.) Beyond that,
+Future has only one method: poll, which takes a special Pin reference for
+its self parameter and a mutable reference to some Context type, and returns
+a Poll<Self::Output>. We will talk a little more about Pin and Context
+later in the chapter. For now, let’s focus on what the method returns, the
+Poll type:
You may notice that this Poll type is a lot like an Option: it has one
+variant which has a value (Ready(T) and Some(T)), and one which does not
+(Pending and None). Having a dedicated type lets Rust treat Poll
+differently from Option, though, which is important since they have very
+different meanings! The Pending variant indicates that the future still has
+work to do, so the caller will need to check again later. The Ready variant
+indicates that the Future has finished its work and the T value is
+available.
+
+
Note: With most futures, the caller should not call poll() again after the
+future has returned Ready. Many futures will panic if polled after becoming
+ready! Futures which are safe to poll again will say so explicitly in their
+documentation.
+
+
Under the hood, when you call .await, Rust compiles that to code which calls
+poll, kind of (although not exactly )
+like this:
+
match hello_async().poll() {
+ Ready(_) => {
+ // We’re done!
+ }
+ Pending => {
+ // But what goes here?
+ }
+}
+
As you can see from this sample, though, there is a question: what happens when
+the Future is still Pending? We need some way to try again. We would need to
+have something like this instead:
When we use .await, Rust compiles it to something fairly similar to that loop.
+If Rust compiled it to exactly that code, though, every .await would block
+the computer from doing anything else—the opposite of what we were going for!
+Instead, Rust needs makes sure that the loop can hand off control to something
+which can pause work on this future and work on other futures and check this one
+again later. That “something” is an async runtime, and this scheduling and
+coordination work is one of the main jobs for a runtime.
+
Every await point—that is, every place where the code explicitly calls
+.await—represents one of those places where control gets handed back to the
+runtime. To make that work, Rust needs to keep track of the state involved in
+the async block, so that the runtime can kick off some other work and then come
+back when it is ready to try advancing this one again. This is an invisible
+state machine, as if you wrote something like this:
+
#![allow(unused)]
+fn main() {
+enum MyAsyncStateMachine {
+ FirstAwaitPoint(/* the state used after the first await point */),
+ SecondAwaitPoint(/* the state used after the second await point */),
+ // etc. for each `.await` point...
+}
+}
+
Writing that out by hand would be tedious and error-prone—especially when making
+changes to code later. Async Rust creates that state machine for us, and it
+really is an enum like this, just an anonymous one you don’t have to name. As
+a result, the normal rules around data structures all apply, including for
+borrowing and ownership. Happily, the compiler also handles checking that for
+us, and has good error messages. We will work through a few of those later in
+the chapter!
+
Once all of that compilation work is done, though, we need a runtime to actually
+poll the futures, coordinate between different futures as they hand off control
+at await points, and even provide async versions of common functionality like
+file or network I/O.
+
Now we can understand why the compiler was stopping us in Listing 17-2 (before
+we added the trpl::block_on function). The main function is not async—and
+it really cannot be: if it were, something would need to call poll() on
+whatever main returned! Instead, we use the trpl::block_on function, which
+polls the Future returned by hello_async until it returns Ready. Every
+async program in Rust has at least one place where it sets up an executor and
+executes code.
+
+
Note: Under the hood, Rust uses generators so that it can hand off control
+between different functions. These are an implementation detail, though, and
+you never have to think about it when writing Rust.
+
The loop as written also wouldn’t compile, because it doesn’t actually satisfy
+the contract for a Future. In particular, hello_async_fut is not pinned
+with the Pin type and we did not pass along a Context argument. We will
+see a little more about Pin later in the chapter, but we will not dig into
+Context because you will not normally need them for working with futures in
+day-to-day Rust code.
+
If you want to understand how things work “under the hood,” though, the
+official Asynchronous Programming in Rust book covers them:
Now, that’s a lot of work to just print a string, but we have laid some key
+foundations for working with async in Rust! Now that you know the basics of how
+futures and runtimes work, we can see some of the things we can do with async.
In this section, we will apply async to some of the same concurrency challenges
+we tackled with threads in chapter 16. Since we already talked about a lot of
+the key ideas there, in this section we will focus on what is different between
+threads and futures.
+
In many cases, the APIs for working with concurrency using async are very
+similar to those for using threads. In other cases, they end up being shaped
+fairly differently. Even when the APIs look similar, they often have different
+behavior and they nearly always have different performance characteristics.
The first task we tackled in Chapter 16 was counting up on two separate threads.
+Let’s do the same using async. The trpl crate supplies a spawn_task function
+which looks very similar to the thread::spawn API, and a sleep function
+which is an async version of the thread::sleep API. We can use these together
+to implement the same counting example as with threads.
+
Listing 17-4 shows our starting point. We set up our main function with trpl::block_on, so that our top-level function can be async.
+
fn main() {
+ trpl::block_on(async {
+ // our implementation will go here
+ });
+}
+
+
Note: From this point forward in the chapter, every example will include this
+exact same wrapping code with trpl::block_on in main, so we will often
+skip it just like we do with main. Don’t forget to include it in your
+code!
+
+
Then we can write two loops within that block, each with a trpl::sleep call in
+them. Similar to the threading example, we put one loop in the body of a
+trpl::spawn_task, the same way we did with thread::spawn, and the other in a
+top-level for loop. Notice that we also need to add a .await after the
+sleep calls.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ trpl::spawn_task(async {
+ for i in 1..10 {
+ println!("hi number {i} from the first task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the second task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ });
+}
+Listing 17-5: Using spawn_task to count with two
+
+
This does something very similar to what the thread-based implementation did, as
+we can see from the output when we run it. (As with the threading example, you
+may see a different order in your own terminal output when you run this.)
+
+
hi number 1 from the second task!
+hi number 1 from the first task!
+hi number 2 from the first task!
+hi number 2 from the second task!
+hi number 3 from the first task!
+hi number 3 from the second task!
+hi number 4 from the first task!
+hi number 4 from the second task!
+hi number 5 from the first task!
+
+
This stops as soon as the for loop in the body of the main async block finishes,
+because the task spawned by spawn_task is shut down when the main function
+ends—just like threads are. Thus, if you want to run all the way to the
+completion of the task, you will need to use a join handle to wait for the first
+task to complete. With threads, we used the join method to “block” until the
+thread was done running. Here, we can use await to do the same thing, and
+since the handle’s output is actually a Result, we will also unwrap it.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let handle = trpl::spawn_task(async {
+ for i in 1..10 {
+ println!("hi number {i} from the first task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ });
+
+ for i in 1..5 {
+ println!("hi number {i} from the second task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+
+ handle.await.unwrap();
+ });
+}
+Listing 17-6: Using .await with a join handle to run a task to completion
+
+
Now the output again looks like what we saw in the threading example. (Again,
+the exact output may look different for you.)
+
+
hi number 1 from the second task!
+hi number 1 from the first task!
+hi number 2 from the first task!
+hi number 2 from the second task!
+hi number 3 from the first task!
+hi number 3 from the second task!
+hi number 4 from the first task!
+hi number 4 from the second task!
+hi number 5 from the first task!
+hi number 6 from the first task!
+hi number 7 from the first task!
+hi number 8 from the first task!
+hi number 9 from the first task!
+
+
So far, it looks like async and threads basically give us the same basic
+behavior. However, there are a few important differences already. One was using
+.await instead of calling join on the join handle. Another is that we needed
+to await both sleep calls. Most importantly, though, we did not need to spawn
+another operating system thread to do this. We were able to get concurrency for
+just the cost of a task, which has much faster startup time and uses much less
+memory than an OS thread.
+
What is more, we actually do not need the spawn_task call at all to get
+concurrency here. Remember that each async block compiles to an anonymous
+future. That means we can put each of these two loops in an async block and then
+ask the runtime to run them both to completion using trpl::join:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let fut1 = async {
+ for i in 1..10 {
+ println!("hi number {i} from the first task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ };
+
+ let fut2 = async {
+ for i in 1..5 {
+ println!("hi number {i} from the second task!");
+ trpl::sleep(Duration::from_millis(1)).await;
+ }
+ };
+
+ trpl::join(fut1, fut2).await;
+ });
+}
+Listing 17-7: Using trpl::join to await two anonymous futures
+
+
When we run this, we see both futures run to completion:
+
+
hi number 1 from the first task!
+hi number 1 from the second task!
+hi number 2 from the first task!
+hi number 2 from the second task!
+hi number 3 from the first task!
+hi number 3 from the second task!
+hi number 4 from the first task!
+hi number 4 from the second task!
+hi number 5 from the first task!
+hi number 6 from the first task!
+hi number 7 from the first task!
+hi number 8 from the first task!
+hi number 9 from the first task!
+
+
Here, you will see the exact same order every time, which is very different from
+what we saw with threads. That is because the trpl::join function is fair,
+meaning it checks both futures equally, rather than letting one race ahead. With
+threads, the operating system decides which thread to check, and that is
+ultimately out of our control. With an async runtime, the runtime itself decides
+which future to check, so it has the final say. In practice, the details get
+complicated because an async runtime might use operating system threads under
+the hood as part of how it manages concurrency, but a runtime can still choose
+to guarantee fairness even so. However, runtimes do not have to guarantee
+fairness for any given operation, and even within a given runtime, different
+APIs sometimes exist to let you choose whether fairness is something you care
+about as a caller.
+
Try some of these different variations on awaiting the futures and see what they
+do:
+
+
Remove the async block from around either or both of the loops.
+
Await each async block immediately after defining it.
+
Wrap only the first loop in an async block, and await the resulting future
+after the body of second loop.
+
+
For an extra challenge, see if you can figure out what the output will be in
+each case before running the code!
Sharing data between futures will look familiar. We can again use async versions
+of Rust’s types for message-passing. Instead of std::sync:mpsc::channel, we
+will use a tprl::channel, for example.
+
The synchronous Receiver::recv() method in std::mpsc::channel blocks until
+it receives a message. The trpl::Receiver::recv() method, by contrast, is an
+async function. Instead of blocking, it waits until a message is received or
+the send side of the channel closes. One other difference with this particular
+recv() implementation is that it returns an Option of the type sent over the
+channel instead of a Result.
+
We can start by introducing an async version of the multiple-producer,
+single-consumer channel channel API we used with threads back in Chapter 16. The
+API is just a little different here in Listing 17-8: we have a mutable receiver
+rx. Otherwise, this looks pretty much the same as the thread-based approach.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+
+ let received = rx.recv().await.unwrap();
+ println!("Got: {received}");
+ });
+}
+Listing 17-8: Creating an async channel and assigning the two halves to tx and rx
+
+
Now we can send messages from the sender to the receiver. Again, the API is just
+a little different from the threaded version in Chapter 16, where we needed to
+spawn a separate thread to allow the message passing to happen asynchronously.
+In the version in Listing 17-9, we opt into async behavior on the receiver side
+by using .await on the rx.recv() call.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let val = String::from("hi");
+ tx.send(val).unwrap();
+
+ let received = rx.recv().await.unwrap();
+ println!("Got: {received}");
+ });
+}
+Listing 17-9: Sending "hi" from tx and receiving it in rx
+
+
The send call does not block, since the channel we are sending it into is
+unbounded. That was true with our threading example back in Chapter 16, too,
+though. However, there is a big difference with the rx.recv() calls. The one
+back in Chapter 16 blocked the thread it ran on—in that case, the main thread.
+This one does not block at all! Instead, once the program hits the .await on
+the rx.recv() call, it hands control back to the runtime, which can go on
+scheduling other operations until a message arrives. It might be hard to see
+that from this code, though, since the message will arrive right away!
+
+
Note: Since this is all wrapped in a trpl::block_on, this would effectively
+block anything happening outside that. That is the whole point of block_on,
+in fact: to allow you to choose where to block on some set of async code to
+transition between sync and async code. However, within this block, the
+.await does not block further operations—as we will see!
+
+
Let’s go ahead and send a whole series of messages, and sleep in between them,
+as shown in Listing 17-10:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+
+ // snip...
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+}
+Listing 17-10: Sending multiple messages over the async channel and sleeping with an .await between each message
+
+
This handles sending the messages, but so far we don’t do anything with them,
+and the code just silently runs forever. We need to actually receive the
+messages. In this case, we could do that manually, because we know how many
+messages are coming in. In the real world, though, we will generally be waiting
+on some unknown number of messages. In that case, we need to keep waiting
+until we determine that there are no more messages.
+
That sounds like a good job for a loop! In synchronous code, we might use a
+for loop to process a sequence of items, regardless of how many items are in
+the loop. However, Rust does not yet have a way to write a for loop over an
+asynchronous series of items. Instead, we need to use a new kind of loop we
+haven’t seen before, the while let conditional loop. A while let loop is the
+loop version of the if let construct we saw back in Chapter 6. It continues as
+long as the condition it relies on is true. Listing 17-11 shows how we can use
+this with rx.recv to print all the messages send by the tx transmitter.
+
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+}
+Listing 17-11: Using a while let loop with .await to receive messages asynchronously
+
+
The rx.recv() call produces a Future. The Output of the future is an
+Option of the message type. While waiting on messages, it will respond with
+Poll::Pending, so the runtime will pause it until it is time to check it
+again. Once a message arrives, it will respond with
+Poll::Ready(Some(message)). When the channel closes, it will instead respond
+with Poll::Ready(None), which we can use to know that it is done. The while let pulls all of this together. If the result of calling rx.recv().await is
+Some(message), we get access to the message and we can use it in the loop
+body, just like we could with if let. If the result is None, the loop ends.
+Every time the loop completes, it hits the await point again, so the runtime
+pauses it again until another message arrives.
+
With the while let loop in place, the code now successfully sends and receives
+the messages. Unfortunately, there are still a couple problems. For one thing,
+the messages do not arrive at one-second intervals, we see them arrive all at
+once, four seconds after we start the program. For another, this program also
+never stops! You will need to shut it down using ctrl-c.
+
Let’s start by understanding why the messages all come in at once after the full
+delay, rather than coming in with delays in between each one. This highlights an
+important point about the way that async works in Rust. Within any given async
+block, the await points are sequential: each one happens one after another. That
+is, after all, one of the big motivations for using this syntax instead of
+callbacks, event handlers, or chains of methods: the flow through the program is
+much easier to follow, because having the order that .await keywords appear in
+the code is also the order they happen when running the program.
+
With that in mind, we can see why this code behaves the way it does by looking
+at the whole thing all together, in Listing 17-12.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+}
+Listing 17-12: An async block with multiple .await points in it
+
+
There is just one async block here, so everything here will proceed linearly.
+Every one of the .await points for the trpl::sleep calls appears before the
+.await points on the rx.recv(), so all the tx.send calls happen,
+interspersed with all of the trpl::sleep calls. Only then does the while let
+loop get to go through all of the .await points on the recv calls.
+
To get the behavior we actually want, where the delay happens in between
+receiving each message, rather than before receiving any message, we need to
+give put the tx and rx operations in their own async blocks, so the runtime
+can execute each of them separately. We also need to tell the runtime to
+actually run them using trpl::join, just like we did for the counting example
+above. Listing 17-13 shows how that looks.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx_fut = async {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ trpl::join(tx_fut, rx_fut).await;
+ });
+}
+Listing 17-13: Separating send and recv into their own async blocks and awaiting the futures for those blocks
+
+
With these changes made, the messages get printed at one-second intervals,
+rather than all in a rush after four seconds.
+
The program still never stops running, though. That’s because of the combination
+of the while let loop and the trpl::join call. Let’s consider the way this
+loop works:
+
+
The trpl::join future only completes once both futures passed to it
+have completed.
+
The tx future completes once it finishes sleeping after sending the last
+message in vals.
+
The rx future will not complete until the while let loop ends.
+
The while let loop will not end until rx.recv().await produces None.
+
The rx.recv().await will only return None once the other end of the
+channel is closed.
+
The channel will only close if we call rx.close() or when the sender side,
+tx, is dropped.
+
We do not call rx.close() anywhere, and tx will not be dropped until the
+async block ends.
+
The block cannot end because it is blocked on trpl::join completing,
+which takes us back to the top of this list!
+
+
We need to make sure the channel gets closed so that trpl::join will complete.
+We could manually close rx somewhere by calling rx.close(), but that does
+not make much sense in this case. The idea is that rx should keep listening
+until tx is done sending. Stopping after handling some arbitrary number of
+messages would make the program shut down, but it would mean we could miss
+messages if the sending side changed. Given that we cannot use rx.close(), we
+need to make sure that tx gets dropped before the end of the function.
+
Right now, the async block only borrows tx. We can confirm this by adding
+another async block which uses tx, and using trpl::join3 to wait for all
+three futures to complete:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx_fut = async {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(received) = rx.recv().await {
+ println!("Got: {received}");
+ }
+ };
+
+ let tx_fut2 = async {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ trpl::join3(tx_fut, tx_fut2, rx_fut).await;
+ });
+}
+Listing 17-14: Adding another async block which borrows tx, to see that we can borrow it repeatedly
+
+
Now both blocks borrow tx, so they are both able to use it to send messages,
+which rx can then receive. When we run that code, we see the extra output from
+the new async block, and the message it sends being received by the
+rx.recv().
+
+
Got: hi
+Got: more
+Got: from
+Got: messages
+Got: the
+Got: for
+Got: future
+Got: you
+
+
As before, we also see that the program does not shut down on its own and
+requires a ctrl-c. This little exploration helps
+us understand why: it is ultimately about ownership. We need to move tx into
+the async block so that once that block ends, tx will be dropped.
+
Since we have seen how async blocks borrow the items they reference from their
+outer scope, we can go ahead and remove the extra block we just added for now,
+and switch back from join3 to join.
+
The last step here is to figure out how to get ownership of the data instead of
+just borrowing it. In Chapter 13, we learned how to use the move keyword with
+closures, and in Chapter 16, we saw that we often need to use closures marked
+with move when working with threads. As we have discovered, the same dynamics
+apply to async blocks! Hopefully this will make sense if you remember that any
+time you write a future, a runtime is ultimately responsible for executing it.
+That means that an async block might outlive the function where you write it,
+the same way a closure can. When a future takes ownership of the data it
+references this way, it needs to move that data into the future—so the move
+keyword works with async blocks just like it does with closures.
+
Thus, we can change the first async block from an async block to an async move block, like this:
+
The result is Listing 17-15, and when we run this version of the code, it
+shuts down gracefully after the last message is sent.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ eprintln!("received '{value}'");
+ }
+ };
+
+ trpl::join(tx_fut, rx_fut).await;
+ });
+}
+Listing 17-15: A working example of sending and receiving messages between futures which correctly shuts down when complete
+
+
This async channel is also a multiple-producer channel, so we can call clone
+on tx if we want to send messages from multiple futures. For example, we can
+make the code from Listing 17-16 work by cloning the tx before moving it
+into the first async block, moving the original tx into the second async
+block, and switching back to join3.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ trpl::join3(tx1_fut, tx_fut, rx_fut).await;
+ });
+}
+Listing 17-16: Using multiple producers with async blocks
+
+
Both of these blocks need to be async move blocks, or else we will end up
+back in the same infinite loop we started out in. With that done, though, we get
+all the messages we expected, with little delays between them. Notice that since
+each of the sending futures do a one-second delay after sending, the messages
+come in right after each other at one-second intervals. The delays are
+concurrent, not sequential, just as we would expect.
+
This is a good start, but it limits us to just a handful of futures: two with
+join, or three with join3. Let’s see how we might work with more futures.
When we switched from using two futures to three in the previous section, we
+also had to switch from using join to using join3. It would be annoying to
+do this every time we changed our code. Happily, we have a macro form of join
+to which we can pass an arbitrary number of arguments. It also handles awaiting
+the futures itself. Thus, we could rewrite the code from Listing 17-16 to use
+join! instead of join3, as in Listing 17-17:
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ trpl::join!(tx1_fut, tx_fut, rx_fut);
+ });
+}
+Listing 17-17: Using join! to wait for multiple futures
+
+
This is definitely a nice improvement over needing to swap between join and
+join3 and join4 and so on! However, both the function nor macro forms of
+join only work for cases where we know the number of futures ahead of time. If
+instead we have a dynamic number of futures, we need a function which works with
+a collection type which can grow and shrink dynamically at runtime, such as a
+vector. In real-world Rust, pushing futures into a collection and then waiting
+on some or all the futures in that collection to complete is a very common
+pattern.
+
The trpl::join_all function accepts any type which implements the Iterator
+trait, which we learned about back in Chapter 13, so it seems like just the
+ticket. Let’s try putting our futures in a vector, and replace join3 with
+join_all.
+
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let futures = vec![tx1_fut, rx_fut, tx_fut];
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-18: Storing anonymous futures in a vector and calling join_all
+
+
Unfortunately, this does not compile. Instead, we get this error:
This error message is admittedly not the most helpful! It only tells us that it
+expected one async block and found another—but why is it looking for the async
+blocks that it names here, and why does it only reference them by where they
+appear in the code?
+
One clue is the format of this message. Notice that it is exactly the same as if
+we had tried to create a Vec with a a number and a string in it:
+
+Filename: src/main.rs
+
fn main() {
+ let a = 1;
+ let b = "Hello";
+ let vals = vec![a, b];
+}
+Listing 17-19: Trying to construct a Vec with a number and a string
+
+
The output there would be:
+
$ cargo build
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/no-listing-type-mismatch)
+error[E0308]: mismatched types
+ --> src/main.rs:5:24
+ |
+5 | let vals = vec![a, b];
+ | ^ expected integer, found `&str`
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `async_await` (bin "async_await") due to 1 previous error
+
+
Saying “expected something, found something else” is Rust’s standard format
+for telling us about a type mismatch. As we saw with vectors in “Using an Enum
+to Store Multiple Types” back in Chapter 8, we need the type of
+each item in a collection to be the same—and tx1_fut, rx_fut, and tx_fut
+do not have the same type.
+
The underlying issue here is what we learned in the previous section: async
+blocks compile to anonymous futures. Under the hood, there is a data structure
+corresponding to each of these blocks, and it has its own unique type. This
+might be surprising. After all, none of them returns anything, so the Future
+type in each case is Future<Output = ()>. However, Future is a trait, not a
+concrete type. The actual types here are invisible from our point of view as the
+person writing the code.
+
In Chapter 8, we discussed one way to include multiple types in a single vector:
+using an enum to represent each of the different types which can appear in the
+vector. We cannot do that here, though. For one thing, we do not even have a way
+to name the different types, because they are anonymous. For another, the reason
+we reached for a vector and join_all in the first place was to be able to work
+with a dynamic collection of futures where we do not know what they will all be
+until runtime.
+
To make this work, we need to use trait objects, just as we did for returning
+different kinds of errors from the same function in “Returning Errors from the
+run function” back in Chapter 12. Again, we will cover trait objects in
+detail in Chapter 17. Here, it lets us treat each of the anonymous futures
+produced by these types as interchangeable, since all of them by definition
+implement the Future trait.
+
We can start by wrapping each of the futures in the vec! in a Box::new().
+Unfortunately, the initial way we might try this, as shown in Listing 17-20,
+still does not compile.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let futures =
+ vec![Box::new(tx1_fut), Box::new(rx_fut), Box::new(tx_fut)];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-20: Trying to use Box::new to align the types of the futures in a Vec
+
+
In fact, we have the same basic error we did before, but we get one for both the
+second and third Box::new calls, and we also get new errors referring to the
+Unpin trait.
+
We can start by fixing the type error around the Box::new calls, by telling
+the compiler explicitly that we want to use these types as trait objects. The
+clearest way to do that here is by adding a type annotation to the declaration
+of futures, as we see in Listing 17-21. The type we have to write here is a
+little involved, so let’s walk through each part of it.
+
+
The innermost type is the future itself. We note explicitly that it the output
+of the future is the unit type () by writing Future<Output = ()>.
+
Then we annotate the trait with dyn to mark it as dynamic.
+
The entire trait is wrapped in a Box.
+
Finally, we state explicitly that futures is a Vec containing these items.
+
+
+Filename: src/main.rs
+
use std::{future::Future, time::Duration};
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let rx_fut = async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ };
+
+ let tx_fut = async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ };
+
+ let futures: Vec<Box<dyn Future<Output = ()>>> =
+ vec![Box::new(tx1_fut), Box::new(rx_fut), Box::new(tx_fut)];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-21: Fixing the rest of the type mismatch errors by using an explicit type declaration
+
+
That already made a big difference. Now when we run the compiler, we only have
+the errors mentioning Unpin. Although there are three of them, notice that
+each is very similar in its contents.
+
cargo run
+ Compiling proc-macro2 v1.0.82
+ Compiling unicode-ident v1.0.12
+ Compiling autocfg v1.3.0
+ Compiling futures-core v0.3.30
+ Compiling pin-project-lite v0.2.14
+ Compiling libc v0.2.154
+ Compiling futures-sink v0.3.30
+ Compiling memchr v2.7.2
+ Compiling futures-task v0.3.30
+ Compiling futures-io v0.3.30
+ Compiling futures-channel v0.3.30
+ Compiling pin-utils v0.1.0
+ Compiling slab v0.4.9
+ Compiling num_cpus v1.16.0
+ Compiling tokio v1.37.0
+ Compiling quote v1.0.36
+ Compiling syn v2.0.63
+ Compiling futures-macro v0.3.30
+ Compiling futures-util v0.3.30
+ Compiling futures-executor v0.3.30
+ Compiling futures v0.3.30
+ Compiling trpl v0.1.0 (/Users/chris/dev/rust-lang/book/packages/trpl)
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-20)
+error[E0277]: `dyn std::future::Future<Output = ()>` cannot be unpinned
+ --> src/main.rs:47:24
+ |
+47 | trpl::join_all(futures).await;
+ | -------------- ^^^^^^^ the trait `Unpin` is not implemented for `dyn std::future::Future<Output = ()>`, which is required by `Box<dyn std::future::Future<Output = ()>>: std::future::Future`
+ | |
+ | required by a bound introduced by this call
+ |
+ = note: consider using the `pin!` macro
+ consider using `Box::pin` if you need to access the pinned value outside of the current scope
+ = note: required for `Box<dyn std::future::Future<Output = ()>>` to implement `std::future::Future`
+note: required by a bound in `join_all`
+ --> /Users/chris/.cargo/registry/src/index.crates.io-6f17d22bba15001f/futures-util-0.3.30/src/future/join_all.rs:105:14
+ |
+102 | pub fn join_all<I>(iter: I) -> JoinAll<I::Item>
+ | -------- required by a bound in this function
+...
+105 | I::Item: Future,
+ | ^^^^^^ required by this bound in `join_all`
+
+error[E0277]: `dyn std::future::Future<Output = ()>` cannot be unpinned
+ --> src/main.rs:47:9
+ |
+47 | trpl::join_all(futures).await;
+ | ^^^^^^^^^^^^^^^^^^^^^^^ the trait `Unpin` is not implemented for `dyn std::future::Future<Output = ()>`, which is required by `Box<dyn std::future::Future<Output = ()>>: std::future::Future`
+ |
+ = note: consider using the `pin!` macro
+ consider using `Box::pin` if you need to access the pinned value outside of the current scope
+ = note: required for `Box<dyn std::future::Future<Output = ()>>` to implement `std::future::Future`
+note: required by a bound in `JoinAll`
+ --> /Users/chris/.cargo/registry/src/index.crates.io-6f17d22bba15001f/futures-util-0.3.30/src/future/join_all.rs:29:8
+ |
+27 | pub struct JoinAll<F>
+ | ------- required by a bound in this struct
+28 | where
+29 | F: Future,
+ | ^^^^^^ required by this bound in `JoinAll`
+
+error[E0277]: `dyn std::future::Future<Output = ()>` cannot be unpinned
+ --> src/main.rs:47:33
+ |
+47 | trpl::join_all(futures).await;
+ | ^^^^^ the trait `Unpin` is not implemented for `dyn std::future::Future<Output = ()>`, which is required by `Box<dyn std::future::Future<Output = ()>>: std::future::Future`
+ |
+ = note: consider using the `pin!` macro
+ consider using `Box::pin` if you need to access the pinned value outside of the current scope
+ = note: required for `Box<dyn std::future::Future<Output = ()>>` to implement `std::future::Future`
+note: required by a bound in `JoinAll`
+ --> /Users/chris/.cargo/registry/src/index.crates.io-6f17d22bba15001f/futures-util-0.3.30/src/future/join_all.rs:29:8
+ |
+27 | pub struct JoinAll<F>
+ | ------- required by a bound in this struct
+28 | where
+29 | F: Future,
+ | ^^^^^^ required by this bound in `JoinAll`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `async_await` (bin "async_await") due to 3 previous errors
+
+
That is a lot to digest, so let’s pull it apart. The first part of the message
+tell us that the first async block (src/main.rs:8:23: 20:10) does not
+implement the Unpin trait, and suggests using pin! or Box::pin to resolve
+it. The rest of the message tells us why that is required: the JoinAll
+struct, which is itself a Future, is also generic over a Future, and
+Future itself requires the Unpin trait. Understanding this error means we
+need to dive into a little more of how the Future type actually works, in
+particular the idea of pinning.
When we introduced the Future trait in the previous chapter, we saw that the
+definition of its poll method has an unusual way of specifying the self
+parameter. To review, here is the full definition of Future:
We have not seen a method definition like this before, where self has a type
+annotation rather than simply being named like self, mut self, &self, or
+&mut self. This syntax means that the method can only be called when the
+instance of the type which implements Future is behind a Pin pointer type.
+This syntax is not specific to Pin; it also works with Box and other smart
+pointer types, and we will see it again in Chapter 18.
+
Here, the signature tells us that if we want to poll a future to check whether
+it is Pending or Ready(Output), the type which implements Future has to be
+behind a Pin smart pointer type. Recalling that .await is implemented in
+terms of calls to poll(), this starts to explain the error message we saw
+above—but that was in terms of Unpin, not Pin. So what exactly are Pin and
+Unpin, how do they relate, and why does Future need self to be in a Pin
+type to call poll?
+
In “Futures and Syntax: What Are Futures”, we described how
+a series of await points in a future get compiled into a state machine—and noted
+how the compiler helps make sure that state machine follows all of Rust’s normal
+rules around safety, including borrowing and ownership. Consider code which has
+a mutable Vec of strings, which asynchronously reads strings from files and
+pushes those strings into the Vec:
+
+
fn main() {
+ trpl::block_on({
+ async {
+ let mut strings = vec![];
+
+ let a = trpl::read_to_string("test-data/hello.txt").await.unwrap();
+ strings.push(a.trim());
+
+ let b = trpl::read_to_string("test-data/world.txt").await.unwrap();
+ strings.push(b.trim());
+
+ let combined = strings.join(" ");
+ println!("{combined}");
+ }
+ });
+}
+Listing 17-22: Borrowing mutable data across multiple .await points
+
+
If we think about the state machine that would get compiled to, it might be
+something kind of like this:
That is, at each .await in the source code, Rust would look at what state is
+needed between that await point and the point another .await appears or the
+async block ends, and create a corresponding variant in the AsyncStateMachine.
+Each variant has the appropriate kind of reference to the data that will be
+referenced in that section. The real implementation is not exactly like this,
+but it is close enough to give the right mental model.
+
And this could actually be fine, on its own—Rust would keep track of those
+mutable references, and if we got something wrong, the borrow checker would tell
+us. It gets a bit tricky, though, if we want to move around the future that
+corresponds to that block. Remember, we could always do something like this:
If we pass those futures into join, or return them from a function, or put
+them in a data structure to keep track of for some reason, that moves the state
+machine as well. That means the reference to Vec<String> for the values we
+read in with trpl::read_to_string moves along with it. Since references point
+to the actual memory address of the Vec, Rust needs some way to either update
+them so they are still valid after the Vec moves, or it needs some way to keep
+Vec from getting moved around so that the references do not need to be
+updated. Updating all the references to an object every time it moves could be
+quite a lot of work for the compiler to add, especially since there can be a
+whole web of references that need updating. On the other hand, making sure the
+underlying item does not move in memory can be “free” at runtime in exchange
+for keeping some promises at compile time. That is where Pin and Unpin come
+in.
+
+
Note: The specific mechanics for how Pin and Unpin work under the hood are
+covered extensively in the API documentation for std::pin, so if you would
+like to understand them more fundamentally, that is a great place to start.
+Those details are not at all necessary for working with async Rust day to day,
+though. Here, we will stick to the parts you do need to understand to work
+with them in everyday Rust!
+
+
Pin is a smart pointer, much like Box, Rc, and the others we saw in
+Chapter 15. Unlike those, however, Pin only works with other pointer types
+like reference (& and &mut) and smart pointers (Box, Rc, and so on). To
+be precise, Pin works with types which implement the Deref or DerefMut
+traits, which we covered in Chapter 15. You can think of this restriction as
+equivalent to only working with pointers, though, since implementing Deref or
+DerefMut means your type behaves like a pointer type. including references,
+other smart pointers, and so on.
+
Wrapping a pointer type in Pin enforces the exact guarantee we need: the value
+behind the pointer we wrap in Pin cannot move. It is “pinned” in its current
+spot by the Pin wrapper. Thus, if you have Pin<Box<SomeType>>, you actually
+pin the SomeType value, not the Box pointer. In fact, the pinned box
+pointer can move around freely. Remember: we care about making sure the data
+ultimately being referenced stays in its place. If a pointer moves around, but
+the data it points to is in the same place, there is no problem.
+
However, most types are perfectly safe to move around, even if they happen to be
+behind a Pin pointer. Remember: the problem Pin addresses is when data
+structures have internal references which need to maintained when the structure
+moves around, as happens with internal references in futures. Primitive values
+like numbers and booleans do not have any internal structure like that, so they
+are obviously safe. Neither do most types you normally work with in Rust. A
+Vec, for example, does not have any internal references it needs to keep up to
+date this way, so you can move it around without worrying. But what happens if
+you have a Pin<u32> or a Pin<Vec<String>>?
+
We need a way to tell the compiler that it is actually just fine to move items
+around in cases like these where there is nothing to worry about. For that, we
+have Unpin. Unpin is a marker trait, like Send and Sync, which we saw in
+Chapter 16. Recall that marker traits have no functionality of their own. They
+exist only to tell the compiler that it is safe to use the type which implements
+a given trait in a particular context. Unpin informs the compiler that a given
+type does not need to uphold any particular guarantees about whether the value
+in question can be moved.
+
Just like Send and Sync, the compiler implements Unpin automatically for
+most types, and implementing it manually is unsafe. That is because you have to
+make sure that the type for which you are implementing Unsafenever moves
+data out from a reference that needs to be stable.
+
+
Note: This combination of Pin and Unpin allows a whole class of complex
+types to be safe in Rust which are otherwise difficult to implement because
+they are self-referential. That is, they are data structures where one part
+of the structure refers to another internally. As we have seen, futures can
+match that description, so self-referential types which require Pin show up
+most commonly in async Rust today, but you might—very rarely!—see it in
+other contexts, too.
+
+
Now we know enough to understand the error message from above. The problem is
+that the futures produced by an async block are not pinned by default.
+Strictly: they implement !Unpin to opt out of being copyable by default the
+way most types are. We need to pin them explicitly.
+
Now that we have an idea what that error message was telling us, we can finally
+get our join_all call to compile! First, we need to explicitly annotate
+futures as referring to a pinned Box of futures. Second, we actually need to
+pin the futures, which we can do using the handy Box::pin API, which exists
+for exactly this. Putting that together, we end up with the code in Listing
+17-23.
+
+Filename: src/main.rs
+
use std::{
+ future::Future,
+ pin::{pin, Pin},
+ time::Duration,
+};
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = pin!(async move {
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let rx_fut = pin!(async {
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+
+ let tx_fut = pin!(async move {
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let futures: Vec<Pin<Box<dyn Future<Output = ()>>>> =
+ vec![Box::pin(tx1_fut), Box::pin(rx_fut), Box::pin(tx_fut)];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-23: Using Pin and Box::pin to make the Vec type check
+
+
If we compile and run this, we finally get the output we hoped for:
There is a bit more we can explore here. For one thing, using Pin<Box<T>>
+comes with a small amount of extra overhead from putting these futures on the
+heap with Box—and we are only doing that to get the types to line up. We don’t
+actually need the heap allocation, after all: these futures are local to this
+particular function. As noted above, Pin is itself a smart pointer, so we can
+get the benefit of having a single type in the Vec—the original reason we
+reached for Box—without doing a heap allocation. We can use Pin directly
+instead.
+
The std::pin::pin macro exists to do just that for values. However, we must
+still be explicit about the type of the pinned reference; otherwise Rust will
+still not know to interpret these as dynamic trait objects, which is what we
+need them to be in the Vec. We therefore pin! each future when we define it,
+and define futures as a Vec containing pinned mutable references to the
+dynamic Future type, as in Listing 17-24.
+
+Filename: src/main.rs
+
use std::{
+ future::Future,
+ pin::{pin, Pin},
+ time::Duration,
+};
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let tx1 = tx.clone();
+ let tx1_fut = pin!(async move {
+ // snip...
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx1.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let rx_fut = pin!(async {
+ // snip...
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+
+ let tx_fut = pin!(async move {
+ // snip...
+ let vals = vec![
+ String::from("more"),
+ String::from("messages"),
+ String::from("for"),
+ String::from("you"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+ });
+
+ let futures: Vec<Pin<&mut dyn Future<Output = ()>>> =
+ vec![tx1_fut, rx_fut, tx_fut];
+
+ trpl::join_all(futures).await;
+ });
+}
+Listing 17-24: Using Pin directly with the pin! macro to avoid unnecessary heap allocations
+
+
This keeps everything on the stack, which is a nice little performance win, but
+it is still a lot of explicit types, which is quite unusual for Rust!
+
There is another, more serious, issue as well. We got this far by ignoring the
+fact that we might have different Output types. For example, in Listing 17-25,
+the anonymous future type for a implements Future<Output = u32>, the
+anonymous future type for b implements Future<Output = &str>, and the
+anonymous future type for c implements Future<Output = bool>. We can use
+trpl::join! to await them together, since it accepts futures of different
+types.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let a = async { 1u32 };
+ let b = async { "Hello!" };
+ let c = async { true };
+
+ let (a_result, b_result, c_result) = trpl::join!(a, b, c);
+ println!("{a_result}, {b_result}, {c_result}");
+ });
+}
+Listing 17-25: Three futures with distinct types
+
+
We cannot use trpl::join_all with these futures, though, because
+we will never be able to make them have the same type. (Remember, that error is
+what got us started on this adventure with Pin!)
+
We have a basic tradeoff here: we can either deal with a dynamic number of
+futures with join_all, as long as they all have the same type, or we can deal
+with a set number of futures with the join functions or the join! macro,
+even if they have different types. This is the same as working with any other
+type in Rust, though: futures are not special, even though we have some nice
+syntax for working with them, and that is a good thing!
+
In practice, you will usually work directly with async and .await, and only
+as a secondary tool reach for the functions like join or join_all, or their
+corresponding macro equivalents. Likewise, you will only need to reach for pin
+now and again to use them with those APIs. These kinds of tools are mostly
+handy for building frameworks, or especially when you are building a runtime
+itself, rather than for day to day Rust code. When you see them, though, now you
+will know what to do!
Thus far, we have only used the join family of functions and macros. When we
+“join” on some collection of futures, we require all of them to finish before
+we move on. Sometimes, though, we only need some future from a set to finish
+before we move on—kind of like racing one future against another. This operation
+is often named race for exactly that reason.
+
In Listing 17-26, we use race to run two futures, slow and fast, against
+each other. Each one prints a message when it starts running, pauses for some
+amount of time by calling and awaiting sleep, and then prints another message
+when it finishes. Then we pass both to trpl::race and wait for one of them to
+finish. (The outcome here won’t be too surprising: fast wins!)
+Listing 17-26: Using race to get the result of whichever future finishes first
+
+
One other thing to notice: if you flip the order of the arguments to race, the
+order of the start messages changes, even though the fast future always
+completes first. That is because the implementation of this particular race
+function is not fair. It always runs the futures passed as arguments in the
+order they are passed. Other implementations are fair, and will randomly
+choose which future to start first.
+
Regardless of whether the implementation of race we are using is fair, though,
+one of the futures will run up to the first .await in its body before
+another task can start.
+
To see why, recall from our discussion in “What Are Futures?” that
+Rust compiles async blocks in a way that hands control back to the async runtime
+at each await point. That has an important corollary: async runtimes can only
+switch which future they are executing at await points. Everything in between
+await points is just normal synchronous Rust code. That means if you do a bunch
+of really expensive work in an async function without an .await, that future
+will block any other futures from making progress.
+
+
Note: You may sometimes hear this referred to as one future starving other
+futures. The same thing applies to threads, too!
+
+
That has another important consequence for using race, join, and other such
+helpers. Some future is going to run first, and everything up to the first
+await point in that future will run before any part of any other future gets a
+chance to run. For simple code, that may not be a big deal. However, if you are
+doing some kind of expensive setup or long-running work, or if you have a future
+which will keep doing some particular task indefinitely, you will need to think
+about when and where to hand control back to the runtime.
Let’s consider a long-running operation. Here, we will simulate it using sleep
+inside the function, but in the real world it could be any of operations which
+might take a while, and which, critically, are blocking. Our slow helper
+function “slow” will just take a number of milliseconds to run, and sleep the
+thread for that long. This is intentionally not an async function, because the
+idea is to represent work that is not async.
+
+Filename: src/main.rs
+
use std::{thread, time::Duration};
+
+fn main() {
+ trpl::block_on(async {
+ // We will call `slow` here later
+ });
+}
+
+fn slow(name: &str, ms: u64) {
+ thread::sleep(Duration::from_millis(ms));
+ println!("'{name}' ran for {ms}ms");
+}
+Listing 17-27: Using thread::sleep to simulate slow operations
+
+
In Listing 17-28, we use slow to emulate doing this kind of CPU-bound work in
+a pair of futures. To begin, each future only hands control back to the runtime
+after carrying out a bunch of slow operations.
+Listing 17-28: Using thread::sleep to simulate slow operations
+
+
If you run this, you will see this output:
+
$ cargo run
+ Compiling proc-macro2 v1.0.82
+ Compiling unicode-ident v1.0.12
+ Compiling autocfg v1.3.0
+ Compiling futures-sink v0.3.30
+ Compiling futures-core v0.3.30
+ Compiling libc v0.2.154
+ Compiling pin-project-lite v0.2.14
+ Compiling futures-io v0.3.30
+ Compiling memchr v2.7.2
+ Compiling futures-task v0.3.30
+ Compiling futures-channel v0.3.30
+ Compiling pin-utils v0.1.0
+ Compiling slab v0.4.9
+ Compiling num_cpus v1.16.0
+ Compiling tokio v1.37.0
+ Compiling quote v1.0.36
+ Compiling syn v2.0.63
+ Compiling futures-macro v0.3.30
+ Compiling futures-util v0.3.30
+ Compiling futures-executor v0.3.30
+ Compiling futures v0.3.30
+ Compiling trpl v0.1.0 (/Users/chris/dev/rust-lang/book/packages/trpl)
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-26)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 4.32s
+ Running `target/debug/async_await`
+'a' started.
+'a' ran for 300ms
+'a' ran for 100ms
+'a' ran for 200ms
+'a' ran for 900ms
+'b' started.
+'b' ran for 750ms
+'b' ran for 100ms
+'b' ran for 150ms
+'b' ran for 350ms
+'b' ran for 150ms
+'a' finished.
+
+
As with our earlier example, race still finishes when a finishes. There is
+no interleaving between the two futures, though. The a future does all of its
+work until the trpl::sleep call is awaited, then the b future does all of
+its work until its own trpl::sleep call is awaited, and then the a future
+completes. It would be better if both futures could make progress between their
+slow tasks. We need some way to hand control back to the runtime there—and we
+know that await points are the way to do that. However, that means we need
+something we can await!
+
However, we can also see the handoff happening in this very example: if we
+removed the trpl::sleep at the end of the a future, it would complete
+without the b future running at all. Given that, maybe we could use the
+sleep function as a starting point, as in Listing 17-29.
+Listing 17-29: Using sleep to let operations switch off making progress
+
+
Now the two futures’ work is interleaved, as we can see if we run it.
+
+
'a' started.
+'a' ran for 300ms
+'b' started.
+'b' ran for 750ms
+'a' ran for 100ms
+'b' ran for 100ms
+'a' ran for 200ms
+'b' ran for 150ms
+'a' ran for 900ms
+'b' ran for 350ms
+'a' finished.
+
+
The a future still runs for a bit before handing off control to b, because
+it has some expensive work to do up front, but after that they just swap back
+and forth every time one of them hits an await point. In this case, we have done
+that after every call to slow, but we could break up the work however makes
+the most sense to us.
+
However, we do not actually need to sleep to accomplish this. We just need to
+hand back control to the runtime. We can actually yield control back to the
+runtime, using a function named yield_now. It does just what it says: hands
+control back to the runtime, so that the runtime can check whether any other
+tasks are ready to make progress.
+Listing 17-30: Using yield_now to let operations switch off making progress
+
+
This is both clearer about the actual intent and can be significantly faster
+than using sleep, because timers like the one used by sleep often have
+limits to how granular they can be. The version of sleep we are using, for
+example, will always sleep for at least a millisecond, even if we pass it a
+Duration of one nanosecond. Again, modern computers are fast: they can do a
+lot in one millisecond!
+
You can see this for yourself by setting up a little benchmark, like the one in
+Listing 17-31. (This is not an especially rigorous way to do performance
+testing, but it suffices to show the difference here.) Here, we skip all the
+status printing, pass a one-nanosecond Duration to sleep, let each future
+run by itself so that they do not interfere with each other, and get rid of all
+the status printing that we did to see the back-and-forth between tasks in
+Listings 17-29 and 17-30. Then we run for 1,000 iterations and see how long
+sleep takes vs. yield_now.
+
+Filename: src/main.rs
+
use std::time::{Duration, Instant};
+
+fn main() {
+ trpl::block_on(async {
+ let one_ns = Duration::from_nanos(1);
+ let start = Instant::now();
+ async {
+ for _ in 1..1000 {
+ trpl::sleep(one_ns).await;
+ }
+ }
+ .await;
+ let time = Instant::now() - start;
+ println!(
+ "'sleep' version finished after {} seconds.",
+ time.as_secs_f32()
+ );
+
+ let start = Instant::now();
+ async {
+ for _ in 1..1000 {
+ trpl::yield_now().await;
+ }
+ }
+ .await;
+ let time = Instant::now() - start;
+ println!(
+ "'yield' version finished after {} seconds.",
+ time.as_secs_f32()
+ );
+ });
+}
+Listing 17-31: Comparing the performance of sleep and yield_now
+
+
The version with yield_now is way faster!
+
+
Note: This also means that async can be a useful tool even for CPU-bound
+tasks, depending on what else your program is doing, because it provides a
+useful tool for structuring the relationships between different parts of the
+program. This is a form of cooperative multitasking, where each future has
+both the power to determine when it hands over control via await points and
+therefore also the responsibility to avoid blocking for too long. This is
+how some Rust-based embedded operating systems work!
+
+
In real-world code, you will not usually be alternative regular function calls
+with await points on every single line, of course. The underlying dynamic is an
+important one to keep in mind, though!
Many of these patterns are common enough to warrant abstracting over. For
+example, the trpl::timeout function takes a Duration for the maximum time to
+run, but also takes a future to run, and produces a new future you can await,
+whose Output type is a Result. Listing 17-32 shows how we can use it. If
+the passed-in future finishes first, the output result will be Ok, with the
+result of that passed-in future. If the duration elapses before the passed-in
+future finishes, the result will be Err with the duration that elapsed.
+
+Filename: src/main.rs
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let slow = async {
+ trpl::sleep(Duration::from_secs(5)).await;
+ "I finished!"
+ };
+
+ match trpl::timeout(Duration::from_secs(2), slow).await {
+ Ok(message) => println!("Succeeded with '{message}'"),
+ Err(duration) => {
+ println!("Failed after {} seconds", duration.as_secs())
+ }
+ }
+ });
+}
+Listing 17-32: Using timeout to run a slow operation with a time limit
+
+
Here we were using the timeout supplied by trpl, but we do not have to. We
+can implement it ourselves using race and sleep! To begin, let’s think about
+the API of timeout:
+
+
Its first parameter is a std::time::Duration which specifies the maximum
+time to wait.
+
Its second parameter is the future to run.
+
It returns a Result. If the future completes successfully, the Result will
+be Ok with the value produced by the future. If the timeout happens, the
+Result will be Err with the duration that the timeout waited for.
+
+
We can write the same signature ourselves, as in Listing 17-33.
+
+Filename: src/main.rs
+
use std::{future::Future, time::Duration};
+
+fn main() {
+ trpl::block_on(async {
+ let slow = async {
+ trpl::sleep(Duration::from_secs(5)).await;
+ "Finally finished"
+ };
+
+ // Here we will actually use the new `timeout` with `slow`.
+ });
+}
+
+async fn timeout<F: Future>(
+ max_time: Duration,
+ future: F,
+) -> Result<F::Output, Duration> {
+ unimplemented!()
+}
+Listing 17-33: Defining the signature of timeout
+
+
Then, in the body of the function, we can race whatever future the caller
+passes with a sleep future.
+
When we saw race earlier in Listing 17-26, we ignored its return type,
+because we were just interested in seeing the behavior of fast and slow when
+we ran the program. Here, though, its return value tells us whether the future
+or the sleep finished first. With race, both futures passed as arguments can
+legitimately “win,” so it does not make sense to use a Result to represent the
+return type. Instead, it returns a similar type called Either. Like Result,
+Either can be one of two types, but unlike Result, there is no notion of
+success or failure baked into the type. Instead, it uses Left and Right to
+indicate “one or the other”. Its implementation looks like this:
In the case of race specifically, it returns Left if the first argument
+finishes first, with that future’s output, and Right with the second future
+argument’s output if that one finishes first.
That gives us enough to be able to implement timeout ourselves using race
+and sleep.
+
+Filename: src/main.rs
+
use std::{future::Future, time::Duration};
+
+use trpl::Either;
+
+fn main() {
+ trpl::block_on(async {
+ let slow = async {
+ trpl::sleep(Duration::from_secs(5)).await;
+ "Finally finished"
+ };
+
+ // Here we will actually use the new `timeout` with `slow`.
+ });
+}
+
+// Note for maintainers: the extra space after the `ANCHOR` is intentional: it
+// makes this render more nicely!
+
+async fn timeout<F: Future>(
+ max_time: Duration,
+ future: F,
+) -> Result<F::Output, Duration> {
+ match trpl::race(future, trpl::sleep(max_time)).await {
+ Either::Left(output) => Ok(output),
+ Either::Right(_) => Err(max_time),
+ }
+}
+Listing 17-34: Defining timeout with race and sleep
+
+
Let’s walk through the details. Since we know from earlier that race is not
+fair, and will prefer the first argument to the second, we pass it the future
+first so it gets a chance to complete even if the caller passes in a very short
+value for max_time. Then we match on the result of awaiting the race. If the
+future passed in by the caller finished first, we will have Left(output),
+which we can return as a success with Ok. If the sleep finished first, we will
+have Right(()) instead, since timeout returns the unit type () if it
+succeeds. We can ignore that () by using _ and return Err with the
+duration the user passed in instead. And that’s it!
+
Back in main, we can call this new timeout function exactly like we called
+trpl::timeout before, but without the trpl:: namespace:
+Listing 17-35: Using the timeout function we defined ourselves
+
+
This pattern is quite common and useful. Futures compose with other futures, so
+you can build really powerful tools using smaller async building blocks. For
+example, you can use this same approach to combine timeouts with retries, and
+in turn use those with things like network calls—the exact example we started
+out with at the beginning of the chapter!
+
Over the last two sections, we have seen how to work with multiple futures at
+the same time. Up next, let’s look at how we can work with multiple futures in a
+sequence over time, with streams.
In Chapter 13, we looked at the Iterator trait, and we saw how we could work
+with a sequence of items in turn. So far in this chapter, we have mostly stuck
+with individual futures. The one big exception was the async channel we used.
+Recall how we used the receiver for our async channel in the “Message
+Passing” earlier in the chapter:
+
use std::time::Duration;
+
+fn main() {
+ trpl::block_on(async {
+ let (tx, mut rx) = trpl::channel();
+
+ let vals = vec![
+ String::from("hi"),
+ String::from("from"),
+ String::from("the"),
+ String::from("future"),
+ ];
+
+ for val in vals {
+ tx.send(val).unwrap();
+ trpl::sleep(Duration::from_secs(1)).await;
+ }
+
+ while let Some(value) = rx.recv().await {
+ println!("received '{value}'");
+ }
+ });
+}
+
This is because the rx receiver actually represents a stream of messages: a
+sequence over time.
+
Unlike Iterator and Future, there is no definition of a Stream type in the
+standard library yet but there is a
+very common definition used throughout the ecosystem. If we start with the
+definition of the Iterator and Trait types, we can figure out what a trait
+that merges them together might look like.
+
The Iterator trait defines an associated type Item and a function next,
+which produces Some(Item) until the underlying iterator is empty, and then
+produces None.
As we saw earlier in this chapter, the Future trait defines an associated item
+Output and a function poll, which produces Poll::Pending while waiting and
+then Poll::Ready(Output) once the future is ready.
From Iterator, we have the idea of a sequence; its next method provides an
+Option<Self::Item>. From Future, we have the idea of readiness; its poll
+method provides a Poll<Self::Output>. To get a stream, a sequence of items
+which become ready over time, we can define a Stream as a trait which has all
+of those features put together:
+
+
+
An associated type Item for the type of the items, just like in Iterator.
+Unlike in Future, where there was a single Output, we use Item here to
+indicate that it is more like Iterator: there may be zero to many of these.
+
+
+
A method to get those items. We can call it poll_next, to make it clear that
+it is polling like a future and producing a sequence of items one after
+another, just like an iterator.
+
+
+
A return type from poll_next which uses both Poll and Option. The outer
+type is Poll, since it has to be checked for readiness as a kind of future.
+The inner type is Option, since it needs to signal whether there are more
+messages, just like an iterator.
+
+
+
When we put those all together, we end up with the same definition for a
+Stream trait as the one used by the Rust ecosystem:
Something very similar to this will likely end up standardized as part of Rust’s
+standard library, just the way Future was. In the meantime, it is part of the
+toolkit of most runtimes, so you can rely on it, and everything we cover below
+should generally apply!
We could work directly in terms of the poll_next API by hand-writing our own
+Stream state machines. However, just as we do not generally work with futures
+directly via their poll method, we generally also do not work directly with
+the poll_next method for streams. Instead, we usually use a next method,
+which is defined roughly like this:
Note: The actual definition we will use looks slightly different than this,
+because it supports versions of Rust which did not yet support using async
+functions in traits. As a result, it looks like this:
That Next type is just a simple struct which implements Future, so that
+.await can work with this!
+
+
Working with this API will be kind of like working with iterators without the
+convenience of a for loop. In fact, it will look a lot like the way we used
+rx.recv back in the “Message Passing” section, using while let loops.
+
Let’s start with a very simple example: using an iterator as a stream. Let’s
+start by creating a range of numbers, including every integer from 1 to 100,
+using the .. range operator. Then we can double all of those values with the
+map method, as Listing 17-36 shows:
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ });
+}
+Listing 17-36: Creating an iterator ranging over the values from 1 to 100
+
+
We can convert this iterator to a stream using the trpl::stream_from_iter
+function.
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let mut stream = trpl::stream_from_iter(iter);
+ });
+}
+Listing 17-37: Converting an iterator to a stream with trpl::stream_from_iter
+
+
This gives us the stream. Now, to work with it, we want to use the next method
+with a while let loop as described above, as in Listing 17-38:
+
+Filename: src/main.rs
+
fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let mut stream = trpl::stream_from_iter(iter);
+
+ while let Some(value) = stream.next().await {
+ println!("The value was: {value}");
+ }
+ });
+}
+Listing 17-38: Trying to use the next method on the newly-created stream
+
+
Unfortunately, this does not yet work. When we try to run the code, it does not
+compile. Instead, as we can see in the output, it reports that there is no
+next method available.
+
$ cargo run
+ Compiling proc-macro2 v1.0.85
+ Compiling unicode-ident v1.0.12
+ Compiling autocfg v1.3.0
+ Compiling pin-project-lite v0.2.14
+ Compiling futures-core v0.3.30
+ Compiling libc v0.2.155
+ Compiling futures-sink v0.3.30
+ Compiling futures-task v0.3.30
+ Compiling pin-utils v0.1.0
+ Compiling futures-io v0.3.30
+ Compiling memchr v2.7.4
+ Compiling futures-channel v0.3.30
+ Compiling slab v0.4.9
+ Compiling num_cpus v1.16.0
+ Compiling quote v1.0.36
+ Compiling tokio v1.38.0
+ Compiling syn v2.0.66
+ Compiling tokio-stream v0.1.15
+ Compiling futures-macro v0.3.30
+ Compiling futures-util v0.3.30
+ Compiling futures-executor v0.3.30
+ Compiling futures v0.3.30
+ Compiling trpl v0.1.0 (/Users/chris/dev/rust-lang/book/packages/trpl)
+ Compiling async_await v0.1.0 (/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-38)
+error[E0599]: no method named `next` found for struct `Iter` in the current scope
+ --> src/main.rs:8:40
+ |
+8 | while let Some(value) = stream.next().await {
+ | ^^^^
+ |
+ = note: the full type name has been written to '/Users/chris/dev/rust-lang/book/listings/ch17-async-await/listing-17-38/target/debug/deps/async_await-bbd5bb8f6851cb5f.long-type-17453505919820464996.txt'
+ = note: consider using `--verbose` to print the full type name to the console
+ = help: items from traits can only be used if the trait is in scope
+help: the following traits which provide `next` are implemented but not in scope; perhaps you want to import one of them
+ |
+1 + use futures_util::stream::stream::StreamExt;
+ |
+1 + use std::iter::Iterator;
+ |
+1 + use std::str::pattern::Searcher;
+ |
+1 + use trpl::StreamExt;
+ |
+help: there is a method `try_next` with a similar name
+ |
+8 | while let Some(value) = stream.try_next().await {
+ | ~~~~~~~~
+
+For more information about this error, try `rustc --explain E0599`.
+error: could not compile `async_await` (bin "async_await") due to 1 previous error
+
+
As the output suggests, the problem is that we need the right trait in scope to
+be able to use it. In this case, that trait is StreamExt. (The Ext there is
+for “extension”: this is a common pattern in the Rust community for extending
+one trait with another.) StreamExt is automatically implemented for every type
+which implements Stream, but they are separated out so that the community can
+iterate on the foundational trait distinctly from the convenience APIs. All we
+need to do, then, is add a use statement for trpl::StreamExt, as in Listing
+17-39.
+
+Filename: src/main.rs
+
use trpl::StreamExt;
+
+fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let mut stream = trpl::stream_from_iter(iter);
+
+ while let Some(value) = stream.next().await {
+ println!("The value was: {value}");
+ }
+ });
+}
+Listing 17-39: Successfully using an iterator as the basis for a stream
+
+
With all those pieces put together, things work the way we want! There is a lot
+of output, though, since we told it to print all of the 100 numbers in the
+iterator. We can filter that down, to, say, multiples of three and five by using
+the filter method, which conveniently also comes from StreamExt.
+
+Filename: src/main.rs
+
use trpl::StreamExt;
+
+fn main() {
+ trpl::block_on(async {
+ let values = 1..101;
+ let iter = values.map(|n| n * 2);
+ let stream = trpl::stream_from_iter(iter);
+
+ let mut filtered =
+ stream.filter(|value| value % 3 == 0 || value % 5 == 0);
+
+ while let Some(value) = filtered.next().await {
+ println!("The value was: {value}");
+ }
+ });
+}
+ Listing 17-40: Filtering a Stream with the StreamExt::filter method
+
+
Of course, in the real world, the only time we would be directly converting an
+iterator to a stream like this is to help break up longer chunks of work, like
+we discussed in the previous section. There are more interesting things we can
+do with streams, though!
For one thing, lots of things are naturally represented as streams—items
+becoming available in a queue over time, for example, or working with more data
+than can fit in a computer’s memory by only pulling chunks of it from the file
+system at a time, or data arriving over the network over time. For another
+thing, since streams are futures, we can use them with any other kind of
+future, and we can combine them in interesting ways.
+
In the real world, we can use this to do things like debounce events to avoid
+triggering too many network calls, set timeouts on sequences of long-running
+operations, or throttle user interface events to avoid doing needless work.
+Let’s start by building a little stream of messages. This is similar to what we
+might see from a WebSocket or some other real-time communication protocol. To
+begin, we will create a function, get_messages(), which returns impl Stream<Item = String>, and use a while let loop to print all the messages
+from the stream.
+Listing 17-41: Using the rx receiver as a ReceiverStream
+
+
In Listing 17-41, we also use a new type: ReceiverStream. This converts the
+rx receiver from the trpl::channel into a stream. This is pretty easy, since
+the API for a receiver like this already has the same basic shape as a Stream.
+
So far this will compile just fine, but we are not sending any messages, so
+nothing will happen when we run the program. We can change that by looping over
+the first ten letters of the English alphabet, and sending those across the
+channel.
+
+Filename: src/main.rs
+
use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let mut messages = get_messages();
+
+ while let Some(message) = messages.next().await {
+ println!("{message}");
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for message in messages {
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+
+ ReceiverStream::new(rx)
+}
+Listing 17-42: Sending messages through the channel to print
+
+
When we run the code in Listing 17-42, we get exactly the results we would
+expect:
Thus far, we have not seen anything we could not do with the regular recv API.
+Since this is a stream, though, we can do things like add a timeout which
+applies to every item in the stream, as in Listing 17-43.
+
+Filename: src/main.rs
+
use std::time::Duration;
+// --snip--
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+
+ let mut messages = get_messages().timeout(Duration::from_millis(200));
+
+ while let Some(result) = messages.next().await {
+ match result {
+ Ok(message) => println!("{message}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for message in messages {
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+
+ ReceiverStream::new(rx)
+}
+Listing 17-43: Using the StreamExt::timeout method to set a time limit on the items in a stream
+
+
First, we add a timeout to the stream itself, using the the timeout method,
+which is available on the stream because we already have StreamExt in scope.
+Second, we update the the while let loop because the stream now returns a
+Result, where the Ok variant indicates a message arrived in time and the
+Err variant indicates that the timeout elapsed before any message arrived. We
+can use a match to either print the message when we receive it successfully,
+or to notify about a problem if the timeout happened.
+
Unfortunately, this does not compile. It is our old friend Unpin again! Both
+the next() method and the await tell us that that type PhantomPin cannot
+be unpinned. (This PhantomPin is just a special type that the runtime is using
+to keep track of what needs to be pinned in a way that only shows up at
+compile time, but has no cost when actually running the program.) The solution
+is exactly the same as what we saw earlier in the chapter: to pin the messages
+with the pin macro. Once we add that, as in Listing 17-44, the program
+compiles again.
+
+Filename: src/main.rs
+
use std::{pin::pin, time::Duration};
+// --snip--
+
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let mut messages =
+ pin!(get_messages().timeout(Duration::from_millis(200)));
+
+ while let Some(result) = messages.next().await {
+ match result {
+ Ok(message) => println!("{message}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for message in messages {
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+
+ ReceiverStream::new(rx)
+}
+Listing 17-44: Pinning messages with the pin! macro to
+
+
However, since there are no delays between messages, this timeout does not
+change the behavior of the program yet. To see the timeout actually have an
+effect, we will add a delay to the messages we send. We will use the enumerate
+iterator method to get the index of the items we are sending, and apply a 100
+millisecond delay to even-index items and a 300 millisecond delay to odd-index
+items, to simulate the different delays we might see from a stream of messages
+in the real world.
+
+Filename: src/main.rs
+
use std::{pin::pin, time::Duration};
+
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let mut messages =
+ pin!(get_messages().timeout(Duration::from_millis(200)));
+
+ while let Some(result) = messages.next().await {
+ match result {
+ Ok(message) => println!("{message}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ trpl::spawn_task(async move {
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+ for (index, message) in messages.into_iter().enumerate() {
+ let time_to_sleep = if index % 2 == 0 { 100 } else { 300 };
+ trpl::sleep(Duration::from_millis(time_to_sleep)).await;
+
+ tx.send(format!("Message: '{message}'")).unwrap();
+ }
+ });
+
+ ReceiverStream::new(rx)
+}
+Listing 17-45: Sending messages through tx with an async delay without making get_messages an async function
+
+
To do that without blocking the get_messages function, we need to use async.
+However, we cannot just turn get_messages itself into an async function,
+because then we would return a Future<Output = Stream<Item = String>> instead
+of just a Stream<Item = String>>. In practical terms, we would end up sending
+all the messages and sleeping repeatedly before finally returning the receiver
+stream. The caller would end up getting all the messages immediately, without
+the sleep in between them, because the caller would not even be able to start
+processing the stream until all of the await points in get_messages had been
+hit.
+
Instead, we leave get_messages as a regular function which returns a stream,
+and spawn a task to handle the async sleep calls.
+
+
Note: calling spawn_task like this works because we already set up our
+runtime. Calling this particular implementation of spawn_taskwithout
+first setting up a runtime will cause a panic. Other implementations choose
+different tradeoffs: they might spawn a new runtime and so avoid the panic but
+end up with a bit of extra overhead, or simply not provide a standalone way to
+spawn tasks without reference to a runtime. You should make sure you know what
+tradeoff your runtime has chosen and write your code accordingly!
+
+
Now our code has a much more interesting result! Between the messages, we see an
+error reported: Problem: Elapsed(()). Notice that it does not prevent the
+messages from arriving in the end—we still get all of the original messages.
+This is because our channel is unbounded: it can hold as many messages as we can
+fit in memory. If the message does not arrive before the timeout, our stream
+handler will account for that, but when it polls the stream again, the message
+may now have arrived.
You can get different behavior if needed by using other kinds of channels, or
+other kinds of streams more generally. Let’s see one of those in practice in our
+final example for this section, by combining a stream of time intervals with
+this stream of messages.
First, let’s create another stream, called get_intervals, which will emit an
+item every millisecond if we let it run directly. For simplicity, we can use the
+sleep function to send a message on that delay, and combine it with the same
+approach of creating a stream from a channel that we used for get_messages.
+(There are, of course, many other ways to build streams, including some
+dedicated to working with intervals!) The difference is that this time, we are
+going to send back the count of intervals, rather than a string, so the
+resulting stream will have the type Stream<Item = u32>.
+
In Listing 17-46, we start by defining a count in the task. (We could define
+it outside the task, too, but it is clearer to limit the scope of any given
+variable.) Then we create a an infinite loop. Each iteration of the loop
+asynchronously sleeps for one millisecond, increments the count, and then sends
+it over the channel. Since this is all wrapped in the task created by
+spawn_task, all of it will get cleaned up along with the runtime, including
+the infinite loop.
+Listing 17-46: Creating a stream with a counter that will be emitted once every millisecond
+
+
This kind of infinite loop, which only ends when the whole runtime gets torn
+down, is a fairly common pattern when dealing with many different kinds of async
+operations in Rust. That is because there are many kinds of programs which need
+to keep running until something actually ends the program.
+
Now we need to use these intervals! Back in our main function’s async block, we
+start by getting the intervals. Then we can try to create a merged stream using
+messages and intervals, and loop over that combined stream instead of over
+messages (Listing 17-47). At this point, neither messages nor intervals
+needs to be pinned or mutable, because both will be combined into the single
+merged stream. However, this call to merge does not type check! (Neither
+does the next call in the while let loop, but we will come back to that
+after fixing this first.)
The problem is that our two streams have different types. The messages stream
+has the type Timeout<impl Stream<Item = String>>. The Timeout is the type
+which implements Stream for a timeout call! Meanwhile, the intervals stream has
+the type impl Stream<Item = u32>. To merge these two streams, we need to transform one of
+them to match the other. Let’s work with the intervals, since messages is
+already in the basic format we want and has to handle timeout errors.
+
Listing 17-48 shows the transformations we need. First, we can use the map
+helper method to transform the intervals into a string. Second, we need to
+match the Timeout from messages. Since we do not actually want a timeout
+for intervals, though, we can just create a timeout which is longer than the
+other durations we are using. Here, we create a 10-second time out with
+Duration::from_secs(10). Finally, we need to make merged both mutable, so
+that the while let loop’s next calls can iterate through the stream, and
+pinned, so that it is safe to do so.
That gets us almost to where we need to be. Everything type checks! If you run
+this, though, the messages from the English alphabet will be buried in the midst
+of all the interval counter messages:
This is no good; we need to only take some of those intervals—say, once every
+hundred milliseconds. For that, we can use the throttle method. Throttling is
+a way of limiting the rate at which a function will be called—or, in this case,
+how often the stream will be polled. We also don’t want to keep going
+indefinitely! We can use the take method to limit how many items we pull from
+a stream. In Listing 17-49, we apply throttle to the intervals stream,
+because we want to avoid overwhelming the stream of messages, but we apply the
+take method to the merged messages, because we want to limit the final
+output, not just one stream or the other.
There is one last thing we need to handle: errors! With both of these
+channel-based streams, the send calls could fail when the other side of the
+channel closes—and that is just a matter of how the runtime executes the futures
+which make up the stream. Up till now we have ignored this by calling unwrap,
+but in a well-behaved app, we should explicitly handle the error, at minimum by
+ending the loop so we do not try to send any more messages! Listing 17-50 shows
+a simple error strategy: print the issue and then break from the loops. As
+usual, the correct behavior on a message send error will vary—just make sure you
+do in fact have a strategy.
+Listing 17-50: Handling errors and shutting down the loops
+
+
Notice that we do not get Interval #100 or Interval #200 or so on, but
+instead simply get Interval #1, Interval #2, and so on—even though we have a
+source stream which can produce an event every millisecond. That is because
+the throttle call produces a new stream, wrapping the original stream, so that
+the original stream only gets polled at the throttle rate, not its own “native”
+rate. We do not have a bunch of unhandled interval messages we are simply
+choosing to ignore. Instead, we never produce those interval messages in the
+first place! This is the inherent “laziness” of Rust’s futures at work again,
+allowing us to choose our performance characteristics.
+
That is a good note to turn to our final section and wrap up this walk through
+async in Rust, by discussing how futures (including streams), tasks, and threads
+relate to each other, and how you can use them together.
As we saw in the previous chapter, threads provide one approach to concurrency.
+We have seen another approach to concurrency in this chapter, using async with
+futures and streams. You might be wondering why you would choose one or the
+other. The answer is: it depends! And in many cases, it is not threads vs.
+async but rather threads and async.
+
Threads are an older and more common tool for concurrency. Many operating
+systems have supplied threading-based concurrency models for decades now, and
+many programming languages have support for them as a result. However, they are
+not without their tradeoffs. On many operating systems, they use a fair bit of
+memory for each thread, and they come with some overhead for starting up and
+shutting down. Threads are also only an option when your operating system and
+hardware support them! Unlike mainstream desktop and mobile operating systems,
+many embedded operating systems, like those used on some microcontrollers, do
+not have OS-level threads at all.
+
The async model provides a different—and ultimately complementary—set of
+tradeoffs. In the async model, concurrent operations do not require their own
+threads. Instead, they can run on tasks, as when we used trpl::spawn_task to
+kick off work from a synchronous function throughout the streams section. A task
+is a lot like a thread—but instead of being managed by the operating system, it
+is managed by library-level code: the runtime.
+
In the previous section, we saw that we could build a Stream by using a
+channel and spawning an async task which we could call from synchronous code. We
+could do the exact same thing with a thread! We’ll use a simpler version of the
+streams example so we can focus on the differences. In Listing 17-50, we used
+trpl::spawn_task and trpl::sleep. In Listing 17-51, we replace those with
+the thread::spawn and thread::sleep APIs from the standard library, in just
+the get_intervals function.
+
+Filename: src/main.rs
+
use std::{pin::pin, time::Duration};
+
+use trpl::{ReceiverStream, Stream, StreamExt};
+
+fn main() {
+ trpl::block_on(async {
+ let messages = get_messages().timeout(Duration::from_millis(200));
+ let intervals = get_intervals()
+ .map(|count| format!("Interval #{count}"))
+ .throttle(Duration::from_millis(500))
+ .timeout(Duration::from_secs(10));
+
+ let mut merged = pin!(messages.merge(intervals).take(20));
+
+ while let Some(result) = merged.next().await {
+ match result {
+ Ok(item) => println!("{item}"),
+ Err(reason) => eprintln!("Problem: {reason:?}"),
+ }
+ }
+ })
+}
+
+fn get_messages() -> impl Stream<Item = String> {
+ let (tx, rx) = trpl::channel();
+
+ trpl::spawn_task(async move {
+ let messages = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j"];
+
+ for (index, message) in messages.into_iter().enumerate() {
+ let time_to_sleep = if index % 2 == 0 { 100 } else { 300 };
+ trpl::sleep(Duration::from_millis(time_to_sleep)).await;
+
+ if let Err(send_error) =
+ tx.send(format!("Message: '{message}' after {time_to_sleep}ms"))
+ {
+ eprintln!("Cannot send message '{message}': {send_error}");
+ break;
+ }
+ }
+ });
+
+ ReceiverStream::new(rx)
+}
+
+fn get_intervals() -> impl Stream<Item = u32> {
+ let (tx, rx) = trpl::channel();
+
+ trpl::spawn_task(async move {
+ let mut count = 0;
+ loop {
+ trpl::sleep(Duration::from_millis(1)).await;
+ count += 1;
+ if let Err(send_error) = tx.send(count) {
+ eprintln!("Could not send interval {count}: {send_error}");
+ break;
+ };
+ }
+ });
+
+ ReceiverStream::new(rx)
+}
+Listing 17-51: TODO
+
+
If you run this, the output is identical. And notice how little changes here
+from the perspective of the calling code! What is more, even though one of our
+functions spawned an async task on the runtime and the other spawned an
+operating system thread, they worked exactly the same way as far as processing
+the stream was concerned.
+
However, there is a meaningful difference in the way this system
+behaves, although we might have a hard time measuring it in this very simple
+example. We could spawn hundreds of thousands or even millions of async tasks on
+any modern personal computer. If we tried to do that with threads, we would
+literally run out of memory!
+
However, there is a reason these APIs are so similar. Threads act as a boundary
+for sets of synchronous operations; concurrency is possible between threads.
+Tasks act as a boundary for sets of asynchronous operations; concurrency is
+possible both between and within tasks. In that regard, tasks are kind of
+like lightweight, runtime-managed threads with added capabilities that come from
+being managed by a runtime instead of by the operating system.
+
However, this does not mean that async tasks are always better than threads, any
+more than that threads are always better than tasks.
+
On the one hand, concurrency with threads is in some ways a simpler programming
+model than concurrency with async. Threads are somewhat “fire and forget”, and
+they only allow interaction with the rest of the program via tools like channels
+or their final result via join. On the other hand, they have no native
+equivalent to a future, so they simply run to completion, without interruption
+except by the operating system itself. Threads also have no mechanisms for
+cancellation—a subject we have not covered in depth in this chapter, but which
+is implicit in the fact that whenever we ended a future, its state got cleaned
+up correctly.
+
These limitations make threads harder to compose than futures. It
+is much more difficult, for example, to build something like the timeout we
+built in “Building Our Own Async Abstractions”, or the
+throttle method we used with streams in “Working With Streams”. The fact
+that futures are richer data structures means they can be composed together
+more naturally, as we have seen.
+
Tasks then give additional control over futures, allowing you to choose where
+and how to group them. And it turns out that threads and tasks often work very
+well together, because tasks can (at least in some runtimes) be moved around
+between threads. We have not mentioned it up until now, but under the hood the
+Runtime we have been using, including the spawn_blocking and spawn_task
+functions, are multithreaded by default! Many runtimes can transparently move
+tasks around between threads based on the current utilization of the threads, to
+hopefully improve the overall performance of the system. To build that actually
+requires threads and tasks, and therefore futures.
Object-oriented programming (OOP) is a way of modeling programs. Objects as a
+programmatic concept were introduced in the programming language Simula in the
+1960s. Those objects influenced Alan Kay’s programming architecture in which
+objects pass messages to each other. To describe this architecture, he coined
+the term object-oriented programming in 1967. Many competing definitions
+describe what OOP is, and by some of these definitions Rust is object-oriented,
+but by others it is not. In this chapter, we’ll explore certain characteristics
+that are commonly considered object-oriented and how those characteristics
+translate to idiomatic Rust. We’ll then show you how to implement an
+object-oriented design pattern in Rust and discuss the trade-offs of doing so
+versus implementing a solution using some of Rust’s strengths instead.
There is no consensus in the programming community about what features a
+language must have to be considered object-oriented. Rust is influenced by many
+programming paradigms, including OOP; for example, we explored the features
+that came from functional programming in Chapter 13. Arguably, OOP languages
+share certain common characteristics, namely objects, encapsulation, and
+inheritance. Let’s look at what each of those characteristics means and whether
+Rust supports it.
The book Design Patterns: Elements of Reusable Object-Oriented Software by
+Erich Gamma, Richard Helm, Ralph Johnson, and John Vlissides (Addison-Wesley
+Professional, 1994), colloquially referred to as The Gang of Four book, is a
+catalog of object-oriented design patterns. It defines OOP this way:
+
+
Object-oriented programs are made up of objects. An object packages both
+data and the procedures that operate on that data. The procedures are
+typically called methods or operations.
+
+
Using this definition, Rust is object-oriented: structs and enums have data,
+and impl blocks provide methods on structs and enums. Even though structs and
+enums with methods aren’t called objects, they provide the same
+functionality, according to the Gang of Four’s definition of objects.
Another aspect commonly associated with OOP is the idea of encapsulation,
+which means that the implementation details of an object aren’t accessible to
+code using that object. Therefore, the only way to interact with an object is
+through its public API; code using the object shouldn’t be able to reach into
+the object’s internals and change data or behavior directly. This enables the
+programmer to change and refactor an object’s internals without needing to
+change the code that uses the object.
+
We discussed how to control encapsulation in Chapter 7: we can use the pub
+keyword to decide which modules, types, functions, and methods in our code
+should be public, and by default everything else is private. For example, we
+can define a struct AveragedCollection that has a field containing a vector
+of i32 values. The struct can also have a field that contains the average of
+the values in the vector, meaning the average doesn’t have to be computed
+on demand whenever anyone needs it. In other words, AveragedCollection will
+cache the calculated average for us. Listing 17-1 has the definition of the
+AveragedCollection struct:
Listing 17-1: An AveragedCollection struct that
+maintains a list of integers and the average of the items in the
+collection
+
The struct is marked pub so that other code can use it, but the fields within
+the struct remain private. This is important in this case because we want to
+ensure that whenever a value is added or removed from the list, the average is
+also updated. We do this by implementing add, remove, and average methods
+on the struct, as shown in Listing 17-2:
Listing 17-2: Implementations of the public methods
+add, remove, and average on AveragedCollection
+
The public methods add, remove, and average are the only ways to access
+or modify data in an instance of AveragedCollection. When an item is added
+to list using the add method or removed using the remove method, the
+implementations of each call the private update_average method that handles
+updating the average field as well.
+
We leave the list and average fields private so there is no way for
+external code to add or remove items to or from the list field directly;
+otherwise, the average field might become out of sync when the list
+changes. The average method returns the value in the average field,
+allowing external code to read the average but not modify it.
+
Because we’ve encapsulated the implementation details of the struct
+AveragedCollection, we can easily change aspects, such as the data structure,
+in the future. For instance, we could use a HashSet<i32> instead of a
+Vec<i32> for the list field. As long as the signatures of the add,
+remove, and average public methods stay the same, code using
+AveragedCollection wouldn’t need to change in order to compile. If we made
+list public instead, this wouldn’t necessarily be the case: HashSet<i32> and
+Vec<i32> have different methods for adding and removing items, so the external
+code would likely have to change if it were modifying list directly.
+
If encapsulation is a required aspect for a language to be considered
+object-oriented, then Rust meets that requirement. The option to use pub or
+not for different parts of code enables encapsulation of implementation details.
Inheritance is a mechanism whereby an object can inherit elements from
+another object’s definition, thus gaining the parent object’s data and behavior
+without you having to define them again.
+
If a language must have inheritance to be an object-oriented language, then
+Rust is not one. There is no way to define a struct that inherits the parent
+struct’s fields and method implementations without using a macro.
+
However, if you’re used to having inheritance in your programming toolbox, you
+can use other solutions in Rust, depending on your reason for reaching for
+inheritance in the first place.
+
You would choose inheritance for two main reasons. One is for reuse of code:
+you can implement particular behavior for one type, and inheritance enables you
+to reuse that implementation for a different type. You can do this in a limited
+way in Rust code using default trait method implementations, which you saw in
+Listing 10-14 when we added a default implementation of the summarize method
+on the Summary trait. Any type implementing the Summary trait would have
+the summarize method available on it without any further code. This is
+similar to a parent class having an implementation of a method and an
+inheriting child class also having the implementation of the method. We can
+also override the default implementation of the summarize method when we
+implement the Summary trait, which is similar to a child class overriding the
+implementation of a method inherited from a parent class.
+
The other reason to use inheritance relates to the type system: to enable a
+child type to be used in the same places as the parent type. This is also
+called polymorphism, which means that you can substitute multiple objects for
+each other at runtime if they share certain characteristics.
To many people, polymorphism is synonymous with inheritance. But it’s
+actually a more general concept that refers to code that can work with data
+of multiple types. For inheritance, those types are generally subclasses.
+
Rust instead uses generics to abstract over different possible types and
+trait bounds to impose constraints on what those types must provide. This is
+sometimes called bounded parametric polymorphism.
+
+
Inheritance has recently fallen out of favor as a programming design solution
+in many programming languages because it’s often at risk of sharing more code
+than necessary. Subclasses shouldn’t always share all characteristics of their
+parent class but will do so with inheritance. This can make a program’s design
+less flexible. It also introduces the possibility of calling methods on
+subclasses that don’t make sense or that cause errors because the methods don’t
+apply to the subclass. In addition, some languages will only allow single
+inheritance (meaning a subclass can only inherit from one class), further
+restricting the flexibility of a program’s design.
+
For these reasons, Rust takes the different approach of using trait objects
+instead of inheritance. Let’s look at how trait objects enable polymorphism in
+Rust.
In Chapter 8, we mentioned that one limitation of vectors is that they can
+store elements of only one type. We created a workaround in Listing 8-9 where
+we defined a SpreadsheetCell enum that had variants to hold integers, floats,
+and text. This meant we could store different types of data in each cell and
+still have a vector that represented a row of cells. This is a perfectly good
+solution when our interchangeable items are a fixed set of types that we know
+when our code is compiled.
+
However, sometimes we want our library user to be able to extend the set of
+types that are valid in a particular situation. To show how we might achieve
+this, we’ll create an example graphical user interface (GUI) tool that iterates
+through a list of items, calling a draw method on each one to draw it to the
+screen—a common technique for GUI tools. We’ll create a library crate called
+gui that contains the structure of a GUI library. This crate might include
+some types for people to use, such as Button or TextField. In addition,
+gui users will want to create their own types that can be drawn: for
+instance, one programmer might add an Image and another might add a
+SelectBox.
+
We won’t implement a fully fledged GUI library for this example but will show
+how the pieces would fit together. At the time of writing the library, we can’t
+know and define all the types other programmers might want to create. But we do
+know that gui needs to keep track of many values of different types, and it
+needs to call a draw method on each of these differently typed values. It
+doesn’t need to know exactly what will happen when we call the draw method,
+just that the value will have that method available for us to call.
+
To do this in a language with inheritance, we might define a class named
+Component that has a method named draw on it. The other classes, such as
+Button, Image, and SelectBox, would inherit from Component and thus
+inherit the draw method. They could each override the draw method to define
+their custom behavior, but the framework could treat all of the types as if
+they were Component instances and call draw on them. But because Rust
+doesn’t have inheritance, we need another way to structure the gui library to
+allow users to extend it with new types.
To implement the behavior we want gui to have, we’ll define a trait named
+Draw that will have one method named draw. Then we can define a vector that
+takes a trait object. A trait object points to both an instance of a type
+implementing our specified trait and a table used to look up trait methods on
+that type at runtime. We create a trait object by specifying some sort of
+pointer, such as a & reference or a Box<T> smart pointer, then the dyn
+keyword, and then specifying the relevant trait. (We’ll talk about the reason
+trait objects must use a pointer in Chapter 19 in the section “Dynamically
+Sized Types and the Sized Trait.”) We can
+use trait objects in place of a generic or concrete type. Wherever we use a
+trait object, Rust’s type system will ensure at compile time that any value
+used in that context will implement the trait object’s trait. Consequently, we
+don’t need to know all the possible types at compile time.
+
We’ve mentioned that, in Rust, we refrain from calling structs and enums
+“objects” to distinguish them from other languages’ objects. In a struct or
+enum, the data in the struct fields and the behavior in impl blocks are
+separated, whereas in other languages, the data and behavior combined into one
+concept is often labeled an object. However, trait objects are more like
+objects in other languages in the sense that they combine data and behavior.
+But trait objects differ from traditional objects in that we can’t add data to
+a trait object. Trait objects aren’t as generally useful as objects in other
+languages: their specific purpose is to allow abstraction across common
+behavior.
+
Listing 17-3 shows how to define a trait named Draw with one method named
+draw:
+
Filename: src/lib.rs
+
pub trait Draw {
+ fn draw(&self);
+}
+
Listing 17-3: Definition of the Draw trait
+
This syntax should look familiar from our discussions on how to define traits
+in Chapter 10. Next comes some new syntax: Listing 17-4 defines a struct named
+Screen that holds a vector named components. This vector is of type
+Box<dyn Draw>, which is a trait object; it’s a stand-in for any type inside
+a Box that implements the Draw trait.
Listing 17-5: A run method on Screen that calls the
+draw method on each component
+
This works differently from defining a struct that uses a generic type
+parameter with trait bounds. A generic type parameter can only be substituted
+with one concrete type at a time, whereas trait objects allow for multiple
+concrete types to fill in for the trait object at runtime. For example, we
+could have defined the Screen struct using a generic type and a trait bound
+as in Listing 17-6:
Listing 17-6: An alternate implementation of the Screen
+struct and its run method using generics and trait bounds
+
This restricts us to a Screen instance that has a list of components all of
+type Button or all of type TextField. If you’ll only ever have homogeneous
+collections, using generics and trait bounds is preferable because the
+definitions will be monomorphized at compile time to use the concrete types.
+
On the other hand, with the method using trait objects, one Screen instance
+can hold a Vec<T> that contains a Box<Button> as well as a
+Box<TextField>. Let’s look at how this works, and then we’ll talk about the
+runtime performance implications.
Now we’ll add some types that implement the Draw trait. We’ll provide the
+Button type. Again, actually implementing a GUI library is beyond the scope
+of this book, so the draw method won’t have any useful implementation in its
+body. To imagine what the implementation might look like, a Button struct
+might have fields for width, height, and label, as shown in Listing 17-7:
Listing 17-7: A Button struct that implements the
+Draw trait
+
The width, height, and label fields on Button will differ from the
+fields on other components; for example, a TextField type might have those
+same fields plus a placeholder field. Each of the types we want to draw on
+the screen will implement the Draw trait but will use different code in the
+draw method to define how to draw that particular type, as Button has here
+(without the actual GUI code, as mentioned). The Button type, for instance,
+might have an additional impl block containing methods related to what
+happens when a user clicks the button. These kinds of methods won’t apply to
+types like TextField.
+
If someone using our library decides to implement a SelectBox struct that has
+width, height, and options fields, they implement the Draw trait on the
+SelectBox type as well, as shown in Listing 17-8:
Listing 17-8: Another crate using gui and implementing
+the Draw trait on a SelectBox struct
+
Our library’s user can now write their main function to create a Screen
+instance. To the Screen instance, they can add a SelectBox and a Button
+by putting each in a Box<T> to become a trait object. They can then call the
+run method on the Screen instance, which will call draw on each of the
+components. Listing 17-9 shows this implementation:
Listing 17-9: Using trait objects to store values of
+different types that implement the same trait
+
When we wrote the library, we didn’t know that someone might add the
+SelectBox type, but our Screen implementation was able to operate on the
+new type and draw it because SelectBox implements the Draw trait, which
+means it implements the draw method.
+
This concept—of being concerned only with the messages a value responds to
+rather than the value’s concrete type—is similar to the concept of duck
+typing in dynamically typed languages: if it walks like a duck and quacks
+like a duck, then it must be a duck! In the implementation of run on Screen
+in Listing 17-5, run doesn’t need to know what the concrete type of each
+component is. It doesn’t check whether a component is an instance of a Button
+or a SelectBox, it just calls the draw method on the component. By
+specifying Box<dyn Draw> as the type of the values in the components
+vector, we’ve defined Screen to need values that we can call the draw
+method on.
+
The advantage of using trait objects and Rust’s type system to write code
+similar to code using duck typing is that we never have to check whether a
+value implements a particular method at runtime or worry about getting errors
+if a value doesn’t implement a method but we call it anyway. Rust won’t compile
+our code if the values don’t implement the traits that the trait objects need.
+
For example, Listing 17-10 shows what happens if we try to create a Screen
+with a String as a component:
Listing 17-10: Attempting to use a type that doesn’t
+implement the trait object’s trait
+
We’ll get this error because String doesn’t implement the Draw trait:
+
$ cargo run
+ Compiling gui v0.1.0 (file:///projects/gui)
+error[E0277]: the trait bound `String: Draw` is not satisfied
+ --> src/main.rs:5:26
+ |
+5 | components: vec![Box::new(String::from("Hi"))],
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `Draw` is not implemented for `String`
+ |
+ = help: the trait `Draw` is implemented for `Button`
+ = note: required for the cast from `Box<String>` to `Box<dyn Draw>`
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `gui` (bin "gui") due to 1 previous error
+
+
This error lets us know that either we’re passing something to Screen we
+didn’t mean to pass and so should pass a different type or we should implement
+Draw on String so that Screen is able to call draw on it.
Recall in the “Performance of Code Using
+Generics” section in
+Chapter 10 our discussion on the monomorphization process performed by the
+compiler when we use trait bounds on generics: the compiler generates
+nongeneric implementations of functions and methods for each concrete type that
+we use in place of a generic type parameter. The code that results from
+monomorphization is doing static dispatch, which is when the compiler knows
+what method you’re calling at compile time. This is opposed to dynamic
+dispatch, which is when the compiler can’t tell at compile time which method
+you’re calling. In dynamic dispatch cases, the compiler emits code that at
+runtime will figure out which method to call.
+
When we use trait objects, Rust must use dynamic dispatch. The compiler doesn’t
+know all the types that might be used with the code that’s using trait objects,
+so it doesn’t know which method implemented on which type to call. Instead, at
+runtime, Rust uses the pointers inside the trait object to know which method to
+call. This lookup incurs a runtime cost that doesn’t occur with static
+dispatch. Dynamic dispatch also prevents the compiler from choosing to inline a
+method’s code, which in turn prevents some optimizations. However, we did get
+extra flexibility in the code that we wrote in Listing 17-5 and were able to
+support in Listing 17-9, so it’s a trade-off to consider.
The state pattern is an object-oriented design pattern. The crux of the
+pattern is that we define a set of states a value can have internally. The
+states are represented by a set of state objects, and the value’s behavior
+changes based on its state. We’re going to work through an example of a blog
+post struct that has a field to hold its state, which will be a state object
+from the set “draft”, “review”, or “published”.
+
The state objects share functionality: in Rust, of course, we use structs and
+traits rather than objects and inheritance. Each state object is responsible
+for its own behavior and for governing when it should change into another
+state. The value that holds a state object knows nothing about the different
+behavior of the states or when to transition between states.
+
The advantage of using the state pattern is that, when the business
+requirements of the program change, we won’t need to change the code of the
+value holding the state or the code that uses the value. We’ll only need to
+update the code inside one of the state objects to change its rules or perhaps
+add more state objects.
+
First, we’re going to implement the state pattern in a more traditional
+object-oriented way, then we’ll use an approach that’s a bit more natural in
+Rust. Let’s dig in to incrementally implementing a blog post workflow using the
+state pattern.
+
The final functionality will look like this:
+
+
A blog post starts as an empty draft.
+
When the draft is done, a review of the post is requested.
+
When the post is approved, it gets published.
+
Only published blog posts return content to print, so unapproved posts can’t
+accidentally be published.
+
+
Any other changes attempted on a post should have no effect. For example, if we
+try to approve a draft blog post before we’ve requested a review, the post
+should remain an unpublished draft.
+
Listing 17-11 shows this workflow in code form: this is an example usage of the
+API we’ll implement in a library crate named blog. This won’t compile yet
+because we haven’t implemented the blog crate.
+
Filename: src/main.rs
+
use blog::Post;
+
+fn main() {
+ let mut post = Post::new();
+
+ post.add_text("I ate a salad for lunch today");
+ assert_eq!("", post.content());
+
+ post.request_review();
+ assert_eq!("", post.content());
+
+ post.approve();
+ assert_eq!("I ate a salad for lunch today", post.content());
+}
+
Listing 17-11: Code that demonstrates the desired
+behavior we want our blog crate to have
+
We want to allow the user to create a new draft blog post with Post::new. We
+want to allow text to be added to the blog post. If we try to get the post’s
+content immediately, before approval, we shouldn’t get any text because the
+post is still a draft. We’ve added assert_eq! in the code for demonstration
+purposes. An excellent unit test for this would be to assert that a draft blog
+post returns an empty string from the content method, but we’re not going to
+write tests for this example.
+
Next, we want to enable a request for a review of the post, and we want
+content to return an empty string while waiting for the review. When the post
+receives approval, it should get published, meaning the text of the post will
+be returned when content is called.
+
Notice that the only type we’re interacting with from the crate is the Post
+type. This type will use the state pattern and will hold a value that will be
+one of three state objects representing the various states a post can be
+in—draft, waiting for review, or published. Changing from one state to another
+will be managed internally within the Post type. The states change in
+response to the methods called by our library’s users on the Post instance,
+but they don’t have to manage the state changes directly. Also, users can’t
+make a mistake with the states, like publishing a post before it’s reviewed.
Let’s get started on the implementation of the library! We know we need a
+public Post struct that holds some content, so we’ll start with the
+definition of the struct and an associated public new function to create an
+instance of Post, as shown in Listing 17-12. We’ll also make a private
+State trait that will define the behavior that all state objects for a Post
+must have.
+
Then Post will hold a trait object of Box<dyn State> inside an Option<T>
+in a private field named state to hold the state object. You’ll see why the
+Option<T> is necessary in a bit.
+
Filename: src/lib.rs
+
pub struct Post {
+ state: Option<Box<dyn State>>,
+ content: String,
+}
+
+impl Post {
+ pub fn new() -> Post {
+ Post {
+ state: Some(Box::new(Draft {})),
+ content: String::new(),
+ }
+ }
+}
+
+trait State {}
+
+struct Draft {}
+
+impl State for Draft {}
+
Listing 17-12: Definition of a Post struct and a new
+function that creates a new Post instance, a State trait, and a Draft
+struct
+
The State trait defines the behavior shared by different post states. The
+state objects are Draft, PendingReview, and Published, and they will all
+implement the State trait. For now, the trait doesn’t have any methods, and
+we’ll start by defining just the Draft state because that is the state we
+want a post to start in.
+
When we create a new Post, we set its state field to a Some value that
+holds a Box. This Box points to a new instance of the Draft struct.
+This ensures whenever we create a new instance of Post, it will start out as
+a draft. Because the state field of Post is private, there is no way to
+create a Post in any other state! In the Post::new function, we set the
+content field to a new, empty String.
We saw in Listing 17-11 that we want to be able to call a method named
+add_text and pass it a &str that is then added as the text content of the
+blog post. We implement this as a method, rather than exposing the content
+field as pub, so that later we can implement a method that will control how
+the content field’s data is read. The add_text method is pretty
+straightforward, so let’s add the implementation in Listing 17-13 to the impl Post block:
+
Filename: src/lib.rs
+
pub struct Post {
+ state: Option<Box<dyn State>>,
+ content: String,
+}
+
+impl Post {
+ // --snip--
+ pub fn new() -> Post {
+ Post {
+ state: Some(Box::new(Draft {})),
+ content: String::new(),
+ }
+ }
+
+ pub fn add_text(&mut self, text: &str) {
+ self.content.push_str(text);
+ }
+}
+
+trait State {}
+
+struct Draft {}
+
+impl State for Draft {}
+
Listing 17-13: Implementing the add_text method to add
+text to a post’s content
+
The add_text method takes a mutable reference to self, because we’re
+changing the Post instance that we’re calling add_text on. We then call
+push_str on the String in content and pass the text argument to add to
+the saved content. This behavior doesn’t depend on the state the post is in,
+so it’s not part of the state pattern. The add_text method doesn’t interact
+with the state field at all, but it is part of the behavior we want to
+support.
Even after we’ve called add_text and added some content to our post, we still
+want the content method to return an empty string slice because the post is
+still in the draft state, as shown on line 7 of Listing 17-11. For now, let’s
+implement the content method with the simplest thing that will fulfill this
+requirement: always returning an empty string slice. We’ll change this later
+once we implement the ability to change a post’s state so it can be published.
+So far, posts can only be in the draft state, so the post content should always
+be empty. Listing 17-14 shows this placeholder implementation:
Next, we need to add functionality to request a review of a post, which should
+change its state from Draft to PendingReview. Listing 17-15 shows this code:
Listing 17-15: Implementing request_review methods on
+Post and the State trait
+
We give Post a public method named request_review that will take a mutable
+reference to self. Then we call an internal request_review method on the
+current state of Post, and this second request_review method consumes the
+current state and returns a new state.
+
We add the request_review method to the State trait; all types that
+implement the trait will now need to implement the request_review method.
+Note that rather than having self, &self, or &mut self as the first
+parameter of the method, we have self: Box<Self>. This syntax means the
+method is only valid when called on a Box holding the type. This syntax takes
+ownership of Box<Self>, invalidating the old state so the state value of the
+Post can transform into a new state.
+
To consume the old state, the request_review method needs to take ownership
+of the state value. This is where the Option in the state field of Post
+comes in: we call the take method to take the Some value out of the state
+field and leave a None in its place, because Rust doesn’t let us have
+unpopulated fields in structs. This lets us move the state value out of
+Post rather than borrowing it. Then we’ll set the post’s state value to the
+result of this operation.
+
We need to set state to None temporarily rather than setting it directly
+with code like self.state = self.state.request_review(); to get ownership of
+the state value. This ensures Post can’t use the old state value after
+we’ve transformed it into a new state.
+
The request_review method on Draft returns a new, boxed instance of a new
+PendingReview struct, which represents the state when a post is waiting for a
+review. The PendingReview struct also implements the request_review method
+but doesn’t do any transformations. Rather, it returns itself, because when we
+request a review on a post already in the PendingReview state, it should stay
+in the PendingReview state.
+
Now we can start seeing the advantages of the state pattern: the
+request_review method on Post is the same no matter its state value. Each
+state is responsible for its own rules.
+
We’ll leave the content method on Post as is, returning an empty string
+slice. We can now have a Post in the PendingReview state as well as in the
+Draft state, but we want the same behavior in the PendingReview state.
+Listing 17-11 now works up to line 10!
The approve method will be similar to the request_review method: it will
+set state to the value that the current state says it should have when that
+state is approved, as shown in Listing 17-16:
Listing 17-16: Implementing the approve method on
+Post and the State trait
+
We add the approve method to the State trait and add a new struct that
+implements State, the Published state.
+
Similar to the way request_review on PendingReview works, if we call the
+approve method on a Draft, it will have no effect because approve will
+return self. When we call approve on PendingReview, it returns a new,
+boxed instance of the Published struct. The Published struct implements the
+State trait, and for both the request_review method and the approve
+method, it returns itself, because the post should stay in the Published
+state in those cases.
+
Now we need to update the content method on Post. We want the value
+returned from content to depend on the current state of the Post, so we’re
+going to have the Post delegate to a content method defined on its state,
+as shown in Listing 17-17:
Listing 17-17: Updating the content method on Post to
+delegate to a content method on State
+
Because the goal is to keep all these rules inside the structs that implement
+State, we call a content method on the value in state and pass the post
+instance (that is, self) as an argument. Then we return the value that’s
+returned from using the content method on the state value.
+
We call the as_ref method on the Option because we want a reference to the
+value inside the Option rather than ownership of the value. Because state
+is an Option<Box<dyn State>>, when we call as_ref, an Option<&Box<dyn State>> is returned. If we didn’t call as_ref, we would get an error because
+we can’t move state out of the borrowed &self of the function parameter.
+
We then call the unwrap method, which we know will never panic, because we
+know the methods on Post ensure that state will always contain a Some
+value when those methods are done. This is one of the cases we talked about in
+the “Cases In Which You Have More Information Than the
+Compiler” section of Chapter 9 when we
+know that a None value is never possible, even though the compiler isn’t able
+to understand that.
+
At this point, when we call content on the &Box<dyn State>, deref coercion
+will take effect on the & and the Box so the content method will
+ultimately be called on the type that implements the State trait. That means
+we need to add content to the State trait definition, and that is where
+we’ll put the logic for what content to return depending on which state we
+have, as shown in Listing 17-18:
Listing 17-18: Adding the content method to the State
+trait
+
We add a default implementation for the content method that returns an empty
+string slice. That means we don’t need to implement content on the Draft
+and PendingReview structs. The Published struct will override the content
+method and return the value in post.content.
+
Note that we need lifetime annotations on this method, as we discussed in
+Chapter 10. We’re taking a reference to a post as an argument and returning a
+reference to part of that post, so the lifetime of the returned reference is
+related to the lifetime of the post argument.
+
And we’re done—all of Listing 17-11 now works! We’ve implemented the state
+pattern with the rules of the blog post workflow. The logic related to the
+rules lives in the state objects rather than being scattered throughout Post.
You may have been wondering why we didn’t use an enum with the different
+possible post states as variants. That’s certainly a possible solution, try
+it and compare the end results to see which you prefer! One disadvantage of
+using an enum is every place that checks the value of the enum will need a
+match expression or similar to handle every possible variant. This could
+get more repetitive than this trait object solution.
We’ve shown that Rust is capable of implementing the object-oriented state
+pattern to encapsulate the different kinds of behavior a post should have in
+each state. The methods on Post know nothing about the various behaviors. The
+way we organized the code, we have to look in only one place to know the
+different ways a published post can behave: the implementation of the State
+trait on the Published struct.
+
If we were to create an alternative implementation that didn’t use the state
+pattern, we might instead use match expressions in the methods on Post or
+even in the main code that checks the state of the post and changes behavior
+in those places. That would mean we would have to look in several places to
+understand all the implications of a post being in the published state! This
+would only increase the more states we added: each of those match expressions
+would need another arm.
+
With the state pattern, the Post methods and the places we use Post don’t
+need match expressions, and to add a new state, we would only need to add a
+new struct and implement the trait methods on that one struct.
+
The implementation using the state pattern is easy to extend to add more
+functionality. To see the simplicity of maintaining code that uses the state
+pattern, try a few of these suggestions:
+
+
Add a reject method that changes the post’s state from PendingReview back
+to Draft.
+
Require two calls to approve before the state can be changed to Published.
+
Allow users to add text content only when a post is in the Draft state.
+Hint: have the state object responsible for what might change about the
+content but not responsible for modifying the Post.
+
+
One downside of the state pattern is that, because the states implement the
+transitions between states, some of the states are coupled to each other. If we
+add another state between PendingReview and Published, such as Scheduled,
+we would have to change the code in PendingReview to transition to
+Scheduled instead. It would be less work if PendingReview didn’t need to
+change with the addition of a new state, but that would mean switching to
+another design pattern.
+
Another downside is that we’ve duplicated some logic. To eliminate some of the
+duplication, we might try to make default implementations for the
+request_review and approve methods on the State trait that return self;
+however, this would violate object safety, because the trait doesn’t know what
+the concrete self will be exactly. We want to be able to use State as a
+trait object, so we need its methods to be object safe.
+
Other duplication includes the similar implementations of the request_review
+and approve methods on Post. Both methods delegate to the implementation of
+the same method on the value in the state field of Option and set the new
+value of the state field to the result. If we had a lot of methods on Post
+that followed this pattern, we might consider defining a macro to eliminate the
+repetition (see the “Macros” section in Chapter 19).
+
By implementing the state pattern exactly as it’s defined for object-oriented
+languages, we’re not taking as full advantage of Rust’s strengths as we could.
+Let’s look at some changes we can make to the blog crate that can make
+invalid states and transitions into compile time errors.
We’ll show you how to rethink the state pattern to get a different set of
+trade-offs. Rather than encapsulating the states and transitions completely so
+outside code has no knowledge of them, we’ll encode the states into different
+types. Consequently, Rust’s type checking system will prevent attempts to use
+draft posts where only published posts are allowed by issuing a compiler error.
+
Let’s consider the first part of main in Listing 17-11:
+
Filename: src/main.rs
+
use blog::Post;
+
+fn main() {
+ let mut post = Post::new();
+
+ post.add_text("I ate a salad for lunch today");
+ assert_eq!("", post.content());
+
+ post.request_review();
+ assert_eq!("", post.content());
+
+ post.approve();
+ assert_eq!("I ate a salad for lunch today", post.content());
+}
+
We still enable the creation of new posts in the draft state using Post::new
+and the ability to add text to the post’s content. But instead of having a
+content method on a draft post that returns an empty string, we’ll make it so
+draft posts don’t have the content method at all. That way, if we try to get
+a draft post’s content, we’ll get a compiler error telling us the method
+doesn’t exist. As a result, it will be impossible for us to accidentally
+display draft post content in production, because that code won’t even compile.
+Listing 17-19 shows the definition of a Post struct and a DraftPost struct,
+as well as methods on each:
Listing 17-19: A Post with a content method and a
+DraftPost without a content method
+
Both the Post and DraftPost structs have a private content field that
+stores the blog post text. The structs no longer have the state field because
+we’re moving the encoding of the state to the types of the structs. The Post
+struct will represent a published post, and it has a content method that
+returns the content.
+
We still have a Post::new function, but instead of returning an instance of
+Post, it returns an instance of DraftPost. Because content is private
+and there aren’t any functions that return Post, it’s not possible to create
+an instance of Post right now.
+
The DraftPost struct has an add_text method, so we can add text to
+content as before, but note that DraftPost does not have a content method
+defined! So now the program ensures all posts start as draft posts, and draft
+posts don’t have their content available for display. Any attempt to get around
+these constraints will result in a compiler error.
So how do we get a published post? We want to enforce the rule that a draft
+post has to be reviewed and approved before it can be published. A post in the
+pending review state should still not display any content. Let’s implement
+these constraints by adding another struct, PendingReviewPost, defining the
+request_review method on DraftPost to return a PendingReviewPost, and
+defining an approve method on PendingReviewPost to return a Post, as
+shown in Listing 17-20:
Listing 17-20: A PendingReviewPost that gets created by
+calling request_review on DraftPost and an approve method that turns a
+PendingReviewPost into a published Post
+
The request_review and approve methods take ownership of self, thus
+consuming the DraftPost and PendingReviewPost instances and transforming
+them into a PendingReviewPost and a published Post, respectively. This way,
+we won’t have any lingering DraftPost instances after we’ve called
+request_review on them, and so forth. The PendingReviewPost struct doesn’t
+have a content method defined on it, so attempting to read its content
+results in a compiler error, as with DraftPost. Because the only way to get a
+published Post instance that does have a content method defined is to call
+the approve method on a PendingReviewPost, and the only way to get a
+PendingReviewPost is to call the request_review method on a DraftPost,
+we’ve now encoded the blog post workflow into the type system.
+
But we also have to make some small changes to main. The request_review and
+approve methods return new instances rather than modifying the struct they’re
+called on, so we need to add more let post = shadowing assignments to save
+the returned instances. We also can’t have the assertions about the draft and
+pending review posts’ contents be empty strings, nor do we need them: we can’t
+compile code that tries to use the content of posts in those states any longer.
+The updated code in main is shown in Listing 17-21:
+
Filename: src/main.rs
+
use blog::Post;
+
+fn main() {
+ let mut post = Post::new();
+
+ post.add_text("I ate a salad for lunch today");
+
+ let post = post.request_review();
+
+ let post = post.approve();
+
+ assert_eq!("I ate a salad for lunch today", post.content());
+}
+
Listing 17-21: Modifications to main to use the new
+implementation of the blog post workflow
+
The changes we needed to make to main to reassign post mean that this
+implementation doesn’t quite follow the object-oriented state pattern anymore:
+the transformations between the states are no longer encapsulated entirely
+within the Post implementation. However, our gain is that invalid states are
+now impossible because of the type system and the type checking that happens at
+compile time! This ensures that certain bugs, such as display of the content of
+an unpublished post, will be discovered before they make it to production.
+
Try the tasks suggested at the start of this section on the blog crate as it
+is after Listing 17-21 to see what you think about the design of this version
+of the code. Note that some of the tasks might be completed already in this
+design.
+
We’ve seen that even though Rust is capable of implementing object-oriented
+design patterns, other patterns, such as encoding state into the type system,
+are also available in Rust. These patterns have different trade-offs. Although
+you might be very familiar with object-oriented patterns, rethinking the
+problem to take advantage of Rust’s features can provide benefits, such as
+preventing some bugs at compile time. Object-oriented patterns won’t always be
+the best solution in Rust due to certain features, like ownership, that
+object-oriented languages don’t have.
No matter whether or not you think Rust is an object-oriented language after
+reading this chapter, you now know that you can use trait objects to get some
+object-oriented features in Rust. Dynamic dispatch can give your code some
+flexibility in exchange for a bit of runtime performance. You can use this
+flexibility to implement object-oriented patterns that can help your code’s
+maintainability. Rust also has other features, like ownership, that
+object-oriented languages don’t have. An object-oriented pattern won’t always
+be the best way to take advantage of Rust’s strengths, but is an available
+option.
+
Next, we’ll look at patterns, which are another of Rust’s features that enable
+lots of flexibility. We’ve looked at them briefly throughout the book but
+haven’t seen their full capability yet. Let’s go!
Patterns are a special syntax in Rust for matching against the structure of
+types, both complex and simple. Using patterns in conjunction with match
+expressions and other constructs gives you more control over a program’s
+control flow. A pattern consists of some combination of the following:
+
+
Literals
+
Destructured arrays, enums, structs, or tuples
+
Variables
+
Wildcards
+
Placeholders
+
+
Some example patterns include x, (a, 3), and Some(Color::Red). In the
+contexts in which patterns are valid, these components describe the shape of
+data. Our program then matches values against the patterns to determine whether
+it has the correct shape of data to continue running a particular piece of code.
+
To use a pattern, we compare it to some value. If the pattern matches the
+value, we use the value parts in our code. Recall the match expressions in
+Chapter 6 that used patterns, such as the coin-sorting machine example. If the
+value fits the shape of the pattern, we can use the named pieces. If it
+doesn’t, the code associated with the pattern won’t run.
+
This chapter is a reference on all things related to patterns. We’ll cover the
+valid places to use patterns, the difference between refutable and irrefutable
+patterns, and the different kinds of pattern syntax that you might see. By the
+end of the chapter, you’ll know how to use patterns to express many concepts in
+a clear way.
Patterns pop up in a number of places in Rust, and you’ve been using them a lot
+without realizing it! This section discusses all the places where patterns are
+valid.
As discussed in Chapter 6, we use patterns in the arms of match expressions.
+Formally, match expressions are defined as the keyword match, a value to
+match on, and one or more match arms that consist of a pattern and an
+expression to run if the value matches that arm’s pattern, like this:
+
match VALUE {
+ PATTERN => EXPRESSION,
+ PATTERN => EXPRESSION,
+ PATTERN => EXPRESSION,
+}
+
+
For example, here’s the match expression from Listing 6-5 that matches on an
+Option<i32> value in the variable x:
+
match x {
+ None => None,
+ Some(i) => Some(i + 1),
+}
+
The patterns in this match expression are the None and Some(i) on the
+left of each arrow.
+
One requirement for match expressions is that they need to be exhaustive in
+the sense that all possibilities for the value in the match expression must
+be accounted for. One way to ensure you’ve covered every possibility is to have
+a catchall pattern for the last arm: for example, a variable name matching any
+value can never fail and thus covers every remaining case.
+
The particular pattern _ will match anything, but it never binds to a
+variable, so it’s often used in the last match arm. The _ pattern can be
+useful when you want to ignore any value not specified, for example. We’ll
+cover the _ pattern in more detail in the “Ignoring Values in a
+Pattern” section later in this
+chapter.
In Chapter 6 we discussed how to use if let expressions mainly as a shorter
+way to write the equivalent of a match that only matches one case.
+Optionally, if let can have a corresponding else containing code to run if
+the pattern in the if let doesn’t match.
+
Listing 18-1 shows that it’s also possible to mix and match if let, else if, and else if let expressions. Doing so gives us more flexibility than a
+match expression in which we can express only one value to compare with the
+patterns. Also, Rust doesn’t require that the conditions in a series of if let, else if, else if let arms relate to each other.
+
The code in Listing 18-1 determines what color to make your background based on
+a series of checks for several conditions. For this example, we’ve created
+variables with hardcoded values that a real program might receive from user
+input.
+
Filename: src/main.rs
+
fn main() {
+ let favorite_color: Option<&str> = None;
+ let is_tuesday = false;
+ let age: Result<u8, _> = "34".parse();
+
+ if let Some(color) = favorite_color {
+ println!("Using your favorite color, {color}, as the background");
+ } else if is_tuesday {
+ println!("Tuesday is green day!");
+ } else if let Ok(age) = age {
+ if age > 30 {
+ println!("Using purple as the background color");
+ } else {
+ println!("Using orange as the background color");
+ }
+ } else {
+ println!("Using blue as the background color");
+ }
+}
+
Listing 18-1: Mixing if let, else if, else if let,
+and else
+
If the user specifies a favorite color, that color is used as the background.
+If no favorite color is specified and today is Tuesday, the background color is
+green. Otherwise, if the user specifies their age as a string and we can parse
+it as a number successfully, the color is either purple or orange depending on
+the value of the number. If none of these conditions apply, the background
+color is blue.
+
This conditional structure lets us support complex requirements. With the
+hardcoded values we have here, this example will print Using purple as the background color.
+
You can see that if let can also introduce shadowed variables in the same way
+that match arms can: the line if let Ok(age) = age introduces a new
+shadowed age variable that contains the value inside the Ok variant. This
+means we need to place the if age > 30 condition within that block: we can’t
+combine these two conditions into if let Ok(age) = age && age > 30. The
+shadowed age we want to compare to 30 isn’t valid until the new scope starts
+with the curly bracket.
+
The downside of using if let expressions is that the compiler doesn’t check
+for exhaustiveness, whereas with match expressions it does. If we omitted the
+last else block and therefore missed handling some cases, the compiler would
+not alert us to the possible logic bug.
Similar in construction to if let, the while let conditional loop allows a
+while loop to run for as long as a pattern continues to match. In Listing
+18-2 we code a while let loop that uses a vector as a stack and prints the
+values in the vector in the opposite order in which they were pushed.
+
fn main() {
+ let mut stack = Vec::new();
+
+ stack.push(1);
+ stack.push(2);
+ stack.push(3);
+
+ while let Some(top) = stack.pop() {
+ println!("{top}");
+ }
+}
+
Listing 18-2: Using a while let loop to print values
+for as long as stack.pop() returns Some
+
This example prints 3, 2, and then 1. The pop method takes the last element
+out of the vector and returns Some(value). If the vector is empty, pop
+returns None. The while loop continues running the code in its block as
+long as pop returns Some. When pop returns None, the loop stops. We can
+use while let to pop every element off our stack.
In a for loop, the value that directly follows the keyword for is a
+pattern. For example, in for x in y the x is the pattern. Listing 18-3
+demonstrates how to use a pattern in a for loop to destructure, or break
+apart, a tuple as part of the for loop.
+
fn main() {
+ let v = vec!['a', 'b', 'c'];
+
+ for (index, value) in v.iter().enumerate() {
+ println!("{value} is at index {index}");
+ }
+}
+
Listing 18-3: Using a pattern in a for loop to
+destructure a tuple
+
The code in Listing 18-3 will print the following:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.52s
+ Running `target/debug/patterns`
+a is at index 0
+b is at index 1
+c is at index 2
+
+
We adapt an iterator using the enumerate method so it produces a value and
+the index for that value, placed into a tuple. The first value produced is the
+tuple (0, 'a'). When this value is matched to the pattern (index, value),
+index will be 0 and value will be 'a', printing the first line of the
+output.
Prior to this chapter, we had only explicitly discussed using patterns with
+match and if let, but in fact, we’ve used patterns in other places as well,
+including in let statements. For example, consider this straightforward
+variable assignment with let:
+
#![allow(unused)]
+fn main() {
+let x = 5;
+}
+
Every time you’ve used a let statement like this you’ve been using patterns,
+although you might not have realized it! More formally, a let statement looks
+like this:
+
let PATTERN = EXPRESSION;
+
+
In statements like let x = 5; with a variable name in the PATTERN slot, the
+variable name is just a particularly simple form of a pattern. Rust compares
+the expression against the pattern and assigns any names it finds. So in the
+let x = 5; example, x is a pattern that means “bind what matches here to
+the variable x.” Because the name x is the whole pattern, this pattern
+effectively means “bind everything to the variable x, whatever the value is.”
+
To see the pattern matching aspect of let more clearly, consider Listing
+18-4, which uses a pattern with let to destructure a tuple.
+
fn main() {
+ let (x, y, z) = (1, 2, 3);
+}
+
Listing 18-4: Using a pattern to destructure a tuple and
+create three variables at once
+
Here, we match a tuple against a pattern. Rust compares the value (1, 2, 3)
+to the pattern (x, y, z) and sees that the value matches the pattern, so Rust
+binds 1 to x, 2 to y, and 3 to z. You can think of this tuple
+pattern as nesting three individual variable patterns inside it.
+
If the number of elements in the pattern doesn’t match the number of elements
+in the tuple, the overall type won’t match and we’ll get a compiler error. For
+example, Listing 18-5 shows an attempt to destructure a tuple with three
+elements into two variables, which won’t work.
+
fn main() {
+ let (x, y) = (1, 2, 3);
+}
+
Listing 18-5: Incorrectly constructing a pattern whose
+variables don’t match the number of elements in the tuple
+
Attempting to compile this code results in this type error:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+error[E0308]: mismatched types
+ --> src/main.rs:2:9
+ |
+2 | let (x, y) = (1, 2, 3);
+ | ^^^^^^ --------- this expression has type `({integer}, {integer}, {integer})`
+ | |
+ | expected a tuple with 3 elements, found one with 2 elements
+ |
+ = note: expected tuple `({integer}, {integer}, {integer})`
+ found tuple `(_, _)`
+
+For more information about this error, try `rustc --explain E0308`.
+error: could not compile `patterns` (bin "patterns") due to 1 previous error
+
+
To fix the error, we could ignore one or more of the values in the tuple using
+_ or .., as you’ll see in the “Ignoring Values in a
+Pattern” section. If the problem
+is that we have too many variables in the pattern, the solution is to make the
+types match by removing variables so the number of variables equals the number
+of elements in the tuple.
Function parameters can also be patterns. The code in Listing 18-6, which
+declares a function named foo that takes one parameter named x of type
+i32, should by now look familiar.
Listing 18-6: A function signature uses patterns in the
+parameters
+
The x part is a pattern! As we did with let, we could match a tuple in a
+function’s arguments to the pattern. Listing 18-7 splits the values in a tuple
+as we pass it to a function.
Listing 18-7: A function with parameters that destructure
+a tuple
+
This code prints Current location: (3, 5). The values &(3, 5) match the
+pattern &(x, y), so x is the value 3 and y is the value 5.
+
We can also use patterns in closure parameter lists in the same way as in
+function parameter lists, because closures are similar to functions, as
+discussed in Chapter 13.
+
At this point, you’ve seen several ways of using patterns, but patterns don’t
+work the same in every place we can use them. In some places, the patterns must
+be irrefutable; in other circumstances, they can be refutable. We’ll discuss
+these two concepts next.
Patterns come in two forms: refutable and irrefutable. Patterns that will match
+for any possible value passed are irrefutable. An example would be x in the
+statement let x = 5; because x matches anything and therefore cannot fail
+to match. Patterns that can fail to match for some possible value are
+refutable. An example would be Some(x) in the expression if let Some(x) = a_value because if the value in the a_value variable is None rather than
+Some, the Some(x) pattern will not match.
+
Function parameters, let statements, and for loops can only accept
+irrefutable patterns, because the program cannot do anything meaningful when
+values don’t match. The if let and while let expressions accept
+refutable and irrefutable patterns, but the compiler warns against
+irrefutable patterns because by definition they’re intended to handle possible
+failure: the functionality of a conditional is in its ability to perform
+differently depending on success or failure.
+
In general, you shouldn’t have to worry about the distinction between refutable
+and irrefutable patterns; however, you do need to be familiar with the concept
+of refutability so you can respond when you see it in an error message. In
+those cases, you’ll need to change either the pattern or the construct you’re
+using the pattern with, depending on the intended behavior of the code.
+
Let’s look at an example of what happens when we try to use a refutable pattern
+where Rust requires an irrefutable pattern and vice versa. Listing 18-8 shows a
+let statement, but for the pattern we’ve specified Some(x), a refutable
+pattern. As you might expect, this code will not compile.
+
fn main() {
+ let some_option_value: Option<i32> = None;
+ let Some(x) = some_option_value;
+}
+
Listing 18-8: Attempting to use a refutable pattern with
+let
+
If some_option_value was a None value, it would fail to match the pattern
+Some(x), meaning the pattern is refutable. However, the let statement can
+only accept an irrefutable pattern because there is nothing valid the code can
+do with a None value. At compile time, Rust will complain that we’ve tried to
+use a refutable pattern where an irrefutable pattern is required:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+error[E0005]: refutable pattern in local binding
+ --> src/main.rs:3:9
+ |
+3 | let Some(x) = some_option_value;
+ | ^^^^^^^ pattern `None` not covered
+ |
+ = note: `let` bindings require an "irrefutable pattern", like a `struct` or an `enum` with only one variant
+ = note: for more information, visit https://doc.rust-lang.org/book/ch18-02-refutability.html
+ = note: the matched value is of type `Option<i32>`
+help: you might want to use `let else` to handle the variant that isn't matched
+ |
+3 | let Some(x) = some_option_value else { todo!() };
+ | ++++++++++++++++
+
+For more information about this error, try `rustc --explain E0005`.
+error: could not compile `patterns` (bin "patterns") due to 1 previous error
+
+
Because we didn’t cover (and couldn’t cover!) every valid value with the
+pattern Some(x), Rust rightfully produces a compiler error.
+
If we have a refutable pattern where an irrefutable pattern is needed, we can
+fix it by changing the code that uses the pattern: instead of using let, we
+can use if let. Then if the pattern doesn’t match, the code will just skip
+the code in the curly brackets, giving it a way to continue validly. Listing
+18-9 shows how to fix the code in Listing 18-8.
+
fn main() {
+ let some_option_value: Option<i32> = None;
+ if let Some(x) = some_option_value {
+ println!("{x}");
+ }
+}
+
Listing 18-9: Using if let and a block with refutable
+patterns instead of let
+
We’ve given the code an out! This code is perfectly valid now. However,
+if we give if let an irrefutable pattern (a pattern that will always
+match), such as x, as shown in Listing 18-10, the compiler will give a
+warning.
+
fn main() {
+ if let x = 5 {
+ println!("{x}");
+ };
+}
+
Listing 18-10: Attempting to use an irrefutable pattern
+with if let
+
Rust complains that it doesn’t make sense to use if let with an irrefutable
+pattern:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+warning: irrefutable `if let` pattern
+ --> src/main.rs:2:8
+ |
+2 | if let x = 5 {
+ | ^^^^^^^^^
+ |
+ = note: this pattern will always match, so the `if let` is useless
+ = help: consider replacing the `if let` with a `let`
+ = note: `#[warn(irrefutable_let_patterns)]` on by default
+
+warning: `patterns` (bin "patterns") generated 1 warning
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.39s
+ Running `target/debug/patterns`
+5
+
+
For this reason, match arms must use refutable patterns, except for the last
+arm, which should match any remaining values with an irrefutable pattern. Rust
+allows us to use an irrefutable pattern in a match with only one arm, but
+this syntax isn’t particularly useful and could be replaced with a simpler
+let statement.
+
Now that you know where to use patterns and the difference between refutable
+and irrefutable patterns, let’s cover all the syntax we can use to create
+patterns.
As you saw in Chapter 6, you can match patterns against literals directly. The
+following code gives some examples:
+
fn main() {
+ let x = 1;
+
+ match x {
+ 1 => println!("one"),
+ 2 => println!("two"),
+ 3 => println!("three"),
+ _ => println!("anything"),
+ }
+}
+
This code prints one because the value in x is 1. This syntax is useful
+when you want your code to take an action if it gets a particular concrete
+value.
Named variables are irrefutable patterns that match any value, and we’ve used
+them many times in the book. However, there is a complication when you use
+named variables in match expressions. Because match starts a new scope,
+variables declared as part of a pattern inside the match expression will
+shadow those with the same name outside the match construct, as is the case
+with all variables. In Listing 18-11, we declare a variable named x with the
+value Some(5) and a variable y with the value 10. We then create a
+match expression on the value x. Look at the patterns in the match arms and
+println! at the end, and try to figure out what the code will print before
+running this code or reading further.
+
Filename: src/main.rs
+
fn main() {
+ let x = Some(5);
+ let y = 10;
+
+ match x {
+ Some(50) => println!("Got 50"),
+ Some(y) => println!("Matched, y = {y}"),
+ _ => println!("Default case, x = {x:?}"),
+ }
+
+ println!("at the end: x = {x:?}, y = {y}");
+}
+
Listing 18-11: A match expression with an arm that
+introduces a shadowed variable y
+
Let’s walk through what happens when the match expression runs. The pattern
+in the first match arm doesn’t match the defined value of x, so the code
+continues.
+
The pattern in the second match arm introduces a new variable named y that
+will match any value inside a Some value. Because we’re in a new scope inside
+the match expression, this is a new y variable, not the y we declared at
+the beginning with the value 10. This new y binding will match any value
+inside a Some, which is what we have in x. Therefore, this new y binds to
+the inner value of the Some in x. That value is 5, so the expression for
+that arm executes and prints Matched, y = 5.
+
If x had been a None value instead of Some(5), the patterns in the first
+two arms wouldn’t have matched, so the value would have matched to the
+underscore. We didn’t introduce the x variable in the pattern of the
+underscore arm, so the x in the expression is still the outer x that hasn’t
+been shadowed. In this hypothetical case, the match would print Default case, x = None.
+
When the match expression is done, its scope ends, and so does the scope of
+the inner y. The last println! produces at the end: x = Some(5), y = 10.
+
To create a match expression that compares the values of the outer x and
+y, rather than introducing a shadowed variable, we would need to use a match
+guard conditional instead. We’ll talk about match guards later in the “Extra
+Conditionals with Match Guards” section.
In match expressions, you can match multiple patterns using the | syntax,
+which is the pattern or operator. For example, in the following code we match
+the value of x against the match arms, the first of which has an or option,
+meaning if the value of x matches either of the values in that arm, that
+arm’s code will run:
+
fn main() {
+ let x = 1;
+
+ match x {
+ 1 | 2 => println!("one or two"),
+ 3 => println!("three"),
+ _ => println!("anything"),
+ }
+}
The ..= syntax allows us to match to an inclusive range of values. In the
+following code, when a pattern matches any of the values within the given
+range, that arm will execute:
+
fn main() {
+ let x = 5;
+
+ match x {
+ 1..=5 => println!("one through five"),
+ _ => println!("something else"),
+ }
+}
+
If x is 1, 2, 3, 4, or 5, the first arm will match. This syntax is more
+convenient for multiple match values than using the | operator to express the
+same idea; if we were to use | we would have to specify 1 | 2 | 3 | 4 | 5.
+Specifying a range is much shorter, especially if we want to match, say, any
+number between 1 and 1,000!
+
The compiler checks that the range isn’t empty at compile time, and because the
+only types for which Rust can tell if a range is empty or not are char and
+numeric values, ranges are only allowed with numeric or char values.
+
Here is an example using ranges of char values:
+
fn main() {
+ let x = 'c';
+
+ match x {
+ 'a'..='j' => println!("early ASCII letter"),
+ 'k'..='z' => println!("late ASCII letter"),
+ _ => println!("something else"),
+ }
+}
+
Rust can tell that 'c' is within the first pattern’s range and prints early ASCII letter.
Listing 18-12 shows a Point struct with two fields, x and y, that we can
+break apart using a pattern with a let statement.
+
Filename: src/main.rs
+
struct Point {
+ x: i32,
+ y: i32,
+}
+
+fn main() {
+ let p = Point { x: 0, y: 7 };
+
+ let Point { x: a, y: b } = p;
+ assert_eq!(0, a);
+ assert_eq!(7, b);
+}
+
Listing 18-12: Destructuring a struct’s fields into
+separate variables
+
This code creates the variables a and b that match the values of the x
+and y fields of the p struct. This example shows that the names of the
+variables in the pattern don’t have to match the field names of the struct.
+However, it’s common to match the variable names to the field names to make it
+easier to remember which variables came from which fields. Because of this
+common usage, and because writing let Point { x: x, y: y } = p; contains a
+lot of duplication, Rust has a shorthand for patterns that match struct fields:
+you only need to list the name of the struct field, and the variables created
+from the pattern will have the same names. Listing 18-13 behaves in the same
+way as the code in Listing 18-12, but the variables created in the let
+pattern are x and y instead of a and b.
+
Filename: src/main.rs
+
struct Point {
+ x: i32,
+ y: i32,
+}
+
+fn main() {
+ let p = Point { x: 0, y: 7 };
+
+ let Point { x, y } = p;
+ assert_eq!(0, x);
+ assert_eq!(7, y);
+}
+
Listing 18-13: Destructuring struct fields using struct
+field shorthand
+
This code creates the variables x and y that match the x and y fields
+of the p variable. The outcome is that the variables x and y contain the
+values from the p struct.
+
We can also destructure with literal values as part of the struct pattern
+rather than creating variables for all the fields. Doing so allows us to test
+some of the fields for particular values while creating variables to
+destructure the other fields.
+
In Listing 18-14, we have a match expression that separates Point values
+into three cases: points that lie directly on the x axis (which is true when
+y = 0), on the y axis (x = 0), or neither.
+
Filename: src/main.rs
+
struct Point {
+ x: i32,
+ y: i32,
+}
+
+fn main() {
+ let p = Point { x: 0, y: 7 };
+
+ match p {
+ Point { x, y: 0 } => println!("On the x axis at {x}"),
+ Point { x: 0, y } => println!("On the y axis at {y}"),
+ Point { x, y } => {
+ println!("On neither axis: ({x}, {y})");
+ }
+ }
+}
+
Listing 18-14: Destructuring and matching literal values
+in one pattern
+
The first arm will match any point that lies on the x axis by specifying that
+the y field matches if its value matches the literal 0. The pattern still
+creates an x variable that we can use in the code for this arm.
+
Similarly, the second arm matches any point on the y axis by specifying that
+the x field matches if its value is 0 and creates a variable y for the
+value of the y field. The third arm doesn’t specify any literals, so it
+matches any other Point and creates variables for both the x and y fields.
+
In this example, the value p matches the second arm by virtue of x
+containing a 0, so this code will print On the y axis at 7.
+
Remember that a match expression stops checking arms once it has found the
+first matching pattern, so even though Point { x: 0, y: 0} is on the x axis
+and the y axis, this code would only print On the x axis at 0.
We’ve destructured enums in this book (for example, Listing 6-5 in Chapter 6),
+but haven’t yet explicitly discussed that the pattern to destructure an enum
+corresponds to the way the data stored within the enum is defined. As an
+example, in Listing 18-15 we use the Message enum from Listing 6-2 and write
+a match with patterns that will destructure each inner value.
+
Filename: src/main.rs
+
enum Message {
+ Quit,
+ Move { x: i32, y: i32 },
+ Write(String),
+ ChangeColor(i32, i32, i32),
+}
+
+fn main() {
+ let msg = Message::ChangeColor(0, 160, 255);
+
+ match msg {
+ Message::Quit => {
+ println!("The Quit variant has no data to destructure.");
+ }
+ Message::Move { x, y } => {
+ println!("Move in the x direction {x} and in the y direction {y}");
+ }
+ Message::Write(text) => {
+ println!("Text message: {text}");
+ }
+ Message::ChangeColor(r, g, b) => {
+ println!("Change the color to red {r}, green {g}, and blue {b}")
+ }
+ }
+}
+
Listing 18-15: Destructuring enum variants that hold
+different kinds of values
+
This code will print Change the color to red 0, green 160, and blue 255. Try
+changing the value of msg to see the code from the other arms run.
+
For enum variants without any data, like Message::Quit, we can’t destructure
+the value any further. We can only match on the literal Message::Quit value,
+and no variables are in that pattern.
+
For struct-like enum variants, such as Message::Move, we can use a pattern
+similar to the pattern we specify to match structs. After the variant name, we
+place curly brackets and then list the fields with variables so we break apart
+the pieces to use in the code for this arm. Here we use the shorthand form as
+we did in Listing 18-13.
+
For tuple-like enum variants, like Message::Write that holds a tuple with one
+element and Message::ChangeColor that holds a tuple with three elements, the
+pattern is similar to the pattern we specify to match tuples. The number of
+variables in the pattern must match the number of elements in the variant we’re
+matching.
So far, our examples have all been matching structs or enums one level deep,
+but matching can work on nested items too! For example, we can refactor the
+code in Listing 18-15 to support RGB and HSV colors in the ChangeColor
+message, as shown in Listing 18-16.
+
enum Color {
+ Rgb(i32, i32, i32),
+ Hsv(i32, i32, i32),
+}
+
+enum Message {
+ Quit,
+ Move { x: i32, y: i32 },
+ Write(String),
+ ChangeColor(Color),
+}
+
+fn main() {
+ let msg = Message::ChangeColor(Color::Hsv(0, 160, 255));
+
+ match msg {
+ Message::ChangeColor(Color::Rgb(r, g, b)) => {
+ println!("Change color to red {r}, green {g}, and blue {b}");
+ }
+ Message::ChangeColor(Color::Hsv(h, s, v)) => {
+ println!("Change color to hue {h}, saturation {s}, value {v}")
+ }
+ _ => (),
+ }
+}
+
Listing 18-16: Matching on nested enums
+
The pattern of the first arm in the match expression matches a
+Message::ChangeColor enum variant that contains a Color::Rgb variant; then
+the pattern binds to the three inner i32 values. The pattern of the second
+arm also matches a Message::ChangeColor enum variant, but the inner enum
+matches Color::Hsv instead. We can specify these complex conditions in one
+match expression, even though two enums are involved.
We can mix, match, and nest destructuring patterns in even more complex ways.
+The following example shows a complicated destructure where we nest structs and
+tuples inside a tuple and destructure all the primitive values out:
+
fn main() {
+ struct Point {
+ x: i32,
+ y: i32,
+ }
+
+ let ((feet, inches), Point { x, y }) = ((3, 10), Point { x: 3, y: -10 });
+}
+
This code lets us break complex types into their component parts so we can use
+the values we’re interested in separately.
+
Destructuring with patterns is a convenient way to use pieces of values, such
+as the value from each field in a struct, separately from each other.
You’ve seen that it’s sometimes useful to ignore values in a pattern, such as
+in the last arm of a match, to get a catchall that doesn’t actually do
+anything but does account for all remaining possible values. There are a few
+ways to ignore entire values or parts of values in a pattern: using the _
+pattern (which you’ve seen), using the _ pattern within another pattern,
+using a name that starts with an underscore, or using .. to ignore remaining
+parts of a value. Let’s explore how and why to use each of these patterns.
We’ve used the underscore as a wildcard pattern that will match any value but
+not bind to the value. This is especially useful as the last arm in a match
+expression, but we can also use it in any pattern, including function
+parameters, as shown in Listing 18-17.
+
Filename: src/main.rs
+
fn foo(_: i32, y: i32) {
+ println!("This code only uses the y parameter: {y}");
+}
+
+fn main() {
+ foo(3, 4);
+}
+
Listing 18-17: Using _ in a function signature
+
This code will completely ignore the value 3 passed as the first argument,
+and will print This code only uses the y parameter: 4.
+
In most cases when you no longer need a particular function parameter, you
+would change the signature so it doesn’t include the unused parameter. Ignoring
+a function parameter can be especially useful in cases when, for example,
+you’re implementing a trait when you need a certain type signature but the
+function body in your implementation doesn’t need one of the parameters. You
+then avoid getting a compiler warning about unused function parameters, as you
+would if you used a name instead.
We can also use _ inside another pattern to ignore just part of a value, for
+example, when we want to test for only part of a value but have no use for the
+other parts in the corresponding code we want to run. Listing 18-18 shows code
+responsible for managing a setting’s value. The business requirements are that
+the user should not be allowed to overwrite an existing customization of a
+setting but can unset the setting and give it a value if it is currently unset.
Listing 18-18: Using an underscore within patterns that
+match Some variants when we don’t need to use the value inside the
+Some
+
This code will print Can't overwrite an existing customized value and then
+setting is Some(5). In the first match arm, we don’t need to match on or use
+the values inside either Some variant, but we do need to test for the case
+when setting_value and new_setting_value are the Some variant. In that
+case, we print the reason for not changing setting_value, and it doesn’t get
+changed.
+
In all other cases (if either setting_value or new_setting_value are
+None) expressed by the _ pattern in the second arm, we want to allow
+new_setting_value to become setting_value.
+
We can also use underscores in multiple places within one pattern to ignore
+particular values. Listing 18-19 shows an example of ignoring the second and
+fourth values in a tuple of five items.
If you create a variable but don’t use it anywhere, Rust will usually issue a
+warning because an unused variable could be a bug. However, sometimes it’s
+useful to be able to create a variable you won’t use yet, such as when you’re
+prototyping or just starting a project. In this situation, you can tell Rust
+not to warn you about the unused variable by starting the name of the variable
+with an underscore. In Listing 18-20, we create two unused variables, but when
+we compile this code, we should only get a warning about one of them.
+
Filename: src/main.rs
+
fn main() {
+ let _x = 5;
+ let y = 10;
+}
+
Listing 18-20: Starting a variable name with an
+underscore to avoid getting unused variable warnings
+
Here we get a warning about not using the variable y, but we don’t get a
+warning about not using _x.
+
Note that there is a subtle difference between using only _ and using a name
+that starts with an underscore. The syntax _x still binds the value to the
+variable, whereas _ doesn’t bind at all. To show a case where this
+distinction matters, Listing 18-21 will provide us with an error.
+
fn main() {
+ let s = Some(String::from("Hello!"));
+
+ if let Some(_s) = s {
+ println!("found a string");
+ }
+
+ println!("{s:?}");
+}
+
Listing 18-21: An unused variable starting with an
+underscore still binds the value, which might take ownership of the value
+
We’ll receive an error because the s value will still be moved into _s,
+which prevents us from using s again. However, using the underscore by itself
+doesn’t ever bind to the value. Listing 18-22 will compile without any errors
+because s doesn’t get moved into _.
+
fn main() {
+ let s = Some(String::from("Hello!"));
+
+ if let Some(_) = s {
+ println!("found a string");
+ }
+
+ println!("{s:?}");
+}
+
Listing 18-22: Using an underscore does not bind the
+value
+
This code works just fine because we never bind s to anything; it isn’t moved.
With values that have many parts, we can use the .. syntax to use specific
+parts and ignore the rest, avoiding the need to list underscores for each
+ignored value. The .. pattern ignores any parts of a value that we haven’t
+explicitly matched in the rest of the pattern. In Listing 18-23, we have a
+Point struct that holds a coordinate in three-dimensional space. In the
+match expression, we want to operate only on the x coordinate and ignore
+the values in the y and z fields.
+
fn main() {
+ struct Point {
+ x: i32,
+ y: i32,
+ z: i32,
+ }
+
+ let origin = Point { x: 0, y: 0, z: 0 };
+
+ match origin {
+ Point { x, .. } => println!("x is {x}"),
+ }
+}
+
Listing 18-23: Ignoring all fields of a Point except
+for x by using ..
+
We list the x value and then just include the .. pattern. This is quicker
+than having to list y: _ and z: _, particularly when we’re working with
+structs that have lots of fields in situations where only one or two fields are
+relevant.
+
The syntax .. will expand to as many values as it needs to be. Listing 18-24
+shows how to use .. with a tuple.
Listing 18-24: Matching only the first and last values in
+a tuple and ignoring all other values
+
In this code, the first and last value are matched with first and last. The
+.. will match and ignore everything in the middle.
+
However, using .. must be unambiguous. If it is unclear which values are
+intended for matching and which should be ignored, Rust will give us an error.
+Listing 18-25 shows an example of using .. ambiguously, so it will not
+compile.
Listing 18-25: An attempt to use .. in an ambiguous
+way
+
When we compile this example, we get this error:
+
$ cargo run
+ Compiling patterns v0.1.0 (file:///projects/patterns)
+error: `..` can only be used once per tuple pattern
+ --> src/main.rs:5:22
+ |
+5 | (.., second, ..) => {
+ | -- ^^ can only be used once per tuple pattern
+ | |
+ | previously used here
+
+error: could not compile `patterns` (bin "patterns") due to 1 previous error
+
+
It’s impossible for Rust to determine how many values in the tuple to ignore
+before matching a value with second and then how many further values to
+ignore thereafter. This code could mean that we want to ignore 2, bind
+second to 4, and then ignore 8, 16, and 32; or that we want to ignore
+2 and 4, bind second to 8, and then ignore 16 and 32; and so forth.
+The variable name second doesn’t mean anything special to Rust, so we get a
+compiler error because using .. in two places like this is ambiguous.
A match guard is an additional if condition, specified after the pattern in
+a match arm, that must also match for that arm to be chosen. Match guards are
+useful for expressing more complex ideas than a pattern alone allows.
+
The condition can use variables created in the pattern. Listing 18-26 shows a
+match where the first arm has the pattern Some(x) and also has a match
+guard of if x % 2 == 0 (which will be true if the number is even).
+
fn main() {
+ let num = Some(4);
+
+ match num {
+ Some(x) if x % 2 == 0 => println!("The number {x} is even"),
+ Some(x) => println!("The number {x} is odd"),
+ None => (),
+ }
+}
+
Listing 18-26: Adding a match guard to a pattern
+
This example will print The number 4 is even. When num is compared to the
+pattern in the first arm, it matches, because Some(4) matches Some(x). Then
+the match guard checks whether the remainder of dividing x by 2 is equal to
+0, and because it is, the first arm is selected.
+
If num had been Some(5) instead, the match guard in the first arm would
+have been false because the remainder of 5 divided by 2 is 1, which is not
+equal to 0. Rust would then go to the second arm, which would match because the
+second arm doesn’t have a match guard and therefore matches any Some variant.
+
There is no way to express the if x % 2 == 0 condition within a pattern, so
+the match guard gives us the ability to express this logic. The downside of
+this additional expressiveness is that the compiler doesn’t try to check for
+exhaustiveness when match guard expressions are involved.
+
In Listing 18-11, we mentioned that we could use match guards to solve our
+pattern-shadowing problem. Recall that we created a new variable inside the
+pattern in the match expression instead of using the variable outside the
+match. That new variable meant we couldn’t test against the value of the
+outer variable. Listing 18-27 shows how we can use a match guard to fix this
+problem.
+
Filename: src/main.rs
+
fn main() {
+ let x = Some(5);
+ let y = 10;
+
+ match x {
+ Some(50) => println!("Got 50"),
+ Some(n) if n == y => println!("Matched, n = {n}"),
+ _ => println!("Default case, x = {x:?}"),
+ }
+
+ println!("at the end: x = {x:?}, y = {y}");
+}
+
Listing 18-27: Using a match guard to test for equality
+with an outer variable
+
This code will now print Default case, x = Some(5). The pattern in the second
+match arm doesn’t introduce a new variable y that would shadow the outer y,
+meaning we can use the outer y in the match guard. Instead of specifying the
+pattern as Some(y), which would have shadowed the outer y, we specify
+Some(n). This creates a new variable n that doesn’t shadow anything because
+there is no n variable outside the match.
+
The match guard if n == y is not a pattern and therefore doesn’t introduce
+new variables. This yis the outer y rather than a new shadowed y, and
+we can look for a value that has the same value as the outer y by comparing
+n to y.
+
You can also use the or operator | in a match guard to specify multiple
+patterns; the match guard condition will apply to all the patterns. Listing
+18-28 shows the precedence when combining a pattern that uses | with a match
+guard. The important part of this example is that the if y match guard
+applies to 4, 5, and6, even though it might look like if y only
+applies to 6.
+
fn main() {
+ let x = 4;
+ let y = false;
+
+ match x {
+ 4 | 5 | 6 if y => println!("yes"),
+ _ => println!("no"),
+ }
+}
+
Listing 18-28: Combining multiple patterns with a match
+guard
+
The match condition states that the arm only matches if the value of x is
+equal to 4, 5, or 6and if y is true. When this code runs, the
+pattern of the first arm matches because x is 4, but the match guard if y
+is false, so the first arm is not chosen. The code moves on to the second arm,
+which does match, and this program prints no. The reason is that the if
+condition applies to the whole pattern 4 | 5 | 6, not only to the last value
+6. In other words, the precedence of a match guard in relation to a pattern
+behaves like this:
+
(4 | 5 | 6) if y => ...
+
+
rather than this:
+
4 | 5 | (6 if y) => ...
+
+
After running the code, the precedence behavior is evident: if the match guard
+were applied only to the final value in the list of values specified using the
+| operator, the arm would have matched and the program would have printed
+yes.
The at operator @ lets us create a variable that holds a value at the same
+time as we’re testing that value for a pattern match. In Listing 18-29, we want
+to test that a Message::Helloid field is within the range 3..=7. We also
+want to bind the value to the variable id_variable so we can use it in the
+code associated with the arm. We could name this variable id, the same as the
+field, but for this example we’ll use a different name.
+
fn main() {
+ enum Message {
+ Hello { id: i32 },
+ }
+
+ let msg = Message::Hello { id: 5 };
+
+ match msg {
+ Message::Hello {
+ id: id_variable @ 3..=7,
+ } => println!("Found an id in range: {id_variable}"),
+ Message::Hello { id: 10..=12 } => {
+ println!("Found an id in another range")
+ }
+ Message::Hello { id } => println!("Found some other id: {id}"),
+ }
+}
+
Listing 18-29: Using @ to bind to a value in a pattern
+while also testing it
+
This example will print Found an id in range: 5. By specifying id_variable @ before the range 3..=7, we’re capturing whatever value matched the range
+while also testing that the value matched the range pattern.
+
In the second arm, where we only have a range specified in the pattern, the code
+associated with the arm doesn’t have a variable that contains the actual value
+of the id field. The id field’s value could have been 10, 11, or 12, but
+the code that goes with that pattern doesn’t know which it is. The pattern code
+isn’t able to use the value from the id field, because we haven’t saved the
+id value in a variable.
+
In the last arm, where we’ve specified a variable without a range, we do have
+the value available to use in the arm’s code in a variable named id. The
+reason is that we’ve used the struct field shorthand syntax. But we haven’t
+applied any test to the value in the id field in this arm, as we did with the
+first two arms: any value would match this pattern.
+
Using @ lets us test a value and save it in a variable within one pattern.
Rust’s patterns are very useful in distinguishing between different kinds of
+data. When used in match expressions, Rust ensures your patterns cover every
+possible value, or your program won’t compile. Patterns in let statements and
+function parameters make those constructs more useful, enabling the
+destructuring of values into smaller parts at the same time as assigning to
+variables. We can create simple or complex patterns to suit our needs.
+
Next, for the penultimate chapter of the book, we’ll look at some advanced
+aspects of a variety of Rust’s features.
By now, you’ve learned the most commonly used parts of the Rust programming
+language. Before we do one more project in Chapter 20, we’ll look at a few
+aspects of the language you might run into every once in a while, but may not
+use every day. You can use this chapter as a reference for when you encounter
+any unknowns. The features covered here are useful in very specific situations.
+Although you might not reach for them often, we want to make sure you have a
+grasp of all the features Rust has to offer.
+
In this chapter, we’ll cover:
+
+
Unsafe Rust: how to opt out of some of Rust’s guarantees and take
+responsibility for manually upholding those guarantees
+
Advanced traits: associated types, default type parameters, fully qualified
+syntax, supertraits, and the newtype pattern in relation to traits
+
Advanced types: more about the newtype pattern, type aliases, the never type,
+and dynamically sized types
+
Advanced functions and closures: function pointers and returning closures
+
Macros: ways to define code that defines more code at compile time
+
+
It’s a panoply of Rust features with something for everyone! Let’s dive in!
All the code we’ve discussed so far has had Rust’s memory safety guarantees
+enforced at compile time. However, Rust has a second language hidden inside it
+that doesn’t enforce these memory safety guarantees: it’s called unsafe Rust
+and works just like regular Rust, but gives us extra superpowers.
+
Unsafe Rust exists because, by nature, static analysis is conservative. When
+the compiler tries to determine whether or not code upholds the guarantees,
+it’s better for it to reject some valid programs than to accept some invalid
+programs. Although the code might be okay, if the Rust compiler doesn’t have
+enough information to be confident, it will reject the code. In these cases,
+you can use unsafe code to tell the compiler, “Trust me, I know what I’m
+doing.” Be warned, however, that you use unsafe Rust at your own risk: if you
+use unsafe code incorrectly, problems can occur due to memory unsafety, such as
+null pointer dereferencing.
+
Another reason Rust has an unsafe alter ego is that the underlying computer
+hardware is inherently unsafe. If Rust didn’t let you do unsafe operations, you
+couldn’t do certain tasks. Rust needs to allow you to do low-level systems
+programming, such as directly interacting with the operating system or even
+writing your own operating system. Working with low-level systems programming
+is one of the goals of the language. Let’s explore what we can do with unsafe
+Rust and how to do it.
To switch to unsafe Rust, use the unsafe keyword and then start a new block
+that holds the unsafe code. You can take five actions in unsafe Rust that you
+can’t in safe Rust, which we call unsafe superpowers. Those superpowers
+include the ability to:
+
+
Dereference a raw pointer
+
Call an unsafe function or method
+
Access or modify a mutable static variable
+
Implement an unsafe trait
+
Access fields of a union
+
+
It’s important to understand that unsafe doesn’t turn off the borrow checker
+or disable any other of Rust’s safety checks: if you use a reference in unsafe
+code, it will still be checked. The unsafe keyword only gives you access to
+these five features that are then not checked by the compiler for memory
+safety. You’ll still get some degree of safety inside of an unsafe block.
+
In addition, unsafe does not mean the code inside the block is necessarily
+dangerous or that it will definitely have memory safety problems: the intent is
+that as the programmer, you’ll ensure the code inside an unsafe block will
+access memory in a valid way.
+
People are fallible, and mistakes will happen, but by requiring these five
+unsafe operations to be inside blocks annotated with unsafe you’ll know that
+any errors related to memory safety must be within an unsafe block. Keep
+unsafe blocks small; you’ll be thankful later when you investigate memory
+bugs.
+
To isolate unsafe code as much as possible, it’s best to enclose unsafe code
+within a safe abstraction and provide a safe API, which we’ll discuss later in
+the chapter when we examine unsafe functions and methods. Parts of the standard
+library are implemented as safe abstractions over unsafe code that has been
+audited. Wrapping unsafe code in a safe abstraction prevents uses of unsafe
+from leaking out into all the places that you or your users might want to use
+the functionality implemented with unsafe code, because using a safe
+abstraction is safe.
+
Let’s look at each of the five unsafe superpowers in turn. We’ll also look at
+some abstractions that provide a safe interface to unsafe code.
In Chapter 4, in the “Dangling References” section, we mentioned that the compiler ensures references are always
+valid. Unsafe Rust has two new types called raw pointers that are similar to
+references. As with references, raw pointers can be immutable or mutable and
+are written as *const T and *mut T, respectively. The asterisk isn’t the
+dereference operator; it’s part of the type name. In the context of raw
+pointers, immutable means that the pointer can’t be directly assigned to
+after being dereferenced.
+
Different from references and smart pointers, raw pointers:
+
+
Are allowed to ignore the borrowing rules by having both immutable and
+mutable pointers or multiple mutable pointers to the same location
+
Aren’t guaranteed to point to valid memory
+
Are allowed to be null
+
Don’t implement any automatic cleanup
+
+
By opting out of having Rust enforce these guarantees, you can give up
+guaranteed safety in exchange for greater performance or the ability to
+interface with another language or hardware where Rust’s guarantees don’t apply.
+
Listing 19-1 shows how to create an immutable and a mutable raw pointer from
+references.
+
fn main() {
+ let mut num = 5;
+
+ let r1 = &num as *const i32;
+ let r2 = &mut num as *mut i32;
+}
+
Listing 19-1: Creating raw pointers from references
+
Notice that we don’t include the unsafe keyword in this code. We can create
+raw pointers in safe code; we just can’t dereference raw pointers outside an
+unsafe block, as you’ll see in a bit.
+
We’ve created raw pointers by using as to cast an immutable and a mutable
+reference into their corresponding raw pointer types. Because we created them
+directly from references guaranteed to be valid, we know these particular raw
+pointers are valid, but we can’t make that assumption about just any raw
+pointer.
+
To demonstrate this, next we’ll create a raw pointer whose validity we can’t be
+so certain of. Listing 19-2 shows how to create a raw pointer to an arbitrary
+location in memory. Trying to use arbitrary memory is undefined: there might be
+data at that address or there might not, the compiler might optimize the code
+so there is no memory access, or the program might error with a segmentation
+fault. Usually, there is no good reason to write code like this, but it is
+possible.
+
fn main() {
+ let address = 0x012345usize;
+ let r = address as *const i32;
+}
+
Listing 19-2: Creating a raw pointer to an arbitrary
+memory address
+
Recall that we can create raw pointers in safe code, but we can’t dereference
+raw pointers and read the data being pointed to. In Listing 19-3, we use the
+dereference operator * on a raw pointer that requires an unsafe block.
+
fn main() {
+ let mut num = 5;
+
+ let r1 = &num as *const i32;
+ let r2 = &mut num as *mut i32;
+
+ unsafe {
+ println!("r1 is: {}", *r1);
+ println!("r2 is: {}", *r2);
+ }
+}
+
Listing 19-3: Dereferencing raw pointers within an
+unsafe block
+
Creating a pointer does no harm; it’s only when we try to access the value that
+it points at that we might end up dealing with an invalid value.
+
Note also that in Listing 19-1 and 19-3, we created *const i32 and *mut i32
+raw pointers that both pointed to the same memory location, where num is
+stored. If we instead tried to create an immutable and a mutable reference to
+num, the code would not have compiled because Rust’s ownership rules don’t
+allow a mutable reference at the same time as any immutable references. With
+raw pointers, we can create a mutable pointer and an immutable pointer to the
+same location and change data through the mutable pointer, potentially creating
+a data race. Be careful!
+
With all of these dangers, why would you ever use raw pointers? One major use
+case is when interfacing with C code, as you’ll see in the next section,
+“Calling an Unsafe Function or
+Method.” Another case is
+when building up safe abstractions that the borrow checker doesn’t understand.
+We’ll introduce unsafe functions and then look at an example of a safe
+abstraction that uses unsafe code.
The second type of operation you can perform in an unsafe block is calling
+unsafe functions. Unsafe functions and methods look exactly like regular
+functions and methods, but they have an extra unsafe before the rest of the
+definition. The unsafe keyword in this context indicates the function has
+requirements we need to uphold when we call this function, because Rust can’t
+guarantee we’ve met these requirements. By calling an unsafe function within an
+unsafe block, we’re saying that we’ve read this function’s documentation and
+take responsibility for upholding the function’s contracts.
+
Here is an unsafe function named dangerous that doesn’t do anything in its
+body:
We must call the dangerous function within a separate unsafe block. If we
+try to call dangerous without the unsafe block, we’ll get an error:
+
$ cargo run
+ Compiling unsafe-example v0.1.0 (file:///projects/unsafe-example)
+error[E0133]: call to unsafe function `dangerous` is unsafe and requires unsafe function or block
+ --> src/main.rs:4:5
+ |
+4 | dangerous();
+ | ^^^^^^^^^^^ call to unsafe function
+ |
+ = note: consult the function's documentation for information on how to avoid undefined behavior
+
+For more information about this error, try `rustc --explain E0133`.
+error: could not compile `unsafe-example` (bin "unsafe-example") due to 1 previous error
+
+
With the unsafe block, we’re asserting to Rust that we’ve read the function’s
+documentation, we understand how to use it properly, and we’ve verified that
+we’re fulfilling the contract of the function.
+
Bodies of unsafe functions are effectively unsafe blocks, so to perform other
+unsafe operations within an unsafe function, we don’t need to add another
+unsafe block.
Just because a function contains unsafe code doesn’t mean we need to mark the
+entire function as unsafe. In fact, wrapping unsafe code in a safe function is
+a common abstraction. As an example, let’s study the split_at_mut function
+from the standard library, which requires some unsafe code. We’ll explore how
+we might implement it. This safe method is defined on mutable slices: it takes
+one slice and makes it two by splitting the slice at the index given as an
+argument. Listing 19-4 shows how to use split_at_mut.
+
fn main() {
+ let mut v = vec![1, 2, 3, 4, 5, 6];
+
+ let r = &mut v[..];
+
+ let (a, b) = r.split_at_mut(3);
+
+ assert_eq!(a, &mut [1, 2, 3]);
+ assert_eq!(b, &mut [4, 5, 6]);
+}
+
Listing 19-4: Using the safe split_at_mut
+function
+
We can’t implement this function using only safe Rust. An attempt might look
+something like Listing 19-5, which won’t compile. For simplicity, we’ll
+implement split_at_mut as a function rather than a method and only for slices
+of i32 values rather than for a generic type T.
Listing 19-5: An attempted implementation of
+split_at_mut using only safe Rust
+
This function first gets the total length of the slice. Then it asserts that
+the index given as a parameter is within the slice by checking whether it’s
+less than or equal to the length. The assertion means that if we pass an index
+that is greater than the length to split the slice at, the function will panic
+before it attempts to use that index.
+
Then we return two mutable slices in a tuple: one from the start of the
+original slice to the mid index and another from mid to the end of the
+slice.
+
When we try to compile the code in Listing 19-5, we’ll get an error.
+
$ cargo run
+ Compiling unsafe-example v0.1.0 (file:///projects/unsafe-example)
+error[E0499]: cannot borrow `*values` as mutable more than once at a time
+ --> src/main.rs:6:31
+ |
+1 | fn split_at_mut(values: &mut [i32], mid: usize) -> (&mut [i32], &mut [i32]) {
+ | - let's call the lifetime of this reference `'1`
+...
+6 | (&mut values[..mid], &mut values[mid..])
+ | --------------------------^^^^^^--------
+ | | | |
+ | | | second mutable borrow occurs here
+ | | first mutable borrow occurs here
+ | returning this value requires that `*values` is borrowed for `'1`
+
+For more information about this error, try `rustc --explain E0499`.
+error: could not compile `unsafe-example` (bin "unsafe-example") due to 1 previous error
+
+
Rust’s borrow checker can’t understand that we’re borrowing different parts of
+the slice; it only knows that we’re borrowing from the same slice twice.
+Borrowing different parts of a slice is fundamentally okay because the two
+slices aren’t overlapping, but Rust isn’t smart enough to know this. When we
+know code is okay, but Rust doesn’t, it’s time to reach for unsafe code.
+
Listing 19-6 shows how to use an unsafe block, a raw pointer, and some calls
+to unsafe functions to make the implementation of split_at_mut work.
Listing 19-6: Using unsafe code in the implementation of
+the split_at_mut function
+
Recall from “The Slice Type” section in
+Chapter 4 that slices are a pointer to some data and the length of the slice.
+We use the len method to get the length of a slice and the as_mut_ptr
+method to access the raw pointer of a slice. In this case, because we have a
+mutable slice to i32 values, as_mut_ptr returns a raw pointer with the type
+*mut i32, which we’ve stored in the variable ptr.
+
We keep the assertion that the mid index is within the slice. Then we get to
+the unsafe code: the slice::from_raw_parts_mut function takes a raw pointer
+and a length, and it creates a slice. We use this function to create a slice
+that starts from ptr and is mid items long. Then we call the add
+method on ptr with mid as an argument to get a raw pointer that starts at
+mid, and we create a slice using that pointer and the remaining number of
+items after mid as the length.
+
The function slice::from_raw_parts_mut is unsafe because it takes a raw
+pointer and must trust that this pointer is valid. The add method on raw
+pointers is also unsafe, because it must trust that the offset location is also
+a valid pointer. Therefore, we had to put an unsafe block around our calls to
+slice::from_raw_parts_mut and add so we could call them. By looking at
+the code and by adding the assertion that mid must be less than or equal to
+len, we can tell that all the raw pointers used within the unsafe block
+will be valid pointers to data within the slice. This is an acceptable and
+appropriate use of unsafe.
+
Note that we don’t need to mark the resulting split_at_mut function as
+unsafe, and we can call this function from safe Rust. We’ve created a safe
+abstraction to the unsafe code with an implementation of the function that uses
+unsafe code in a safe way, because it creates only valid pointers from the
+data this function has access to.
+
In contrast, the use of slice::from_raw_parts_mut in Listing 19-7 would
+likely crash when the slice is used. This code takes an arbitrary memory
+location and creates a slice 10,000 items long.
+
fn main() {
+ use std::slice;
+
+ let address = 0x01234usize;
+ let r = address as *mut i32;
+
+ let values: &[i32] = unsafe { slice::from_raw_parts_mut(r, 10000) };
+}
+
Listing 19-7: Creating a slice from an arbitrary memory
+location
+
We don’t own the memory at this arbitrary location, and there is no guarantee
+that the slice this code creates contains valid i32 values. Attempting to use
+values as though it’s a valid slice results in undefined behavior.
Sometimes, your Rust code might need to interact with code written in another
+language. For this, Rust has the keyword extern that facilitates the creation
+and use of a Foreign Function Interface (FFI). An FFI is a way for a
+programming language to define functions and enable a different (foreign)
+programming language to call those functions.
+
Listing 19-8 demonstrates how to set up an integration with the abs function
+from the C standard library. Functions declared within extern blocks are
+always unsafe to call from Rust code. The reason is that other languages don’t
+enforce Rust’s rules and guarantees, and Rust can’t check them, so
+responsibility falls on the programmer to ensure safety.
+
Filename: src/main.rs
+
extern "C" {
+ fn abs(input: i32) -> i32;
+}
+
+fn main() {
+ unsafe {
+ println!("Absolute value of -3 according to C: {}", abs(-3));
+ }
+}
+
Listing 19-8: Declaring and calling an extern function
+defined in another language
+
Within the extern "C" block, we list the names and signatures of external
+functions from another language we want to call. The "C" part defines which
+application binary interface (ABI) the external function uses: the ABI
+defines how to call the function at the assembly level. The "C" ABI is the
+most common and follows the C programming language’s ABI.
We can also use extern to create an interface that allows other languages
+to call Rust functions. Instead of creating a whole extern block, we add
+the extern keyword and specify the ABI to use just before the fn keyword
+for the relevant function. We also need to add a #[no_mangle] annotation to
+tell the Rust compiler not to mangle the name of this function. Mangling is
+when a compiler changes the name we’ve given a function to a different name
+that contains more information for other parts of the compilation process to
+consume but is less human readable. Every programming language compiler
+mangles names slightly differently, so for a Rust function to be nameable by
+other languages, we must disable the Rust compiler’s name mangling.
+
In the following example, we make the call_from_c function accessible from
+C code, after it’s compiled to a shared library and linked from C:
+
#![allow(unused)]
+fn main() {
+#[no_mangle]
+pub extern "C" fn call_from_c() {
+ println!("Just called a Rust function from C!");
+}
+}
In this book, we’ve not yet talked about global variables, which Rust does
+support but can be problematic with Rust’s ownership rules. If two threads are
+accessing the same mutable global variable, it can cause a data race.
+
In Rust, global variables are called static variables. Listing 19-9 shows an
+example declaration and use of a static variable with a string slice as a
+value.
Listing 19-9: Defining and using an immutable static
+variable
+
Static variables are similar to constants, which we discussed in the
+“Differences Between Variables and
+Constants” section
+in Chapter 3. The names of static variables are in SCREAMING_SNAKE_CASE by
+convention. Static variables can only store references with the 'static
+lifetime, which means the Rust compiler can figure out the lifetime and we
+aren’t required to annotate it explicitly. Accessing an immutable static
+variable is safe.
+
A subtle difference between constants and immutable static variables is that
+values in a static variable have a fixed address in memory. Using the value
+will always access the same data. Constants, on the other hand, are allowed to
+duplicate their data whenever they’re used. Another difference is that static
+variables can be mutable. Accessing and modifying mutable static variables is
+unsafe. Listing 19-10 shows how to declare, access, and modify a mutable
+static variable named COUNTER.
Listing 19-10: Reading from or writing to a mutable
+static variable is unsafe
+
As with regular variables, we specify mutability using the mut keyword. Any
+code that reads or writes from COUNTER must be within an unsafe block. This
+code compiles and prints COUNTER: 3 as we would expect because it’s single
+threaded. Having multiple threads access COUNTER would likely result in data
+races.
+
With mutable data that is globally accessible, it’s difficult to ensure there
+are no data races, which is why Rust considers mutable static variables to be
+unsafe. Where possible, it’s preferable to use the concurrency techniques and
+thread-safe smart pointers we discussed in Chapter 16 so the compiler checks
+that data accessed from different threads is done safely.
We can use unsafe to implement an unsafe trait. A trait is unsafe when at
+least one of its methods has some invariant that the compiler can’t verify. We
+declare that a trait is unsafe by adding the unsafe keyword before trait
+and marking the implementation of the trait as unsafe too, as shown in
+Listing 19-11.
+
unsafe trait Foo {
+ // methods go here
+}
+
+unsafe impl Foo for i32 {
+ // method implementations go here
+}
+
+fn main() {}
+
Listing 19-11: Defining and implementing an unsafe
+trait
+
By using unsafe impl, we’re promising that we’ll uphold the invariants that
+the compiler can’t verify.
+
As an example, recall the Sync and Send marker traits we discussed in the
+“Extensible Concurrency with the Sync and Send
+Traits”
+section in Chapter 16: the compiler implements these traits automatically if
+our types are composed entirely of Send and Sync types. If we implement a
+type that contains a type that is not Send or Sync, such as raw pointers,
+and we want to mark that type as Send or Sync, we must use unsafe. Rust
+can’t verify that our type upholds the guarantees that it can be safely sent
+across threads or accessed from multiple threads; therefore, we need to do
+those checks manually and indicate as such with unsafe.
The final action that works only with unsafe is accessing fields of a
+union. A union is similar to a struct, but only one declared field is
+used in a particular instance at one time. Unions are primarily used to
+interface with unions in C code. Accessing union fields is unsafe because Rust
+can’t guarantee the type of the data currently being stored in the union
+instance. You can learn more about unions in the Rust Reference.
Using unsafe to take one of the five actions (superpowers) just discussed
+isn’t wrong or even frowned upon. But it is trickier to get unsafe code
+correct because the compiler can’t help uphold memory safety. When you have a
+reason to use unsafe code, you can do so, and having the explicit unsafe
+annotation makes it easier to track down the source of problems when they occur.
We first covered traits in the “Traits: Defining Shared
+Behavior” section of Chapter
+10, but we didn’t discuss the more advanced details. Now that you know more
+about Rust, we can get into the nitty-gritty.
Associated types connect a type placeholder with a trait such that the trait
+method definitions can use these placeholder types in their signatures. The
+implementor of a trait will specify the concrete type to be used instead of the
+placeholder type for the particular implementation. That way, we can define a
+trait that uses some types without needing to know exactly what those types are
+until the trait is implemented.
+
We’ve described most of the advanced features in this chapter as being rarely
+needed. Associated types are somewhere in the middle: they’re used more rarely
+than features explained in the rest of the book but more commonly than many of
+the other features discussed in this chapter.
+
One example of a trait with an associated type is the Iterator trait that the
+standard library provides. The associated type is named Item and stands in
+for the type of the values the type implementing the Iterator trait is
+iterating over. The definition of the Iterator trait is as shown in Listing
+19-12.
Listing 19-12: The definition of the Iterator trait
+that has an associated type Item
+
The type Item is a placeholder, and the next method’s definition shows that
+it will return values of type Option<Self::Item>. Implementors of the
+Iterator trait will specify the concrete type for Item, and the next
+method will return an Option containing a value of that concrete type.
+
Associated types might seem like a similar concept to generics, in that the
+latter allow us to define a function without specifying what types it can
+handle. To examine the difference between the two concepts, we’ll look at an
+implementation of the Iterator trait on a type named Counter that specifies
+the Item type is u32:
Listing 19-13: A hypothetical definition of the
+Iterator trait using generics
+
The difference is that when using generics, as in Listing 19-13, we must
+annotate the types in each implementation; because we can also implement
+Iterator<String> for Counter or any other type, we could have multiple
+implementations of Iterator for Counter. In other words, when a trait has a
+generic parameter, it can be implemented for a type multiple times, changing
+the concrete types of the generic type parameters each time. When we use the
+next method on Counter, we would have to provide type annotations to
+indicate which implementation of Iterator we want to use.
+
With associated types, we don’t need to annotate types because we can’t
+implement a trait on a type multiple times. In Listing 19-12 with the
+definition that uses associated types, we can only choose what the type of
+Item will be once, because there can only be one impl Iterator for Counter.
+We don’t have to specify that we want an iterator of u32 values everywhere
+that we call next on Counter.
+
Associated types also become part of the trait’s contract: implementors of the
+trait must provide a type to stand in for the associated type placeholder.
+Associated types often have a name that describes how the type will be used,
+and documenting the associated type in the API documentation is good practice.
When we use generic type parameters, we can specify a default concrete type for
+the generic type. This eliminates the need for implementors of the trait to
+specify a concrete type if the default type works. You specify a default type
+when declaring a generic type with the <PlaceholderType=ConcreteType> syntax.
+
A great example of a situation where this technique is useful is with operator
+overloading, in which you customize the behavior of an operator (such as +)
+in particular situations.
+
Rust doesn’t allow you to create your own operators or overload arbitrary
+operators. But you can overload the operations and corresponding traits listed
+in std::ops by implementing the traits associated with the operator. For
+example, in Listing 19-14 we overload the + operator to add two Point
+instances together. We do this by implementing the Add trait on a Point
+struct:
+
Filename: src/main.rs
+
use std::ops::Add;
+
+#[derive(Debug, Copy, Clone, PartialEq)]
+struct Point {
+ x: i32,
+ y: i32,
+}
+
+impl Add for Point {
+ type Output = Point;
+
+ fn add(self, other: Point) -> Point {
+ Point {
+ x: self.x + other.x,
+ y: self.y + other.y,
+ }
+ }
+}
+
+fn main() {
+ assert_eq!(
+ Point { x: 1, y: 0 } + Point { x: 2, y: 3 },
+ Point { x: 3, y: 3 }
+ );
+}
+
Listing 19-14: Implementing the Add trait to overload
+the + operator for Point instances
+
The add method adds the x values of two Point instances and the y
+values of two Point instances to create a new Point. The Add trait has an
+associated type named Output that determines the type returned from the add
+method.
+
The default generic type in this code is within the Add trait. Here is its
+definition:
This code should look generally familiar: a trait with one method and an
+associated type. The new part is Rhs=Self: this syntax is called default
+type parameters. The Rhs generic type parameter (short for “right hand
+side”) defines the type of the rhs parameter in the add method. If we don’t
+specify a concrete type for Rhs when we implement the Add trait, the type
+of Rhs will default to Self, which will be the type we’re implementing
+Add on.
+
When we implemented Add for Point, we used the default for Rhs because we
+wanted to add two Point instances. Let’s look at an example of implementing
+the Add trait where we want to customize the Rhs type rather than using the
+default.
+
We have two structs, Millimeters and Meters, holding values in different
+units. This thin wrapping of an existing type in another struct is known as the
+newtype pattern, which we describe in more detail in the “Using the Newtype
+Pattern to Implement External Traits on External Types” section. We want to add values in millimeters to values in meters and have
+the implementation of Add do the conversion correctly. We can implement Add
+for Millimeters with Meters as the Rhs, as shown in Listing 19-15.
Listing 19-15: Implementing the Add trait on
+Millimeters to add Millimeters to Meters
+
To add Millimeters and Meters, we specify impl Add<Meters> to set the
+value of the Rhs type parameter instead of using the default of Self.
+
You’ll use default type parameters in two main ways:
+
+
To extend a type without breaking existing code
+
To allow customization in specific cases most users won’t need
+
+
The standard library’s Add trait is an example of the second purpose:
+usually, you’ll add two like types, but the Add trait provides the ability to
+customize beyond that. Using a default type parameter in the Add trait
+definition means you don’t have to specify the extra parameter most of the
+time. In other words, a bit of implementation boilerplate isn’t needed, making
+it easier to use the trait.
+
The first purpose is similar to the second but in reverse: if you want to add a
+type parameter to an existing trait, you can give it a default to allow
+extension of the functionality of the trait without breaking the existing
+implementation code.
Nothing in Rust prevents a trait from having a method with the same name as
+another trait’s method, nor does Rust prevent you from implementing both traits
+on one type. It’s also possible to implement a method directly on the type with
+the same name as methods from traits.
+
When calling methods with the same name, you’ll need to tell Rust which one you
+want to use. Consider the code in Listing 19-16 where we’ve defined two traits,
+Pilot and Wizard, that both have a method called fly. We then implement
+both traits on a type Human that already has a method named fly implemented
+on it. Each fly method does something different.
+
Filename: src/main.rs
+
trait Pilot {
+ fn fly(&self);
+}
+
+trait Wizard {
+ fn fly(&self);
+}
+
+struct Human;
+
+impl Pilot for Human {
+ fn fly(&self) {
+ println!("This is your captain speaking.");
+ }
+}
+
+impl Wizard for Human {
+ fn fly(&self) {
+ println!("Up!");
+ }
+}
+
+impl Human {
+ fn fly(&self) {
+ println!("*waving arms furiously*");
+ }
+}
+
+fn main() {}
+
Listing 19-16: Two traits are defined to have a fly
+method and are implemented on the Human type, and a fly method is
+implemented on Human directly
+
When we call fly on an instance of Human, the compiler defaults to calling
+the method that is directly implemented on the type, as shown in Listing 19-17.
+
Filename: src/main.rs
+
trait Pilot {
+ fn fly(&self);
+}
+
+trait Wizard {
+ fn fly(&self);
+}
+
+struct Human;
+
+impl Pilot for Human {
+ fn fly(&self) {
+ println!("This is your captain speaking.");
+ }
+}
+
+impl Wizard for Human {
+ fn fly(&self) {
+ println!("Up!");
+ }
+}
+
+impl Human {
+ fn fly(&self) {
+ println!("*waving arms furiously*");
+ }
+}
+
+fn main() {
+ let person = Human;
+ person.fly();
+}
+
Listing 19-17: Calling fly on an instance of
+Human
+
Running this code will print *waving arms furiously*, showing that Rust
+called the fly method implemented on Human directly.
+
To call the fly methods from either the Pilot trait or the Wizard trait,
+we need to use more explicit syntax to specify which fly method we mean.
+Listing 19-18 demonstrates this syntax.
+
Filename: src/main.rs
+
trait Pilot {
+ fn fly(&self);
+}
+
+trait Wizard {
+ fn fly(&self);
+}
+
+struct Human;
+
+impl Pilot for Human {
+ fn fly(&self) {
+ println!("This is your captain speaking.");
+ }
+}
+
+impl Wizard for Human {
+ fn fly(&self) {
+ println!("Up!");
+ }
+}
+
+impl Human {
+ fn fly(&self) {
+ println!("*waving arms furiously*");
+ }
+}
+
+fn main() {
+ let person = Human;
+ Pilot::fly(&person);
+ Wizard::fly(&person);
+ person.fly();
+}
+
Listing 19-18: Specifying which trait’s fly method we
+want to call
+
Specifying the trait name before the method name clarifies to Rust which
+implementation of fly we want to call. We could also write
+Human::fly(&person), which is equivalent to the person.fly() that we used
+in Listing 19-18, but this is a bit longer to write if we don’t need to
+disambiguate.
+
Running this code prints the following:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.46s
+ Running `target/debug/traits-example`
+This is your captain speaking.
+Up!
+*waving arms furiously*
+
+
Because the fly method takes a self parameter, if we had two types that
+both implement one trait, Rust could figure out which implementation of a
+trait to use based on the type of self.
+
However, associated functions that are not methods don’t have a self
+parameter. When there are multiple types or traits that define non-method
+functions with the same function name, Rust doesn’t always know which type you
+mean unless you use fully qualified syntax. For example, in Listing 19-19 we
+create a trait for an animal shelter that wants to name all baby dogs Spot.
+We make an Animal trait with an associated non-method function baby_name.
+The Animal trait is implemented for the struct Dog, on which we also
+provide an associated non-method function baby_name directly.
+
Filename: src/main.rs
+
trait Animal {
+ fn baby_name() -> String;
+}
+
+struct Dog;
+
+impl Dog {
+ fn baby_name() -> String {
+ String::from("Spot")
+ }
+}
+
+impl Animal for Dog {
+ fn baby_name() -> String {
+ String::from("puppy")
+ }
+}
+
+fn main() {
+ println!("A baby dog is called a {}", Dog::baby_name());
+}
+
Listing 19-19: A trait with an associated function and a
+type with an associated function of the same name that also implements the
+trait
+
We implement the code for naming all puppies Spot in the baby_name associated
+function that is defined on Dog. The Dog type also implements the trait
+Animal, which describes characteristics that all animals have. Baby dogs are
+called puppies, and that is expressed in the implementation of the Animal
+trait on Dog in the baby_name function associated with the Animal trait.
+
In main, we call the Dog::baby_name function, which calls the associated
+function defined on Dog directly. This code prints the following:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.54s
+ Running `target/debug/traits-example`
+A baby dog is called a Spot
+
+
This output isn’t what we wanted. We want to call the baby_name function that
+is part of the Animal trait that we implemented on Dog so the code prints
+A baby dog is called a puppy. The technique of specifying the trait name that
+we used in Listing 19-18 doesn’t help here; if we change main to the code in
+Listing 19-20, we’ll get a compilation error.
+
Filename: src/main.rs
+
trait Animal {
+ fn baby_name() -> String;
+}
+
+struct Dog;
+
+impl Dog {
+ fn baby_name() -> String {
+ String::from("Spot")
+ }
+}
+
+impl Animal for Dog {
+ fn baby_name() -> String {
+ String::from("puppy")
+ }
+}
+
+fn main() {
+ println!("A baby dog is called a {}", Animal::baby_name());
+}
+
Listing 19-20: Attempting to call the baby_name
+function from the Animal trait, but Rust doesn’t know which implementation to
+use
+
Because Animal::baby_name doesn’t have a self parameter, and there could be
+other types that implement the Animal trait, Rust can’t figure out which
+implementation of Animal::baby_name we want. We’ll get this compiler error:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+error[E0790]: cannot call associated function on trait without specifying the corresponding `impl` type
+ --> src/main.rs:20:43
+ |
+2 | fn baby_name() -> String;
+ | ------------------------- `Animal::baby_name` defined here
+...
+20 | println!("A baby dog is called a {}", Animal::baby_name());
+ | ^^^^^^^^^^^^^^^^^^^ cannot call associated function of trait
+ |
+help: use the fully-qualified path to the only available implementation
+ |
+20 | println!("A baby dog is called a {}", <Dog as Animal>::baby_name());
+ | +++++++ +
+
+For more information about this error, try `rustc --explain E0790`.
+error: could not compile `traits-example` (bin "traits-example") due to 1 previous error
+
+
To disambiguate and tell Rust that we want to use the implementation of
+Animal for Dog as opposed to the implementation of Animal for some other
+type, we need to use fully qualified syntax. Listing 19-21 demonstrates how to
+use fully qualified syntax.
+
Filename: src/main.rs
+
trait Animal {
+ fn baby_name() -> String;
+}
+
+struct Dog;
+
+impl Dog {
+ fn baby_name() -> String {
+ String::from("Spot")
+ }
+}
+
+impl Animal for Dog {
+ fn baby_name() -> String {
+ String::from("puppy")
+ }
+}
+
+fn main() {
+ println!("A baby dog is called a {}", <Dog as Animal>::baby_name());
+}
+
Listing 19-21: Using fully qualified syntax to specify
+that we want to call the baby_name function from the Animal trait as
+implemented on Dog
+
We’re providing Rust with a type annotation within the angle brackets, which
+indicates we want to call the baby_name method from the Animal trait as
+implemented on Dog by saying that we want to treat the Dog type as an
+Animal for this function call. This code will now print what we want:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+ Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.48s
+ Running `target/debug/traits-example`
+A baby dog is called a puppy
+
+
In general, fully qualified syntax is defined as follows:
+
<Type as Trait>::function(receiver_if_method, next_arg, ...);
+
For associated functions that aren’t methods, there would not be a receiver:
+there would only be the list of other arguments. You could use fully qualified
+syntax everywhere that you call functions or methods. However, you’re allowed
+to omit any part of this syntax that Rust can figure out from other information
+in the program. You only need to use this more verbose syntax in cases where
+there are multiple implementations that use the same name and Rust needs help
+to identify which implementation you want to call.
Sometimes, you might write a trait definition that depends on another trait:
+for a type to implement the first trait, you want to require that type to also
+implement the second trait. You would do this so that your trait definition can
+make use of the associated items of the second trait. The trait your trait
+definition is relying on is called a supertrait of your trait.
+
For example, let’s say we want to make an OutlinePrint trait with an
+outline_print method that will print a given value formatted so that it’s
+framed in asterisks. That is, given a Point struct that implements the
+standard library trait Display to result in (x, y), when we call
+outline_print on a Point instance that has 1 for x and 3 for y, it
+should print the following:
+
**********
+* *
+* (1, 3) *
+* *
+**********
+
+
In the implementation of the outline_print method, we want to use the
+Display trait’s functionality. Therefore, we need to specify that the
+OutlinePrint trait will work only for types that also implement Display and
+provide the functionality that OutlinePrint needs. We can do that in the
+trait definition by specifying OutlinePrint: Display. This technique is
+similar to adding a trait bound to the trait. Listing 19-22 shows an
+implementation of the OutlinePrint trait.
Listing 19-22: Implementing the OutlinePrint trait that
+requires the functionality from Display
+
Because we’ve specified that OutlinePrint requires the Display trait, we
+can use the to_string function that is automatically implemented for any type
+that implements Display. If we tried to use to_string without adding a
+colon and specifying the Display trait after the trait name, we’d get an
+error saying that no method named to_string was found for the type &Self in
+the current scope.
+
Let’s see what happens when we try to implement OutlinePrint on a type that
+doesn’t implement Display, such as the Point struct:
+
Filename: src/main.rs
+
use std::fmt;
+
+trait OutlinePrint: fmt::Display {
+ fn outline_print(&self) {
+ let output = self.to_string();
+ let len = output.len();
+ println!("{}", "*".repeat(len + 4));
+ println!("*{}*", " ".repeat(len + 2));
+ println!("* {output} *");
+ println!("*{}*", " ".repeat(len + 2));
+ println!("{}", "*".repeat(len + 4));
+ }
+}
+
+struct Point {
+ x: i32,
+ y: i32,
+}
+
+impl OutlinePrint for Point {}
+
+fn main() {
+ let p = Point { x: 1, y: 3 };
+ p.outline_print();
+}
+
We get an error saying that Display is required but not implemented:
+
$ cargo run
+ Compiling traits-example v0.1.0 (file:///projects/traits-example)
+error[E0277]: `Point` doesn't implement `std::fmt::Display`
+ --> src/main.rs:20:23
+ |
+20 | impl OutlinePrint for Point {}
+ | ^^^^^ `Point` cannot be formatted with the default formatter
+ |
+ = help: the trait `std::fmt::Display` is not implemented for `Point`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+note: required by a bound in `OutlinePrint`
+ --> src/main.rs:3:21
+ |
+3 | trait OutlinePrint: fmt::Display {
+ | ^^^^^^^^^^^^ required by this bound in `OutlinePrint`
+
+error[E0277]: `Point` doesn't implement `std::fmt::Display`
+ --> src/main.rs:24:7
+ |
+24 | p.outline_print();
+ | ^^^^^^^^^^^^^ `Point` cannot be formatted with the default formatter
+ |
+ = help: the trait `std::fmt::Display` is not implemented for `Point`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+note: required by a bound in `OutlinePrint::outline_print`
+ --> src/main.rs:3:21
+ |
+3 | trait OutlinePrint: fmt::Display {
+ | ^^^^^^^^^^^^ required by this bound in `OutlinePrint::outline_print`
+4 | fn outline_print(&self) {
+ | ------------- required by a bound in this associated function
+
+For more information about this error, try `rustc --explain E0277`.
+error: could not compile `traits-example` (bin "traits-example") due to 2 previous errors
+
+
To fix this, we implement Display on Point and satisfy the constraint that
+OutlinePrint requires, like so:
+
Filename: src/main.rs
+
trait OutlinePrint: fmt::Display {
+ fn outline_print(&self) {
+ let output = self.to_string();
+ let len = output.len();
+ println!("{}", "*".repeat(len + 4));
+ println!("*{}*", " ".repeat(len + 2));
+ println!("* {output} *");
+ println!("*{}*", " ".repeat(len + 2));
+ println!("{}", "*".repeat(len + 4));
+ }
+}
+
+struct Point {
+ x: i32,
+ y: i32,
+}
+
+impl OutlinePrint for Point {}
+
+use std::fmt;
+
+impl fmt::Display for Point {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ write!(f, "({}, {})", self.x, self.y)
+ }
+}
+
+fn main() {
+ let p = Point { x: 1, y: 3 };
+ p.outline_print();
+}
+
Then implementing the OutlinePrint trait on Point will compile
+successfully, and we can call outline_print on a Point instance to display
+it within an outline of asterisks.
In Chapter 10 in the “Implementing a Trait on a
+Type” section, we mentioned the
+orphan rule that states we’re only allowed to implement a trait on a type if
+either the trait or the type are local to our crate. It’s possible to get
+around this restriction using the newtype pattern, which involves creating a
+new type in a tuple struct. (We covered tuple structs in the “Using Tuple
+Structs without Named Fields to Create Different Types” section of Chapter 5.) The tuple struct will have one field and be a
+thin wrapper around the type we want to implement a trait for. Then the wrapper
+type is local to our crate, and we can implement the trait on the wrapper.
+Newtype is a term that originates from the Haskell programming language.
+There is no runtime performance penalty for using this pattern, and the wrapper
+type is elided at compile time.
+
As an example, let’s say we want to implement Display on Vec<T>, which the
+orphan rule prevents us from doing directly because the Display trait and the
+Vec<T> type are defined outside our crate. We can make a Wrapper struct
+that holds an instance of Vec<T>; then we can implement Display on
+Wrapper and use the Vec<T> value, as shown in Listing 19-23.
Listing 19-23: Creating a Wrapper type around
+Vec<String> to implement Display
+
The implementation of Display uses self.0 to access the inner Vec<T>,
+because Wrapper is a tuple struct and Vec<T> is the item at index 0 in the
+tuple. Then we can use the functionality of the Display trait on Wrapper.
+
The downside of using this technique is that Wrapper is a new type, so it
+doesn’t have the methods of the value it’s holding. We would have to implement
+all the methods of Vec<T> directly on Wrapper such that the methods
+delegate to self.0, which would allow us to treat Wrapper exactly like a
+Vec<T>. If we wanted the new type to have every method the inner type has,
+implementing the Deref trait (discussed in Chapter 15 in the “Treating Smart
+Pointers Like Regular References with the Deref
+Trait” section) on the Wrapper to return
+the inner type would be a solution. If we don’t want the Wrapper type to have
+all the methods of the inner type—for example, to restrict the Wrapper type’s
+behavior—we would have to implement just the methods we do want manually.
+
This newtype pattern is also useful even when traits are not involved. Let’s
+switch focus and look at some advanced ways to interact with Rust’s type system.
The Rust type system has some features that we’ve so far mentioned but haven’t
+yet discussed. We’ll start by discussing newtypes in general as we examine why
+newtypes are useful as types. Then we’ll move on to type aliases, a feature
+similar to newtypes but with slightly different semantics. We’ll also discuss
+the ! type and dynamically sized types.
The newtype pattern is also useful for tasks beyond those we’ve discussed so
+far, including statically enforcing that values are never confused and
+indicating the units of a value. You saw an example of using newtypes to
+indicate units in Listing 19-15: recall that the Millimeters and Meters
+structs wrapped u32 values in a newtype. If we wrote a function with a
+parameter of type Millimeters, we couldn’t compile a program that
+accidentally tried to call that function with a value of type Meters or a
+plain u32.
+
We can also use the newtype pattern to abstract away some implementation
+details of a type: the new type can expose a public API that is different from
+the API of the private inner type.
+
Newtypes can also hide internal implementation. For example, we could provide a
+People type to wrap a HashMap<i32, String> that stores a person’s ID
+associated with their name. Code using People would only interact with the
+public API we provide, such as a method to add a name string to the People
+collection; that code wouldn’t need to know that we assign an i32 ID to names
+internally. The newtype pattern is a lightweight way to achieve encapsulation
+to hide implementation details, which we discussed in the “Encapsulation that
+Hides Implementation
+Details”
+section of Chapter 17.
Rust provides the ability to declare a type alias to give an existing type
+another name. For this we use the type keyword. For example, we can create
+the alias Kilometers to i32 like so:
+
fn main() {
+ type Kilometers = i32;
+
+ let x: i32 = 5;
+ let y: Kilometers = 5;
+
+ println!("x + y = {}", x + y);
+}
+
Now, the alias Kilometers is a synonym for i32; unlike the Millimeters
+and Meters types we created in Listing 19-15, Kilometers is not a separate,
+new type. Values that have the type Kilometers will be treated the same as
+values of type i32:
+
fn main() {
+ type Kilometers = i32;
+
+ let x: i32 = 5;
+ let y: Kilometers = 5;
+
+ println!("x + y = {}", x + y);
+}
+
Because Kilometers and i32 are the same type, we can add values of both
+types and we can pass Kilometers values to functions that take i32
+parameters. However, using this method, we don’t get the type checking benefits
+that we get from the newtype pattern discussed earlier. In other words, if we
+mix up Kilometers and i32 values somewhere, the compiler will not give us
+an error.
+
The main use case for type synonyms is to reduce repetition. For example, we
+might have a lengthy type like this:
+
Box<dyn Fn() + Send + 'static>
+
Writing this lengthy type in function signatures and as type annotations all
+over the code can be tiresome and error prone. Imagine having a project full of
+code like that in Listing 19-24.
A type alias makes this code more manageable by reducing the repetition. In
+Listing 19-25, we’ve introduced an alias named Thunk for the verbose type and
+can replace all uses of the type with the shorter alias Thunk.
Listing 19-25: Introducing a type alias Thunk to reduce
+repetition
+
This code is much easier to read and write! Choosing a meaningful name for a
+type alias can help communicate your intent as well (thunk is a word for code
+to be evaluated at a later time, so it’s an appropriate name for a closure that
+gets stored).
+
Type aliases are also commonly used with the Result<T, E> type for reducing
+repetition. Consider the std::io module in the standard library. I/O
+operations often return a Result<T, E> to handle situations when operations
+fail to work. This library has a std::io::Error struct that represents all
+possible I/O errors. Many of the functions in std::io will be returning
+Result<T, E> where the E is std::io::Error, such as these functions in
+the Write trait:
Because this declaration is in the std::io module, we can use the fully
+qualified alias std::io::Result<T>; that is, a Result<T, E> with the E
+filled in as std::io::Error. The Write trait function signatures end up
+looking like this:
The type alias helps in two ways: it makes code easier to write and it gives
+us a consistent interface across all of std::io. Because it’s an alias, it’s
+just another Result<T, E>, which means we can use any methods that work on
+Result<T, E> with it, as well as special syntax like the ? operator.
Rust has a special type named ! that’s known in type theory lingo as the
+empty type because it has no values. We prefer to call it the never type
+because it stands in the place of the return type when a function will never
+return. Here is an example:
+
fn bar() -> ! {
+ // --snip--
+ panic!();
+}
+
This code is read as “the function bar returns never.” Functions that return
+never are called diverging functions. We can’t create values of the type !
+so bar can never possibly return.
+
But what use is a type you can never create values for? Recall the code from
+Listing 2-5, part of the number guessing game; we’ve reproduced a bit of it
+here in Listing 19-26.
Listing 19-26: A match with an arm that ends in
+continue
+
At the time, we skipped over some details in this code. In Chapter 6 in “The
+match Control Flow Operator”
+section, we discussed that match arms must all return the same type. So, for
+example, the following code doesn’t work:
+
fn main() {
+ let guess = "3";
+ let guess = match guess.trim().parse() {
+ Ok(_) => 5,
+ Err(_) => "hello",
+ };
+}
+
The type of guess in this code would have to be an integer and a string,
+and Rust requires that guess have only one type. So what does continue
+return? How were we allowed to return a u32 from one arm and have another arm
+that ends with continue in Listing 19-26?
+
As you might have guessed, continue has a ! value. That is, when Rust
+computes the type of guess, it looks at both match arms, the former with a
+value of u32 and the latter with a ! value. Because ! can never have a
+value, Rust decides that the type of guess is u32.
+
The formal way of describing this behavior is that expressions of type ! can
+be coerced into any other type. We’re allowed to end this match arm with
+continue because continue doesn’t return a value; instead, it moves control
+back to the top of the loop, so in the Err case, we never assign a value to
+guess.
+
The never type is useful with the panic! macro as well. Recall the unwrap
+function that we call on Option<T> values to produce a value or panic with
+this definition:
In this code, the same thing happens as in the match in Listing 19-26: Rust
+sees that val has the type T and panic! has the type !, so the result
+of the overall match expression is T. This code works because panic!
+doesn’t produce a value; it ends the program. In the None case, we won’t be
+returning a value from unwrap, so this code is valid.
+
One final expression that has the type ! is a loop:
Here, the loop never ends, so ! is the value of the expression. However, this
+wouldn’t be true if we included a break, because the loop would terminate
+when it got to the break.
Rust needs to know certain details about its types, such as how much space to
+allocate for a value of a particular type. This leaves one corner of its type
+system a little confusing at first: the concept of dynamically sized types.
+Sometimes referred to as DSTs or unsized types, these types let us write
+code using values whose size we can know only at runtime.
+
Let’s dig into the details of a dynamically sized type called str, which
+we’ve been using throughout the book. That’s right, not &str, but str on
+its own, is a DST. We can’t know how long the string is until runtime, meaning
+we can’t create a variable of type str, nor can we take an argument of type
+str. Consider the following code, which does not work:
+
fn main() {
+ let s1: str = "Hello there!";
+ let s2: str = "How's it going?";
+}
+
Rust needs to know how much memory to allocate for any value of a particular
+type, and all values of a type must use the same amount of memory. If Rust
+allowed us to write this code, these two str values would need to take up the
+same amount of space. But they have different lengths: s1 needs 12 bytes of
+storage and s2 needs 15. This is why it’s not possible to create a variable
+holding a dynamically sized type.
+
So what do we do? In this case, you already know the answer: we make the types
+of s1 and s2 a &str rather than a str. Recall from the “String
+Slices” section of Chapter 4 that the slice data
+structure just stores the starting position and the length of the slice. So
+although a &T is a single value that stores the memory address of where the
+T is located, a &str is two values: the address of the str and its
+length. As such, we can know the size of a &str value at compile time: it’s
+twice the length of a usize. That is, we always know the size of a &str, no
+matter how long the string it refers to is. In general, this is the way in
+which dynamically sized types are used in Rust: they have an extra bit of
+metadata that stores the size of the dynamic information. The golden rule of
+dynamically sized types is that we must always put values of dynamically sized
+types behind a pointer of some kind.
+
We can combine str with all kinds of pointers: for example, Box<str> or
+Rc<str>. In fact, you’ve seen this before but with a different dynamically
+sized type: traits. Every trait is a dynamically sized type we can refer to by
+using the name of the trait. In Chapter 17 in the “Using Trait Objects That
+Allow for Values of Different
+Types” section, we mentioned that to use traits as trait objects, we must
+put them behind a pointer, such as &dyn Trait or Box<dyn Trait> (Rc<dyn Trait> would work too).
+
To work with DSTs, Rust provides the Sized trait to determine whether or not
+a type’s size is known at compile time. This trait is automatically implemented
+for everything whose size is known at compile time. In addition, Rust
+implicitly adds a bound on Sized to every generic function. That is, a
+generic function definition like this:
+
fn generic<T>(t: T) {
+ // --snip--
+}
+
is actually treated as though we had written this:
+
fn generic<T: Sized>(t: T) {
+ // --snip--
+}
+
By default, generic functions will work only on types that have a known size at
+compile time. However, you can use the following special syntax to relax this
+restriction:
+
fn generic<T: ?Sized>(t: &T) {
+ // --snip--
+}
+
A trait bound on ?Sized means “T may or may not be Sized” and this
+notation overrides the default that generic types must have a known size at
+compile time. The ?Trait syntax with this meaning is only available for
+Sized, not any other traits.
+
Also note that we switched the type of the t parameter from T to &T.
+Because the type might not be Sized, we need to use it behind some kind of
+pointer. In this case, we’ve chosen a reference.
We’ve talked about how to pass closures to functions; you can also pass regular
+functions to functions! This technique is useful when you want to pass a
+function you’ve already defined rather than defining a new closure. Functions
+coerce to the type fn (with a lowercase f), not to be confused with the Fn
+closure trait. The fn type is called a function pointer. Passing functions
+with function pointers will allow you to use functions as arguments to other
+functions.
+
The syntax for specifying that a parameter is a function pointer is similar to
+that of closures, as shown in Listing 19-27, where we’ve defined a function
+add_one that adds one to its parameter. The function do_twice takes two
+parameters: a function pointer to any function that takes an i32 parameter
+and returns an i32, and one i32 value. The do_twice function calls the
+function f twice, passing it the arg value, then adds the two function call
+results together. The main function calls do_twice with the arguments
+add_one and 5.
Listing 19-27: Using the fn type to accept a function
+pointer as an argument
+
This code prints The answer is: 12. We specify that the parameter f in
+do_twice is an fn that takes one parameter of type i32 and returns an
+i32. We can then call f in the body of do_twice. In main, we can pass
+the function name add_one as the first argument to do_twice.
+
Unlike closures, fn is a type rather than a trait, so we specify fn as the
+parameter type directly rather than declaring a generic type parameter with one
+of the Fn traits as a trait bound.
+
Function pointers implement all three of the closure traits (Fn, FnMut, and
+FnOnce), meaning you can always pass a function pointer as an argument for a
+function that expects a closure. It’s best to write functions using a generic
+type and one of the closure traits so your functions can accept either
+functions or closures.
+
That said, one example of where you would want to only accept fn and not
+closures is when interfacing with external code that doesn’t have closures: C
+functions can accept functions as arguments, but C doesn’t have closures.
+
As an example of where you could use either a closure defined inline or a named
+function, let’s look at a use of the map method provided by the Iterator
+trait in the standard library. To use the map function to turn a vector of
+numbers into a vector of strings, we could use a closure, like this:
+
fn main() {
+ let list_of_numbers = vec![1, 2, 3];
+ let list_of_strings: Vec<String> =
+ list_of_numbers.iter().map(|i| i.to_string()).collect();
+}
+
Or we could name a function as the argument to map instead of the closure,
+like this:
+
fn main() {
+ let list_of_numbers = vec![1, 2, 3];
+ let list_of_strings: Vec<String> =
+ list_of_numbers.iter().map(ToString::to_string).collect();
+}
+
Note that we must use the fully qualified syntax that we talked about earlier
+in the “Advanced Traits” section because
+there are multiple functions available named to_string. Here, we’re using the
+to_string function defined in the ToString trait, which the standard
+library has implemented for any type that implements Display.
+
Recall from the “Enum values” section of Chapter
+6 that the name of each enum variant that we define also becomes an initializer
+function. We can use these initializer functions as function pointers that
+implement the closure traits, which means we can specify the initializer
+functions as arguments for methods that take closures, like so:
Here we create Status::Value instances using each u32 value in the range
+that map is called on by using the initializer function of Status::Value.
+Some people prefer this style, and some people prefer to use closures. They
+compile to the same code, so use whichever style is clearer to you.
Closures are represented by traits, which means you can’t return closures
+directly. In most cases where you might want to return a trait, you can instead
+use the concrete type that implements the trait as the return value of the
+function. However, you can’t do that with closures because they don’t have a
+concrete type that is returnable; you’re not allowed to use the function
+pointer fn as a return type, for example.
+
The following code tries to return a closure directly, but it won’t compile:
$ cargo build
+ Compiling functions-example v0.1.0 (file:///projects/functions-example)
+error[E0746]: return type cannot have an unboxed trait object
+ --> src/lib.rs:1:25
+ |
+1 | fn returns_closure() -> dyn Fn(i32) -> i32 {
+ | ^^^^^^^^^^^^^^^^^^ doesn't have a size known at compile-time
+ |
+help: return an `impl Trait` instead of a `dyn Trait`, if all returned values are the same type
+ |
+1 | fn returns_closure() -> impl Fn(i32) -> i32 {
+ | ~~~~
+help: box the return type, and wrap all of the returned values in `Box::new`
+ |
+1 ~ fn returns_closure() -> Box<dyn Fn(i32) -> i32> {
+2 ~ Box::new(|x| x + 1)
+ |
+
+For more information about this error, try `rustc --explain E0746`.
+error: could not compile `functions-example` (lib) due to 1 previous error
+
+
The error references the Sized trait again! Rust doesn’t know how much space
+it will need to store the closure. We saw a solution to this problem earlier.
+We can use a trait object:
We’ve used macros like println! throughout this book, but we haven’t fully
+explored what a macro is and how it works. The term macro refers to a family
+of features in Rust: declarative macros with macro_rules! and three kinds
+of procedural macros:
+
+
Custom #[derive] macros that specify code added with the derive attribute
+used on structs and enums
+
Attribute-like macros that define custom attributes usable on any item
+
Function-like macros that look like function calls but operate on the tokens
+specified as their argument
+
+
We’ll talk about each of these in turn, but first, let’s look at why we even
+need macros when we already have functions.
Fundamentally, macros are a way of writing code that writes other code, which
+is known as metaprogramming. In Appendix C, we discuss the derive
+attribute, which generates an implementation of various traits for you. We’ve
+also used the println! and vec! macros throughout the book. All of these
+macros expand to produce more code than the code you’ve written manually.
+
Metaprogramming is useful for reducing the amount of code you have to write and
+maintain, which is also one of the roles of functions. However, macros have
+some additional powers that functions don’t.
+
A function signature must declare the number and type of parameters the
+function has. Macros, on the other hand, can take a variable number of
+parameters: we can call println!("hello") with one argument or
+println!("hello {}", name) with two arguments. Also, macros are expanded
+before the compiler interprets the meaning of the code, so a macro can, for
+example, implement a trait on a given type. A function can’t, because it gets
+called at runtime and a trait needs to be implemented at compile time.
+
The downside to implementing a macro instead of a function is that macro
+definitions are more complex than function definitions because you’re writing
+Rust code that writes Rust code. Due to this indirection, macro definitions are
+generally more difficult to read, understand, and maintain than function
+definitions.
+
Another important difference between macros and functions is that you must
+define macros or bring them into scope before you call them in a file, as
+opposed to functions you can define anywhere and call anywhere.
The most widely used form of macros in Rust is the declarative macro. These
+are also sometimes referred to as “macros by example,” “macro_rules! macros,”
+or just plain “macros.” At their core, declarative macros allow you to write
+something similar to a Rust match expression. As discussed in Chapter 6,
+match expressions are control structures that take an expression, compare the
+resulting value of the expression to patterns, and then run the code associated
+with the matching pattern. Macros also compare a value to patterns that are
+associated with particular code: in this situation, the value is the literal
+Rust source code passed to the macro; the patterns are compared with the
+structure of that source code; and the code associated with each pattern, when
+matched, replaces the code passed to the macro. This all happens during
+compilation.
+
To define a macro, you use the macro_rules! construct. Let’s explore how to
+use macro_rules! by looking at how the vec! macro is defined. Chapter 8
+covered how we can use the vec! macro to create a new vector with particular
+values. For example, the following macro creates a new vector containing three
+integers:
We could also use the vec! macro to make a vector of two integers or a vector
+of five string slices. We wouldn’t be able to use a function to do the same
+because we wouldn’t know the number or type of values up front.
+
Listing 19-28 shows a slightly simplified definition of the vec! macro.
Listing 19-28: A simplified version of the vec! macro
+definition
+
+
Note: The actual definition of the vec! macro in the standard library
+includes code to preallocate the correct amount of memory up front. That code
+is an optimization that we don’t include here to make the example simpler.
+
+
The #[macro_export] annotation indicates that this macro should be made
+available whenever the crate in which the macro is defined is brought into
+scope. Without this annotation, the macro can’t be brought into scope.
+
We then start the macro definition with macro_rules! and the name of the
+macro we’re defining without the exclamation mark. The name, in this case
+vec, is followed by curly brackets denoting the body of the macro definition.
+
The structure in the vec! body is similar to the structure of a match
+expression. Here we have one arm with the pattern ( $( $x:expr ),* ),
+followed by => and the block of code associated with this pattern. If the
+pattern matches, the associated block of code will be emitted. Given that this
+is the only pattern in this macro, there is only one valid way to match; any
+other pattern will result in an error. More complex macros will have more than
+one arm.
+
Valid pattern syntax in macro definitions is different than the pattern syntax
+covered in Chapter 18 because macro patterns are matched against Rust code
+structure rather than values. Let’s walk through what the pattern pieces in
+Listing 19-28 mean; for the full macro pattern syntax, see the Rust
+Reference.
+
First, we use a set of parentheses to encompass the whole pattern. We use a
+dollar sign ($) to declare a variable in the macro system that will contain
+the Rust code matching the pattern. The dollar sign makes it clear this is a
+macro variable as opposed to a regular Rust variable. Next comes a set of
+parentheses that captures values that match the pattern within the parentheses
+for use in the replacement code. Within $() is $x:expr, which matches any
+Rust expression and gives the expression the name $x.
+
The comma following $() indicates that a literal comma separator character
+could optionally appear after the code that matches the code in $(). The *
+specifies that the pattern matches zero or more of whatever precedes the *.
+
When we call this macro with vec![1, 2, 3];, the $x pattern matches three
+times with the three expressions 1, 2, and 3.
+
Now let’s look at the pattern in the body of the code associated with this arm:
+temp_vec.push() within $()* is generated for each part that matches $()
+in the pattern zero or more times depending on how many times the pattern
+matches. The $x is replaced with each expression matched. When we call this
+macro with vec![1, 2, 3];, the code generated that replaces this macro call
+will be the following:
We’ve defined a macro that can take any number of arguments of any type and can
+generate code to create a vector containing the specified elements.
+
To learn more about how to write macros, consult the online documentation or
+other resources, such as “The Little Book of Rust Macros” started by
+Daniel Keep and continued by Lukas Wirth.
The second form of macros is the procedural macro, which acts more like a
+function (and is a type of procedure). Procedural macros accept some code as an
+input, operate on that code, and produce some code as an output rather than
+matching against patterns and replacing the code with other code as declarative
+macros do. The three kinds of procedural macros are custom derive,
+attribute-like, and function-like, and all work in a similar fashion.
+
When creating procedural macros, the definitions must reside in their own crate
+with a special crate type. This is for complex technical reasons that we hope
+to eliminate in the future. In Listing 19-29, we show how to define a
+procedural macro, where some_attribute is a placeholder for using a specific
+macro variety.
Listing 19-29: An example of defining a procedural
+macro
+
The function that defines a procedural macro takes a TokenStream as an input
+and produces a TokenStream as an output. The TokenStream type is defined by
+the proc_macro crate that is included with Rust and represents a sequence of
+tokens. This is the core of the macro: the source code that the macro is
+operating on makes up the input TokenStream, and the code the macro produces
+is the output TokenStream. The function also has an attribute attached to it
+that specifies which kind of procedural macro we’re creating. We can have
+multiple kinds of procedural macros in the same crate.
+
Let’s look at the different kinds of procedural macros. We’ll start with a
+custom derive macro and then explain the small dissimilarities that make the
+other forms different.
Let’s create a crate named hello_macro that defines a trait named
+HelloMacro with one associated function named hello_macro. Rather than
+making our users implement the HelloMacro trait for each of their types,
+we’ll provide a procedural macro so users can annotate their type with
+#[derive(HelloMacro)] to get a default implementation of the hello_macro
+function. The default implementation will print Hello, Macro! My name is TypeName! where TypeName is the name of the type on which this trait has
+been defined. In other words, we’ll write a crate that enables another
+programmer to write code like Listing 19-30 using our crate.
Listing 19-30: The code a user of our crate will be able
+to write when using our procedural macro
+
This code will print Hello, Macro! My name is Pancakes! when we’re done. The
+first step is to make a new library crate, like this:
+
$ cargo new hello_macro --lib
+
+
Next, we’ll define the HelloMacro trait and its associated function:
+
Filename: src/lib.rs
+
pub trait HelloMacro {
+ fn hello_macro();
+}
+
We have a trait and its function. At this point, our crate user could implement
+the trait to achieve the desired functionality, like so:
+
use hello_macro::HelloMacro;
+
+struct Pancakes;
+
+impl HelloMacro for Pancakes {
+ fn hello_macro() {
+ println!("Hello, Macro! My name is Pancakes!");
+ }
+}
+
+fn main() {
+ Pancakes::hello_macro();
+}
+
However, they would need to write the implementation block for each type they
+wanted to use with hello_macro; we want to spare them from having to do this
+work.
+
Additionally, we can’t yet provide the hello_macro function with default
+implementation that will print the name of the type the trait is implemented
+on: Rust doesn’t have reflection capabilities, so it can’t look up the type’s
+name at runtime. We need a macro to generate code at compile time.
+
The next step is to define the procedural macro. At the time of this writing,
+procedural macros need to be in their own crate. Eventually, this restriction
+might be lifted. The convention for structuring crates and macro crates is as
+follows: for a crate named foo, a custom derive procedural macro crate is
+called foo_derive. Let’s start a new crate called hello_macro_derive inside
+our hello_macro project:
+
$ cargo new hello_macro_derive --lib
+
+
Our two crates are tightly related, so we create the procedural macro crate
+within the directory of our hello_macro crate. If we change the trait
+definition in hello_macro, we’ll have to change the implementation of the
+procedural macro in hello_macro_derive as well. The two crates will need to
+be published separately, and programmers using these crates will need to add
+both as dependencies and bring them both into scope. We could instead have the
+hello_macro crate use hello_macro_derive as a dependency and re-export the
+procedural macro code. However, the way we’ve structured the project makes it
+possible for programmers to use hello_macro even if they don’t want the
+derive functionality.
+
We need to declare the hello_macro_derive crate as a procedural macro crate.
+We’ll also need functionality from the syn and quote crates, as you’ll see
+in a moment, so we need to add them as dependencies. Add the following to the
+Cargo.toml file for hello_macro_derive:
To start defining the procedural macro, place the code in Listing 19-31 into
+your src/lib.rs file for the hello_macro_derive crate. Note that this code
+won’t compile until we add a definition for the impl_hello_macro function.
+
Filename: hello_macro_derive/src/lib.rs
+
use proc_macro::TokenStream;
+use quote::quote;
+
+#[proc_macro_derive(HelloMacro)]
+pub fn hello_macro_derive(input: TokenStream) -> TokenStream {
+ // Construct a representation of Rust code as a syntax tree
+ // that we can manipulate
+ let ast = syn::parse(input).unwrap();
+
+ // Build the trait implementation
+ impl_hello_macro(&ast)
+}
+
Listing 19-31: Code that most procedural macro crates
+will require in order to process Rust code
+
Notice that we’ve split the code into the hello_macro_derive function, which
+is responsible for parsing the TokenStream, and the impl_hello_macro
+function, which is responsible for transforming the syntax tree: this makes
+writing a procedural macro more convenient. The code in the outer function
+(hello_macro_derive in this case) will be the same for almost every
+procedural macro crate you see or create. The code you specify in the body of
+the inner function (impl_hello_macro in this case) will be different
+depending on your procedural macro’s purpose.
+
We’ve introduced three new crates: proc_macro, syn, and quote. The
+proc_macro crate comes with Rust, so we didn’t need to add that to the
+dependencies in Cargo.toml. The proc_macro crate is the compiler’s API that
+allows us to read and manipulate Rust code from our code.
+
The syn crate parses Rust code from a string into a data structure that we
+can perform operations on. The quote crate turns syn data structures back
+into Rust code. These crates make it much simpler to parse any sort of Rust
+code we might want to handle: writing a full parser for Rust code is no simple
+task.
+
The hello_macro_derive function will be called when a user of our library
+specifies #[derive(HelloMacro)] on a type. This is possible because we’ve
+annotated the hello_macro_derive function here with proc_macro_derive and
+specified the name HelloMacro, which matches our trait name; this is the
+convention most procedural macros follow.
+
The hello_macro_derive function first converts the input from a
+TokenStream to a data structure that we can then interpret and perform
+operations on. This is where syn comes into play. The parse function in
+syn takes a TokenStream and returns a DeriveInput struct representing the
+parsed Rust code. Listing 19-32 shows the relevant parts of the DeriveInput
+struct we get from parsing the struct Pancakes; string:
Listing 19-32: The DeriveInput instance we get when
+parsing the code that has the macro’s attribute in Listing 19-30
+
The fields of this struct show that the Rust code we’ve parsed is a unit struct
+with the ident (identifier, meaning the name) of Pancakes. There are more
+fields on this struct for describing all sorts of Rust code; check the syn
+documentation for DeriveInput for more information.
+
Soon we’ll define the impl_hello_macro function, which is where we’ll build
+the new Rust code we want to include. But before we do, note that the output
+for our derive macro is also a TokenStream. The returned TokenStream is
+added to the code that our crate users write, so when they compile their crate,
+they’ll get the extra functionality that we provide in the modified
+TokenStream.
+
You might have noticed that we’re calling unwrap to cause the
+hello_macro_derive function to panic if the call to the syn::parse function
+fails here. It’s necessary for our procedural macro to panic on errors because
+proc_macro_derive functions must return TokenStream rather than Result to
+conform to the procedural macro API. We’ve simplified this example by using
+unwrap; in production code, you should provide more specific error messages
+about what went wrong by using panic! or expect.
+
Now that we have the code to turn the annotated Rust code from a TokenStream
+into a DeriveInput instance, let’s generate the code that implements the
+HelloMacro trait on the annotated type, as shown in Listing 19-33.
+
Filename: hello_macro_derive/src/lib.rs
+
use proc_macro::TokenStream;
+use quote::quote;
+
+#[proc_macro_derive(HelloMacro)]
+pub fn hello_macro_derive(input: TokenStream) -> TokenStream {
+ // Construct a representation of Rust code as a syntax tree
+ // that we can manipulate
+ let ast = syn::parse(input).unwrap();
+
+ // Build the trait implementation
+ impl_hello_macro(&ast)
+}
+
+fn impl_hello_macro(ast: &syn::DeriveInput) -> TokenStream {
+ let name = &ast.ident;
+ let gen = quote! {
+ impl HelloMacro for #name {
+ fn hello_macro() {
+ println!("Hello, Macro! My name is {}!", stringify!(#name));
+ }
+ }
+ };
+ gen.into()
+}
+
Listing 19-33: Implementing the HelloMacro trait using
+the parsed Rust code
+
We get an Ident struct instance containing the name (identifier) of the
+annotated type using ast.ident. The struct in Listing 19-32 shows that when
+we run the impl_hello_macro function on the code in Listing 19-30, the
+ident we get will have the ident field with a value of "Pancakes". Thus,
+the name variable in Listing 19-33 will contain an Ident struct instance
+that, when printed, will be the string "Pancakes", the name of the struct in
+Listing 19-30.
+
The quote! macro lets us define the Rust code that we want to return. The
+compiler expects something different to the direct result of the quote!
+macro’s execution, so we need to convert it to a TokenStream. We do this by
+calling the into method, which consumes this intermediate representation and
+returns a value of the required TokenStream type.
+
The quote! macro also provides some very cool templating mechanics: we can
+enter #name, and quote! will replace it with the value in the variable
+name. You can even do some repetition similar to the way regular macros work.
+Check out the quote crate’s docs for a thorough introduction.
+
We want our procedural macro to generate an implementation of our HelloMacro
+trait for the type the user annotated, which we can get by using #name. The
+trait implementation has the one function hello_macro, whose body contains the
+functionality we want to provide: printing Hello, Macro! My name is and then
+the name of the annotated type.
+
The stringify! macro used here is built into Rust. It takes a Rust
+expression, such as 1 + 2, and at compile time turns the expression into a
+string literal, such as "1 + 2". This is different than format! or
+println!, macros which evaluate the expression and then turn the result into
+a String. There is a possibility that the #name input might be an
+expression to print literally, so we use stringify!. Using stringify! also
+saves an allocation by converting #name to a string literal at compile time.
+
At this point, cargo build should complete successfully in both hello_macro
+and hello_macro_derive. Let’s hook up these crates to the code in Listing
+19-30 to see the procedural macro in action! Create a new binary project in
+your projects directory using cargo new pancakes. We need to add
+hello_macro and hello_macro_derive as dependencies in the pancakes
+crate’s Cargo.toml. If you’re publishing your versions of hello_macro and
+hello_macro_derive to crates.io, they would be regular
+dependencies; if not, you can specify them as path dependencies as follows:
Put the code in Listing 19-30 into src/main.rs, and run cargo run: it
+should print Hello, Macro! My name is Pancakes! The implementation of the
+HelloMacro trait from the procedural macro was included without the
+pancakes crate needing to implement it; the #[derive(HelloMacro)] added the
+trait implementation.
+
Next, let’s explore how the other kinds of procedural macros differ from custom
+derive macros.
Attribute-like macros are similar to custom derive macros, but instead of
+generating code for the derive attribute, they allow you to create new
+attributes. They’re also more flexible: derive only works for structs and
+enums; attributes can be applied to other items as well, such as functions.
+Here’s an example of using an attribute-like macro: say you have an attribute
+named route that annotates functions when using a web application framework:
+
#[route(GET, "/")]
+fn index() {
+
This #[route] attribute would be defined by the framework as a procedural
+macro. The signature of the macro definition function would look like this:
Here, we have two parameters of type TokenStream. The first is for the
+contents of the attribute: the GET, "/" part. The second is the body of the
+item the attribute is attached to: in this case, fn index() {} and the rest
+of the function’s body.
+
Other than that, attribute-like macros work the same way as custom derive
+macros: you create a crate with the proc-macro crate type and implement a
+function that generates the code you want!
Function-like macros define macros that look like function calls. Similarly to
+macro_rules! macros, they’re more flexible than functions; for example, they
+can take an unknown number of arguments. However, macro_rules! macros can be
+defined only using the match-like syntax we discussed in the section
+“Declarative Macros with macro_rules! for General
+Metaprogramming” earlier. Function-like macros take a
+TokenStream parameter and their definition manipulates that TokenStream
+using Rust code as the other two types of procedural macros do. An example of a
+function-like macro is an sql! macro that might be called like so:
+
let sql = sql!(SELECT * FROM posts WHERE id=1);
+
This macro would parse the SQL statement inside it and check that it’s
+syntactically correct, which is much more complex processing than a
+macro_rules! macro can do. The sql! macro would be defined like this:
This definition is similar to the custom derive macro’s signature: we receive
+the tokens that are inside the parentheses and return the code we wanted to
+generate.
Whew! Now you have some Rust features in your toolbox that you likely won’t use
+often, but you’ll know they’re available in very particular circumstances.
+We’ve introduced several complex topics so that when you encounter them in
+error message suggestions or in other peoples’ code, you’ll be able to
+recognize these concepts and syntax. Use this chapter as a reference to guide
+you to solutions.
+
Next, we’ll put everything we’ve discussed throughout the book into practice
+and do one more project!
It’s been a long journey, but we’ve reached the end of the book. In this
+chapter, we’ll build one more project together to demonstrate some of the
+concepts we covered in the final chapters, as well as recap some earlier
+lessons.
+
For our final project, we’ll make a web server that says “hello” and looks like
+Figure 20-1 in a web browser.
+
+
Figure 20-1: Our final shared project
+
Here is our plan for building the web server:
+
+
Learn a bit about TCP and HTTP.
+
Listen for TCP connections on a socket.
+
Parse a small number of HTTP requests.
+
Create a proper HTTP response.
+
Improve the throughput of our server with a thread pool.
+
+
Before we get started, we should mention one detail: the method we’ll use won’t
+be the best way to build a web server with Rust. Community members have
+published a number of production-ready crates available on
+crates.io that provide more complete web server and
+thread pool implementations than we’ll build. However, our intention in this
+chapter is to help you learn, not to take the easy route. Because Rust is a
+systems programming language, we can choose the level of abstraction we want to
+work with and can go to a lower level than is possible or practical in other
+languages. We’ll therefore write the basic HTTP server and thread pool manually
+so you can learn the general ideas and techniques behind the crates you might
+use in the future.
We’ll start by getting a single-threaded web server working. Before we begin,
+let’s look at a quick overview of the protocols involved in building web
+servers. The details of these protocols are beyond the scope of this book, but
+a brief overview will give you the information you need.
+
The two main protocols involved in web servers are Hypertext Transfer
+Protocol(HTTP) and Transmission Control Protocol(TCP). Both protocols
+are request-response protocols, meaning a client initiates requests and a
+server listens to the requests and provides a response to the client. The
+contents of those requests and responses are defined by the protocols.
+
TCP is the lower-level protocol that describes the details of how information
+gets from one server to another but doesn’t specify what that information is.
+HTTP builds on top of TCP by defining the contents of the requests and
+responses. It’s technically possible to use HTTP with other protocols, but in
+the vast majority of cases, HTTP sends its data over TCP. We’ll work with the
+raw bytes of TCP and HTTP requests and responses.
Our web server needs to listen to a TCP connection, so that’s the first part
+we’ll work on. The standard library offers a std::net module that lets us do
+this. Let’s make a new project in the usual fashion:
+
$ cargo new hello
+ Created binary (application) `hello` project
+$ cd hello
+
+
Now enter the code in Listing 20-1 in src/main.rs to start. This code will
+listen at the local address 127.0.0.1:7878 for incoming TCP streams. When it
+gets an incoming stream, it will print Connection established!.
+
Filename: src/main.rs
+
use std::net::TcpListener;
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ println!("Connection established!");
+ }
+}
+
Listing 20-1: Listening for incoming streams and printing
+a message when we receive a stream
+
Using TcpListener, we can listen for TCP connections at the address
+127.0.0.1:7878. In the address, the section before the colon is an IP address
+representing your computer (this is the same on every computer and doesn’t
+represent the authors’ computer specifically), and 7878 is the port. We’ve
+chosen this port for two reasons: HTTP isn’t normally accepted on this port so
+our server is unlikely to conflict with any other web server you might have
+running on your machine, and 7878 is rust typed on a telephone.
+
The bind function in this scenario works like the new function in that it
+will return a new TcpListener instance. The function is called bind
+because, in networking, connecting to a port to listen to is known as “binding
+to a port.”
+
The bind function returns a Result<T, E>, which indicates that it’s
+possible for binding to fail. For example, connecting to port 80 requires
+administrator privileges (nonadministrators can listen only on ports higher
+than 1023), so if we tried to connect to port 80 without being an
+administrator, binding wouldn’t work. Binding also wouldn’t work, for example,
+if we ran two instances of our program and so had two programs listening to the
+same port. Because we’re writing a basic server just for learning purposes, we
+won’t worry about handling these kinds of errors; instead, we use unwrap to
+stop the program if errors happen.
+
The incoming method on TcpListener returns an iterator that gives us a
+sequence of streams (more specifically, streams of type TcpStream). A single
+stream represents an open connection between the client and the server. A
+connection is the name for the full request and response process in which a
+client connects to the server, the server generates a response, and the server
+closes the connection. As such, we will read from the TcpStream to see what
+the client sent and then write our response to the stream to send data back to
+the client. Overall, this for loop will process each connection in turn and
+produce a series of streams for us to handle.
+
For now, our handling of the stream consists of calling unwrap to terminate
+our program if the stream has any errors; if there aren’t any errors, the
+program prints a message. We’ll add more functionality for the success case in
+the next listing. The reason we might receive errors from the incoming method
+when a client connects to the server is that we’re not actually iterating over
+connections. Instead, we’re iterating over connection attempts. The
+connection might not be successful for a number of reasons, many of them
+operating system specific. For example, many operating systems have a limit to
+the number of simultaneous open connections they can support; new connection
+attempts beyond that number will produce an error until some of the open
+connections are closed.
+
Let’s try running this code! Invoke cargo run in the terminal and then load
+127.0.0.1:7878 in a web browser. The browser should show an error message
+like “Connection reset,” because the server isn’t currently sending back any
+data. But when you look at your terminal, you should see several messages that
+were printed when the browser connected to the server!
Sometimes, you’ll see multiple messages printed for one browser request; the
+reason might be that the browser is making a request for the page as well as a
+request for other resources, like the favicon.ico icon that appears in the
+browser tab.
+
It could also be that the browser is trying to connect to the server multiple
+times because the server isn’t responding with any data. When stream goes out
+of scope and is dropped at the end of the loop, the connection is closed as
+part of the drop implementation. Browsers sometimes deal with closed
+connections by retrying, because the problem might be temporary. The important
+factor is that we’ve successfully gotten a handle to a TCP connection!
+
Remember to stop the program by pressing ctrl-c when
+you’re done running a particular version of the code. Then restart the program
+by invoking the cargo run command after you’ve made each set of code changes
+to make sure you’re running the newest code.
Let’s implement the functionality to read the request from the browser! To
+separate the concerns of first getting a connection and then taking some action
+with the connection, we’ll start a new function for processing connections. In
+this new handle_connection function, we’ll read data from the TCP stream and
+print it so we can see the data being sent from the browser. Change the code to
+look like Listing 20-2.
+
Filename: src/main.rs
+
use std::{
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let http_request: Vec<_> = buf_reader
+ .lines()
+ .map(|result| result.unwrap())
+ .take_while(|line| !line.is_empty())
+ .collect();
+
+ println!("Request: {http_request:#?}");
+}
+
Listing 20-2: Reading from the TcpStream and printing
+the data
+
We bring std::io::prelude and std::io::BufReader into scope to get access
+to traits and types that let us read from and write to the stream. In the for
+loop in the main function, instead of printing a message that says we made a
+connection, we now call the new handle_connection function and pass the
+stream to it.
+
In the handle_connection function, we create a new BufReader instance that
+wraps a mutable reference to the stream. BufReader adds buffering by
+managing calls to the std::io::Read trait methods for us.
+
We create a variable named http_request to collect the lines of the request
+the browser sends to our server. We indicate that we want to collect these
+lines in a vector by adding the Vec<_> type annotation.
+
BufReader implements the std::io::BufRead trait, which provides the lines
+method. The lines method returns an iterator of Result<String, std::io::Error> by splitting the stream of data whenever it sees a newline
+byte. To get each String, we map and unwrap each Result. The Result
+might be an error if the data isn’t valid UTF-8 or if there was a problem
+reading from the stream. Again, a production program should handle these errors
+more gracefully, but we’re choosing to stop the program in the error case for
+simplicity.
+
The browser signals the end of an HTTP request by sending two newline
+characters in a row, so to get one request from the stream, we take lines until
+we get a line that is the empty string. Once we’ve collected the lines into the
+vector, we’re printing them out using pretty debug formatting so we can take a
+look at the instructions the web browser is sending to our server.
+
Let’s try this code! Start the program and make a request in a web browser
+again. Note that we’ll still get an error page in the browser, but our
+program’s output in the terminal will now look similar to this:
Depending on your browser, you might get slightly different output. Now that
+we’re printing the request data, we can see why we get multiple connections
+from one browser request by looking at the path after GET in the first line
+of the request. If the repeated connections are all requesting /, we know the
+browser is trying to fetch / repeatedly because it’s not getting a response
+from our program.
+
Let’s break down this request data to understand what the browser is asking of
+our program.
The first line is the request line that holds information about what the
+client is requesting. The first part of the request line indicates the method
+being used, such as GET or POST, which describes how the client is making
+this request. Our client used a GET request, which means it is asking for
+information.
+
The next part of the request line is /, which indicates the Uniform Resource
+Identifier(URI) the client is requesting: a URI is almost, but not quite,
+the same as a Uniform Resource Locator(URL). The difference between URIs
+and URLs isn’t important for our purposes in this chapter, but the HTTP spec
+uses the term URI, so we can just mentally substitute URL for URI here.
+
The last part is the HTTP version the client uses, and then the request line
+ends in a CRLF sequence. (CRLF stands for carriage return and line feed,
+which are terms from the typewriter days!) The CRLF sequence can also be
+written as \r\n, where \r is a carriage return and \n is a line feed. The
+CRLF sequence separates the request line from the rest of the request data.
+Note that when the CRLF is printed, we see a new line start rather than \r\n.
+
Looking at the request line data we received from running our program so far,
+we see that GET is the method, / is the request URI, and HTTP/1.1 is the
+version.
+
After the request line, the remaining lines starting from Host: onward are
+headers. GET requests have no body.
+
Try making a request from a different browser or asking for a different
+address, such as 127.0.0.1:7878/test, to see how the request data changes.
+
Now that we know what the browser is asking for, let’s send back some data!
The first line is a status line that contains the HTTP version used in the
+response, a numeric status code that summarizes the result of the request, and
+a reason phrase that provides a text description of the status code. After the
+CRLF sequence are any headers, another CRLF sequence, and the body of the
+response.
+
Here is an example response that uses HTTP version 1.1, has a status code of
+200, an OK reason phrase, no headers, and no body:
+
HTTP/1.1 200 OK\r\n\r\n
+
+
The status code 200 is the standard success response. The text is a tiny
+successful HTTP response. Let’s write this to the stream as our response to a
+successful request! From the handle_connection function, remove the
+println! that was printing the request data and replace it with the code in
+Listing 20-3.
+
Filename: src/main.rs
+
use std::{
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let http_request: Vec<_> = buf_reader
+ .lines()
+ .map(|result| result.unwrap())
+ .take_while(|line| !line.is_empty())
+ .collect();
+
+ let response = "HTTP/1.1 200 OK\r\n\r\n";
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-3: Writing a tiny successful HTTP response to
+the stream
+
The first new line defines the response variable that holds the success
+message’s data. Then we call as_bytes on our response to convert the string
+data to bytes. The write_all method on stream takes a &[u8] and sends
+those bytes directly down the connection. Because the write_all operation
+could fail, we use unwrap on any error result as before. Again, in a real
+application you would add error handling here.
+
With these changes, let’s run our code and make a request. We’re no longer
+printing any data to the terminal, so we won’t see any output other than the
+output from Cargo. When you load 127.0.0.1:7878 in a web browser, you should
+get a blank page instead of an error. You’ve just hand-coded receiving an HTTP
+request and sending a response!
Let’s implement the functionality for returning more than a blank page. Create
+the new file hello.html in the root of your project directory, not in the
+src directory. You can input any HTML you want; Listing 20-4 shows one
+possibility.
Listing 20-4: A sample HTML file to return in a
+response
+
This is a minimal HTML5 document with a heading and some text. To return this
+from the server when a request is received, we’ll modify handle_connection as
+shown in Listing 20-5 to read the HTML file, add it to the response as a body,
+and send it.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+// --snip--
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let http_request: Vec<_> = buf_reader
+ .lines()
+ .map(|result| result.unwrap())
+ .take_while(|line| !line.is_empty())
+ .collect();
+
+ let status_line = "HTTP/1.1 200 OK";
+ let contents = fs::read_to_string("hello.html").unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-5: Sending the contents of hello.html as the
+body of the response
+
We’ve added fs to the use statement to bring the standard library’s
+filesystem module into scope. The code for reading the contents of a file to a
+string should look familiar; we used it in Chapter 12 when we read the contents
+of a file for our I/O project in Listing 12-4.
+
Next, we use format! to add the file’s contents as the body of the success
+response. To ensure a valid HTTP response, we add the Content-Length header
+which is set to the size of our response body, in this case the size of
+hello.html.
+
Run this code with cargo run and load 127.0.0.1:7878 in your browser; you
+should see your HTML rendered!
+
Currently, we’re ignoring the request data in http_request and just sending
+back the contents of the HTML file unconditionally. That means if you try
+requesting 127.0.0.1:7878/something-else in your browser, you’ll still get
+back this same HTML response. At the moment, our server is very limited and
+does not do what most web servers do. We want to customize our responses
+depending on the request and only send back the HTML file for a well-formed
+request to /.
Right now, our web server will return the HTML in the file no matter what the
+client requested. Let’s add functionality to check that the browser is
+requesting / before returning the HTML file and return an error if the
+browser requests anything else. For this we need to modify handle_connection,
+as shown in Listing 20-6. This new code checks the content of the request
+received against what we know a request for / looks like and adds if and
+else blocks to treat requests differently.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+// --snip--
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ if request_line == "GET / HTTP/1.1" {
+ let status_line = "HTTP/1.1 200 OK";
+ let contents = fs::read_to_string("hello.html").unwrap();
+ let length = contents.len();
+
+ let response = format!(
+ "{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}"
+ );
+
+ stream.write_all(response.as_bytes()).unwrap();
+ } else {
+ // some other request
+ }
+}
+
Listing 20-6: Handling requests to / differently from
+other requests
+
We’re only going to be looking at the first line of the HTTP request, so rather
+than reading the entire request into a vector, we’re calling next to get the
+first item from the iterator. The first unwrap takes care of the Option and
+stops the program if the iterator has no items. The second unwrap handles the
+Result and has the same effect as the unwrap that was in the map added in
+Listing 20-2.
+
Next, we check the request_line to see if it equals the request line of a GET
+request to the / path. If it does, the if block returns the contents of our
+HTML file.
+
If the request_line does not equal the GET request to the / path, it
+means we’ve received some other request. We’ll add code to the else block in
+a moment to respond to all other requests.
+
Run this code now and request 127.0.0.1:7878; you should get the HTML in
+hello.html. If you make any other request, such as
+127.0.0.1:7878/something-else, you’ll get a connection error like those you
+saw when running the code in Listing 20-1 and Listing 20-2.
+
Now let’s add the code in Listing 20-7 to the else block to return a response
+with the status code 404, which signals that the content for the request was
+not found. We’ll also return some HTML for a page to render in the browser
+indicating the response to the end user.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ if request_line == "GET / HTTP/1.1" {
+ let status_line = "HTTP/1.1 200 OK";
+ let contents = fs::read_to_string("hello.html").unwrap();
+ let length = contents.len();
+
+ let response = format!(
+ "{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}"
+ );
+
+ stream.write_all(response.as_bytes()).unwrap();
+ // --snip--
+ } else {
+ let status_line = "HTTP/1.1 404 NOT FOUND";
+ let contents = fs::read_to_string("404.html").unwrap();
+ let length = contents.len();
+
+ let response = format!(
+ "{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}"
+ );
+
+ stream.write_all(response.as_bytes()).unwrap();
+ }
+}
+
Listing 20-7: Responding with status code 404 and an
+error page if anything other than / was requested
+
Here, our response has a status line with status code 404 and the reason phrase
+NOT FOUND. The body of the response will be the HTML in the file 404.html.
+You’ll need to create a 404.html file next to hello.html for the error
+page; again feel free to use any HTML you want or use the example HTML in
+Listing 20-8.
Listing 20-8: Sample content for the page to send back
+with any 404 response
+
With these changes, run your server again. Requesting 127.0.0.1:7878 should
+return the contents of hello.html, and any other request, like
+127.0.0.1:7878/foo, should return the error HTML from 404.html.
At the moment the if and else blocks have a lot of repetition: they’re both
+reading files and writing the contents of the files to the stream. The only
+differences are the status line and the filename. Let’s make the code more
+concise by pulling out those differences into separate if and else lines
+that will assign the values of the status line and the filename to variables;
+we can then use those variables unconditionally in the code to read the file
+and write the response. Listing 20-9 shows the resulting code after replacing
+the large if and else blocks.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ handle_connection(stream);
+ }
+}
+// --snip--
+
+fn handle_connection(mut stream: TcpStream) {
+ // --snip--
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = if request_line == "GET / HTTP/1.1" {
+ ("HTTP/1.1 200 OK", "hello.html")
+ } else {
+ ("HTTP/1.1 404 NOT FOUND", "404.html")
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-9: Refactoring the if and else blocks to
+contain only the code that differs between the two cases
+
Now the if and else blocks only return the appropriate values for the
+status line and filename in a tuple; we then use destructuring to assign these
+two values to status_line and filename using a pattern in the let
+statement, as discussed in Chapter 18.
+
The previously duplicated code is now outside the if and else blocks and
+uses the status_line and filename variables. This makes it easier to see
+the difference between the two cases, and it means we have only one place to
+update the code if we want to change how the file reading and response writing
+work. The behavior of the code in Listing 20-9 will be the same as that in
+Listing 20-7.
+
Awesome! We now have a simple web server in approximately 40 lines of Rust code
+that responds to one request with a page of content and responds to all other
+requests with a 404 response.
+
Currently, our server runs in a single thread, meaning it can only serve one
+request at a time. Let’s examine how that can be a problem by simulating some
+slow requests. Then we’ll fix it so our server can handle multiple requests at
+once.
Right now, the server will process each request in turn, meaning it won’t
+process a second connection until the first is finished processing. If the
+server received more and more requests, this serial execution would be less and
+less optimal. If the server receives a request that takes a long time to
+process, subsequent requests will have to wait until the long request is
+finished, even if the new requests can be processed quickly. We’ll need to fix
+this, but first, we’ll look at the problem in action.
We’ll look at how a slow-processing request can affect other requests made to
+our current server implementation. Listing 20-10 implements handling a request
+to /sleep with a simulated slow response that will cause the server to sleep
+for 5 seconds before responding.
Listing 20-10: Simulating a slow request by sleeping for
+5 seconds
+
We switched from if to match now that we have three cases. We need to
+explicitly match on a slice of request_line to pattern match against the
+string literal values; match doesn’t do automatic referencing and
+dereferencing like the equality method does.
+
The first arm is the same as the if block from Listing 20-9. The second arm
+matches a request to /sleep. When that request is received, the server will
+sleep for 5 seconds before rendering the successful HTML page. The third arm is
+the same as the else block from Listing 20-9.
+
You can see how primitive our server is: real libraries would handle the
+recognition of multiple requests in a much less verbose way!
+
Start the server using cargo run. Then open two browser windows: one for
+http://127.0.0.1:7878/ and the other for http://127.0.0.1:7878/sleep. If
+you enter the / URI a few times, as before, you’ll see it respond quickly.
+But if you enter /sleep and then load /, you’ll see that / waits until
+sleep has slept for its full 5 seconds before loading.
+
There are multiple techniques we could use to avoid requests backing up behind
+a slow request; the one we’ll implement is a thread pool.
A thread pool is a group of spawned threads that are waiting and ready to
+handle a task. When the program receives a new task, it assigns one of the
+threads in the pool to the task, and that thread will process the task. The
+remaining threads in the pool are available to handle any other tasks that come
+in while the first thread is processing. When the first thread is done
+processing its task, it’s returned to the pool of idle threads, ready to handle
+a new task. A thread pool allows you to process connections concurrently,
+increasing the throughput of your server.
+
We’ll limit the number of threads in the pool to a small number to protect us
+from Denial of Service (DoS) attacks; if we had our program create a new thread
+for each request as it came in, someone making 10 million requests to our
+server could create havoc by using up all our server’s resources and grinding
+the processing of requests to a halt.
+
Rather than spawning unlimited threads, then, we’ll have a fixed number of
+threads waiting in the pool. Requests that come in are sent to the pool for
+processing. The pool will maintain a queue of incoming requests. Each of the
+threads in the pool will pop off a request from this queue, handle the request,
+and then ask the queue for another request. With this design, we can process up
+to N requests concurrently, where N is the number of threads. If each
+thread is responding to a long-running request, subsequent requests can still
+back up in the queue, but we’ve increased the number of long-running requests
+we can handle before reaching that point.
+
This technique is just one of many ways to improve the throughput of a web
+server. Other options you might explore are the fork/join model, the
+single-threaded async I/O model, or the multi-threaded async I/O model. If
+you’re interested in this topic, you can read more about other solutions and
+try to implement them; with a low-level language like Rust, all of these
+options are possible.
+
Before we begin implementing a thread pool, let’s talk about what using the
+pool should look like. When you’re trying to design code, writing the client
+interface first can help guide your design. Write the API of the code so it’s
+structured in the way you want to call it; then implement the functionality
+within that structure rather than implementing the functionality and then
+designing the public API.
+
Similar to how we used test-driven development in the project in Chapter 12,
+we’ll use compiler-driven development here. We’ll write the code that calls the
+functions we want, and then we’ll look at errors from the compiler to determine
+what we should change next to get the code to work. Before we do that, however,
+we’ll explore the technique we’re not going to use as a starting point.
First, let’s explore how our code might look if it did create a new thread for
+every connection. As mentioned earlier, this isn’t our final plan due to the
+problems with potentially spawning an unlimited number of threads, but it is a
+starting point to get a working multithreaded server first. Then we’ll add the
+thread pool as an improvement, and contrasting the two solutions will be
+easier. Listing 20-11 shows the changes to make to main to spawn a new thread
+to handle each stream within the for loop.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ thread::spawn(|| {
+ handle_connection(stream);
+ });
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-11: Spawning a new thread for each
+stream
+
As you learned in Chapter 16, thread::spawn will create a new thread and then
+run the code in the closure in the new thread. If you run this code and load
+/sleep in your browser, then / in two more browser tabs, you’ll indeed see
+that the requests to / don’t have to wait for /sleep to finish. However, as
+we mentioned, this will eventually overwhelm the system because you’d be making
+new threads without any limit.
We want our thread pool to work in a similar, familiar way so switching from
+threads to a thread pool doesn’t require large changes to the code that uses
+our API. Listing 20-12 shows the hypothetical interface for a ThreadPool
+struct we want to use instead of thread::spawn.
+
Filename: src/main.rs
+
use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-12: Our ideal ThreadPool interface
+
We use ThreadPool::new to create a new thread pool with a configurable number
+of threads, in this case four. Then, in the for loop, pool.execute has a
+similar interface as thread::spawn in that it takes a closure the pool should
+run for each stream. We need to implement pool.execute so it takes the
+closure and gives it to a thread in the pool to run. This code won’t yet
+compile, but we’ll try so the compiler can guide us in how to fix it.
Make the changes in Listing 20-12 to src/main.rs, and then let’s use the
+compiler errors from cargo check to drive our development. Here is the first
+error we get:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0433]: failed to resolve: use of undeclared type `ThreadPool`
+ --> src/main.rs:11:16
+ |
+11 | let pool = ThreadPool::new(4);
+ | ^^^^^^^^^^ use of undeclared type `ThreadPool`
+
+For more information about this error, try `rustc --explain E0433`.
+error: could not compile `hello` (bin "hello") due to 1 previous error
+
+
Great! This error tells us we need a ThreadPool type or module, so we’ll
+build one now. Our ThreadPool implementation will be independent of the kind
+of work our web server is doing. So, let’s switch the hello crate from a
+binary crate to a library crate to hold our ThreadPool implementation. After
+we change to a library crate, we could also use the separate thread pool
+library for any work we want to do using a thread pool, not just for serving
+web requests.
+
Create a src/lib.rs that contains the following, which is the simplest
+definition of a ThreadPool struct that we can have for now:
+
Filename: src/lib.rs
+
pub struct ThreadPool;
+
Then edit main.rs file to bring ThreadPool into scope from the library
+crate by adding the following code to the top of src/main.rs:
+
Filename: src/main.rs
+
use hello::ThreadPool;
+use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming() {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
This code still won’t work, but let’s check it again to get the next error that
+we need to address:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0599]: no function or associated item named `new` found for struct `ThreadPool` in the current scope
+ --> src/main.rs:12:28
+ |
+12 | let pool = ThreadPool::new(4);
+ | ^^^ function or associated item not found in `ThreadPool`
+
+For more information about this error, try `rustc --explain E0599`.
+error: could not compile `hello` (bin "hello") due to 1 previous error
+
+
This error indicates that next we need to create an associated function named
+new for ThreadPool. We also know that new needs to have one parameter
+that can accept 4 as an argument and should return a ThreadPool instance.
+Let’s implement the simplest new function that will have those
+characteristics:
We chose usize as the type of the size parameter, because we know that a
+negative number of threads doesn’t make any sense. We also know we’ll use this
+4 as the number of elements in a collection of threads, which is what the
+usize type is for, as discussed in the “Integer Types” section of Chapter 3.
+
Let’s check the code again:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0599]: no method named `execute` found for struct `ThreadPool` in the current scope
+ --> src/main.rs:17:14
+ |
+17 | pool.execute(|| {
+ | -----^^^^^^^ method not found in `ThreadPool`
+
+For more information about this error, try `rustc --explain E0599`.
+error: could not compile `hello` (bin "hello") due to 1 previous error
+
+
Now the error occurs because we don’t have an execute method on ThreadPool.
+Recall from the “Creating a Finite Number of
+Threads” section that we
+decided our thread pool should have an interface similar to thread::spawn. In
+addition, we’ll implement the execute function so it takes the closure it’s
+given and gives it to an idle thread in the pool to run.
+
We’ll define the execute method on ThreadPool to take a closure as a
+parameter. Recall from the “Moving Captured Values Out of the Closure and the
+Fn Traits” section in Chapter 13 that we can take
+closures as parameters with three different traits: Fn, FnMut, and
+FnOnce. We need to decide which kind of closure to use here. We know we’ll
+end up doing something similar to the standard library thread::spawn
+implementation, so we can look at what bounds the signature of thread::spawn
+has on its parameter. The documentation shows us the following:
The F type parameter is the one we’re concerned with here; the T type
+parameter is related to the return value, and we’re not concerned with that. We
+can see that spawn uses FnOnce as the trait bound on F. This is probably
+what we want as well, because we’ll eventually pass the argument we get in
+execute to spawn. We can be further confident that FnOnce is the trait we
+want to use because the thread for running a request will only execute that
+request’s closure one time, which matches the Once in FnOnce.
+
The F type parameter also has the trait bound Send and the lifetime bound
+'static, which are useful in our situation: we need Send to transfer the
+closure from one thread to another and 'static because we don’t know how long
+the thread will take to execute. Let’s create an execute method on
+ThreadPool that will take a generic parameter of type F with these bounds:
We still use the () after FnOnce because this FnOnce represents a closure
+that takes no parameters and returns the unit type (). Just like function
+definitions, the return type can be omitted from the signature, but even if we
+have no parameters, we still need the parentheses.
+
Again, this is the simplest implementation of the execute method: it does
+nothing, but we’re trying only to make our code compile. Let’s check it again:
It compiles! But note that if you try cargo run and make a request in the
+browser, you’ll see the errors in the browser that we saw at the beginning of
+the chapter. Our library isn’t actually calling the closure passed to execute
+yet!
+
+
Note: A saying you might hear about languages with strict compilers, such as
+Haskell and Rust, is “if the code compiles, it works.” But this saying is not
+universally true. Our project compiles, but it does absolutely nothing! If we
+were building a real, complete project, this would be a good time to start
+writing unit tests to check that the code compiles and has the behavior we
+want.
We aren’t doing anything with the parameters to new and execute. Let’s
+implement the bodies of these functions with the behavior we want. To start,
+let’s think about new. Earlier we chose an unsigned type for the size
+parameter, because a pool with a negative number of threads makes no sense.
+However, a pool with zero threads also makes no sense, yet zero is a perfectly
+valid usize. We’ll add code to check that size is greater than zero before
+we return a ThreadPool instance and have the program panic if it receives a
+zero by using the assert! macro, as shown in Listing 20-13.
+
Filename: src/lib.rs
+
pub struct ThreadPool;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ ThreadPool
+ }
+
+ // --snip--
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
Listing 20-13: Implementing ThreadPool::new to panic if
+size is zero
+
We’ve also added some documentation for our ThreadPool with doc comments.
+Note that we followed good documentation practices by adding a section that
+calls out the situations in which our function can panic, as discussed in
+Chapter 14. Try running cargo doc --open and clicking the ThreadPool struct
+to see what the generated docs for new look like!
+
Instead of adding the assert! macro as we’ve done here, we could change new
+into build and return a Result like we did with Config::build in the I/O
+project in Listing 12-9. But we’ve decided in this case that trying to create a
+thread pool without any threads should be an unrecoverable error. If you’re
+feeling ambitious, try to write a function named build with the following
+signature to compare with the new function:
Now that we have a way to know we have a valid number of threads to store in
+the pool, we can create those threads and store them in the ThreadPool struct
+before returning the struct. But how do we “store” a thread? Let’s take another
+look at the thread::spawn signature:
The spawn function returns a JoinHandle<T>, where T is the type that the
+closure returns. Let’s try using JoinHandle too and see what happens. In our
+case, the closures we’re passing to the thread pool will handle the connection
+and not return anything, so T will be the unit type ().
+
The code in Listing 20-14 will compile but doesn’t create any threads yet.
+We’ve changed the definition of ThreadPool to hold a vector of
+thread::JoinHandle<()> instances, initialized the vector with a capacity of
+size, set up a for loop that will run some code to create the threads, and
+returned a ThreadPool instance containing them.
+
Filename: src/lib.rs
+
use std::thread;
+
+pub struct ThreadPool {
+ threads: Vec<thread::JoinHandle<()>>,
+}
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let mut threads = Vec::with_capacity(size);
+
+ for _ in 0..size {
+ // create some threads and store them in the vector
+ }
+
+ ThreadPool { threads }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
Listing 20-14: Creating a vector for ThreadPool to hold
+the threads
+
We’ve brought std::thread into scope in the library crate, because we’re
+using thread::JoinHandle as the type of the items in the vector in
+ThreadPool.
+
Once a valid size is received, our ThreadPool creates a new vector that can
+hold size items. The with_capacity function performs the same task as
+Vec::new but with an important difference: it preallocates space in the
+vector. Because we know we need to store size elements in the vector, doing
+this allocation up front is slightly more efficient than using Vec::new,
+which resizes itself as elements are inserted.
+
When you run cargo check again, it should succeed.
We left a comment in the for loop in Listing 20-14 regarding the creation of
+threads. Here, we’ll look at how we actually create threads. The standard
+library provides thread::spawn as a way to create threads, and
+thread::spawn expects to get some code the thread should run as soon as the
+thread is created. However, in our case, we want to create the threads and have
+them wait for code that we’ll send later. The standard library’s
+implementation of threads doesn’t include any way to do that; we have to
+implement it manually.
+
We’ll implement this behavior by introducing a new data structure between the
+ThreadPool and the threads that will manage this new behavior. We’ll call
+this data structure Worker, which is a common term in pooling
+implementations. The Worker picks up code that needs to be run and runs the
+code in the Worker’s thread. Think of people working in the kitchen at a
+restaurant: the workers wait until orders come in from customers, and then
+they’re responsible for taking those orders and fulfilling them.
+
Instead of storing a vector of JoinHandle<()> instances in the thread pool,
+we’ll store instances of the Worker struct. Each Worker will store a single
+JoinHandle<()> instance. Then we’ll implement a method on Worker that will
+take a closure of code to run and send it to the already running thread for
+execution. We’ll also give each worker an id so we can distinguish between
+the different workers in the pool when logging or debugging.
+
Here is the new process that will happen when we create a ThreadPool. We’ll
+implement the code that sends the closure to the thread after we have Worker
+set up in this way:
+
+
Define a Worker struct that holds an id and a JoinHandle<()>.
+
Change ThreadPool to hold a vector of Worker instances.
+
Define a Worker::new function that takes an id number and returns a
+Worker instance that holds the id and a thread spawned with an empty
+closure.
+
In ThreadPool::new, use the for loop counter to generate an id, create
+a new Worker with that id, and store the worker in the vector.
+
+
If you’re up for a challenge, try implementing these changes on your own before
+looking at the code in Listing 20-15.
+
Ready? Here is Listing 20-15 with one way to make the preceding modifications.
+
Filename: src/lib.rs
+
use std::thread;
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+}
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id));
+ }
+
+ ThreadPool { workers }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize) -> Worker {
+ let thread = thread::spawn(|| {});
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-15: Modifying ThreadPool to hold Worker
+instances instead of holding threads directly
+
We’ve changed the name of the field on ThreadPool from threads to workers
+because it’s now holding Worker instances instead of JoinHandle<()>
+instances. We use the counter in the for loop as an argument to
+Worker::new, and we store each new Worker in the vector named workers.
+
External code (like our server in src/main.rs) doesn’t need to know the
+implementation details regarding using a Worker struct within ThreadPool,
+so we make the Worker struct and its new function private. The
+Worker::new function uses the id we give it and stores a JoinHandle<()>
+instance that is created by spawning a new thread using an empty closure.
+
+
Note: If the operating system can’t create a thread because there aren’t
+enough system resources, thread::spawn will panic. That will cause our
+whole server to panic, even though the creation of some threads might
+succeed. For simplicity’s sake, this behavior is fine, but in a production
+thread pool implementation, you’d likely want to use
+std::thread::Builder and its
+spawn method that returns Result instead.
+
+
This code will compile and will store the number of Worker instances we
+specified as an argument to ThreadPool::new. But we’re still not processing
+the closure that we get in execute. Let’s look at how to do that next.
The next problem we’ll tackle is that the closures given to thread::spawn do
+absolutely nothing. Currently, we get the closure we want to execute in the
+execute method. But we need to give thread::spawn a closure to run when we
+create each Worker during the creation of the ThreadPool.
+
We want the Worker structs that we just created to fetch the code to run from
+a queue held in the ThreadPool and send that code to its thread to run.
+
The channels we learned about in Chapter 16—a simple way to communicate between
+two threads—would be perfect for this use case. We’ll use a channel to function
+as the queue of jobs, and execute will send a job from the ThreadPool to
+the Worker instances, which will send the job to its thread. Here is the plan:
+
+
The ThreadPool will create a channel and hold on to the sender.
+
Each Worker will hold on to the receiver.
+
We’ll create a new Job struct that will hold the closures we want to send
+down the channel.
+
The execute method will send the job it wants to execute through the
+sender.
+
In its thread, the Worker will loop over its receiver and execute the
+closures of any jobs it receives.
+
+
Let’s start by creating a channel in ThreadPool::new and holding the sender
+in the ThreadPool instance, as shown in Listing 20-16. The Job struct
+doesn’t hold anything for now but will be the type of item we’re sending down
+the channel.
+
Filename: src/lib.rs
+
use std::{sync::mpsc, thread};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+struct Job;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id));
+ }
+
+ ThreadPool { workers, sender }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize) -> Worker {
+ let thread = thread::spawn(|| {});
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-16: Modifying ThreadPool to store the
+sender of a channel that transmits Job instances
+
In ThreadPool::new, we create our new channel and have the pool hold the
+sender. This will successfully compile.
+
Let’s try passing a receiver of the channel into each worker as the thread pool
+creates the channel. We know we want to use the receiver in the thread that the
+workers spawn, so we’ll reference the receiver parameter in the closure. The
+code in Listing 20-17 won’t quite compile yet.
+
Filename: src/lib.rs
+
use std::{sync::mpsc, thread};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+struct Job;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, receiver));
+ }
+
+ ThreadPool { workers, sender }
+ }
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+// --snip--
+
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: mpsc::Receiver<Job>) -> Worker {
+ let thread = thread::spawn(|| {
+ receiver;
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-17: Passing the receiver to the workers
+
We’ve made some small and straightforward changes: we pass the receiver into
+Worker::new, and then we use it inside the closure.
+
When we try to check this code, we get this error:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0382]: use of moved value: `receiver`
+ --> src/lib.rs:26:42
+ |
+21 | let (sender, receiver) = mpsc::channel();
+ | -------- move occurs because `receiver` has type `std::sync::mpsc::Receiver<Job>`, which does not implement the `Copy` trait
+...
+25 | for id in 0..size {
+ | ----------------- inside of this loop
+26 | workers.push(Worker::new(id, receiver));
+ | ^^^^^^^^ value moved here, in previous iteration of loop
+ |
+note: consider changing this parameter type in method `new` to borrow instead if owning the value isn't necessary
+ --> src/lib.rs:47:33
+ |
+47 | fn new(id: usize, receiver: mpsc::Receiver<Job>) -> Worker {
+ | --- in this method ^^^^^^^^^^^^^^^^^^^ this parameter takes ownership of the value
+
+For more information about this error, try `rustc --explain E0382`.
+error: could not compile `hello` (lib) due to 1 previous error
+
+
The code is trying to pass receiver to multiple Worker instances. This
+won’t work, as you’ll recall from Chapter 16: the channel implementation that
+Rust provides is multiple producer, single consumer. This means we can’t
+just clone the consuming end of the channel to fix this code. We also don’t
+want to send a message multiple times to multiple consumers; we want one list
+of messages with multiple workers such that each message gets processed once.
+
Additionally, taking a job off the channel queue involves mutating the
+receiver, so the threads need a safe way to share and modify receiver;
+otherwise, we might get race conditions (as covered in Chapter 16).
+
Recall the thread-safe smart pointers discussed in Chapter 16: to share
+ownership across multiple threads and allow the threads to mutate the value, we
+need to use Arc<Mutex<T>>. The Arc type will let multiple workers own the
+receiver, and Mutex will ensure that only one worker gets a job from the
+receiver at a time. Listing 20-18 shows the changes we need to make.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+// --snip--
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+struct Job;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ // --snip--
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ }
+}
+
+// --snip--
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ // --snip--
+ let thread = thread::spawn(|| {
+ receiver;
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-18: Sharing the receiver among the workers
+using Arc and Mutex
+
In ThreadPool::new, we put the receiver in an Arc and a Mutex. For each
+new worker, we clone the Arc to bump the reference count so the workers can
+share ownership of the receiver.
+
With these changes, the code compiles! We’re getting there!
Let’s finally implement the execute method on ThreadPool. We’ll also change
+Job from a struct to a type alias for a trait object that holds the type of
+closure that execute receives. As discussed in the “Creating Type Synonyms
+with Type Aliases”
+section of Chapter 19, type aliases allow us to make long types shorter for
+ease of use. Look at Listing 20-19.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+// --snip--
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ // --snip--
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+// --snip--
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(|| {
+ receiver;
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-19: Creating a Job type alias for a Box
+that holds each closure and then sending the job down the channel
+
After creating a new Job instance using the closure we get in execute, we
+send that job down the sending end of the channel. We’re calling unwrap on
+send for the case that sending fails. This might happen if, for example, we
+stop all our threads from executing, meaning the receiving end has stopped
+receiving new messages. At the moment, we can’t stop our threads from
+executing: our threads continue executing as long as the pool exists. The
+reason we use unwrap is that we know the failure case won’t happen, but the
+compiler doesn’t know that.
+
But we’re not quite done yet! In the worker, our closure being passed to
+thread::spawn still only references the receiving end of the channel.
+Instead, we need the closure to loop forever, asking the receiving end of the
+channel for a job and running the job when it gets one. Let’s make the change
+shown in Listing 20-20 to Worker::new.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+// --snip--
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-20: Receiving and executing the jobs in the
+worker’s thread
+
Here, we first call lock on the receiver to acquire the mutex, and then we
+call unwrap to panic on any errors. Acquiring a lock might fail if the mutex
+is in a poisoned state, which can happen if some other thread panicked while
+holding the lock rather than releasing the lock. In this situation, calling
+unwrap to have this thread panic is the correct action to take. Feel free to
+change this unwrap to an expect with an error message that is meaningful to
+you.
+
If we get the lock on the mutex, we call recv to receive a Job from the
+channel. A final unwrap moves past any errors here as well, which might occur
+if the thread holding the sender has shut down, similar to how the send
+method returns Err if the receiver shuts down.
+
The call to recv blocks, so if there is no job yet, the current thread will
+wait until a job becomes available. The Mutex<T> ensures that only one
+Worker thread at a time is trying to request a job.
+
Our thread pool is now in a working state! Give it a cargo run and make some
+requests:
+
+
$ cargo run
+ Compiling hello v0.1.0 (file:///projects/hello)
+warning: field is never read: `workers`
+ --> src/lib.rs:7:5
+ |
+7 | workers: Vec<Worker>,
+ | ^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: `#[warn(dead_code)]` on by default
+
+warning: field is never read: `id`
+ --> src/lib.rs:48:5
+ |
+48 | id: usize,
+ | ^^^^^^^^^
+
+warning: field is never read: `thread`
+ --> src/lib.rs:49:5
+ |
+49 | thread: thread::JoinHandle<()>,
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+warning: `hello` (lib) generated 3 warnings
+ Finished dev [unoptimized + debuginfo] target(s) in 1.40s
+ Running `target/debug/hello`
+Worker 0 got a job; executing.
+Worker 2 got a job; executing.
+Worker 1 got a job; executing.
+Worker 3 got a job; executing.
+Worker 0 got a job; executing.
+Worker 2 got a job; executing.
+Worker 1 got a job; executing.
+Worker 3 got a job; executing.
+Worker 0 got a job; executing.
+Worker 2 got a job; executing.
+
+
Success! We now have a thread pool that executes connections asynchronously.
+There are never more than four threads created, so our system won’t get
+overloaded if the server receives a lot of requests. If we make a request to
+/sleep, the server will be able to serve other requests by having another
+thread run them.
+
+
Note: If you open /sleep in multiple browser windows simultaneously, they
+might load one at a time in 5 second intervals. Some web browsers execute
+multiple instances of the same request sequentially for caching reasons. This
+limitation is not caused by our web server.
+
+
After learning about the while let loop in Chapter 18, you might be wondering
+why we didn’t write the worker thread code as shown in Listing 20-21.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+// --snip--
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || {
+ while let Ok(job) = receiver.lock().unwrap().recv() {
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ }
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-21: An alternative implementation of
+Worker::new using while let
+
This code compiles and runs but doesn’t result in the desired threading
+behavior: a slow request will still cause other requests to wait to be
+processed. The reason is somewhat subtle: the Mutex struct has no public
+unlock method because the ownership of the lock is based on the lifetime of
+the MutexGuard<T> within the LockResult<MutexGuard<T>> that the lock
+method returns. At compile time, the borrow checker can then enforce the rule
+that a resource guarded by a Mutex cannot be accessed unless we hold the
+lock. However, this implementation can also result in the lock being held
+longer than intended if we aren’t mindful of the lifetime of the
+MutexGuard<T>.
+
The code in Listing 20-20 that uses let job = receiver.lock().unwrap().recv().unwrap(); works because with let, any
+temporary values used in the expression on the right hand side of the equals
+sign are immediately dropped when the let statement ends. However, while let (and if let and match) does not drop temporary values until the end of
+the associated block. In Listing 20-21, the lock remains held for the duration
+of the call to job(), meaning other workers cannot receive jobs.
The code in Listing 20-20 is responding to requests asynchronously through the
+use of a thread pool, as we intended. We get some warnings about the workers,
+id, and thread fields that we’re not using in a direct way that reminds us
+we’re not cleaning up anything. When we use the less elegant
+ctrl-c method to halt the main thread, all other threads
+are stopped immediately as well, even if they’re in the middle of serving a
+request.
+
Next, then, we’ll implement the Drop trait to call join on each of the
+threads in the pool so they can finish the requests they’re working on before
+closing. Then we’ll implement a way to tell the threads they should stop
+accepting new requests and shut down. To see this code in action, we’ll modify
+our server to accept only two requests before gracefully shutting down its
+thread pool.
Let’s start with implementing Drop on our thread pool. When the pool is
+dropped, our threads should all join to make sure they finish their work.
+Listing 20-22 shows a first attempt at a Drop implementation; this code won’t
+quite work yet.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ worker.thread.join().unwrap();
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: thread::JoinHandle<()>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker { id, thread }
+ }
+}
+
Listing 20-22: Joining each thread when the thread pool
+goes out of scope
+
First, we loop through each of the thread pool workers. We use &mut for
+this because self is a mutable reference, and we also need to be able to
+mutate worker. For each worker, we print a message saying that this
+particular worker is shutting down, and then we call join on that worker’s
+thread. If the call to join fails, we use unwrap to make Rust panic and go
+into an ungraceful shutdown.
+
Here is the error we get when we compile this code:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0507]: cannot move out of `worker.thread` which is behind a mutable reference
+ --> src/lib.rs:52:13
+ |
+52 | worker.thread.join().unwrap();
+ | ^^^^^^^^^^^^^ ------ `worker.thread` moved due to this method call
+ | |
+ | move occurs because `worker.thread` has type `JoinHandle<()>`, which does not implement the `Copy` trait
+ |
+note: `JoinHandle::<T>::join` takes ownership of the receiver `self`, which moves `worker.thread`
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/thread/mod.rs:1657:17
+
+For more information about this error, try `rustc --explain E0507`.
+error: could not compile `hello` (lib) due to 1 previous error
+
+
The error tells us we can’t call join because we only have a mutable borrow
+of each worker and join takes ownership of its argument. To solve this
+issue, we need to move the thread out of the Worker instance that owns
+thread so join can consume the thread. We did this in Listing 17-15: if
+Worker holds an Option<thread::JoinHandle<()>> instead, we can call the
+take method on the Option to move the value out of the Some variant and
+leave a None variant in its place. In other words, a Worker that is running
+will have a Some variant in thread, and when we want to clean up a
+Worker, we’ll replace Some with None so the Worker doesn’t have a
+thread to run.
+
So we know we want to update the definition of Worker like this:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ worker.thread.join().unwrap();
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker { id, thread }
+ }
+}
+
Now let’s lean on the compiler to find the other places that need to change.
+Checking this code, we get two errors:
+
$ cargo check
+ Checking hello v0.1.0 (file:///projects/hello)
+error[E0599]: no method named `join` found for enum `Option` in the current scope
+ --> src/lib.rs:52:27
+ |
+52 | worker.thread.join().unwrap();
+ | ^^^^ method not found in `Option<JoinHandle<()>>`
+ |
+note: the method `join` exists on the type `JoinHandle<()>`
+ --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/thread/mod.rs:1657:5
+help: consider using `Option::expect` to unwrap the `JoinHandle<()>` value, panicking if the value is an `Option::None`
+ |
+52 | worker.thread.expect("REASON").join().unwrap();
+ | +++++++++++++++++
+
+error[E0308]: mismatched types
+ --> src/lib.rs:72:22
+ |
+72 | Worker { id, thread }
+ | ^^^^^^ expected `Option<JoinHandle<()>>`, found `JoinHandle<_>`
+ |
+ = note: expected enum `Option<JoinHandle<()>>`
+ found struct `JoinHandle<_>`
+help: try wrapping the expression in `Some`
+ |
+72 | Worker { id, thread: Some(thread) }
+ | +++++++++++++ +
+
+Some errors have detailed explanations: E0308, E0599.
+For more information about an error, try `rustc --explain E0308`.
+error: could not compile `hello` (lib) due to 2 previous errors
+
+
Let’s address the second error, which points to the code at the end of
+Worker::new; we need to wrap the thread value in Some when we create a
+new Worker. Make the following changes to fix this error:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ worker.thread.join().unwrap();
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ // --snip--
+
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
The first error is in our Drop implementation. We mentioned earlier that we
+intended to call take on the Option value to move thread out of worker.
+The following changes will do so:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: mpsc::Sender<Job>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool { workers, sender }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
As discussed in Chapter 17, the take method on Option takes the Some
+variant out and leaves None in its place. We’re using if let to destructure
+the Some and get the thread; then we call join on the thread. If a worker’s
+thread is already None, we know that worker has already had its thread
+cleaned up, so nothing happens in that case.
With all the changes we’ve made, our code compiles without any warnings.
+However, the bad news is this code doesn’t function the way we want it to yet.
+The key is the logic in the closures run by the threads of the Worker
+instances: at the moment, we call join, but that won’t shut down the threads
+because they loop forever looking for jobs. If we try to drop our
+ThreadPool with our current implementation of drop, the main thread will
+block forever waiting for the first thread to finish.
+
To fix this problem, we’ll need a change in the ThreadPooldrop
+implementation and then a change in the Worker loop.
+
First, we’ll change the ThreadPooldrop implementation to explicitly drop
+the sender before waiting for the threads to finish. Listing 20-23 shows the
+changes to ThreadPool to explicitly drop sender. We use the same Option
+and take technique as we did with the thread to be able to move sender out
+of ThreadPool:
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: Option<mpsc::Sender<Job>>,
+}
+// --snip--
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ // --snip--
+
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool {
+ workers,
+ sender: Some(sender),
+ }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.as_ref().unwrap().send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ drop(self.sender.take());
+
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let job = receiver.lock().unwrap().recv().unwrap();
+
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
Listing 20-23: Explicitly drop sender before joining
+the worker threads
+
Dropping sender closes the channel, which indicates no more messages will be
+sent. When that happens, all the calls to recv that the workers do in the
+infinite loop will return an error. In Listing 20-24, we change the Worker
+loop to gracefully exit the loop in that case, which means the threads will
+finish when the ThreadPooldrop implementation calls join on them.
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: Option<mpsc::Sender<Job>>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool {
+ workers,
+ sender: Some(sender),
+ }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.as_ref().unwrap().send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ drop(self.sender.take());
+
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let message = receiver.lock().unwrap().recv();
+
+ match message {
+ Ok(job) => {
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ }
+ Err(_) => {
+ println!("Worker {id} disconnected; shutting down.");
+ break;
+ }
+ }
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
Listing 20-24: Explicitly break out of the loop when
+recv returns an error
+
To see this code in action, let’s modify main to accept only two requests
+before gracefully shutting down the server, as shown in Listing 20-25.
+
Filename: src/main.rs
+
use hello::ThreadPool;
+use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming().take(2) {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+
+ println!("Shutting down.");
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Listing 20-25: Shut down the server after serving two
+requests by exiting the loop
+
You wouldn’t want a real-world web server to shut down after serving only two
+requests. This code just demonstrates that the graceful shutdown and cleanup is
+in working order.
+
The take method is defined in the Iterator trait and limits the iteration
+to the first two items at most. The ThreadPool will go out of scope at the
+end of main, and the drop implementation will run.
+
Start the server with cargo run, and make three requests. The third request
+should error, and in your terminal you should see output similar to this:
+
+
$ cargo run
+ Compiling hello v0.1.0 (file:///projects/hello)
+ Finished dev [unoptimized + debuginfo] target(s) in 1.0s
+ Running `target/debug/hello`
+Worker 0 got a job; executing.
+Shutting down.
+Shutting down worker 0
+Worker 3 got a job; executing.
+Worker 1 disconnected; shutting down.
+Worker 2 disconnected; shutting down.
+Worker 3 disconnected; shutting down.
+Worker 0 disconnected; shutting down.
+Shutting down worker 1
+Shutting down worker 2
+Shutting down worker 3
+
+
You might see a different ordering of workers and messages printed. We can see
+how this code works from the messages: workers 0 and 3 got the first two
+requests. The server stopped accepting connections after the second connection,
+and the Drop implementation on ThreadPool starts executing before worker 3
+even starts its job. Dropping the sender disconnects all the workers and
+tells them to shut down. The workers each print a message when they disconnect,
+and then the thread pool calls join to wait for each worker thread to finish.
+
Notice one interesting aspect of this particular execution: the ThreadPool
+dropped the sender, and before any worker received an error, we tried to join
+worker 0. Worker 0 had not yet gotten an error from recv, so the main thread
+blocked waiting for worker 0 to finish. In the meantime, worker 3 received a
+job and then all threads received an error. When worker 0 finished, the main
+thread waited for the rest of the workers to finish. At that point, they had
+all exited their loops and stopped.
+
Congrats! We’ve now completed our project; we have a basic web server that uses
+a thread pool to respond asynchronously. We’re able to perform a graceful
+shutdown of the server, which cleans up all the threads in the pool.
+
Here’s the full code for reference:
+
Filename: src/main.rs
+
use hello::ThreadPool;
+use std::{
+ fs,
+ io::{prelude::*, BufReader},
+ net::{TcpListener, TcpStream},
+ thread,
+ time::Duration,
+};
+
+fn main() {
+ let listener = TcpListener::bind("127.0.0.1:7878").unwrap();
+ let pool = ThreadPool::new(4);
+
+ for stream in listener.incoming().take(2) {
+ let stream = stream.unwrap();
+
+ pool.execute(|| {
+ handle_connection(stream);
+ });
+ }
+
+ println!("Shutting down.");
+}
+
+fn handle_connection(mut stream: TcpStream) {
+ let buf_reader = BufReader::new(&mut stream);
+ let request_line = buf_reader.lines().next().unwrap().unwrap();
+
+ let (status_line, filename) = match &request_line[..] {
+ "GET / HTTP/1.1" => ("HTTP/1.1 200 OK", "hello.html"),
+ "GET /sleep HTTP/1.1" => {
+ thread::sleep(Duration::from_secs(5));
+ ("HTTP/1.1 200 OK", "hello.html")
+ }
+ _ => ("HTTP/1.1 404 NOT FOUND", "404.html"),
+ };
+
+ let contents = fs::read_to_string(filename).unwrap();
+ let length = contents.len();
+
+ let response =
+ format!("{status_line}\r\nContent-Length: {length}\r\n\r\n{contents}");
+
+ stream.write_all(response.as_bytes()).unwrap();
+}
+
Filename: src/lib.rs
+
use std::{
+ sync::{mpsc, Arc, Mutex},
+ thread,
+};
+
+pub struct ThreadPool {
+ workers: Vec<Worker>,
+ sender: Option<mpsc::Sender<Job>>,
+}
+
+type Job = Box<dyn FnOnce() + Send + 'static>;
+
+impl ThreadPool {
+ /// Create a new ThreadPool.
+ ///
+ /// The size is the number of threads in the pool.
+ ///
+ /// # Panics
+ ///
+ /// The `new` function will panic if the size is zero.
+ pub fn new(size: usize) -> ThreadPool {
+ assert!(size > 0);
+
+ let (sender, receiver) = mpsc::channel();
+
+ let receiver = Arc::new(Mutex::new(receiver));
+
+ let mut workers = Vec::with_capacity(size);
+
+ for id in 0..size {
+ workers.push(Worker::new(id, Arc::clone(&receiver)));
+ }
+
+ ThreadPool {
+ workers,
+ sender: Some(sender),
+ }
+ }
+
+ pub fn execute<F>(&self, f: F)
+ where
+ F: FnOnce() + Send + 'static,
+ {
+ let job = Box::new(f);
+
+ self.sender.as_ref().unwrap().send(job).unwrap();
+ }
+}
+
+impl Drop for ThreadPool {
+ fn drop(&mut self) {
+ drop(self.sender.take());
+
+ for worker in &mut self.workers {
+ println!("Shutting down worker {}", worker.id);
+
+ if let Some(thread) = worker.thread.take() {
+ thread.join().unwrap();
+ }
+ }
+ }
+}
+
+struct Worker {
+ id: usize,
+ thread: Option<thread::JoinHandle<()>>,
+}
+
+impl Worker {
+ fn new(id: usize, receiver: Arc<Mutex<mpsc::Receiver<Job>>>) -> Worker {
+ let thread = thread::spawn(move || loop {
+ let message = receiver.lock().unwrap().recv();
+
+ match message {
+ Ok(job) => {
+ println!("Worker {id} got a job; executing.");
+
+ job();
+ }
+ Err(_) => {
+ println!("Worker {id} disconnected; shutting down.");
+ break;
+ }
+ }
+ });
+
+ Worker {
+ id,
+ thread: Some(thread),
+ }
+ }
+}
+
We could do more here! If you want to continue enhancing this project, here are
+some ideas:
+
+
Add more documentation to ThreadPool and its public methods.
+
Add tests of the library’s functionality.
+
Change calls to unwrap to more robust error handling.
+
Use ThreadPool to perform some task other than serving web requests.
+
Find a thread pool crate on crates.io and implement a
+similar web server using the crate instead. Then compare its API and
+robustness to the thread pool we implemented.
Well done! You’ve made it to the end of the book! We want to thank you for
+joining us on this tour of Rust. You’re now ready to implement your own Rust
+projects and help with other peoples’ projects. Keep in mind that there is a
+welcoming community of other Rustaceans who would love to help you with any
+challenges you encounter on your Rust journey.
The following list contains keywords that are reserved for current or future
+use by the Rust language. As such, they cannot be used as identifiers (except
+as raw identifiers as we’ll discuss in the “Raw
+Identifiers” section). Identifiers are names
+of functions, variables, parameters, struct fields, modules, crates, constants,
+macros, static values, attributes, types, traits, or lifetimes.
Raw identifiers are the syntax that lets you use keywords where they wouldn’t
+normally be allowed. You use a raw identifier by prefixing a keyword with r#.
+
For example, match is a keyword. If you try to compile the following function
+that uses match as its name:
The error shows that you can’t use the keyword match as the function
+identifier. To use match as a function name, you need to use the raw
+identifier syntax, like this:
This code will compile without any errors. Note the r# prefix on the function
+name in its definition as well as where the function is called in main.
+
Raw identifiers allow you to use any word you choose as an identifier, even if
+that word happens to be a reserved keyword. This gives us more freedom to
+choose identifier names, as well as lets us integrate with programs written in
+a language where these words aren’t keywords. In addition, raw identifiers
+allow you to use libraries written in a different Rust edition than your crate
+uses. For example, try isn’t a keyword in the 2015 edition but is in the 2018
+edition. If you depend on a library that’s written using the 2015 edition and
+has a try function, you’ll need to use the raw identifier syntax, r#try in
+this case, to call that function from your 2018 edition code. See Appendix
+E for more information on editions.
This appendix contains a glossary of Rust’s syntax, including operators and
+other symbols that appear by themselves or in the context of paths, generics,
+trait bounds, macros, attributes, comments, tuples, and brackets.
Table B-1 contains the operators in Rust, an example of how the operator would
+appear in context, a short explanation, and whether that operator is
+overloadable. If an operator is overloadable, the relevant trait to use to
+overload that operator is listed.
+
Table B-1: Operators
+
Operator
Example
Explanation
Overloadable?
+
!
ident!(...), ident!{...}, ident![...]
Macro expansion
+
!
!expr
Bitwise or logical complement
Not
+
!=
expr != expr
Nonequality comparison
PartialEq
+
%
expr % expr
Arithmetic remainder
Rem
+
%=
var %= expr
Arithmetic remainder and assignment
RemAssign
+
&
&expr, &mut expr
Borrow
+
&
&type, &mut type, &'a type, &'a mut type
Borrowed pointer type
+
&
expr & expr
Bitwise AND
BitAnd
+
&=
var &= expr
Bitwise AND and assignment
BitAndAssign
+
&&
expr && expr
Short-circuiting logical AND
+
*
expr * expr
Arithmetic multiplication
Mul
+
*=
var *= expr
Arithmetic multiplication and assignment
MulAssign
+
*
*expr
Dereference
Deref
+
*
*const type, *mut type
Raw pointer
+
+
trait + trait, 'a + trait
Compound type constraint
+
+
expr + expr
Arithmetic addition
Add
+
+=
var += expr
Arithmetic addition and assignment
AddAssign
+
,
expr, expr
Argument and element separator
+
-
- expr
Arithmetic negation
Neg
+
-
expr - expr
Arithmetic subtraction
Sub
+
-=
var -= expr
Arithmetic subtraction and assignment
SubAssign
+
->
fn(...) -> type, |…| -> type
Function and closure return type
+
.
expr.ident
Member access
+
..
.., expr.., ..expr, expr..expr
Right-exclusive range literal
PartialOrd
+
..=
..=expr, expr..=expr
Right-inclusive range literal
PartialOrd
+
..
..expr
Struct literal update syntax
+
..
variant(x, ..), struct_type { x, .. }
“And the rest” pattern binding
+
...
expr...expr
(Deprecated, use ..= instead) In a pattern: inclusive range pattern
In various places in the book, we’ve discussed the derive attribute, which
+you can apply to a struct or enum definition. The derive attribute generates
+code that will implement a trait with its own default implementation on the
+type you’ve annotated with the derive syntax.
+
In this appendix, we provide a reference of all the traits in the standard
+library that you can use with derive. Each section covers:
+
+
What operators and methods deriving this trait will enable
+
What the implementation of the trait provided by derive does
+
What implementing the trait signifies about the type
+
The conditions in which you’re allowed or not allowed to implement the trait
+
Examples of operations that require the trait
+
+
If you want different behavior from that provided by the derive attribute,
+consult the standard library documentation
+for each trait for details of how to manually implement them.
+
These traits listed here are the only ones defined by the standard library that
+can be implemented on your types using derive. Other traits defined in the
+standard library don’t have sensible default behavior, so it’s up to you to
+implement them in the way that makes sense for what you’re trying to accomplish.
+
An example of a trait that can’t be derived is Display, which handles
+formatting for end users. You should always consider the appropriate way to
+display a type to an end user. What parts of the type should an end user be
+allowed to see? What parts would they find relevant? What format of the data
+would be most relevant to them? The Rust compiler doesn’t have this insight, so
+it can’t provide appropriate default behavior for you.
+
The list of derivable traits provided in this appendix is not comprehensive:
+libraries can implement derive for their own traits, making the list of
+traits you can use derive with truly open-ended. Implementing derive
+involves using a procedural macro, which is covered in the
+“Macros” section of Chapter 19.
The Debug trait enables debug formatting in format strings, which you
+indicate by adding :? within {} placeholders.
+
The Debug trait allows you to print instances of a type for debugging
+purposes, so you and other programmers using your type can inspect an instance
+at a particular point in a program’s execution.
+
The Debug trait is required, for example, in using the assert_eq! macro.
+This macro prints the values of instances given as arguments if the equality
+assertion fails so programmers can see why the two instances weren’t equal.
The PartialEq trait allows you to compare instances of a type to check for
+equality and enables use of the == and != operators.
+
Deriving PartialEq implements the eq method. When PartialEq is derived on
+structs, two instances are equal only if all fields are equal, and the
+instances are not equal if any fields are not equal. When derived on enums,
+each variant is equal to itself and not equal to the other variants.
+
The PartialEq trait is required, for example, with the use of the
+assert_eq! macro, which needs to be able to compare two instances of a type
+for equality.
+
The Eq trait has no methods. Its purpose is to signal that for every value of
+the annotated type, the value is equal to itself. The Eq trait can only be
+applied to types that also implement PartialEq, although not all types that
+implement PartialEq can implement Eq. One example of this is floating point
+number types: the implementation of floating point numbers states that two
+instances of the not-a-number (NaN) value are not equal to each other.
+
An example of when Eq is required is for keys in a HashMap<K, V> so the
+HashMap<K, V> can tell whether two keys are the same.
The PartialOrd trait allows you to compare instances of a type for sorting
+purposes. A type that implements PartialOrd can be used with the <, >,
+<=, and >= operators. You can only apply the PartialOrd trait to types
+that also implement PartialEq.
+
Deriving PartialOrd implements the partial_cmp method, which returns an
+Option<Ordering> that will be None when the values given don’t produce an
+ordering. An example of a value that doesn’t produce an ordering, even though
+most values of that type can be compared, is the not-a-number (NaN) floating
+point value. Calling partial_cmp with any floating point number and the NaN
+floating point value will return None.
+
When derived on structs, PartialOrd compares two instances by comparing the
+value in each field in the order in which the fields appear in the struct
+definition. When derived on enums, variants of the enum declared earlier in the
+enum definition are considered less than the variants listed later.
+
The PartialOrd trait is required, for example, for the gen_range method
+from the rand crate that generates a random value in the range specified by a
+range expression.
+
The Ord trait allows you to know that for any two values of the annotated
+type, a valid ordering will exist. The Ord trait implements the cmp method,
+which returns an Ordering rather than an Option<Ordering> because a valid
+ordering will always be possible. You can only apply the Ord trait to types
+that also implement PartialOrd and Eq (and Eq requires PartialEq). When
+derived on structs and enums, cmp behaves the same way as the derived
+implementation for partial_cmp does with PartialOrd.
+
An example of when Ord is required is when storing values in a BTreeSet<T>,
+a data structure that stores data based on the sort order of the values.
The Clone trait allows you to explicitly create a deep copy of a value, and
+the duplication process might involve running arbitrary code and copying heap
+data. See the “Ways Variables and Data Interact:
+Clone” section in
+Chapter 4 for more information on Clone.
+
Deriving Clone implements the clone method, which when implemented for the
+whole type, calls clone on each of the parts of the type. This means all the
+fields or values in the type must also implement Clone to derive Clone.
+
An example of when Clone is required is when calling the to_vec method on a
+slice. The slice doesn’t own the type instances it contains, but the vector
+returned from to_vec will need to own its instances, so to_vec calls
+clone on each item. Thus, the type stored in the slice must implement Clone.
+
The Copy trait allows you to duplicate a value by only copying bits stored on
+the stack; no arbitrary code is necessary. See the “Stack-Only Data:
+Copy” section in Chapter 4 for more
+information on Copy.
+
The Copy trait doesn’t define any methods to prevent programmers from
+overloading those methods and violating the assumption that no arbitrary code
+is being run. That way, all programmers can assume that copying a value will be
+very fast.
+
You can derive Copy on any type whose parts all implement Copy. A type that
+implements Copy must also implement Clone, because a type that implements
+Copy has a trivial implementation of Clone that performs the same task as
+Copy.
+
The Copy trait is rarely required; types that implement Copy have
+optimizations available, meaning you don’t have to call clone, which makes
+the code more concise.
+
Everything possible with Copy you can also accomplish with Clone, but the
+code might be slower or have to use clone in places.
The Hash trait allows you to take an instance of a type of arbitrary size and
+map that instance to a value of fixed size using a hash function. Deriving
+Hash implements the hash method. The derived implementation of the hash
+method combines the result of calling hash on each of the parts of the type,
+meaning all fields or values must also implement Hash to derive Hash.
+
An example of when Hash is required is in storing keys in a HashMap<K, V>
+to store data efficiently.
The Default trait allows you to create a default value for a type. Deriving
+Default implements the default function. The derived implementation of the
+default function calls the default function on each part of the type,
+meaning all fields or values in the type must also implement Default to
+derive Default.
+
The Default::default function is commonly used in combination with the struct
+update syntax discussed in the “Creating Instances From Other Instances With
+Struct Update
+Syntax”
+section in Chapter 5. You can customize a few fields of a struct and then
+set and use a default value for the rest of the fields by using
+..Default::default().
+
The Default trait is required when you use the method unwrap_or_default on
+Option<T> instances, for example. If the Option<T> is None, the method
+unwrap_or_default will return the result of Default::default for the type
+T stored in the Option<T>.
In this appendix, we talk about some useful development tools that the Rust
+project provides. We’ll look at automatic formatting, quick ways to apply
+warning fixes, a linter, and integrating with IDEs.
The rustfmt tool reformats your code according to the community code style.
+Many collaborative projects use rustfmt to prevent arguments about which
+style to use when writing Rust: everyone formats their code using the tool.
+
To install rustfmt, enter the following:
+
$ rustup component add rustfmt
+
+
This command gives you rustfmt and cargo-fmt, similar to how Rust gives you
+both rustc and cargo. To format any Cargo project, enter the following:
+
$ cargo fmt
+
+
Running this command reformats all the Rust code in the current crate. This
+should only change the code style, not the code semantics. For more information
+on rustfmt, see its documentation.
The rustfix tool is included with Rust installations and can automatically fix
+compiler warnings that have a clear way to correct the problem that’s likely
+what you want. It’s likely you’ve seen compiler warnings before. For example,
+consider this code:
+
Filename: src/main.rs
+
fn do_something() {}
+
+fn main() {
+ for i in 0..100 {
+ do_something();
+ }
+}
+
Here, we’re calling the do_something function 100 times, but we never use the
+variable i in the body of the for loop. Rust warns us about that:
+
$ cargo build
+ Compiling myprogram v0.1.0 (file:///projects/myprogram)
+warning: unused variable: `i`
+ --> src/main.rs:4:9
+ |
+4 | for i in 0..100 {
+ | ^ help: consider using `_i` instead
+ |
+ = note: #[warn(unused_variables)] on by default
+
+ Finished dev [unoptimized + debuginfo] target(s) in 0.50s
+
+
The warning suggests that we use _i as a name instead: the underscore
+indicates that we intend for this variable to be unused. We can automatically
+apply that suggestion using the rustfix tool by running the command cargo fix:
The Clippy tool is a collection of lints to analyze your code so you can catch
+common mistakes and improve your Rust code.
+
To install Clippy, enter the following:
+
$ rustup component add clippy
+
+
To run Clippy’s lints on any Cargo project, enter the following:
+
$ cargo clippy
+
+
For example, say you write a program that uses an approximation of a
+mathematical constant, such as pi, as this program does:
+
Filename: src/main.rs
+
fn main() {
+ let x = 3.1415;
+ let r = 8.0;
+ println!("the area of the circle is {}", x * r * r);
+}
+
Running cargo clippy on this project results in this error:
+
error: approximate value of `f{32, 64}::consts::PI` found
+ --> src/main.rs:2:13
+ |
+2 | let x = 3.1415;
+ | ^^^^^^
+ |
+ = note: `#[deny(clippy::approx_constant)]` on by default
+ = help: consider using the constant directly
+ = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#approx_constant
+
+
This error lets you know that Rust already has a more precise PI constant
+defined, and that your program would be more correct if you used the constant
+instead. You would then change your code to use the PI constant. The
+following code doesn’t result in any errors or warnings from Clippy:
+
Filename: src/main.rs
+
fn main() {
+ let x = std::f64::consts::PI;
+ let r = 8.0;
+ println!("the area of the circle is {}", x * r * r);
+}
To help IDE integration, the Rust community recommends using
+rust-analyzer. This tool is a set of
+compiler-centric utilities that speaks the Language Server Protocol, which is a specification for IDEs and programming languages to
+communicate with each other. Different clients can use rust-analyzer, such as
+the Rust analyzer plug-in for Visual Studio Code.
+
Visit the rust-analyzer project’s home page
+for installation instructions, then install the language server support in your
+particular IDE. Your IDE will gain abilities such as autocompletion, jump to
+definition, and inline errors.
In Chapter 1, you saw that cargo new adds a bit of metadata to your
+Cargo.toml file about an edition. This appendix talks about what that means!
+
The Rust language and compiler have a six-week release cycle, meaning users get
+a constant stream of new features. Other programming languages release larger
+changes less often; Rust releases smaller updates more frequently. After a
+while, all of these tiny changes add up. But from release to release, it can be
+difficult to look back and say, “Wow, between Rust 1.10 and Rust 1.31, Rust has
+changed a lot!”
+
Every two or three years, the Rust team produces a new Rust edition. Each
+edition brings together the features that have landed into a clear package with
+fully updated documentation and tooling. New editions ship as part of the usual
+six-week release process.
+
Editions serve different purposes for different people:
+
+
For active Rust users, a new edition brings together incremental changes into
+an easy-to-understand package.
+
For non-users, a new edition signals that some major advancements have
+landed, which might make Rust worth another look.
+
For those developing Rust, a new edition provides a rallying point for the
+project as a whole.
+
+
At the time of this writing, three Rust editions are available: Rust 2015, Rust
+2018, and Rust 2021. This book is written using Rust 2021 edition idioms.
+
The edition key in Cargo.toml indicates which edition the compiler should
+use for your code. If the key doesn’t exist, Rust uses 2015 as the edition
+value for backward compatibility reasons.
+
Each project can opt in to an edition other than the default 2015 edition.
+Editions can contain incompatible changes, such as including a new keyword that
+conflicts with identifiers in code. However, unless you opt in to those
+changes, your code will continue to compile even as you upgrade the Rust
+compiler version you use.
+
All Rust compiler versions support any edition that existed prior to that
+compiler’s release, and they can link crates of any supported editions
+together. Edition changes only affect the way the compiler initially parses
+code. Therefore, if you’re using Rust 2015 and one of your dependencies uses
+Rust 2018, your project will compile and be able to use that dependency. The
+opposite situation, where your project uses Rust 2018 and a dependency uses
+Rust 2015, works as well.
+
To be clear: most features will be available on all editions. Developers using
+any Rust edition will continue to see improvements as new stable releases are
+made. However, in some cases, mainly when new keywords are added, some new
+features might only be available in later editions. You will need to switch
+editions if you want to take advantage of such features.
+
For more details, the Edition
+Guide is a complete book
+about editions that enumerates the differences between editions and explains
+how to automatically upgrade your code to a new edition via cargo fix.
As a language, Rust cares a lot about the stability of your code. We want
+Rust to be a rock-solid foundation you can build on, and if things were
+constantly changing, that would be impossible. At the same time, if we can’t
+experiment with new features, we may not find out important flaws until after
+their release, when we can no longer change things.
+
Our solution to this problem is what we call “stability without stagnation”,
+and our guiding principle is this: you should never have to fear upgrading to a
+new version of stable Rust. Each upgrade should be painless, but should also
+bring you new features, fewer bugs, and faster compile times.
Rust development operates on a train schedule. That is, all development is
+done on the master branch of the Rust repository. Releases follow a software
+release train model, which has been used by Cisco IOS and other software
+projects. There are three release channels for Rust:
+
+
Nightly
+
Beta
+
Stable
+
+
Most Rust developers primarily use the stable channel, but those who want to
+try out experimental new features may use nightly or beta.
+
Here’s an example of how the development and release process works: let’s
+assume that the Rust team is working on the release of Rust 1.5. That release
+happened in December of 2015, but it will provide us with realistic version
+numbers. A new feature is added to Rust: a new commit lands on the master
+branch. Each night, a new nightly version of Rust is produced. Every day is a
+release day, and these releases are created by our release infrastructure
+automatically. So as time passes, our releases look like this, once a night:
+
nightly: * - - * - - *
+
+
Every six weeks, it’s time to prepare a new release! The beta branch of the
+Rust repository branches off from the master branch used by nightly. Now,
+there are two releases:
+
nightly: * - - * - - *
+ |
+beta: *
+
+
Most Rust users do not use beta releases actively, but test against beta in
+their CI system to help Rust discover possible regressions. In the meantime,
+there’s still a nightly release every night:
+
nightly: * - - * - - * - - * - - *
+ |
+beta: *
+
+
Let’s say a regression is found. Good thing we had some time to test the beta
+release before the regression snuck into a stable release! The fix is applied
+to master, so that nightly is fixed, and then the fix is backported to the
+beta branch, and a new release of beta is produced:
Hooray! Rust 1.5 is done! However, we’ve forgotten one thing: because the six
+weeks have gone by, we also need a new beta of the next version of Rust, 1.6.
+So after stable branches off of beta, the next version of beta branches
+off of nightly again:
This is called the “train model” because every six weeks, a release “leaves the
+station”, but still has to take a journey through the beta channel before it
+arrives as a stable release.
+
Rust releases every six weeks, like clockwork. If you know the date of one Rust
+release, you can know the date of the next one: it’s six weeks later. A nice
+aspect of having releases scheduled every six weeks is that the next train is
+coming soon. If a feature happens to miss a particular release, there’s no need
+to worry: another one is happening in a short time! This helps reduce pressure
+to sneak possibly unpolished features in close to the release deadline.
+
Thanks to this process, you can always check out the next build of Rust and
+verify for yourself that it’s easy to upgrade to: if a beta release doesn’t
+work as expected, you can report it to the team and get it fixed before the
+next stable release happens! Breakage in a beta release is relatively rare, but
+rustc is still a piece of software, and bugs do exist.
The Rust project supports the most recent stable version. When a new stable
+version is released, the old version reaches its end of life (EOL). This means
+each version is supported for six weeks.
There’s one more catch with this release model: unstable features. Rust uses a
+technique called “feature flags” to determine what features are enabled in a
+given release. If a new feature is under active development, it lands on
+master, and therefore, in nightly, but behind a feature flag. If you, as a
+user, wish to try out the work-in-progress feature, you can, but you must be
+using a nightly release of Rust and annotate your source code with the
+appropriate flag to opt in.
+
If you’re using a beta or stable release of Rust, you can’t use any feature
+flags. This is the key that allows us to get practical use with new features
+before we declare them stable forever. Those who wish to opt into the bleeding
+edge can do so, and those who want a rock-solid experience can stick with
+stable and know that their code won’t break. Stability without stagnation.
+
This book only contains information about stable features, as in-progress
+features are still changing, and surely they’ll be different between when this
+book was written and when they get enabled in stable builds. You can find
+documentation for nightly-only features online.
Rustup makes it easy to change between different release channels of Rust, on a
+global or per-project basis. By default, you’ll have stable Rust installed. To
+install nightly, for example:
+
$ rustup toolchain install nightly
+
+
You can see all of the toolchains (releases of Rust and associated
+components) you have installed with rustup as well. Here’s an example on one
+of your authors’ Windows computer:
+
> rustup toolchain list
+stable-x86_64-pc-windows-msvc (default)
+beta-x86_64-pc-windows-msvc
+nightly-x86_64-pc-windows-msvc
+
+
As you can see, the stable toolchain is the default. Most Rust users use stable
+most of the time. You might want to use stable most of the time, but use
+nightly on a specific project, because you care about a cutting-edge feature.
+To do so, you can use rustup override in that project’s directory to set the
+nightly toolchain as the one rustup should use when you’re in that directory:
+
$ cd ~/projects/needs-nightly
+$ rustup override set nightly
+
+
Now, every time you call rustc or cargo inside of
+~/projects/needs-nightly, rustup will make sure that you are using nightly
+Rust, rather than your default of stable Rust. This comes in handy when you
+have a lot of Rust projects!
So how do you learn about these new features? Rust’s development model follows
+a Request For Comments (RFC) process. If you’d like an improvement in Rust,
+you can write up a proposal, called an RFC.
+
Anyone can write RFCs to improve Rust, and the proposals are reviewed and
+discussed by the Rust team, which is comprised of many topic subteams. There’s
+a full list of the teams on Rust’s
+website, which includes teams for
+each area of the project: language design, compiler implementation,
+infrastructure, documentation, and more. The appropriate team reads the
+proposal and the comments, writes some comments of their own, and eventually,
+there’s consensus to accept or reject the feature.
+
If the feature is accepted, an issue is opened on the Rust repository, and
+someone can implement it. The person who implements it very well may not be the
+person who proposed the feature in the first place! When the implementation is
+ready, it lands on the master branch behind a feature gate, as we discussed
+in the “Unstable Features” section.
+
After some time, once Rust developers who use nightly releases have been able
+to try out the new feature, team members will discuss the feature, how it’s
+worked out on nightly, and decide if it should make it into stable Rust or not.
+If the decision is to move forward, the feature gate is removed, and the
+feature is now considered stable! It rides the trains into a new stable release
+of Rust.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 0000000000..dc03e0a02d
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i': '>',
+ '"': '"',
+ "'": '''
+ };
+ var repl = function(c) { return MAP[c]; };
+ return function(s) {
+ return s.replace(/[&<>'"]/g, repl);
+ };
+ })();
+
+ function formatSearchMetric(count, searchterm) {
+ if (count == 1) {
+ return count + " search result for '" + searchterm + "':";
+ } else if (count == 0) {
+ return "No search results for '" + searchterm + "'.";
+ } else {
+ return count + " search results for '" + searchterm + "':";
+ }
+ }
+
+ function formatSearchResult(result, searchterms) {
+ var teaser = makeTeaser(escapeHTML(result.doc.body), searchterms);
+ teaser_count++;
+
+ // The ?URL_MARK_PARAM= parameter belongs inbetween the page and the #heading-anchor
+ var url = doc_urls[result.ref].split("#");
+ if (url.length == 1) { // no anchor found
+ url.push("");
+ }
+
+ // encodeURIComponent escapes all chars that could allow an XSS except
+ // for '. Due to that we also manually replace ' with its url-encoded
+ // representation (%27).
+ var searchterms = encodeURIComponent(searchterms.join(" ")).replace(/\'/g, "%27");
+
+ return '' + result.doc.breadcrumbs + ''
+ + ''
+ + teaser + '';
+ }
+
+ function makeTeaser(body, searchterms) {
+ // The strategy is as follows:
+ // First, assign a value to each word in the document:
+ // Words that correspond to search terms (stemmer aware): 40
+ // Normal words: 2
+ // First word in a sentence: 8
+ // Then use a sliding window with a constant number of words and count the
+ // sum of the values of the words within the window. Then use the window that got the
+ // maximum sum. If there are multiple maximas, then get the last one.
+ // Enclose the terms in .
+ var stemmed_searchterms = searchterms.map(function(w) {
+ return elasticlunr.stemmer(w.toLowerCase());
+ });
+ var searchterm_weight = 40;
+ var weighted = []; // contains elements of ["word", weight, index_in_document]
+ // split in sentences, then words
+ var sentences = body.toLowerCase().split('. ');
+ var index = 0;
+ var value = 0;
+ var searchterm_found = false;
+ for (var sentenceindex in sentences) {
+ var words = sentences[sentenceindex].split(' ');
+ value = 8;
+ for (var wordindex in words) {
+ var word = words[wordindex];
+ if (word.length > 0) {
+ for (var searchtermindex in stemmed_searchterms) {
+ if (elasticlunr.stemmer(word).startsWith(stemmed_searchterms[searchtermindex])) {
+ value = searchterm_weight;
+ searchterm_found = true;
+ }
+ };
+ weighted.push([word, value, index]);
+ value = 2;
+ }
+ index += word.length;
+ index += 1; // ' ' or '.' if last word in sentence
+ };
+ index += 1; // because we split at a two-char boundary '. '
+ };
+
+ if (weighted.length == 0) {
+ return body;
+ }
+
+ var window_weight = [];
+ var window_size = Math.min(weighted.length, results_options.teaser_word_count);
+
+ var cur_sum = 0;
+ for (var wordindex = 0; wordindex < window_size; wordindex++) {
+ cur_sum += weighted[wordindex][1];
+ };
+ window_weight.push(cur_sum);
+ for (var wordindex = 0; wordindex < weighted.length - window_size; wordindex++) {
+ cur_sum -= weighted[wordindex][1];
+ cur_sum += weighted[wordindex + window_size][1];
+ window_weight.push(cur_sum);
+ };
+
+ if (searchterm_found) {
+ var max_sum = 0;
+ var max_sum_window_index = 0;
+ // backwards
+ for (var i = window_weight.length - 1; i >= 0; i--) {
+ if (window_weight[i] > max_sum) {
+ max_sum = window_weight[i];
+ max_sum_window_index = i;
+ }
+ };
+ } else {
+ max_sum_window_index = 0;
+ }
+
+ // add around searchterms
+ var teaser_split = [];
+ var index = weighted[max_sum_window_index][2];
+ for (var i = max_sum_window_index; i < max_sum_window_index+window_size; i++) {
+ var word = weighted[i];
+ if (index < word[2]) {
+ // missing text from index to start of `word`
+ teaser_split.push(body.substring(index, word[2]));
+ index = word[2];
+ }
+ if (word[1] == searchterm_weight) {
+ teaser_split.push("")
+ }
+ index = word[2] + word[0].length;
+ teaser_split.push(body.substring(word[2], index));
+ if (word[1] == searchterm_weight) {
+ teaser_split.push("")
+ }
+ };
+
+ return teaser_split.join('');
+ }
+
+ function init(config) {
+ results_options = config.results_options;
+ search_options = config.search_options;
+ searchbar_outer = config.searchbar_outer;
+ doc_urls = config.doc_urls;
+ searchindex = elasticlunr.Index.load(config.index);
+
+ // Set up events
+ searchicon.addEventListener('click', function(e) { searchIconClickHandler(); }, false);
+ searchbar.addEventListener('keyup', function(e) { searchbarKeyUpHandler(); }, false);
+ document.addEventListener('keydown', function(e) { globalKeyHandler(e); }, false);
+ // If the user uses the browser buttons, do the same as if a reload happened
+ window.onpopstate = function(e) { doSearchOrMarkFromUrl(); };
+ // Suppress "submit" events so the page doesn't reload when the user presses Enter
+ document.addEventListener('submit', function(e) { e.preventDefault(); }, false);
+
+ // If reloaded, do the search or mark again, depending on the current url parameters
+ doSearchOrMarkFromUrl();
+ }
+
+ function unfocusSearchbar() {
+ // hacky, but just focusing a div only works once
+ var tmp = document.createElement('input');
+ tmp.setAttribute('style', 'position: absolute; opacity: 0;');
+ searchicon.appendChild(tmp);
+ tmp.focus();
+ tmp.remove();
+ }
+
+ // On reload or browser history backwards/forwards events, parse the url and do search or mark
+ function doSearchOrMarkFromUrl() {
+ // Check current URL for search request
+ var url = parseURL(window.location.href);
+ if (url.params.hasOwnProperty(URL_SEARCH_PARAM)
+ && url.params[URL_SEARCH_PARAM] != "") {
+ showSearch(true);
+ searchbar.value = decodeURIComponent(
+ (url.params[URL_SEARCH_PARAM]+'').replace(/\+/g, '%20'));
+ searchbarKeyUpHandler(); // -> doSearch()
+ } else {
+ showSearch(false);
+ }
+
+ if (url.params.hasOwnProperty(URL_MARK_PARAM)) {
+ var words = decodeURIComponent(url.params[URL_MARK_PARAM]).split(' ');
+ marker.mark(words, {
+ exclude: mark_exclude
+ });
+
+ var markers = document.querySelectorAll("mark");
+ function hide() {
+ for (var i = 0; i < markers.length; i++) {
+ markers[i].classList.add("fade-out");
+ window.setTimeout(function(e) { marker.unmark(); }, 300);
+ }
+ }
+ for (var i = 0; i < markers.length; i++) {
+ markers[i].addEventListener('click', hide);
+ }
+ }
+ }
+
+ // Eventhandler for keyevents on `document`
+ function globalKeyHandler(e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey || e.target.type === 'textarea' || e.target.type === 'text' || !hasFocus() && /^(?:input|select|textarea)$/i.test(e.target.nodeName)) { return; }
+
+ if (e.keyCode === ESCAPE_KEYCODE) {
+ e.preventDefault();
+ searchbar.classList.remove("active");
+ setSearchUrlParameters("",
+ (searchbar.value.trim() !== "") ? "push" : "replace");
+ if (hasFocus()) {
+ unfocusSearchbar();
+ }
+ showSearch(false);
+ marker.unmark();
+ } else if (!hasFocus() && e.keyCode === SEARCH_HOTKEY_KEYCODE) {
+ e.preventDefault();
+ showSearch(true);
+ window.scrollTo(0, 0);
+ searchbar.select();
+ } else if (hasFocus() && e.keyCode === DOWN_KEYCODE) {
+ e.preventDefault();
+ unfocusSearchbar();
+ searchresults.firstElementChild.classList.add("focus");
+ } else if (!hasFocus() && (e.keyCode === DOWN_KEYCODE
+ || e.keyCode === UP_KEYCODE
+ || e.keyCode === SELECT_KEYCODE)) {
+ // not `:focus` because browser does annoying scrolling
+ var focused = searchresults.querySelector("li.focus");
+ if (!focused) return;
+ e.preventDefault();
+ if (e.keyCode === DOWN_KEYCODE) {
+ var next = focused.nextElementSibling;
+ if (next) {
+ focused.classList.remove("focus");
+ next.classList.add("focus");
+ }
+ } else if (e.keyCode === UP_KEYCODE) {
+ focused.classList.remove("focus");
+ var prev = focused.previousElementSibling;
+ if (prev) {
+ prev.classList.add("focus");
+ } else {
+ searchbar.select();
+ }
+ } else { // SELECT_KEYCODE
+ window.location.assign(focused.querySelector('a'));
+ }
+ }
+ }
+
+ function showSearch(yes) {
+ if (yes) {
+ search_wrap.classList.remove('hidden');
+ searchicon.setAttribute('aria-expanded', 'true');
+ } else {
+ search_wrap.classList.add('hidden');
+ searchicon.setAttribute('aria-expanded', 'false');
+ var results = searchresults.children;
+ for (var i = 0; i < results.length; i++) {
+ results[i].classList.remove("focus");
+ }
+ }
+ }
+
+ function showResults(yes) {
+ if (yes) {
+ searchresults_outer.classList.remove('hidden');
+ } else {
+ searchresults_outer.classList.add('hidden');
+ }
+ }
+
+ // Eventhandler for search icon
+ function searchIconClickHandler() {
+ if (search_wrap.classList.contains('hidden')) {
+ showSearch(true);
+ window.scrollTo(0, 0);
+ searchbar.select();
+ } else {
+ showSearch(false);
+ }
+ }
+
+ // Eventhandler for keyevents while the searchbar is focused
+ function searchbarKeyUpHandler() {
+ var searchterm = searchbar.value.trim();
+ if (searchterm != "") {
+ searchbar.classList.add("active");
+ doSearch(searchterm);
+ } else {
+ searchbar.classList.remove("active");
+ showResults(false);
+ removeChildren(searchresults);
+ }
+
+ setSearchUrlParameters(searchterm, "push_if_new_search_else_replace");
+
+ // Remove marks
+ marker.unmark();
+ }
+
+ // Update current url with ?URL_SEARCH_PARAM= parameter, remove ?URL_MARK_PARAM and #heading-anchor .
+ // `action` can be one of "push", "replace", "push_if_new_search_else_replace"
+ // and replaces or pushes a new browser history item.
+ // "push_if_new_search_else_replace" pushes if there is no `?URL_SEARCH_PARAM=abc` yet.
+ function setSearchUrlParameters(searchterm, action) {
+ var url = parseURL(window.location.href);
+ var first_search = ! url.params.hasOwnProperty(URL_SEARCH_PARAM);
+ if (searchterm != "" || action == "push_if_new_search_else_replace") {
+ url.params[URL_SEARCH_PARAM] = searchterm;
+ delete url.params[URL_MARK_PARAM];
+ url.hash = "";
+ } else {
+ delete url.params[URL_MARK_PARAM];
+ delete url.params[URL_SEARCH_PARAM];
+ }
+ // A new search will also add a new history item, so the user can go back
+ // to the page prior to searching. A updated search term will only replace
+ // the url.
+ if (action == "push" || (action == "push_if_new_search_else_replace" && first_search) ) {
+ history.pushState({}, document.title, renderURL(url));
+ } else if (action == "replace" || (action == "push_if_new_search_else_replace" && !first_search) ) {
+ history.replaceState({}, document.title, renderURL(url));
+ }
+ }
+
+ function doSearch(searchterm) {
+
+ // Don't search the same twice
+ if (current_searchterm == searchterm) { return; }
+ else { current_searchterm = searchterm; }
+
+ if (searchindex == null) { return; }
+
+ // Do the actual search
+ var results = searchindex.search(searchterm, search_options);
+ var resultcount = Math.min(results.length, results_options.limit_results);
+
+ // Display search metrics
+ searchresults_header.innerText = formatSearchMetric(resultcount, searchterm);
+
+ // Clear and insert results
+ var searchterms = searchterm.split(' ');
+ removeChildren(searchresults);
+ for(var i = 0; i < resultcount ; i++){
+ var resultElem = document.createElement('li');
+ resultElem.innerHTML = formatSearchResult(results[i], searchterms);
+ searchresults.appendChild(resultElem);
+ }
+
+ // Display results
+ showResults(true);
+ }
+
+ fetch(path_to_root + 'searchindex.json')
+ .then(response => response.json())
+ .then(json => init(json))
+ .catch(error => { // Try to load searchindex.js if fetch failed
+ var script = document.createElement('script');
+ script.src = path_to_root + 'searchindex.js';
+ script.onload = () => init(window.search);
+ document.head.appendChild(script);
+ });
+
+ // Exported functions
+ search.hasFocus = hasFocus;
+})(window.search);
diff --git a/searchindex.js b/searchindex.js
new file mode 100644
index 0000000000..9db9fb714e
--- /dev/null
+++ b/searchindex.js
@@ -0,0 +1 @@
+Object.assign(window.search, {"doc_urls":["title-page.html#the-rust-programming-language","foreword.html#foreword","ch00-00-introduction.html#introduction","ch00-00-introduction.html#who-rust-is-for","ch00-00-introduction.html#teams-of-developers","ch00-00-introduction.html#students","ch00-00-introduction.html#companies","ch00-00-introduction.html#open-source-developers","ch00-00-introduction.html#people-who-value-speed-and-stability","ch00-00-introduction.html#who-this-book-is-for","ch00-00-introduction.html#how-to-use-this-book","ch00-00-introduction.html#source-code","ch01-00-getting-started.html#getting-started","ch01-01-installation.html#installation","ch01-01-installation.html#command-line-notation","ch01-01-installation.html#installing-rustup-on-linux-or-macos","ch01-01-installation.html#installing-rustup-on-windows","ch01-01-installation.html#troubleshooting","ch01-01-installation.html#updating-and-uninstalling","ch01-01-installation.html#local-documentation","ch01-02-hello-world.html#hello-world","ch01-02-hello-world.html#creating-a-project-directory","ch01-02-hello-world.html#writing-and-running-a-rust-program","ch01-02-hello-world.html#anatomy-of-a-rust-program","ch01-02-hello-world.html#compiling-and-running-are-separate-steps","ch01-03-hello-cargo.html#hello-cargo","ch01-03-hello-cargo.html#creating-a-project-with-cargo","ch01-03-hello-cargo.html#building-and-running-a-cargo-project","ch01-03-hello-cargo.html#building-for-release","ch01-03-hello-cargo.html#cargo-as-convention","ch01-03-hello-cargo.html#summary","ch02-00-guessing-game-tutorial.html#programming-a-guessing-game","ch02-00-guessing-game-tutorial.html#setting-up-a-new-project","ch02-00-guessing-game-tutorial.html#processing-a-guess","ch02-00-guessing-game-tutorial.html#storing-values-with-variables","ch02-00-guessing-game-tutorial.html#receiving-user-input","ch02-00-guessing-game-tutorial.html#handling-potential-failure-with-result","ch02-00-guessing-game-tutorial.html#printing-values-with-println-placeholders","ch02-00-guessing-game-tutorial.html#testing-the-first-part","ch02-00-guessing-game-tutorial.html#generating-a-secret-number","ch02-00-guessing-game-tutorial.html#using-a-crate-to-get-more-functionality","ch02-00-guessing-game-tutorial.html#generating-a-random-number","ch02-00-guessing-game-tutorial.html#comparing-the-guess-to-the-secret-number","ch02-00-guessing-game-tutorial.html#allowing-multiple-guesses-with-looping","ch02-00-guessing-game-tutorial.html#quitting-after-a-correct-guess","ch02-00-guessing-game-tutorial.html#handling-invalid-input","ch02-00-guessing-game-tutorial.html#summary","ch03-00-common-programming-concepts.html#common-programming-concepts","ch03-01-variables-and-mutability.html#variables-and-mutability","ch03-01-variables-and-mutability.html#constants","ch03-01-variables-and-mutability.html#shadowing","ch03-02-data-types.html#data-types","ch03-02-data-types.html#scalar-types","ch03-02-data-types.html#compound-types","ch03-03-how-functions-work.html#functions","ch03-03-how-functions-work.html#parameters","ch03-03-how-functions-work.html#statements-and-expressions","ch03-03-how-functions-work.html#functions-with-return-values","ch03-04-comments.html#comments","ch03-05-control-flow.html#control-flow","ch03-05-control-flow.html#if-expressions","ch03-05-control-flow.html#repetition-with-loops","ch03-05-control-flow.html#summary","ch04-00-understanding-ownership.html#understanding-ownership","ch04-01-what-is-ownership.html#what-is-ownership","ch04-01-what-is-ownership.html#the-stack-and-the-heap","ch04-01-what-is-ownership.html#ownership-rules","ch04-01-what-is-ownership.html#variable-scope","ch04-01-what-is-ownership.html#the-string-type","ch04-01-what-is-ownership.html#memory-and-allocation","ch04-01-what-is-ownership.html#ownership-and-functions","ch04-01-what-is-ownership.html#return-values-and-scope","ch04-02-references-and-borrowing.html#references-and-borrowing","ch04-02-references-and-borrowing.html#mutable-references","ch04-02-references-and-borrowing.html#dangling-references","ch04-02-references-and-borrowing.html#the-rules-of-references","ch04-03-slices.html#the-slice-type","ch04-03-slices.html#string-slices","ch04-03-slices.html#other-slices","ch04-03-slices.html#summary","ch05-00-structs.html#using-structs-to-structure-related-data","ch05-01-defining-structs.html#defining-and-instantiating-structs","ch05-01-defining-structs.html#using-the-field-init-shorthand","ch05-01-defining-structs.html#creating-instances-from-other-instances-with-struct-update-syntax","ch05-01-defining-structs.html#using-tuple-structs-without-named-fields-to-create-different-types","ch05-01-defining-structs.html#unit-like-structs-without-any-fields","ch05-01-defining-structs.html#ownership-of-struct-data","ch05-02-example-structs.html#an-example-program-using-structs","ch05-02-example-structs.html#refactoring-with-tuples","ch05-02-example-structs.html#refactoring-with-structs-adding-more-meaning","ch05-02-example-structs.html#adding-useful-functionality-with-derived-traits","ch05-03-method-syntax.html#method-syntax","ch05-03-method-syntax.html#defining-methods","ch05-03-method-syntax.html#wheres-the---operator","ch05-03-method-syntax.html#methods-with-more-parameters","ch05-03-method-syntax.html#associated-functions","ch05-03-method-syntax.html#multiple-impl-blocks","ch05-03-method-syntax.html#summary","ch06-00-enums.html#enums-and-pattern-matching","ch06-01-defining-an-enum.html#defining-an-enum","ch06-01-defining-an-enum.html#enum-values","ch06-01-defining-an-enum.html#the-option-enum-and-its-advantages-over-null-values","ch06-02-match.html#the-match-control-flow-construct","ch06-02-match.html#patterns-that-bind-to-values","ch06-02-match.html#matching-with-option","ch06-02-match.html#matches-are-exhaustive","ch06-02-match.html#catch-all-patterns-and-the-_-placeholder","ch06-03-if-let.html#concise-control-flow-with-if-let","ch06-03-if-let.html#summary","ch07-00-managing-growing-projects-with-packages-crates-and-modules.html#managing-growing-projects-with-packages-crates-and-modules","ch07-01-packages-and-crates.html#packages-and-crates","ch07-02-defining-modules-to-control-scope-and-privacy.html#defining-modules-to-control-scope-and-privacy","ch07-02-defining-modules-to-control-scope-and-privacy.html#modules-cheat-sheet","ch07-02-defining-modules-to-control-scope-and-privacy.html#grouping-related-code-in-modules","ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html#paths-for-referring-to-an-item-in-the-module-tree","ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html#exposing-paths-with-the-pub-keyword","ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html#starting-relative-paths-with-super","ch07-03-paths-for-referring-to-an-item-in-the-module-tree.html#making-structs-and-enums-public","ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#bringing-paths-into-scope-with-the-use-keyword","ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#creating-idiomatic-use-paths","ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#providing-new-names-with-the-as-keyword","ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#re-exporting-names-with-pub-use","ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#using-external-packages","ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#using-nested-paths-to-clean-up-large-use-lists","ch07-04-bringing-paths-into-scope-with-the-use-keyword.html#the-glob-operator","ch07-05-separating-modules-into-different-files.html#separating-modules-into-different-files","ch07-05-separating-modules-into-different-files.html#alternate-file-paths","ch07-05-separating-modules-into-different-files.html#summary","ch08-00-common-collections.html#common-collections","ch08-01-vectors.html#storing-lists-of-values-with-vectors","ch08-01-vectors.html#creating-a-new-vector","ch08-01-vectors.html#updating-a-vector","ch08-01-vectors.html#reading-elements-of-vectors","ch08-01-vectors.html#iterating-over-the-values-in-a-vector","ch08-01-vectors.html#using-an-enum-to-store-multiple-types","ch08-01-vectors.html#dropping-a-vector-drops-its-elements","ch08-02-strings.html#storing-utf-8-encoded-text-with-strings","ch08-02-strings.html#what-is-a-string","ch08-02-strings.html#creating-a-new-string","ch08-02-strings.html#updating-a-string","ch08-02-strings.html#indexing-into-strings","ch08-02-strings.html#slicing-strings","ch08-02-strings.html#methods-for-iterating-over-strings","ch08-02-strings.html#strings-are-not-so-simple","ch08-03-hash-maps.html#storing-keys-with-associated-values-in-hash-maps","ch08-03-hash-maps.html#creating-a-new-hash-map","ch08-03-hash-maps.html#accessing-values-in-a-hash-map","ch08-03-hash-maps.html#hash-maps-and-ownership","ch08-03-hash-maps.html#updating-a-hash-map","ch08-03-hash-maps.html#hashing-functions","ch08-03-hash-maps.html#summary","ch09-00-error-handling.html#error-handling","ch09-01-unrecoverable-errors-with-panic.html#unrecoverable-errors-with-panic","ch09-01-unrecoverable-errors-with-panic.html#unwinding-the-stack-or-aborting-in-response-to-a-panic","ch09-02-recoverable-errors-with-result.html#recoverable-errors-with-result","ch09-02-recoverable-errors-with-result.html#matching-on-different-errors","ch09-02-recoverable-errors-with-result.html#propagating-errors","ch09-03-to-panic-or-not-to-panic.html#to-panic-or-not-to-panic","ch09-03-to-panic-or-not-to-panic.html#examples-prototype-code-and-tests","ch09-03-to-panic-or-not-to-panic.html#cases-in-which-you-have-more-information-than-the-compiler","ch09-03-to-panic-or-not-to-panic.html#guidelines-for-error-handling","ch09-03-to-panic-or-not-to-panic.html#creating-custom-types-for-validation","ch09-03-to-panic-or-not-to-panic.html#summary","ch10-00-generics.html#generic-types-traits-and-lifetimes","ch10-00-generics.html#removing-duplication-by-extracting-a-function","ch10-01-syntax.html#generic-data-types","ch10-01-syntax.html#in-function-definitions","ch10-01-syntax.html#in-struct-definitions","ch10-01-syntax.html#in-enum-definitions","ch10-01-syntax.html#in-method-definitions","ch10-01-syntax.html#performance-of-code-using-generics","ch10-02-traits.html#traits-defining-shared-behavior","ch10-02-traits.html#defining-a-trait","ch10-02-traits.html#implementing-a-trait-on-a-type","ch10-02-traits.html#default-implementations","ch10-02-traits.html#traits-as-parameters","ch10-02-traits.html#returning-types-that-implement-traits","ch10-02-traits.html#using-trait-bounds-to-conditionally-implement-methods","ch10-03-lifetime-syntax.html#validating-references-with-lifetimes","ch10-03-lifetime-syntax.html#preventing-dangling-references-with-lifetimes","ch10-03-lifetime-syntax.html#the-borrow-checker","ch10-03-lifetime-syntax.html#generic-lifetimes-in-functions","ch10-03-lifetime-syntax.html#lifetime-annotation-syntax","ch10-03-lifetime-syntax.html#lifetime-annotations-in-function-signatures","ch10-03-lifetime-syntax.html#thinking-in-terms-of-lifetimes","ch10-03-lifetime-syntax.html#lifetime-annotations-in-struct-definitions","ch10-03-lifetime-syntax.html#lifetime-elision","ch10-03-lifetime-syntax.html#lifetime-annotations-in-method-definitions","ch10-03-lifetime-syntax.html#the-static-lifetime","ch10-03-lifetime-syntax.html#generic-type-parameters-trait-bounds-and-lifetimes-together","ch10-03-lifetime-syntax.html#summary","ch11-00-testing.html#writing-automated-tests","ch11-01-writing-tests.html#how-to-write-tests","ch11-01-writing-tests.html#the-anatomy-of-a-test-function","ch11-01-writing-tests.html#checking-results-with-the-assert-macro","ch11-01-writing-tests.html#testing-equality-with-the-assert_eq-and-assert_ne-macros","ch11-01-writing-tests.html#adding-custom-failure-messages","ch11-01-writing-tests.html#checking-for-panics-with-should_panic","ch11-01-writing-tests.html#using-result-in-tests","ch11-02-running-tests.html#controlling-how-tests-are-run","ch11-02-running-tests.html#running-tests-in-parallel-or-consecutively","ch11-02-running-tests.html#showing-function-output","ch11-02-running-tests.html#running-a-subset-of-tests-by-name","ch11-02-running-tests.html#ignoring-some-tests-unless-specifically-requested","ch11-03-test-organization.html#test-organization","ch11-03-test-organization.html#unit-tests","ch11-03-test-organization.html#integration-tests","ch11-03-test-organization.html#summary","ch12-00-an-io-project.html#an-io-project-building-a-command-line-program","ch12-01-accepting-command-line-arguments.html#accepting-command-line-arguments","ch12-01-accepting-command-line-arguments.html#reading-the-argument-values","ch12-01-accepting-command-line-arguments.html#the-args-function-and-invalid-unicode","ch12-01-accepting-command-line-arguments.html#saving-the-argument-values-in-variables","ch12-02-reading-a-file.html#reading-a-file","ch12-03-improving-error-handling-and-modularity.html#refactoring-to-improve-modularity-and-error-handling","ch12-03-improving-error-handling-and-modularity.html#separation-of-concerns-for-binary-projects","ch12-03-improving-error-handling-and-modularity.html#the-trade-offs-of-using-clone","ch12-03-improving-error-handling-and-modularity.html#fixing-the-error-handling","ch12-03-improving-error-handling-and-modularity.html#extracting-logic-from-main","ch12-03-improving-error-handling-and-modularity.html#splitting-code-into-a-library-crate","ch12-04-testing-the-librarys-functionality.html#developing-the-librarys-functionality-with-test-driven-development","ch12-04-testing-the-librarys-functionality.html#writing-a-failing-test","ch12-04-testing-the-librarys-functionality.html#writing-code-to-pass-the-test","ch12-05-working-with-environment-variables.html#working-with-environment-variables","ch12-05-working-with-environment-variables.html#writing-a-failing-test-for-the-case-insensitive-search-function","ch12-05-working-with-environment-variables.html#implementing-the-search_case_insensitive-function","ch12-06-writing-to-stderr-instead-of-stdout.html#writing-error-messages-to-standard-error-instead-of-standard-output","ch12-06-writing-to-stderr-instead-of-stdout.html#checking-where-errors-are-written","ch12-06-writing-to-stderr-instead-of-stdout.html#printing-errors-to-standard-error","ch12-06-writing-to-stderr-instead-of-stdout.html#summary","ch13-00-functional-features.html#functional-language-features-iterators-and-closures","ch13-01-closures.html#closures-anonymous-functions-that-capture-their-environment","ch13-01-closures.html#capturing-the-environment-with-closures","ch13-01-closures.html#closure-type-inference-and-annotation","ch13-01-closures.html#capturing-references-or-moving-ownership","ch13-01-closures.html#moving-captured-values-out-of-closures-and-the-fn-traits","ch13-02-iterators.html#processing-a-series-of-items-with-iterators","ch13-02-iterators.html#the-iterator-trait-and-the-next-method","ch13-02-iterators.html#methods-that-consume-the-iterator","ch13-02-iterators.html#methods-that-produce-other-iterators","ch13-02-iterators.html#using-closures-that-capture-their-environment","ch13-03-improving-our-io-project.html#improving-our-io-project","ch13-03-improving-our-io-project.html#removing-a-clone-using-an-iterator","ch13-03-improving-our-io-project.html#making-code-clearer-with-iterator-adaptors","ch13-03-improving-our-io-project.html#choosing-between-loops-or-iterators","ch13-04-performance.html#comparing-performance-loops-vs-iterators","ch13-04-performance.html#summary","ch14-00-more-about-cargo.html#more-about-cargo-and-cratesio","ch14-01-release-profiles.html#customizing-builds-with-release-profiles","ch14-02-publishing-to-crates-io.html#publishing-a-crate-to-cratesio","ch14-02-publishing-to-crates-io.html#making-useful-documentation-comments","ch14-02-publishing-to-crates-io.html#exporting-a-convenient-public-api-with-pub-use","ch14-02-publishing-to-crates-io.html#setting-up-a-cratesio-account","ch14-02-publishing-to-crates-io.html#adding-metadata-to-a-new-crate","ch14-02-publishing-to-crates-io.html#publishing-to-cratesio","ch14-02-publishing-to-crates-io.html#publishing-a-new-version-of-an-existing-crate","ch14-02-publishing-to-crates-io.html#deprecating-versions-from-cratesio-with-cargo-yank","ch14-03-cargo-workspaces.html#cargo-workspaces","ch14-03-cargo-workspaces.html#creating-a-workspace","ch14-03-cargo-workspaces.html#creating-the-second-package-in-the-workspace","ch14-04-installing-binaries.html#installing-binaries-with-cargo-install","ch14-05-extending-cargo.html#extending-cargo-with-custom-commands","ch14-05-extending-cargo.html#summary","ch15-00-smart-pointers.html#smart-pointers","ch15-01-box.html#using-box-to-point-to-data-on-the-heap","ch15-01-box.html#using-a-box-to-store-data-on-the-heap","ch15-01-box.html#enabling-recursive-types-with-boxes","ch15-02-deref.html#treating-smart-pointers-like-regular-references-with-the-deref-trait","ch15-02-deref.html#following-the-pointer-to-the-value","ch15-02-deref.html#using-box-like-a-reference","ch15-02-deref.html#defining-our-own-smart-pointer","ch15-02-deref.html#treating-a-type-like-a-reference-by-implementing-the-deref-trait","ch15-02-deref.html#implicit-deref-coercions-with-functions-and-methods","ch15-02-deref.html#how-deref-coercion-interacts-with-mutability","ch15-03-drop.html#running-code-on-cleanup-with-the-drop-trait","ch15-03-drop.html#dropping-a-value-early-with-stdmemdrop","ch15-04-rc.html#rc-the-reference-counted-smart-pointer","ch15-04-rc.html#using-rc-to-share-data","ch15-04-rc.html#cloning-an-rc-increases-the-reference-count","ch15-05-interior-mutability.html#refcell-and-the-interior-mutability-pattern","ch15-05-interior-mutability.html#enforcing-borrowing-rules-at-runtime-with-refcell","ch15-05-interior-mutability.html#interior-mutability-a-mutable-borrow-to-an-immutable-value","ch15-05-interior-mutability.html#having-multiple-owners-of-mutable-data-by-combining-rc-and-refcell","ch15-06-reference-cycles.html#reference-cycles-can-leak-memory","ch15-06-reference-cycles.html#creating-a-reference-cycle","ch15-06-reference-cycles.html#preventing-reference-cycles-turning-an-rc-into-a-weak","ch15-06-reference-cycles.html#summary","ch16-00-concurrency.html#fearless-concurrency","ch16-01-threads.html#using-threads-to-run-code-simultaneously","ch16-01-threads.html#creating-a-new-thread-with-spawn","ch16-01-threads.html#waiting-for-all-threads-to-finish-using-join-handles","ch16-01-threads.html#using-move-closures-with-threads","ch16-02-message-passing.html#using-message-passing-to-transfer-data-between-threads","ch16-02-message-passing.html#channels-and-ownership-transference","ch16-02-message-passing.html#sending-multiple-values-and-seeing-the-receiver-waiting","ch16-02-message-passing.html#creating-multiple-producers-by-cloning-the-transmitter","ch16-03-shared-state.html#shared-state-concurrency","ch16-03-shared-state.html#using-mutexes-to-allow-access-to-data-from-one-thread-at-a-time","ch16-03-shared-state.html#similarities-between-refcellrc-and-mutexarc","ch16-04-extensible-concurrency-sync-and-send.html#extensible-concurrency-with-the-sync-and-send-traits","ch16-04-extensible-concurrency-sync-and-send.html#allowing-transference-of-ownership-between-threads-with-send","ch16-04-extensible-concurrency-sync-and-send.html#allowing-access-from-multiple-threads-with-sync","ch16-04-extensible-concurrency-sync-and-send.html#implementing-send-and-sync-manually-is-unsafe","ch16-04-extensible-concurrency-sync-and-send.html#summary","ch17-00-async-await.html#async-and-await","ch17-00-async-await.html#why-async","ch17-00-async-await.html#parallelism-and-concurrency","ch17-01-futures-and-syntax.html#futures-and-the-async-syntax","ch17-01-futures-and-syntax.html#async-functions","ch17-01-futures-and-syntax.html#the-futures-and-tokio-crates","ch17-01-futures-and-syntax.html#what-are-futures","ch17-02-concurrency-with-async.html#concurrency-with-async","ch17-02-concurrency-with-async.html#counting","ch17-02-concurrency-with-async.html#message-passing","ch17-03-more-futures.html#working-with-more-futures","ch17-03-more-futures.html#pinning-and-the-pin-and-unpin-traits","ch17-04-more-ways-of-combining-futures.html#more-ways-of-combining-futures","ch17-04-more-ways-of-combining-futures.html#yielding","ch17-04-more-ways-of-combining-futures.html#building-our-own-async-abstractions","ch17-05-streams.html#streams","ch17-05-streams.html#working-with-streams","ch17-05-streams.html#composing-streams","ch17-05-streams.html#merging-streams","ch17-06-futures-tasks-threads.html#futures-tasks-and-threads","ch18-00-oop.html#object-oriented-programming-features-of-rust","ch18-01-what-is-oo.html#characteristics-of-object-oriented-languages","ch18-01-what-is-oo.html#objects-contain-data-and-behavior","ch18-01-what-is-oo.html#encapsulation-that-hides-implementation-details","ch18-01-what-is-oo.html#inheritance-as-a-type-system-and-as-code-sharing","ch18-01-what-is-oo.html#polymorphism","ch18-02-trait-objects.html#using-trait-objects-that-allow-for-values-of-different-types","ch18-02-trait-objects.html#defining-a-trait-for-common-behavior","ch18-02-trait-objects.html#implementing-the-trait","ch18-02-trait-objects.html#trait-objects-perform-dynamic-dispatch","ch18-03-oo-design-patterns.html#implementing-an-object-oriented-design-pattern","ch18-03-oo-design-patterns.html#defining-post-and-creating-a-new-instance-in-the-draft-state","ch18-03-oo-design-patterns.html#storing-the-text-of-the-post-content","ch18-03-oo-design-patterns.html#ensuring-the-content-of-a-draft-post-is-empty","ch18-03-oo-design-patterns.html#requesting-a-review-of-the-post-changes-its-state","ch18-03-oo-design-patterns.html#adding-approve-to-change-the-behavior-of-content","ch18-03-oo-design-patterns.html#trade-offs-of-the-state-pattern","ch18-03-oo-design-patterns.html#summary","ch19-00-patterns.html#patterns-and-matching","ch19-01-all-the-places-for-patterns.html#all-the-places-patterns-can-be-used","ch19-01-all-the-places-for-patterns.html#match-arms","ch19-01-all-the-places-for-patterns.html#conditional-if-let-expressions","ch19-01-all-the-places-for-patterns.html#while-let-conditional-loops","ch19-01-all-the-places-for-patterns.html#for-loops","ch19-01-all-the-places-for-patterns.html#let-statements","ch19-01-all-the-places-for-patterns.html#function-parameters","ch19-02-refutability.html#refutability-whether-a-pattern-might-fail-to-match","ch19-03-pattern-syntax.html#pattern-syntax","ch19-03-pattern-syntax.html#matching-literals","ch19-03-pattern-syntax.html#matching-named-variables","ch19-03-pattern-syntax.html#multiple-patterns","ch19-03-pattern-syntax.html#matching-ranges-of-values-with-","ch19-03-pattern-syntax.html#destructuring-to-break-apart-values","ch19-03-pattern-syntax.html#ignoring-values-in-a-pattern","ch19-03-pattern-syntax.html#extra-conditionals-with-match-guards","ch19-03-pattern-syntax.html#-bindings","ch19-03-pattern-syntax.html#summary","ch20-00-advanced-features.html#advanced-features","ch20-01-unsafe-rust.html#unsafe-rust","ch20-01-unsafe-rust.html#unsafe-superpowers","ch20-01-unsafe-rust.html#dereferencing-a-raw-pointer","ch20-01-unsafe-rust.html#calling-an-unsafe-function-or-method","ch20-01-unsafe-rust.html#accessing-or-modifying-a-mutable-static-variable","ch20-01-unsafe-rust.html#implementing-an-unsafe-trait","ch20-01-unsafe-rust.html#accessing-fields-of-a-union","ch20-01-unsafe-rust.html#when-to-use-unsafe-code","ch20-03-advanced-traits.html#advanced-traits","ch20-03-advanced-traits.html#specifying-placeholder-types-in-trait-definitions-with-associated-types","ch20-03-advanced-traits.html#default-generic-type-parameters-and-operator-overloading","ch20-03-advanced-traits.html#fully-qualified-syntax-for-disambiguation-calling-methods-with-the-same-name","ch20-03-advanced-traits.html#using-supertraits-to-require-one-traits-functionality-within-another-trait","ch20-03-advanced-traits.html#using-the-newtype-pattern-to-implement-external-traits-on-external-types","ch20-04-advanced-types.html#advanced-types","ch20-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction","ch20-04-advanced-types.html#creating-type-synonyms-with-type-aliases","ch20-04-advanced-types.html#the-never-type-that-never-returns","ch20-04-advanced-types.html#dynamically-sized-types-and-the-sized-trait","ch20-05-advanced-functions-and-closures.html#advanced-functions-and-closures","ch20-05-advanced-functions-and-closures.html#function-pointers","ch20-05-advanced-functions-and-closures.html#returning-closures","ch20-06-macros.html#macros","ch20-06-macros.html#the-difference-between-macros-and-functions","ch20-06-macros.html#declarative-macros-with-macro_rules-for-general-metaprogramming","ch20-06-macros.html#procedural-macros-for-generating-code-from-attributes","ch20-06-macros.html#how-to-write-a-custom-derive-macro","ch20-06-macros.html#attribute-like-macros","ch20-06-macros.html#function-like-macros","ch20-06-macros.html#summary","ch21-00-final-project-a-web-server.html#final-project-building-a-multithreaded-web-server","ch21-01-single-threaded.html#building-a-single-threaded-web-server","ch21-01-single-threaded.html#listening-to-the-tcp-connection","ch21-01-single-threaded.html#reading-the-request","ch21-01-single-threaded.html#a-closer-look-at-an-http-request","ch21-01-single-threaded.html#writing-a-response","ch21-01-single-threaded.html#returning-real-html","ch21-01-single-threaded.html#validating-the-request-and-selectively-responding","ch21-01-single-threaded.html#a-touch-of-refactoring","ch21-02-multithreaded.html#turning-our-single-threaded-server-into-a-multithreaded-server","ch21-02-multithreaded.html#simulating-a-slow-request-in-the-current-server-implementation","ch21-02-multithreaded.html#improving-throughput-with-a-thread-pool","ch21-03-graceful-shutdown-and-cleanup.html#graceful-shutdown-and-cleanup","ch21-03-graceful-shutdown-and-cleanup.html#implementing-the-drop-trait-on-threadpool","ch21-03-graceful-shutdown-and-cleanup.html#signaling-to-the-threads-to-stop-listening-for-jobs","ch21-03-graceful-shutdown-and-cleanup.html#summary","appendix-00.html#appendix","appendix-01-keywords.html#appendix-a-keywords","appendix-01-keywords.html#keywords-currently-in-use","appendix-01-keywords.html#keywords-reserved-for-future-use","appendix-01-keywords.html#raw-identifiers","appendix-02-operators.html#appendix-b-operators-and-symbols","appendix-02-operators.html#operators","appendix-02-operators.html#non-operator-symbols","appendix-03-derivable-traits.html#appendix-c-derivable-traits","appendix-03-derivable-traits.html#debug-for-programmer-output","appendix-03-derivable-traits.html#partialeq-and-eq-for-equality-comparisons","appendix-03-derivable-traits.html#partialord-and-ord-for-ordering-comparisons","appendix-03-derivable-traits.html#clone-and-copy-for-duplicating-values","appendix-03-derivable-traits.html#hash-for-mapping-a-value-to-a-value-of-fixed-size","appendix-03-derivable-traits.html#default-for-default-values","appendix-04-useful-development-tools.html#appendix-d---useful-development-tools","appendix-04-useful-development-tools.html#automatic-formatting-with-rustfmt","appendix-04-useful-development-tools.html#fix-your-code-with-rustfix","appendix-04-useful-development-tools.html#more-lints-with-clippy","appendix-04-useful-development-tools.html#ide-integration-using-rust-analyzer","appendix-05-editions.html#appendix-e---editions","appendix-06-translation.html#appendix-f-translations-of-the-book","appendix-07-nightly-rust.html#appendix-g---how-rust-is-made-and-nightly-rust","appendix-07-nightly-rust.html#stability-without-stagnation","appendix-07-nightly-rust.html#choo-choo-release-channels-and-riding-the-trains","appendix-07-nightly-rust.html#maintenance-time","appendix-07-nightly-rust.html#unstable-features","appendix-07-nightly-rust.html#rustup-and-the-role-of-rust-nightly","appendix-07-nightly-rust.html#the-rfc-process-and-teams"],"index":{"documentStore":{"docInfo":{"0":{"body":72,"breadcrumbs":6,"title":3},"1":{"body":226,"breadcrumbs":2,"title":1},"10":{"body":503,"breadcrumbs":3,"title":2},"100":{"body":675,"breadcrumbs":7,"title":2},"101":{"body":647,"breadcrumbs":11,"title":6},"102":{"body":337,"breadcrumbs":11,"title":4},"103":{"body":203,"breadcrumbs":10,"title":3},"104":{"body":265,"breadcrumbs":9,"title":2},"105":{"body":162,"breadcrumbs":9,"title":2},"106":{"body":313,"breadcrumbs":11,"title":4},"107":{"body":286,"breadcrumbs":9,"title":3},"108":{"body":82,"breadcrumbs":7,"title":1},"109":{"body":252,"breadcrumbs":12,"title":6},"11":{"body":6,"breadcrumbs":3,"title":2},"110":{"body":349,"breadcrumbs":10,"title":2},"111":{"body":29,"breadcrumbs":16,"title":5},"112":{"body":281,"breadcrumbs":14,"title":3},"113":{"body":346,"breadcrumbs":15,"title":4},"114":{"body":539,"breadcrumbs":16,"title":5},"115":{"body":502,"breadcrumbs":15,"title":4},"116":{"body":141,"breadcrumbs":15,"title":4},"117":{"body":315,"breadcrumbs":15,"title":4},"118":{"body":265,"breadcrumbs":16,"title":5},"119":{"body":249,"breadcrumbs":15,"title":4},"12":{"body":30,"breadcrumbs":4,"title":2},"120":{"body":88,"breadcrumbs":15,"title":4},"121":{"body":180,"breadcrumbs":16,"title":5},"122":{"body":161,"breadcrumbs":14,"title":3},"123":{"body":273,"breadcrumbs":19,"title":8},"124":{"body":68,"breadcrumbs":13,"title":2},"125":{"body":284,"breadcrumbs":14,"title":4},"126":{"body":148,"breadcrumbs":13,"title":3},"127":{"body":54,"breadcrumbs":11,"title":1},"128":{"body":123,"breadcrumbs":4,"title":2},"129":{"body":38,"breadcrumbs":10,"title":4},"13":{"body":77,"breadcrumbs":4,"title":1},"130":{"body":171,"breadcrumbs":9,"title":3},"131":{"body":54,"breadcrumbs":8,"title":2},"132":{"body":453,"breadcrumbs":9,"title":3},"133":{"body":150,"breadcrumbs":10,"title":4},"134":{"body":195,"breadcrumbs":11,"title":5},"135":{"body":58,"breadcrumbs":10,"title":4},"136":{"body":88,"breadcrumbs":14,"title":6},"137":{"body":90,"breadcrumbs":9,"title":1},"138":{"body":215,"breadcrumbs":11,"title":3},"139":{"body":476,"breadcrumbs":10,"title":2},"14":{"body":38,"breadcrumbs":6,"title":3},"140":{"body":501,"breadcrumbs":10,"title":2},"141":{"body":120,"breadcrumbs":10,"title":2},"142":{"body":88,"breadcrumbs":12,"title":4},"143":{"body":93,"breadcrumbs":10,"title":2},"144":{"body":105,"breadcrumbs":14,"title":6},"145":{"body":109,"breadcrumbs":12,"title":4},"146":{"body":108,"breadcrumbs":12,"title":4},"147":{"body":97,"breadcrumbs":11,"title":3},"148":{"body":469,"breadcrumbs":11,"title":3},"149":{"body":71,"breadcrumbs":10,"title":2},"15":{"body":94,"breadcrumbs":7,"title":4},"150":{"body":131,"breadcrumbs":9,"title":1},"151":{"body":130,"breadcrumbs":4,"title":2},"152":{"body":60,"breadcrumbs":8,"title":3},"153":{"body":626,"breadcrumbs":10,"title":5},"154":{"body":392,"breadcrumbs":8,"title":3},"155":{"body":497,"breadcrumbs":8,"title":3},"156":{"body":1417,"breadcrumbs":7,"title":2},"157":{"body":100,"breadcrumbs":6,"title":2},"158":{"body":81,"breadcrumbs":8,"title":4},"159":{"body":159,"breadcrumbs":8,"title":4},"16":{"body":43,"breadcrumbs":6,"title":3},"160":{"body":335,"breadcrumbs":7,"title":3},"161":{"body":467,"breadcrumbs":8,"title":4},"162":{"body":81,"breadcrumbs":5,"title":1},"163":{"body":153,"breadcrumbs":8,"title":4},"164":{"body":459,"breadcrumbs":8,"title":4},"165":{"body":30,"breadcrumbs":10,"title":3},"166":{"body":454,"breadcrumbs":9,"title":2},"167":{"body":322,"breadcrumbs":9,"title":2},"168":{"body":159,"breadcrumbs":9,"title":2},"169":{"body":422,"breadcrumbs":9,"title":2},"17":{"body":77,"breadcrumbs":4,"title":1},"170":{"body":180,"breadcrumbs":11,"title":4},"171":{"body":32,"breadcrumbs":12,"title":4},"172":{"body":194,"breadcrumbs":10,"title":2},"173":{"body":341,"breadcrumbs":11,"title":3},"174":{"body":399,"breadcrumbs":10,"title":2},"175":{"body":430,"breadcrumbs":10,"title":2},"176":{"body":302,"breadcrumbs":12,"title":4},"177":{"body":264,"breadcrumbs":14,"title":6},"178":{"body":92,"breadcrumbs":10,"title":3},"179":{"body":242,"breadcrumbs":11,"title":4},"18":{"body":28,"breadcrumbs":5,"title":2},"180":{"body":151,"breadcrumbs":9,"title":2},"181":{"body":353,"breadcrumbs":10,"title":3},"182":{"body":120,"breadcrumbs":10,"title":3},"183":{"body":620,"breadcrumbs":11,"title":4},"184":{"body":267,"breadcrumbs":10,"title":3},"185":{"body":129,"breadcrumbs":11,"title":4},"186":{"body":562,"breadcrumbs":9,"title":2},"187":{"body":209,"breadcrumbs":11,"title":4},"188":{"body":82,"breadcrumbs":9,"title":2},"189":{"body":101,"breadcrumbs":14,"title":7},"19":{"body":32,"breadcrumbs":5,"title":2},"190":{"body":102,"breadcrumbs":8,"title":1},"191":{"body":175,"breadcrumbs":6,"title":3},"192":{"body":46,"breadcrumbs":7,"title":2},"193":{"body":869,"breadcrumbs":8,"title":3},"194":{"body":643,"breadcrumbs":9,"title":4},"195":{"body":490,"breadcrumbs":10,"title":5},"196":{"body":355,"breadcrumbs":9,"title":4},"197":{"body":667,"breadcrumbs":8,"title":3},"198":{"body":123,"breadcrumbs":9,"title":4},"199":{"body":92,"breadcrumbs":9,"title":3},"2":{"body":66,"breadcrumbs":2,"title":1},"20":{"body":80,"breadcrumbs":6,"title":2},"200":{"body":158,"breadcrumbs":10,"title":4},"201":{"body":318,"breadcrumbs":9,"title":3},"202":{"body":347,"breadcrumbs":10,"title":4},"203":{"body":236,"breadcrumbs":11,"title":5},"204":{"body":69,"breadcrumbs":7,"title":2},"205":{"body":299,"breadcrumbs":7,"title":2},"206":{"body":888,"breadcrumbs":7,"title":2},"207":{"body":76,"breadcrumbs":6,"title":1},"208":{"body":218,"breadcrumbs":12,"title":6},"209":{"body":87,"breadcrumbs":14,"title":4},"21":{"body":63,"breadcrumbs":7,"title":3},"210":{"body":142,"breadcrumbs":13,"title":3},"211":{"body":191,"breadcrumbs":14,"title":4},"212":{"body":163,"breadcrumbs":14,"title":4},"213":{"body":278,"breadcrumbs":10,"title":2},"214":{"body":197,"breadcrumbs":16,"title":5},"215":{"body":525,"breadcrumbs":15,"title":4},"216":{"body":289,"breadcrumbs":15,"title":4},"217":{"body":793,"breadcrumbs":14,"title":3},"218":{"body":660,"breadcrumbs":14,"title":3},"219":{"body":263,"breadcrumbs":15,"title":4},"22":{"body":113,"breadcrumbs":8,"title":4},"220":{"body":126,"breadcrumbs":18,"title":6},"221":{"body":569,"breadcrumbs":15,"title":3},"222":{"body":855,"breadcrumbs":16,"title":4},"223":{"body":42,"breadcrumbs":12,"title":3},"224":{"body":269,"breadcrumbs":16,"title":7},"225":{"body":1185,"breadcrumbs":12,"title":3},"226":{"body":47,"breadcrumbs":22,"title":8},"227":{"body":146,"breadcrumbs":17,"title":3},"228":{"body":153,"breadcrumbs":18,"title":4},"229":{"body":59,"breadcrumbs":15,"title":1},"23":{"body":190,"breadcrumbs":7,"title":3},"230":{"body":102,"breadcrumbs":10,"title":5},"231":{"body":36,"breadcrumbs":15,"title":5},"232":{"body":387,"breadcrumbs":13,"title":3},"233":{"body":479,"breadcrumbs":14,"title":4},"234":{"body":483,"breadcrumbs":14,"title":4},"235":{"body":766,"breadcrumbs":17,"title":7},"236":{"body":211,"breadcrumbs":13,"title":4},"237":{"body":216,"breadcrumbs":13,"title":4},"238":{"body":117,"breadcrumbs":12,"title":3},"239":{"body":273,"breadcrumbs":12,"title":3},"24":{"body":204,"breadcrumbs":8,"title":4},"240":{"body":203,"breadcrumbs":13,"title":4},"241":{"body":25,"breadcrumbs":11,"title":3},"242":{"body":870,"breadcrumbs":12,"title":4},"243":{"body":364,"breadcrumbs":13,"title":5},"244":{"body":81,"breadcrumbs":12,"title":4},"245":{"body":377,"breadcrumbs":15,"title":5},"246":{"body":50,"breadcrumbs":11,"title":1},"247":{"body":51,"breadcrumbs":6,"title":3},"248":{"body":266,"breadcrumbs":11,"title":4},"249":{"body":40,"breadcrumbs":9,"title":3},"25":{"body":118,"breadcrumbs":6,"title":2},"250":{"body":538,"breadcrumbs":10,"title":4},"251":{"body":615,"breadcrumbs":12,"title":6},"252":{"body":69,"breadcrumbs":10,"title":4},"253":{"body":293,"breadcrumbs":10,"title":4},"254":{"body":107,"breadcrumbs":8,"title":2},"255":{"body":35,"breadcrumbs":11,"title":5},"256":{"body":124,"breadcrumbs":11,"title":5},"257":{"body":35,"breadcrumbs":7,"title":2},"258":{"body":196,"breadcrumbs":7,"title":2},"259":{"body":788,"breadcrumbs":9,"title":4},"26":{"body":316,"breadcrumbs":7,"title":3},"260":{"body":171,"breadcrumbs":12,"title":4},"261":{"body":41,"breadcrumbs":11,"title":4},"262":{"body":36,"breadcrumbs":8,"title":1},"263":{"body":286,"breadcrumbs":4,"title":2},"264":{"body":149,"breadcrumbs":12,"title":5},"265":{"body":119,"breadcrumbs":12,"title":5},"266":{"body":979,"breadcrumbs":11,"title":4},"267":{"body":103,"breadcrumbs":16,"title":7},"268":{"body":170,"breadcrumbs":12,"title":3},"269":{"body":90,"breadcrumbs":12,"title":3},"27":{"body":334,"breadcrumbs":8,"title":4},"270":{"body":216,"breadcrumbs":12,"title":3},"271":{"body":281,"breadcrumbs":15,"title":6},"272":{"body":374,"breadcrumbs":14,"title":5},"273":{"body":135,"breadcrumbs":13,"title":4},"274":{"body":341,"breadcrumbs":12,"title":5},"275":{"body":454,"breadcrumbs":11,"title":4},"276":{"body":159,"breadcrumbs":12,"title":5},"277":{"body":416,"breadcrumbs":11,"title":4},"278":{"body":277,"breadcrumbs":12,"title":5},"279":{"body":87,"breadcrumbs":10,"title":4},"28":{"body":62,"breadcrumbs":6,"title":2},"280":{"body":265,"breadcrumbs":11,"title":5},"281":{"body":1477,"breadcrumbs":12,"title":6},"282":{"body":294,"breadcrumbs":14,"title":8},"283":{"body":59,"breadcrumbs":10,"title":4},"284":{"body":585,"breadcrumbs":9,"title":3},"285":{"body":926,"breadcrumbs":12,"title":6},"286":{"body":100,"breadcrumbs":7,"title":1},"287":{"body":279,"breadcrumbs":4,"title":2},"288":{"body":169,"breadcrumbs":12,"title":5},"289":{"body":201,"breadcrumbs":11,"title":4},"29":{"body":73,"breadcrumbs":6,"title":2},"290":{"body":336,"breadcrumbs":13,"title":6},"291":{"body":582,"breadcrumbs":11,"title":4},"292":{"body":590,"breadcrumbs":16,"title":7},"293":{"body":237,"breadcrumbs":12,"title":3},"294":{"body":154,"breadcrumbs":15,"title":6},"295":{"body":158,"breadcrumbs":14,"title":5},"296":{"body":104,"breadcrumbs":8,"title":3},"297":{"body":1064,"breadcrumbs":13,"title":8},"298":{"body":119,"breadcrumbs":9,"title":4},"299":{"body":40,"breadcrumbs":12,"title":5},"3":{"body":11,"breadcrumbs":2,"title":1},"30":{"body":70,"breadcrumbs":5,"title":1},"300":{"body":96,"breadcrumbs":13,"title":6},"301":{"body":78,"breadcrumbs":12,"title":5},"302":{"body":65,"breadcrumbs":12,"title":5},"303":{"body":131,"breadcrumbs":8,"title":1},"304":{"body":52,"breadcrumbs":4,"title":2},"305":{"body":553,"breadcrumbs":3,"title":1},"306":{"body":262,"breadcrumbs":4,"title":2},"307":{"body":120,"breadcrumbs":8,"title":3},"308":{"body":411,"breadcrumbs":7,"title":2},"309":{"body":225,"breadcrumbs":8,"title":3},"31":{"body":74,"breadcrumbs":6,"title":3},"310":{"body":549,"breadcrumbs":6,"title":1},"311":{"body":51,"breadcrumbs":6,"title":2},"312":{"body":651,"breadcrumbs":5,"title":1},"313":{"body":1322,"breadcrumbs":6,"title":2},"314":{"body":1226,"breadcrumbs":8,"title":3},"315":{"body":1145,"breadcrumbs":9,"title":4},"316":{"body":269,"breadcrumbs":10,"title":4},"317":{"body":784,"breadcrumbs":7,"title":1},"318":{"body":510,"breadcrumbs":9,"title":3},"319":{"body":274,"breadcrumbs":4,"title":1},"32":{"body":130,"breadcrumbs":7,"title":4},"320":{"body":565,"breadcrumbs":5,"title":2},"321":{"body":778,"breadcrumbs":5,"title":2},"322":{"body":943,"breadcrumbs":5,"title":2},"323":{"body":533,"breadcrumbs":8,"title":3},"324":{"body":77,"breadcrumbs":10,"title":5},"325":{"body":43,"breadcrumbs":13,"title":4},"326":{"body":81,"breadcrumbs":13,"title":4},"327":{"body":351,"breadcrumbs":13,"title":4},"328":{"body":156,"breadcrumbs":14,"title":5},"329":{"body":118,"breadcrumbs":10,"title":1},"33":{"body":226,"breadcrumbs":5,"title":2},"330":{"body":212,"breadcrumbs":19,"title":7},"331":{"body":423,"breadcrumbs":16,"title":4},"332":{"body":533,"breadcrumbs":14,"title":2},"333":{"body":133,"breadcrumbs":17,"title":5},"334":{"body":368,"breadcrumbs":15,"title":5},"335":{"body":169,"breadcrumbs":17,"title":7},"336":{"body":131,"breadcrumbs":14,"title":4},"337":{"body":129,"breadcrumbs":15,"title":5},"338":{"body":314,"breadcrumbs":15,"title":5},"339":{"body":720,"breadcrumbs":15,"title":5},"34":{"body":210,"breadcrumbs":6,"title":3},"340":{"body":966,"breadcrumbs":14,"title":4},"341":{"body":77,"breadcrumbs":11,"title":1},"342":{"body":133,"breadcrumbs":4,"title":2},"343":{"body":16,"breadcrumbs":8,"title":3},"344":{"body":129,"breadcrumbs":7,"title":2},"345":{"body":240,"breadcrumbs":7,"title":2},"346":{"body":82,"breadcrumbs":7,"title":2},"347":{"body":101,"breadcrumbs":6,"title":1},"348":{"body":292,"breadcrumbs":6,"title":1},"349":{"body":135,"breadcrumbs":7,"title":2},"35":{"body":177,"breadcrumbs":6,"title":3},"350":{"body":439,"breadcrumbs":12,"title":5},"351":{"body":10,"breadcrumbs":6,"title":2},"352":{"body":42,"breadcrumbs":6,"title":2},"353":{"body":256,"breadcrumbs":7,"title":3},"354":{"body":47,"breadcrumbs":6,"title":2},"355":{"body":119,"breadcrumbs":7,"title":3},"356":{"body":783,"breadcrumbs":8,"title":4},"357":{"body":821,"breadcrumbs":7,"title":3},"358":{"body":445,"breadcrumbs":8,"title":4},"359":{"body":188,"breadcrumbs":5,"title":1},"36":{"body":282,"breadcrumbs":7,"title":4},"360":{"body":56,"breadcrumbs":5,"title":1},"361":{"body":111,"breadcrumbs":4,"title":2},"362":{"body":138,"breadcrumbs":6,"title":2},"363":{"body":206,"breadcrumbs":6,"title":2},"364":{"body":408,"breadcrumbs":7,"title":3},"365":{"body":1034,"breadcrumbs":8,"title":4},"366":{"body":241,"breadcrumbs":9,"title":5},"367":{"body":124,"breadcrumbs":7,"title":3},"368":{"body":44,"breadcrumbs":7,"title":3},"369":{"body":38,"breadcrumbs":7,"title":3},"37":{"body":109,"breadcrumbs":7,"title":4},"370":{"body":21,"breadcrumbs":6,"title":2},"371":{"body":339,"breadcrumbs":11,"title":7},"372":{"body":427,"breadcrumbs":10,"title":6},"373":{"body":847,"breadcrumbs":12,"title":8},"374":{"body":432,"breadcrumbs":13,"title":9},"375":{"body":251,"breadcrumbs":12,"title":8},"376":{"body":34,"breadcrumbs":6,"title":2},"377":{"body":141,"breadcrumbs":10,"title":6},"378":{"body":451,"breadcrumbs":9,"title":5},"379":{"body":338,"breadcrumbs":8,"title":4},"38":{"body":42,"breadcrumbs":6,"title":3},"380":{"body":377,"breadcrumbs":9,"title":5},"381":{"body":12,"breadcrumbs":8,"title":3},"382":{"body":382,"breadcrumbs":7,"title":2},"383":{"body":181,"breadcrumbs":7,"title":2},"384":{"body":63,"breadcrumbs":4,"title":1},"385":{"body":142,"breadcrumbs":7,"title":4},"386":{"body":464,"breadcrumbs":8,"title":5},"387":{"body":151,"breadcrumbs":8,"title":5},"388":{"body":1035,"breadcrumbs":7,"title":4},"389":{"body":103,"breadcrumbs":5,"title":2},"39":{"body":41,"breadcrumbs":6,"title":3},"390":{"body":96,"breadcrumbs":5,"title":2},"391":{"body":46,"breadcrumbs":4,"title":1},"392":{"body":144,"breadcrumbs":12,"title":6},"393":{"body":108,"breadcrumbs":16,"title":5},"394":{"body":468,"breadcrumbs":14,"title":3},"395":{"body":365,"breadcrumbs":13,"title":2},"396":{"body":173,"breadcrumbs":15,"title":4},"397":{"body":221,"breadcrumbs":13,"title":2},"398":{"body":234,"breadcrumbs":14,"title":3},"399":{"body":369,"breadcrumbs":15,"title":4},"4":{"body":109,"breadcrumbs":3,"title":2},"40":{"body":630,"breadcrumbs":7,"title":4},"400":{"body":214,"breadcrumbs":13,"title":2},"401":{"body":53,"breadcrumbs":18,"title":6},"402":{"body":215,"breadcrumbs":18,"title":6},"403":{"body":3553,"breadcrumbs":16,"title":4},"404":{"body":86,"breadcrumbs":12,"title":3},"405":{"body":815,"breadcrumbs":13,"title":4},"406":{"body":965,"breadcrumbs":14,"title":5},"407":{"body":31,"breadcrumbs":10,"title":1},"408":{"body":9,"breadcrumbs":2,"title":1},"409":{"body":38,"breadcrumbs":4,"title":2},"41":{"body":277,"breadcrumbs":6,"title":3},"410":{"body":213,"breadcrumbs":5,"title":3},"411":{"body":20,"breadcrumbs":6,"title":4},"412":{"body":173,"breadcrumbs":4,"title":2},"413":{"body":20,"breadcrumbs":8,"title":4},"414":{"body":314,"breadcrumbs":5,"title":1},"415":{"body":537,"breadcrumbs":7,"title":3},"416":{"body":168,"breadcrumbs":8,"title":4},"417":{"body":50,"breadcrumbs":7,"title":3},"418":{"body":103,"breadcrumbs":8,"title":4},"419":{"body":159,"breadcrumbs":8,"title":4},"42":{"body":841,"breadcrumbs":7,"title":4},"420":{"body":172,"breadcrumbs":8,"title":4},"421":{"body":49,"breadcrumbs":10,"title":6},"422":{"body":80,"breadcrumbs":7,"title":3},"423":{"body":20,"breadcrumbs":10,"title":5},"424":{"body":67,"breadcrumbs":8,"title":3},"425":{"body":149,"breadcrumbs":8,"title":3},"426":{"body":131,"breadcrumbs":8,"title":3},"427":{"body":59,"breadcrumbs":10,"title":5},"428":{"body":298,"breadcrumbs":6,"title":3},"429":{"body":28,"breadcrumbs":8,"title":4},"43":{"body":215,"breadcrumbs":7,"title":4},"430":{"body":6,"breadcrumbs":12,"title":6},"431":{"body":57,"breadcrumbs":9,"title":3},"432":{"body":326,"breadcrumbs":12,"title":6},"433":{"body":22,"breadcrumbs":8,"title":2},"434":{"body":110,"breadcrumbs":8,"title":2},"435":{"body":122,"breadcrumbs":10,"title":4},"436":{"body":132,"breadcrumbs":9,"title":3},"44":{"body":83,"breadcrumbs":6,"title":3},"45":{"body":370,"breadcrumbs":6,"title":3},"46":{"body":56,"breadcrumbs":4,"title":1},"47":{"body":87,"breadcrumbs":6,"title":3},"48":{"body":364,"breadcrumbs":7,"title":2},"49":{"body":206,"breadcrumbs":6,"title":1},"5":{"body":41,"breadcrumbs":2,"title":1},"50":{"body":312,"breadcrumbs":6,"title":1},"51":{"body":146,"breadcrumbs":7,"title":2},"52":{"body":769,"breadcrumbs":7,"title":2},"53":{"body":668,"breadcrumbs":7,"title":2},"54":{"body":164,"breadcrumbs":5,"title":1},"55":{"body":228,"breadcrumbs":5,"title":1},"56":{"body":325,"breadcrumbs":6,"title":2},"57":{"body":303,"breadcrumbs":7,"title":3},"58":{"body":121,"breadcrumbs":5,"title":1},"59":{"body":26,"breadcrumbs":7,"title":2},"6":{"body":38,"breadcrumbs":2,"title":1},"60":{"body":648,"breadcrumbs":6,"title":1},"61":{"body":848,"breadcrumbs":7,"title":2},"62":{"body":55,"breadcrumbs":6,"title":1},"63":{"body":38,"breadcrumbs":4,"title":2},"64":{"body":106,"breadcrumbs":4,"title":1},"65":{"body":349,"breadcrumbs":5,"title":2},"66":{"body":26,"breadcrumbs":5,"title":2},"67":{"body":142,"breadcrumbs":5,"title":2},"68":{"body":202,"breadcrumbs":5,"title":2},"69":{"body":1074,"breadcrumbs":5,"title":2},"7":{"body":16,"breadcrumbs":4,"title":3},"70":{"body":137,"breadcrumbs":5,"title":2},"71":{"body":224,"breadcrumbs":6,"title":3},"72":{"body":357,"breadcrumbs":6,"title":2},"73":{"body":531,"breadcrumbs":6,"title":2},"74":{"body":278,"breadcrumbs":6,"title":2},"75":{"body":23,"breadcrumbs":6,"title":2},"76":{"body":458,"breadcrumbs":6,"title":2},"77":{"body":729,"breadcrumbs":6,"title":2},"78":{"body":63,"breadcrumbs":5,"title":1},"79":{"body":64,"breadcrumbs":5,"title":1},"8":{"body":94,"breadcrumbs":5,"title":4},"80":{"body":81,"breadcrumbs":10,"title":5},"81":{"body":384,"breadcrumbs":11,"title":3},"82":{"body":106,"breadcrumbs":12,"title":4},"83":{"body":258,"breadcrumbs":14,"title":6},"84":{"body":138,"breadcrumbs":17,"title":9},"85":{"body":108,"breadcrumbs":12,"title":4},"86":{"body":191,"breadcrumbs":11,"title":3},"87":{"body":190,"breadcrumbs":13,"title":4},"88":{"body":108,"breadcrumbs":11,"title":2},"89":{"body":166,"breadcrumbs":14,"title":5},"9":{"body":42,"breadcrumbs":2,"title":1},"90":{"body":633,"breadcrumbs":14,"title":5},"91":{"body":43,"breadcrumbs":9,"title":2},"92":{"body":405,"breadcrumbs":9,"title":2},"93":{"body":145,"breadcrumbs":9,"title":2},"94":{"body":273,"breadcrumbs":10,"title":3},"95":{"body":145,"breadcrumbs":9,"title":2},"96":{"body":108,"breadcrumbs":10,"title":3},"97":{"body":49,"breadcrumbs":8,"title":1},"98":{"body":62,"breadcrumbs":6,"title":3},"99":{"body":154,"breadcrumbs":7,"title":2}},"docs":{"0":{"body":"by Steve Klabnik and Carol Nichols, with contributions from the Rust Community This version of the text assumes you’re using Rust 1.78.0 (released 2024-05-02) or later. See the “Installation” section of Chapter 1 to install or update Rust. The HTML format is available online at https://doc.rust-lang.org/stable/book/ and offline with installations of Rust made with rustup; run rustup doc --book to open. Several community translations are also available. This text is available in paperback and ebook format from No Starch Press . 🚨 Want a more interactive learning experience? Try out a different version of the Rust Book, featuring: quizzes, highlighting, visualizations, and more : https://rust-book.cs.brown.edu","breadcrumbs":"The Rust Programming Language » The Rust Programming Language","id":"0","title":"The Rust Programming Language"},"1":{"body":"It wasn’t always so clear, but the Rust programming language is fundamentally about empowerment : no matter what kind of code you are writing now, Rust empowers you to reach farther, to program with confidence in a wider variety of domains than you did before. Take, for example, “systems-level” work that deals with low-level details of memory management, data representation, and concurrency. Traditionally, this realm of programming is seen as arcane, accessible only to a select few who have devoted the necessary years learning to avoid its infamous pitfalls. And even those who practice it do so with caution, lest their code be open to exploits, crashes, or corruption. Rust breaks down these barriers by eliminating the old pitfalls and providing a friendly, polished set of tools to help you along the way. Programmers who need to “dip down” into lower-level control can do so with Rust, without taking on the customary risk of crashes or security holes, and without having to learn the fine points of a fickle toolchain. Better yet, the language is designed to guide you naturally towards reliable code that is efficient in terms of speed and memory usage. Programmers who are already working with low-level code can use Rust to raise their ambitions. For example, introducing parallelism in Rust is a relatively low-risk operation: the compiler will catch the classical mistakes for you. And you can tackle more aggressive optimizations in your code with the confidence that you won’t accidentally introduce crashes or vulnerabilities. But Rust isn’t limited to low-level systems programming. It’s expressive and ergonomic enough to make CLI apps, web servers, and many other kinds of code quite pleasant to write — you’ll find simple examples of both later in the book. Working with Rust allows you to build skills that transfer from one domain to another; you can learn Rust by writing a web app, then apply those same skills to target your Raspberry Pi. This book fully embraces the potential of Rust to empower its users. It’s a friendly and approachable text intended to help you level up not just your knowledge of Rust, but also your reach and confidence as a programmer in general. So dive in, get ready to learn—and welcome to the Rust community! — Nicholas Matsakis and Aaron Turon","breadcrumbs":"Foreword » Foreword","id":"1","title":"Foreword"},"10":{"body":"In general, this book assumes that you’re reading it in sequence from front to back. Later chapters build on concepts in earlier chapters, and earlier chapters might not delve into details on a particular topic but will revisit the topic in a later chapter. You’ll find two kinds of chapters in this book: concept chapters and project chapters. In concept chapters, you’ll learn about an aspect of Rust. In project chapters, we’ll build small programs together, applying what you’ve learned so far. Chapters 2, 12, and 20 are project chapters; the rest are concept chapters. Chapter 1 explains how to install Rust, how to write a “Hello, world!” program, and how to use Cargo, Rust’s package manager and build tool. Chapter 2 is a hands-on introduction to writing a program in Rust, having you build up a number guessing game. Here we cover concepts at a high level, and later chapters will provide additional detail. If you want to get your hands dirty right away, Chapter 2 is the place for that. Chapter 3 covers Rust features that are similar to those of other programming languages, and in Chapter 4 you’ll learn about Rust’s ownership system. If you’re a particularly meticulous learner who prefers to learn every detail before moving on to the next, you might want to skip Chapter 2 and go straight to Chapter 3, returning to Chapter 2 when you’d like to work on a project applying the details you’ve learned. Chapter 5 discusses structs and methods, and Chapter 6 covers enums, match expressions, and the if let control flow construct. You’ll use structs and enums to make custom types in Rust. In Chapter 7, you’ll learn about Rust’s module system and about privacy rules for organizing your code and its public Application Programming Interface (API). Chapter 8 discusses some common collection data structures that the standard library provides, such as vectors, strings, and hash maps. Chapter 9 explores Rust’s error-handling philosophy and techniques. Chapter 10 digs into generics, traits, and lifetimes, which give you the power to define code that applies to multiple types. Chapter 11 is all about testing, which even with Rust’s safety guarantees is necessary to ensure your program’s logic is correct. In Chapter 12, we’ll build our own implementation of a subset of functionality from the grep command line tool that searches for text within files. For this, we’ll use many of the concepts we discussed in the previous chapters. Chapter 13 explores closures and iterators: features of Rust that come from functional programming languages. In Chapter 14, we’ll examine Cargo in more depth and talk about best practices for sharing your libraries with others. Chapter 15 discusses smart pointers that the standard library provides and the traits that enable their functionality. In Chapter 16, we’ll walk through different models of concurrent programming and talk about how Rust helps you to program in multiple threads fearlessly. Chapter 17 looks at how Rust idioms compare to object-oriented programming principles you might be familiar with. Chapter 18 is a reference on patterns and pattern matching, which are powerful ways of expressing ideas throughout Rust programs. Chapter 19 contains a smorgasbord of advanced topics of interest, including unsafe Rust, macros, and more about lifetimes, traits, types, functions, and closures. In Chapter 20, we’ll complete a project in which we’ll implement a low-level multithreaded web server! Finally, some appendices contain useful information about the language in a more reference-like format. Appendix A covers Rust’s keywords, Appendix B covers Rust’s operators and symbols, Appendix C covers derivable traits provided by the standard library, Appendix D covers some useful development tools, and Appendix E explains Rust editions. In Appendix F, you can find translations of the book, and in Appendix G we’ll cover how Rust is made and what nightly Rust is. There is no wrong way to read this book: if you want to skip ahead, go for it! You might have to jump back to earlier chapters if you experience any confusion. But do whatever works for you. An important part of the process of learning Rust is learning how to read the error messages the compiler displays: these will guide you toward working code. As such, we’ll provide many examples that don’t compile along with the error message the compiler will show you in each situation. Know that if you enter and run a random example, it may not compile! Make sure you read the surrounding text to see whether the example you’re trying to run is meant to error. Ferris will also help you distinguish code that isn’t meant to work: Ferris Meaning This code does not compile! This code panics! This code does not produce the desired behavior. In most situations, we’ll lead you to the correct version of any code that doesn’t compile.","breadcrumbs":"Introduction » How to Use This Book","id":"10","title":"How to Use This Book"},"100":{"body":"We can create instances of each of the two variants of IpAddrKind like this: # enum IpAddrKind {\n# V4,\n# V6,\n# }\n# # fn main() { let four = IpAddrKind::V4; let six = IpAddrKind::V6;\n# # route(IpAddrKind::V4);\n# route(IpAddrKind::V6);\n# }\n# # fn route(ip_kind: IpAddrKind) {} Note that the variants of the enum are namespaced under its identifier, and we use a double colon to separate the two. This is useful because now both values IpAddrKind::V4 and IpAddrKind::V6 are of the same type: IpAddrKind. We can then, for instance, define a function that takes any IpAddrKind: # enum IpAddrKind {\n# V4,\n# V6,\n# }\n# # fn main() {\n# let four = IpAddrKind::V4;\n# let six = IpAddrKind::V6;\n# # route(IpAddrKind::V4);\n# route(IpAddrKind::V6);\n# }\n# fn route(ip_kind: IpAddrKind) {} And we can call this function with either variant: # enum IpAddrKind {\n# V4,\n# V6,\n# }\n# # fn main() {\n# let four = IpAddrKind::V4;\n# let six = IpAddrKind::V6;\n# route(IpAddrKind::V4); route(IpAddrKind::V6);\n# }\n# # fn route(ip_kind: IpAddrKind) {} Using enums has even more advantages. Thinking more about our IP address type, at the moment we don’t have a way to store the actual IP address data ; we only know what kind it is. Given that you just learned about structs in Chapter 5, you might be tempted to tackle this problem with structs as shown in Listing 6-1. # fn main() { enum IpAddrKind { V4, V6, } struct IpAddr { kind: IpAddrKind, address: String, } let home = IpAddr { kind: IpAddrKind::V4, address: String::from(\"127.0.0.1\"), }; let loopback = IpAddr { kind: IpAddrKind::V6, address: String::from(\"::1\"), };\n# } Listing 6-1: Storing the data and IpAddrKind variant of an IP address using a struct Here, we’ve defined a struct IpAddr that has two fields: a kind field that is of type IpAddrKind (the enum we defined previously) and an address field of type String. We have two instances of this struct. The first is home, and it has the value IpAddrKind::V4 as its kind with associated address data of 127.0.0.1. The second instance is loopback. It has the other variant of IpAddrKind as its kind value, V6, and has address ::1 associated with it. We’ve used a struct to bundle the kind and address values together, so now the variant is associated with the value. However, representing the same concept using just an enum is more concise: rather than an enum inside a struct, we can put data directly into each enum variant. This new definition of the IpAddr enum says that both V4 and V6 variants will have associated String values: # fn main() { enum IpAddr { V4(String), V6(String), } let home = IpAddr::V4(String::from(\"127.0.0.1\")); let loopback = IpAddr::V6(String::from(\"::1\"));\n# } We attach data to each variant of the enum directly, so there is no need for an extra struct. Here, it’s also easier to see another detail of how enums work: the name of each enum variant that we define also becomes a function that constructs an instance of the enum. That is, IpAddr::V4() is a function call that takes a String argument and returns an instance of the IpAddr type. We automatically get this constructor function defined as a result of defining the enum. There’s another advantage to using an enum rather than a struct: each variant can have different types and amounts of associated data. Version four IP addresses will always have four numeric components that will have values between 0 and 255. If we wanted to store V4 addresses as four u8 values but still express V6 addresses as one String value, we wouldn’t be able to with a struct. Enums handle this case with ease: # fn main() { enum IpAddr { V4(u8, u8, u8, u8), V6(String), } let home = IpAddr::V4(127, 0, 0, 1); let loopback = IpAddr::V6(String::from(\"::1\"));\n# } We’ve shown several different ways to define data structures to store version four and version six IP addresses. However, as it turns out, wanting to store IP addresses and encode which kind they are is so common that the standard library has a definition we can use! Let’s look at how the standard library defines IpAddr: it has the exact enum and variants that we’ve defined and used, but it embeds the address data inside the variants in the form of two different structs, which are defined differently for each variant: struct Ipv4Addr { // --snip--\n} struct Ipv6Addr { // --snip--\n} enum IpAddr { V4(Ipv4Addr), V6(Ipv6Addr),\n} This code illustrates that you can put any kind of data inside an enum variant: strings, numeric types, or structs, for example. You can even include another enum! Also, standard library types are often not much more complicated than what you might come up with. Note that even though the standard library contains a definition for IpAddr, we can still create and use our own definition without conflict because we haven’t brought the standard library’s definition into our scope. We’ll talk more about bringing types into scope in Chapter 7. Let’s look at another example of an enum in Listing 6-2: this one has a wide variety of types embedded in its variants. enum Message { Quit, Move { x: i32, y: i32 }, Write(String), ChangeColor(i32, i32, i32),\n}\n# # fn main() {} Listing 6-2: A Message enum whose variants each store different amounts and types of values This enum has four variants with different types: Quit has no data associated with it at all. Move has named fields, like a struct does. Write includes a single String. ChangeColor includes three i32 values. Defining an enum with variants such as the ones in Listing 6-2 is similar to defining different kinds of struct definitions, except the enum doesn’t use the struct keyword and all the variants are grouped together under the Message type. The following structs could hold the same data that the preceding enum variants hold: struct QuitMessage; // unit struct\nstruct MoveMessage { x: i32, y: i32,\n}\nstruct WriteMessage(String); // tuple struct\nstruct ChangeColorMessage(i32, i32, i32); // tuple struct\n# # fn main() {} But if we used the different structs, each of which has its own type, we couldn’t as easily define a function to take any of these kinds of messages as we could with the Message enum defined in Listing 6-2, which is a single type. There is one more similarity between enums and structs: just as we’re able to define methods on structs using impl, we’re also able to define methods on enums. Here’s a method named call that we could define on our Message enum: # fn main() {\n# enum Message {\n# Quit,\n# Move { x: i32, y: i32 },\n# Write(String),\n# ChangeColor(i32, i32, i32),\n# }\n# impl Message { fn call(&self) { // method body would be defined here } } let m = Message::Write(String::from(\"hello\")); m.call();\n# } The body of the method would use self to get the value that we called the method on. In this example, we’ve created a variable m that has the value Message::Write(String::from(\"hello\")), and that is what self will be in the body of the call method when m.call() runs. Let’s look at another enum in the standard library that is very common and useful: Option.","breadcrumbs":"Enums and Pattern Matching » Defining an Enum » Enum Values","id":"100","title":"Enum Values"},"101":{"body":"This section explores a case study of Option, which is another enum defined by the standard library. The Option type encodes the very common scenario in which a value could be something or it could be nothing. For example, if you request the first item in a non-empty list, you would get a value. If you request the first item in an empty list, you would get nothing. Expressing this concept in terms of the type system means the compiler can check whether you’ve handled all the cases you should be handling; this functionality can prevent bugs that are extremely common in other programming languages. Programming language design is often thought of in terms of which features you include, but the features you exclude are important too. Rust doesn’t have the null feature that many other languages have. Null is a value that means there is no value there. In languages with null, variables can always be in one of two states: null or not-null. In his 2009 presentation “Null References: The Billion Dollar Mistake,” Tony Hoare, the inventor of null, has this to say: I call it my billion-dollar mistake. At that time, I was designing the first comprehensive type system for references in an object-oriented language. My goal was to ensure that all use of references should be absolutely safe, with checking performed automatically by the compiler. But I couldn’t resist the temptation to put in a null reference, simply because it was so easy to implement. This has led to innumerable errors, vulnerabilities, and system crashes, which have probably caused a billion dollars of pain and damage in the last forty years. The problem with null values is that if you try to use a null value as a not-null value, you’ll get an error of some kind. Because this null or not-null property is pervasive, it’s extremely easy to make this kind of error. However, the concept that null is trying to express is still a useful one: a null is a value that is currently invalid or absent for some reason. The problem isn’t really with the concept but with the particular implementation. As such, Rust does not have nulls, but it does have an enum that can encode the concept of a value being present or absent. This enum is Option, and it is defined by the standard library as follows: enum Option { None, Some(T),\n} The Option enum is so useful that it’s even included in the prelude; you don’t need to bring it into scope explicitly. Its variants are also included in the prelude: you can use Some and None directly without the Option:: prefix. The Option enum is still just a regular enum, and Some(T) and None are still variants of type Option. The syntax is a feature of Rust we haven’t talked about yet. It’s a generic type parameter, and we’ll cover generics in more detail in Chapter 10. For now, all you need to know is that means that the Some variant of the Option enum can hold one piece of data of any type, and that each concrete type that gets used in place of T makes the overall Option type a different type. Here are some examples of using Option values to hold number types and string types: # fn main() { let some_number = Some(5); let some_char = Some('e'); let absent_number: Option = None;\n# } The type of some_number is Option. The type of some_char is Option, which is a different type. Rust can infer these types because we’ve specified a value inside the Some variant. For absent_number, Rust requires us to annotate the overall Option type: the compiler can’t infer the type that the corresponding Some variant will hold by looking only at a None value. Here, we tell Rust that we mean for absent_number to be of type Option. When we have a Some value, we know that a value is present and the value is held within the Some. When we have a None value, in some sense it means the same thing as null: we don’t have a valid value. So why is having Option any better than having null? In short, because Option and T (where T can be any type) are different types, the compiler won’t let us use an Option value as if it were definitely a valid value. For example, this code won’t compile, because it’s trying to add an i8 to an Option: # fn main() { let x: i8 = 5; let y: Option = Some(5); let sum = x + y;\n# } If we run this code, we get an error message like this one: $ cargo run Compiling enums v0.1.0 (file:///projects/enums)\nerror[E0277]: cannot add `Option` to `i8` --> src/main.rs:5:17 |\n5 | let sum = x + y; | ^ no implementation for `i8 + Option` | = help: the trait `Add>` is not implemented for `i8` = help: the following other types implement trait `Add`: > <&'a i8 as Add> <&i8 as Add<&i8>> For more information about this error, try `rustc --explain E0277`.\nerror: could not compile `enums` (bin \"enums\") due to 1 previous error Intense! In effect, this error message means that Rust doesn’t understand how to add an i8 and an Option, because they’re different types. When we have a value of a type like i8 in Rust, the compiler will ensure that we always have a valid value. We can proceed confidently without having to check for null before using that value. Only when we have an Option (or whatever type of value we’re working with) do we have to worry about possibly not having a value, and the compiler will make sure we handle that case before using the value. In other words, you have to convert an Option to a T before you can perform T operations with it. Generally, this helps catch one of the most common issues with null: assuming that something isn’t null when it actually is. Eliminating the risk of incorrectly assuming a not-null value helps you to be more confident in your code. In order to have a value that can possibly be null, you must explicitly opt in by making the type of that value Option. Then, when you use that value, you are required to explicitly handle the case when the value is null. Everywhere that a value has a type that isn’t an Option, you can safely assume that the value isn’t null. This was a deliberate design decision for Rust to limit null’s pervasiveness and increase the safety of Rust code. So how do you get the T value out of a Some variant when you have a value of type Option so that you can use that value? The Option enum has a large number of methods that are useful in a variety of situations; you can check them out in its documentation . Becoming familiar with the methods on Option will be extremely useful in your journey with Rust. In general, in order to use an Option value, you want to have code that will handle each variant. You want some code that will run only when you have a Some(T) value, and this code is allowed to use the inner T. You want some other code to run only if you have a None value, and that code doesn’t have a T value available. The match expression is a control flow construct that does just this when used with enums: it will run different code depending on which variant of the enum it has, and that code can use the data inside the matching value.","breadcrumbs":"Enums and Pattern Matching » Defining an Enum » The Option Enum and Its Advantages Over Null Values","id":"101","title":"The Option Enum and Its Advantages Over Null Values"},"102":{"body":"Rust has an extremely powerful control flow construct called match that allows you to compare a value against a series of patterns and then execute code based on which pattern matches. Patterns can be made up of literal values, variable names, wildcards, and many other things; Chapter 18 covers all the different kinds of patterns and what they do. The power of match comes from the expressiveness of the patterns and the fact that the compiler confirms that all possible cases are handled. Think of a match expression as being like a coin-sorting machine: coins slide down a track with variously sized holes along it, and each coin falls through the first hole it encounters that it fits into. In the same way, values go through each pattern in a match, and at the first pattern the value “fits,” the value falls into the associated code block to be used during execution. Speaking of coins, let’s use them as an example using match! We can write a function that takes an unknown US coin and, in a similar way as the counting machine, determines which coin it is and returns its value in cents, as shown in Listing 6-3. enum Coin { Penny, Nickel, Dime, Quarter,\n} fn value_in_cents(coin: Coin) -> u8 { match coin { Coin::Penny => 1, Coin::Nickel => 5, Coin::Dime => 10, Coin::Quarter => 25, }\n}\n# # fn main() {} Listing 6-3: An enum and a match expression that has the variants of the enum as its patterns Let’s break down the match in the value_in_cents function. First we list the match keyword followed by an expression, which in this case is the value coin. This seems very similar to a conditional expression used with if, but there’s a big difference: with if, the condition needs to evaluate to a Boolean value, but here it can be any type. The type of coin in this example is the Coin enum that we defined on the first line. Next are the match arms. An arm has two parts: a pattern and some code. The first arm here has a pattern that is the value Coin::Penny and then the => operator that separates the pattern and the code to run. The code in this case is just the value 1. Each arm is separated from the next with a comma. When the match expression executes, it compares the resultant value against the pattern of each arm, in order. If a pattern matches the value, the code associated with that pattern is executed. If that pattern doesn’t match the value, execution continues to the next arm, much as in a coin-sorting machine. We can have as many arms as we need: in Listing 6-3, our match has four arms. The code associated with each arm is an expression, and the resultant value of the expression in the matching arm is the value that gets returned for the entire match expression. We don’t typically use curly brackets if the match arm code is short, as it is in Listing 6-3 where each arm just returns a value. If you want to run multiple lines of code in a match arm, you must use curly brackets, and the comma following the arm is then optional. For example, the following code prints “Lucky penny!” every time the method is called with a Coin::Penny, but still returns the last value of the block, 1: # enum Coin {\n# Penny,\n# Nickel,\n# Dime,\n# Quarter,\n# }\n# fn value_in_cents(coin: Coin) -> u8 { match coin { Coin::Penny => { println!(\"Lucky penny!\"); 1 } Coin::Nickel => 5, Coin::Dime => 10, Coin::Quarter => 25, }\n}\n# # fn main() {}","breadcrumbs":"Enums and Pattern Matching » The match Control Flow Construct » The match Control Flow Construct","id":"102","title":"The match Control Flow Construct"},"103":{"body":"Another useful feature of match arms is that they can bind to the parts of the values that match the pattern. This is how we can extract values out of enum variants. As an example, let’s change one of our enum variants to hold data inside it. From 1999 through 2008, the United States minted quarters with different designs for each of the 50 states on one side. No other coins got state designs, so only quarters have this extra value. We can add this information to our enum by changing the Quarter variant to include a UsState value stored inside it, which we’ve done in Listing 6-4. #[derive(Debug)] // so we can inspect the state in a minute\nenum UsState { Alabama, Alaska, // --snip--\n} enum Coin { Penny, Nickel, Dime, Quarter(UsState),\n}\n# # fn main() {} Listing 6-4: A Coin enum in which the Quarter variant also holds a UsState value Let’s imagine that a friend is trying to collect all 50 state quarters. While we sort our loose change by coin type, we’ll also call out the name of the state associated with each quarter so that if it’s one our friend doesn’t have, they can add it to their collection. In the match expression for this code, we add a variable called state to the pattern that matches values of the variant Coin::Quarter. When a Coin::Quarter matches, the state variable will bind to the value of that quarter’s state. Then we can use state in the code for that arm, like so: # #[derive(Debug)]\n# enum UsState {\n# Alabama,\n# Alaska,\n# // --snip--\n# }\n# # enum Coin {\n# Penny,\n# Nickel,\n# Dime,\n# Quarter(UsState),\n# }\n# fn value_in_cents(coin: Coin) -> u8 { match coin { Coin::Penny => 1, Coin::Nickel => 5, Coin::Dime => 10, Coin::Quarter(state) => { println!(\"State quarter from {state:?}!\"); 25 } }\n}\n# # fn main() {\n# value_in_cents(Coin::Quarter(UsState::Alaska));\n# } If we were to call value_in_cents(Coin::Quarter(UsState::Alaska)), coin would be Coin::Quarter(UsState::Alaska). When we compare that value with each of the match arms, none of them match until we reach Coin::Quarter(state). At that point, the binding for state will be the value UsState::Alaska. We can then use that binding in the println! expression, thus getting the inner state value out of the Coin enum variant for Quarter.","breadcrumbs":"Enums and Pattern Matching » The match Control Flow Construct » Patterns That Bind to Values","id":"103","title":"Patterns That Bind to Values"},"104":{"body":"In the previous section, we wanted to get the inner T value out of the Some case when using Option; we can also handle Option using match, as we did with the Coin enum! Instead of comparing coins, we’ll compare the variants of Option, but the way the match expression works remains the same. Let’s say we want to write a function that takes an Option and, if there’s a value inside, adds 1 to that value. If there isn’t a value inside, the function should return the None value and not attempt to perform any operations. This function is very easy to write, thanks to match, and will look like Listing 6-5. # fn main() { fn plus_one(x: Option) -> Option { match x { None => None, Some(i) => Some(i + 1), } } let five = Some(5); let six = plus_one(five); let none = plus_one(None);\n# } Listing 6-5: A function that uses a match expression on an Option Let’s examine the first execution of plus_one in more detail. When we call plus_one(five), the variable x in the body of plus_one will have the value Some(5). We then compare that against each match arm: # fn main() {\n# fn plus_one(x: Option) -> Option {\n# match x { None => None,\n# Some(i) => Some(i + 1),\n# }\n# }\n# # let five = Some(5);\n# let six = plus_one(five);\n# let none = plus_one(None);\n# } The Some(5) value doesn’t match the pattern None, so we continue to the next arm: # fn main() {\n# fn plus_one(x: Option) -> Option {\n# match x {\n# None => None, Some(i) => Some(i + 1),\n# }\n# }\n# # let five = Some(5);\n# let six = plus_one(five);\n# let none = plus_one(None);\n# } Does Some(5) match Some(i)? It does! We have the same variant. The i binds to the value contained in Some, so i takes the value 5. The code in the match arm is then executed, so we add 1 to the value of i and create a new Some value with our total 6 inside. Now let’s consider the second call of plus_one in Listing 6-5, where x is None. We enter the match and compare to the first arm: # fn main() {\n# fn plus_one(x: Option) -> Option {\n# match x { None => None,\n# Some(i) => Some(i + 1),\n# }\n# }\n# # let five = Some(5);\n# let six = plus_one(five);\n# let none = plus_one(None);\n# } It matches! There’s no value to add to, so the program stops and returns the None value on the right side of =>. Because the first arm matched, no other arms are compared. Combining match and enums is useful in many situations. You’ll see this pattern a lot in Rust code: match against an enum, bind a variable to the data inside, and then execute code based on it. It’s a bit tricky at first, but once you get used to it, you’ll wish you had it in all languages. It’s consistently a user favorite.","breadcrumbs":"Enums and Pattern Matching » The match Control Flow Construct » Matching with Option","id":"104","title":"Matching with Option"},"105":{"body":"There’s one other aspect of match we need to discuss: the arms’ patterns must cover all possibilities. Consider this version of our plus_one function, which has a bug and won’t compile: # fn main() { fn plus_one(x: Option) -> Option { match x { Some(i) => Some(i + 1), } }\n# # let five = Some(5);\n# let six = plus_one(five);\n# let none = plus_one(None);\n# } We didn’t handle the None case, so this code will cause a bug. Luckily, it’s a bug Rust knows how to catch. If we try to compile this code, we’ll get this error: $ cargo run Compiling enums v0.1.0 (file:///projects/enums)\nerror[E0004]: non-exhaustive patterns: `None` not covered --> src/main.rs:3:15 |\n3 | match x { | ^ pattern `None` not covered |\nnote: `Option` defined here --> /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/option.rs:572:1 ::: /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/option.rs:576:5 | = note: not covered = note: the matched value is of type `Option`\nhelp: ensure that all possible cases are being handled by adding a match arm with a wildcard pattern or an explicit pattern as shown |\n4 ~ Some(i) => Some(i + 1),\n5 ~ None => todo!(), | For more information about this error, try `rustc --explain E0004`.\nerror: could not compile `enums` (bin \"enums\") due to 1 previous error Rust knows that we didn’t cover every possible case, and even knows which pattern we forgot! Matches in Rust are exhaustive : we must exhaust every last possibility in order for the code to be valid. Especially in the case of Option, when Rust prevents us from forgetting to explicitly handle the None case, it protects us from assuming that we have a value when we might have null, thus making the billion-dollar mistake discussed earlier impossible.","breadcrumbs":"Enums and Pattern Matching » The match Control Flow Construct » Matches Are Exhaustive","id":"105","title":"Matches Are Exhaustive"},"106":{"body":"Using enums, we can also take special actions for a few particular values, but for all other values take one default action. Imagine we’re implementing a game where, if you roll a 3 on a dice roll, your player doesn’t move, but instead gets a new fancy hat. If you roll a 7, your player loses a fancy hat. For all other values, your player moves that number of spaces on the game board. Here’s a match that implements that logic, with the result of the dice roll hardcoded rather than a random value, and all other logic represented by functions without bodies because actually implementing them is out of scope for this example: # fn main() { let dice_roll = 9; match dice_roll { 3 => add_fancy_hat(), 7 => remove_fancy_hat(), other => move_player(other), } fn add_fancy_hat() {} fn remove_fancy_hat() {} fn move_player(num_spaces: u8) {}\n# } For the first two arms, the patterns are the literal values 3 and 7. For the last arm that covers every other possible value, the pattern is the variable we’ve chosen to name other. The code that runs for the other arm uses the variable by passing it to the move_player function. This code compiles, even though we haven’t listed all the possible values a u8 can have, because the last pattern will match all values not specifically listed. This catch-all pattern meets the requirement that match must be exhaustive. Note that we have to put the catch-all arm last because the patterns are evaluated in order. If we put the catch-all arm earlier, the other arms would never run, so Rust will warn us if we add arms after a catch-all! Rust also has a pattern we can use when we want a catch-all but don’t want to use the value in the catch-all pattern: _ is a special pattern that matches any value and does not bind to that value. This tells Rust we aren’t going to use the value, so Rust won’t warn us about an unused variable. Let’s change the rules of the game: now, if you roll anything other than a 3 or a 7, you must roll again. We no longer need to use the catch-all value, so we can change our code to use _ instead of the variable named other: # fn main() { let dice_roll = 9; match dice_roll { 3 => add_fancy_hat(), 7 => remove_fancy_hat(), _ => reroll(), } fn add_fancy_hat() {} fn remove_fancy_hat() {} fn reroll() {}\n# } This example also meets the exhaustiveness requirement because we’re explicitly ignoring all other values in the last arm; we haven’t forgotten anything. Finally, we’ll change the rules of the game one more time so that nothing else happens on your turn if you roll anything other than a 3 or a 7. We can express that by using the unit value (the empty tuple type we mentioned in “The Tuple Type” section) as the code that goes with the _ arm: # fn main() { let dice_roll = 9; match dice_roll { 3 => add_fancy_hat(), 7 => remove_fancy_hat(), _ => (), } fn add_fancy_hat() {} fn remove_fancy_hat() {}\n# } Here, we’re telling Rust explicitly that we aren’t going to use any other value that doesn’t match a pattern in an earlier arm, and we don’t want to run any code in this case. There’s more about patterns and matching that we’ll cover in Chapter 18 . For now, we’re going to move on to the if let syntax, which can be useful in situations where the match expression is a bit wordy.","breadcrumbs":"Enums and Pattern Matching » The match Control Flow Construct » Catch-all Patterns and the _ Placeholder","id":"106","title":"Catch-all Patterns and the _ Placeholder"},"107":{"body":"The if let syntax lets you combine if and let into a less verbose way to handle values that match one pattern while ignoring the rest. Consider the program in Listing 6-6 that matches on an Option value in the config_max variable but only wants to execute code if the value is the Some variant. # fn main() { let config_max = Some(3u8); match config_max { Some(max) => println!(\"The maximum is configured to be {max}\"), _ => (), }\n# } Listing 6-6: A match that only cares about executing code when the value is Some If the value is Some, we print out the value in the Some variant by binding the value to the variable max in the pattern. We don’t want to do anything with the None value. To satisfy the match expression, we have to add _ => () after processing just one variant, which is annoying boilerplate code to add. Instead, we could write this in a shorter way using if let. The following code behaves the same as the match in Listing 6-6: # fn main() { let config_max = Some(3u8); if let Some(max) = config_max { println!(\"The maximum is configured to be {max}\"); }\n# } The syntax if let takes a pattern and an expression separated by an equal sign. It works the same way as a match, where the expression is given to the match and the pattern is its first arm. In this case, the pattern is Some(max), and the max binds to the value inside the Some. We can then use max in the body of the if let block in the same way we used max in the corresponding match arm. The code in the if let block isn’t run if the value doesn’t match the pattern. Using if let means less typing, less indentation, and less boilerplate code. However, you lose the exhaustive checking that match enforces. Choosing between match and if let depends on what you’re doing in your particular situation and whether gaining conciseness is an appropriate trade-off for losing exhaustive checking. In other words, you can think of if let as syntax sugar for a match that runs code when the value matches one pattern and then ignores all other values. We can include an else with an if let. The block of code that goes with the else is the same as the block of code that would go with the _ case in the match expression that is equivalent to the if let and else. Recall the Coin enum definition in Listing 6-4, where the Quarter variant also held a UsState value. If we wanted to count all non-quarter coins we see while also announcing the state of the quarters, we could do that with a match expression, like this: # #[derive(Debug)]\n# enum UsState {\n# Alabama,\n# Alaska,\n# // --snip--\n# }\n# # enum Coin {\n# Penny,\n# Nickel,\n# Dime,\n# Quarter(UsState),\n# }\n# # fn main() {\n# let coin = Coin::Penny; let mut count = 0; match coin { Coin::Quarter(state) => println!(\"State quarter from {state:?}!\"), _ => count += 1, }\n# } Or we could use an if let and else expression, like this: # #[derive(Debug)]\n# enum UsState {\n# Alabama,\n# Alaska,\n# // --snip--\n# }\n# # enum Coin {\n# Penny,\n# Nickel,\n# Dime,\n# Quarter(UsState),\n# }\n# # fn main() {\n# let coin = Coin::Penny; let mut count = 0; if let Coin::Quarter(state) = coin { println!(\"State quarter from {state:?}!\"); } else { count += 1; }\n# } If you have a situation in which your program has logic that is too verbose to express using a match, remember that if let is in your Rust toolbox as well.","breadcrumbs":"Enums and Pattern Matching » Concise Control Flow with if let » Concise Control Flow with if let","id":"107","title":"Concise Control Flow with if let"},"108":{"body":"We’ve now covered how to use enums to create custom types that can be one of a set of enumerated values. We’ve shown how the standard library’s Option type helps you use the type system to prevent errors. When enum values have data inside them, you can use match or if let to extract and use those values, depending on how many cases you need to handle. Your Rust programs can now express concepts in your domain using structs and enums. Creating custom types to use in your API ensures type safety: the compiler will make certain your functions only get values of the type each function expects. In order to provide a well-organized API to your users that is straightforward to use and only exposes exactly what your users will need, let’s now turn to Rust’s modules.","breadcrumbs":"Enums and Pattern Matching » Concise Control Flow with if let » Summary","id":"108","title":"Summary"},"109":{"body":"As you write large programs, organizing your code will become increasingly important. By grouping related functionality and separating code with distinct features, you’ll clarify where to find code that implements a particular feature and where to go to change how a feature works. The programs we’ve written so far have been in one module in one file. As a project grows, you should organize code by splitting it into multiple modules and then multiple files. A package can contain multiple binary crates and optionally one library crate. As a package grows, you can extract parts into separate crates that become external dependencies. This chapter covers all these techniques. For very large projects comprising a set of interrelated packages that evolve together, Cargo provides workspaces , which we’ll cover in the “Cargo Workspaces” section in Chapter 14. We’ll also discuss encapsulating implementation details, which lets you reuse code at a higher level: once you’ve implemented an operation, other code can call your code via its public interface without having to know how the implementation works. The way you write code defines which parts are public for other code to use and which parts are private implementation details that you reserve the right to change. This is another way to limit the amount of detail you have to keep in your head. A related concept is scope: the nested context in which code is written has a set of names that are defined as “in scope.” When reading, writing, and compiling code, programmers and compilers need to know whether a particular name at a particular spot refers to a variable, function, struct, enum, module, constant, or other item and what that item means. You can create scopes and change which names are in or out of scope. You can’t have two items with the same name in the same scope; tools are available to resolve name conflicts. Rust has a number of features that allow you to manage your code’s organization, including which details are exposed, which details are private, and what names are in each scope in your programs. These features, sometimes collectively referred to as the module system , include: Packages: A Cargo feature that lets you build, test, and share crates Crates: A tree of modules that produces a library or executable Modules and use: Let you control the organization, scope, and privacy of paths Paths: A way of naming an item, such as a struct, function, or module In this chapter, we’ll cover all these features, discuss how they interact, and explain how to use them to manage scope. By the end, you should have a solid understanding of the module system and be able to work with scopes like a pro!","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Managing Growing Projects with Packages, Crates, and Modules","id":"109","title":"Managing Growing Projects with Packages, Crates, and Modules"},"11":{"body":"The source files from which this book is generated can be found on GitHub .","breadcrumbs":"Introduction » Source Code","id":"11","title":"Source Code"},"110":{"body":"The first parts of the module system we’ll cover are packages and crates. A crate is the smallest amount of code that the Rust compiler considers at a time. Even if you run rustc rather than cargo and pass a single source code file (as we did all the way back in the “Writing and Running a Rust Program” section of Chapter 1), the compiler considers that file to be a crate. Crates can contain modules, and the modules may be defined in other files that get compiled with the crate, as we’ll see in the coming sections. A crate can come in one of two forms: a binary crate or a library crate. Binary crates are programs you can compile to an executable that you can run, such as a command-line program or a server. Each must have a function called main that defines what happens when the executable runs. All the crates we’ve created so far have been binary crates. Library crates don’t have a main function, and they don’t compile to an executable. Instead, they define functionality intended to be shared with multiple projects. For example, the rand crate we used in Chapter 2 provides functionality that generates random numbers. Most of the time when Rustaceans say “crate”, they mean library crate, and they use “crate” interchangeably with the general programming concept of a “library“. The crate root is a source file that the Rust compiler starts from and makes up the root module of your crate (we’ll explain modules in depth in the “Defining Modules to Control Scope and Privacy” section). A package is a bundle of one or more crates that provides a set of functionality. A package contains a Cargo.toml file that describes how to build those crates. Cargo is actually a package that contains the binary crate for the command-line tool you’ve been using to build your code. The Cargo package also contains a library crate that the binary crate depends on. Other projects can depend on the Cargo library crate to use the same logic the Cargo command-line tool uses. A crate can come in one of two forms: a binary crate or a library crate. A package can contain as many binary crates as you like, but at most only one library crate. A package must contain at least one crate, whether that’s a library or binary crate. Let’s walk through what happens when we create a package. First we enter the command cargo new my-project: $ cargo new my-project Created binary (application) `my-project` package\n$ ls my-project\nCargo.toml\nsrc\n$ ls my-project/src\nmain.rs After we run cargo new my-project, we use ls to see what Cargo creates. In the project directory, there’s a Cargo.toml file, giving us a package. There’s also a src directory that contains main.rs . Open Cargo.toml in your text editor, and note there’s no mention of src/main.rs . Cargo follows a convention that src/main.rs is the crate root of a binary crate with the same name as the package. Likewise, Cargo knows that if the package directory contains src/lib.rs , the package contains a library crate with the same name as the package, and src/lib.rs is its crate root. Cargo passes the crate root files to rustc to build the library or binary. Here, we have a package that only contains src/main.rs , meaning it only contains a binary crate named my-project. If a package contains src/main.rs and src/lib.rs , it has two crates: a binary and a library, both with the same name as the package. A package can have multiple binary crates by placing files in the src/bin directory: each file will be a separate binary crate.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Packages and Crates » Packages and Crates","id":"110","title":"Packages and Crates"},"111":{"body":"In this section, we’ll talk about modules and other parts of the module system, namely paths , which allow you to name items; the use keyword that brings a path into scope; and the pub keyword to make items public. We’ll also discuss the as keyword, external packages, and the glob operator.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Defining Modules to Control Scope and Privacy » Defining Modules to Control Scope and Privacy","id":"111","title":"Defining Modules to Control Scope and Privacy"},"112":{"body":"Before we get to the details of modules and paths, here we provide a quick reference on how modules, paths, the use keyword, and the pub keyword work in the compiler, and how most developers organize their code. We’ll be going through examples of each of these rules throughout this chapter, but this is a great place to refer to as a reminder of how modules work. Start from the crate root : When compiling a crate, the compiler first looks in the crate root file (usually src/lib.rs for a library crate or src/main.rs for a binary crate) for code to compile. Declaring modules : In the crate root file, you can declare new modules; say you declare a “garden” module with mod garden;. The compiler will look for the module’s code in these places: Inline, within curly brackets that replace the semicolon following mod garden In the file src/garden.rs In the file src/garden/mod.rs Declaring submodules : In any file other than the crate root, you can declare submodules. For example, you might declare mod vegetables; in src/garden.rs . The compiler will look for the submodule’s code within the directory named for the parent module in these places: Inline, directly following mod vegetables, within curly brackets instead of the semicolon In the file src/garden/vegetables.rs In the file src/garden/vegetables/mod.rs Paths to code in modules : Once a module is part of your crate, you can refer to code in that module from anywhere else in that same crate, as long as the privacy rules allow, using the path to the code. For example, an Asparagus type in the garden vegetables module would be found at crate::garden::vegetables::Asparagus. Private vs. public : Code within a module is private from its parent modules by default. To make a module public, declare it with pub mod instead of mod. To make items within a public module public as well, use pub before their declarations. The use keyword : Within a scope, the use keyword creates shortcuts to items to reduce repetition of long paths. In any scope that can refer to crate::garden::vegetables::Asparagus, you can create a shortcut with use crate::garden::vegetables::Asparagus; and from then on you only need to write Asparagus to make use of that type in the scope. Here, we create a binary crate named backyard that illustrates these rules. The crate’s directory, also named backyard, contains these files and directories: backyard\n├── Cargo.lock\n├── Cargo.toml\n└── src ├── garden │ └── vegetables.rs ├── garden.rs └── main.rs The crate root file in this case is src/main.rs , and it contains: Filename: src/main.rs use crate::garden::vegetables::Asparagus; pub mod garden; fn main() { let plant = Asparagus {}; println!(\"I'm growing {plant:?}!\");\n} The pub mod garden; line tells the compiler to include the code it finds in src/garden.rs , which is: Filename: src/garden.rs pub mod vegetables; Here, pub mod vegetables; means the code in src/garden/vegetables.rs is included too. That code is: #[derive(Debug)]\npub struct Asparagus {} Now let’s get into the details of these rules and demonstrate them in action!","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Defining Modules to Control Scope and Privacy » Modules Cheat Sheet","id":"112","title":"Modules Cheat Sheet"},"113":{"body":"Modules let us organize code within a crate for readability and easy reuse. Modules also allow us to control the privacy of items because code within a module is private by default. Private items are internal implementation details not available for outside use. We can choose to make modules and the items within them public, which exposes them to allow external code to use and depend on them. As an example, let’s write a library crate that provides the functionality of a restaurant. We’ll define the signatures of functions but leave their bodies empty to concentrate on the organization of the code rather than the implementation of a restaurant. In the restaurant industry, some parts of a restaurant are referred to as front of house and others as back of house . Front of house is where customers are; this encompasses where the hosts seat customers, servers take orders and payment, and bartenders make drinks. Back of house is where the chefs and cooks work in the kitchen, dishwashers clean up, and managers do administrative work. To structure our crate in this way, we can organize its functions into nested modules. Create a new library named restaurant by running cargo new restaurant --lib. Then enter the code in Listing 7-1 into src/lib.rs to define some modules and function signatures; this code is the front of house section. Filename: src/lib.rs mod front_of_house { mod hosting { fn add_to_waitlist() {} fn seat_at_table() {} } mod serving { fn take_order() {} fn serve_order() {} fn take_payment() {} }\n} Listing 7-1: A front_of_house module containing other modules that then contain functions We define a module with the mod keyword followed by the name of the module (in this case, front_of_house). The body of the module then goes inside curly brackets. Inside modules, we can place other modules, as in this case with the modules hosting and serving. Modules can also hold definitions for other items, such as structs, enums, constants, traits, and—as in Listing 7-1—functions. By using modules, we can group related definitions together and name why they’re related. Programmers using this code can navigate the code based on the groups rather than having to read through all the definitions, making it easier to find the definitions relevant to them. Programmers adding new functionality to this code would know where to place the code to keep the program organized. Earlier, we mentioned that src/main.rs and src/lib.rs are called crate roots. The reason for their name is that the contents of either of these two files form a module named crate at the root of the crate’s module structure, known as the module tree . Listing 7-2 shows the module tree for the structure in Listing 7-1. crate └── front_of_house ├── hosting │ ├── add_to_waitlist │ └── seat_at_table └── serving ├── take_order ├── serve_order └── take_payment Listing 7-2: The module tree for the code in Listing 7-1 This tree shows how some of the modules nest inside other modules; for example, hosting nests inside front_of_house. The tree also shows that some modules are siblings , meaning they’re defined in the same module; hosting and serving are siblings defined within front_of_house. If module A is contained inside module B, we say that module A is the child of module B and that module B is the parent of module A. Notice that the entire module tree is rooted under the implicit module named crate. The module tree might remind you of the filesystem’s directory tree on your computer; this is a very apt comparison! Just like directories in a filesystem, you use modules to organize your code. And just like files in a directory, we need a way to find our modules.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Defining Modules to Control Scope and Privacy » Grouping Related Code in Modules","id":"113","title":"Grouping Related Code in Modules"},"114":{"body":"To show Rust where to find an item in a module tree, we use a path in the same way we use a path when navigating a filesystem. To call a function, we need to know its path. A path can take two forms: An absolute path is the full path starting from a crate root; for code from an external crate, the absolute path begins with the crate name, and for code from the current crate, it starts with the literal crate. A relative path starts from the current module and uses self, super, or an identifier in the current module. Both absolute and relative paths are followed by one or more identifiers separated by double colons (::). Returning to Listing 7-1, say we want to call the add_to_waitlist function. This is the same as asking: what’s the path of the add_to_waitlist function? Listing 7-3 contains Listing 7-1 with some of the modules and functions removed. We’ll show two ways to call the add_to_waitlist function from a new function, eat_at_restaurant, defined in the crate root. These paths are correct, but there’s another problem remaining that will prevent this example from compiling as is. We’ll explain why in a bit. The eat_at_restaurant function is part of our library crate’s public API, so we mark it with the pub keyword. In the “Exposing Paths with the pub Keyword” section, we’ll go into more detail about pub. Filename: src/lib.rs mod front_of_house { mod hosting { fn add_to_waitlist() {} }\n} pub fn eat_at_restaurant() { // Absolute path crate::front_of_house::hosting::add_to_waitlist(); // Relative path front_of_house::hosting::add_to_waitlist();\n} Listing 7-3: Calling the add_to_waitlist function using absolute and relative paths The first time we call the add_to_waitlist function in eat_at_restaurant, we use an absolute path. The add_to_waitlist function is defined in the same crate as eat_at_restaurant, which means we can use the crate keyword to start an absolute path. We then include each of the successive modules until we make our way to add_to_waitlist. You can imagine a filesystem with the same structure: we’d specify the path /front_of_house/hosting/add_to_waitlist to run the add_to_waitlist program; using the crate name to start from the crate root is like using / to start from the filesystem root in your shell. The second time we call add_to_waitlist in eat_at_restaurant, we use a relative path. The path starts with front_of_house, the name of the module defined at the same level of the module tree as eat_at_restaurant. Here the filesystem equivalent would be using the path front_of_house/hosting/add_to_waitlist. Starting with a module name means that the path is relative. Choosing whether to use a relative or absolute path is a decision you’ll make based on your project, and it depends on whether you’re more likely to move item definition code separately from or together with the code that uses the item. For example, if we moved the front_of_house module and the eat_at_restaurant function into a module named customer_experience, we’d need to update the absolute path to add_to_waitlist, but the relative path would still be valid. However, if we moved the eat_at_restaurant function separately into a module named dining, the absolute path to the add_to_waitlist call would stay the same, but the relative path would need to be updated. Our preference in general is to specify absolute paths because it’s more likely we’ll want to move code definitions and item calls independently of each other. Let’s try to compile Listing 7-3 and find out why it won’t compile yet! The errors we get are shown in Listing 7-4. $ cargo build Compiling restaurant v0.1.0 (file:///projects/restaurant)\nerror[E0603]: module `hosting` is private --> src/lib.rs:9:28 |\n9 | crate::front_of_house::hosting::add_to_waitlist(); | ^^^^^^^ --------------- function `add_to_waitlist` is not publicly re-exported | | | private module |\nnote: the module `hosting` is defined here --> src/lib.rs:2:5 |\n2 | mod hosting { | ^^^^^^^^^^^ error[E0603]: module `hosting` is private --> src/lib.rs:12:21 |\n12 | front_of_house::hosting::add_to_waitlist(); | ^^^^^^^ --------------- function `add_to_waitlist` is not publicly re-exported | | | private module |\nnote: the module `hosting` is defined here --> src/lib.rs:2:5 |\n2 | mod hosting { | ^^^^^^^^^^^ For more information about this error, try `rustc --explain E0603`.\nerror: could not compile `restaurant` (lib) due to 2 previous errors Listing 7-4: Compiler errors from building the code in Listing 7-3 The error messages say that module hosting is private. In other words, we have the correct paths for the hosting module and the add_to_waitlist function, but Rust won’t let us use them because it doesn’t have access to the private sections. In Rust, all items (functions, methods, structs, enums, modules, and constants) are private to parent modules by default. If you want to make an item like a function or struct private, you put it in a module. Items in a parent module can’t use the private items inside child modules, but items in child modules can use the items in their ancestor modules. This is because child modules wrap and hide their implementation details, but the child modules can see the context in which they’re defined. To continue with our metaphor, think of the privacy rules as being like the back office of a restaurant: what goes on in there is private to restaurant customers, but office managers can see and do everything in the restaurant they operate. Rust chose to have the module system function this way so that hiding inner implementation details is the default. That way, you know which parts of the inner code you can change without breaking outer code. However, Rust does give you the option to expose inner parts of child modules’ code to outer ancestor modules by using the pub keyword to make an item public.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Paths for Referring to an Item in the Module Tree » Paths for Referring to an Item in the Module Tree","id":"114","title":"Paths for Referring to an Item in the Module Tree"},"115":{"body":"Let’s return to the error in Listing 7-4 that told us the hosting module is private. We want the eat_at_restaurant function in the parent module to have access to the add_to_waitlist function in the child module, so we mark the hosting module with the pub keyword, as shown in Listing 7-5. Filename: src/lib.rs mod front_of_house { pub mod hosting { fn add_to_waitlist() {} }\n} pub fn eat_at_restaurant() { // Absolute path crate::front_of_house::hosting::add_to_waitlist(); // Relative path front_of_house::hosting::add_to_waitlist();\n} Listing 7-5: Declaring the hosting module as pub to use it from eat_at_restaurant Unfortunately, the code in Listing 7-5 still results in compiler errors, as shown in Listing 7-6. $ cargo build Compiling restaurant v0.1.0 (file:///projects/restaurant)\nerror[E0603]: function `add_to_waitlist` is private --> src/lib.rs:9:37 |\n9 | crate::front_of_house::hosting::add_to_waitlist(); | ^^^^^^^^^^^^^^^ private function |\nnote: the function `add_to_waitlist` is defined here --> src/lib.rs:3:9 |\n3 | fn add_to_waitlist() {} | ^^^^^^^^^^^^^^^^^^^^ error[E0603]: function `add_to_waitlist` is private --> src/lib.rs:12:30 |\n12 | front_of_house::hosting::add_to_waitlist(); | ^^^^^^^^^^^^^^^ private function |\nnote: the function `add_to_waitlist` is defined here --> src/lib.rs:3:9 |\n3 | fn add_to_waitlist() {} | ^^^^^^^^^^^^^^^^^^^^ For more information about this error, try `rustc --explain E0603`.\nerror: could not compile `restaurant` (lib) due to 2 previous errors Listing 7-6: Compiler errors from building the code in Listing 7-5 What happened? Adding the pub keyword in front of mod hosting makes the module public. With this change, if we can access front_of_house, we can access hosting. But the contents of hosting are still private; making the module public doesn’t make its contents public. The pub keyword on a module only lets code in its ancestor modules refer to it, not access its inner code. Because modules are containers, there’s not much we can do by only making the module public; we need to go further and choose to make one or more of the items within the module public as well. The errors in Listing 7-6 say that the add_to_waitlist function is private. The privacy rules apply to structs, enums, functions, and methods as well as modules. Let’s also make the add_to_waitlist function public by adding the pub keyword before its definition, as in Listing 7-7. Filename: src/lib.rs mod front_of_house { pub mod hosting { pub fn add_to_waitlist() {} }\n} pub fn eat_at_restaurant() { // Absolute path crate::front_of_house::hosting::add_to_waitlist(); // Relative path front_of_house::hosting::add_to_waitlist();\n} Listing 7-7: Adding the pub keyword to mod hosting and fn add_to_waitlist lets us call the function from eat_at_restaurant Now the code will compile! To see why adding the pub keyword lets us use these paths in eat_at_restaurant with respect to the privacy rules, let’s look at the absolute and the relative paths. In the absolute path, we start with crate, the root of our crate’s module tree. The front_of_house module is defined in the crate root. While front_of_house isn’t public, because the eat_at_restaurant function is defined in the same module as front_of_house (that is, eat_at_restaurant and front_of_house are siblings), we can refer to front_of_house from eat_at_restaurant. Next is the hosting module marked with pub. We can access the parent module of hosting, so we can access hosting. Finally, the add_to_waitlist function is marked with pub and we can access its parent module, so this function call works! In the relative path, the logic is the same as the absolute path except for the first step: rather than starting from the crate root, the path starts from front_of_house. The front_of_house module is defined within the same module as eat_at_restaurant, so the relative path starting from the module in which eat_at_restaurant is defined works. Then, because hosting and add_to_waitlist are marked with pub, the rest of the path works, and this function call is valid! If you plan on sharing your library crate so other projects can use your code, your public API is your contract with users of your crate that determines how they can interact with your code. There are many considerations around managing changes to your public API to make it easier for people to depend on your crate. These considerations are out of the scope of this book; if you’re interested in this topic, see The Rust API Guidelines . Best Practices for Packages with a Binary and a Library We mentioned that a package can contain both a src/main.rs binary crate root as well as a src/lib.rs library crate root, and both crates will have the package name by default. Typically, packages with this pattern of containing both a library and a binary crate will have just enough code in the binary crate to start an executable that calls code within the library crate. This lets other projects benefit from most of the functionality that the package provides because the library crate’s code can be shared. The module tree should be defined in src/lib.rs . Then, any public items can be used in the binary crate by starting paths with the name of the package. The binary crate becomes a user of the library crate just like a completely external crate would use the library crate: it can only use the public API. This helps you design a good API; not only are you the author, you’re also a client! In Chapter 12 , we’ll demonstrate this organizational practice with a command-line program that will contain both a binary crate and a library crate.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Paths for Referring to an Item in the Module Tree » Exposing Paths with the pub Keyword","id":"115","title":"Exposing Paths with the pub Keyword"},"116":{"body":"We can construct relative paths that begin in the parent module, rather than the current module or the crate root, by using super at the start of the path. This is like starting a filesystem path with the .. syntax. Using super allows us to reference an item that we know is in the parent module, which can make rearranging the module tree easier when the module is closely related to the parent but the parent might be moved elsewhere in the module tree someday. Consider the code in Listing 7-8 that models the situation in which a chef fixes an incorrect order and personally brings it out to the customer. The function fix_incorrect_order defined in the back_of_house module calls the function deliver_order defined in the parent module by specifying the path to deliver_order, starting with super. Filename: src/lib.rs fn deliver_order() {} mod back_of_house { fn fix_incorrect_order() { cook_order(); super::deliver_order(); } fn cook_order() {}\n} Listing 7-8: Calling a function using a relative path starting with super The fix_incorrect_order function is in the back_of_house module, so we can use super to go to the parent module of back_of_house, which in this case is crate, the root. From there, we look for deliver_order and find it. Success! We think the back_of_house module and the deliver_order function are likely to stay in the same relationship to each other and get moved together should we decide to reorganize the crate’s module tree. Therefore, we used super so we’ll have fewer places to update code in the future if this code gets moved to a different module.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Paths for Referring to an Item in the Module Tree » Starting Relative Paths with super","id":"116","title":"Starting Relative Paths with super"},"117":{"body":"We can also use pub to designate structs and enums as public, but there are a few extra details to the usage of pub with structs and enums. If we use pub before a struct definition, we make the struct public, but the struct’s fields will still be private. We can make each field public or not on a case-by-case basis. In Listing 7-9, we’ve defined a public back_of_house::Breakfast struct with a public toast field but a private seasonal_fruit field. This models the case in a restaurant where the customer can pick the type of bread that comes with a meal, but the chef decides which fruit accompanies the meal based on what’s in season and in stock. The available fruit changes quickly, so customers can’t choose the fruit or even see which fruit they’ll get. Filename: src/lib.rs mod back_of_house { pub struct Breakfast { pub toast: String, seasonal_fruit: String, } impl Breakfast { pub fn summer(toast: &str) -> Breakfast { Breakfast { toast: String::from(toast), seasonal_fruit: String::from(\"peaches\"), } } }\n} pub fn eat_at_restaurant() { // Order a breakfast in the summer with Rye toast let mut meal = back_of_house::Breakfast::summer(\"Rye\"); // Change our mind about what bread we'd like meal.toast = String::from(\"Wheat\"); println!(\"I'd like {} toast please\", meal.toast); // The next line won't compile if we uncomment it; we're not allowed // to see or modify the seasonal fruit that comes with the meal // meal.seasonal_fruit = String::from(\"blueberries\");\n} Listing 7-9: A struct with some public fields and some private fields Because the toast field in the back_of_house::Breakfast struct is public, in eat_at_restaurant we can write and read to the toast field using dot notation. Notice that we can’t use the seasonal_fruit field in eat_at_restaurant, because seasonal_fruit is private. Try uncommenting the line modifying the seasonal_fruit field value to see what error you get! Also, note that because back_of_house::Breakfast has a private field, the struct needs to provide a public associated function that constructs an instance of Breakfast (we’ve named it summer here). If Breakfast didn’t have such a function, we couldn’t create an instance of Breakfast in eat_at_restaurant because we couldn’t set the value of the private seasonal_fruit field in eat_at_restaurant. In contrast, if we make an enum public, all of its variants are then public. We only need the pub before the enum keyword, as shown in Listing 7-10. Filename: src/lib.rs mod back_of_house { pub enum Appetizer { Soup, Salad, }\n} pub fn eat_at_restaurant() { let order1 = back_of_house::Appetizer::Soup; let order2 = back_of_house::Appetizer::Salad;\n} Listing 7-10: Designating an enum as public makes all its variants public Because we made the Appetizer enum public, we can use the Soup and Salad variants in eat_at_restaurant. Enums aren’t very useful unless their variants are public; it would be annoying to have to annotate all enum variants with pub in every case, so the default for enum variants is to be public. Structs are often useful without their fields being public, so struct fields follow the general rule of everything being private by default unless annotated with pub. There’s one more situation involving pub that we haven’t covered, and that is our last module system feature: the use keyword. We’ll cover use by itself first, and then we’ll show how to combine pub and use.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Paths for Referring to an Item in the Module Tree » Making Structs and Enums Public","id":"117","title":"Making Structs and Enums Public"},"118":{"body":"Having to write out the paths to call functions can feel inconvenient and repetitive. In Listing 7-7, whether we chose the absolute or relative path to the add_to_waitlist function, every time we wanted to call add_to_waitlist we had to specify front_of_house and hosting too. Fortunately, there’s a way to simplify this process: we can create a shortcut to a path with the use keyword once, and then use the shorter name everywhere else in the scope. In Listing 7-11, we bring the crate::front_of_house::hosting module into the scope of the eat_at_restaurant function so we only have to specify hosting::add_to_waitlist to call the add_to_waitlist function in eat_at_restaurant. Filename: src/lib.rs mod front_of_house { pub mod hosting { pub fn add_to_waitlist() {} }\n} use crate::front_of_house::hosting; pub fn eat_at_restaurant() { hosting::add_to_waitlist();\n} Listing 7-11: Bringing a module into scope with use Adding use and a path in a scope is similar to creating a symbolic link in the filesystem. By adding use crate::front_of_house::hosting in the crate root, hosting is now a valid name in that scope, just as though the hosting module had been defined in the crate root. Paths brought into scope with use also check privacy, like any other paths. Note that use only creates the shortcut for the particular scope in which the use occurs. Listing 7-12 moves the eat_at_restaurant function into a new child module named customer, which is then a different scope than the use statement, so the function body won’t compile. Filename: src/lib.rs mod front_of_house { pub mod hosting { pub fn add_to_waitlist() {} }\n} use crate::front_of_house::hosting; mod customer { pub fn eat_at_restaurant() { hosting::add_to_waitlist(); }\n} Listing 7-12: A use statement only applies in the scope it’s in The compiler error shows that the shortcut no longer applies within the customer module: $ cargo build Compiling restaurant v0.1.0 (file:///projects/restaurant)\nerror[E0433]: failed to resolve: use of undeclared crate or module `hosting` --> src/lib.rs:11:9 |\n11 | hosting::add_to_waitlist(); | ^^^^^^^ use of undeclared crate or module `hosting` |\nhelp: consider importing this module through its public re-export |\n10 + use crate::hosting; | warning: unused import: `crate::front_of_house::hosting` --> src/lib.rs:7:5 |\n7 | use crate::front_of_house::hosting; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = note: `#[warn(unused_imports)]` on by default For more information about this error, try `rustc --explain E0433`.\nwarning: `restaurant` (lib) generated 1 warning\nerror: could not compile `restaurant` (lib) due to 1 previous error; 1 warning emitted Notice there’s also a warning that the use is no longer used in its scope! To fix this problem, move the use within the customer module too, or reference the shortcut in the parent module with super::hosting within the child customer module.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Bringing Paths Into Scope with the use Keyword » Bringing Paths into Scope with the use Keyword","id":"118","title":"Bringing Paths into Scope with the use Keyword"},"119":{"body":"In Listing 7-11, you might have wondered why we specified use crate::front_of_house::hosting and then called hosting::add_to_waitlist in eat_at_restaurant, rather than specifying the use path all the way out to the add_to_waitlist function to achieve the same result, as in Listing 7-13. Filename: src/lib.rs mod front_of_house { pub mod hosting { pub fn add_to_waitlist() {} }\n} use crate::front_of_house::hosting::add_to_waitlist; pub fn eat_at_restaurant() { add_to_waitlist();\n} Listing 7-13: Bringing the add_to_waitlist function into scope with use, which is unidiomatic Although both Listing 7-11 and Listing 7-13 accomplish the same task, Listing 7-11 is the idiomatic way to bring a function into scope with use. Bringing the function’s parent module into scope with use means we have to specify the parent module when calling the function. Specifying the parent module when calling the function makes it clear that the function isn’t locally defined while still minimizing repetition of the full path. The code in Listing 7-13 is unclear as to where add_to_waitlist is defined. On the other hand, when bringing in structs, enums, and other items with use, it’s idiomatic to specify the full path. Listing 7-14 shows the idiomatic way to bring the standard library’s HashMap struct into the scope of a binary crate. Filename: src/main.rs use std::collections::HashMap; fn main() { let mut map = HashMap::new(); map.insert(1, 2);\n} Listing 7-14: Bringing HashMap into scope in an idiomatic way There’s no strong reason behind this idiom: it’s just the convention that has emerged, and folks have gotten used to reading and writing Rust code this way. The exception to this idiom is if we’re bringing two items with the same name into scope with use statements, because Rust doesn’t allow that. Listing 7-15 shows how to bring two Result types into scope that have the same name but different parent modules, and how to refer to them. Filename: src/lib.rs use std::fmt;\nuse std::io; fn function1() -> fmt::Result { // --snip--\n# Ok(())\n} fn function2() -> io::Result<()> { // --snip--\n# Ok(())\n} Listing 7-15: Bringing two types with the same name into the same scope requires using their parent modules. As you can see, using the parent modules distinguishes the two Result types. If instead we specified use std::fmt::Result and use std::io::Result, we’d have two Result types in the same scope, and Rust wouldn’t know which one we meant when we used Result.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Bringing Paths Into Scope with the use Keyword » Creating Idiomatic use Paths","id":"119","title":"Creating Idiomatic use Paths"},"12":{"body":"Let’s start your Rust journey! There’s a lot to learn, but every journey starts somewhere. In this chapter, we’ll discuss: Installing Rust on Linux, macOS, and Windows Writing a program that prints Hello, world! Using cargo, Rust’s package manager and build system","breadcrumbs":"Getting Started » Getting Started","id":"12","title":"Getting Started"},"120":{"body":"There’s another solution to the problem of bringing two types of the same name into the same scope with use: after the path, we can specify as and a new local name, or alias , for the type. Listing 7-16 shows another way to write the code in Listing 7-15 by renaming one of the two Result types using as. Filename: src/lib.rs use std::fmt::Result;\nuse std::io::Result as IoResult; fn function1() -> Result { // --snip--\n# Ok(())\n} fn function2() -> IoResult<()> { // --snip--\n# Ok(())\n} Listing 7-16: Renaming a type when it’s brought into scope with the as keyword In the second use statement, we chose the new name IoResult for the std::io::Result type, which won’t conflict with the Result from std::fmt that we’ve also brought into scope. Listing 7-15 and Listing 7-16 are considered idiomatic, so the choice is up to you!","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Bringing Paths Into Scope with the use Keyword » Providing New Names with the as Keyword","id":"120","title":"Providing New Names with the as Keyword"},"121":{"body":"When we bring a name into scope with the use keyword, the name available in the new scope is private. To enable the code that calls our code to refer to that name as if it had been defined in that code’s scope, we can combine pub and use. This technique is called re-exporting because we’re bringing an item into scope but also making that item available for others to bring into their scope. Listing 7-17 shows the code in Listing 7-11 with use in the root module changed to pub use. Filename: src/lib.rs mod front_of_house { pub mod hosting { pub fn add_to_waitlist() {} }\n} pub use crate::front_of_house::hosting; pub fn eat_at_restaurant() { hosting::add_to_waitlist();\n} Listing 7-17: Making a name available for any code to use from a new scope with pub use Before this change, external code would have to call the add_to_waitlist function by using the path restaurant::front_of_house::hosting::add_to_waitlist(), which also would have required the front_of_house module to be marked as pub. Now that this pub use has re-exported the hosting module from the root module, external code can use the path restaurant::hosting::add_to_waitlist() instead. Re-exporting is useful when the internal structure of your code is different from how programmers calling your code would think about the domain. For example, in this restaurant metaphor, the people running the restaurant think about “front of house” and “back of house.” But customers visiting a restaurant probably won’t think about the parts of the restaurant in those terms. With pub use, we can write our code with one structure but expose a different structure. Doing so makes our library well organized for programmers working on the library and programmers calling the library. We’ll look at another example of pub use and how it affects your crate’s documentation in the “Exporting a Convenient Public API with pub use” section of Chapter 14.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Bringing Paths Into Scope with the use Keyword » Re-exporting Names with pub use","id":"121","title":"Re-exporting Names with pub use"},"122":{"body":"In Chapter 2, we programmed a guessing game project that used an external package called rand to get random numbers. To use rand in our project, we added this line to Cargo.toml : Filename: Cargo.toml rand = \"0.8.5\" Adding rand as a dependency in Cargo.toml tells Cargo to download the rand package and any dependencies from crates.io and make rand available to our project. Then, to bring rand definitions into the scope of our package, we added a use line starting with the name of the crate, rand, and listed the items we wanted to bring into scope. Recall that in the “Generating a Random Number” section in Chapter 2, we brought the Rng trait into scope and called the rand::thread_rng function: # use std::io;\nuse rand::Rng; fn main() {\n# println!(\"Guess the number!\");\n# let secret_number = rand::thread_rng().gen_range(1..=100);\n# # println!(\"The secret number is: {secret_number}\");\n# # println!(\"Please input your guess.\");\n# # let mut guess = String::new();\n# # io::stdin()\n# .read_line(&mut guess)\n# .expect(\"Failed to read line\");\n# # println!(\"You guessed: {guess}\");\n} Members of the Rust community have made many packages available at crates.io , and pulling any of them into your package involves these same steps: listing them in your package’s Cargo.toml file and using use to bring items from their crates into scope. Note that the standard std library is also a crate that’s external to our package. Because the standard library is shipped with the Rust language, we don’t need to change Cargo.toml to include std. But we do need to refer to it with use to bring items from there into our package’s scope. For example, with HashMap we would use this line: use std::collections::HashMap; This is an absolute path starting with std, the name of the standard library crate.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Bringing Paths Into Scope with the use Keyword » Using External Packages","id":"122","title":"Using External Packages"},"123":{"body":"If we’re using multiple items defined in the same crate or same module, listing each item on its own line can take up a lot of vertical space in our files. For example, these two use statements we had in the guessing game in Listing 2-4 bring items from std into scope: Filename: src/main.rs # use rand::Rng;\n// --snip--\nuse std::cmp::Ordering;\nuse std::io;\n// --snip--\n# # fn main() {\n# println!(\"Guess the number!\");\n# # let secret_number = rand::thread_rng().gen_range(1..=100);\n# # println!(\"The secret number is: {secret_number}\");\n# # println!(\"Please input your guess.\");\n# # let mut guess = String::new();\n# # io::stdin()\n# .read_line(&mut guess)\n# .expect(\"Failed to read line\");\n# # println!(\"You guessed: {guess}\");\n# # match guess.cmp(&secret_number) {\n# Ordering::Less => println!(\"Too small!\"),\n# Ordering::Greater => println!(\"Too big!\"),\n# Ordering::Equal => println!(\"You win!\"),\n# }\n# } Instead, we can use nested paths to bring the same items into scope in one line. We do this by specifying the common part of the path, followed by two colons, and then curly brackets around a list of the parts of the paths that differ, as shown in Listing 7-18. Filename: src/main.rs # use rand::Rng;\n// --snip--\nuse std::{cmp::Ordering, io};\n// --snip--\n# # fn main() {\n# println!(\"Guess the number!\");\n# # let secret_number = rand::thread_rng().gen_range(1..=100);\n# # println!(\"The secret number is: {secret_number}\");\n# # println!(\"Please input your guess.\");\n# # let mut guess = String::new();\n# # io::stdin()\n# .read_line(&mut guess)\n# .expect(\"Failed to read line\");\n# # let guess: u32 = guess.trim().parse().expect(\"Please type a number!\");\n# # println!(\"You guessed: {guess}\");\n# # match guess.cmp(&secret_number) {\n# Ordering::Less => println!(\"Too small!\"),\n# Ordering::Greater => println!(\"Too big!\"),\n# Ordering::Equal => println!(\"You win!\"),\n# }\n# } Listing 7-18: Specifying a nested path to bring multiple items with the same prefix into scope In bigger programs, bringing many items into scope from the same crate or module using nested paths can reduce the number of separate use statements needed by a lot! We can use a nested path at any level in a path, which is useful when combining two use statements that share a subpath. For example, Listing 7-19 shows two use statements: one that brings std::io into scope and one that brings std::io::Write into scope. Filename: src/lib.rs use std::io;\nuse std::io::Write; Listing 7-19: Two use statements where one is a subpath of the other The common part of these two paths is std::io, and that’s the complete first path. To merge these two paths into one use statement, we can use self in the nested path, as shown in Listing 7-20. Filename: src/lib.rs use std::io::{self, Write}; Listing 7-20: Combining the paths in Listing 7-19 into one use statement This line brings std::io and std::io::Write into scope.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Bringing Paths Into Scope with the use Keyword » Using Nested Paths to Clean Up Large use Lists","id":"123","title":"Using Nested Paths to Clean Up Large use Lists"},"124":{"body":"If we want to bring all public items defined in a path into scope, we can specify that path followed by the * glob operator: use std::collections::*; This use statement brings all public items defined in std::collections into the current scope. Be careful when using the glob operator! Glob can make it harder to tell what names are in scope and where a name used in your program was defined. The glob operator is often used when testing to bring everything under test into the tests module; we’ll talk about that in the “How to Write Tests” section in Chapter 11. The glob operator is also sometimes used as part of the prelude pattern: see the standard library documentation for more information on that pattern.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Bringing Paths Into Scope with the use Keyword » The Glob Operator","id":"124","title":"The Glob Operator"},"125":{"body":"So far, all the examples in this chapter defined multiple modules in one file. When modules get large, you might want to move their definitions to a separate file to make the code easier to navigate. For example, let’s start from the code in Listing 7-17 that had multiple restaurant modules. We’ll extract modules into files instead of having all the modules defined in the crate root file. In this case, the crate root file is src/lib.rs , but this procedure also works with binary crates whose crate root file is src/main.rs . First we’ll extract the front_of_house module to its own file. Remove the code inside the curly brackets for the front_of_house module, leaving only the mod front_of_house; declaration, so that src/lib.rs contains the code shown in Listing 7-21. Note that this won’t compile until we create the src/front_of_house.rs file in Listing 7-22. Filename: src/lib.rs mod front_of_house; pub use crate::front_of_house::hosting; pub fn eat_at_restaurant() { hosting::add_to_waitlist();\n} Listing 7-21: Declaring the front_of_house module whose body will be in src/front_of_house.rs Next, place the code that was in the curly brackets into a new file named src/front_of_house.rs , as shown in Listing 7-22. The compiler knows to look in this file because it came across the module declaration in the crate root with the name front_of_house. Filename: src/front_of_house.rs pub mod hosting { pub fn add_to_waitlist() {}\n} Listing 7-22: Definitions inside the front_of_house module in src/front_of_house.rs Note that you only need to load a file using a mod declaration once in your module tree. Once the compiler knows the file is part of the project (and knows where in the module tree the code resides because of where you’ve put the mod statement), other files in your project should refer to the loaded file’s code using a path to where it was declared, as covered in the “Paths for Referring to an Item in the Module Tree” section. In other words, mod is not an “include” operation that you may have seen in other programming languages. Next, we’ll extract the hosting module to its own file. The process is a bit different because hosting is a child module of front_of_house, not of the root module. We’ll place the file for hosting in a new directory that will be named for its ancestors in the module tree, in this case src/front_of_house . To start moving hosting, we change src/front_of_house.rs to contain only the declaration of the hosting module: Filename: src/front_of_house.rs pub mod hosting; Then we create a src/front_of_house directory and a hosting.rs file to contain the definitions made in the hosting module: Filename: src/front_of_house/hosting.rs pub fn add_to_waitlist() {} If we instead put hosting.rs in the src directory, the compiler would expect the hosting.rs code to be in a hosting module declared in the crate root, and not declared as a child of the front_of_house module. The compiler’s rules for which files to check for which modules’ code mean the directories and files more closely match the module tree.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Separating Modules into Different Files » Separating Modules into Different Files","id":"125","title":"Separating Modules into Different Files"},"126":{"body":"So far we’ve covered the most idiomatic file paths the Rust compiler uses, but Rust also supports an older style of file path. For a module named front_of_house declared in the crate root, the compiler will look for the module’s code in: src/front_of_house.rs (what we covered) src/front_of_house/mod.rs (older style, still supported path) For a module named hosting that is a submodule of front_of_house, the compiler will look for the module’s code in: src/front_of_house/hosting.rs (what we covered) src/front_of_house/hosting/mod.rs (older style, still supported path) If you use both styles for the same module, you’ll get a compiler error. Using a mix of both styles for different modules in the same project is allowed, but might be confusing for people navigating your project. The main downside to the style that uses files named mod.rs is that your project can end up with many files named mod.rs , which can get confusing when you have them open in your editor at the same time. We’ve moved each module’s code to a separate file, and the module tree remains the same. The function calls in eat_at_restaurant will work without any modification, even though the definitions live in different files. This technique lets you move modules to new files as they grow in size. Note that the pub use crate::front_of_house::hosting statement in src/lib.rs also hasn’t changed, nor does use have any impact on what files are compiled as part of the crate. The mod keyword declares modules, and Rust looks in a file with the same name as the module for the code that goes into that module.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Separating Modules into Different Files » Alternate File Paths","id":"126","title":"Alternate File Paths"},"127":{"body":"Rust lets you split a package into multiple crates and a crate into modules so you can refer to items defined in one module from another module. You can do this by specifying absolute or relative paths. These paths can be brought into scope with a use statement so you can use a shorter path for multiple uses of the item in that scope. Module code is private by default, but you can make definitions public by adding the pub keyword. In the next chapter, we’ll look at some collection data structures in the standard library that you can use in your neatly organized code.","breadcrumbs":"Managing Growing Projects with Packages, Crates, and Modules » Separating Modules into Different Files » Summary","id":"127","title":"Summary"},"128":{"body":"Rust’s standard library includes a number of very useful data structures called collections . Most other data types represent one specific value, but collections can contain multiple values. Unlike the built-in array and tuple types, the data these collections point to is stored on the heap, which means the amount of data does not need to be known at compile time and can grow or shrink as the program runs. Each kind of collection has different capabilities and costs, and choosing an appropriate one for your current situation is a skill you’ll develop over time. In this chapter, we’ll discuss three collections that are used very often in Rust programs: A vector allows you to store a variable number of values next to each other. A string is a collection of characters. We’ve mentioned the String type previously, but in this chapter we’ll talk about it in depth. A hash map allows you to associate a value with a specific key. It’s a particular implementation of the more general data structure called a map . To learn about the other kinds of collections provided by the standard library, see the documentation . We’ll discuss how to create and update vectors, strings, and hash maps, as well as what makes each special.","breadcrumbs":"Common Collections » Common Collections","id":"128","title":"Common Collections"},"129":{"body":"The first collection type we’ll look at is Vec, also known as a vector . Vectors allow you to store more than one value in a single data structure that puts all the values next to each other in memory. Vectors can only store values of the same type. They are useful when you have a list of items, such as the lines of text in a file or the prices of items in a shopping cart.","breadcrumbs":"Common Collections » Storing Lists of Values with Vectors » Storing Lists of Values with Vectors","id":"129","title":"Storing Lists of Values with Vectors"},"13":{"body":"The first step is to install Rust. We’ll download Rust through rustup, a command line tool for managing Rust versions and associated tools. You’ll need an internet connection for the download. Note: If you prefer not to use rustup for some reason, please see the Other Rust Installation Methods page for more options. The following steps install the latest stable version of the Rust compiler. Rust’s stability guarantees ensure that all the examples in the book that compile will continue to compile with newer Rust versions. The output might differ slightly between versions because Rust often improves error messages and warnings. In other words, any newer, stable version of Rust you install using these steps should work as expected with the content of this book.","breadcrumbs":"Getting Started » Installation » Installation","id":"13","title":"Installation"},"130":{"body":"To create a new empty vector, we call the Vec::new function, as shown in Listing 8-1. # fn main() { let v: Vec = Vec::new();\n# } Listing 8-1: Creating a new, empty vector to hold values of type i32 Note that we added a type annotation here. Because we aren’t inserting any values into this vector, Rust doesn’t know what kind of elements we intend to store. This is an important point. Vectors are implemented using generics; we’ll cover how to use generics with your own types in Chapter 10. For now, know that the Vec type provided by the standard library can hold any type. When we create a vector to hold a specific type, we can specify the type within angle brackets. In Listing 8-1, we’ve told Rust that the Vec in v will hold elements of the i32 type. More often, you’ll create a Vec with initial values and Rust will infer the type of value you want to store, so you rarely need to do this type annotation. Rust conveniently provides the vec! macro, which will create a new vector that holds the values you give it. Listing 8-2 creates a new Vec that holds the values 1, 2, and 3. The integer type is i32 because that’s the default integer type, as we discussed in the “Data Types” section of Chapter 3. # fn main() { let v = vec![1, 2, 3];\n# } Listing 8-2: Creating a new vector containing values Because we’ve given initial i32 values, Rust can infer that the type of v is Vec, and the type annotation isn’t necessary. Next, we’ll look at how to modify a vector.","breadcrumbs":"Common Collections » Storing Lists of Values with Vectors » Creating a New Vector","id":"130","title":"Creating a New Vector"},"131":{"body":"To create a vector and then add elements to it, we can use the push method, as shown in Listing 8-3. # fn main() { let mut v = Vec::new(); v.push(5); v.push(6); v.push(7); v.push(8);\n# } Listing 8-3: Using the push method to add values to a vector As with any variable, if we want to be able to change its value, we need to make it mutable using the mut keyword, as discussed in Chapter 3. The numbers we place inside are all of type i32, and Rust infers this from the data, so we don’t need the Vec annotation.","breadcrumbs":"Common Collections » Storing Lists of Values with Vectors » Updating a Vector","id":"131","title":"Updating a Vector"},"132":{"body":"There are two ways to reference a value stored in a vector: via indexing or by using the get method. In the following examples, we’ve annotated the types of the values that are returned from these functions for extra clarity. Listing 8-4 shows both methods of accessing a value in a vector, with indexing syntax and the get method. # fn main() { let v = vec![1, 2, 3, 4, 5]; let third: &i32 = &v[2]; println!(\"The third element is {third}\"); let third: Option<&i32> = v.get(2); match third { Some(third) => println!(\"The third element is {third}\"), None => println!(\"There is no third element.\"), }\n# } Listing 8-4: Using indexing syntax and using the get method to access an item in a vector Note a few details here. We use the index value of 2 to get the third element because vectors are indexed by number, starting at zero. Using & and [] gives us a reference to the element at the index value. When we use the get method with the index passed as an argument, we get an Option<&T> that we can use with match. Rust provides these two ways to reference an element so you can choose how the program behaves when you try to use an index value outside the range of existing elements. As an example, let’s see what happens when we have a vector of five elements and then we try to access an element at index 100 with each technique, as shown in Listing 8-5. # fn main() { let v = vec![1, 2, 3, 4, 5]; let does_not_exist = &v[100]; let does_not_exist = v.get(100);\n# } Listing 8-5: Attempting to access the element at index 100 in a vector containing five elements When we run this code, the first [] method will cause the program to panic because it references a nonexistent element. This method is best used when you want your program to crash if there’s an attempt to access an element past the end of the vector. When the get method is passed an index that is outside the vector, it returns None without panicking. You would use this method if accessing an element beyond the range of the vector may happen occasionally under normal circumstances. Your code will then have logic to handle having either Some(&element) or None, as discussed in Chapter 6. For example, the index could be coming from a person entering a number. If they accidentally enter a number that’s too large and the program gets a None value, you could tell the user how many items are in the current vector and give them another chance to enter a valid value. That would be more user-friendly than crashing the program due to a typo! When the program has a valid reference, the borrow checker enforces the ownership and borrowing rules (covered in Chapter 4) to ensure this reference and any other references to the contents of the vector remain valid. Recall the rule that states you can’t have mutable and immutable references in the same scope. That rule applies in Listing 8-6, where we hold an immutable reference to the first element in a vector and try to add an element to the end. This program won’t work if we also try to refer to that element later in the function. # fn main() { let mut v = vec![1, 2, 3, 4, 5]; let first = &v[0]; v.push(6); println!(\"The first element is: {first}\");\n# } Listing 8-6: Attempting to add an element to a vector while holding a reference to an item Compiling this code will result in this error: $ cargo run Compiling collections v0.1.0 (file:///projects/collections)\nerror[E0502]: cannot borrow `v` as mutable because it is also borrowed as immutable --> src/main.rs:6:5 |\n4 | let first = &v[0]; | - immutable borrow occurs here\n5 |\n6 | v.push(6); | ^^^^^^^^^ mutable borrow occurs here\n7 |\n8 | println!(\"The first element is: {first}\"); | ------- immutable borrow later used here For more information about this error, try `rustc --explain E0502`.\nerror: could not compile `collections` (bin \"collections\") due to 1 previous error The code in Listing 8-6 might look like it should work: why should a reference to the first element care about changes at the end of the vector? This error is due to the way vectors work: because vectors put the values next to each other in memory, adding a new element onto the end of the vector might require allocating new memory and copying the old elements to the new space, if there isn’t enough room to put all the elements next to each other where the vector is currently stored. In that case, the reference to the first element would be pointing to deallocated memory. The borrowing rules prevent programs from ending up in that situation. Note: For more on the implementation details of the Vec type, see “The Rustonomicon” .","breadcrumbs":"Common Collections » Storing Lists of Values with Vectors » Reading Elements of Vectors","id":"132","title":"Reading Elements of Vectors"},"133":{"body":"To access each element in a vector in turn, we would iterate through all of the elements rather than use indices to access one at a time. Listing 8-7 shows how to use a for loop to get immutable references to each element in a vector of i32 values and print them. # fn main() { let v = vec![100, 32, 57]; for i in &v { println!(\"{i}\"); }\n# } Listing 8-7: Printing each element in a vector by iterating over the elements using a for loop We can also iterate over mutable references to each element in a mutable vector in order to make changes to all the elements. The for loop in Listing 8-8 will add 50 to each element. # fn main() { let mut v = vec![100, 32, 57]; for i in &mut v { *i += 50; }\n# } Listing 8-8: Iterating over mutable references to elements in a vector To change the value that the mutable reference refers to, we have to use the * dereference operator to get to the value in i before we can use the += operator. We’ll talk more about the dereference operator in the “Following the Pointer to the Value with the Dereference Operator” section of Chapter 15. Iterating over a vector, whether immutably or mutably, is safe because of the borrow checker’s rules. If we attempted to insert or remove items in the for loop bodies in Listing 8-7 and Listing 8-8, we would get a compiler error similar to the one we got with the code in Listing 8-6. The reference to the vector that the for loop holds prevents simultaneous modification of the whole vector.","breadcrumbs":"Common Collections » Storing Lists of Values with Vectors » Iterating Over the Values in a Vector","id":"133","title":"Iterating Over the Values in a Vector"},"134":{"body":"Vectors can only store values that are of the same type. This can be inconvenient; there are definitely use cases for needing to store a list of items of different types. Fortunately, the variants of an enum are defined under the same enum type, so when we need one type to represent elements of different types, we can define and use an enum! For example, say we want to get values from a row in a spreadsheet in which some of the columns in the row contain integers, some floating-point numbers, and some strings. We can define an enum whose variants will hold the different value types, and all the enum variants will be considered the same type: that of the enum. Then we can create a vector to hold that enum and so, ultimately, hold different types. We’ve demonstrated this in Listing 8-9. # fn main() { enum SpreadsheetCell { Int(i32), Float(f64), Text(String), } let row = vec![ SpreadsheetCell::Int(3), SpreadsheetCell::Text(String::from(\"blue\")), SpreadsheetCell::Float(10.12), ];\n# } Listing 8-9: Defining an enum to store values of different types in one vector Rust needs to know what types will be in the vector at compile time so it knows exactly how much memory on the heap will be needed to store each element. We must also be explicit about what types are allowed in this vector. If Rust allowed a vector to hold any type, there would be a chance that one or more of the types would cause errors with the operations performed on the elements of the vector. Using an enum plus a match expression means that Rust will ensure at compile time that every possible case is handled, as discussed in Chapter 6. If you don’t know the exhaustive set of types a program will get at runtime to store in a vector, the enum technique won’t work. Instead, you can use a trait object, which we’ll cover in Chapter 17. Now that we’ve discussed some of the most common ways to use vectors, be sure to review the API documentation for all of the many useful methods defined on Vec by the standard library. For example, in addition to push, a pop method removes and returns the last element.","breadcrumbs":"Common Collections » Storing Lists of Values with Vectors » Using an Enum to Store Multiple Types","id":"134","title":"Using an Enum to Store Multiple Types"},"135":{"body":"Like any other struct, a vector is freed when it goes out of scope, as annotated in Listing 8-10. # fn main() { { let v = vec![1, 2, 3, 4]; // do stuff with v } // <- v goes out of scope and is freed here\n# } Listing 8-10: Showing where the vector and its elements are dropped When the vector gets dropped, all of its contents are also dropped, meaning the integers it holds will be cleaned up. The borrow checker ensures that any references to contents of a vector are only used while the vector itself is valid. Let’s move on to the next collection type: String!","breadcrumbs":"Common Collections » Storing Lists of Values with Vectors » Dropping a Vector Drops Its Elements","id":"135","title":"Dropping a Vector Drops Its Elements"},"136":{"body":"We talked about strings in Chapter 4, but we’ll look at them in more depth now. New Rustaceans commonly get stuck on strings for a combination of three reasons: Rust’s propensity for exposing possible errors, strings being a more complicated data structure than many programmers give them credit for, and UTF-8. These factors combine in a way that can seem difficult when you’re coming from other programming languages. We discuss strings in the context of collections because strings are implemented as a collection of bytes, plus some methods to provide useful functionality when those bytes are interpreted as text. In this section, we’ll talk about the operations on String that every collection type has, such as creating, updating, and reading. We’ll also discuss the ways in which String is different from the other collections, namely how indexing into a String is complicated by the differences between how people and computers interpret String data.","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » Storing UTF-8 Encoded Text with Strings","id":"136","title":"Storing UTF-8 Encoded Text with Strings"},"137":{"body":"We’ll first define what we mean by the term string . Rust has only one string type in the core language, which is the string slice str that is usually seen in its borrowed form &str. In Chapter 4, we talked about string slices , which are references to some UTF-8 encoded string data stored elsewhere. String literals, for example, are stored in the program’s binary and are therefore string slices. The String type, which is provided by Rust’s standard library rather than coded into the core language, is a growable, mutable, owned, UTF-8 encoded string type. When Rustaceans refer to “strings” in Rust, they might be referring to either the String or the string slice &str types, not just one of those types. Although this section is largely about String, both types are used heavily in Rust’s standard library, and both String and string slices are UTF-8 encoded.","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » What Is a String?","id":"137","title":"What Is a String?"},"138":{"body":"Many of the same operations available with Vec are available with String as well because String is actually implemented as a wrapper around a vector of bytes with some extra guarantees, restrictions, and capabilities. An example of a function that works the same way with Vec and String is the new function to create an instance, shown in Listing 8-11. # fn main() { let mut s = String::new();\n# } Listing 8-11: Creating a new, empty String This line creates a new, empty string called s, into which we can then load data. Often, we’ll have some initial data with which we want to start the string. For that, we use the to_string method, which is available on any type that implements the Display trait, as string literals do. Listing 8-12 shows two examples. # fn main() { let data = \"initial contents\"; let s = data.to_string(); // the method also works on a literal directly: let s = \"initial contents\".to_string();\n# } Listing 8-12: Using the to_string method to create a String from a string literal This code creates a string containing initial contents. We can also use the function String::from to create a String from a string literal. The code in Listing 8-13 is equivalent to the code in Listing 8-12 that uses to_string. # fn main() { let s = String::from(\"initial contents\");\n# } Listing 8-13: Using the String::from function to create a String from a string literal Because strings are used for so many things, we can use many different generic APIs for strings, providing us with a lot of options. Some of them can seem redundant, but they all have their place! In this case, String::from and to_string do the same thing, so which one you choose is a matter of style and readability. Remember that strings are UTF-8 encoded, so we can include any properly encoded data in them, as shown in Listing 8-14. # fn main() { let hello = String::from(\"السلام عليكم\"); let hello = String::from(\"Dobrý den\"); let hello = String::from(\"Hello\"); let hello = String::from(\"שלום\"); let hello = String::from(\"नमस्ते\"); let hello = String::from(\"こんにちは\"); let hello = String::from(\"안녕하세요\"); let hello = String::from(\"你好\"); let hello = String::from(\"Olá\"); let hello = String::from(\"Здравствуйте\"); let hello = String::from(\"Hola\");\n# } Listing 8-14: Storing greetings in different languages in strings All of these are valid String values.","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » Creating a New String","id":"138","title":"Creating a New String"},"139":{"body":"A String can grow in size and its contents can change, just like the contents of a Vec, if you push more data into it. In addition, you can conveniently use the + operator or the format! macro to concatenate String values. Appending to a String with push_str and push We can grow a String by using the push_str method to append a string slice, as shown in Listing 8-15. # fn main() { let mut s = String::from(\"foo\"); s.push_str(\"bar\");\n# } Listing 8-15: Appending a string slice to a String using the push_str method After these two lines, s will contain foobar. The push_str method takes a string slice because we don’t necessarily want to take ownership of the parameter. For example, in the code in Listing 8-16, we want to be able to use s2 after appending its contents to s1. # fn main() { let mut s1 = String::from(\"foo\"); let s2 = \"bar\"; s1.push_str(s2); println!(\"s2 is {s2}\");\n# } Listing 8-16: Using a string slice after appending its contents to a String If the push_str method took ownership of s2, we wouldn’t be able to print its value on the last line. However, this code works as we’d expect! The push method takes a single character as a parameter and adds it to the String. Listing 8-17 adds the letter l to a String using the push method. # fn main() { let mut s = String::from(\"lo\"); s.push('l');\n# } Listing 8-17: Adding one character to a String value using push As a result, s will contain lol. Concatenation with the + Operator or the format! Macro Often, you’ll want to combine two existing strings. One way to do so is to use the + operator, as shown in Listing 8-18. # fn main() { let s1 = String::from(\"Hello, \"); let s2 = String::from(\"world!\"); let s3 = s1 + &s2; // note s1 has been moved here and can no longer be used\n# } Listing 8-18: Using the + operator to combine two String values into a new String value The string s3 will contain Hello, world!. The reason s1 is no longer valid after the addition, and the reason we used a reference to s2, has to do with the signature of the method that’s called when we use the + operator. The + operator uses the add method, whose signature looks something like this: fn add(self, s: &str) -> String { In the standard library, you’ll see add defined using generics and associated types. Here, we’ve substituted in concrete types, which is what happens when we call this method with String values. We’ll discuss generics in Chapter 10. This signature gives us the clues we need in order to understand the tricky bits of the + operator. First, s2 has an &, meaning that we’re adding a reference of the second string to the first string. This is because of the s parameter in the add function: we can only add a &str to a String; we can’t add two String values together. But wait—the type of &s2 is &String, not &str, as specified in the second parameter to add. So why does Listing 8-18 compile? The reason we’re able to use &s2 in the call to add is that the compiler can coerce the &String argument into a &str. When we call the add method, Rust uses a deref coercion , which here turns &s2 into &s2[..]. We’ll discuss deref coercion in more depth in Chapter 15. Because add does not take ownership of the s parameter, s2 will still be a valid String after this operation. Second, we can see in the signature that add takes ownership of self because self does not have an &. This means s1 in Listing 8-18 will be moved into the add call and will no longer be valid after that. So, although let s3 = s1 + &s2; looks like it will copy both strings and create a new one, this statement actually takes ownership of s1, appends a copy of the contents of s2, and then returns ownership of the result. In other words, it looks like it’s making a lot of copies, but it isn’t; the implementation is more efficient than copying. If we need to concatenate multiple strings, the behavior of the + operator gets unwieldy: # fn main() { let s1 = String::from(\"tic\"); let s2 = String::from(\"tac\"); let s3 = String::from(\"toe\"); let s = s1 + \"-\" + &s2 + \"-\" + &s3;\n# } At this point, s will be tic-tac-toe. With all of the + and \" characters, it’s difficult to see what’s going on. For combining strings in more complicated ways, we can instead use the format! macro: # fn main() { let s1 = String::from(\"tic\"); let s2 = String::from(\"tac\"); let s3 = String::from(\"toe\"); let s = format!(\"{s1}-{s2}-{s3}\");\n# } This code also sets s to tic-tac-toe. The format! macro works like println!, but instead of printing the output to the screen, it returns a String with the contents. The version of the code using format! is much easier to read, and the code generated by the format! macro uses references so that this call doesn’t take ownership of any of its parameters.","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » Updating a String","id":"139","title":"Updating a String"},"14":{"body":"In this chapter and throughout the book, we’ll show some commands used in the terminal. Lines that you should enter in a terminal all start with $. You don’t need to type the $ character; it’s the command line prompt shown to indicate the start of each command. Lines that don’t start with $ typically show the output of the previous command. Additionally, PowerShell-specific examples will use > rather than $.","breadcrumbs":"Getting Started » Installation » Command Line Notation","id":"14","title":"Command Line Notation"},"140":{"body":"In many other programming languages, accessing individual characters in a string by referencing them by index is a valid and common operation. However, if you try to access parts of a String using indexing syntax in Rust, you’ll get an error. Consider the invalid code in Listing 8-19. # fn main() { let s1 = String::from(\"hello\"); let h = s1[0];\n# } Listing 8-19: Attempting to use indexing syntax with a String This code will result in the following error: $ cargo run Compiling collections v0.1.0 (file:///projects/collections)\nerror[E0277]: the type `str` cannot be indexed by `{integer}` --> src/main.rs:3:16 |\n3 | let h = s1[0]; | ^ string indices are ranges of `usize` | = help: the trait `SliceIndex` is not implemented for `{integer}`, which is required by `String: Index<_>` = note: you can use `.chars().nth()` or `.bytes().nth()` for more information, see chapter 8 in The Book: = help: the trait `SliceIndex<[_]>` is implemented for `usize` = help: for that trait implementation, expected `[_]`, found `str` = note: required for `String` to implement `Index<{integer}>` For more information about this error, try `rustc --explain E0277`.\nerror: could not compile `collections` (bin \"collections\") due to 1 previous error The error and the note tell the story: Rust strings don’t support indexing. But why not? To answer that question, we need to discuss how Rust stores strings in memory. Internal Representation A String is a wrapper over a Vec. Let’s look at some of our properly encoded UTF-8 example strings from Listing 8-14. First, this one: # fn main() {\n# let hello = String::from(\"السلام عليكم\");\n# let hello = String::from(\"Dobrý den\");\n# let hello = String::from(\"Hello\");\n# let hello = String::from(\"שלום\");\n# let hello = String::from(\"नमस्ते\");\n# let hello = String::from(\"こんにちは\");\n# let hello = String::from(\"안녕하세요\");\n# let hello = String::from(\"你好\");\n# let hello = String::from(\"Olá\");\n# let hello = String::from(\"Здравствуйте\"); let hello = String::from(\"Hola\");\n# } In this case, len will be 4, which means the vector storing the string \"Hola\" is 4 bytes long. Each of these letters takes one byte when encoded in UTF-8. The following line, however, may surprise you (note that this string begins with the capital Cyrillic letter Ze , not the number 3): # fn main() {\n# let hello = String::from(\"السلام عليكم\");\n# let hello = String::from(\"Dobrý den\");\n# let hello = String::from(\"Hello\");\n# let hello = String::from(\"שלום\");\n# let hello = String::from(\"नमस्ते\");\n# let hello = String::from(\"こんにちは\");\n# let hello = String::from(\"안녕하세요\");\n# let hello = String::from(\"你好\");\n# let hello = String::from(\"Olá\"); let hello = String::from(\"Здравствуйте\");\n# let hello = String::from(\"Hola\");\n# } If you were asked how long the string is, you might say 12. In fact, Rust’s answer is 24: that’s the number of bytes it takes to encode “Здравствуйте” in UTF-8, because each Unicode scalar value in that string takes 2 bytes of storage. Therefore, an index into the string’s bytes will not always correlate to a valid Unicode scalar value. To demonstrate, consider this invalid Rust code: let hello = \"Здравствуйте\";\nlet answer = &hello[0]; You already know that answer will not be З, the first letter. When encoded in UTF-8, the first byte of З is 208 and the second is 151, so it would seem that answer should in fact be 208, but 208 is not a valid character on its own. Returning 208 is likely not what a user would want if they asked for the first letter of this string; however, that’s the only data that Rust has at byte index 0. Users generally don’t want the byte value returned, even if the string contains only Latin letters: if &\"hello\"[0] were valid code that returned the byte value, it would return 104, not h. The answer, then, is that to avoid returning an unexpected value and causing bugs that might not be discovered immediately, Rust doesn’t compile this code at all and prevents misunderstandings early in the development process. Bytes and Scalar Values and Grapheme Clusters! Oh My! Another point about UTF-8 is that there are actually three relevant ways to look at strings from Rust’s perspective: as bytes, scalar values, and grapheme clusters (the closest thing to what we would call letters ). If we look at the Hindi word “नमस्ते” written in the Devanagari script, it is stored as a vector of u8 values that looks like this: [224, 164, 168, 224, 164, 174, 224, 164, 184, 224, 165, 141, 224, 164, 164,\n224, 165, 135] That’s 18 bytes and is how computers ultimately store this data. If we look at them as Unicode scalar values, which are what Rust’s char type is, those bytes look like this: ['न', 'म', 'स', '्', 'त', 'े'] There are six char values here, but the fourth and sixth are not letters: they’re diacritics that don’t make sense on their own. Finally, if we look at them as grapheme clusters, we’d get what a person would call the four letters that make up the Hindi word: [\"न\", \"म\", \"स्\", \"ते\"] Rust provides different ways of interpreting the raw string data that computers store so that each program can choose the interpretation it needs, no matter what human language the data is in. A final reason Rust doesn’t allow us to index into a String to get a character is that indexing operations are expected to always take constant time (O(1)). But it isn’t possible to guarantee that performance with a String, because Rust would have to walk through the contents from the beginning to the index to determine how many valid characters there were.","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » Indexing into Strings","id":"140","title":"Indexing into Strings"},"141":{"body":"Indexing into a string is often a bad idea because it’s not clear what the return type of the string-indexing operation should be: a byte value, a character, a grapheme cluster, or a string slice. If you really need to use indices to create string slices, therefore, Rust asks you to be more specific. Rather than indexing using [] with a single number, you can use [] with a range to create a string slice containing particular bytes: let hello = \"Здравствуйте\"; let s = &hello[0..4]; Here, s will be a &str that contains the first four bytes of the string. Earlier, we mentioned that each of these characters was two bytes, which means s will be Зд. If we were to try to slice only part of a character’s bytes with something like &hello[0..1], Rust would panic at runtime in the same way as if an invalid index were accessed in a vector: $ cargo run Compiling collections v0.1.0 (file:///projects/collections) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.43s Running `target/debug/collections`\nthread 'main' panicked at src/main.rs:4:19:\nbyte index 1 is not a char boundary; it is inside 'З' (bytes 0..2) of `Здравствуйте`\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace You should use caution when creating string slices with ranges, because doing so can crash your program.","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » Slicing Strings","id":"141","title":"Slicing Strings"},"142":{"body":"The best way to operate on pieces of strings is to be explicit about whether you want characters or bytes. For individual Unicode scalar values, use the chars method. Calling chars on “Зд” separates out and returns two values of type char, and you can iterate over the result to access each element: for c in \"Зд\".chars() { println!(\"{c}\");\n} This code will print the following: З\nд Alternatively, the bytes method returns each raw byte, which might be appropriate for your domain: for b in \"Зд\".bytes() { println!(\"{b}\");\n} This code will print the four bytes that make up this string: 208\n151\n208\n180 But be sure to remember that valid Unicode scalar values may be made up of more than one byte. Getting grapheme clusters from strings, as with the Devanagari script, is complex, so this functionality is not provided by the standard library. Crates are available on crates.io if this is the functionality you need.","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » Methods for Iterating Over Strings","id":"142","title":"Methods for Iterating Over Strings"},"143":{"body":"To summarize, strings are complicated. Different programming languages make different choices about how to present this complexity to the programmer. Rust has chosen to make the correct handling of String data the default behavior for all Rust programs, which means programmers have to put more thought into handling UTF-8 data up front. This trade-off exposes more of the complexity of strings than is apparent in other programming languages, but it prevents you from having to handle errors involving non-ASCII characters later in your development life cycle. The good news is that the standard library offers a lot of functionality built off the String and &str types to help handle these complex situations correctly. Be sure to check out the documentation for useful methods like contains for searching in a string and replace for substituting parts of a string with another string. Let’s switch to something a bit less complex: hash maps!","breadcrumbs":"Common Collections » Storing UTF-8 Encoded Text with Strings » Strings Are Not So Simple","id":"143","title":"Strings Are Not So Simple"},"144":{"body":"The last of our common collections is the hash map . The type HashMap stores a mapping of keys of type K to values of type V using a hashing function , which determines how it places these keys and values into memory. Many programming languages support this kind of data structure, but they often use a different name, such as hash , map , object , hash table , dictionary , or associative array , just to name a few. Hash maps are useful when you want to look up data not by using an index, as you can with vectors, but by using a key that can be of any type. For example, in a game, you could keep track of each team’s score in a hash map in which each key is a team’s name and the values are each team’s score. Given a team name, you can retrieve its score. We’ll go over the basic API of hash maps in this section, but many more goodies are hiding in the functions defined on HashMap by the standard library. As always, check the standard library documentation for more information.","breadcrumbs":"Common Collections » Storing Keys with Associated Values in Hash Maps » Storing Keys with Associated Values in Hash Maps","id":"144","title":"Storing Keys with Associated Values in Hash Maps"},"145":{"body":"One way to create an empty hash map is to use new and to add elements with insert. In Listing 8-20, we’re keeping track of the scores of two teams whose names are Blue and Yellow . The Blue team starts with 10 points, and the Yellow team starts with 50. # fn main() { use std::collections::HashMap; let mut scores = HashMap::new(); scores.insert(String::from(\"Blue\"), 10); scores.insert(String::from(\"Yellow\"), 50);\n# } Listing 8-20: Creating a new hash map and inserting some keys and values Note that we need to first use the HashMap from the collections portion of the standard library. Of our three common collections, this one is the least often used, so it’s not included in the features brought into scope automatically in the prelude. Hash maps also have less support from the standard library; there’s no built-in macro to construct them, for example. Just like vectors, hash maps store their data on the heap. This HashMap has keys of type String and values of type i32. Like vectors, hash maps are homogeneous: all of the keys must have the same type, and all of the values must have the same type.","breadcrumbs":"Common Collections » Storing Keys with Associated Values in Hash Maps » Creating a New Hash Map","id":"145","title":"Creating a New Hash Map"},"146":{"body":"We can get a value out of the hash map by providing its key to the get method, as shown in Listing 8-21. # fn main() { use std::collections::HashMap; let mut scores = HashMap::new(); scores.insert(String::from(\"Blue\"), 10); scores.insert(String::from(\"Yellow\"), 50); let team_name = String::from(\"Blue\"); let score = scores.get(&team_name).copied().unwrap_or(0);\n# } Listing 8-21: Accessing the score for the Blue team stored in the hash map Here, score will have the value that’s associated with the Blue team, and the result will be 10. The get method returns an Option<&V>; if there’s no value for that key in the hash map, get will return None. This program handles the Option by calling copied to get an Option rather than an Option<&i32>, then unwrap_or to set score to zero if scores doesn’t have an entry for the key. We can iterate over each key–value pair in a hash map in a similar manner as we do with vectors, using a for loop: # fn main() { use std::collections::HashMap; let mut scores = HashMap::new(); scores.insert(String::from(\"Blue\"), 10); scores.insert(String::from(\"Yellow\"), 50); for (key, value) in &scores { println!(\"{key}: {value}\"); }\n# } This code will print each pair in an arbitrary order: Yellow: 50\nBlue: 10","breadcrumbs":"Common Collections » Storing Keys with Associated Values in Hash Maps » Accessing Values in a Hash Map","id":"146","title":"Accessing Values in a Hash Map"},"147":{"body":"For types that implement the Copy trait, like i32, the values are copied into the hash map. For owned values like String, the values will be moved and the hash map will be the owner of those values, as demonstrated in Listing 8-22. # fn main() { use std::collections::HashMap; let field_name = String::from(\"Favorite color\"); let field_value = String::from(\"Blue\"); let mut map = HashMap::new(); map.insert(field_name, field_value); // field_name and field_value are invalid at this point, try using them and // see what compiler error you get!\n# } Listing 8-22: Showing that keys and values are owned by the hash map once they’re inserted We aren’t able to use the variables field_name and field_value after they’ve been moved into the hash map with the call to insert. If we insert references to values into the hash map, the values won’t be moved into the hash map. The values that the references point to must be valid for at least as long as the hash map is valid. We’ll talk more about these issues in the “Validating References with Lifetimes” section in Chapter 10.","breadcrumbs":"Common Collections » Storing Keys with Associated Values in Hash Maps » Hash Maps and Ownership","id":"147","title":"Hash Maps and Ownership"},"148":{"body":"Although the number of key and value pairs is growable, each unique key can only have one value associated with it at a time (but not vice versa: for example, both the Blue team and the Yellow team could have the value 10 stored in the scores hash map). When you want to change the data in a hash map, you have to decide how to handle the case when a key already has a value assigned. You could replace the old value with the new value, completely disregarding the old value. You could keep the old value and ignore the new value, only adding the new value if the key doesn’t already have a value. Or you could combine the old value and the new value. Let’s look at how to do each of these! Overwriting a Value If we insert a key and a value into a hash map and then insert that same key with a different value, the value associated with that key will be replaced. Even though the code in Listing 8-23 calls insert twice, the hash map will only contain one key–value pair because we’re inserting the value for the Blue team’s key both times. # fn main() { use std::collections::HashMap; let mut scores = HashMap::new(); scores.insert(String::from(\"Blue\"), 10); scores.insert(String::from(\"Blue\"), 25); println!(\"{scores:?}\");\n# } Listing 8-23: Replacing a value stored with a particular key This code will print {\"Blue\": 25}. The original value of 10 has been overwritten. Adding a Key and Value Only If a Key Isn’t Present It’s common to check whether a particular key already exists in the hash map with a value and then to take the following actions: if the key does exist in the hash map, the existing value should remain the way it is; if the key doesn’t exist, insert it and a value for it. Hash maps have a special API for this called entry that takes the key you want to check as a parameter. The return value of the entry method is an enum called Entry that represents a value that might or might not exist. Let’s say we want to check whether the key for the Yellow team has a value associated with it. If it doesn’t, we want to insert the value 50, and the same for the Blue team. Using the entry API, the code looks like Listing 8-24. # fn main() { use std::collections::HashMap; let mut scores = HashMap::new(); scores.insert(String::from(\"Blue\"), 10); scores.entry(String::from(\"Yellow\")).or_insert(50); scores.entry(String::from(\"Blue\")).or_insert(50); println!(\"{scores:?}\");\n# } Listing 8-24: Using the entry method to only insert if the key does not already have a value The or_insert method on Entry is defined to return a mutable reference to the value for the corresponding Entry key if that key exists, and if not, it inserts the parameter as the new value for this key and returns a mutable reference to the new value. This technique is much cleaner than writing the logic ourselves and, in addition, plays more nicely with the borrow checker. Running the code in Listing 8-24 will print {\"Yellow\": 50, \"Blue\": 10}. The first call to entry will insert the key for the Yellow team with the value 50 because the Yellow team doesn’t have a value already. The second call to entry will not change the hash map because the Blue team already has the value 10. Updating a Value Based on the Old Value Another common use case for hash maps is to look up a key’s value and then update it based on the old value. For instance, Listing 8-25 shows code that counts how many times each word appears in some text. We use a hash map with the words as keys and increment the value to keep track of how many times we’ve seen that word. If it’s the first time we’ve seen a word, we’ll first insert the value 0. # fn main() { use std::collections::HashMap; let text = \"hello world wonderful world\"; let mut map = HashMap::new(); for word in text.split_whitespace() { let count = map.entry(word).or_insert(0); *count += 1; } println!(\"{map:?}\");\n# } Listing 8-25: Counting occurrences of words using a hash map that stores words and counts This code will print {\"world\": 2, \"hello\": 1, \"wonderful\": 1}. You might see the same key–value pairs printed in a different order: recall from the “Accessing Values in a Hash Map” section that iterating over a hash map happens in an arbitrary order. The split_whitespace method returns an iterator over subslices, separated by whitespace, of the value in text. The or_insert method returns a mutable reference (&mut V) to the value for the specified key. Here, we store that mutable reference in the count variable, so in order to assign to that value, we must first dereference count using the asterisk (*). The mutable reference goes out of scope at the end of the for loop, so all of these changes are safe and allowed by the borrowing rules.","breadcrumbs":"Common Collections » Storing Keys with Associated Values in Hash Maps » Updating a Hash Map","id":"148","title":"Updating a Hash Map"},"149":{"body":"By default, HashMap uses a hashing function called SipHash that can provide resistance to denial-of-service (DoS) attacks involving hash tables [1] . This is not the fastest hashing algorithm available, but the trade-off for better security that comes with the drop in performance is worth it. If you profile your code and find that the default hash function is too slow for your purposes, you can switch to another function by specifying a different hasher. A hasher is a type that implements the BuildHasher trait. We’ll talk about traits and how to implement them in Chapter 10 . You don’t necessarily have to implement your own hasher from scratch; crates.io has libraries shared by other Rust users that provide hashers implementing many common hashing algorithms. https://en.wikipedia.org/wiki/SipHash","breadcrumbs":"Common Collections » Storing Keys with Associated Values in Hash Maps » Hashing Functions","id":"149","title":"Hashing Functions"},"15":{"body":"If you’re using Linux or macOS, open a terminal and enter the following command: $ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh The command downloads a script and starts the installation of the rustup tool, which installs the latest stable version of Rust. You might be prompted for your password. If the install is successful, the following line will appear: Rust is installed now. Great! You will also need a linker , which is a program that Rust uses to join its compiled outputs into one file. It is likely you already have one. If you get linker errors, you should install a C compiler, which will typically include a linker. A C compiler is also useful because some common Rust packages depend on C code and will need a C compiler. On macOS, you can get a C compiler by running: $ xcode-select --install Linux users should generally install GCC or Clang, according to their distribution’s documentation. For example, if you use Ubuntu, you can install the build-essential package.","breadcrumbs":"Getting Started » Installation » Installing rustup on Linux or macOS","id":"15","title":"Installing rustup on Linux or macOS"},"150":{"body":"Vectors, strings, and hash maps will provide a large amount of functionality necessary in programs when you need to store, access, and modify data. Here are some exercises you should now be equipped to solve: Given a list of integers, use a vector and return the median (when sorted, the value in the middle position) and mode (the value that occurs most often; a hash map will be helpful here) of the list. Convert strings to pig latin. The first consonant of each word is moved to the end of the word and ay is added, so first becomes irst-fay . Words that start with a vowel have hay added to the end instead ( apple becomes apple-hay ). Keep in mind the details about UTF-8 encoding! Using a hash map and vectors, create a text interface to allow a user to add employee names to a department in a company; for example, “Add Sally to Engineering” or “Add Amir to Sales.” Then let the user retrieve a list of all people in a department or all people in the company by department, sorted alphabetically. The standard library API documentation describes methods that vectors, strings, and hash maps have that will be helpful for these exercises! We’re getting into more complex programs in which operations can fail, so it’s a perfect time to discuss error handling. We’ll do that next!","breadcrumbs":"Common Collections » Storing Keys with Associated Values in Hash Maps » Summary","id":"150","title":"Summary"},"151":{"body":"Errors are a fact of life in software, so Rust has a number of features for handling situations in which something goes wrong. In many cases, Rust requires you to acknowledge the possibility of an error and take some action before your code will compile. This requirement makes your program more robust by ensuring that you’ll discover errors and handle them appropriately before you’ve deployed your code to production! Rust groups errors into two major categories: recoverable and unrecoverable errors. For a recoverable error, such as a file not found error, we most likely just want to report the problem to the user and retry the operation. Unrecoverable errors are always symptoms of bugs, such as trying to access a location beyond the end of an array, and so we want to immediately stop the program. Most languages don’t distinguish between these two kinds of errors and handle both in the same way, using mechanisms such as exceptions. Rust doesn’t have exceptions. Instead, it has the type Result for recoverable errors and the panic! macro that stops execution when the program encounters an unrecoverable error. This chapter covers calling panic! first and then talks about returning Result values. Additionally, we’ll explore considerations when deciding whether to try to recover from an error or to stop execution.","breadcrumbs":"Error Handling » Error Handling","id":"151","title":"Error Handling"},"152":{"body":"Sometimes bad things happen in your code, and there’s nothing you can do about it. In these cases, Rust has the panic! macro. There are two ways to cause a panic in practice: by taking an action that causes our code to panic (such as accessing an array past the end) or by explicitly calling the panic! macro. In both cases, we cause a panic in our program. By default, these panics will print a failure message, unwind, clean up the stack, and quit. Via an environment variable, you can also have Rust display the call stack when a panic occurs to make it easier to track down the source of the panic.","breadcrumbs":"Error Handling » Unrecoverable Errors with panic! » Unrecoverable Errors with panic!","id":"152","title":"Unrecoverable Errors with panic!"},"153":{"body":"By default, when a panic occurs the program starts unwinding , which means Rust walks back up the stack and cleans up the data from each function it encounters. However, walking back and cleaning up is a lot of work. Rust, therefore, allows you to choose the alternative of immediately aborting , which ends the program without cleaning up. Memory that the program was using will then need to be cleaned up by the operating system. If in your project you need to make the resultant binary as small as possible, you can switch from unwinding to aborting upon a panic by adding panic = 'abort' to the appropriate [profile] sections in your Cargo.toml file. For example, if you want to abort on panic in release mode, add this: [profile.release]\npanic = 'abort' Let’s try calling panic! in a simple program: Filename: src/main.rs fn main() { panic!(\"crash and burn\");\n} When you run the program, you’ll see something like this: $ cargo run Compiling panic v0.1.0 (file:///projects/panic) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.25s Running `target/debug/panic`\nthread 'main' panicked at src/main.rs:2:5:\ncrash and burn\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace The call to panic! causes the error message contained in the last two lines. The first line shows our panic message and the place in our source code where the panic occurred: src/main.rs:2:5 indicates that it’s the second line, fifth character of our src/main.rs file. In this case, the line indicated is part of our code, and if we go to that line, we see the panic! macro call. In other cases, the panic! call might be in code that our code calls, and the filename and line number reported by the error message will be someone else’s code where the panic! macro is called, not the line of our code that eventually led to the panic! call. We can use the backtrace of the functions the panic! call came from to figure out the part of our code that is causing the problem. To understand how to use a panic! backtrace, let’s look at another example and see what it’s like when a panic! call comes from a library because of a bug in our code instead of from our code calling the macro directly. Listing 9-1 has some code that attempts to access an index in a vector beyond the range of valid indexes. Filename: src/main.rs fn main() { let v = vec![1, 2, 3]; v[99];\n} Listing 9-1: Attempting to access an element beyond the end of a vector, which will cause a call to panic! Here, we’re attempting to access the 100th element of our vector (which is at index 99 because indexing starts at zero), but the vector has only three elements. In this situation, Rust will panic. Using [] is supposed to return an element, but if you pass an invalid index, there’s no element that Rust could return here that would be correct. In C, attempting to read beyond the end of a data structure is undefined behavior. You might get whatever is at the location in memory that would correspond to that element in the data structure, even though the memory doesn’t belong to that structure. This is called a buffer overread and can lead to security vulnerabilities if an attacker is able to manipulate the index in such a way as to read data they shouldn’t be allowed to that is stored after the data structure. To protect your program from this sort of vulnerability, if you try to read an element at an index that doesn’t exist, Rust will stop execution and refuse to continue. Let’s try it and see: $ cargo run Compiling panic v0.1.0 (file:///projects/panic) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s Running `target/debug/panic`\nthread 'main' panicked at src/main.rs:4:6:\nindex out of bounds: the len is 3 but the index is 99\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace This error points at line 4 of our main.rs where we attempt to access index 99 of the vector in v. The note: line tells us that we can set the RUST_BACKTRACE environment variable to get a backtrace of exactly what happened to cause the error. A backtrace is a list of all the functions that have been called to get to this point. Backtraces in Rust work as they do in other languages: the key to reading the backtrace is to start from the top and read until you see files you wrote. That’s the spot where the problem originated. The lines above that spot are code that your code has called; the lines below are code that called your code. These before-and-after lines might include core Rust code, standard library code, or crates that you’re using. Let’s try getting a backtrace by setting the RUST_BACKTRACE environment variable to any value except 0. Listing 9-2 shows output similar to what you’ll see. $ RUST_BACKTRACE=1 cargo run\nthread 'main' panicked at src/main.rs:4:6:\nindex out of bounds: the len is 3 but the index is 99\nstack backtrace: 0: rust_begin_unwind at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/std/src/panicking.rs:645:5 1: core::panicking::panic_fmt at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/panicking.rs:72:14 2: core::panicking::panic_bounds_check at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/panicking.rs:208:5 3: >::index at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/slice/index.rs:255:10 4: core::slice::index:: for [T]>::index at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/slice/index.rs:18:9 5: as core::ops::index::Index>::index at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/alloc/src/vec/mod.rs:2770:9 6: panic::main at ./src/main.rs:4:6 7: core::ops::function::FnOnce::call_once at /rustc/07dca489ac2d933c78d3c5158e3f43beefeb02ce/library/core/src/ops/function.rs:250:5\nnote: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace. Listing 9-2: The backtrace generated by a call to panic! displayed when the environment variable RUST_BACKTRACE is set That’s a lot of output! The exact output you see might be different depending on your operating system and Rust version. In order to get backtraces with this information, debug symbols must be enabled. Debug symbols are enabled by default when using cargo build or cargo run without the --release flag, as we have here. In the output in Listing 9-2, line 6 of the backtrace points to the line in our project that’s causing the problem: line 4 of src/main.rs . If we don’t want our program to panic, we should start our investigation at the location pointed to by the first line mentioning a file we wrote. In Listing 9-1, where we deliberately wrote code that would panic, the way to fix the panic is to not request an element beyond the range of the vector indexes. When your code panics in the future, you’ll need to figure out what action the code is taking with what values to cause the panic and what the code should do instead. We’ll come back to panic! and when we should and should not use panic! to handle error conditions in the “To panic! or Not to panic!” section later in this chapter. Next, we’ll look at how to recover from an error using Result.","breadcrumbs":"Error Handling » Unrecoverable Errors with panic! » Unwinding the Stack or Aborting in Response to a Panic","id":"153","title":"Unwinding the Stack or Aborting in Response to a Panic"},"154":{"body":"Most errors aren’t serious enough to require the program to stop entirely. Sometimes when a function fails it’s for a reason that you can easily interpret and respond to. For example, if you try to open a file and that operation fails because the file doesn’t exist, you might want to create the file instead of terminating the process. Recall from “Handling Potential Failure with Result” in Chapter 2 that the Result enum is defined as having two variants, Ok and Err, as follows: enum Result { Ok(T), Err(E),\n} The T and E are generic type parameters: we’ll discuss generics in more detail in Chapter 10. What you need to know right now is that T represents the type of the value that will be returned in a success case within the Ok variant, and E represents the type of the error that will be returned in a failure case within the Err variant. Because Result has these generic type parameters, we can use the Result type and the functions defined on it in many different situations where the success value and error value we want to return may differ. Let’s call a function that returns a Result value because the function could fail. In Listing 9-3 we try to open a file. Filename: src/main.rs use std::fs::File; fn main() { let greeting_file_result = File::open(\"hello.txt\");\n} Listing 9-3: Opening a file The return type of File::open is a Result. The generic parameter T has been filled in by the implementation of File::open with the type of the success value, std::fs::File, which is a file handle. The type of E used in the error value is std::io::Error. This return type means the call to File::open might succeed and return a file handle that we can read from or write to. The function call also might fail: for example, the file might not exist, or we might not have permission to access the file. The File::open function needs to have a way to tell us whether it succeeded or failed and at the same time give us either the file handle or error information. This information is exactly what the Result enum conveys. In the case where File::open succeeds, the value in the variable greeting_file_result will be an instance of Ok that contains a file handle. In the case where it fails, the value in greeting_file_result will be an instance of Err that contains more information about the kind of error that occurred. We need to add to the code in Listing 9-3 to take different actions depending on the value File::open returns. Listing 9-4 shows one way to handle the Result using a basic tool, the match expression that we discussed in Chapter 6. Filename: src/main.rs use std::fs::File; fn main() { let greeting_file_result = File::open(\"hello.txt\"); let greeting_file = match greeting_file_result { Ok(file) => file, Err(error) => panic!(\"Problem opening the file: {error:?}\"), };\n} Listing 9-4: Using a match expression to handle the Result variants that might be returned Note that, like the Option enum, the Result enum and its variants have been brought into scope by the prelude, so we don’t need to specify Result:: before the Ok and Err variants in the match arms. When the result is Ok, this code will return the inner file value out of the Ok variant, and we then assign that file handle value to the variable greeting_file. After the match, we can use the file handle for reading or writing. The other arm of the match handles the case where we get an Err value from File::open. In this example, we’ve chosen to call the panic! macro. If there’s no file named hello.txt in our current directory and we run this code, we’ll see the following output from the panic! macro: $ cargo run Compiling error-handling v0.1.0 (file:///projects/error-handling) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.73s Running `target/debug/error-handling`\nthread 'main' panicked at src/main.rs:8:23:\nProblem opening the file: Os { code: 2, kind: NotFound, message: \"No such file or directory\" }\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace As usual, this output tells us exactly what has gone wrong.","breadcrumbs":"Error Handling » Recoverable Errors with Result » Recoverable Errors with Result","id":"154","title":"Recoverable Errors with Result"},"155":{"body":"The code in Listing 9-4 will panic! no matter why File::open failed. However, we want to take different actions for different failure reasons. If File::open failed because the file doesn’t exist, we want to create the file and return the handle to the new file. If File::open failed for any other reason—for example, because we didn’t have permission to open the file—we still want the code to panic! in the same way it did in Listing 9-4. For this, we add an inner match expression, shown in Listing 9-5. Filename: src/main.rs use std::fs::File;\nuse std::io::ErrorKind; fn main() { let greeting_file_result = File::open(\"hello.txt\"); let greeting_file = match greeting_file_result { Ok(file) => file, Err(error) => match error.kind() { ErrorKind::NotFound => match File::create(\"hello.txt\") { Ok(fc) => fc, Err(e) => panic!(\"Problem creating the file: {e:?}\"), }, other_error => { panic!(\"Problem opening the file: {other_error:?}\"); } }, };\n} Listing 9-5: Handling different kinds of errors in different ways The type of the value that File::open returns inside the Err variant is io::Error, which is a struct provided by the standard library. This struct has a method kind that we can call to get an io::ErrorKind value. The enum io::ErrorKind is provided by the standard library and has variants representing the different kinds of errors that might result from an io operation. The variant we want to use is ErrorKind::NotFound, which indicates the file we’re trying to open doesn’t exist yet. So we match on greeting_file_result, but we also have an inner match on error.kind(). The condition we want to check in the inner match is whether the value returned by error.kind() is the NotFound variant of the ErrorKind enum. If it is, we try to create the file with File::create. However, because File::create could also fail, we need a second arm in the inner match expression. When the file can’t be created, a different error message is printed. The second arm of the outer match stays the same, so the program panics on any error besides the missing file error. Alternatives to Using match with Result That’s a lot of match! The match expression is very useful but also very much a primitive. In Chapter 13, you’ll learn about closures, which are used with many of the methods defined on Result. These methods can be more concise than using match when handling Result values in your code. For example, here’s another way to write the same logic as shown in Listing 9-5, this time using closures and the unwrap_or_else method: use std::fs::File;\nuse std::io::ErrorKind; fn main() { let greeting_file = File::open(\"hello.txt\").unwrap_or_else(|error| { if error.kind() == ErrorKind::NotFound { File::create(\"hello.txt\").unwrap_or_else(|error| { panic!(\"Problem creating the file: {error:?}\"); }) } else { panic!(\"Problem opening the file: {error:?}\"); } });\n} Although this code has the same behavior as Listing 9-5, it doesn’t contain any match expressions and is cleaner to read. Come back to this example after you’ve read Chapter 13, and look up the unwrap_or_else method in the standard library documentation. Many more of these methods can clean up huge nested match expressions when you’re dealing with errors. Shortcuts for Panic on Error: unwrap and expect Using match works well enough, but it can be a bit verbose and doesn’t always communicate intent well. The Result type has many helper methods defined on it to do various, more specific tasks. The unwrap method is a shortcut method implemented just like the match expression we wrote in Listing 9-4. If the Result value is the Ok variant, unwrap will return the value inside the Ok. If the Result is the Err variant, unwrap will call the panic! macro for us. Here is an example of unwrap in action: Filename: src/main.rs use std::fs::File; fn main() { let greeting_file = File::open(\"hello.txt\").unwrap();\n} If we run this code without a hello.txt file, we’ll see an error message from the panic! call that the unwrap method makes: thread 'main' panicked at src/main.rs:4:49:\ncalled `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: \"No such file or directory\" } Similarly, the expect method lets us also choose the panic! error message. Using expect instead of unwrap and providing good error messages can convey your intent and make tracking down the source of a panic easier. The syntax of expect looks like this: Filename: src/main.rs use std::fs::File; fn main() { let greeting_file = File::open(\"hello.txt\") .expect(\"hello.txt should be included in this project\");\n} We use expect in the same way as unwrap: to return the file handle or call the panic! macro. The error message used by expect in its call to panic! will be the parameter that we pass to expect, rather than the default panic! message that unwrap uses. Here’s what it looks like: thread 'main' panicked at src/main.rs:5:10:\nhello.txt should be included in this project: Os { code: 2, kind: NotFound, message: \"No such file or directory\" } In production-quality code, most Rustaceans choose expect rather than unwrap and give more context about why the operation is expected to always succeed. That way, if your assumptions are ever proven wrong, you have more information to use in debugging.","breadcrumbs":"Error Handling » Recoverable Errors with Result » Matching on Different Errors","id":"155","title":"Matching on Different Errors"},"156":{"body":"When a function’s implementation calls something that might fail, instead of handling the error within the function itself you can return the error to the calling code so that it can decide what to do. This is known as propagating the error and gives more control to the calling code, where there might be more information or logic that dictates how the error should be handled than what you have available in the context of your code. For example, Listing 9-6 shows a function that reads a username from a file. If the file doesn’t exist or can’t be read, this function will return those errors to the code that called the function. Filename: src/main.rs use std::fs::File;\nuse std::io::{self, Read}; fn read_username_from_file() -> Result { let username_file_result = File::open(\"hello.txt\"); let mut username_file = match username_file_result { Ok(file) => file, Err(e) => return Err(e), }; let mut username = String::new(); match username_file.read_to_string(&mut username) { Ok(_) => Ok(username), Err(e) => Err(e), }\n} Listing 9-6: A function that returns errors to the calling code using match This function can be written in a much shorter way, but we’re going to start by doing a lot of it manually in order to explore error handling; at the end, we’ll show the shorter way. Let’s look at the return type of the function first: Result. This means the function is returning a value of the type Result, where the generic parameter T has been filled in with the concrete type String and the generic type E has been filled in with the concrete type io::Error. If this function succeeds without any problems, the code that calls this function will receive an Ok value that holds a String—the username that this function read from the file. If this function encounters any problems, the calling code will receive an Err value that holds an instance of io::Error that contains more information about what the problems were. We chose io::Error as the return type of this function because that happens to be the type of the error value returned from both of the operations we’re calling in this function’s body that might fail: the File::open function and the read_to_string method. The body of the function starts by calling the File::open function. Then we handle the Result value with a match similar to the match in Listing 9-4. If File::open succeeds, the file handle in the pattern variable file becomes the value in the mutable variable username_file and the function continues. In the Err case, instead of calling panic!, we use the return keyword to return early out of the function entirely and pass the error value from File::open, now in the pattern variable e, back to the calling code as this function’s error value. So, if we have a file handle in username_file, the function then creates a new String in variable username and calls the read_to_string method on the file handle in username_file to read the contents of the file into username. The read_to_string method also returns a Result because it might fail, even though File::open succeeded. So we need another match to handle that Result: if read_to_string succeeds, then our function has succeeded, and we return the username from the file that’s now in username wrapped in an Ok. If read_to_string fails, we return the error value in the same way that we returned the error value in the match that handled the return value of File::open. However, we don’t need to explicitly say return, because this is the last expression in the function. The code that calls this code will then handle getting either an Ok value that contains a username or an Err value that contains an io::Error. It’s up to the calling code to decide what to do with those values. If the calling code gets an Err value, it could call panic! and crash the program, use a default username, or look up the username from somewhere other than a file, for example. We don’t have enough information on what the calling code is actually trying to do, so we propagate all the success or error information upward for it to handle appropriately. This pattern of propagating errors is so common in Rust that Rust provides the question mark operator ? to make this easier. A Shortcut for Propagating Errors: the ? Operator Listing 9-7 shows an implementation of read_username_from_file that has the same functionality as in Listing 9-6, but this implementation uses the ? operator. Filename: src/main.rs use std::fs::File;\nuse std::io::{self, Read}; fn read_username_from_file() -> Result { let mut username_file = File::open(\"hello.txt\")?; let mut username = String::new(); username_file.read_to_string(&mut username)?; Ok(username)\n} Listing 9-7: A function that returns errors to the calling code using the ? operator The ? placed after a Result value is defined to work in almost the same way as the match expressions we defined to handle the Result values in Listing 9-6. If the value of the Result is an Ok, the value inside the Ok will get returned from this expression, and the program will continue. If the value is an Err, the Err will be returned from the whole function as if we had used the return keyword so the error value gets propagated to the calling code. There is a difference between what the match expression from Listing 9-6 does and what the ? operator does: error values that have the ? operator called on them go through the from function, defined in the From trait in the standard library, which is used to convert values from one type into another. When the ? operator calls the from function, the error type received is converted into the error type defined in the return type of the current function. This is useful when a function returns one error type to represent all the ways a function might fail, even if parts might fail for many different reasons. For example, we could change the read_username_from_file function in Listing 9-7 to return a custom error type named OurError that we define. If we also define impl From for OurError to construct an instance of OurError from an io::Error, then the ? operator calls in the body of read_username_from_file will call from and convert the error types without needing to add any more code to the function. In the context of Listing 9-7, the ? at the end of the File::open call will return the value inside an Ok to the variable username_file. If an error occurs, the ? operator will return early out of the whole function and give any Err value to the calling code. The same thing applies to the ? at the end of the read_to_string call. The ? operator eliminates a lot of boilerplate and makes this function’s implementation simpler. We could even shorten this code further by chaining method calls immediately after the ?, as shown in Listing 9-8. Filename: src/main.rs use std::fs::File;\nuse std::io::{self, Read}; fn read_username_from_file() -> Result { let mut username = String::new(); File::open(\"hello.txt\")?.read_to_string(&mut username)?; Ok(username)\n} Listing 9-8: Chaining method calls after the ? operator We’ve moved the creation of the new String in username to the beginning of the function; that part hasn’t changed. Instead of creating a variable username_file, we’ve chained the call to read_to_string directly onto the result of File::open(\"hello.txt\")?. We still have a ? at the end of the read_to_string call, and we still return an Ok value containing username when both File::open and read_to_string succeed rather than returning errors. The functionality is again the same as in Listing 9-6 and Listing 9-7; this is just a different, more ergonomic way to write it. Listing 9-9 shows a way to make this even shorter using fs::read_to_string. Filename: src/main.rs use std::fs;\nuse std::io; fn read_username_from_file() -> Result { fs::read_to_string(\"hello.txt\")\n} Listing 9-9: Using fs::read_to_string instead of opening and then reading the file Reading a file into a string is a fairly common operation, so the standard library provides the convenient fs::read_to_string function that opens the file, creates a new String, reads the contents of the file, puts the contents into that String, and returns it. Of course, using fs::read_to_string doesn’t give us the opportunity to explain all the error handling, so we did it the longer way first. Where The ? Operator Can Be Used The ? operator can only be used in functions whose return type is compatible with the value the ? is used on. This is because the ? operator is defined to perform an early return of a value out of the function, in the same manner as the match expression we defined in Listing 9-6. In Listing 9-6, the match was using a Result value, and the early return arm returned an Err(e) value. The return type of the function has to be a Result so that it’s compatible with this return. In Listing 9-10, let’s look at the error we’ll get if we use the ? operator in a main function with a return type that is incompatible with the type of the value we use ? on. Filename: src/main.rs use std::fs::File; fn main() { let greeting_file = File::open(\"hello.txt\")?;\n} Listing 9-10: Attempting to use the ? in the main function that returns () won’t compile. This code opens a file, which might fail. The ? operator follows the Result value returned by File::open, but this main function has the return type of (), not Result. When we compile this code, we get the following error message: $ cargo run Compiling error-handling v0.1.0 (file:///projects/error-handling)\nerror[E0277]: the `?` operator can only be used in a function that returns `Result` or `Option` (or another type that implements `FromResidual`) --> src/main.rs:4:48 |\n3 | fn main() { | --------- this function should return `Result` or `Option` to accept `?`\n4 | let greeting_file = File::open(\"hello.txt\")?; | ^ cannot use the `?` operator in a function that returns `()` | = help: the trait `FromResidual>` is not implemented for `()` For more information about this error, try `rustc --explain E0277`.\nerror: could not compile `error-handling` (bin \"error-handling\") due to 1 previous error This error points out that we’re only allowed to use the ? operator in a function that returns Result, Option, or another type that implements FromResidual. To fix the error, you have two choices. One choice is to change the return type of your function to be compatible with the value you’re using the ? operator on as long as you have no restrictions preventing that. The other choice is to use a match or one of the Result methods to handle the Result in whatever way is appropriate. The error message also mentioned that ? can be used with Option values as well. As with using ? on Result, you can only use ? on Option in a function that returns an Option. The behavior of the ? operator when called on an Option is similar to its behavior when called on a Result: if the value is None, the None will be returned early from the function at that point. If the value is Some, the value inside the Some is the resultant value of the expression, and the function continues. Listing 9-11 has an example of a function that finds the last character of the first line in the given text. fn last_char_of_first_line(text: &str) -> Option { text.lines().next()?.chars().last()\n}\n# # fn main() {\n# assert_eq!(\n# last_char_of_first_line(\"Hello, world\\nHow are you today?\"),\n# Some('d')\n# );\n# # assert_eq!(last_char_of_first_line(\"\"), None);\n# assert_eq!(last_char_of_first_line(\"\\nhi\"), None);\n# } Listing 9-11: Using the ? operator on an Option value This function returns Option because it’s possible that there is a character there, but it’s also possible that there isn’t. This code takes the text string slice argument and calls the lines method on it, which returns an iterator over the lines in the string. Because this function wants to examine the first line, it calls next on the iterator to get the first value from the iterator. If text is the empty string, this call to next will return None, in which case we use ? to stop and return None from last_char_of_first_line. If text is not the empty string, next will return a Some value containing a string slice of the first line in text. The ? extracts the string slice, and we can call chars on that string slice to get an iterator of its characters. We’re interested in the last character in this first line, so we call last to return the last item in the iterator. This is an Option because it’s possible that the first line is the empty string; for example, if text starts with a blank line but has characters on other lines, as in \"\\nhi\". However, if there is a last character on the first line, it will be returned in the Some variant. The ? operator in the middle gives us a concise way to express this logic, allowing us to implement the function in one line. If we couldn’t use the ? operator on Option, we’d have to implement this logic using more method calls or a match expression. Note that you can use the ? operator on a Result in a function that returns Result, and you can use the ? operator on an Option in a function that returns Option, but you can’t mix and match. The ? operator won’t automatically convert a Result to an Option or vice versa; in those cases, you can use methods like the ok method on Result or the ok_or method on Option to do the conversion explicitly. So far, all the main functions we’ve used return (). The main function is special because it’s the entry point and exit point of an executable program, and there are restrictions on what its return type can be for the program to behave as expected. Luckily, main can also return a Result<(), E>. Listing 9-12 has the code from Listing 9-10, but we’ve changed the return type of main to be Result<(), Box> and added a return value Ok(()) to the end. This code will now compile. Filename: src/main.rs use std::error::Error;\nuse std::fs::File; fn main() -> Result<(), Box> { let greeting_file = File::open(\"hello.txt\")?; Ok(())\n} Listing 9-12: Changing main to return Result<(), E> allows the use of the ? operator on Result values. The Box type is a trait object , which we’ll talk about in the “Using Trait Objects that Allow for Values of Different Types” section in Chapter 17. For now, you can read Box to mean “any kind of error.” Using ? on a Result value in a main function with the error type Box is allowed because it allows any Err value to be returned early. Even though the body of this main function will only ever return errors of type std::io::Error, by specifying Box, this signature will continue to be correct even if more code that returns other errors is added to the body of main. When a main function returns a Result<(), E>, the executable will exit with a value of 0 if main returns Ok(()) and will exit with a nonzero value if main returns an Err value. Executables written in C return integers when they exit: programs that exit successfully return the integer 0, and programs that error return some integer other than 0. Rust also returns integers from executables to be compatible with this convention. The main function may return any types that implement the std::process::Termination trait , which contains a function report that returns an ExitCode. Consult the standard library documentation for more information on implementing the Termination trait for your own types. Now that we’ve discussed the details of calling panic! or returning Result, let’s return to the topic of how to decide which is appropriate to use in which cases.","breadcrumbs":"Error Handling » Recoverable Errors with Result » Propagating Errors","id":"156","title":"Propagating Errors"},"157":{"body":"So how do you decide when you should call panic! and when you should return Result? When code panics, there’s no way to recover. You could call panic! for any error situation, whether there’s a possible way to recover or not, but then you’re making the decision that a situation is unrecoverable on behalf of the calling code. When you choose to return a Result value, you give the calling code options. The calling code could choose to attempt to recover in a way that’s appropriate for its situation, or it could decide that an Err value in this case is unrecoverable, so it can call panic! and turn your recoverable error into an unrecoverable one. Therefore, returning Result is a good default choice when you’re defining a function that might fail. In situations such as examples, prototype code, and tests, it’s more appropriate to write code that panics instead of returning a Result. Let’s explore why, then discuss situations in which the compiler can’t tell that failure is impossible, but you as a human can. The chapter will conclude with some general guidelines on how to decide whether to panic in library code.","breadcrumbs":"Error Handling » To panic! or Not to panic! » To panic! or Not to panic!","id":"157","title":"To panic! or Not to panic!"},"158":{"body":"When you’re writing an example to illustrate some concept, also including robust error-handling code can make the example less clear. In examples, it’s understood that a call to a method like unwrap that could panic is meant as a placeholder for the way you’d want your application to handle errors, which can differ based on what the rest of your code is doing. Similarly, the unwrap and expect methods are very handy when prototyping, before you’re ready to decide how to handle errors. They leave clear markers in your code for when you’re ready to make your program more robust. If a method call fails in a test, you’d want the whole test to fail, even if that method isn’t the functionality under test. Because panic! is how a test is marked as a failure, calling unwrap or expect is exactly what should happen.","breadcrumbs":"Error Handling » To panic! or Not to panic! » Examples, Prototype Code, and Tests","id":"158","title":"Examples, Prototype Code, and Tests"},"159":{"body":"It would also be appropriate to call unwrap or expect when you have some other logic that ensures the Result will have an Ok value, but the logic isn’t something the compiler understands. You’ll still have a Result value that you need to handle: whatever operation you’re calling still has the possibility of failing in general, even though it’s logically impossible in your particular situation. If you can ensure by manually inspecting the code that you’ll never have an Err variant, it’s perfectly acceptable to call unwrap, and even better to document the reason you think you’ll never have an Err variant in the expect text. Here’s an example: # fn main() { use std::net::IpAddr; let home: IpAddr = \"127.0.0.1\" .parse() .expect(\"Hardcoded IP address should be valid\");\n# } We’re creating an IpAddr instance by parsing a hardcoded string. We can see that 127.0.0.1 is a valid IP address, so it’s acceptable to use expect here. However, having a hardcoded, valid string doesn’t change the return type of the parse method: we still get a Result value, and the compiler will still make us handle the Result as if the Err variant is a possibility because the compiler isn’t smart enough to see that this string is always a valid IP address. If the IP address string came from a user rather than being hardcoded into the program and therefore did have a possibility of failure, we’d definitely want to handle the Result in a more robust way instead. Mentioning the assumption that this IP address is hardcoded will prompt us to change expect to better error-handling code if, in the future, we need to get the IP address from some other source instead.","breadcrumbs":"Error Handling » To panic! or Not to panic! » Cases in Which You Have More Information Than the Compiler","id":"159","title":"Cases in Which You Have More Information Than the Compiler"},"16":{"body":"On Windows, go to https://www.rust-lang.org/tools/install and follow the instructions for installing Rust. At some point in the installation, you’ll be prompted to install Visual Studio. This provides a linker and the native libraries needed to compile programs. If you need more help with this step, see https://rust-lang.github.io/rustup/installation/windows-msvc.html The rest of this book uses commands that work in both cmd.exe and PowerShell. If there are specific differences, we’ll explain which to use.","breadcrumbs":"Getting Started » Installation » Installing rustup on Windows","id":"16","title":"Installing rustup on Windows"},"160":{"body":"It’s advisable to have your code panic when it’s possible that your code could end up in a bad state. In this context, a bad state is when some assumption, guarantee, contract, or invariant has been broken, such as when invalid values, contradictory values, or missing values are passed to your code—plus one or more of the following: The bad state is something that is unexpected, as opposed to something that will likely happen occasionally, like a user entering data in the wrong format. Your code after this point needs to rely on not being in this bad state, rather than checking for the problem at every step. There’s not a good way to encode this information in the types you use. We’ll work through an example of what we mean in the “Encoding States and Behavior as Types” section of Chapter 17. If someone calls your code and passes in values that don’t make sense, it’s best to return an error if you can so the user of the library can decide what they want to do in that case. However, in cases where continuing could be insecure or harmful, the best choice might be to call panic! and alert the person using your library to the bug in their code so they can fix it during development. Similarly, panic! is often appropriate if you’re calling external code that is out of your control and it returns an invalid state that you have no way of fixing. However, when failure is expected, it’s more appropriate to return a Result than to make a panic! call. Examples include a parser being given malformed data or an HTTP request returning a status that indicates you have hit a rate limit. In these cases, returning a Result indicates that failure is an expected possibility that the calling code must decide how to handle. When your code performs an operation that could put a user at risk if it’s called using invalid values, your code should verify the values are valid first and panic if the values aren’t valid. This is mostly for safety reasons: attempting to operate on invalid data can expose your code to vulnerabilities. This is the main reason the standard library will call panic! if you attempt an out-of-bounds memory access: trying to access memory that doesn’t belong to the current data structure is a common security problem. Functions often have contracts : their behavior is only guaranteed if the inputs meet particular requirements. Panicking when the contract is violated makes sense because a contract violation always indicates a caller-side bug, and it’s not a kind of error you want the calling code to have to explicitly handle. In fact, there’s no reasonable way for calling code to recover; the calling programmers need to fix the code. Contracts for a function, especially when a violation will cause a panic, should be explained in the API documentation for the function. However, having lots of error checks in all of your functions would be verbose and annoying. Fortunately, you can use Rust’s type system (and thus the type checking done by the compiler) to do many of the checks for you. If your function has a particular type as a parameter, you can proceed with your code’s logic knowing that the compiler has already ensured you have a valid value. For example, if you have a type rather than an Option, your program expects to have something rather than nothing . Your code then doesn’t have to handle two cases for the Some and None variants: it will only have one case for definitely having a value. Code trying to pass nothing to your function won’t even compile, so your function doesn’t have to check for that case at runtime. Another example is using an unsigned integer type such as u32, which ensures the parameter is never negative.","breadcrumbs":"Error Handling » To panic! or Not to panic! » Guidelines for Error Handling","id":"160","title":"Guidelines for Error Handling"},"161":{"body":"Let’s take the idea of using Rust’s type system to ensure we have a valid value one step further and look at creating a custom type for validation. Recall the guessing game in Chapter 2 in which our code asked the user to guess a number between 1 and 100. We never validated that the user’s guess was between those numbers before checking it against our secret number; we only validated that the guess was positive. In this case, the consequences were not very dire: our output of “Too high” or “Too low” would still be correct. But it would be a useful enhancement to guide the user toward valid guesses and have different behavior when the user guesses a number that’s out of range versus when the user types, for example, letters instead. One way to do this would be to parse the guess as an i32 instead of only a u32 to allow potentially negative numbers, and then add a check for the number being in range, like so: Filename: src/main.rs # use rand::Rng;\n# use std::cmp::Ordering;\n# use std::io;\n# # fn main() {\n# println!(\"Guess the number!\");\n# # let secret_number = rand::thread_rng().gen_range(1..=100);\n# loop { // --snip-- # println!(\"Please input your guess.\");\n# # let mut guess = String::new();\n# # io::stdin()\n# .read_line(&mut guess)\n# .expect(\"Failed to read line\");\n# let guess: i32 = match guess.trim().parse() { Ok(num) => num, Err(_) => continue, }; if guess < 1 || guess > 100 { println!(\"The secret number will be between 1 and 100.\"); continue; } match guess.cmp(&secret_number) { // --snip--\n# Ordering::Less => println!(\"Too small!\"),\n# Ordering::Greater => println!(\"Too big!\"),\n# Ordering::Equal => {\n# println!(\"You win!\");\n# break;\n# }\n# } }\n# } The if expression checks whether our value is out of range, tells the user about the problem, and calls continue to start the next iteration of the loop and ask for another guess. After the if expression, we can proceed with the comparisons between guess and the secret number knowing that guess is between 1 and 100. However, this is not an ideal solution: if it were absolutely critical that the program only operated on values between 1 and 100, and it had many functions with this requirement, having a check like this in every function would be tedious (and might impact performance). Instead, we can make a new type and put the validations in a function to create an instance of the type rather than repeating the validations everywhere. That way, it’s safe for functions to use the new type in their signatures and confidently use the values they receive. Listing 9-13 shows one way to define a Guess type that will only create an instance of Guess if the new function receives a value between 1 and 100. Filename: src/lib.rs pub struct Guess { value: i32,\n} impl Guess { pub fn new(value: i32) -> Guess { if value < 1 || value > 100 { panic!(\"Guess value must be between 1 and 100, got {value}.\"); } Guess { value } } pub fn value(&self) -> i32 { self.value }\n} Listing 9-13: A Guess type that will only continue with values between 1 and 100 First we define a struct named Guess that has a field named value that holds an i32. This is where the number will be stored. Then we implement an associated function named new on Guess that creates instances of Guess values. The new function is defined to have one parameter named value of type i32 and to return a Guess. The code in the body of the new function tests value to make sure it’s between 1 and 100. If value doesn’t pass this test, we make a panic! call, which will alert the programmer who is writing the calling code that they have a bug they need to fix, because creating a Guess with a value outside this range would violate the contract that Guess::new is relying on. The conditions in which Guess::new might panic should be discussed in its public-facing API documentation; we’ll cover documentation conventions indicating the possibility of a panic! in the API documentation that you create in Chapter 14. If value does pass the test, we create a new Guess with its value field set to the value parameter and return the Guess. Next, we implement a method named value that borrows self, doesn’t have any other parameters, and returns an i32. This kind of method is sometimes called a getter because its purpose is to get some data from its fields and return it. This public method is necessary because the value field of the Guess struct is private. It’s important that the value field be private so code using the Guess struct is not allowed to set value directly: code outside the module must use the Guess::new function to create an instance of Guess, thereby ensuring there’s no way for a Guess to have a value that hasn’t been checked by the conditions in the Guess::new function. A function that has a parameter or returns only numbers between 1 and 100 could then declare in its signature that it takes or returns a Guess rather than an i32 and wouldn’t need to do any additional checks in its body.","breadcrumbs":"Error Handling » To panic! or Not to panic! » Creating Custom Types for Validation","id":"161","title":"Creating Custom Types for Validation"},"162":{"body":"Rust’s error-handling features are designed to help you write more robust code. The panic! macro signals that your program is in a state it can’t handle and lets you tell the process to stop instead of trying to proceed with invalid or incorrect values. The Result enum uses Rust’s type system to indicate that operations might fail in a way that your code could recover from. You can use Result to tell code that calls your code that it needs to handle potential success or failure as well. Using panic! and Result in the appropriate situations will make your code more reliable in the face of inevitable problems. Now that you’ve seen useful ways that the standard library uses generics with the Option and Result enums, we’ll talk about how generics work and how you can use them in your code.","breadcrumbs":"Error Handling » To panic! or Not to panic! » Summary","id":"162","title":"Summary"},"163":{"body":"Every programming language has tools for effectively handling the duplication of concepts. In Rust, one such tool is generics : abstract stand-ins for concrete types or other properties. We can express the behavior of generics or how they relate to other generics without knowing what will be in their place when compiling and running the code. Functions can take parameters of some generic type, instead of a concrete type like i32 or String, in the same way they take parameters with unknown values to run the same code on multiple concrete values. In fact, we’ve already used generics in Chapter 6 with Option, in Chapter 8 with Vec and HashMap, and in Chapter 9 with Result. In this chapter, you’ll explore how to define your own types, functions, and methods with generics! First we’ll review how to extract a function to reduce code duplication. We’ll then use the same technique to make a generic function from two functions that differ only in the types of their parameters. We’ll also explain how to use generic types in struct and enum definitions. Then you’ll learn how to use traits to define behavior in a generic way. You can combine traits with generic types to constrain a generic type to accept only those types that have a particular behavior, as opposed to just any type. Finally, we’ll discuss lifetimes : a variety of generics that give the compiler information about how references relate to each other. Lifetimes allow us to give the compiler enough information about borrowed values so that it can ensure references will be valid in more situations than it could without our help.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Generic Types, Traits, and Lifetimes","id":"163","title":"Generic Types, Traits, and Lifetimes"},"164":{"body":"Generics allow us to replace specific types with a placeholder that represents multiple types to remove code duplication. Before diving into generics syntax, let’s first look at how to remove duplication in a way that doesn’t involve generic types by extracting a function that replaces specific values with a placeholder that represents multiple values. Then we’ll apply the same technique to extract a generic function! By looking at how to recognize duplicated code you can extract into a function, you’ll start to recognize duplicated code that can use generics. We’ll begin with the short program in Listing 10-1 that finds the largest number in a list. Filename: src/main.rs fn main() { let number_list = vec![34, 50, 25, 100, 65]; let mut largest = &number_list[0]; for number in &number_list { if number > largest { largest = number; } } println!(\"The largest number is {largest}\");\n# assert_eq!(*largest, 100);\n} Listing 10-1: Finding the largest number in a list of numbers We store a list of integers in the variable number_list and place a reference to the first number in the list in a variable named largest. We then iterate through all the numbers in the list, and if the current number is greater than the number stored in largest, we replace the reference in that variable. However, if the current number is less than or equal to the largest number seen so far, the variable doesn’t change, and the code moves on to the next number in the list. After considering all the numbers in the list, largest should refer to the largest number, which in this case is 100. We’ve now been tasked with finding the largest number in two different lists of numbers. To do so, we can choose to duplicate the code in Listing 10-1 and use the same logic at two different places in the program, as shown in Listing 10-2. Filename: src/main.rs fn main() { let number_list = vec![34, 50, 25, 100, 65]; let mut largest = &number_list[0]; for number in &number_list { if number > largest { largest = number; } } println!(\"The largest number is {largest}\"); let number_list = vec![102, 34, 6000, 89, 54, 2, 43, 8]; let mut largest = &number_list[0]; for number in &number_list { if number > largest { largest = number; } } println!(\"The largest number is {largest}\");\n} Listing 10-2: Code to find the largest number in two lists of numbers Although this code works, duplicating code is tedious and error prone. We also have to remember to update the code in multiple places when we want to change it. To eliminate this duplication, we’ll create an abstraction by defining a function that operates on any list of integers passed in as a parameter. This solution makes our code clearer and lets us express the concept of finding the largest number in a list abstractly. In Listing 10-3, we extract the code that finds the largest number into a function named largest. Then we call the function to find the largest number in the two lists from Listing 10-2. We could also use the function on any other list of i32 values we might have in the future. Filename: src/main.rs fn largest(list: &[i32]) -> &i32 { let mut largest = &list[0]; for item in list { if item > largest { largest = item; } } largest\n} fn main() { let number_list = vec![34, 50, 25, 100, 65]; let result = largest(&number_list); println!(\"The largest number is {result}\");\n# assert_eq!(*result, 100); let number_list = vec![102, 34, 6000, 89, 54, 2, 43, 8]; let result = largest(&number_list); println!(\"The largest number is {result}\");\n# assert_eq!(*result, 6000);\n} Listing 10-3: Abstracted code to find the largest number in two lists The largest function has a parameter called list, which represents any concrete slice of i32 values we might pass into the function. As a result, when we call the function, the code runs on the specific values that we pass in. In summary, here are the steps we took to change the code from Listing 10-2 to Listing 10-3: Identify duplicate code. Extract the duplicate code into the body of the function, and specify the inputs and return values of that code in the function signature. Update the two instances of duplicated code to call the function instead. Next, we’ll use these same steps with generics to reduce code duplication. In the same way that the function body can operate on an abstract list instead of specific values, generics allow code to operate on abstract types. For example, say we had two functions: one that finds the largest item in a slice of i32 values and one that finds the largest item in a slice of char values. How would we eliminate that duplication? Let’s find out!","breadcrumbs":"Generic Types, Traits, and Lifetimes » Removing Duplication by Extracting a Function","id":"164","title":"Removing Duplication by Extracting a Function"},"165":{"body":"We use generics to create definitions for items like function signatures or structs, which we can then use with many different concrete data types. Let’s first look at how to define functions, structs, enums, and methods using generics. Then we’ll discuss how generics affect code performance.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Generic Data Types » Generic Data Types","id":"165","title":"Generic Data Types"},"166":{"body":"When defining a function that uses generics, we place the generics in the signature of the function where we would usually specify the data types of the parameters and return value. Doing so makes our code more flexible and provides more functionality to callers of our function while preventing code duplication. Continuing with our largest function, Listing 10-4 shows two functions that both find the largest value in a slice. We’ll then combine these into a single function that uses generics. Filename: src/main.rs fn largest_i32(list: &[i32]) -> &i32 { let mut largest = &list[0]; for item in list { if item > largest { largest = item; } } largest\n} fn largest_char(list: &[char]) -> &char { let mut largest = &list[0]; for item in list { if item > largest { largest = item; } } largest\n} fn main() { let number_list = vec![34, 50, 25, 100, 65]; let result = largest_i32(&number_list); println!(\"The largest number is {result}\");\n# assert_eq!(*result, 100); let char_list = vec!['y', 'm', 'a', 'q']; let result = largest_char(&char_list); println!(\"The largest char is {result}\");\n# assert_eq!(*result, 'y');\n} Listing 10-4: Two functions that differ only in their names and in the types in their signatures The largest_i32 function is the one we extracted in Listing 10-3 that finds the largest i32 in a slice. The largest_char function finds the largest char in a slice. The function bodies have the same code, so let’s eliminate the duplication by introducing a generic type parameter in a single function. To parameterize the types in a new single function, we need to name the type parameter, just as we do for the value parameters to a function. You can use any identifier as a type parameter name. But we’ll use T because, by convention, type parameter names in Rust are short, often just one letter, and Rust’s type-naming convention is UpperCamelCase. Short for type , T is the default choice of most Rust programmers. When we use a parameter in the body of the function, we have to declare the parameter name in the signature so the compiler knows what that name means. Similarly, when we use a type parameter name in a function signature, we have to declare the type parameter name before we use it. To define the generic largest function, we place type name declarations inside angle brackets, <>, between the name of the function and the parameter list, like this: fn largest(list: &[T]) -> &T { We read this definition as: the function largest is generic over some type T. This function has one parameter named list, which is a slice of values of type T. The largest function will return a reference to a value of the same type T. Listing 10-5 shows the combined largest function definition using the generic data type in its signature. The listing also shows how we can call the function with either a slice of i32 values or char values. Note that this code won’t compile yet, but we’ll fix it later in this chapter. Filename: src/main.rs fn largest(list: &[T]) -> &T { let mut largest = &list[0]; for item in list { if item > largest { largest = item; } } largest\n} fn main() { let number_list = vec![34, 50, 25, 100, 65]; let result = largest(&number_list); println!(\"The largest number is {result}\"); let char_list = vec!['y', 'm', 'a', 'q']; let result = largest(&char_list); println!(\"The largest char is {result}\");\n} Listing 10-5: The largest function using generic type parameters; this doesn’t compile yet If we compile this code right now, we’ll get this error: $ cargo run Compiling chapter10 v0.1.0 (file:///projects/chapter10)\nerror[E0369]: binary operation `>` cannot be applied to type `&T` --> src/main.rs:5:17 |\n5 | if item > largest { | ---- ^ ------- &T | | | &T |\nhelp: consider restricting type parameter `T` |\n1 | fn largest(list: &[T]) -> &T { | ++++++++++++++++++++++ For more information about this error, try `rustc --explain E0369`.\nerror: could not compile `chapter10` (bin \"chapter10\") due to 1 previous error The help text mentions std::cmp::PartialOrd, which is a trait , and we’re going to talk about traits in the next section. For now, know that this error states that the body of largest won’t work for all possible types that T could be. Because we want to compare values of type T in the body, we can only use types whose values can be ordered. To enable comparisons, the standard library has the std::cmp::PartialOrd trait that you can implement on types (see Appendix C for more on this trait). By following the help text’s suggestion, we restrict the types valid for T to only those that implement PartialOrd and this example will compile, because the standard library implements PartialOrd on both i32 and char.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Generic Data Types » In Function Definitions","id":"166","title":"In Function Definitions"},"167":{"body":"We can also define structs to use a generic type parameter in one or more fields using the <> syntax. Listing 10-6 defines a Point struct to hold x and y coordinate values of any type. Filename: src/main.rs struct Point { x: T, y: T,\n} fn main() { let integer = Point { x: 5, y: 10 }; let float = Point { x: 1.0, y: 4.0 };\n} Listing 10-6: A Point struct that holds x and y values of type T The syntax for using generics in struct definitions is similar to that used in function definitions. First we declare the name of the type parameter inside angle brackets just after the name of the struct. Then we use the generic type in the struct definition where we would otherwise specify concrete data types. Note that because we’ve used only one generic type to define Point, this definition says that the Point struct is generic over some type T, and the fields x and y are both that same type, whatever that type may be. If we create an instance of a Point that has values of different types, as in Listing 10-7, our code won’t compile. Filename: src/main.rs struct Point { x: T, y: T,\n} fn main() { let wont_work = Point { x: 5, y: 4.0 };\n} Listing 10-7: The fields x and y must be the same type because both have the same generic data type T. In this example, when we assign the integer value 5 to x, we let the compiler know that the generic type T will be an integer for this instance of Point. Then when we specify 4.0 for y, which we’ve defined to have the same type as x, we’ll get a type mismatch error like this: $ cargo run Compiling chapter10 v0.1.0 (file:///projects/chapter10)\nerror[E0308]: mismatched types --> src/main.rs:7:38 |\n7 | let wont_work = Point { x: 5, y: 4.0 }; | ^^^ expected integer, found floating-point number For more information about this error, try `rustc --explain E0308`.\nerror: could not compile `chapter10` (bin \"chapter10\") due to 1 previous error To define a Point struct where x and y are both generics but could have different types, we can use multiple generic type parameters. For example, in Listing 10-8, we change the definition of Point to be generic over types T and U where x is of type T and y is of type U. Filename: src/main.rs struct Point { x: T, y: U,\n} fn main() { let both_integer = Point { x: 5, y: 10 }; let both_float = Point { x: 1.0, y: 4.0 }; let integer_and_float = Point { x: 5, y: 4.0 };\n} Listing 10-8: A Point generic over two types so that x and y can be values of different types Now all the instances of Point shown are allowed! You can use as many generic type parameters in a definition as you want, but using more than a few makes your code hard to read. If you’re finding you need lots of generic types in your code, it could indicate that your code needs restructuring into smaller pieces.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Generic Data Types » In Struct Definitions","id":"167","title":"In Struct Definitions"},"168":{"body":"As we did with structs, we can define enums to hold generic data types in their variants. Let’s take another look at the Option enum that the standard library provides, which we used in Chapter 6: enum Option { Some(T), None,\n} This definition should now make more sense to you. As you can see, the Option enum is generic over type T and has two variants: Some, which holds one value of type T, and a None variant that doesn’t hold any value. By using the Option enum, we can express the abstract concept of an optional value, and because Option is generic, we can use this abstraction no matter what the type of the optional value is. Enums can use multiple generic types as well. The definition of the Result enum that we used in Chapter 9 is one example: enum Result { Ok(T), Err(E),\n} The Result enum is generic over two types, T and E, and has two variants: Ok, which holds a value of type T, and Err, which holds a value of type E. This definition makes it convenient to use the Result enum anywhere we have an operation that might succeed (return a value of some type T) or fail (return an error of some type E). In fact, this is what we used to open a file in Listing 9-3, where T was filled in with the type std::fs::File when the file was opened successfully and E was filled in with the type std::io::Error when there were problems opening the file. When you recognize situations in your code with multiple struct or enum definitions that differ only in the types of the values they hold, you can avoid duplication by using generic types instead.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Generic Data Types » In Enum Definitions","id":"168","title":"In Enum Definitions"},"169":{"body":"We can implement methods on structs and enums (as we did in Chapter 5) and use generic types in their definitions too. Listing 10-9 shows the Point struct we defined in Listing 10-6 with a method named x implemented on it. Filename: src/main.rs struct Point { x: T, y: T,\n} impl Point { fn x(&self) -> &T { &self.x }\n} fn main() { let p = Point { x: 5, y: 10 }; println!(\"p.x = {}\", p.x());\n} Listing 10-9: Implementing a method named x on the Point struct that will return a reference to the x field of type T Here, we’ve defined a method named x on Point that returns a reference to the data in the field x. Note that we have to declare T just after impl so we can use T to specify that we’re implementing methods on the type Point. By declaring T as a generic type after impl, Rust can identify that the type in the angle brackets in Point is a generic type rather than a concrete type. We could have chosen a different name for this generic parameter than the generic parameter declared in the struct definition, but using the same name is conventional. Methods written within an impl that declares the generic type will be defined on any instance of the type, no matter what concrete type ends up substituting for the generic type. We can also specify constraints on generic types when defining methods on the type. We could, for example, implement methods only on Point instances rather than on Point instances with any generic type. In Listing 10-10 we use the concrete type f32, meaning we don’t declare any types after impl. Filename: src/main.rs # struct Point {\n# x: T,\n# y: T,\n# }\n# # impl Point {\n# fn x(&self) -> &T {\n# &self.x\n# }\n# }\n# impl Point { fn distance_from_origin(&self) -> f32 { (self.x.powi(2) + self.y.powi(2)).sqrt() }\n}\n# # fn main() {\n# let p = Point { x: 5, y: 10 };\n# # println!(\"p.x = {}\", p.x());\n# } Listing 10-10: An impl block that only applies to a struct with a particular concrete type for the generic type parameter T This code means the type Point will have a distance_from_origin method; other instances of Point where T is not of type f32 will not have this method defined. The method measures how far our point is from the point at coordinates (0.0, 0.0) and uses mathematical operations that are available only for floating-point types. Generic type parameters in a struct definition aren’t always the same as those you use in that same struct’s method signatures. Listing 10-11 uses the generic types X1 and Y1 for the Point struct and X2 Y2 for the mixup method signature to make the example clearer. The method creates a new Point instance with the x value from the self Point (of type X1) and the y value from the passed-in Point (of type Y2). Filename: src/main.rs struct Point { x: X1, y: Y1,\n} impl Point { fn mixup(self, other: Point) -> Point { Point { x: self.x, y: other.y, } }\n} fn main() { let p1 = Point { x: 5, y: 10.4 }; let p2 = Point { x: \"Hello\", y: 'c' }; let p3 = p1.mixup(p2); println!(\"p3.x = {}, p3.y = {}\", p3.x, p3.y);\n} Listing 10-11: A method that uses generic types different from its struct’s definition In main, we’ve defined a Point that has an i32 for x (with value 5) and an f64 for y (with value 10.4). The p2 variable is a Point struct that has a string slice for x (with value \"Hello\") and a char for y (with value c). Calling mixup on p1 with the argument p2 gives us p3, which will have an i32 for x because x came from p1. The p3 variable will have a char for y because y came from p2. The println! macro call will print p3.x = 5, p3.y = c. The purpose of this example is to demonstrate a situation in which some generic parameters are declared with impl and some are declared with the method definition. Here, the generic parameters X1 and Y1 are declared after impl because they go with the struct definition. The generic parameters X2 and Y2 are declared after fn mixup because they’re only relevant to the method.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Generic Data Types » In Method Definitions","id":"169","title":"In Method Definitions"},"17":{"body":"To check whether you have Rust installed correctly, open a shell and enter this line: $ rustc --version You should see the version number, commit hash, and commit date for the latest stable version that has been released, in the following format: rustc x.y.z (abcabcabc yyyy-mm-dd) If you see this information, you have installed Rust successfully! If you don’t see this information, check that Rust is in your %PATH% system variable as follows. In Windows CMD, use: > echo %PATH% In PowerShell, use: > echo $env:Path In Linux and macOS, use: $ echo $PATH If that’s all correct and Rust still isn’t working, there are a number of places you can get help. Find out how to get in touch with other Rustaceans (a silly nickname we call ourselves) on the community page .","breadcrumbs":"Getting Started » Installation » Troubleshooting","id":"17","title":"Troubleshooting"},"170":{"body":"You might be wondering whether there is a runtime cost when using generic type parameters. The good news is that using generic types won’t make your program run any slower than it would with concrete types. Rust accomplishes this by performing monomorphization of the code using generics at compile time. Monomorphization is the process of turning generic code into specific code by filling in the concrete types that are used when compiled. In this process, the compiler does the opposite of the steps we used to create the generic function in Listing 10-5: the compiler looks at all the places where generic code is called and generates code for the concrete types the generic code is called with. Let’s look at how this works by using the standard library’s generic Option enum: let integer = Some(5);\nlet float = Some(5.0); When Rust compiles this code, it performs monomorphization. During that process, the compiler reads the values that have been used in Option instances and identifies two kinds of Option: one is i32 and the other is f64. As such, it expands the generic definition of Option into two definitions specialized to i32 and f64, thereby replacing the generic definition with the specific ones. The monomorphized version of the code looks similar to the following (the compiler uses different names than what we’re using here for illustration): Filename: src/main.rs enum Option_i32 { Some(i32), None,\n} enum Option_f64 { Some(f64), None,\n} fn main() { let integer = Option_i32::Some(5); let float = Option_f64::Some(5.0);\n} The generic Option is replaced with the specific definitions created by the compiler. Because Rust compiles generic code into code that specifies the type in each instance, we pay no runtime cost for using generics. When the code runs, it performs just as it would if we had duplicated each definition by hand. The process of monomorphization makes Rust’s generics extremely efficient at runtime.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Generic Data Types » Performance of Code Using Generics","id":"170","title":"Performance of Code Using Generics"},"171":{"body":"A trait defines the functionality a particular type has and can share with other types. We can use traits to define shared behavior in an abstract way. We can use trait bounds to specify that a generic type can be any type that has certain behavior. Note: Traits are similar to a feature often called interfaces in other languages, although with some differences.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Traits: Defining Shared Behavior » Traits: Defining Shared Behavior","id":"171","title":"Traits: Defining Shared Behavior"},"172":{"body":"A type’s behavior consists of the methods we can call on that type. Different types share the same behavior if we can call the same methods on all of those types. Trait definitions are a way to group method signatures together to define a set of behaviors necessary to accomplish some purpose. For example, let’s say we have multiple structs that hold various kinds and amounts of text: a NewsArticle struct that holds a news story filed in a particular location and a Tweet that can have, at most, 280 characters along with metadata that indicates whether it was a new tweet, a retweet, or a reply to another tweet. We want to make a media aggregator library crate named aggregator that can display summaries of data that might be stored in a NewsArticle or Tweet instance. To do this, we need a summary from each type, and we’ll request that summary by calling a summarize method on an instance. Listing 10-12 shows the definition of a public Summary trait that expresses this behavior. Filename: src/lib.rs pub trait Summary { fn summarize(&self) -> String;\n} Listing 10-12: A Summary trait that consists of the behavior provided by a summarize method Here, we declare a trait using the trait keyword and then the trait’s name, which is Summary in this case. We also declare the trait as pub so that crates depending on this crate can make use of this trait too, as we’ll see in a few examples. Inside the curly brackets, we declare the method signatures that describe the behaviors of the types that implement this trait, which in this case is fn summarize(&self) -> String. After the method signature, instead of providing an implementation within curly brackets, we use a semicolon. Each type implementing this trait must provide its own custom behavior for the body of the method. The compiler will enforce that any type that has the Summary trait will have the method summarize defined with this signature exactly. A trait can have multiple methods in its body: the method signatures are listed one per line, and each line ends in a semicolon.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Traits: Defining Shared Behavior » Defining a Trait","id":"172","title":"Defining a Trait"},"173":{"body":"Now that we’ve defined the desired signatures of the Summary trait’s methods, we can implement it on the types in our media aggregator. Listing 10-13 shows an implementation of the Summary trait on the NewsArticle struct that uses the headline, the author, and the location to create the return value of summarize. For the Tweet struct, we define summarize as the username followed by the entire text of the tweet, assuming that the tweet content is already limited to 280 characters. Filename: src/lib.rs # pub trait Summary {\n# fn summarize(&self) -> String;\n# }\n# pub struct NewsArticle { pub headline: String, pub location: String, pub author: String, pub content: String,\n} impl Summary for NewsArticle { fn summarize(&self) -> String { format!(\"{}, by {} ({})\", self.headline, self.author, self.location) }\n} pub struct Tweet { pub username: String, pub content: String, pub reply: bool, pub retweet: bool,\n} impl Summary for Tweet { fn summarize(&self) -> String { format!(\"{}: {}\", self.username, self.content) }\n} Listing 10-13: Implementing the Summary trait on the NewsArticle and Tweet types Implementing a trait on a type is similar to implementing regular methods. The difference is that after impl, we put the trait name we want to implement, then use the for keyword, and then specify the name of the type we want to implement the trait for. Within the impl block, we put the method signatures that the trait definition has defined. Instead of adding a semicolon after each signature, we use curly brackets and fill in the method body with the specific behavior that we want the methods of the trait to have for the particular type. Now that the library has implemented the Summary trait on NewsArticle and Tweet, users of the crate can call the trait methods on instances of NewsArticle and Tweet in the same way we call regular methods. The only difference is that the user must bring the trait into scope as well as the types. Here’s an example of how a binary crate could use our aggregator library crate: use aggregator::{Summary, Tweet}; fn main() { let tweet = Tweet { username: String::from(\"horse_ebooks\"), content: String::from( \"of course, as you probably already know, people\", ), reply: false, retweet: false, }; println!(\"1 new tweet: {}\", tweet.summarize());\n} This code prints 1 new tweet: horse_ebooks: of course, as you probably already know, people. Other crates that depend on the aggregator crate can also bring the Summary trait into scope to implement Summary on their own types. One restriction to note is that we can implement a trait on a type only if either the trait or the type, or both, are local to our crate. For example, we can implement standard library traits like Display on a custom type like Tweet as part of our aggregator crate functionality because the type Tweet is local to our aggregator crate. We can also implement Summary on Vec in our aggregator crate because the trait Summary is local to our aggregator crate. But we can’t implement external traits on external types. For example, we can’t implement the Display trait on Vec within our aggregator crate because Display and Vec are both defined in the standard library and aren’t local to our aggregator crate. This restriction is part of a property called coherence , and more specifically the orphan rule , so named because the parent type is not present. This rule ensures that other people’s code can’t break your code and vice versa. Without the rule, two crates could implement the same trait for the same type, and Rust wouldn’t know which implementation to use.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Traits: Defining Shared Behavior » Implementing a Trait on a Type","id":"173","title":"Implementing a Trait on a Type"},"174":{"body":"Sometimes it’s useful to have default behavior for some or all of the methods in a trait instead of requiring implementations for all methods on every type. Then, as we implement the trait on a particular type, we can keep or override each method’s default behavior. In Listing 10-14, we specify a default string for the summarize method of the Summary trait instead of only defining the method signature, as we did in Listing 10-12. Filename: src/lib.rs pub trait Summary { fn summarize(&self) -> String { String::from(\"(Read more...)\") }\n}\n# # pub struct NewsArticle {\n# pub headline: String,\n# pub location: String,\n# pub author: String,\n# pub content: String,\n# }\n# # impl Summary for NewsArticle {}\n# # pub struct Tweet {\n# pub username: String,\n# pub content: String,\n# pub reply: bool,\n# pub retweet: bool,\n# }\n# # impl Summary for Tweet {\n# fn summarize(&self) -> String {\n# format!(\"{}: {}\", self.username, self.content)\n# }\n# } Listing 10-14: Defining a Summary trait with a default implementation of the summarize method To use a default implementation to summarize instances of NewsArticle, we specify an empty impl block with impl Summary for NewsArticle {}. Even though we’re no longer defining the summarize method on NewsArticle directly, we’ve provided a default implementation and specified that NewsArticle implements the Summary trait. As a result, we can still call the summarize method on an instance of NewsArticle, like this: # use aggregator::{self, NewsArticle, Summary};\n# # fn main() { let article = NewsArticle { headline: String::from(\"Penguins win the Stanley Cup Championship!\"), location: String::from(\"Pittsburgh, PA, USA\"), author: String::from(\"Iceburgh\"), content: String::from( \"The Pittsburgh Penguins once again are the best \\ hockey team in the NHL.\", ), }; println!(\"New article available! {}\", article.summarize());\n# } This code prints New article available! (Read more...). Creating a default implementation doesn’t require us to change anything about the implementation of Summary on Tweet in Listing 10-13. The reason is that the syntax for overriding a default implementation is the same as the syntax for implementing a trait method that doesn’t have a default implementation. Default implementations can call other methods in the same trait, even if those other methods don’t have a default implementation. In this way, a trait can provide a lot of useful functionality and only require implementors to specify a small part of it. For example, we could define the Summary trait to have a summarize_author method whose implementation is required, and then define a summarize method that has a default implementation that calls the summarize_author method: pub trait Summary { fn summarize_author(&self) -> String; fn summarize(&self) -> String { format!(\"(Read more from {}...)\", self.summarize_author()) }\n}\n# # pub struct Tweet {\n# pub username: String,\n# pub content: String,\n# pub reply: bool,\n# pub retweet: bool,\n# }\n# # impl Summary for Tweet {\n# fn summarize_author(&self) -> String {\n# format!(\"@{}\", self.username)\n# }\n# } To use this version of Summary, we only need to define summarize_author when we implement the trait on a type: # pub trait Summary {\n# fn summarize_author(&self) -> String;\n# # fn summarize(&self) -> String {\n# format!(\"(Read more from {}...)\", self.summarize_author())\n# }\n# }\n# # pub struct Tweet {\n# pub username: String,\n# pub content: String,\n# pub reply: bool,\n# pub retweet: bool,\n# }\n# impl Summary for Tweet { fn summarize_author(&self) -> String { format!(\"@{}\", self.username) }\n} After we define summarize_author, we can call summarize on instances of the Tweet struct, and the default implementation of summarize will call the definition of summarize_author that we’ve provided. Because we’ve implemented summarize_author, the Summary trait has given us the behavior of the summarize method without requiring us to write any more code. Here’s what that looks like: # use aggregator::{self, Summary, Tweet};\n# # fn main() { let tweet = Tweet { username: String::from(\"horse_ebooks\"), content: String::from( \"of course, as you probably already know, people\", ), reply: false, retweet: false, }; println!(\"1 new tweet: {}\", tweet.summarize());\n# } This code prints 1 new tweet: (Read more from @horse_ebooks...). Note that it isn’t possible to call the default implementation from an overriding implementation of that same method.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Traits: Defining Shared Behavior » Default Implementations","id":"174","title":"Default Implementations"},"175":{"body":"Now that you know how to define and implement traits, we can explore how to use traits to define functions that accept many different types. We’ll use the Summary trait we implemented on the NewsArticle and Tweet types in Listing 10-13 to define a notify function that calls the summarize method on its item parameter, which is of some type that implements the Summary trait. To do this, we use the impl Trait syntax, like this: # pub trait Summary {\n# fn summarize(&self) -> String;\n# }\n# # pub struct NewsArticle {\n# pub headline: String,\n# pub location: String,\n# pub author: String,\n# pub content: String,\n# }\n# # impl Summary for NewsArticle {\n# fn summarize(&self) -> String {\n# format!(\"{}, by {} ({})\", self.headline, self.author, self.location)\n# }\n# }\n# # pub struct Tweet {\n# pub username: String,\n# pub content: String,\n# pub reply: bool,\n# pub retweet: bool,\n# }\n# # impl Summary for Tweet {\n# fn summarize(&self) -> String {\n# format!(\"{}: {}\", self.username, self.content)\n# }\n# }\n# pub fn notify(item: &impl Summary) { println!(\"Breaking news! {}\", item.summarize());\n} Instead of a concrete type for the item parameter, we specify the impl keyword and the trait name. This parameter accepts any type that implements the specified trait. In the body of notify, we can call any methods on item that come from the Summary trait, such as summarize. We can call notify and pass in any instance of NewsArticle or Tweet. Code that calls the function with any other type, such as a String or an i32, won’t compile because those types don’t implement Summary. Trait Bound Syntax The impl Trait syntax works for straightforward cases but is actually syntax sugar for a longer form known as a trait bound ; it looks like this: pub fn notify(item: &T) { println!(\"Breaking news! {}\", item.summarize());\n} This longer form is equivalent to the example in the previous section but is more verbose. We place trait bounds with the declaration of the generic type parameter after a colon and inside angle brackets. The impl Trait syntax is convenient and makes for more concise code in simple cases, while the fuller trait bound syntax can express more complexity in other cases. For example, we can have two parameters that implement Summary. Doing so with the impl Trait syntax looks like this: pub fn notify(item1: &impl Summary, item2: &impl Summary) { Using impl Trait is appropriate if we want this function to allow item1 and item2 to have different types (as long as both types implement Summary). If we want to force both parameters to have the same type, however, we must use a trait bound, like this: pub fn notify(item1: &T, item2: &T) { The generic type T specified as the type of the item1 and item2 parameters constrains the function such that the concrete type of the value passed as an argument for item1 and item2 must be the same. Specifying Multiple Trait Bounds with the + Syntax We can also specify more than one trait bound. Say we wanted notify to use display formatting as well as summarize on item: we specify in the notify definition that item must implement both Display and Summary. We can do so using the + syntax: pub fn notify(item: &(impl Summary + Display)) { The + syntax is also valid with trait bounds on generic types: pub fn notify(item: &T) { With the two trait bounds specified, the body of notify can call summarize and use {} to format item. Clearer Trait Bounds with where Clauses Using too many trait bounds has its downsides. Each generic has its own trait bounds, so functions with multiple generic type parameters can contain lots of trait bound information between the function’s name and its parameter list, making the function signature hard to read. For this reason, Rust has alternate syntax for specifying trait bounds inside a where clause after the function signature. So, instead of writing this: fn some_function(t: &T, u: &U) -> i32 { we can use a where clause, like this: fn some_function(t: &T, u: &U) -> i32\nwhere T: Display + Clone, U: Clone + Debug,\n{\n# unimplemented!()\n# } This function’s signature is less cluttered: the function name, parameter list, and return type are close together, similar to a function without lots of trait bounds.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Traits: Defining Shared Behavior » Traits as Parameters","id":"175","title":"Traits as Parameters"},"176":{"body":"We can also use the impl Trait syntax in the return position to return a value of some type that implements a trait, as shown here: # pub trait Summary {\n# fn summarize(&self) -> String;\n# }\n# # pub struct NewsArticle {\n# pub headline: String,\n# pub location: String,\n# pub author: String,\n# pub content: String,\n# }\n# # impl Summary for NewsArticle {\n# fn summarize(&self) -> String {\n# format!(\"{}, by {} ({})\", self.headline, self.author, self.location)\n# }\n# }\n# # pub struct Tweet {\n# pub username: String,\n# pub content: String,\n# pub reply: bool,\n# pub retweet: bool,\n# }\n# # impl Summary for Tweet {\n# fn summarize(&self) -> String {\n# format!(\"{}: {}\", self.username, self.content)\n# }\n# }\n# fn returns_summarizable() -> impl Summary { Tweet { username: String::from(\"horse_ebooks\"), content: String::from( \"of course, as you probably already know, people\", ), reply: false, retweet: false, }\n} By using impl Summary for the return type, we specify that the returns_summarizable function returns some type that implements the Summary trait without naming the concrete type. In this case, returns_summarizable returns a Tweet, but the code calling this function doesn’t need to know that. The ability to specify a return type only by the trait it implements is especially useful in the context of closures and iterators, which we cover in Chapter 13. Closures and iterators create types that only the compiler knows or types that are very long to specify. The impl Trait syntax lets you concisely specify that a function returns some type that implements the Iterator trait without needing to write out a very long type. However, you can only use impl Trait if you’re returning a single type. For example, this code that returns either a NewsArticle or a Tweet with the return type specified as impl Summary wouldn’t work: # pub trait Summary {\n# fn summarize(&self) -> String;\n# }\n# # pub struct NewsArticle {\n# pub headline: String,\n# pub location: String,\n# pub author: String,\n# pub content: String,\n# }\n# # impl Summary for NewsArticle {\n# fn summarize(&self) -> String {\n# format!(\"{}, by {} ({})\", self.headline, self.author, self.location)\n# }\n# }\n# # pub struct Tweet {\n# pub username: String,\n# pub content: String,\n# pub reply: bool,\n# pub retweet: bool,\n# }\n# # impl Summary for Tweet {\n# fn summarize(&self) -> String {\n# format!(\"{}: {}\", self.username, self.content)\n# }\n# }\n# fn returns_summarizable(switch: bool) -> impl Summary { if switch { NewsArticle { headline: String::from( \"Penguins win the Stanley Cup Championship!\", ), location: String::from(\"Pittsburgh, PA, USA\"), author: String::from(\"Iceburgh\"), content: String::from( \"The Pittsburgh Penguins once again are the best \\ hockey team in the NHL.\", ), } } else { Tweet { username: String::from(\"horse_ebooks\"), content: String::from( \"of course, as you probably already know, people\", ), reply: false, retweet: false, } }\n} Returning either a NewsArticle or a Tweet isn’t allowed due to restrictions around how the impl Trait syntax is implemented in the compiler. We’ll cover how to write a function with this behavior in the “Using Trait Objects That Allow for Values of Different Types” section of Chapter 17.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Traits: Defining Shared Behavior » Returning Types That Implement Traits","id":"176","title":"Returning Types That Implement Traits"},"177":{"body":"By using a trait bound with an impl block that uses generic type parameters, we can implement methods conditionally for types that implement the specified traits. For example, the type Pair in Listing 10-15 always implements the new function to return a new instance of Pair (recall from the “Defining Methods” section of Chapter 5 that Self is a type alias for the type of the impl block, which in this case is Pair). But in the next impl block, Pair only implements the cmp_display method if its inner type T implements the PartialOrd trait that enables comparison and the Display trait that enables printing. Filename: src/lib.rs use std::fmt::Display; struct Pair { x: T, y: T,\n} impl Pair { fn new(x: T, y: T) -> Self { Self { x, y } }\n} impl Pair { fn cmp_display(&self) { if self.x >= self.y { println!(\"The largest member is x = {}\", self.x); } else { println!(\"The largest member is y = {}\", self.y); } }\n} Listing 10-15: Conditionally implementing methods on a generic type depending on trait bounds We can also conditionally implement a trait for any type that implements another trait. Implementations of a trait on any type that satisfies the trait bounds are called blanket implementations and are used extensively in the Rust standard library. For example, the standard library implements the ToString trait on any type that implements the Display trait. The impl block in the standard library looks similar to this code: impl ToString for T { // --snip--\n} Because the standard library has this blanket implementation, we can call the to_string method defined by the ToString trait on any type that implements the Display trait. For example, we can turn integers into their corresponding String values like this because integers implement Display: let s = 3.to_string(); Blanket implementations appear in the documentation for the trait in the “Implementors” section. Traits and trait bounds let us write code that uses generic type parameters to reduce duplication but also specify to the compiler that we want the generic type to have particular behavior. The compiler can then use the trait bound information to check that all the concrete types used with our code provide the correct behavior. In dynamically typed languages, we would get an error at runtime if we called a method on a type which didn’t define the method. But Rust moves these errors to compile time so we’re forced to fix the problems before our code is even able to run. Additionally, we don’t have to write code that checks for behavior at runtime because we’ve already checked at compile time. Doing so improves performance without having to give up the flexibility of generics.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Traits: Defining Shared Behavior » Using Trait Bounds to Conditionally Implement Methods","id":"177","title":"Using Trait Bounds to Conditionally Implement Methods"},"178":{"body":"Lifetimes are another kind of generic that we’ve already been using. Rather than ensuring that a type has the behavior we want, lifetimes ensure that references are valid as long as we need them to be. One detail we didn’t discuss in the “References and Borrowing” section in Chapter 4 is that every reference in Rust has a lifetime , which is the scope for which that reference is valid. Most of the time, lifetimes are implicit and inferred, just like most of the time, types are inferred. We must annotate types only when multiple types are possible. In a similar way, we must annotate lifetimes when the lifetimes of references could be related in a few different ways. Rust requires us to annotate the relationships using generic lifetime parameters to ensure the actual references used at runtime will definitely be valid. Annotating lifetimes is not a concept most other programming languages have, so this is going to feel unfamiliar. Although we won’t cover lifetimes in their entirety in this chapter, we’ll discuss common ways you might encounter lifetime syntax so you can get comfortable with the concept.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Validating References with Lifetimes","id":"178","title":"Validating References with Lifetimes"},"179":{"body":"The main aim of lifetimes is to prevent dangling references , which cause a program to reference data other than the data it’s intended to reference. Consider the program in Listing 10-16, which has an outer scope and an inner scope. fn main() { let r; { let x = 5; r = &x; } println!(\"r: {r}\");\n} Listing 10-16: An attempt to use a reference whose value has gone out of scope Note: The examples in Listing 10-16, 10-17, and 10-23 declare variables without giving them an initial value, so the variable name exists in the outer scope. At first glance, this might appear to be in conflict with Rust’s having no null values. However, if we try to use a variable before giving it a value, we’ll get a compile-time error, which shows that Rust indeed does not allow null values. The outer scope declares a variable named r with no initial value, and the inner scope declares a variable named x with the initial value of 5. Inside the inner scope, we attempt to set the value of r as a reference to x. Then the inner scope ends, and we attempt to print the value in r. This code won’t compile because the value that r is referring to has gone out of scope before we try to use it. Here is the error message: $ cargo run Compiling chapter10 v0.1.0 (file:///projects/chapter10)\nerror[E0597]: `x` does not live long enough --> src/main.rs:6:13 |\n5 | let x = 5; | - binding `x` declared here\n6 | r = &x; | ^^ borrowed value does not live long enough\n7 | } | - `x` dropped here while still borrowed\n8 |\n9 | println!(\"r: {r}\"); | --- borrow later used here For more information about this error, try `rustc --explain E0597`.\nerror: could not compile `chapter10` (bin \"chapter10\") due to 1 previous error The error message says that the variable x “does not live long enough.” The reason is that x will be out of scope when the inner scope ends on line 7. But r is still valid for the outer scope; because its scope is larger, we say that it “lives longer.” If Rust allowed this code to work, r would be referencing memory that was deallocated when x went out of scope, and anything we tried to do with r wouldn’t work correctly. So how does Rust determine that this code is invalid? It uses a borrow checker.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Preventing Dangling References with Lifetimes","id":"179","title":"Preventing Dangling References with Lifetimes"},"18":{"body":"Once Rust is installed via rustup, updating to a newly released version is easy. From your shell, run the following update script: $ rustup update To uninstall Rust and rustup, run the following uninstall script from your shell: $ rustup self uninstall","breadcrumbs":"Getting Started » Installation » Updating and Uninstalling","id":"18","title":"Updating and Uninstalling"},"180":{"body":"The Rust compiler has a borrow checker that compares scopes to determine whether all borrows are valid. Listing 10-17 shows the same code as Listing 10-16 but with annotations showing the lifetimes of the variables. fn main() { let r; // ---------+-- 'a // | { // | let x = 5; // -+-- 'b | r = &x; // | | } // -+ | // | println!(\"r: {r}\"); // |\n} // ---------+ Listing 10-17: Annotations of the lifetimes of r and x, named 'a and 'b, respectively Here, we’ve annotated the lifetime of r with 'a and the lifetime of x with 'b. As you can see, the inner 'b block is much smaller than the outer 'a lifetime block. At compile time, Rust compares the size of the two lifetimes and sees that r has a lifetime of 'a but that it refers to memory with a lifetime of 'b. The program is rejected because 'b is shorter than 'a: the subject of the reference doesn’t live as long as the reference. Listing 10-18 fixes the code so it doesn’t have a dangling reference and it compiles without any errors. fn main() { let x = 5; // ----------+-- 'b // | let r = &x; // --+-- 'a | // | | println!(\"r: {r}\"); // | | // --+ |\n} // ----------+ Listing 10-18: A valid reference because the data has a longer lifetime than the reference Here, x has the lifetime 'b, which in this case is larger than 'a. This means r can reference x because Rust knows that the reference in r will always be valid while x is valid. Now that you know what the lifetimes of references are and how Rust analyzes lifetimes to ensure references will always be valid, let’s explore generic lifetimes of parameters and return values in the context of functions.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » The Borrow Checker","id":"180","title":"The Borrow Checker"},"181":{"body":"We’ll write a function that returns the longer of two string slices. This function will take two string slices and return a single string slice. After we’ve implemented the longest function, the code in Listing 10-19 should print The longest string is abcd. Filename: src/main.rs fn main() { let string1 = String::from(\"abcd\"); let string2 = \"xyz\"; let result = longest(string1.as_str(), string2); println!(\"The longest string is {result}\");\n} Listing 10-19: A main function that calls the longest function to find the longer of two string slices Note that we want the function to take string slices, which are references, rather than strings, because we don’t want the longest function to take ownership of its parameters. Refer to the “String Slices as Parameters” section in Chapter 4 for more discussion about why the parameters we use in Listing 10-19 are the ones we want. If we try to implement the longest function as shown in Listing 10-20, it won’t compile. Filename: src/main.rs # fn main() {\n# let string1 = String::from(\"abcd\");\n# let string2 = \"xyz\";\n# # let result = longest(string1.as_str(), string2);\n# println!(\"The longest string is {result}\");\n# }\n# fn longest(x: &str, y: &str) -> &str { if x.len() > y.len() { x } else { y }\n} Listing 10-20: An implementation of the longest function that returns the longer of two string slices but does not yet compile Instead, we get the following error that talks about lifetimes: $ cargo run Compiling chapter10 v0.1.0 (file:///projects/chapter10)\nerror[E0106]: missing lifetime specifier --> src/main.rs:9:33 |\n9 | fn longest(x: &str, y: &str) -> &str { | ---- ---- ^ expected named lifetime parameter | = help: this function's return type contains a borrowed value, but the signature does not say whether it is borrowed from `x` or `y`\nhelp: consider introducing a named lifetime parameter |\n9 | fn longest<'a>(x: &'a str, y: &'a str) -> &'a str { | ++++ ++ ++ ++ error: lifetime may not live long enough --> src/main.rs:11:9 |\n9 | fn longest(x: &str, y: &str) -> &str { | - let's call the lifetime of this reference `'1`\n10 | if x.len() > y.len() {\n11 | x | ^ returning this value requires that `'1` must outlive `'static` error: lifetime may not live long enough --> src/main.rs:13:9 |\n9 | fn longest(x: &str, y: &str) -> &str { | - let's call the lifetime of this reference `'2`\n...\n13 | y | ^ returning this value requires that `'2` must outlive `'static` For more information about this error, try `rustc --explain E0106`.\nerror: could not compile `chapter10` (bin \"chapter10\") due to 3 previous errors The help text reveals that the return type needs a generic lifetime parameter on it because Rust can’t tell whether the reference being returned refers to x or y. Actually, we don’t know either, because the if block in the body of this function returns a reference to x and the else block returns a reference to y! When we’re defining this function, we don’t know the concrete values that will be passed into this function, so we don’t know whether the if case or the else case will execute. We also don’t know the concrete lifetimes of the references that will be passed in, so we can’t look at the scopes as we did in Listings 10-17 and 10-18 to determine whether the reference we return will always be valid. The borrow checker can’t determine this either, because it doesn’t know how the lifetimes of x and y relate to the lifetime of the return value. To fix this error, we’ll add generic lifetime parameters that define the relationship between the references so the borrow checker can perform its analysis.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Generic Lifetimes in Functions","id":"181","title":"Generic Lifetimes in Functions"},"182":{"body":"Lifetime annotations don’t change how long any of the references live. Rather, they describe the relationships of the lifetimes of multiple references to each other without affecting the lifetimes. Just as functions can accept any type when the signature specifies a generic type parameter, functions can accept references with any lifetime by specifying a generic lifetime parameter. Lifetime annotations have a slightly unusual syntax: the names of lifetime parameters must start with an apostrophe (') and are usually all lowercase and very short, like generic types. Most people use the name 'a for the first lifetime annotation. We place lifetime parameter annotations after the & of a reference, using a space to separate the annotation from the reference’s type. Here are some examples: a reference to an i32 without a lifetime parameter, a reference to an i32 that has a lifetime parameter named 'a, and a mutable reference to an i32 that also has the lifetime 'a. &i32 // a reference\n&'a i32 // a reference with an explicit lifetime\n&'a mut i32 // a mutable reference with an explicit lifetime One lifetime annotation by itself doesn’t have much meaning because the annotations are meant to tell Rust how generic lifetime parameters of multiple references relate to each other. Let’s examine how the lifetime annotations relate to each other in the context of the longest function.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Lifetime Annotation Syntax","id":"182","title":"Lifetime Annotation Syntax"},"183":{"body":"To use lifetime annotations in function signatures, we need to declare the generic lifetime parameters inside angle brackets between the function name and the parameter list, just as we did with generic type parameters. We want the signature to express the following constraint: the returned reference will be valid as long as both the parameters are valid. This is the relationship between lifetimes of the parameters and the return value. We’ll name the lifetime 'a and then add it to each reference, as shown in Listing 10-21. Filename: src/main.rs # fn main() {\n# let string1 = String::from(\"abcd\");\n# let string2 = \"xyz\";\n# # let result = longest(string1.as_str(), string2);\n# println!(\"The longest string is {result}\");\n# }\n# fn longest<'a>(x: &'a str, y: &'a str) -> &'a str { if x.len() > y.len() { x } else { y }\n} Listing 10-21: The longest function definition specifying that all the references in the signature must have the same lifetime 'a This code should compile and produce the result we want when we use it with the main function in Listing 10-19. The function signature now tells Rust that for some lifetime 'a, the function takes two parameters, both of which are string slices that live at least as long as lifetime 'a. The function signature also tells Rust that the string slice returned from the function will live at least as long as lifetime 'a. In practice, it means that the lifetime of the reference returned by the longest function is the same as the smaller of the lifetimes of the values referred to by the function arguments. These relationships are what we want Rust to use when analyzing this code. Remember, when we specify the lifetime parameters in this function signature, we’re not changing the lifetimes of any values passed in or returned. Rather, we’re specifying that the borrow checker should reject any values that don’t adhere to these constraints. Note that the longest function doesn’t need to know exactly how long x and y will live, only that some scope can be substituted for 'a that will satisfy this signature. When annotating lifetimes in functions, the annotations go in the function signature, not in the function body. The lifetime annotations become part of the contract of the function, much like the types in the signature. Having function signatures contain the lifetime contract means the analysis the Rust compiler does can be simpler. If there’s a problem with the way a function is annotated or the way it is called, the compiler errors can point to the part of our code and the constraints more precisely. If, instead, the Rust compiler made more inferences about what we intended the relationships of the lifetimes to be, the compiler might only be able to point to a use of our code many steps away from the cause of the problem. When we pass concrete references to longest, the concrete lifetime that is substituted for 'a is the part of the scope of x that overlaps with the scope of y. In other words, the generic lifetime 'a will get the concrete lifetime that is equal to the smaller of the lifetimes of x and y. Because we’ve annotated the returned reference with the same lifetime parameter 'a, the returned reference will also be valid for the length of the smaller of the lifetimes of x and y. Let’s look at how the lifetime annotations restrict the longest function by passing in references that have different concrete lifetimes. Listing 10-22 is a straightforward example. Filename: src/main.rs fn main() { let string1 = String::from(\"long string is long\"); { let string2 = String::from(\"xyz\"); let result = longest(string1.as_str(), string2.as_str()); println!(\"The longest string is {result}\"); }\n}\n# # fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {\n# if x.len() > y.len() {\n# x\n# } else {\n# y\n# }\n# } Listing 10-22: Using the longest function with references to String values that have different concrete lifetimes In this example, string1 is valid until the end of the outer scope, string2 is valid until the end of the inner scope, and result references something that is valid until the end of the inner scope. Run this code and you’ll see that the borrow checker approves; it will compile and print The longest string is long string is long. Next, let’s try an example that shows that the lifetime of the reference in result must be the smaller lifetime of the two arguments. We’ll move the declaration of the result variable outside the inner scope but leave the assignment of the value to the result variable inside the scope with string2. Then we’ll move the println! that uses result to outside the inner scope, after the inner scope has ended. The code in Listing 10-23 will not compile. Filename: src/main.rs fn main() { let string1 = String::from(\"long string is long\"); let result; { let string2 = String::from(\"xyz\"); result = longest(string1.as_str(), string2.as_str()); } println!(\"The longest string is {result}\");\n}\n# # fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {\n# if x.len() > y.len() {\n# x\n# } else {\n# y\n# }\n# } Listing 10-23: Attempting to use result after string2 has gone out of scope When we try to compile this code, we get this error: $ cargo run Compiling chapter10 v0.1.0 (file:///projects/chapter10)\nerror[E0597]: `string2` does not live long enough --> src/main.rs:6:44 |\n5 | let string2 = String::from(\"xyz\"); | ------- binding `string2` declared here\n6 | result = longest(string1.as_str(), string2.as_str()); | ^^^^^^^ borrowed value does not live long enough\n7 | } | - `string2` dropped here while still borrowed\n8 | println!(\"The longest string is {result}\"); | -------- borrow later used here For more information about this error, try `rustc --explain E0597`.\nerror: could not compile `chapter10` (bin \"chapter10\") due to 1 previous error The error shows that for result to be valid for the println! statement, string2 would need to be valid until the end of the outer scope. Rust knows this because we annotated the lifetimes of the function parameters and return values using the same lifetime parameter 'a. As humans, we can look at this code and see that string1 is longer than string2, and therefore, result will contain a reference to string1. Because string1 has not gone out of scope yet, a reference to string1 will still be valid for the println! statement. However, the compiler can’t see that the reference is valid in this case. We’ve told Rust that the lifetime of the reference returned by the longest function is the same as the smaller of the lifetimes of the references passed in. Therefore, the borrow checker disallows the code in Listing 10-23 as possibly having an invalid reference. Try designing more experiments that vary the values and lifetimes of the references passed in to the longest function and how the returned reference is used. Make hypotheses about whether or not your experiments will pass the borrow checker before you compile; then check to see if you’re right!","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Lifetime Annotations in Function Signatures","id":"183","title":"Lifetime Annotations in Function Signatures"},"184":{"body":"The way in which you need to specify lifetime parameters depends on what your function is doing. For example, if we changed the implementation of the longest function to always return the first parameter rather than the longest string slice, we wouldn’t need to specify a lifetime on the y parameter. The following code will compile: Filename: src/main.rs # fn main() {\n# let string1 = String::from(\"abcd\");\n# let string2 = \"efghijklmnopqrstuvwxyz\";\n# # let result = longest(string1.as_str(), string2);\n# println!(\"The longest string is {result}\");\n# }\n# fn longest<'a>(x: &'a str, y: &str) -> &'a str { x\n} We’ve specified a lifetime parameter 'a for the parameter x and the return type, but not for the parameter y, because the lifetime of y does not have any relationship with the lifetime of x or the return value. When returning a reference from a function, the lifetime parameter for the return type needs to match the lifetime parameter for one of the parameters. If the reference returned does not refer to one of the parameters, it must refer to a value created within this function. However, this would be a dangling reference because the value will go out of scope at the end of the function. Consider this attempted implementation of the longest function that won’t compile: Filename: src/main.rs # fn main() {\n# let string1 = String::from(\"abcd\");\n# let string2 = \"xyz\";\n# # let result = longest(string1.as_str(), string2);\n# println!(\"The longest string is {result}\");\n# }\n# fn longest<'a>(x: &str, y: &str) -> &'a str { let result = String::from(\"really long string\"); result.as_str()\n} Here, even though we’ve specified a lifetime parameter 'a for the return type, this implementation will fail to compile because the return value lifetime is not related to the lifetime of the parameters at all. Here is the error message we get: $ cargo run Compiling chapter10 v0.1.0 (file:///projects/chapter10)\nerror[E0515]: cannot return value referencing local variable `result` --> src/main.rs:11:5 |\n11 | result.as_str() | ------^^^^^^^^^ | | | returns a value referencing data owned by the current function | `result` is borrowed here For more information about this error, try `rustc --explain E0515`.\nerror: could not compile `chapter10` (bin \"chapter10\") due to 1 previous error The problem is that result goes out of scope and gets cleaned up at the end of the longest function. We’re also trying to return a reference to result from the function. There is no way we can specify lifetime parameters that would change the dangling reference, and Rust won’t let us create a dangling reference. In this case, the best fix would be to return an owned data type rather than a reference so the calling function is then responsible for cleaning up the value. Ultimately, lifetime syntax is about connecting the lifetimes of various parameters and return values of functions. Once they’re connected, Rust has enough information to allow memory-safe operations and disallow operations that would create dangling pointers or otherwise violate memory safety.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Thinking in Terms of Lifetimes","id":"184","title":"Thinking in Terms of Lifetimes"},"185":{"body":"So far, the structs we’ve defined all hold owned types. We can define structs to hold references, but in that case we would need to add a lifetime annotation on every reference in the struct’s definition. Listing 10-24 has a struct named ImportantExcerpt that holds a string slice. Filename: src/main.rs struct ImportantExcerpt<'a> { part: &'a str,\n} fn main() { let novel = String::from(\"Call me Ishmael. Some years ago...\"); let first_sentence = novel.split('.').next().unwrap(); let i = ImportantExcerpt { part: first_sentence, };\n} Listing 10-24: A struct that holds a reference, requiring a lifetime annotation This struct has the single field part that holds a string slice, which is a reference. As with generic data types, we declare the name of the generic lifetime parameter inside angle brackets after the name of the struct so we can use the lifetime parameter in the body of the struct definition. This annotation means an instance of ImportantExcerpt can’t outlive the reference it holds in its part field. The main function here creates an instance of the ImportantExcerpt struct that holds a reference to the first sentence of the String owned by the variable novel. The data in novel exists before the ImportantExcerpt instance is created. In addition, novel doesn’t go out of scope until after the ImportantExcerpt goes out of scope, so the reference in the ImportantExcerpt instance is valid.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Lifetime Annotations in Struct Definitions","id":"185","title":"Lifetime Annotations in Struct Definitions"},"186":{"body":"You’ve learned that every reference has a lifetime and that you need to specify lifetime parameters for functions or structs that use references. However, we had a function in Listing 4-9, shown again in Listing 10-25, that compiled without lifetime annotations. Filename: src/lib.rs fn first_word(s: &str) -> &str { let bytes = s.as_bytes(); for (i, &item) in bytes.iter().enumerate() { if item == b' ' { return &s[0..i]; } } &s[..]\n}\n# # fn main() {\n# let my_string = String::from(\"hello world\");\n# # // first_word works on slices of `String`s\n# let word = first_word(&my_string[..]);\n# # let my_string_literal = \"hello world\";\n# # // first_word works on slices of string literals\n# let word = first_word(&my_string_literal[..]);\n# # // Because string literals *are* string slices already,\n# // this works too, without the slice syntax!\n# let word = first_word(my_string_literal);\n# } Listing 10-25: A function we defined in Listing 4-9 that compiled without lifetime annotations, even though the parameter and return type are references The reason this function compiles without lifetime annotations is historical: in early versions (pre-1.0) of Rust, this code wouldn’t have compiled because every reference needed an explicit lifetime. At that time, the function signature would have been written like this: fn first_word<'a>(s: &'a str) -> &'a str { After writing a lot of Rust code, the Rust team found that Rust programmers were entering the same lifetime annotations over and over in particular situations. These situations were predictable and followed a few deterministic patterns. The developers programmed these patterns into the compiler’s code so the borrow checker could infer the lifetimes in these situations and wouldn’t need explicit annotations. This piece of Rust history is relevant because it’s possible that more deterministic patterns will emerge and be added to the compiler. In the future, even fewer lifetime annotations might be required. The patterns programmed into Rust’s analysis of references are called the lifetime elision rules . These aren’t rules for programmers to follow; they’re a set of particular cases that the compiler will consider, and if your code fits these cases, you don’t need to write the lifetimes explicitly. The elision rules don’t provide full inference. If there is still ambiguity as to what lifetimes the references have after Rust applies the rules, the compiler won’t guess what the lifetime of the remaining references should be. Instead of guessing, the compiler will give you an error that you can resolve by adding the lifetime annotations. Lifetimes on function or method parameters are called input lifetimes , and lifetimes on return values are called output lifetimes . The compiler uses three rules to figure out the lifetimes of the references when there aren’t explicit annotations. The first rule applies to input lifetimes, and the second and third rules apply to output lifetimes. If the compiler gets to the end of the three rules and there are still references for which it can’t figure out lifetimes, the compiler will stop with an error. These rules apply to fn definitions as well as impl blocks. The first rule is that the compiler assigns a lifetime parameter to each parameter that’s a reference. In other words, a function with one parameter gets one lifetime parameter: fn foo<'a>(x: &'a i32); a function with two parameters gets two separate lifetime parameters: fn foo<'a, 'b>(x: &'a i32, y: &'b i32); and so on. The second rule is that, if there is exactly one input lifetime parameter, that lifetime is assigned to all output lifetime parameters: fn foo<'a>(x: &'a i32) -> &'a i32. The third rule is that, if there are multiple input lifetime parameters, but one of them is &self or &mut self because this is a method, the lifetime of self is assigned to all output lifetime parameters. This third rule makes methods much nicer to read and write because fewer symbols are necessary. Let’s pretend we’re the compiler. We’ll apply these rules to figure out the lifetimes of the references in the signature of the first_word function in Listing 10-25. The signature starts without any lifetimes associated with the references: fn first_word(s: &str) -> &str { Then the compiler applies the first rule, which specifies that each parameter gets its own lifetime. We’ll call it 'a as usual, so now the signature is this: fn first_word<'a>(s: &'a str) -> &str { The second rule applies because there is exactly one input lifetime. The second rule specifies that the lifetime of the one input parameter gets assigned to the output lifetime, so the signature is now this: fn first_word<'a>(s: &'a str) -> &'a str { Now all the references in this function signature have lifetimes, and the compiler can continue its analysis without needing the programmer to annotate the lifetimes in this function signature. Let’s look at another example, this time using the longest function that had no lifetime parameters when we started working with it in Listing 10-20: fn longest(x: &str, y: &str) -> &str { Let’s apply the first rule: each parameter gets its own lifetime. This time we have two parameters instead of one, so we have two lifetimes: fn longest<'a, 'b>(x: &'a str, y: &'b str) -> &str { You can see that the second rule doesn’t apply because there is more than one input lifetime. The third rule doesn’t apply either, because longest is a function rather than a method, so none of the parameters are self. After working through all three rules, we still haven’t figured out what the return type’s lifetime is. This is why we got an error trying to compile the code in Listing 10-20: the compiler worked through the lifetime elision rules but still couldn’t figure out all the lifetimes of the references in the signature. Because the third rule really only applies in method signatures, we’ll look at lifetimes in that context next to see why the third rule means we don’t have to annotate lifetimes in method signatures very often.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Lifetime Elision","id":"186","title":"Lifetime Elision"},"187":{"body":"When we implement methods on a struct with lifetimes, we use the same syntax as that of generic type parameters shown in Listing 10-11. Where we declare and use the lifetime parameters depends on whether they’re related to the struct fields or the method parameters and return values. Lifetime names for struct fields always need to be declared after the impl keyword and then used after the struct’s name because those lifetimes are part of the struct’s type. In method signatures inside the impl block, references might be tied to the lifetime of references in the struct’s fields, or they might be independent. In addition, the lifetime elision rules often make it so that lifetime annotations aren’t necessary in method signatures. Let’s look at some examples using the struct named ImportantExcerpt that we defined in Listing 10-24. First we’ll use a method named level whose only parameter is a reference to self and whose return value is an i32, which is not a reference to anything: # struct ImportantExcerpt<'a> {\n# part: &'a str,\n# }\n# impl<'a> ImportantExcerpt<'a> { fn level(&self) -> i32 { 3 }\n}\n# # impl<'a> ImportantExcerpt<'a> {\n# fn announce_and_return_part(&self, announcement: &str) -> &str {\n# println!(\"Attention please: {announcement}\");\n# self.part\n# }\n# }\n# # fn main() {\n# let novel = String::from(\"Call me Ishmael. Some years ago...\");\n# let first_sentence = novel.split('.').next().unwrap();\n# let i = ImportantExcerpt {\n# part: first_sentence,\n# };\n# } The lifetime parameter declaration after impl and its use after the type name are required, but we’re not required to annotate the lifetime of the reference to self because of the first elision rule. Here is an example where the third lifetime elision rule applies: # struct ImportantExcerpt<'a> {\n# part: &'a str,\n# }\n# # impl<'a> ImportantExcerpt<'a> {\n# fn level(&self) -> i32 {\n# 3\n# }\n# }\n# impl<'a> ImportantExcerpt<'a> { fn announce_and_return_part(&self, announcement: &str) -> &str { println!(\"Attention please: {announcement}\"); self.part }\n}\n# # fn main() {\n# let novel = String::from(\"Call me Ishmael. Some years ago...\");\n# let first_sentence = novel.split('.').next().unwrap();\n# let i = ImportantExcerpt {\n# part: first_sentence,\n# };\n# } There are two input lifetimes, so Rust applies the first lifetime elision rule and gives both &self and announcement their own lifetimes. Then, because one of the parameters is &self, the return type gets the lifetime of &self, and all lifetimes have been accounted for.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Lifetime Annotations in Method Definitions","id":"187","title":"Lifetime Annotations in Method Definitions"},"188":{"body":"One special lifetime we need to discuss is 'static, which denotes that the affected reference can live for the entire duration of the program. All string literals have the 'static lifetime, which we can annotate as follows: let s: &'static str = \"I have a static lifetime.\"; The text of this string is stored directly in the program’s binary, which is always available. Therefore, the lifetime of all string literals is 'static. You might see suggestions to use the 'static lifetime in error messages. But before specifying 'static as the lifetime for a reference, think about whether the reference you have actually lives the entire lifetime of your program or not, and whether you want it to. Most of the time, an error message suggesting the 'static lifetime results from attempting to create a dangling reference or a mismatch of the available lifetimes. In such cases, the solution is to fix those problems, not to specify the 'static lifetime.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » The Static Lifetime","id":"188","title":"The Static Lifetime"},"189":{"body":"Let’s briefly look at the syntax of specifying generic type parameters, trait bounds, and lifetimes all in one function! # fn main() {\n# let string1 = String::from(\"abcd\");\n# let string2 = \"xyz\";\n# # let result = longest_with_an_announcement(\n# string1.as_str(),\n# string2,\n# \"Today is someone's birthday!\",\n# );\n# println!(\"The longest string is {result}\");\n# }\n# use std::fmt::Display; fn longest_with_an_announcement<'a, T>( x: &'a str, y: &'a str, ann: T,\n) -> &'a str\nwhere T: Display,\n{ println!(\"Announcement! {ann}\"); if x.len() > y.len() { x } else { y }\n} This is the longest function from Listing 10-21 that returns the longer of two string slices. But now it has an extra parameter named ann of the generic type T, which can be filled in by any type that implements the Display trait as specified by the where clause. This extra parameter will be printed using {}, which is why the Display trait bound is necessary. Because lifetimes are a type of generic, the declarations of the lifetime parameter 'a and the generic type parameter T go in the same list inside the angle brackets after the function name.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Generic Type Parameters, Trait Bounds, and Lifetimes Together","id":"189","title":"Generic Type Parameters, Trait Bounds, and Lifetimes Together"},"19":{"body":"The installation of Rust also includes a local copy of the documentation so that you can read it offline. Run rustup doc to open the local documentation in your browser. Any time a type or function is provided by the standard library and you’re not sure what it does or how to use it, use the application programming interface (API) documentation to find out!","breadcrumbs":"Getting Started » Installation » Local Documentation","id":"19","title":"Local Documentation"},"190":{"body":"We covered a lot in this chapter! Now that you know about generic type parameters, traits and trait bounds, and generic lifetime parameters, you’re ready to write code without repetition that works in many different situations. Generic type parameters let you apply the code to different types. Traits and trait bounds ensure that even though the types are generic, they’ll have the behavior the code needs. You learned how to use lifetime annotations to ensure that this flexible code won’t have any dangling references. And all of this analysis happens at compile time, which doesn’t affect runtime performance! Believe it or not, there is much more to learn on the topics we discussed in this chapter: Chapter 17 discusses trait objects, which are another way to use traits. There are also more complex scenarios involving lifetime annotations that you will only need in very advanced scenarios; for those, you should read the Rust Reference . But next, you’ll learn how to write tests in Rust so you can make sure your code is working the way it should.","breadcrumbs":"Generic Types, Traits, and Lifetimes » Validating References with Lifetimes » Summary","id":"190","title":"Summary"},"191":{"body":"In his 1972 essay “The Humble Programmer,” Edsger W. Dijkstra said that “Program testing can be a very effective way to show the presence of bugs, but it is hopelessly inadequate for showing their absence.” That doesn’t mean we shouldn’t try to test as much as we can! Correctness in our programs is the extent to which our code does what we intend it to do. Rust is designed with a high degree of concern about the correctness of programs, but correctness is complex and not easy to prove. Rust’s type system shoulders a huge part of this burden, but the type system cannot catch everything. As such, Rust includes support for writing automated software tests. Say we write a function add_two that adds 2 to whatever number is passed to it. This function’s signature accepts an integer as a parameter and returns an integer as a result. When we implement and compile that function, Rust does all the type checking and borrow checking that you’ve learned so far to ensure that, for instance, we aren’t passing a String value or an invalid reference to this function. But Rust can’t check that this function will do precisely what we intend, which is return the parameter plus 2 rather than, say, the parameter plus 10 or the parameter minus 50! That’s where tests come in. We can write tests that assert, for example, that when we pass 3 to the add_two function, the returned value is 5. We can run these tests whenever we make changes to our code to make sure any existing correct behavior has not changed. Testing is a complex skill: although we can’t cover every detail about how to write good tests in one chapter, we’ll discuss the mechanics of Rust’s testing facilities. We’ll talk about the annotations and macros available to you when writing your tests, the default behavior and options provided for running your tests, and how to organize tests into unit tests and integration tests.","breadcrumbs":"Writing Automated Tests » Writing Automated Tests","id":"191","title":"Writing Automated Tests"},"192":{"body":"Tests are Rust functions that verify that the non-test code is functioning in the expected manner. The bodies of test functions typically perform these three actions: Set up any needed data or state. Run the code you want to test. Assert the results are what you expect. Let’s look at the features Rust provides specifically for writing tests that take these actions, which include the test attribute, a few macros, and the should_panic attribute.","breadcrumbs":"Writing Automated Tests » How to Write Tests » How to Write Tests","id":"192","title":"How to Write Tests"},"193":{"body":"At its simplest, a test in Rust is a function that’s annotated with the test attribute. Attributes are metadata about pieces of Rust code; one example is the derive attribute we used with structs in Chapter 5. To change a function into a test function, add #[test] on the line before fn. When you run your tests with the cargo test command, Rust builds a test runner binary that runs the annotated functions and reports on whether each test function passes or fails. Whenever we make a new library project with Cargo, a test module with a test function in it is automatically generated for us. This module gives you a template for writing your tests so you don’t have to look up the exact structure and syntax every time you start a new project. You can add as many additional test functions and as many test modules as you want! We’ll explore some aspects of how tests work by experimenting with the template test before we actually test any code. Then we’ll write some real-world tests that call some code that we’ve written and assert that its behavior is correct. Let’s create a new library project called adder that will add two numbers: $ cargo new adder --lib Created library `adder` project\n$ cd adder The contents of the src/lib.rs file in your adder library should look like Listing 11-1. Filename: src/lib.rs pub fn add(left: usize, right: usize) -> usize { left + right\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn it_works() { let result = add(2, 2); assert_eq!(result, 4); }\n} Listing 11-1: The test module and function generated automatically by cargo new For now, let’s focus solely on the it_works() function. Note the #[test] annotation: this attribute indicates this is a test function, so the test runner knows to treat this function as a test. We might also have non-test functions in the tests module to help set up common scenarios or perform common operations, so we always need to indicate which functions are tests. The example function body uses the assert_eq! macro to assert that result, which contains the result of adding 2 and 2, equals 4. This assertion serves as an example of the format for a typical test. Let’s run it to see that this test passes. The cargo test command runs all tests in our project, as shown in Listing 11-2. $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.57s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 1 test\ntest tests::it_works ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Listing 11-2: The output from running the automatically generated test Cargo compiled and ran the test. We see the line running 1 test. The next line shows the name of the generated test function, called it_works, and that the result of running that test is ok. The overall summary test result: ok. means that all the tests passed, and the portion that reads 1 passed; 0 failed totals the number of tests that passed or failed. It’s possible to mark a test as ignored so it doesn’t run in a particular instance; we’ll cover that in the “Ignoring Some Tests Unless Specifically Requested” section later in this chapter. Because we haven’t done that here, the summary shows 0 ignored. We can also pass an argument to the cargo test command to run only tests whose name matches a string; this is called filtering and we’ll cover that in the “Running a Subset of Tests by Name” section. We also haven’t filtered the tests being run, so the end of the summary shows 0 filtered out. The 0 measured statistic is for benchmark tests that measure performance. Benchmark tests are, as of this writing, only available in nightly Rust. See the documentation about benchmark tests to learn more. The next part of the test output starting at Doc-tests adder is for the results of any documentation tests. We don’t have any documentation tests yet, but Rust can compile any code examples that appear in our API documentation. This feature helps keep your docs and your code in sync! We’ll discuss how to write documentation tests in the “Documentation Comments as Tests” section of Chapter 14. For now, we’ll ignore the Doc-tests output. Let’s start to customize the test to our own needs. First change the name of the it_works function to a different name, such as exploration, like so: Filename: src/lib.rs pub fn add(left: usize, right: usize) -> usize { left + right\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn exploration() { let result = add(2, 2); assert_eq!(result, 4); }\n} Then run cargo test again. The output now shows exploration instead of it_works: $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.59s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 1 test\ntest tests::exploration ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Now we’ll add another test, but this time we’ll make a test that fails! Tests fail when something in the test function panics. Each test is run in a new thread, and when the main thread sees that a test thread has died, the test is marked as failed. In Chapter 9, we talked about how the simplest way to panic is to call the panic! macro. Enter the new test as a function named another, so your src/lib.rs file looks like Listing 11-3. Filename: src/lib.rs pub fn add(left: usize, right: usize) -> usize { left + right\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn exploration() { let result = add(2, 2); assert_eq!(result, 4); } #[test] fn another() { panic!(\"Make this test fail\"); }\n} Listing 11-3: Adding a second test that will fail because we call the panic! macro Run the tests again using cargo test. The output should look like Listing 11-4, which shows that our exploration test passed and another failed. $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.72s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 2 tests\ntest tests::another ... FAILED\ntest tests::exploration ... ok failures: ---- tests::another stdout ----\nthread 'tests::another' panicked at src/lib.rs:17:9:\nMake this test fail\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::another test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` Listing 11-4: Test results when one test passes and one test fails Instead of ok, the line test tests::another shows FAILED. Two new sections appear between the individual results and the summary: the first displays the detailed reason for each test failure. In this case, we get the details that another failed because it panicked at 'Make this test fail' on line 10 in the src/lib.rs file. The next section lists just the names of all the failing tests, which is useful when there are lots of tests and lots of detailed failing test output. We can use the name of a failing test to run just that test to more easily debug it; we’ll talk more about ways to run tests in the “Controlling How Tests Are Run” section. The summary line displays at the end: overall, our test result is FAILED. We had one test pass and one test fail. Now that you’ve seen what the test results look like in different scenarios, let’s look at some macros other than panic! that are useful in tests.","breadcrumbs":"Writing Automated Tests » How to Write Tests » The Anatomy of a Test Function","id":"193","title":"The Anatomy of a Test Function"},"194":{"body":"The assert! macro, provided by the standard library, is useful when you want to ensure that some condition in a test evaluates to true. We give the assert! macro an argument that evaluates to a Boolean. If the value is true, nothing happens and the test passes. If the value is false, the assert! macro calls panic! to cause the test to fail. Using the assert! macro helps us check that our code is functioning in the way we intend. In Chapter 5, Listing 5-15, we used a Rectangle struct and a can_hold method, which are repeated here in Listing 11-5. Let’s put this code in the src/lib.rs file, then write some tests for it using the assert! macro. Filename: src/lib.rs #[derive(Debug)]\nstruct Rectangle { width: u32, height: u32,\n} impl Rectangle { fn can_hold(&self, other: &Rectangle) -> bool { self.width > other.width && self.height > other.height }\n} Listing 11-5: The Rectangle struct and its can_hold method from Chapter 5 The can_hold method returns a Boolean, which means it’s a perfect use case for the assert! macro. In Listing 11-6, we write a test that exercises the can_hold method by creating a Rectangle instance that has a width of 8 and a height of 7 and asserting that it can hold another Rectangle instance that has a width of 5 and a height of 1. Filename: src/lib.rs # #[derive(Debug)]\n# struct Rectangle {\n# width: u32,\n# height: u32,\n# }\n# # impl Rectangle {\n# fn can_hold(&self, other: &Rectangle) -> bool {\n# self.width > other.width && self.height > other.height\n# }\n# }\n# #[cfg(test)]\nmod tests { use super::*; #[test] fn larger_can_hold_smaller() { let larger = Rectangle { width: 8, height: 7, }; let smaller = Rectangle { width: 5, height: 1, }; assert!(larger.can_hold(&smaller)); }\n} Listing 11-6: A test for can_hold that checks whether a larger rectangle can indeed hold a smaller rectangle Note that we’ve added a new line inside the tests module: use super::*;. The tests module is a regular module that follows the usual visibility rules we covered in Chapter 7 in the “Paths for Referring to an Item in the Module Tree” section. Because the tests module is an inner module, we need to bring the code under test in the outer module into the scope of the inner module. We use a glob here so anything we define in the outer module is available to this tests module. We’ve named our test larger_can_hold_smaller, and we’ve created the two Rectangle instances that we need. Then we called the assert! macro and passed it the result of calling larger.can_hold(&smaller). This expression is supposed to return true, so our test should pass. Let’s find out! $ cargo test Compiling rectangle v0.1.0 (file:///projects/rectangle) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e) running 1 test\ntest tests::larger_can_hold_smaller ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests rectangle running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s It does pass! Let’s add another test, this time asserting that a smaller rectangle cannot hold a larger rectangle: Filename: src/lib.rs # #[derive(Debug)]\n# struct Rectangle {\n# width: u32,\n# height: u32,\n# }\n# # impl Rectangle {\n# fn can_hold(&self, other: &Rectangle) -> bool {\n# self.width > other.width && self.height > other.height\n# }\n# }\n# #[cfg(test)]\nmod tests { use super::*; #[test] fn larger_can_hold_smaller() { // --snip--\n# let larger = Rectangle {\n# width: 8,\n# height: 7,\n# };\n# let smaller = Rectangle {\n# width: 5,\n# height: 1,\n# };\n# # assert!(larger.can_hold(&smaller)); } #[test] fn smaller_cannot_hold_larger() { let larger = Rectangle { width: 8, height: 7, }; let smaller = Rectangle { width: 5, height: 1, }; assert!(!smaller.can_hold(&larger)); }\n} Because the correct result of the can_hold function in this case is false, we need to negate that result before we pass it to the assert! macro. As a result, our test will pass if can_hold returns false: $ cargo test Compiling rectangle v0.1.0 (file:///projects/rectangle) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e) running 2 tests\ntest tests::larger_can_hold_smaller ... ok\ntest tests::smaller_cannot_hold_larger ... ok test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests rectangle running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Two tests that pass! Now let’s see what happens to our test results when we introduce a bug in our code. We’ll change the implementation of the can_hold method by replacing the greater-than sign with a less-than sign when it compares the widths: # #[derive(Debug)]\n# struct Rectangle {\n# width: u32,\n# height: u32,\n# }\n# // --snip--\nimpl Rectangle { fn can_hold(&self, other: &Rectangle) -> bool { self.width < other.width && self.height > other.height }\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn larger_can_hold_smaller() {\n# let larger = Rectangle {\n# width: 8,\n# height: 7,\n# };\n# let smaller = Rectangle {\n# width: 5,\n# height: 1,\n# };\n# # assert!(larger.can_hold(&smaller));\n# }\n# # #[test]\n# fn smaller_cannot_hold_larger() {\n# let larger = Rectangle {\n# width: 8,\n# height: 7,\n# };\n# let smaller = Rectangle {\n# width: 5,\n# height: 1,\n# };\n# # assert!(!smaller.can_hold(&larger));\n# }\n# } Running the tests now produces the following: $ cargo test Compiling rectangle v0.1.0 (file:///projects/rectangle) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s Running unittests src/lib.rs (target/debug/deps/rectangle-6584c4561e48942e) running 2 tests\ntest tests::larger_can_hold_smaller ... FAILED\ntest tests::smaller_cannot_hold_larger ... ok failures: ---- tests::larger_can_hold_smaller stdout ----\nthread 'tests::larger_can_hold_smaller' panicked at src/lib.rs:28:9:\nassertion failed: larger.can_hold(&smaller)\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::larger_can_hold_smaller test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` Our tests caught the bug! Because larger.width is 8 and smaller.width is 5, the comparison of the widths in can_hold now returns false: 8 is not less than 5.","breadcrumbs":"Writing Automated Tests » How to Write Tests » Checking Results with the assert! Macro","id":"194","title":"Checking Results with the assert! Macro"},"195":{"body":"A common way to verify functionality is to test for equality between the result of the code under test and the value you expect the code to return. You could do this using the assert! macro and passing it an expression using the == operator. However, this is such a common test that the standard library provides a pair of macros—assert_eq! and assert_ne!—to perform this test more conveniently. These macros compare two arguments for equality or inequality, respectively. They’ll also print the two values if the assertion fails, which makes it easier to see why the test failed; conversely, the assert! macro only indicates that it got a false value for the == expression, without printing the values that led to the false value. In Listing 11-7, we write a function named add_two that adds 2 to its parameter, then we test this function using the assert_eq! macro. Filename: src/lib.rs pub fn add_two(a: i32) -> i32 { a + 2\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn it_adds_two() { assert_eq!(4, add_two(2)); }\n} Listing 11-7: Testing the function add_two using the assert_eq! macro Let’s check that it passes! $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 1 test\ntest tests::it_adds_two ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s We pass 4 as the argument to assert_eq!, which is equal to the result of calling add_two(2). The line for this test is test tests::it_adds_two ... ok, and the ok text indicates that our test passed! Let’s introduce a bug into our code to see what assert_eq! looks like when it fails. Change the implementation of the add_two function to instead add 3: pub fn add_two(a: i32) -> i32 { a + 3\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn it_adds_two() {\n# assert_eq!(add_two(2), 4);\n# }\n# } Run the tests again: $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 1 test\ntest tests::it_adds_two ... FAILED failures: ---- tests::it_adds_two stdout ----\nassertion `left == right` failed left: 5 right: 4\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::it_adds_two test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` Our test caught the bug! The it_adds_two test failed, and the message tells us that the assertion that fails was assertion `left == right` failed and what the left and right values are. This message helps us start debugging: the left argument was 4 but the right argument, where we had add_two(2), was 5. You can imagine that this would be especially helpful when we have a lot of tests going on. Note that in some languages and test frameworks, the parameters to equality assertion functions are called expected and actual, and the order in which we specify the arguments matters. However, in Rust, they’re called left and right, and the order in which we specify the value we expect and the value the code produces doesn’t matter. We could write the assertion in this test as assert_eq!(4, add_two(2)), which would result in the same failure message that displays assertion failed: `(left == right)`. The assert_ne! macro will pass if the two values we give it are not equal and fail if they’re equal. This macro is most useful for cases when we’re not sure what a value will be, but we know what the value definitely shouldn’t be. For example, if we’re testing a function that is guaranteed to change its input in some way, but the way in which the input is changed depends on the day of the week that we run our tests, the best thing to assert might be that the output of the function is not equal to the input. Under the surface, the assert_eq! and assert_ne! macros use the operators == and !=, respectively. When the assertions fail, these macros print their arguments using debug formatting, which means the values being compared must implement the PartialEq and Debug traits. All primitive types and most of the standard library types implement these traits. For structs and enums that you define yourself, you’ll need to implement PartialEq to assert equality of those types. You’ll also need to implement Debug to print the values when the assertion fails. Because both traits are derivable traits, as mentioned in Listing 5-12 in Chapter 5, this is usually as straightforward as adding the #[derive(PartialEq, Debug)] annotation to your struct or enum definition. See Appendix C, “Derivable Traits,” for more details about these and other derivable traits.","breadcrumbs":"Writing Automated Tests » How to Write Tests » Testing Equality with the assert_eq! and assert_ne! Macros","id":"195","title":"Testing Equality with the assert_eq! and assert_ne! Macros"},"196":{"body":"You can also add a custom message to be printed with the failure message as optional arguments to the assert!, assert_eq!, and assert_ne! macros. Any arguments specified after the required arguments are passed along to the format! macro (discussed in Chapter 8 in the “Concatenation with the + Operator or the format! Macro” section), so you can pass a format string that contains {} placeholders and values to go in those placeholders. Custom messages are useful for documenting what an assertion means; when a test fails, you’ll have a better idea of what the problem is with the code. For example, let’s say we have a function that greets people by name and we want to test that the name we pass into the function appears in the output: Filename: src/lib.rs pub fn greeting(name: &str) -> String { format!(\"Hello {name}!\")\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn greeting_contains_name() { let result = greeting(\"Carol\"); assert!(result.contains(\"Carol\")); }\n} The requirements for this program haven’t been agreed upon yet, and we’re pretty sure the Hello text at the beginning of the greeting will change. We decided we don’t want to have to update the test when the requirements change, so instead of checking for exact equality to the value returned from the greeting function, we’ll just assert that the output contains the text of the input parameter. Now let’s introduce a bug into this code by changing greeting to exclude name to see what the default test failure looks like: pub fn greeting(name: &str) -> String { String::from(\"Hello!\")\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn greeting_contains_name() {\n# let result = greeting(\"Carol\");\n# assert!(result.contains(\"Carol\"));\n# }\n# } Running this test produces the following: $ cargo test Compiling greeter v0.1.0 (file:///projects/greeter) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.91s Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a) running 1 test\ntest tests::greeting_contains_name ... FAILED failures: ---- tests::greeting_contains_name stdout ----\nthread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:\nassertion failed: result.contains(\"Carol\")\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::greeting_contains_name test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` This result just indicates that the assertion failed and which line the assertion is on. A more useful failure message would print the value from the greeting function. Let’s add a custom failure message composed of a format string with a placeholder filled in with the actual value we got from the greeting function: # pub fn greeting(name: &str) -> String {\n# String::from(\"Hello!\")\n# }\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# #[test] fn greeting_contains_name() { let result = greeting(\"Carol\"); assert!( result.contains(\"Carol\"), \"Greeting did not contain name, value was `{}`\", result ); }\n# } Now when we run the test, we’ll get a more informative error message: $ cargo test Compiling greeter v0.1.0 (file:///projects/greeter) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.93s Running unittests src/lib.rs (target/debug/deps/greeter-170b942eb5bf5e3a) running 1 test\ntest tests::greeting_contains_name ... FAILED failures: ---- tests::greeting_contains_name stdout ----\nthread 'tests::greeting_contains_name' panicked at src/lib.rs:12:9:\nGreeting did not contain name, value was `Hello!`\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::greeting_contains_name test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` We can see the value we actually got in the test output, which would help us debug what happened instead of what we were expecting to happen.","breadcrumbs":"Writing Automated Tests » How to Write Tests » Adding Custom Failure Messages","id":"196","title":"Adding Custom Failure Messages"},"197":{"body":"In addition to checking return values, it’s important to check that our code handles error conditions as we expect. For example, consider the Guess type that we created in Chapter 9, Listing 9-13. Other code that uses Guess depends on the guarantee that Guess instances will contain only values between 1 and 100. We can write a test that ensures that attempting to create a Guess instance with a value outside that range panics. We do this by adding the attribute should_panic to our test function. The test passes if the code inside the function panics; the test fails if the code inside the function doesn’t panic. Listing 11-8 shows a test that checks that the error conditions of Guess::new happen when we expect them to. Filename: src/lib.rs pub struct Guess { value: i32,\n} impl Guess { pub fn new(value: i32) -> Guess { if value < 1 || value > 100 { panic!(\"Guess value must be between 1 and 100, got {value}.\"); } Guess { value } }\n} #[cfg(test)]\nmod tests { use super::*; #[test] #[should_panic] fn greater_than_100() { Guess::new(200); }\n} Listing 11-8: Testing that a condition will cause a panic! We place the #[should_panic] attribute after the #[test] attribute and before the test function it applies to. Let’s look at the result when this test passes: $ cargo test Compiling guessing_game v0.1.0 (file:///projects/guessing_game) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d) running 1 test\ntest tests::greater_than_100 - should panic ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests guessing_game running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Looks good! Now let’s introduce a bug in our code by removing the condition that the new function will panic if the value is greater than 100: # pub struct Guess {\n# value: i32,\n# }\n# // --snip--\nimpl Guess { pub fn new(value: i32) -> Guess { if value < 1 { panic!(\"Guess value must be between 1 and 100, got {value}.\"); } Guess { value } }\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# #[should_panic]\n# fn greater_than_100() {\n# Guess::new(200);\n# }\n# } When we run the test in Listing 11-8, it will fail: $ cargo test Compiling guessing_game v0.1.0 (file:///projects/guessing_game) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.62s Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d) running 1 test\ntest tests::greater_than_100 - should panic ... FAILED failures: ---- tests::greater_than_100 stdout ----\nnote: test did not panic as expected failures: tests::greater_than_100 test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` We don’t get a very helpful message in this case, but when we look at the test function, we see that it’s annotated with #[should_panic]. The failure we got means that the code in the test function did not cause a panic. Tests that use should_panic can be imprecise. A should_panic test would pass even if the test panics for a different reason from the one we were expecting. To make should_panic tests more precise, we can add an optional expected parameter to the should_panic attribute. The test harness will make sure that the failure message contains the provided text. For example, consider the modified code for Guess in Listing 11-9 where the new function panics with different messages depending on whether the value is too small or too large. Filename: src/lib.rs # pub struct Guess {\n# value: i32,\n# }\n# // --snip-- impl Guess { pub fn new(value: i32) -> Guess { if value < 1 { panic!( \"Guess value must be greater than or equal to 1, got {value}.\" ); } else if value > 100 { panic!( \"Guess value must be less than or equal to 100, got {value}.\" ); } Guess { value } }\n} #[cfg(test)]\nmod tests { use super::*; #[test] #[should_panic(expected = \"less than or equal to 100\")] fn greater_than_100() { Guess::new(200); }\n} Listing 11-9: Testing for a panic! with a panic message containing a specified substring This test will pass because the value we put in the should_panic attribute’s expected parameter is a substring of the message that the Guess::new function panics with. We could have specified the entire panic message that we expect, which in this case would be Guess value must be less than or equal to 100, got 200. What you choose to specify depends on how much of the panic message is unique or dynamic and how precise you want your test to be. In this case, a substring of the panic message is enough to ensure that the code in the test function executes the else if value > 100 case. To see what happens when a should_panic test with an expected message fails, let’s again introduce a bug into our code by swapping the bodies of the if value < 1 and the else if value > 100 blocks: # pub struct Guess {\n# value: i32,\n# }\n# # impl Guess {\n# pub fn new(value: i32) -> Guess { if value < 1 { panic!( \"Guess value must be less than or equal to 100, got {value}.\" ); } else if value > 100 { panic!( \"Guess value must be greater than or equal to 1, got {value}.\" ); }\n# # Guess { value }\n# }\n# }\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# #[should_panic(expected = \"less than or equal to 100\")]\n# fn greater_than_100() {\n# Guess::new(200);\n# }\n# } This time when we run the should_panic test, it will fail: $ cargo test Compiling guessing_game v0.1.0 (file:///projects/guessing_game) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.66s Running unittests src/lib.rs (target/debug/deps/guessing_game-57d70c3acb738f4d) running 1 test\ntest tests::greater_than_100 - should panic ... FAILED failures: ---- tests::greater_than_100 stdout ----\nthread 'tests::greater_than_100' panicked at src/lib.rs:12:13:\nGuess value must be greater than or equal to 1, got 200.\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace\nnote: panic did not contain expected string panic message: `\"Guess value must be greater than or equal to 1, got 200.\"`, expected substring: `\"less than or equal to 100\"` failures: tests::greater_than_100 test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` The failure message indicates that this test did indeed panic as we expected, but the panic message did not include the expected string less than or equal to 100. The panic message that we did get in this case was Guess value must be greater than or equal to 1, got 200. Now we can start figuring out where our bug is!","breadcrumbs":"Writing Automated Tests » How to Write Tests » Checking for Panics with should_panic","id":"197","title":"Checking for Panics with should_panic"},"198":{"body":"Our tests so far all panic when they fail. We can also write tests that use Result! Here’s the test from Listing 11-1, rewritten to use Result and return an Err instead of panicking: #[cfg(test)]\nmod tests { #[test] fn it_works() -> Result<(), String> { if 2 + 2 == 4 { Ok(()) } else { Err(String::from(\"two plus two does not equal four\")) } }\n} The it_works function now has the Result<(), String> return type. In the body of the function, rather than calling the assert_eq! macro, we return Ok(()) when the test passes and an Err with a String inside when the test fails. Writing tests so they return a Result enables you to use the question mark operator in the body of tests, which can be a convenient way to write tests that should fail if any operation within them returns an Err variant. You can’t use the #[should_panic] annotation on tests that use Result. To assert that an operation returns an Err variant, don’t use the question mark operator on the Result value. Instead, use assert!(value.is_err()). Now that you know several ways to write tests, let’s look at what is happening when we run our tests and explore the different options we can use with cargo test.","breadcrumbs":"Writing Automated Tests » How to Write Tests » Using Result in Tests","id":"198","title":"Using Result in Tests"},"199":{"body":"Just as cargo run compiles your code and then runs the resulting binary, cargo test compiles your code in test mode and runs the resulting test binary. The default behavior of the binary produced by cargo test is to run all the tests in parallel and capture output generated during test runs, preventing the output from being displayed and making it easier to read the output related to the test results. You can, however, specify command line options to change this default behavior. Some command line options go to cargo test, and some go to the resulting test binary. To separate these two types of arguments, you list the arguments that go to cargo test followed by the separator -- and then the ones that go to the test binary. Running cargo test --help displays the options you can use with cargo test, and running cargo test -- --help displays the options you can use after the separator.","breadcrumbs":"Writing Automated Tests » Controlling How Tests Are Run » Controlling How Tests Are Run","id":"199","title":"Controlling How Tests Are Run"},"2":{"body":"Note: This edition of the book is the same as The Rust Programming Language available in print and ebook format from No Starch Press . Welcome to The Rust Programming Language , an introductory book about Rust. The Rust programming language helps you write faster, more reliable software. High-level ergonomics and low-level control are often at odds in programming language design; Rust challenges that conflict. Through balancing powerful technical capacity and a great developer experience, Rust gives you the option to control low-level details (such as memory usage) without all the hassle traditionally associated with such control.","breadcrumbs":"Introduction » Introduction","id":"2","title":"Introduction"},"20":{"body":"Now that you’ve installed Rust, it’s time to write your first Rust program. It’s traditional when learning a new language to write a little program that prints the text Hello, world! to the screen, so we’ll do the same here! Note: This book assumes basic familiarity with the command line. Rust makes no specific demands about your editing or tooling or where your code lives, so if you prefer to use an integrated development environment (IDE) instead of the command line, feel free to use your favorite IDE. Many IDEs now have some degree of Rust support; check the IDE’s documentation for details. The Rust team has been focusing on enabling great IDE support via rust-analyzer. See Appendix D for more details.","breadcrumbs":"Getting Started » Hello, World! » Hello, World!","id":"20","title":"Hello, World!"},"200":{"body":"When you run multiple tests, by default they run in parallel using threads, meaning they finish running faster and you get feedback quicker. Because the tests are running at the same time, you must make sure your tests don’t depend on each other or on any shared state, including a shared environment, such as the current working directory or environment variables. For example, say each of your tests runs some code that creates a file on disk named test-output.txt and writes some data to that file. Then each test reads the data in that file and asserts that the file contains a particular value, which is different in each test. Because the tests run at the same time, one test might overwrite the file in the time between another test writing and reading the file. The second test will then fail, not because the code is incorrect but because the tests have interfered with each other while running in parallel. One solution is to make sure each test writes to a different file; another solution is to run the tests one at a time. If you don’t want to run the tests in parallel or if you want more fine-grained control over the number of threads used, you can send the --test-threads flag and the number of threads you want to use to the test binary. Take a look at the following example: $ cargo test -- --test-threads=1 We set the number of test threads to 1, telling the program not to use any parallelism. Running the tests using one thread will take longer than running them in parallel, but the tests won’t interfere with each other if they share state.","breadcrumbs":"Writing Automated Tests » Controlling How Tests Are Run » Running Tests in Parallel or Consecutively","id":"200","title":"Running Tests in Parallel or Consecutively"},"201":{"body":"By default, if a test passes, Rust’s test library captures anything printed to standard output. For example, if we call println! in a test and the test passes, we won’t see the println! output in the terminal; we’ll see only the line that indicates the test passed. If a test fails, we’ll see whatever was printed to standard output with the rest of the failure message. As an example, Listing 11-10 has a silly function that prints the value of its parameter and returns 10, as well as a test that passes and a test that fails. Filename: src/lib.rs fn prints_and_returns_10(a: i32) -> i32 { println!(\"I got the value {a}\"); 10\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn this_test_will_pass() { let value = prints_and_returns_10(4); assert_eq!(10, value); } #[test] fn this_test_will_fail() { let value = prints_and_returns_10(8); assert_eq!(5, value); }\n} Listing 11-10: Tests for a function that calls println! When we run these tests with cargo test, we’ll see the following output: $ cargo test Compiling silly-function v0.1.0 (file:///projects/silly-function) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.58s Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166) running 2 tests\ntest tests::this_test_will_fail ... FAILED\ntest tests::this_test_will_pass ... ok failures: ---- tests::this_test_will_fail stdout ----\nI got the value 8\nthread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:\nassertion `left == right` failed left: 5 right: 10\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::this_test_will_fail test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` Note that nowhere in this output do we see I got the value 4, which is what is printed when the test that passes runs. That output has been captured. The output from the test that failed, I got the value 8, appears in the section of the test summary output, which also shows the cause of the test failure. If we want to see printed values for passing tests as well, we can tell Rust to also show the output of successful tests with --show-output. $ cargo test -- --show-output When we run the tests in Listing 11-10 again with the --show-output flag, we see the following output: $ cargo test -- --show-output Compiling silly-function v0.1.0 (file:///projects/silly-function) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s Running unittests src/lib.rs (target/debug/deps/silly_function-160869f38cff9166) running 2 tests\ntest tests::this_test_will_fail ... FAILED\ntest tests::this_test_will_pass ... ok successes: ---- tests::this_test_will_pass stdout ----\nI got the value 4 successes: tests::this_test_will_pass failures: ---- tests::this_test_will_fail stdout ----\nI got the value 8\nthread 'tests::this_test_will_fail' panicked at src/lib.rs:19:9:\nassertion `left == right` failed left: 5 right: 10\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::this_test_will_fail test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib`","breadcrumbs":"Writing Automated Tests » Controlling How Tests Are Run » Showing Function Output","id":"201","title":"Showing Function Output"},"202":{"body":"Sometimes, running a full test suite can take a long time. If you’re working on code in a particular area, you might want to run only the tests pertaining to that code. You can choose which tests to run by passing cargo test the name or names of the test(s) you want to run as an argument. To demonstrate how to run a subset of tests, we’ll first create three tests for our add_two function, as shown in Listing 11-11, and choose which ones to run. Filename: src/lib.rs pub fn add_two(a: i32) -> i32 { a + 2\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn add_two_and_two() { assert_eq!(4, add_two(2)); } #[test] fn add_three_and_two() { assert_eq!(5, add_two(3)); } #[test] fn one_hundred() { assert_eq!(102, add_two(100)); }\n} Listing 11-11: Three tests with three different names If we run the tests without passing any arguments, as we saw earlier, all the tests will run in parallel: $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.62s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 3 tests\ntest tests::add_three_and_two ... ok\ntest tests::add_two_and_two ... ok\ntest tests::one_hundred ... ok test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Running Single Tests We can pass the name of any test function to cargo test to run only that test: $ cargo test one_hundred Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.69s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 1 test\ntest tests::one_hundred ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out; finished in 0.00s Only the test with the name one_hundred ran; the other two tests didn’t match that name. The test output lets us know we had more tests that didn’t run by displaying 2 filtered out at the end. We can’t specify the names of multiple tests in this way; only the first value given to cargo test will be used. But there is a way to run multiple tests. Filtering to Run Multiple Tests We can specify part of a test name, and any test whose name matches that value will be run. For example, because two of our tests’ names contain add, we can run those two by running cargo test add: $ cargo test add Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 2 tests\ntest tests::add_three_and_two ... ok\ntest tests::add_two_and_two ... ok test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s This command ran all tests with add in the name and filtered out the test named one_hundred. Also note that the module in which a test appears becomes part of the test’s name, so we can run all the tests in a module by filtering on the module’s name.","breadcrumbs":"Writing Automated Tests » Controlling How Tests Are Run » Running a Subset of Tests by Name","id":"202","title":"Running a Subset of Tests by Name"},"203":{"body":"Sometimes a few specific tests can be very time-consuming to execute, so you might want to exclude them during most runs of cargo test. Rather than listing as arguments all tests you do want to run, you can instead annotate the time-consuming tests using the ignore attribute to exclude them, as shown here: Filename: src/lib.rs #[test]\nfn it_works() { assert_eq!(2 + 2, 4);\n} #[test]\n#[ignore]\nfn expensive_test() { // code that takes an hour to run\n} After #[test] we add the #[ignore] line to the test we want to exclude. Now when we run our tests, it_works runs, but expensive_test doesn’t: $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.60s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 2 tests\ntest expensive_test ... ignored\ntest it_works ... ok test result: ok. 1 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s The expensive_test function is listed as ignored. If we want to run only the ignored tests, we can use cargo test -- --ignored: $ cargo test -- --ignored Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.61s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 1 test\ntest expensive_test ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s By controlling which tests run, you can make sure your cargo test results will be fast. When you’re at a point where it makes sense to check the results of the ignored tests and you have time to wait for the results, you can run cargo test -- --ignored instead. If you want to run all tests whether they’re ignored or not, you can run cargo test -- --include-ignored.","breadcrumbs":"Writing Automated Tests » Controlling How Tests Are Run » Ignoring Some Tests Unless Specifically Requested","id":"203","title":"Ignoring Some Tests Unless Specifically Requested"},"204":{"body":"As mentioned at the start of the chapter, testing is a complex discipline, and different people use different terminology and organization. The Rust community thinks about tests in terms of two main categories: unit tests and integration tests. Unit tests are small and more focused, testing one module in isolation at a time, and can test private interfaces. Integration tests are entirely external to your library and use your code in the same way any other external code would, using only the public interface and potentially exercising multiple modules per test. Writing both kinds of tests is important to ensure that the pieces of your library are doing what you expect them to, separately and together.","breadcrumbs":"Writing Automated Tests » Test Organization » Test Organization","id":"204","title":"Test Organization"},"205":{"body":"The purpose of unit tests is to test each unit of code in isolation from the rest of the code to quickly pinpoint where code is and isn’t working as expected. You’ll put unit tests in the src directory in each file with the code that they’re testing. The convention is to create a module named tests in each file to contain the test functions and to annotate the module with cfg(test). The Tests Module and #[cfg(test)] The #[cfg(test)] annotation on the tests module tells Rust to compile and run the test code only when you run cargo test, not when you run cargo build. This saves compile time when you only want to build the library and saves space in the resulting compiled artifact because the tests are not included. You’ll see that because integration tests go in a different directory, they don’t need the #[cfg(test)] annotation. However, because unit tests go in the same files as the code, you’ll use #[cfg(test)] to specify that they shouldn’t be included in the compiled result. Recall that when we generated the new adder project in the first section of this chapter, Cargo generated this code for us: Filename: src/lib.rs pub fn add(left: usize, right: usize) -> usize { left + right\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn it_works() { let result = add(2, 2); assert_eq!(result, 4); }\n} This code is the automatically generated test module. The attribute cfg stands for configuration and tells Rust that the following item should only be included given a certain configuration option. In this case, the configuration option is test, which is provided by Rust for compiling and running tests. By using the cfg attribute, Cargo compiles our test code only if we actively run the tests with cargo test. This includes any helper functions that might be within this module, in addition to the functions annotated with #[test]. Testing Private Functions There’s debate within the testing community about whether or not private functions should be tested directly, and other languages make it difficult or impossible to test private functions. Regardless of which testing ideology you adhere to, Rust’s privacy rules do allow you to test private functions. Consider the code in Listing 11-12 with the private function internal_adder. Filename: src/lib.rs pub fn add_two(a: i32) -> i32 { internal_adder(a, 2)\n} fn internal_adder(a: i32, b: i32) -> i32 { a + b\n} #[cfg(test)]\nmod tests { use super::*; #[test] fn internal() { assert_eq!(4, internal_adder(2, 2)); }\n} Listing 11-12: Testing a private function Note that the internal_adder function is not marked as pub. Tests are just Rust code, and the tests module is just another module. As we discussed in the “Paths for Referring to an Item in the Module Tree” section, items in child modules can use the items in their ancestor modules. In this test, we bring all of the tests module’s parent’s items into scope with use super::*, and then the test can call internal_adder. If you don’t think private functions should be tested, there’s nothing in Rust that will compel you to do so.","breadcrumbs":"Writing Automated Tests » Test Organization » Unit Tests","id":"205","title":"Unit Tests"},"206":{"body":"In Rust, integration tests are entirely external to your library. They use your library in the same way any other code would, which means they can only call functions that are part of your library’s public API. Their purpose is to test whether many parts of your library work together correctly. Units of code that work correctly on their own could have problems when integrated, so test coverage of the integrated code is important as well. To create integration tests, you first need a tests directory. The tests Directory We create a tests directory at the top level of our project directory, next to src . Cargo knows to look for integration test files in this directory. We can then make as many test files as we want, and Cargo will compile each of the files as an individual crate. Let’s create an integration test. With the code in Listing 11-12 still in the src/lib.rs file, make a tests directory, and create a new file named tests/integration_test.rs . Your directory structure should look like this: adder\n├── Cargo.lock\n├── Cargo.toml\n├── src\n│ └── lib.rs\n└── tests └── integration_test.rs Enter the code in Listing 11-13 into the tests/integration_test.rs file: Filename: tests/integration_test.rs use adder::add_two; #[test]\nfn it_adds_two() { assert_eq!(4, add_two(2));\n} Listing 11-13: An integration test of a function in the adder crate Each file in the tests directory is a separate crate, so we need to bring our library into each test crate’s scope. For that reason we add use adder::add_two at the top of the code, which we didn’t need in the unit tests. We don’t need to annotate any code in tests/integration_test.rs with #[cfg(test)]. Cargo treats the tests directory specially and compiles files in this directory only when we run cargo test. Run cargo test now: $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 1.31s Running unittests src/lib.rs (target/debug/deps/adder-1082c4b063a8fbe6) running 1 test\ntest tests::internal ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Running tests/integration_test.rs (target/debug/deps/integration_test-1082c4b063a8fbe6) running 1 test\ntest it_adds_two ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s The three sections of output include the unit tests, the integration test, and the doc tests. Note that if any test in a section fails, the following sections will not be run. For example, if a unit test fails, there won’t be any output for integration and doc tests because those tests will only be run if all unit tests are passing. The first section for the unit tests is the same as we’ve been seeing: one line for each unit test (one named internal that we added in Listing 11-12) and then a summary line for the unit tests. The integration tests section starts with the line Running tests/integration_test.rs. Next, there is a line for each test function in that integration test and a summary line for the results of the integration test just before the Doc-tests adder section starts. Each integration test file has its own section, so if we add more files in the tests directory, there will be more integration test sections. We can still run a particular integration test function by specifying the test function’s name as an argument to cargo test. To run all the tests in a particular integration test file, use the --test argument of cargo test followed by the name of the file: $ cargo test --test integration_test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.64s Running tests/integration_test.rs (target/debug/deps/integration_test-82e7799c1bc62298) running 1 test\ntest it_adds_two ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s This command runs only the tests in the tests/integration_test.rs file. Submodules in Integration Tests As you add more integration tests, you might want to make more files in the tests directory to help organize them; for example, you can group the test functions by the functionality they’re testing. As mentioned earlier, each file in the tests directory is compiled as its own separate crate, which is useful for creating separate scopes to more closely imitate the way end users will be using your crate. However, this means files in the tests directory don’t share the same behavior as files in src do, as you learned in Chapter 7 regarding how to separate code into modules and files. The different behavior of tests directory files is most noticeable when you have a set of helper functions to use in multiple integration test files and you try to follow the steps in the “Separating Modules into Different Files” section of Chapter 7 to extract them into a common module. For example, if we create tests/common.rs and place a function named setup in it, we can add some code to setup that we want to call from multiple test functions in multiple test files: Filename: tests/common.rs pub fn setup() { // setup code specific to your library's tests would go here\n} When we run the tests again, we’ll see a new section in the test output for the common.rs file, even though this file doesn’t contain any test functions nor did we call the setup function from anywhere: $ cargo test Compiling adder v0.1.0 (file:///projects/adder) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.89s Running unittests src/lib.rs (target/debug/deps/adder-92948b65e88960b4) running 1 test\ntest tests::internal ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Running tests/common.rs (target/debug/deps/common-92948b65e88960b4) running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Running tests/integration_test.rs (target/debug/deps/integration_test-92948b65e88960b4) running 1 test\ntest it_adds_two ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests adder running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Having common appear in the test results with running 0 tests displayed for it is not what we wanted. We just wanted to share some code with the other integration test files. To avoid having common appear in the test output, instead of creating tests/common.rs , we’ll create tests/common/mod.rs . The project directory now looks like this: ├── Cargo.lock\n├── Cargo.toml\n├── src\n│ └── lib.rs\n└── tests ├── common │ └── mod.rs └── integration_test.rs This is the older naming convention that Rust also understands that we mentioned in the “Alternate File Paths” section of Chapter 7. Naming the file this way tells Rust not to treat the common module as an integration test file. When we move the setup function code into tests/common/mod.rs and delete the tests/common.rs file, the section in the test output will no longer appear. Files in subdirectories of the tests directory don’t get compiled as separate crates or have sections in the test output. After we’ve created tests/common/mod.rs , we can use it from any of the integration test files as a module. Here’s an example of calling the setup function from the it_adds_two test in tests/integration_test.rs : Filename: tests/integration_test.rs use adder; mod common; #[test]\nfn it_adds_two() { common::setup(); assert_eq!(4, adder::add_two(2));\n} Note that the mod common; declaration is the same as the module declaration we demonstrated in Listing 7-21. Then in the test function, we can call the common::setup() function. Integration Tests for Binary Crates If our project is a binary crate that only contains a src/main.rs file and doesn’t have a src/lib.rs file, we can’t create integration tests in the tests directory and bring functions defined in the src/main.rs file into scope with a use statement. Only library crates expose functions that other crates can use; binary crates are meant to be run on their own. This is one of the reasons Rust projects that provide a binary have a straightforward src/main.rs file that calls logic that lives in the src/lib.rs file. Using that structure, integration tests can test the library crate with use to make the important functionality available. If the important functionality works, the small amount of code in the src/main.rs file will work as well, and that small amount of code doesn’t need to be tested.","breadcrumbs":"Writing Automated Tests » Test Organization » Integration Tests","id":"206","title":"Integration Tests"},"207":{"body":"Rust’s testing features provide a way to specify how code should function to ensure it continues to work as you expect, even as you make changes. Unit tests exercise different parts of a library separately and can test private implementation details. Integration tests check that many parts of the library work together correctly, and they use the library’s public API to test the code in the same way external code will use it. Even though Rust’s type system and ownership rules help prevent some kinds of bugs, tests are still important to reduce logic bugs having to do with how your code is expected to behave. Let’s combine the knowledge you learned in this chapter and in previous chapters to work on a project!","breadcrumbs":"Writing Automated Tests » Test Organization » Summary","id":"207","title":"Summary"},"208":{"body":"This chapter is a recap of the many skills you’ve learned so far and an exploration of a few more standard library features. We’ll build a command line tool that interacts with file and command line input/output to practice some of the Rust concepts you now have under your belt. Rust’s speed, safety, single binary output, and cross-platform support make it an ideal language for creating command line tools, so for our project, we’ll make our own version of the classic command line search tool grep ( g lobally search a r egular e xpression and p rint). In the simplest use case, grep searches a specified file for a specified string. To do so, grep takes as its arguments a file path and a string. Then it reads the file, finds lines in that file that contain the string argument, and prints those lines. Along the way, we’ll show how to make our command line tool use the terminal features that many other command line tools use. We’ll read the value of an environment variable to allow the user to configure the behavior of our tool. We’ll also print error messages to the standard error console stream (stderr) instead of standard output (stdout), so, for example, the user can redirect successful output to a file while still seeing error messages onscreen. One Rust community member, Andrew Gallant, has already created a fully featured, very fast version of grep, called ripgrep. By comparison, our version will be fairly simple, but this chapter will give you some of the background knowledge you need to understand a real-world project such as ripgrep. Our grep project will combine a number of concepts you’ve learned so far: Organizing code (using what you learned about modules in Chapter 7 ) Using vectors and strings (collections, Chapter 8 ) Handling errors ( Chapter 9 ) Using traits and lifetimes where appropriate ( Chapter 10 ) Writing tests ( Chapter 11 ) We’ll also briefly introduce closures, iterators, and trait objects, which Chapters 13 and 17 will cover in detail.","breadcrumbs":"An I/O Project: Building a Command Line Program » An I/O Project: Building a Command Line Program","id":"208","title":"An I/O Project: Building a Command Line Program"},"209":{"body":"Let’s create a new project with, as always, cargo new. We’ll call our project minigrep to distinguish it from the grep tool that you might already have on your system. $ cargo new minigrep Created binary (application) `minigrep` project\n$ cd minigrep The first task is to make minigrep accept its two command line arguments: the file path and a string to search for. That is, we want to be able to run our program with cargo run, two hyphens to indicate the following arguments are for our program rather than for cargo, a string to search for, and a path to a file to search in, like so: $ cargo run -- searchstring example-filename.txt Right now, the program generated by cargo new cannot process arguments we give it. Some existing libraries on crates.io can help with writing a program that accepts command line arguments, but because you’re just learning this concept, let’s implement this capability ourselves.","breadcrumbs":"An I/O Project: Building a Command Line Program » Accepting Command Line Arguments » Accepting Command Line Arguments","id":"209","title":"Accepting Command Line Arguments"},"21":{"body":"You’ll start by making a directory to store your Rust code. It doesn’t matter to Rust where your code lives, but for the exercises and projects in this book, we suggest making a projects directory in your home directory and keeping all your projects there. Open a terminal and enter the following commands to make a projects directory and a directory for the “Hello, world!” project within the projects directory. For Linux, macOS, and PowerShell on Windows, enter this: $ mkdir ~/projects\n$ cd ~/projects\n$ mkdir hello_world\n$ cd hello_world For Windows CMD, enter this: > mkdir \"%USERPROFILE%\\projects\"\n> cd /d \"%USERPROFILE%\\projects\"\n> mkdir hello_world\n> cd hello_world","breadcrumbs":"Getting Started » Hello, World! » Creating a Project Directory","id":"21","title":"Creating a Project Directory"},"210":{"body":"To enable minigrep to read the values of command line arguments we pass to it, we’ll need the std::env::args function provided in Rust’s standard library. This function returns an iterator of the command line arguments passed to minigrep. We’ll cover iterators fully in Chapter 13 . For now, you only need to know two details about iterators: iterators produce a series of values, and we can call the collect method on an iterator to turn it into a collection, such as a vector, that contains all the elements the iterator produces. The code in Listing 12-1 allows your minigrep program to read any command line arguments passed to it and then collect the values into a vector. Filename: src/main.rs use std::env; fn main() { let args: Vec = env::args().collect(); dbg!(args);\n} Listing 12-1: Collecting the command line arguments into a vector and printing them First, we bring the std::env module into scope with a use statement so we can use its args function. Notice that the std::env::args function is nested in two levels of modules. As we discussed in Chapter 7 , in cases where the desired function is nested in more than one module, we’ve chosen to bring the parent module into scope rather than the function. By doing so, we can easily use other functions from std::env. It’s also less ambiguous than adding use std::env::args and then calling the function with just args, because args might easily be mistaken for a function that’s defined in the current module.","breadcrumbs":"An I/O Project: Building a Command Line Program » Accepting Command Line Arguments » Reading the Argument Values","id":"210","title":"Reading the Argument Values"},"211":{"body":"Note that std::env::args will panic if any argument contains invalid Unicode. If your program needs to accept arguments containing invalid Unicode, use std::env::args_os instead. That function returns an iterator that produces OsString values instead of String values. We’ve chosen to use std::env::args here for simplicity, because OsString values differ per platform and are more complex to work with than String values. On the first line of main, we call env::args, and we immediately use collect to turn the iterator into a vector containing all the values produced by the iterator. We can use the collect function to create many kinds of collections, so we explicitly annotate the type of args to specify that we want a vector of strings. Although we very rarely need to annotate types in Rust, collect is one function you do often need to annotate because Rust isn’t able to infer the kind of collection you want. Finally, we print the vector using the debug macro. Let’s try running the code first with no arguments and then with two arguments: $ cargo run Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.61s Running `target/debug/minigrep`\n[src/main.rs:5:5] args = [ \"target/debug/minigrep\",\n] $ cargo run -- needle haystack Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.57s Running `target/debug/minigrep needle haystack`\n[src/main.rs:5:5] args = [ \"target/debug/minigrep\", \"needle\", \"haystack\",\n] Notice that the first value in the vector is \"target/debug/minigrep\", which is the name of our binary. This matches the behavior of the arguments list in C, letting programs use the name by which they were invoked in their execution. It’s often convenient to have access to the program name in case you want to print it in messages or change behavior of the program based on what command line alias was used to invoke the program. But for the purposes of this chapter, we’ll ignore it and save only the two arguments we need.","breadcrumbs":"An I/O Project: Building a Command Line Program » Accepting Command Line Arguments » The args Function and Invalid Unicode","id":"211","title":"The args Function and Invalid Unicode"},"212":{"body":"The program is currently able to access the values specified as command line arguments. Now we need to save the values of the two arguments in variables so we can use the values throughout the rest of the program. We do that in Listing 12-2. Filename: src/main.rs use std::env; fn main() { let args: Vec = env::args().collect(); let query = &args[1]; let file_path = &args[2]; println!(\"Searching for {query}\"); println!(\"In file {file_path}\");\n} Listing 12-2: Creating variables to hold the query argument and file path argument As we saw when we printed the vector, the program’s name takes up the first value in the vector at args[0], so we’re starting arguments at index 1. The first argument minigrep takes is the string we’re searching for, so we put a reference to the first argument in the variable query. The second argument will be the file path, so we put a reference to the second argument in the variable file_path. We temporarily print the values of these variables to prove that the code is working as we intend. Let’s run this program again with the arguments test and sample.txt: $ cargo run -- test sample.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep test sample.txt`\nSearching for test\nIn file sample.txt Great, the program is working! The values of the arguments we need are being saved into the right variables. Later we’ll add some error handling to deal with certain potential erroneous situations, such as when the user provides no arguments; for now, we’ll ignore that situation and work on adding file-reading capabilities instead.","breadcrumbs":"An I/O Project: Building a Command Line Program » Accepting Command Line Arguments » Saving the Argument Values in Variables","id":"212","title":"Saving the Argument Values in Variables"},"213":{"body":"Now we’ll add functionality to read the file specified in the file_path argument. First, we need a sample file to test it with: we’ll use a file with a small amount of text over multiple lines with some repeated words. Listing 12-3 has an Emily Dickinson poem that will work well! Create a file called poem.txt at the root level of your project, and enter the poem “I’m Nobody! Who are you?” Filename: poem.txt I'm nobody! Who are you?\nAre you nobody, too?\nThen there's a pair of us - don't tell!\nThey'd banish us, you know. How dreary to be somebody!\nHow public, like a frog\nTo tell your name the livelong day\nTo an admiring bog! Listing 12-3: A poem by Emily Dickinson makes a good test case With the text in place, edit src/main.rs and add code to read the file, as shown in Listing 12-4. Filename: src/main.rs use std::env;\nuse std::fs; fn main() { // --snip--\n# let args: Vec = env::args().collect();\n# # let query = &args[1];\n# let file_path = &args[2];\n# # println!(\"Searching for {query}\"); println!(\"In file {file_path}\"); let contents = fs::read_to_string(file_path) .expect(\"Should have been able to read the file\"); println!(\"With text:\\n{contents}\");\n} Listing 12-4: Reading the contents of the file specified by the second argument First, we bring in a relevant part of the standard library with a use statement: we need std::fs to handle files. In main, the new statement fs::read_to_string takes the file_path, opens that file, and returns a std::io::Result of the file’s contents. After that, we again add a temporary println! statement that prints the value of contents after the file is read, so we can check that the program is working so far. Let’s run this code with any string as the first command line argument (because we haven’t implemented the searching part yet) and the poem.txt file as the second argument: $ cargo run -- the poem.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep the poem.txt`\nSearching for the\nIn file poem.txt\nWith text:\nI'm nobody! Who are you?\nAre you nobody, too?\nThen there's a pair of us - don't tell!\nThey'd banish us, you know. How dreary to be somebody!\nHow public, like a frog\nTo tell your name the livelong day\nTo an admiring bog! Great! The code read and then printed the contents of the file. But the code has a few flaws. At the moment, the main function has multiple responsibilities: generally, functions are clearer and easier to maintain if each function is responsible for only one idea. The other problem is that we’re not handling errors as well as we could. The program is still small, so these flaws aren’t a big problem, but as the program grows, it will be harder to fix them cleanly. It’s good practice to begin refactoring early on when developing a program, because it’s much easier to refactor smaller amounts of code. We’ll do that next.","breadcrumbs":"An I/O Project: Building a Command Line Program » Reading a File » Reading a File","id":"213","title":"Reading a File"},"214":{"body":"To improve our program, we’ll fix four problems that have to do with the program’s structure and how it’s handling potential errors. First, our main function now performs two tasks: it parses arguments and reads files. As our program grows, the number of separate tasks the main function handles will increase. As a function gains responsibilities, it becomes more difficult to reason about, harder to test, and harder to change without breaking one of its parts. It’s best to separate functionality so each function is responsible for one task. This issue also ties into the second problem: although query and file_path are configuration variables to our program, variables like contents are used to perform the program’s logic. The longer main becomes, the more variables we’ll need to bring into scope; the more variables we have in scope, the harder it will be to keep track of the purpose of each. It’s best to group the configuration variables into one structure to make their purpose clear. The third problem is that we’ve used expect to print an error message when reading the file fails, but the error message just prints Should have been able to read the file. Reading a file can fail in a number of ways: for example, the file could be missing, or we might not have permission to open it. Right now, regardless of the situation, we’d print the same error message for everything, which wouldn’t give the user any information! Fourth, we use expect to handle an error, and if the user runs our program without specifying enough arguments, they’ll get an index out of bounds error from Rust that doesn’t clearly explain the problem. It would be best if all the error-handling code were in one place so future maintainers had only one place to consult the code if the error-handling logic needed to change. Having all the error-handling code in one place will also ensure that we’re printing messages that will be meaningful to our end users. Let’s address these four problems by refactoring our project.","breadcrumbs":"An I/O Project: Building a Command Line Program » Refactoring to Improve Modularity and Error Handling » Refactoring to Improve Modularity and Error Handling","id":"214","title":"Refactoring to Improve Modularity and Error Handling"},"215":{"body":"The organizational problem of allocating responsibility for multiple tasks to the main function is common to many binary projects. As a result, the Rust community has developed guidelines for splitting the separate concerns of a binary program when main starts getting large. This process has the following steps: Split your program into a main.rs and a lib.rs and move your program’s logic to lib.rs . As long as your command line parsing logic is small, it can remain in main.rs . When the command line parsing logic starts getting complicated, extract it from main.rs and move it to lib.rs . The responsibilities that remain in the main function after this process should be limited to the following: Calling the command line parsing logic with the argument values Setting up any other configuration Calling a run function in lib.rs Handling the error if run returns an error This pattern is about separating concerns: main.rs handles running the program, and lib.rs handles all the logic of the task at hand. Because you can’t test the main function directly, this structure lets you test all of your program’s logic by moving it into functions in lib.rs . The code that remains in main.rs will be small enough to verify its correctness by reading it. Let’s rework our program by following this process. Extracting the Argument Parser We’ll extract the functionality for parsing arguments into a function that main will call to prepare for moving the command line parsing logic to src/lib.rs . Listing 12-5 shows the new start of main that calls a new function parse_config, which we’ll define in src/main.rs for the moment. Filename: src/main.rs # use std::env;\n# use std::fs;\n# fn main() { let args: Vec = env::args().collect(); let (query, file_path) = parse_config(&args); // --snip--\n# # println!(\"Searching for {query}\");\n# println!(\"In file {file_path}\");\n# # let contents = fs::read_to_string(file_path)\n# .expect(\"Should have been able to read the file\");\n# # println!(\"With text:\\n{contents}\");\n} fn parse_config(args: &[String]) -> (&str, &str) { let query = &args[1]; let file_path = &args[2]; (query, file_path)\n} Listing 12-5: Extracting a parse_config function from main We’re still collecting the command line arguments into a vector, but instead of assigning the argument value at index 1 to the variable query and the argument value at index 2 to the variable file_path within the main function, we pass the whole vector to the parse_config function. The parse_config function then holds the logic that determines which argument goes in which variable and passes the values back to main. We still create the query and file_path variables in main, but main no longer has the responsibility of determining how the command line arguments and variables correspond. This rework may seem like overkill for our small program, but we’re refactoring in small, incremental steps. After making this change, run the program again to verify that the argument parsing still works. It’s good to check your progress often, to help identify the cause of problems when they occur. Grouping Configuration Values We can take another small step to improve the parse_config function further. At the moment, we’re returning a tuple, but then we immediately break that tuple into individual parts again. This is a sign that perhaps we don’t have the right abstraction yet. Another indicator that shows there’s room for improvement is the config part of parse_config, which implies that the two values we return are related and are both part of one configuration value. We’re not currently conveying this meaning in the structure of the data other than by grouping the two values into a tuple; we’ll instead put the two values into one struct and give each of the struct fields a meaningful name. Doing so will make it easier for future maintainers of this code to understand how the different values relate to each other and what their purpose is. Listing 12-6 shows the improvements to the parse_config function. Filename: src/main.rs # use std::env;\n# use std::fs;\n# fn main() { let args: Vec = env::args().collect(); let config = parse_config(&args); println!(\"Searching for {}\", config.query); println!(\"In file {}\", config.file_path); let contents = fs::read_to_string(config.file_path) .expect(\"Should have been able to read the file\"); // --snip--\n# # println!(\"With text:\\n{contents}\");\n} struct Config { query: String, file_path: String,\n} fn parse_config(args: &[String]) -> Config { let query = args[1].clone(); let file_path = args[2].clone(); Config { query, file_path }\n} Listing 12-6: Refactoring parse_config to return an instance of a Config struct We’ve added a struct named Config defined to have fields named query and file_path. The signature of parse_config now indicates that it returns a Config value. In the body of parse_config, where we used to return string slices that reference String values in args, we now define Config to contain owned String values. The args variable in main is the owner of the argument values and is only letting the parse_config function borrow them, which means we’d violate Rust’s borrowing rules if Config tried to take ownership of the values in args. There are a number of ways we could manage the String data; the easiest, though somewhat inefficient, route is to call the clone method on the values. This will make a full copy of the data for the Config instance to own, which takes more time and memory than storing a reference to the string data. However, cloning the data also makes our code very straightforward because we don’t have to manage the lifetimes of the references; in this circumstance, giving up a little performance to gain simplicity is a worthwhile trade-off.","breadcrumbs":"An I/O Project: Building a Command Line Program » Refactoring to Improve Modularity and Error Handling » Separation of Concerns for Binary Projects","id":"215","title":"Separation of Concerns for Binary Projects"},"216":{"body":"There’s a tendency among many Rustaceans to avoid using clone to fix ownership problems because of its runtime cost. In Chapter 13 , you’ll learn how to use more efficient methods in this type of situation. But for now, it’s okay to copy a few strings to continue making progress because you’ll make these copies only once and your file path and query string are very small. It’s better to have a working program that’s a bit inefficient than to try to hyperoptimize code on your first pass. As you become more experienced with Rust, it’ll be easier to start with the most efficient solution, but for now, it’s perfectly acceptable to call clone. We’ve updated main so it places the instance of Config returned by parse_config into a variable named config, and we updated the code that previously used the separate query and file_path variables so it now uses the fields on the Config struct instead. Now our code more clearly conveys that query and file_path are related and that their purpose is to configure how the program will work. Any code that uses these values knows to find them in the config instance in the fields named for their purpose. Creating a Constructor for Config So far, we’ve extracted the logic responsible for parsing the command line arguments from main and placed it in the parse_config function. Doing so helped us to see that the query and file_path values were related and that relationship should be conveyed in our code. We then added a Config struct to name the related purpose of query and file_path and to be able to return the values’ names as struct field names from the parse_config function. So now that the purpose of the parse_config function is to create a Config instance, we can change parse_config from a plain function to a function named new that is associated with the Config struct. Making this change will make the code more idiomatic. We can create instances of types in the standard library, such as String, by calling String::new. Similarly, by changing parse_config into a new function associated with Config, we’ll be able to create instances of Config by calling Config::new. Listing 12-7 shows the changes we need to make. Filename: src/main.rs # use std::env;\n# use std::fs;\n# fn main() { let args: Vec = env::args().collect(); let config = Config::new(&args);\n# # println!(\"Searching for {}\", config.query);\n# println!(\"In file {}\", config.file_path);\n# # let contents = fs::read_to_string(config.file_path)\n# .expect(\"Should have been able to read the file\");\n# # println!(\"With text:\\n{contents}\"); // --snip--\n} // --snip-- # struct Config {\n# query: String,\n# file_path: String,\n# }\n# impl Config { fn new(args: &[String]) -> Config { let query = args[1].clone(); let file_path = args[2].clone(); Config { query, file_path } }\n} Listing 12-7: Changing parse_config into Config::new We’ve updated main where we were calling parse_config to instead call Config::new. We’ve changed the name of parse_config to new and moved it within an impl block, which associates the new function with Config. Try compiling this code again to make sure it works.","breadcrumbs":"An I/O Project: Building a Command Line Program » Refactoring to Improve Modularity and Error Handling » The Trade-Offs of Using clone","id":"216","title":"The Trade-Offs of Using clone"},"217":{"body":"Now we’ll work on fixing our error handling. Recall that attempting to access the values in the args vector at index 1 or index 2 will cause the program to panic if the vector contains fewer than three items. Try running the program without any arguments; it will look like this: $ cargo run Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep`\nthread 'main' panicked at src/main.rs:27:21:\nindex out of bounds: the len is 1 but the index is 1\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace The line index out of bounds: the len is 1 but the index is 1 is an error message intended for programmers. It won’t help our end users understand what they should do instead. Let’s fix that now. Improving the Error Message In Listing 12-8, we add a check in the new function that will verify that the slice is long enough before accessing index 1 and 2. If the slice isn’t long enough, the program panics and displays a better error message. Filename: src/main.rs # use std::env;\n# use std::fs;\n# # fn main() {\n# let args: Vec = env::args().collect();\n# # let config = Config::new(&args);\n# # println!(\"Searching for {}\", config.query);\n# println!(\"In file {}\", config.file_path);\n# # let contents = fs::read_to_string(config.file_path)\n# .expect(\"Should have been able to read the file\");\n# # println!(\"With text:\\n{contents}\");\n# }\n# # struct Config {\n# query: String,\n# file_path: String,\n# }\n# # impl Config { // --snip-- fn new(args: &[String]) -> Config { if args.len() < 3 { panic!(\"not enough arguments\"); } // --snip--\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Config { query, file_path }\n# }\n# } Listing 12-8: Adding a check for the number of arguments This code is similar to the Guess::new function we wrote in Listing 9-13 , where we called panic! when the value argument was out of the range of valid values. Instead of checking for a range of values here, we’re checking that the length of args is at least 3 and the rest of the function can operate under the assumption that this condition has been met. If args has fewer than three items, this condition will be true, and we call the panic! macro to end the program immediately. With these extra few lines of code in new, let’s run the program without any arguments again to see what the error looks like now: $ cargo run Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep`\nthread 'main' panicked at src/main.rs:26:13:\nnot enough arguments\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace This output is better: we now have a reasonable error message. However, we also have extraneous information we don’t want to give to our users. Perhaps using the technique we used in Listing 9-13 isn’t the best to use here: a call to panic! is more appropriate for a programming problem than a usage problem, as discussed in Chapter 9 . Instead, we’ll use the other technique you learned about in Chapter 9— returning a Result that indicates either success or an error. Returning a Result Instead of Calling panic! We can instead return a Result value that will contain a Config instance in the successful case and will describe the problem in the error case. We’re also going to change the function name from new to build because many programmers expect new functions to never fail. When Config::build is communicating to main, we can use the Result type to signal there was a problem. Then we can change main to convert an Err variant into a more practical error for our users without the surrounding text about thread 'main' and RUST_BACKTRACE that a call to panic! causes. Listing 12-9 shows the changes we need to make to the return value of the function we’re now calling Config::build and the body of the function needed to return a Result. Note that this won’t compile until we update main as well, which we’ll do in the next listing. Filename: src/main.rs # use std::env;\n# use std::fs;\n# # fn main() {\n# let args: Vec = env::args().collect();\n# # let config = Config::new(&args);\n# # println!(\"Searching for {}\", config.query);\n# println!(\"In file {}\", config.file_path);\n# # let contents = fs::read_to_string(config.file_path)\n# .expect(\"Should have been able to read the file\");\n# # println!(\"With text:\\n{contents}\");\n# }\n# # struct Config {\n# query: String,\n# file_path: String,\n# }\n# impl Config { fn build(args: &[String]) -> Result { if args.len() < 3 { return Err(\"not enough arguments\"); } let query = args[1].clone(); let file_path = args[2].clone(); Ok(Config { query, file_path }) }\n} Listing 12-9: Returning a Result from Config::build Our build function returns a Result with a Config instance in the success case and a &'static str in the error case. Our error values will always be string literals that have the 'static lifetime. We’ve made two changes in the body of the function: instead of calling panic! when the user doesn’t pass enough arguments, we now return an Err value, and we’ve wrapped the Config return value in an Ok. These changes make the function conform to its new type signature. Returning an Err value from Config::build allows the main function to handle the Result value returned from the build function and exit the process more cleanly in the error case. Calling Config::build and Handling Errors To handle the error case and print a user-friendly message, we need to update main to handle the Result being returned by Config::build, as shown in Listing 12-10. We’ll also take the responsibility of exiting the command line tool with a nonzero error code away from panic! and instead implement it by hand. A nonzero exit status is a convention to signal to the process that called our program that the program exited with an error state. Filename: src/main.rs # use std::env;\n# use std::fs;\nuse std::process; fn main() { let args: Vec = env::args().collect(); let config = Config::build(&args).unwrap_or_else(|err| { println!(\"Problem parsing arguments: {err}\"); process::exit(1); }); // --snip--\n# # println!(\"Searching for {}\", config.query);\n# println!(\"In file {}\", config.file_path);\n# # let contents = fs::read_to_string(config.file_path)\n# .expect(\"Should have been able to read the file\");\n# # println!(\"With text:\\n{contents}\");\n# }\n# # struct Config {\n# query: String,\n# file_path: String,\n# }\n# # impl Config {\n# fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# } Listing 12-10: Exiting with an error code if building a Config fails In this listing, we’ve used a method we haven’t covered in detail yet: unwrap_or_else, which is defined on Result by the standard library. Using unwrap_or_else allows us to define some custom, non-panic! error handling. If the Result is an Ok value, this method’s behavior is similar to unwrap: it returns the inner value Ok is wrapping. However, if the value is an Err value, this method calls the code in the closure , which is an anonymous function we define and pass as an argument to unwrap_or_else. We’ll cover closures in more detail in Chapter 13 . For now, you just need to know that unwrap_or_else will pass the inner value of the Err, which in this case is the static string \"not enough arguments\" that we added in Listing 12-9, to our closure in the argument err that appears between the vertical pipes. The code in the closure can then use the err value when it runs. We’ve added a new use line to bring process from the standard library into scope. The code in the closure that will be run in the error case is only two lines: we print the err value and then call process::exit. The process::exit function will stop the program immediately and return the number that was passed as the exit status code. This is similar to the panic!-based handling we used in Listing 12-8, but we no longer get all the extra output. Let’s try it: $ cargo run Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.48s Running `target/debug/minigrep`\nProblem parsing arguments: not enough arguments Great! This output is much friendlier for our users.","breadcrumbs":"An I/O Project: Building a Command Line Program » Refactoring to Improve Modularity and Error Handling » Fixing the Error Handling","id":"217","title":"Fixing the Error Handling"},"218":{"body":"Now that we’ve finished refactoring the configuration parsing, let’s turn to the program’s logic. As we stated in “Separation of Concerns for Binary Projects” , we’ll extract a function named run that will hold all the logic currently in the main function that isn’t involved with setting up configuration or handling errors. When we’re done, main will be concise and easy to verify by inspection, and we’ll be able to write tests for all the other logic. Listing 12-11 shows the extracted run function. For now, we’re just making the small, incremental improvement of extracting the function. We’re still defining the function in src/main.rs . Filename: src/main.rs # use std::env;\n# use std::fs;\n# use std::process;\n# fn main() { // --snip-- # let args: Vec = env::args().collect();\n# # let config = Config::build(&args).unwrap_or_else(|err| {\n# println!(\"Problem parsing arguments: {err}\");\n# process::exit(1);\n# });\n# println!(\"Searching for {}\", config.query); println!(\"In file {}\", config.file_path); run(config);\n} fn run(config: Config) { let contents = fs::read_to_string(config.file_path) .expect(\"Should have been able to read the file\"); println!(\"With text:\\n{contents}\");\n} // --snip--\n# # struct Config {\n# query: String,\n# file_path: String,\n# }\n# # impl Config {\n# fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# } Listing 12-11: Extracting a run function containing the rest of the program logic The run function now contains all the remaining logic from main, starting from reading the file. The run function takes the Config instance as an argument. Returning Errors from the run Function With the remaining program logic separated into the run function, we can improve the error handling, as we did with Config::build in Listing 12-9. Instead of allowing the program to panic by calling expect, the run function will return a Result when something goes wrong. This will let us further consolidate the logic around handling errors into main in a user-friendly way. Listing 12-12 shows the changes we need to make to the signature and body of run. Filename: src/main.rs # use std::env;\n# use std::fs;\n# use std::process;\nuse std::error::Error; // --snip-- # # fn main() {\n# let args: Vec = env::args().collect();\n# # let config = Config::build(&args).unwrap_or_else(|err| {\n# println!(\"Problem parsing arguments: {err}\");\n# process::exit(1);\n# });\n# # println!(\"Searching for {}\", config.query);\n# println!(\"In file {}\", config.file_path);\n# # run(config);\n# }\n# fn run(config: Config) -> Result<(), Box> { let contents = fs::read_to_string(config.file_path)?; println!(\"With text:\\n{contents}\"); Ok(())\n}\n# # struct Config {\n# query: String,\n# file_path: String,\n# }\n# # impl Config {\n# fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# } Listing 12-12: Changing the run function to return Result We’ve made three significant changes here. First, we changed the return type of the run function to Result<(), Box>. This function previously returned the unit type, (), and we keep that as the value returned in the Ok case. For the error type, we used the trait object Box (and we’ve brought std::error::Error into scope with a use statement at the top). We’ll cover trait objects in Chapter 17 . For now, just know that Box means the function will return a type that implements the Error trait, but we don’t have to specify what particular type the return value will be. This gives us flexibility to return error values that may be of different types in different error cases. The dyn keyword is short for “dynamic.” Second, we’ve removed the call to expect in favor of the ? operator, as we talked about in Chapter 9 . Rather than panic! on an error, ? will return the error value from the current function for the caller to handle. Third, the run function now returns an Ok value in the success case. We’ve declared the run function’s success type as () in the signature, which means we need to wrap the unit type value in the Ok value. This Ok(()) syntax might look a bit strange at first, but using () like this is the idiomatic way to indicate that we’re calling run for its side effects only; it doesn’t return a value we need. When you run this code, it will compile but will display a warning: $ cargo run -- the poem.txt Compiling minigrep v0.1.0 (file:///projects/minigrep)\nwarning: unused `Result` that must be used --> src/main.rs:19:5 |\n19 | run(config); | ^^^^^^^^^^^ | = note: this `Result` may be an `Err` variant, which should be handled = note: `#[warn(unused_must_use)]` on by default\nhelp: use `let _ = ...` to ignore the resulting value |\n19 | let _ = run(config); | +++++++ warning: `minigrep` (bin \"minigrep\") generated 1 warning Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.71s Running `target/debug/minigrep the poem.txt`\nSearching for the\nIn file poem.txt\nWith text:\nI'm nobody! Who are you?\nAre you nobody, too?\nThen there's a pair of us - don't tell!\nThey'd banish us, you know. How dreary to be somebody!\nHow public, like a frog\nTo tell your name the livelong day\nTo an admiring bog! Rust tells us that our code ignored the Result value and the Result value might indicate that an error occurred. But we’re not checking to see whether or not there was an error, and the compiler reminds us that we probably meant to have some error-handling code here! Let’s rectify that problem now. Handling Errors Returned from run in main We’ll check for errors and handle them using a technique similar to one we used with Config::build in Listing 12-10, but with a slight difference: Filename: src/main.rs # use std::env;\n# use std::error::Error;\n# use std::fs;\n# use std::process;\n# fn main() { // --snip-- # let args: Vec = env::args().collect();\n# # let config = Config::build(&args).unwrap_or_else(|err| {\n# println!(\"Problem parsing arguments: {err}\");\n# process::exit(1);\n# });\n# println!(\"Searching for {}\", config.query); println!(\"In file {}\", config.file_path); if let Err(e) = run(config) { println!(\"Application error: {e}\"); process::exit(1); }\n}\n# # fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # println!(\"With text:\\n{contents}\");\n# # Ok(())\n# }\n# # struct Config {\n# query: String,\n# file_path: String,\n# }\n# # impl Config {\n# fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# } We use if let rather than unwrap_or_else to check whether run returns an Err value and call process::exit(1) if it does. The run function doesn’t return a value that we want to unwrap in the same way that Config::build returns the Config instance. Because run returns () in the success case, we only care about detecting an error, so we don’t need unwrap_or_else to return the unwrapped value, which would only be (). The bodies of the if let and the unwrap_or_else functions are the same in both cases: we print the error and exit.","breadcrumbs":"An I/O Project: Building a Command Line Program » Refactoring to Improve Modularity and Error Handling » Extracting Logic from main","id":"218","title":"Extracting Logic from main"},"219":{"body":"Our minigrep project is looking good so far! Now we’ll split the src/main.rs file and put some code into the src/lib.rs file. That way we can test the code and have a src/main.rs file with fewer responsibilities. Let’s move all the code that isn’t the main function from src/main.rs to src/lib.rs : The run function definition The relevant use statements The definition of Config The Config::build function definition The contents of src/lib.rs should have the signatures shown in Listing 12-13 (we’ve omitted the bodies of the functions for brevity). Note that this won’t compile until we modify src/main.rs in Listing 12-14. Filename: src/lib.rs use std::error::Error;\nuse std::fs; pub struct Config { pub query: String, pub file_path: String,\n} impl Config { pub fn build(args: &[String]) -> Result { // --snip--\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path }) }\n} pub fn run(config: Config) -> Result<(), Box> { // --snip--\n# let contents = fs::read_to_string(config.file_path)?;\n# # println!(\"With text:\\n{contents}\");\n# # Ok(())\n} Listing 12-13: Moving Config and run into src/lib.rs We’ve made liberal use of the pub keyword: on Config, on its fields and its build method, and on the run function. We now have a library crate that has a public API we can test! Now we need to bring the code we moved to src/lib.rs into the scope of the binary crate in src/main.rs , as shown in Listing 12-14. Filename: src/main.rs use std::env;\nuse std::process; use minigrep::Config; fn main() { // --snip--\n# let args: Vec = env::args().collect();\n# # let config = Config::build(&args).unwrap_or_else(|err| {\n# println!(\"Problem parsing arguments: {err}\");\n# process::exit(1);\n# });\n# # println!(\"Searching for {}\", config.query);\n# println!(\"In file {}\", config.file_path);\n# if let Err(e) = minigrep::run(config) { // --snip--\n# println!(\"Application error: {e}\");\n# process::exit(1); }\n} Listing 12-14: Using the minigrep library crate in src/main.rs We add a use minigrep::Config line to bring the Config type from the library crate into the binary crate’s scope, and we prefix the run function with our crate name. Now all the functionality should be connected and should work. Run the program with cargo run and make sure everything works correctly. Whew! That was a lot of work, but we’ve set ourselves up for success in the future. Now it’s much easier to handle errors, and we’ve made the code more modular. Almost all of our work will be done in src/lib.rs from here on out. Let’s take advantage of this newfound modularity by doing something that would have been difficult with the old code but is easy with the new code: we’ll write some tests!","breadcrumbs":"An I/O Project: Building a Command Line Program » Refactoring to Improve Modularity and Error Handling » Splitting Code into a Library Crate","id":"219","title":"Splitting Code into a Library Crate"},"22":{"body":"Next, make a new source file and call it main.rs . Rust files always end with the .rs extension. If you’re using more than one word in your filename, the convention is to use an underscore to separate them. For example, use hello_world.rs rather than helloworld.rs . Now open the main.rs file you just created and enter the code in Listing 1-1. Filename: main.rs fn main() { println!(\"Hello, world!\");\n} Listing 1-1: A program that prints Hello, world! Save the file and go back to your terminal window in the ~/projects/hello_world directory. On Linux or macOS, enter the following commands to compile and run the file: $ rustc main.rs\n$ ./main\nHello, world! On Windows, enter the command .\\main.exe instead of ./main: > rustc main.rs\n> .\\main.exe\nHello, world! Regardless of your operating system, the string Hello, world! should print to the terminal. If you don’t see this output, refer back to the “Troubleshooting” part of the Installation section for ways to get help. If Hello, world! did print, congratulations! You’ve officially written a Rust program. That makes you a Rust programmer—welcome!","breadcrumbs":"Getting Started » Hello, World! » Writing and Running a Rust Program","id":"22","title":"Writing and Running a Rust Program"},"220":{"body":"Now that we’ve extracted the logic into src/lib.rs and left the argument collecting and error handling in src/main.rs , it’s much easier to write tests for the core functionality of our code. We can call functions directly with various arguments and check return values without having to call our binary from the command line. In this section, we’ll add the searching logic to the minigrep program using the test-driven development (TDD) process with the following steps: Write a test that fails and run it to make sure it fails for the reason you expect. Write or modify just enough code to make the new test pass. Refactor the code you just added or changed and make sure the tests continue to pass. Repeat from step 1! Though it’s just one of many ways to write software, TDD can help drive code design. Writing the test before you write the code that makes the test pass helps to maintain high test coverage throughout the process. We’ll test drive the implementation of the functionality that will actually do the searching for the query string in the file contents and produce a list of lines that match the query. We’ll add this functionality in a function called search.","breadcrumbs":"An I/O Project: Building a Command Line Program » Developing the Library’s Functionality with Test Driven Development » Developing the Library’s Functionality with Test-Driven Development","id":"220","title":"Developing the Library’s Functionality with Test-Driven Development"},"221":{"body":"Because we don’t need them anymore, let’s remove the println! statements from src/lib.rs and src/main.rs that we used to check the program’s behavior. Then, in src/lib.rs , add a tests module with a test function, as we did in Chapter 11 . The test function specifies the behavior we want the search function to have: it will take a query and the text to search, and it will return only the lines from the text that contain the query. Listing 12-15 shows this test, which won’t compile yet. Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # Ok(())\n# }\n# #[cfg(test)]\nmod tests { use super::*; #[test] fn one_result() { let query = \"duct\"; let contents = \"\\\nRust:\nsafe, fast, productive.\nPick three.\"; assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents)); }\n} Listing 12-15: Creating a failing test for the search function we wish we had This test searches for the string \"duct\". The text we’re searching is three lines, only one of which contains \"duct\" (Note that the backslash after the opening double quote tells Rust not to put a newline character at the beginning of the contents of this string literal). We assert that the value returned from the search function contains only the line we expect. We aren’t yet able to run this test and watch it fail because the test doesn’t even compile: the search function doesn’t exist yet! In accordance with TDD principles, we’ll add just enough code to get the test to compile and run by adding a definition of the search function that always returns an empty vector, as shown in Listing 12-16. Then the test should compile and fail because an empty vector doesn’t match a vector containing the line \"safe, fast, productive.\" Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # Ok(())\n# }\n# pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> { vec![]\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn one_result() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# } Listing 12-16: Defining just enough of the search function so our test will compile Notice that we need to define an explicit lifetime 'a in the signature of search and use that lifetime with the contents argument and the return value. Recall in Chapter 10 that the lifetime parameters specify which argument lifetime is connected to the lifetime of the return value. In this case, we indicate that the returned vector should contain string slices that reference slices of the argument contents (rather than the argument query). In other words, we tell Rust that the data returned by the search function will live as long as the data passed into the search function in the contents argument. This is important! The data referenced by a slice needs to be valid for the reference to be valid; if the compiler assumes we’re making string slices of query rather than contents, it will do its safety checking incorrectly. If we forget the lifetime annotations and try to compile this function, we’ll get this error: $ cargo build Compiling minigrep v0.1.0 (file:///projects/minigrep)\nerror[E0106]: missing lifetime specifier --> src/lib.rs:28:51 |\n28 | pub fn search(query: &str, contents: &str) -> Vec<&str> { | ---- ---- ^ expected named lifetime parameter | = help: this function's return type contains a borrowed value, but the signature does not say whether it is borrowed from `query` or `contents`\nhelp: consider introducing a named lifetime parameter |\n28 | pub fn search<'a>(query: &'a str, contents: &'a str) -> Vec<&'a str> { | ++++ ++ ++ ++ For more information about this error, try `rustc --explain E0106`.\nerror: could not compile `minigrep` (lib) due to 1 previous error Rust can’t possibly know which of the two arguments we need, so we need to tell it explicitly. Because contents is the argument that contains all of our text and we want to return the parts of that text that match, we know contents is the argument that should be connected to the return value using the lifetime syntax. Other programming languages don’t require you to connect arguments to return values in the signature, but this practice will get easier over time. You might want to compare this example with the “Validating References with Lifetimes” section in Chapter 10. Now let’s run the test: $ cargo test Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `test` profile [unoptimized + debuginfo] target(s) in 0.97s Running unittests src/lib.rs (target/debug/deps/minigrep-9cd200e5fac0fc94) running 1 test\ntest tests::one_result ... FAILED failures: ---- tests::one_result stdout ----\nthread 'tests::one_result' panicked at src/lib.rs:44:9:\nassertion `left == right` failed left: [\"safe, fast, productive.\"] right: []\nnote: run with `RUST_BACKTRACE=1` environment variable to display a backtrace failures: tests::one_result test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s error: test failed, to rerun pass `--lib` Great, the test fails, exactly as we expected. Let’s get the test to pass!","breadcrumbs":"An I/O Project: Building a Command Line Program » Developing the Library’s Functionality with Test Driven Development » Writing a Failing Test","id":"221","title":"Writing a Failing Test"},"222":{"body":"Currently, our test is failing because we always return an empty vector. To fix that and implement search, our program needs to follow these steps: Iterate through each line of the contents. Check whether the line contains our query string. If it does, add it to the list of values we’re returning. If it doesn’t, do nothing. Return the list of results that match. Let’s work through each step, starting with iterating through lines. Iterating Through Lines with the lines Method Rust has a helpful method to handle line-by-line iteration of strings, conveniently named lines, that works as shown in Listing 12-17. Note this won’t compile yet. Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # Ok(())\n# }\n# pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> { for line in contents.lines() { // do something with line }\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn one_result() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# } Listing 12-17: Iterating through each line in contents The lines method returns an iterator. We’ll talk about iterators in depth in Chapter 13 , but recall that you saw this way of using an iterator in Listing 3-5 , where we used a for loop with an iterator to run some code on each item in a collection. Searching Each Line for the Query Next, we’ll check whether the current line contains our query string. Fortunately, strings have a helpful method named contains that does this for us! Add a call to the contains method in the search function, as shown in Listing 12-18. Note this still won’t compile yet. Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # Ok(())\n# }\n# pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> { for line in contents.lines() { if line.contains(query) { // do something with line } }\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn one_result() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# } Listing 12-18: Adding functionality to see whether the line contains the string in query At the moment, we’re building up functionality. To get it to compile, we need to return a value from the body as we indicated we would in the function signature. Storing Matching Lines To finish this function, we need a way to store the matching lines that we want to return. For that, we can make a mutable vector before the for loop and call the push method to store a line in the vector. After the for loop, we return the vector, as shown in Listing 12-19. Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # Ok(())\n# }\n# pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> { let mut results = Vec::new(); for line in contents.lines() { if line.contains(query) { results.push(line); } } results\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn one_result() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# } Listing 12-19: Storing the lines that match so we can return them Now the search function should return only the lines that contain query, and our test should pass. Let’s run the test: $ cargo test Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `test` profile [unoptimized + debuginfo] target(s) in 1.22s Running unittests src/lib.rs (target/debug/deps/minigrep-9cd200e5fac0fc94) running 1 test\ntest tests::one_result ... ok test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Running unittests src/main.rs (target/debug/deps/minigrep-9cd200e5fac0fc94) running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests minigrep running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Our test passed, so we know it works! At this point, we could consider opportunities for refactoring the implementation of the search function while keeping the tests passing to maintain the same functionality. The code in the search function isn’t too bad, but it doesn’t take advantage of some useful features of iterators. We’ll return to this example in Chapter 13 , where we’ll explore iterators in detail, and look at how to improve it. Using the search Function in the run Function Now that the search function is working and tested, we need to call search from our run function. We need to pass the config.query value and the contents that run reads from the file to the search function. Then run will print each line returned from search: Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# pub fn run(config: Config) -> Result<(), Box> { let contents = fs::read_to_string(config.file_path)?; for line in search(&config.query, &contents) { println!(\"{line}\"); } Ok(())\n}\n# # pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.contains(query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn one_result() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# } We’re still using a for loop to return each line from search and print it. Now the entire program should work! Let’s try it out, first with a word that should return exactly one line from the Emily Dickinson poem, “frog”: $ cargo run -- frog poem.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.38s Running `target/debug/minigrep frog poem.txt`\nHow public, like a frog Cool! Now let’s try a word that will match multiple lines, like “body”: $ cargo run -- body poem.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep body poem.txt`\nI'm nobody! Who are you?\nAre you nobody, too?\nHow dreary to be somebody! And finally, let’s make sure that we don’t get any lines when we search for a word that isn’t anywhere in the poem, such as “monomorphization”: $ cargo run -- monomorphization poem.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep monomorphization poem.txt` Excellent! We’ve built our own mini version of a classic tool and learned a lot about how to structure applications. We’ve also learned a bit about file input and output, lifetimes, testing, and command line parsing. To round out this project, we’ll briefly demonstrate how to work with environment variables and how to print to standard error, both of which are useful when you’re writing command line programs.","breadcrumbs":"An I/O Project: Building a Command Line Program » Developing the Library’s Functionality with Test Driven Development » Writing Code to Pass the Test","id":"222","title":"Writing Code to Pass the Test"},"223":{"body":"We’ll improve minigrep by adding an extra feature: an option for case-insensitive searching that the user can turn on via an environment variable. We could make this feature a command line option and require that users enter it each time they want it to apply, but by instead making it an environment variable, we allow our users to set the environment variable once and have all their searches be case insensitive in that terminal session.","breadcrumbs":"An I/O Project: Building a Command Line Program » Working with Environment Variables » Working with Environment Variables","id":"223","title":"Working with Environment Variables"},"224":{"body":"We first add a new search_case_insensitive function that will be called when the environment variable has a value. We’ll continue to follow the TDD process, so the first step is again to write a failing test. We’ll add a new test for the new search_case_insensitive function and rename our old test from one_result to case_sensitive to clarify the differences between the two tests, as shown in Listing 12-20. Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # for line in search(&config.query, &contents) {\n# println!(\"{line}\");\n# }\n# # Ok(())\n# }\n# # pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.contains(query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# #[cfg(test)]\nmod tests { use super::*; #[test] fn case_sensitive() { let query = \"duct\"; let contents = \"\\\nRust:\nsafe, fast, productive.\nPick three.\nDuct tape.\"; assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents)); } #[test] fn case_insensitive() { let query = \"rUsT\"; let contents = \"\\\nRust:\nsafe, fast, productive.\nPick three.\nTrust me.\"; assert_eq!( vec![\"Rust:\", \"Trust me.\"], search_case_insensitive(query, contents) ); }\n} Listing 12-20: Adding a new failing test for the case-insensitive function we’re about to add Note that we’ve edited the old test’s contents too. We’ve added a new line with the text \"Duct tape.\" using a capital D that shouldn’t match the query \"duct\" when we’re searching in a case-sensitive manner. Changing the old test in this way helps ensure that we don’t accidentally break the case-sensitive search functionality that we’ve already implemented. This test should pass now and should continue to pass as we work on the case-insensitive search. The new test for the case- insensitive search uses \"rUsT\" as its query. In the search_case_insensitive function we’re about to add, the query \"rUsT\" should match the line containing \"Rust:\" with a capital R and match the line \"Trust me.\" even though both have different casing from the query. This is our failing test, and it will fail to compile because we haven’t yet defined the search_case_insensitive function. Feel free to add a skeleton implementation that always returns an empty vector, similar to the way we did for the search function in Listing 12-16 to see the test compile and fail.","breadcrumbs":"An I/O Project: Building a Command Line Program » Working with Environment Variables » Writing a Failing Test for the Case-Insensitive search Function","id":"224","title":"Writing a Failing Test for the Case-Insensitive search Function"},"225":{"body":"The search_case_insensitive function, shown in Listing 12-21, will be almost the same as the search function. The only difference is that we’ll lowercase the query and each line so whatever the case of the input arguments, they’ll be the same case when we check whether the line contains the query. Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # for line in search(&config.query, &contents) {\n# println!(\"{line}\");\n# }\n# # Ok(())\n# }\n# # pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.contains(query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# pub fn search_case_insensitive<'a>( query: &str, contents: &'a str,\n) -> Vec<&'a str> { let query = query.to_lowercase(); let mut results = Vec::new(); for line in contents.lines() { if line.to_lowercase().contains(&query) { results.push(line); } } results\n}\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn case_sensitive() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Duct tape.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# # #[test]\n# fn case_insensitive() {\n# let query = \"rUsT\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Trust me.\";\n# # assert_eq!(\n# vec![\"Rust:\", \"Trust me.\"],\n# search_case_insensitive(query, contents)\n# );\n# }\n# } Listing 12-21: Defining the search_case_insensitive function to lowercase the query and the line before comparing them First, we lowercase the query string and store it in a shadowed variable with the same name. Calling to_lowercase on the query is necessary so no matter whether the user’s query is \"rust\", \"RUST\", \"Rust\", or \"rUsT\", we’ll treat the query as if it were \"rust\" and be insensitive to the case. While to_lowercase will handle basic Unicode, it won’t be 100% accurate. If we were writing a real application, we’d want to do a bit more work here, but this section is about environment variables, not Unicode, so we’ll leave it at that here. Note that query is now a String rather than a string slice, because calling to_lowercase creates new data rather than referencing existing data. Say the query is \"rUsT\", as an example: that string slice doesn’t contain a lowercase u or t for us to use, so we have to allocate a new String containing \"rust\". When we pass query as an argument to the contains method now, we need to add an ampersand because the signature of contains is defined to take a string slice. Next, we add a call to to_lowercase on each line to lowercase all characters. Now that we’ve converted line and query to lowercase, we’ll find matches no matter what the case of the query is. Let’s see if this implementation passes the tests: $ cargo test Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `test` profile [unoptimized + debuginfo] target(s) in 1.33s Running unittests src/lib.rs (target/debug/deps/minigrep-9cd200e5fac0fc94) running 2 tests\ntest tests::case_insensitive ... ok\ntest tests::case_sensitive ... ok test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Running unittests src/main.rs (target/debug/deps/minigrep-9cd200e5fac0fc94) running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Doc-tests minigrep running 0 tests test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s Great! They passed. Now, let’s call the new search_case_insensitive function from the run function. First, we’ll add a configuration option to the Config struct to switch between case-sensitive and case-insensitive search. Adding this field will cause compiler errors because we aren’t initializing this field anywhere yet: Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# pub struct Config { pub query: String, pub file_path: String, pub ignore_case: bool,\n}\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # let results = if config.ignore_case {\n# search_case_insensitive(&config.query, &contents)\n# } else {\n# search(&config.query, &contents)\n# };\n# # for line in results {\n# println!(\"{line}\");\n# }\n# # Ok(())\n# }\n# # pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.contains(query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# # pub fn search_case_insensitive<'a>(\n# query: &str,\n# contents: &'a str,\n# ) -> Vec<&'a str> {\n# let query = query.to_lowercase();\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.to_lowercase().contains(&query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn case_sensitive() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Duct tape.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# # #[test]\n# fn case_insensitive() {\n# let query = \"rUsT\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Trust me.\";\n# # assert_eq!(\n# vec![\"Rust:\", \"Trust me.\"],\n# search_case_insensitive(query, contents)\n# );\n# }\n# } We added the ignore_case field that holds a Boolean. Next, we need the run function to check the ignore_case field’s value and use that to decide whether to call the search function or the search_case_insensitive function, as shown in Listing 12-22. This still won’t compile yet. Filename: src/lib.rs # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# pub ignore_case: bool,\n# }\n# # impl Config {\n# pub fn build(args: &[String]) -> Result {\n# if args.len() < 3 {\n# return Err(\"not enough arguments\");\n# }\n# # let query = args[1].clone();\n# let file_path = args[2].clone();\n# # Ok(Config { query, file_path })\n# }\n# }\n# pub fn run(config: Config) -> Result<(), Box> { let contents = fs::read_to_string(config.file_path)?; let results = if config.ignore_case { search_case_insensitive(&config.query, &contents) } else { search(&config.query, &contents) }; for line in results { println!(\"{line}\"); } Ok(())\n}\n# # pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.contains(query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# # pub fn search_case_insensitive<'a>(\n# query: &str,\n# contents: &'a str,\n# ) -> Vec<&'a str> {\n# let query = query.to_lowercase();\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.to_lowercase().contains(&query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn case_sensitive() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Duct tape.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# # #[test]\n# fn case_insensitive() {\n# let query = \"rUsT\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Trust me.\";\n# # assert_eq!(\n# vec![\"Rust:\", \"Trust me.\"],\n# search_case_insensitive(query, contents)\n# );\n# }\n# } Listing 12-22: Calling either search or search_case_insensitive based on the value in config.ignore_case Finally, we need to check for the environment variable. The functions for working with environment variables are in the env module in the standard library, so we bring that module into scope at the top of src/lib.rs . Then we’ll use the var function from the env module to check if any value has been set for an environment variable named IGNORE_CASE, as shown in Listing 12-23. Filename: src/lib.rs use std::env;\n// --snip-- # use std::error::Error;\n# use std::fs;\n# # pub struct Config {\n# pub query: String,\n# pub file_path: String,\n# pub ignore_case: bool,\n# }\n# impl Config { pub fn build(args: &[String]) -> Result { if args.len() < 3 { return Err(\"not enough arguments\"); } let query = args[1].clone(); let file_path = args[2].clone(); let ignore_case = env::var(\"IGNORE_CASE\").is_ok(); Ok(Config { query, file_path, ignore_case, }) }\n}\n# # pub fn run(config: Config) -> Result<(), Box> {\n# let contents = fs::read_to_string(config.file_path)?;\n# # let results = if config.ignore_case {\n# search_case_insensitive(&config.query, &contents)\n# } else {\n# search(&config.query, &contents)\n# };\n# # for line in results {\n# println!(\"{line}\");\n# }\n# # Ok(())\n# }\n# # pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.contains(query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# # pub fn search_case_insensitive<'a>(\n# query: &str,\n# contents: &'a str,\n# ) -> Vec<&'a str> {\n# let query = query.to_lowercase();\n# let mut results = Vec::new();\n# # for line in contents.lines() {\n# if line.to_lowercase().contains(&query) {\n# results.push(line);\n# }\n# }\n# # results\n# }\n# # #[cfg(test)]\n# mod tests {\n# use super::*;\n# # #[test]\n# fn case_sensitive() {\n# let query = \"duct\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Duct tape.\";\n# # assert_eq!(vec![\"safe, fast, productive.\"], search(query, contents));\n# }\n# # #[test]\n# fn case_insensitive() {\n# let query = \"rUsT\";\n# let contents = \"\\\n# Rust:\n# safe, fast, productive.\n# Pick three.\n# Trust me.\";\n# # assert_eq!(\n# vec![\"Rust:\", \"Trust me.\"],\n# search_case_insensitive(query, contents)\n# );\n# }\n# } Listing 12-23: Checking for any value in an environment variable named IGNORE_CASE Here, we create a new variable ignore_case. To set its value, we call the env::var function and pass it the name of the IGNORE_CASE environment variable. The env::var function returns a Result that will be the successful Ok variant that contains the value of the environment variable if the environment variable is set to any value. It will return the Err variant if the environment variable is not set. We’re using the is_ok method on the Result to check whether the environment variable is set, which means the program should do a case-insensitive search. If the IGNORE_CASE environment variable isn’t set to anything, is_ok will return false and the program will perform a case-sensitive search. We don’t care about the value of the environment variable, just whether it’s set or unset, so we’re checking is_ok rather than using unwrap, expect, or any of the other methods we’ve seen on Result. We pass the value in the ignore_case variable to the Config instance so the run function can read that value and decide whether to call search_case_insensitive or search, as we implemented in Listing 12-22. Let’s give it a try! First, we’ll run our program without the environment variable set and with the query to, which should match any line that contains the word “to” in all lowercase: $ cargo run -- to poem.txt Compiling minigrep v0.1.0 (file:///projects/minigrep) Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.0s Running `target/debug/minigrep to poem.txt`\nAre you nobody, too?\nHow dreary to be somebody! Looks like that still works! Now, let’s run the program with IGNORE_CASE set to 1 but with the same query to. $ IGNORE_CASE=1 cargo run -- to poem.txt If you’re using PowerShell, you will need to set the environment variable and run the program as separate commands: PS> $Env:IGNORE_CASE=1; cargo run -- to poem.txt This will make IGNORE_CASE persist for the remainder of your shell session. It can be unset with the Remove-Item cmdlet: PS> Remove-Item Env:IGNORE_CASE We should get lines that contain “to” that might have uppercase letters: Are you nobody, too?\nHow dreary to be somebody!\nTo tell your name the livelong day\nTo an admiring bog! Excellent, we also got lines containing “To”! Our minigrep program can now do case-insensitive searching controlled by an environment variable. Now you know how to manage options set using either command line arguments or environment variables. Some programs allow arguments and environment variables for the same configuration. In those cases, the programs decide that one or the other takes precedence. For another exercise on your own, try controlling case sensitivity through either a command line argument or an environment variable. Decide whether the command line argument or the environment variable should take precedence if the program is run with one set to case sensitive and one set to ignore case. The std::env module contains many more useful features for dealing with environment variables: check out its documentation to see what is available.","breadcrumbs":"An I/O Project: Building a Command Line Program » Working with Environment Variables » Implementing the search_case_insensitive Function","id":"225","title":"Implementing the search_case_insensitive Function"},"226":{"body":"At the moment, we’re writing all of our output to the terminal using the println! macro. In most terminals, there are two kinds of output: standard output (stdout) for general information and standard error (stderr) for error messages. This distinction enables users to choose to direct the successful output of a program to a file but still print error messages to the screen. The println! macro is only capable of printing to standard output, so we have to use something else to print to standard error.","breadcrumbs":"An I/O Project: Building a Command Line Program » Writing Error Messages to Standard Error Instead of Standard Output » Writing Error Messages to Standard Error Instead of Standard Output","id":"226","title":"Writing Error Messages to Standard Error Instead of Standard Output"},"227":{"body":"First, let’s observe how the content printed by minigrep is currently being written to standard output, including any error messages we want to write to standard error instead. We’ll do that by redirecting the standard output stream to a file while intentionally causing an error. We won’t redirect the standard error stream, so any content sent to standard error will continue to display on the screen. Command line programs are expected to send error messages to the standard error stream so we can still see error messages on the screen even if we redirect the standard output stream to a file. Our program is not currently well-behaved: we’re about to see that it saves the error message output to a file instead! To demonstrate this behavior, we’ll run the program with > and the file path, output.txt , that we want to redirect the standard output stream to. We won’t pass any arguments, which should cause an error: $ cargo run > output.txt The > syntax tells the shell to write the contents of standard output to output.txt instead of the screen. We didn’t see the error message we were expecting printed to the screen, so that means it must have ended up in the file. This is what output.txt contains: Problem parsing arguments: not enough arguments Yup, our error message is being printed to standard output. It’s much more useful for error messages like this to be printed to standard error so only data from a successful run ends up in the file. We’ll change that.","breadcrumbs":"An I/O Project: Building a Command Line Program » Writing Error Messages to Standard Error Instead of Standard Output » Checking Where Errors Are Written","id":"227","title":"Checking Where Errors Are Written"},"228":{"body":"We’ll use the code in Listing 12-24 to change how error messages are printed. Because of the refactoring we did earlier in this chapter, all the code that prints error messages is in one function, main. The standard library provides the eprintln! macro that prints to the standard error stream, so let’s change the two places we were calling println! to print errors to use eprintln! instead. Filename: src/main.rs # use std::env;\n# use std::process;\n# # use minigrep::Config;\n# fn main() { let args: Vec = env::args().collect(); let config = Config::build(&args).unwrap_or_else(|err| { eprintln!(\"Problem parsing arguments: {err}\"); process::exit(1); }); if let Err(e) = minigrep::run(config) { eprintln!(\"Application error: {e}\"); process::exit(1); }\n} Listing 12-24: Writing error messages to standard error instead of standard output using eprintln! Let’s now run the program again in the same way, without any arguments and redirecting standard output with >: $ cargo run > output.txt\nProblem parsing arguments: not enough arguments Now we see the error onscreen and output.txt contains nothing, which is the behavior we expect of command line programs. Let’s run the program again with arguments that don’t cause an error but still redirect standard output to a file, like so: $ cargo run -- to poem.txt > output.txt We won’t see any output to the terminal, and output.txt will contain our results: Filename: output.txt Are you nobody, too?\nHow dreary to be somebody! This demonstrates that we’re now using standard output for successful output and standard error for error output as appropriate.","breadcrumbs":"An I/O Project: Building a Command Line Program » Writing Error Messages to Standard Error Instead of Standard Output » Printing Errors to Standard Error","id":"228","title":"Printing Errors to Standard Error"},"229":{"body":"This chapter recapped some of the major concepts you’ve learned so far and covered how to perform common I/O operations in Rust. By using command line arguments, files, environment variables, and the eprintln! macro for printing errors, you’re now prepared to write command line applications. Combined with the concepts in previous chapters, your code will be well organized, store data effectively in the appropriate data structures, handle errors nicely, and be well tested. Next, we’ll explore some Rust features that were influenced by functional languages: closures and iterators.","breadcrumbs":"An I/O Project: Building a Command Line Program » Writing Error Messages to Standard Error Instead of Standard Output » Summary","id":"229","title":"Summary"},"23":{"body":"Let’s review this “Hello, world!” program in detail. Here’s the first piece of the puzzle: fn main() { } These lines define a function named main. The main function is special: it is always the first code that runs in every executable Rust program. Here, the first line declares a function named main that has no parameters and returns nothing. If there were parameters, they would go inside the parentheses (). The function body is wrapped in {}. Rust requires curly brackets around all function bodies. It’s good style to place the opening curly bracket on the same line as the function declaration, adding one space in between. Note: If you want to stick to a standard style across Rust projects, you can use an automatic formatter tool called rustfmt to format your code in a particular style (more on rustfmt in Appendix D ). The Rust team has included this tool with the standard Rust distribution, as rustc is, so it should already be installed on your computer! The body of the main function holds the following code: println!(\"Hello, world!\"); This line does all the work in this little program: it prints text to the screen. There are four important details to notice here. First, Rust style is to indent with four spaces, not a tab. Second, println! calls a Rust macro. If it had called a function instead, it would be entered as println (without the !). We’ll discuss Rust macros in more detail in Chapter 19. For now, you just need to know that using a ! means that you’re calling a macro instead of a normal function and that macros don’t always follow the same rules as functions. Third, you see the \"Hello, world!\" string. We pass this string as an argument to println!, and the string is printed to the screen. Fourth, we end the line with a semicolon (;), which indicates that this expression is over and the next one is ready to begin. Most lines of Rust code end with a semicolon.","breadcrumbs":"Getting Started » Hello, World! » Anatomy of a Rust Program","id":"23","title":"Anatomy of a Rust Program"},"230":{"body":"Rust’s design has taken inspiration from many existing languages and techniques, and one significant influence is functional programming . Programming in a functional style often includes using functions as values by passing them in arguments, returning them from other functions, assigning them to variables for later execution, and so forth. In this chapter, we won’t debate the issue of what functional programming is or isn’t but will instead discuss some features of Rust that are similar to features in many languages often referred to as functional. More specifically, we’ll cover: Closures , a function-like construct you can store in a variable Iterators , a way of processing a series of elements How to use closures and iterators to improve the I/O project in Chapter 12 The performance of closures and iterators (Spoiler alert: they’re faster than you might think!) We’ve already covered some other Rust features, such as pattern matching and enums, that are also influenced by the functional style. Because mastering closures and iterators is an important part of writing idiomatic, fast Rust code, we’ll devote this entire chapter to them.","breadcrumbs":"Functional Language Features: Iterators and Closures » Functional Language Features: Iterators and Closures","id":"230","title":"Functional Language Features: Iterators and Closures"},"231":{"body":"Rust’s closures are anonymous functions you can save in a variable or pass as arguments to other functions. You can create the closure in one place and then call the closure elsewhere to evaluate it in a different context. Unlike functions, closures can capture values from the scope in which they’re defined. We’ll demonstrate how these closure features allow for code reuse and behavior customization.","breadcrumbs":"Functional Language Features: Iterators and Closures » Closures: Anonymous Functions that Capture Their Environment » Closures: Anonymous Functions that Capture Their Environment","id":"231","title":"Closures: Anonymous Functions that Capture Their Environment"},"232":{"body":"We’ll first examine how we can use closures to capture values from the environment they’re defined in for later use. Here’s the scenario: Every so often, our t-shirt company gives away an exclusive, limited-edition shirt to someone on our mailing list as a promotion. People on the mailing list can optionally add their favorite color to their profile. If the person chosen for a free shirt has their favorite color set, they get that color shirt. If the person hasn’t specified a favorite color, they get whatever color the company currently has the most of. There are many ways to implement this. For this example, we’re going to use an enum called ShirtColor that has the variants Red and Blue (limiting the number of colors available for simplicity). We represent the company’s inventory with an Inventory struct that has a field named shirts that contains a Vec representing the shirt colors currently in stock. The method giveaway defined on Inventory gets the optional shirt color preference of the free shirt winner, and returns the shirt color the person will get. This setup is shown in Listing 13-1: Filename: src/main.rs #[derive(Debug, PartialEq, Copy, Clone)]\nenum ShirtColor { Red, Blue,\n} struct Inventory { shirts: Vec,\n} impl Inventory { fn giveaway(&self, user_preference: Option) -> ShirtColor { user_preference.unwrap_or_else(|| self.most_stocked()) } fn most_stocked(&self) -> ShirtColor { let mut num_red = 0; let mut num_blue = 0; for color in &self.shirts { match color { ShirtColor::Red => num_red += 1, ShirtColor::Blue => num_blue += 1, } } if num_red > num_blue { ShirtColor::Red } else { ShirtColor::Blue } }\n} fn main() { let store = Inventory { shirts: vec![ShirtColor::Blue, ShirtColor::Red, ShirtColor::Blue], }; let user_pref1 = Some(ShirtColor::Red); let giveaway1 = store.giveaway(user_pref1); println!( \"The user with preference {:?} gets {:?}\", user_pref1, giveaway1 ); let user_pref2 = None; let giveaway2 = store.giveaway(user_pref2); println!( \"The user with preference {:?} gets {:?}\", user_pref2, giveaway2 );\n} Listing 13-1: Shirt company giveaway situation The store defined in main has two blue shirts and one red shirt remaining to distribute for this limited-edition promotion. We call the giveaway method for a user with a preference for a red shirt and a user without any preference. Again, this code could be implemented in many ways, and here, to focus on closures, we’ve stuck to concepts you’ve already learned except for the body of the giveaway method that uses a closure. In the giveaway method, we get the user preference as a parameter of type Option
+
+
+
+
+
+
+
+