Skip to content

(Mini) Rollup of 15 pull requests #23660

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

Closed
wants to merge 32 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
0c040b0
guide: minor copy edits
ches Mar 2, 2015
92294e7
guide: Improvements to language covering enums
ches Mar 2, 2015
c175b35
fix the attributes sytax
FuGangqiang Mar 21, 2015
bc9d9f2
add lifetime for `while` and `for` expression
FuGangqiang Mar 21, 2015
90c8592
Refine Cursor docstring
nagisa Mar 22, 2015
5321d22
Remove bad reference to std::io
steveklabnik Mar 22, 2015
fbc823d
Document how to document macros
steveklabnik Mar 22, 2015
81801f2
Re-word explanation on closures in intro
steveklabnik Mar 22, 2015
d944689
Fix dead link for std::sync::mpsc.
WiSaGaN Mar 23, 2015
2750e3c
Add note about pointer state after the call.
steveklabnik Mar 20, 2015
d6fb7e9
derive missing trait implementations for cursor
mahkoh Mar 22, 2015
a5e1cbe
Beef up BufRead::consume documentation.
steveklabnik Mar 22, 2015
d52c362
Clarify that slices don't just point to arrays
steveklabnik Mar 23, 2015
05c9728
Don't conflate regions and affine types
steveklabnik Mar 23, 2015
1be8fcb
Make note of str in 'more strings' chapter
steveklabnik Mar 23, 2015
248b2ec
Stabilize Entry types
aturon Mar 19, 2015
3f52d71
Update docs for ptr module.
mbrubeck Mar 23, 2015
1f984c6
Rollup merge of #22954 - ches:docs, r=steveklabnik
Manishearth Mar 24, 2015
413c0c9
Rollup merge of #23509 - aturon:stab-entry, r=aturon
Manishearth Mar 24, 2015
566becb
Rollup merge of #23561 - steveklabnik:gh23422, r=alexcrichton
Manishearth Mar 24, 2015
2b19ddb
Rollup merge of #23590 - FuGangqiang:attr, r=alexcrichton
Manishearth Mar 24, 2015
847118f
Rollup merge of #23607 - mahkoh:cursor, r=alexcrichton
Manishearth Mar 24, 2015
cc76e09
Rollup merge of #23608 - nagisa:refine-cursor-docstring, r=steveklabnik
Manishearth Mar 24, 2015
3a021fa
Rollup merge of #23615 - steveklabnik:gh23540, r=alexcrichton
Manishearth Mar 24, 2015
01e94e7
Rollup merge of #23618 - steveklabnik:gh23571, r=alexcrichton
Manishearth Mar 24, 2015
b5e841b
Rollup merge of #23619 - steveklabnik:gh23220, r=alexcrichton
Manishearth Mar 24, 2015
408e6bd
Rollup merge of #23622 - steveklabnik:gh23196, r=alexcrichton
Manishearth Mar 24, 2015
10ab1cb
Rollup merge of #23634 - WiSaGaN:bugfix/fix_dead_link, r=steveklabnik
Manishearth Mar 24, 2015
0175198
Rollup merge of #23639 - steveklabnik:gh21305, r=alexcrichton
Manishearth Mar 24, 2015
12c7e37
Rollup merge of #23641 - steveklabnik:gh23632, r=alexcrichton
Manishearth Mar 24, 2015
4c11af4
Rollup merge of #23644 - mbrubeck:doc-edit, r=steveklabnik
Manishearth Mar 24, 2015
01a7947
Rollup merge of #23645 - steveklabnik:gh23642, r=brson
Manishearth Mar 24, 2015
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
Prev Previous commit
Next Next commit
guide: Improvements to language covering enums
  • Loading branch information
ches committed Mar 20, 2015
commit 92294e7aedf26c1b276b4a721e18b7a43217848d
68 changes: 35 additions & 33 deletions src/doc/trpl/compound-data-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,9 @@ Now, we have actual names, rather than positions. Good names are important,
and with a struct, we have actual names.

There _is_ one case when a tuple struct is very useful, though, and that's a
tuple struct with only one element. We call this a *newtype*, because it lets
you create a new type that's similar to another one:
tuple struct with only one element. We call this the *newtype* pattern, because
it allows you to create a new type, distinct from that of its contained value
and expressing its own semantic meaning:

```{rust}
struct Inches(i32);
Expand All @@ -216,7 +217,7 @@ destructuring `let`, as we discussed previously in 'tuples.' In this case, the

Finally, Rust has a "sum type", an *enum*. Enums are an incredibly useful
feature of Rust, and are used throughout the standard library. An `enum` is
a type which ties a set of alternates to a specific name. For example, below
a type which relates a set of alternates to a specific name. For example, below
we define `Character` to be either a `Digit` or something else. These
can be used via their fully scoped names: `Character::Other` (more about `::`
below).
Expand All @@ -228,8 +229,8 @@ enum Character {
}
```

An `enum` variant can be defined as most normal types. Below are some example
types which also would be allowed in an `enum`.
Most normal types are allowed as the variant components of an `enum`. Here are
some examples:

```rust
struct Empty;
Expand All @@ -239,15 +240,15 @@ struct Status { Health: i32, Mana: i32, Attack: i32, Defense: i32 }
struct HeightDatabase(Vec<i32>);
```

So you see that depending on the sub-datastructure, the `enum` variant, same as
a struct, may or may not hold data. That is, in `Character`, `Digit` is a name
tied to an `i32` where `Other` is just a name. However, the fact that they are
distinct makes this very useful.
You see that, depending on its type, an `enum` variant may or may not hold data.
In `Character`, for instance, `Digit` gives a meaningful name for an `i32`
value, where `Other` is only a name. However, the fact that they represent
distinct categories of `Character` is a very useful property.

As with structures, enums don't by default have access to operators such as
compare ( `==` and `!=`), binary operations (`*` and `+`), and order
(`<` and `>=`). As such, using the previous `Character` type, the
following code is invalid:
As with structures, the variants of an enum by default are not comparable with
equality operators (`==`, `!=`), have no ordering (`<`, `>=`, etc.), and do not
support other binary operations such as `*` and `+`. As such, the following code
is invalid for the example `Character` type:

```{rust,ignore}
// These assignments both succeed
Expand All @@ -265,9 +266,10 @@ let four_equals_ten = four == ten;
```

This may seem rather limiting, but it's a limitation which we can overcome.
There are two ways: by implementing equality ourselves, or by using the
[`match`][match] keyword. We don't know enough about Rust to implement equality
yet, but we can use the `Ordering` enum from the standard library, which does:
There are two ways: by implementing equality ourselves, or by pattern matching
variants with [`match`][match] expressions, which you'll learn in the next
chapter. We don't know enough about Rust to implement equality yet, but we can
use the `Ordering` enum from the standard library, which does:

```
enum Ordering {
Expand All @@ -277,9 +279,8 @@ enum Ordering {
}
```

Because we did not define `Ordering`, we must import it (from the std
library) with the `use` keyword. Here's an example of how `Ordering` is
used:
Because `Ordering` has already been defined for us, we will import it with the
`use` keyword. Here's an example of how it is used:

```{rust}
use std::cmp::Ordering;
Expand Down Expand Up @@ -313,17 +314,17 @@ the standard library if you need them.

Okay, let's talk about the actual code in the example. `cmp` is a function that
compares two things, and returns an `Ordering`. We return either
`Ordering::Less`, `Ordering::Greater`, or `Ordering::Equal`, depending on if
the two values are less, greater, or equal. Note that each variant of the
`enum` is namespaced under the `enum` itself: it's `Ordering::Greater` not
`Greater`.
`Ordering::Less`, `Ordering::Greater`, or `Ordering::Equal`, depending on
whether the first value is less than, greater than, or equal to the second. Note
that each variant of the `enum` is namespaced under the `enum` itself: it's
`Ordering::Greater`, not `Greater`.

The `ordering` variable has the type `Ordering`, and so contains one of the
three values. We then do a bunch of `if`/`else` comparisons to check which
one it is.

This `Ordering::Greater` notation is too long. Let's use `use` to import the
`enum` variants instead. This will avoid full scoping:
This `Ordering::Greater` notation is too long. Let's use another form of `use`
to import the `enum` variants instead. This will avoid full scoping:

```{rust}
use std::cmp::Ordering::{self, Equal, Less, Greater};
Expand All @@ -347,14 +348,15 @@ fn main() {
```

Importing variants is convenient and compact, but can also cause name conflicts,
so do this with caution. It's considered good style to rarely import variants
for this reason.

As you can see, `enum`s are quite a powerful tool for data representation, and are
even more useful when they're [generic][generics] across types. Before we
get to generics, though, let's talk about how to use them with pattern matching, a
tool that will let us deconstruct this sum type (the type theory term for enums)
in a very elegant way and avoid all these messy `if`/`else`s.
so do this with caution. For this reason, it's normally considered better style
to `use` an enum rather than its variants directly.

As you can see, `enum`s are quite a powerful tool for data representation, and
are even more useful when they're [generic][generics] across types. Before we
get to generics, though, let's talk about how to use enums with pattern
matching, a tool that will let us deconstruct sum types (the type theory term
for enums) like `Ordering` in a very elegant way that avoids all these messy
and brittle `if`/`else`s.


[arity]: ./glossary.html#arity
Expand Down