diff --git a/nostarch/chapter01.md b/nostarch/chapter01.md index daaf44f5e..0d81803a9 100644 --- a/nostarch/chapter01.md +++ b/nostarch/chapter01.md @@ -12,37 +12,40 @@ Let’s start your Rust journey! There’s a lot to learn, but every journey sta somewhere. In this chapter, we’ll discuss: * Installing Rust on Linux, macOS, and Windows -* Writing a program that prints `Hello, world!` +* Writing a program that prints `Hello,` `world!` * Using `cargo`, Rust’s package manager and build system - ## Installation 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 at -> *https://forge.rust-lang.org/infra/other-installation-methods.html* for more -> options. +> NoteIf you prefer not to use `rustup` for some reason, please see the Other +Rust Installation Methods page at +*https://forge.rust-lang.org/infra/other-installation-methods.html* 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. +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. + + +Unmatched: BoxType > ### Command Line Notation -> -> 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 in 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 `$`. -### Installing `rustup` on Linux or macOS + +> 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 `$`. + +### Installing rustup on Linux or macOS If you’re using Linux or macOS, open a terminal and enter the following command: @@ -74,7 +77,7 @@ 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. -### Installing `rustup` on Windows +### Installing rustup on Windows 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 @@ -82,14 +85,13 @@ receive a message explaining that you’ll also need the MSVC build tools for Visual Studio 2013 or later. To acquire the build tools, you’ll need to install Visual Studio 2022 from -*https://visualstudio.microsoft.com/downloads/*. When asked which workloads to +*https://visualstudio.microsoft.com/downloads*. When asked which workloads to install, include: -- “Desktop Development with C++” -- The Windows 10 or 11 SDK -- The English language pack component, along with any other language pack of - your choosing - +* “Desktop Development with C++” +* The Windows 10 or 11 SDK +* The English language pack component, along with any other language pack of +your choosing 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. @@ -103,7 +105,7 @@ $ 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: +stable version that has been released, in the following format: ``` rustc x.y.z (abcabcabc yyyy-mm-dd) @@ -128,21 +130,18 @@ In PowerShell, use: In Linux and macOS, use: ``` -echo $PATH +$ echo $PATH ``` If that’s all correct and Rust still isn’t working, there are a number of -places you can get help. The easiest is the #beginners channel on the official -Rust Discord at *https://discord.gg/rust-lang*. There, you can chat with other -Rustaceans (a silly nickname we call ourselves) who can help you out. Other -great resources include the Users forum at *https://users.rust-lang.org/* and -Stack Overflow at *https://stackoverflow.com/questions/tagged/rust*. +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 at +*https://www.rust-lang.org/community*. ### Updating and Uninstalling -Once Rust is installed via `rustup`, when a new version of Rust is released, -updating to the latest version is easy. From your shell, run the following -update script: +Once Rust is installed via `rustup`, updating to a newly released version is +easy. From your shell, run the following update script: ``` $ rustup update @@ -157,9 +156,9 @@ $ rustup self uninstall ### Local Documentation -The installation of Rust also includes a local copy of the documentation, so -you can read it offline. Run `rustup doc` to open the local documentation in -your browser. +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 @@ -167,17 +166,17 @@ sure what it does or how to use it, use the application programming interface ## Hello, World! -Now that you’ve installed Rust, let’s 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! +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! +> NoteThis 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. ### Creating a Project Directory @@ -193,8 +192,17 @@ For Linux, macOS, and PowerShell on Windows, enter this: ``` $ mkdir ~/projects +``` + +``` $ cd ~/projects +``` + +``` $ mkdir hello_world +``` + +``` $ cd hello_world ``` @@ -202,8 +210,17 @@ For Windows CMD, enter this: ``` > mkdir "%USERPROFILE%\projects" +``` + +``` > cd /d "%USERPROFILE%\projects" +``` + +``` > mkdir hello_world +``` + +``` > cd hello_world ``` @@ -220,11 +237,17 @@ Filename: main.rs ``` fn main() { +``` + +``` println!("Hello, world!"); +``` + +``` } ``` -Listing 1-1: A program that prints `Hello, world!` +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 @@ -232,7 +255,13 @@ commands to compile and run the file: ``` $ rustc main.rs +``` + +``` $ ./main +``` + +``` Hello, world! ``` @@ -240,16 +269,22 @@ 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. +Regardless of your operating system, the string `Hello,` `world!` should print +to the terminal. If you don’t see this output, refer back to “Troubleshooting” +on page XX 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! +If `Hello,` `world!` did print, congratulations! You’ve officially written a +Rust program. That makes you a Rust programmer—welcome! ### Anatomy of a Rust Program @@ -258,12 +293,18 @@ 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 +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 `()`. @@ -271,11 +312,11 @@ 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, like `rustc`, so it -> should already be installed on your computer! +> NoteIf 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: @@ -291,11 +332,11 @@ 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 +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. +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 @@ -318,21 +359,33 @@ 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. 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. +entering the `ls` command in your shell. ``` $ ls +``` + +``` main main.rs ``` -With CMD on Windows, you would enter the following: +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 ``` @@ -345,14 +398,14 @@ 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 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 +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 +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. @@ -378,27 +431,30 @@ 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 +used the official installers discussed in “Installation” on page XX. If you installed Rust through some other means, check whether Cargo is installed by -entering the following into your terminal: +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. +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. ### Creating a Project with Cargo 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: +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 ``` @@ -411,12 +467,12 @@ 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`. +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. +> NoteGit 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. @@ -425,25 +481,40 @@ Filename: Cargo.toml ``` [package] -name = "hello_cargo" -version = "0.1.0" -edition = "2021" +``` +``` +name = "hello_cargo" +``` + +``` +version = "0.1.0" +``` + +``` +edition = "2021" +``` + +``` + +``` + +``` [dependencies] ``` -Listing 1-2: Contents of *Cargo.toml* generated by `cargo new` +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. +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. +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 @@ -456,13 +527,19 @@ 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, +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 @@ -484,7 +561,13 @@ 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 ``` @@ -495,30 +578,42 @@ 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 +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 resulting executable all in one command: +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`. +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 @@ -528,55 +623,72 @@ 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 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. +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 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`. +`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. - +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. ### Building for Release -When your project is finally ready for release, you can use `cargo build ---release` to compile it with optimizations. This command will create an +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*. +code’s running time, be sure to run `cargo` `build` `--release` and benchmark +with the executable in *target/release*. ### Cargo as Convention @@ -592,11 +704,18 @@ using Git, change to that project’s directory, and build: ``` $ git clone example.org/someproject +``` + +``` $ cd someproject +``` + +``` $ cargo build ``` -For more information about Cargo, check out its documentation at *https://doc.rust-lang.org/cargo/*. +For more information about Cargo, check out its documentation at +*https://doc.rust-lang.org/cargo*. ## Summary @@ -608,8 +727,8 @@ you’ve learned how to: * 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. + diff --git a/nostarch/docx/chapter01.docx b/nostarch/docx/chapter01.docx index 88794a7a4..f3bccda5b 100644 Binary files a/nostarch/docx/chapter01.docx and b/nostarch/docx/chapter01.docx differ