diff options
Diffstat (limited to '')
| -rw-r--r-- | src/doc/book/nostarch/chapter01.md | 161 |
1 files changed, 63 insertions, 98 deletions
diff --git a/src/doc/book/nostarch/chapter01.md b/src/doc/book/nostarch/chapter01.md index 87848b66f..3379b14f2 100644 --- a/src/doc/book/nostarch/chapter01.md +++ b/src/doc/book/nostarch/chapter01.md @@ -21,28 +21,28 @@ 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. +> 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. 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. > ### 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 `$`. +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 +### Installing rustup on Linux or macOS If you’re using Linux or macOS, open a terminal and enter the following command: @@ -74,7 +74,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,18 +82,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 - -<!-- Liz: We do want to recommend the English language pack along with whatever -other languages the reader speaks-- otherwise, sometimes error messages are -printed strangely -https://github.com/rust-lang/rust/issues/35785#issuecomment-735051657 /Carol --> +* “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. @@ -108,7 +103,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) @@ -133,25 +128,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*. - -<!-- `echo %PATH%` will work for cmd. PowerShell would use `echo $env:Path`. -Bash would use `echo $PATH` /JT --> -<!-- I've added these instructions above /Carol --> +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 @@ -166,9 +154,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 @@ -176,17 +164,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! +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 @@ -254,8 +242,8 @@ 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. +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! @@ -281,10 +269,10 @@ function bodies. It’s good style to place the opening curly bracket on the sam 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! +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: @@ -300,7 +288,7 @@ 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 @@ -327,16 +315,16 @@ 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 =% @@ -387,9 +375,9 @@ 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 @@ -402,9 +390,9 @@ 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 @@ -424,8 +412,8 @@ 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. +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. @@ -471,7 +459,7 @@ fn main() { 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 @@ -499,21 +487,6 @@ $ cargo build This command creates an executable file in *target/debug/hello_cargo* (or *target\debug\hello_cargo.exe* on Windows) rather than in your current -<!-- why does it put it in a debug folder? Interesting to know, because it seems -laborious to have to enter the whole path to run the executable /LC --> -<!-- Because `build` uses debug settings by default, and the compiler tries to -make it clear that this isn't a release build by storing it in the `debug` -path. Most people use `cargo run` instead, which is what we show in a few -paragraphs. We talk about building for release mode in the next section; do you -think it needs to be mentioned here too? I think it would be somewhat -distracting and repetitive to get into that right here... /Carol --> -<!-- JT, what do you think? I don't want to get into the weeds... but will the -reader be wondering? /LC --> -<!-- I think we could quickly mention that because the default build is a debug -build, cargo will put the binary in the debug directory. If we created a release -build, it would put it in the release directory. Looks like we do mention this -later /JT --> -<!-- I've added a sentence here along the lines of what JT suggested /Carol --> 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: @@ -531,7 +504,7 @@ 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: +code and then run the resultant executable all in one command: ``` $ cargo run @@ -568,7 +541,7 @@ $ cargo check ``` 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 +`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 @@ -581,9 +554,9 @@ Let’s recap what we’ve learned so far about Cargo: * 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 @@ -609,10 +582,6 @@ With simple projects, Cargo doesn’t provide a lot of value over just using Once programs grow to multiple files or need a dependency, it’s much easier to let Cargo coordinate the build. -<!-- I think once you go add a second file or add a single dependency, you -already want to move to cargo imho. /JT --> -<!-- Updated above! /Carol --> - 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 @@ -624,7 +593,8 @@ $ 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 @@ -642,8 +612,3 @@ 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. -<!-- Question for Carol: Do we want to mention IDE support? Rust Analyzer is -pretty good these days. /JT --> -<!-- I don't want to make the reader feel like they *have* to stop at this -point and set up their IDE (or use an unfamiliar IDE); I did add a sentence to -the note about IDEs pointing to Appendix D for more info on Rust Analyzer. --> |