Skip to content

Commit fff2b35

Browse files
committed
rollup merge of rust-lang#18355 : chastell/guide_iterators_macros_unsafe_fixes
2 parents 3aaee49 + 1bfe6a2 commit fff2b35

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

src/doc/guide.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4467,18 +4467,19 @@ see why consumers matter.
44674467

44684468
## Iterators
44694469

4470-
As we've said before, an iterator is something that we can call the `.next()`
4471-
method on repeatedly, and it gives us a sequence of things. Because you need
4472-
to call the method, this means that iterators are **lazy**. This code, for
4473-
example, does not actually generate the numbers `1-100`, and just creates a
4474-
value that represents the sequence:
4470+
As we've said before, an iterator is something that we can call the
4471+
`.next()` method on repeatedly, and it gives us a sequence of things.
4472+
Because you need to call the method, this means that iterators
4473+
are **lazy** and don't need to generate all of the values upfront.
4474+
This code, for example, does not actually generate the numbers
4475+
`1-100`, and just creates a value that represents the sequence:
44754476

44764477
```{rust}
44774478
let nums = range(1i, 100i);
44784479
```
44794480

44804481
Since we didn't do anything with the range, it didn't generate the sequence.
4481-
Once we add the consumer:
4482+
Let's add the consumer:
44824483

44834484
```{rust}
44844485
let nums = range(1i, 100i).collect::<Vec<int>>();
@@ -4507,8 +4508,8 @@ std::iter::count(1i, 5i);
45074508
```
45084509

45094510
This iterator counts up from one, adding five each time. It will give
4510-
you a new integer every time, forever. Well, technically, until the
4511-
maximum number that an `int` can represent. But since iterators are lazy,
4511+
you a new integer every time, forever (well, technically, until it reaches the
4512+
maximum number representable by an `int`). But since iterators are lazy,
45124513
that's okay! You probably don't want to use `collect()` on it, though...
45134514

45144515
That's enough about iterators. Iterator adapters are the last concept
@@ -5251,8 +5252,8 @@ to do something that it can't currently do? You may be able to write a macro
52515252
to extend Rust's capabilities.
52525253

52535254
You've already used one macro extensively: `println!`. When we invoke
5254-
a Rust macro, we need to use the exclamation mark (`!`). There's two reasons
5255-
that this is true: the first is that it makes it clear when you're using a
5255+
a Rust macro, we need to use the exclamation mark (`!`). There are two reasons
5256+
why this is so: the first is that it makes it clear when you're using a
52565257
macro. The second is that macros allow for flexible syntax, and so Rust must
52575258
be able to tell where a macro starts and ends. The `!(...)` helps with this.
52585259

@@ -5267,7 +5268,7 @@ println!("x is: {}", x);
52675268

52685269
The `println!` macro does a few things:
52695270

5270-
1. It parses the string to find any `{}`s
5271+
1. It parses the string to find any `{}`s.
52715272
2. It checks that the number of `{}`s matches the number of other arguments.
52725273
3. It generates a bunch of Rust code, taking this in mind.
52735274

@@ -5276,8 +5277,8 @@ Rust will generate code that takes all of the types into account. If
52765277
`println!` was a function, it could still do this type checking, but it
52775278
would happen at run time rather than compile time.
52785279

5279-
We can check this out using a special flag to `rustc`. This code, in a file
5280-
`print.rs`:
5280+
We can check this out using a special flag to `rustc`. Put this code in a file
5281+
called `print.rs`:
52815282

52825283
```{rust}
52835284
fn main() {
@@ -5286,7 +5287,7 @@ fn main() {
52865287
}
52875288
```
52885289

5289-
Can have its macros expanded like this: `rustc print.rs --pretty=expanded`, will
5290+
You can have the macros expanded like this: `rustc print.rs --pretty=expanded` – which will
52905291
give us this huge result:
52915292

52925293
```{rust,ignore}
@@ -5325,12 +5326,12 @@ invoke the `println_args` function with the generated arguments.
53255326
This is the code that Rust actually compiles. You can see all of the extra
53265327
information that's here. We get all of the type safety and options that it
53275328
provides, but at compile time, and without needing to type all of this out.
5328-
This is how macros are powerful. Without them, you would need to type all of
5329-
this by hand to get a type checked `println`.
5329+
This is how macros are powerful: without them you would need to type all of
5330+
this by hand to get a type-checked `println`.
53305331

53315332
For more on macros, please consult [the Macros Guide](guide-macros.html).
5332-
Macros are a very advanced and still slightly experimental feature, but don't
5333-
require a deep understanding to call, since they look just like functions. The
5333+
Macros are a very advanced and still slightly experimental feature, but they don't
5334+
require a deep understanding to be called, since they look just like functions. The
53345335
Guide can help you if you want to write your own.
53355336

53365337
# Unsafe
@@ -5347,8 +5348,8 @@ keyword, which indicates that the function may not behave properly.
53475348

53485349
Second, if you'd like to create some sort of shared-memory data structure, Rust
53495350
won't allow it, because memory must be owned by a single owner. However, if
5350-
you're planning on making access to that shared memory safe, such as with a
5351-
mutex, _you_ know that it's safe, but Rust can't know. Writing an `unsafe`
5351+
you're planning on making access to that shared memory safe such as with a
5352+
mutex _you_ know that it's safe, but Rust can't know. Writing an `unsafe`
53525353
block allows you to ask the compiler to trust you. In this case, the _internal_
53535354
implementation of the mutex is considered unsafe, but the _external_ interface
53545355
we present is safe. This allows it to be effectively used in normal Rust, while

0 commit comments

Comments
 (0)