Go to file
bors c3ae182d5c auto merge of #11754 : alexcrichton/rust/unused-result, r=brson
The general consensus is that we want to move away from conditions for I/O, and I propose a two-step plan for doing so:

1. Warn about unused `Result` types. When all of I/O returns `Result`, it will require you inspect the return value for an error *only if* you have a result you want to look at. By default, for things like `write` returning `Result<(), Error>`, these will all go silently ignored. This lint will prevent blind ignorance of these return values, letting you know that there's something you should do about them.

2. Implement a `try!` macro:

```
macro_rules! try( ($e:expr) => (match $e { Ok(e) => e, Err(e) => return Err(e) }) )
```

With these two tools combined, I feel that we get almost all the benefits of conditions. The first step (the lint) is a sanity check that you're not ignoring return values at callsites. The second step is to provide a convenience method of returning early out of a sequence of computations. After thinking about this for awhile, I don't think that we need the so-called "do-notation" in the compiler itself because I think it's just *too* specialized. Additionally, the `try!` macro is super lightweight, easy to understand, and works almost everywhere. As soon as you want to do something more fancy, my answer is "use match".

Basically, with these two tools in action, I would be comfortable removing conditions. What do others think about this strategy?

----

This PR specifically implements the `unused_result` lint. I actually added two lints, `unused_result` and `unused_must_use`, and the first commit has the rationale for why `unused_result` is turned off by default.
2014-01-29 09:46:34 -08:00
doc auto merge of #11868 : bytbox/rust/remove-do, r=alexcrichton 2014-01-29 08:21:38 -08:00
man remove old rc extension from detection files 2014-01-22 20:39:32 -05:00
mk auto merge of #11867 : dmanescu/rust/8784-arena-glob, r=huonw 2014-01-29 06:26:38 -08:00
src auto merge of #11754 : alexcrichton/rust/unused-result, r=brson 2014-01-29 09:46:34 -08:00
.gitattributes drop the linenoise library 2013-10-16 22:57:51 -04:00
.gitignore extra: move glob to libglob 2014-01-29 17:23:28 +11:00
.gitmodules Update submodules to point to rust-lang repos 2014-01-09 20:21:22 -08:00
.mailmap
AUTHORS.txt Update extract-tests.py to use same test directives as rustdoc. 2014-01-28 14:52:36 -06:00
configure Allow opting-out of rpath usage 2014-01-24 09:24:45 -08:00
CONTRIBUTING.md Various READMEs and docs cleanup 2014-01-11 19:41:31 +01:00
COPYRIGHT Update some copyright dates 2014-01-08 18:04:43 -08:00
LICENSE-APACHE
LICENSE-MIT Update some copyright dates 2014-01-08 18:04:43 -08:00
Makefile.in Fix a typo in disable rpaths 2014-01-28 11:49:25 -08:00
README.md Various READMEs and docs cleanup 2014-01-11 19:41:31 +01:00
RELEASES.txt More 0.9 release notes 2014-01-06 14:52:16 -08:00

The Rust Programming Language

This is a compiler for Rust, including standard libraries, tools and documentation.

Quick Start

Windows

  1. Download and use the installer and MinGW.
  2. Read the tutorial.
  3. Enjoy!

Note: Windows users can read the detailed getting started notes on the wiki.

Linux / OS X

  1. Make sure you have installed the dependencies:

    • g++ 4.4 or clang++ 3.x
    • python 2.6 or later (but not 3.x)
    • perl 5.0 or later
    • GNU make 3.81 or later
    • curl
  2. Download and build Rust:

    You can either download a tarball or build directly from the repo.

    To build from the tarball do:

     $ curl -O http://static.rust-lang.org/dist/rust-0.9.tar.gz
     $ tar -xzf rust-0.9.tar.gz
     $ cd rust-0.9
    

    Or to build from the repo do:

     $ git clone https://github.com/mozilla/rust.git
     $ cd rust
    

    Now that you have Rust's source code, you can configure and build it:

     $ ./configure
     $ make && make install
    

    Note: You may need to use sudo make install if you do not normally have permission to modify the destination directory. The install locations can be adjusted by passing a --prefix argument to configure. Various other options are also supported, pass --help for more information on them.

    When complete, make install will place several programs into /usr/local/bin: rustc, the Rust compiler; rustdoc, the API-documentation tool, and rustpkg, the Rust package manager and build system.

  3. Read the tutorial.

  4. Enjoy!

Notes

Since the Rust compiler is written in Rust, it must be built by a precompiled "snapshot" version of itself (made in an earlier state of development). As such, source builds require a connection to the Internet, to fetch snapshots, and an OS that can execute the available snapshot binaries.

Snapshot binaries are currently built and tested on several platforms:

  • Windows (7, Server 2008 R2), x86 only
  • Linux (various distributions), x86 and x86-64
  • OSX 10.6 ("Snow Leopard") or greater, x86 and x86-64

You may find that other platforms work, but these are our officially supported build environments that are most likely to work.

Rust currently needs about 1.5 GiB of RAM to build without swapping; if it hits swap, it will take a very long time to build.

There is a lot more documentation in the wiki.

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.