Skip to content

1.18.0 announcement #173

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 3 commits into from
Jun 8, 2017
Merged
Changes from 1 commit
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
200 changes: 200 additions & 0 deletions _posts/2017-06-08-Rust-1.18.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
---
layout: post
title: "Announcing Rust 1.18"
author: The Rust Core Team
---

The Rust team is happy to announce the latest version of Rust, 1.18.0. Rust is a
systems programming language focused on safety, speed, and concurrency.

If you have a previous version of Rust installed, getting Rust 1.18 is as easy as:

```bash
$ rustup update stable
```

If you don't have it already, you can [get `rustup`][install] from the
appropriate page on our website, and check out the [detailed release notes for
1.18.0][notes] on GitHub.

[install]: https://www.rust-lang.org/install.html
[notes]: https://github.com/rust-lang/rust/blob/rust-1.17-relnotes/RELEASES.md#version-1180-2017-06-08

### What's in 1.18.0 stable

Rust 1.18.0 is similar to many of our releases: no big bombshells, just a number
Copy link
Member

Choose a reason for hiding this comment

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

nit, and this is totally a personal pet peeve of mine that you can feel free to ignore, can we not use war-related phrases? suggestion: "no big surprises"?

Copy link
Member

Choose a reason for hiding this comment

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

I would just drop this altogether. On the train system, this is the default! Incremental improvement over time. Making a note of it like this feels unnecessarily defensive.

of improvements, cleanups, and new features.

One of the largest changes is a long time coming: core team members Carol
Nichols and Steve Klabnik have been writing a new edition of "The Rust
Copy link
Member

Choose a reason for hiding this comment

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

❤️

Programming Language", the official book about Rust. It's being [written openly
on GitHub](https://github.com/rust-lang/book), and has over a hundred
contributors in total. This release [includes the first draft of the second
edition in our online documentation](https://doc.rust-lang.org/stable/book/).
19 out of 20 chapters have a draft; the draft of chapter 20 will land in the
Rust 1.19. When the book is done, a print version will be made available through
Copy link
Member

Choose a reason for hiding this comment

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

s/in the Rust 1.19./in Rust 1.19./ or /in the Rust 1.19 release./

[No Starch Press](https://www.nostarch.com/Rust), if you'd like a paper copy.
While first drafts of the chapters are available, we're still working with the
editors at No Starch to improve the text, so there's more to do, but we wanted
to start getting a wider audience now. The new edition is a complete re-write
Copy link
Member

Choose a reason for hiding this comment

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

The "While first drafts" sentence feels kinda long, maybe split it in two? Or shorten to just "We're still working with the editors at No Starch to improve the text, but we wanted to start getting a wider audience now"?

Copy link
Member

Choose a reason for hiding this comment

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

"The new edition" -> I'd start a new paragraph with that sentence.

from the ground up, using the last two years of knowledge we've gained from
teaching people Rust. You'll find brand-new explanations for a lot of Rust's
core concepts, new projects to build, and all kinds of other good stuff. Please
check it out and let us know what you think!
Copy link
Member

Choose a reason for hiding this comment

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

Should we include a link to the rust-lang/book repo again here? Or the new issue form in that repo?


As for the language itself, an old feature has learned some new tricks: the
`pub` keyword has been expanded a bit. Experienced Rustaceans will know that
items are private by default in Rust, and you can use the `pub` keyword to make
them public. In Rust 1.18.0, `pub` has [gained a new
form](https://github.com/rust-lang/rust/pull/40556):

```rust
pub(crate) bar;
```

The bit inside of `()` is a 'restriction', which refines the notion of how this
is made public. Using the `crate` keyword like the example above means that
`bar` would be public to the entire crate, but not outside of it. This makes it
easier to declare APIs that are "public to your crate", but not exposed to your
users. This was *possible* with the current module system, but often very awkward.
Copy link
Member

Choose a reason for hiding this comment

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

s/current/existing/


You can also specify a path, like this:

```rust
pub(a::b::c) foo;
Copy link
Member

Choose a reason for hiding this comment

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

The syntax is pub(in a::b::c). That was a last minute change before stabilization. pub(crate) is fine.

```

This means "usable within the hierarchy of `a::b::c`, but not elsewhere." This
feature was defined in [RFC
1422](https://github.com/rust-lang/rfcs/blob/master/text/1422-pub-restricted.md)
Copy link
Member

Choose a reason for hiding this comment

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

Can we add a link to https://doc.rust-lang.org/beta/reference/visibility-and-privacy.html#pubin-path-pubcrate-pubsuper-and-pubself (with beta replaced with stable when appropriate) here?

Copy link
Member

Choose a reason for hiding this comment

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

resolved


For our Windows users, Rust 1.18.0 has [a new attribute,
`#![windows_subsystem]`](https://github.com/rust-lang/rust/pull/40870). It
works like this:

```rust
#![windows_subsystem(console)]
#![windows_subsystem(windows)]
```

These control the [`/SUBSYSTEM` flag](https://msdn.microsoft.com/en-us/library/fcc1zstk.aspx)
in the linker. For now, only `console` and `windows` are supported.

When is this useful? In the simplest terms, if you're developing a graphical
application, and do not specify `windows`, a console window would flash up upon
your application's start. With this flag, it won't.

Finally, Rust's tuples, enum variant fields, and structs (without `#[repr]`) have
always had an undefined layout. [We've turned on automatic re-ordering](https://github.com/rust-lang/rust/pull/40377), which can result in smaller sizes
through reducing padding. Consider a struct like this:

```rust
struct Suboptimal(u8, u16, u8);
```

In previous versions of Rust on the x86_64 platform, this struct would have the
size of six bytes. But looking at the source, you'd expect it to have four. The
extra two bytes come from padding; given that we have a `u16` here, it should be
aligned to two bytes. But in this case, it's at offset one. To move it to offset
two, another byte of padding is placed after the first `u8`. To give the whole struct
a proper alignment, another byte is added after the second `u8` as well, giving us
`1 + 1 (padding) + 2 + 1 + 1 (padding) = 6 bytes`.

But what if our struct looked like this?

```rust
struct Optimal(u8, u8, u16);
```

This struct is properly aligned; the `u16` lies on a two byte boundary, and so does
the entire struct. No padding is needed. This gives us `1 + 1 + 2 = 4 bytes`.

When designing Rust, stuff like this is why we left the details here undefined.
Copy link
Member

Choose a reason for hiding this comment

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

Little too much "stuff" "here" "thing" :-)

It allows for exactly this kind of thing: the compiler can optimize `Suboptimal`
into `Optimal` automatically. And if you check the sizes of `Suboptimal` and
`Optimal` on Rust 1.18.0, you'll see that they both have a size of four bytes.

We've been planning this for a while; previous versions of Rust included this
Copy link
Member

Choose a reason for hiding this comment

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

s/this/this change/

optimization on the nightly channel, but some people wrote unsafe code that
assumed the exact details of the representation. We rolled it back while we fixed
all instances of this that we know about, but if you find some code breaks due to
Copy link
Member

Choose a reason for hiding this comment

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

What kind of code would break because of this? What does breaking look like? How do I fix it? This is a little scary to me without it, even though I probably don't have this problem ;)

Is there someplace we can link that would go into more details on the potential breakage?

Copy link
Member

Choose a reason for hiding this comment

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

just changed this to "let us know so we can help you fix it" esp since aturon recommended removing all the fuel stuff

this, you should fix it! In the meantime, there's also a flag you can use to control
this. Imagine we have `Suboptimal` in a file named `foo.rs`, along with a `main`
function that prints out its size:

```rust
> rustc foo.rs
> ./foo
4
> rustc foo.rs -Z fuel=foo=0
Copy link
Member

Choose a reason for hiding this comment

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

Is this an unstable flag that isn't supposed to be used on stable? (I might be confused about this)

Is foo here the module path?

Are there docs/PR/RFC/issue on this flag we can link to here?

Copy link
Member

Choose a reason for hiding this comment

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

now moot

optimization-fuel-exhausted: Reorder fields of "Suboptimal"
Copy link
Member

Choose a reason for hiding this comment

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

Will this work on stable? It seems like we don't really want to publicize -Z options... though there's probably no alternative right now.

Copy link
Member

Choose a reason for hiding this comment

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

I think -Z will work on stable 1.18, but stop working on stable 1.19, when this PR gets into stable.

> ./foo
6
```

This flag is based on an idea called "[Optimization
fuel](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/07/dfopt-popl10.pdf)":

> It works by giving the optimizer a finite supply of optimization fuel. Each
> time a rewrite function proposes to replace a node, one unit of fuel is
> consumed. When the optimizer runs out of fuel, further rewrites are
> suppressed.

Currently, this is the only optimization that uses the "fuel" concept. By
Copy link
Member

Choose a reason for hiding this comment

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

We should nix the stuff about the fuel flag.

setting the fuel to zero, `rustc` will not perform the optimization. This can
keep your code compiling if you run into a problem, but the longer-term fix is
to use a `#[repr]` attribute to guarantee a particular layout if you rely on it.

We've been planning on moving `rustdoc` to use a CommonMark compliant markdown
parser for a long time now. However, just switching over can introduce
regressions where the CommonMark spec differs from our existing parser, Hoedown.
As part of the transition plan, [a new flag has been added to
`rustdoc`](https://github.com/rust-lang/rust/pull/40338), `--enable-commonmark`.
This will use the new parser instead of the old one. Please give it a try! There's
no scenario we know of where tweaking your markdown gets identical results on both
Copy link
Member

Choose a reason for hiding this comment

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

It seems like this is missing a negation I think? Presumably it's possible to write some text that renders the same with CommonMark and Hoedown.

Copy link
Member

Choose a reason for hiding this comment

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

. . . . is this sentence supposed to say "There's no scenario we know of where tweaking your markdown doesn't get identical results on both parsers...?" If not, I'm confused about why we're stating this in this way? Does "tweaking your markdown" mean I change the markdown text I've written, or does it mean "tweaking your markdown parser"?

parsers.

Finally, compiling `rustc` itself is now [15%-20% faster](https://github.com/rust-lang/rust/pull/41469). Each commit message in this PR
goes over the details, but the short of it is that there were some inefficient
Copy link
Member

Choose a reason for hiding this comment

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

The "but the short of it" doesn't add anything and should be dropped.

things, and now they've been cleaned up.

See the [detailed release notes][notes] for more.

#### Library stabilizations

Seven new APIs were stabilized this release:

- [`Child::try_wait`] is a non-blocking form of `Child::wait`.
- [`HashMap::retain`] and [`HashSet::retain`] bring the `retain` API `Vec<T>` has to these two hash data structures.
- [`PeekMut::pop`] lets you pop stuff off of a `BinaryHeap<T>`
Copy link
Member

Choose a reason for hiding this comment

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

You could pop stuff off of BinaryHeap already - this lets you pop the top element off of the heap after you've already looked at/messed with it without needing to reorder the heap twice.

- [`TcpStream::peek`], [`UdpSocket::peek`], [`UdpSocket::peek_from`] let you peek at a stream or socket.

[`Child::try_wait`]: https://doc.rust-lang.org/std/process/struct.Child.html#method.try_wait
[`HashMap::retain`]: https://doc.rust-lang.org/std/collections/struct.HashMap.html#method.retain
[`HashSet::retain`]: https://doc.rust-lang.org/std/collections/struct.HashSet.html#method.retain
[`PeekMut::pop`]: https://doc.rust-lang.org/std/collections/binary_heap/struct.PeekMut.html#method.pop
[`TcpStream::peek`]: https://doc.rust-lang.org/std/net/struct.TcpStream.html#method.peek
[`UdpSocket::peek_from`]: https://doc.rust-lang.org/std/net/struct.UdpSocket.html#method.peek_from
[`UdpSocket::peek`]: https://doc.rust-lang.org/std/net/struct.UdpSocket.html#method.peek

See the [detailed release notes][notes] for more.

#### Cargo features

Cargo has [added support](https://github.com/rust-lang/cargo/pull/3842) for the Pijul VCS,
which is written in Rust. `cargo new my-awesome-project --vcs=pijul` will get you going!
Copy link
Member

Choose a reason for hiding this comment

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

ooooooh coool!!!!!


To suppliment the `--all` flag, Cargo now has [several new
Copy link
Member

Choose a reason for hiding this comment

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

s/suppliment/supplement/ ❤️

flags](https://github.com/rust-lang/cargo/pull/3901) such as `--bins`,
`--examples`, `--tests`, and `--benches`, which will let you build all programs of
that type.

Finally, Cargo now supports [Haiku](https://github.com/rust-lang/cargo/pull/3952) and
[Android](https://github.com/rust-lang/cargo/pull/3885)!

See the [detailed release notes][notes] for more.

### Contributors to 1.18.0

Many people came together to create Rust 1.18. We couldn't have done it without
all of you. [Thanks!](https://thanks.rust-lang.org/rust/1.18.0)