Skip to content

Rewrite paragraph in 'match' to be more concise and readable. Start #30502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 30, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/doc/book/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ hello.rs:4 }
```

This [unfortunate error](https://github.com/rust-lang/rust/issues/22547) is
correct: documentation comments apply to the thing after them, and there's
correct; documentation comments apply to the thing after them, and there's
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"This is correct" is an independent clause, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I read it as being independent but also part of/related to the following sentence though;

  • This unfortunate error is correct. o , documentation comments apply...
    Which I then add a ; to;
  • This unfortunate error is correct; documentation comments apply...

This is the way I was taught to use it in University.
Reference link: Semicolon
Reference link: Colon

nothing after that last comment.

[rc-new]: https://doc.rust-lang.org/nightly/std/rc/struct.Rc.html#method.new
Expand Down Expand Up @@ -385,7 +385,7 @@ error handling. Lets say you want the following,

```rust,ignore
/// use std::io;
/// let mut input = String::new();
/// let mut input = String::new();
/// try!(io::stdin().read_line(&mut input));
```

Expand All @@ -398,7 +398,7 @@ don't return anything so this will give a mismatched types error.
/// ```
/// use std::io;
/// # fn foo() -> io::Result<()> {
/// let mut input = String::new();
/// let mut input = String::new();
/// try!(io::stdin().read_line(&mut input));
/// # Ok(())
/// # }
Expand Down
26 changes: 13 additions & 13 deletions src/doc/book/match.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,24 @@ match x {
`match` takes an expression and then branches based on its value. Each ‘arm’ of
the branch is of the form `val => expression`. When the value matches, that arm’s
expression will be evaluated. It’s called `match` because of the term ‘pattern
matching’, which `match` is an implementation of. There’s an [entire section on
matching’, which `match` is an implementation of. There’s a [separate section on
patterns][patterns] that covers all the patterns that are possible here.

[patterns]: patterns.html

So what’s the big advantage? Well, there are a few. First of all, `match`
enforces ‘exhaustiveness checking’. Do you see that last arm, the one with the
underscore (`_`)? If we remove that arm, Rust will give us an error:
One of the many advantages of `match` is it enforces ‘exhaustiveness checking’.
For example if we remove the last arm with the underscore `_`, the compiler will
give us an error:

```text
error: non-exhaustive patterns: `_` not covered
```

In other words, Rust is trying to tell us we forgot a value. Because `x` is an
integer, Rust knows that it can have a number of different values – for
example, `6`. Without the `_`, however, there is no arm that could match, and
so Rust refuses to compile the code. `_` acts like a ‘catch-all arm’. If none
of the other arms match, the arm with `_` will, and since we have this
catch-all arm, we now have an arm for every possible value of `x`, and so our
program will compile successfully.
Rust is telling us that we forgot a value. The compiler infers from `x` that it
can have any positive 32bit value; for example 1 to 2,147,483,647. The `_` acts
as a 'catch-all', and will catch all possible values that *aren't* specified in
an arm of `match`. As you can see with the previous example, we provide `match`
arms for integers 1-5, if `x` is 6 or any other value, then it is caught by `_`.

`match` is also an expression, which means we can use it on the right-hand
side of a `let` binding or directly where an expression is used:
Expand All @@ -60,7 +58,8 @@ let number = match x {
};
```

Sometimes it’s a nice way of converting something from one type to another.
Sometimes it’s a nice way of converting something from one type to another; in
this example the integers are converted to `String`.

# Matching on enums

Expand Down Expand Up @@ -91,7 +90,8 @@ fn process_message(msg: Message) {

Again, the Rust compiler checks exhaustiveness, so it demands that you
have a match arm for every variant of the enum. If you leave one off, it
will give you a compile-time error unless you use `_`.
will give you a compile-time error unless you use `_` or provide all possible
arms.

Unlike the previous uses of `match`, you can’t use the normal `if`
statement to do this. You can use the [`if let`][if-let] statement,
Expand Down