Go to file

bors 4d6019d07a Auto merge of #39457 - bvinc:master, r=alexcrichton Dont segfault if btree range is not in order This is a first attempt to fix issue #33197. The issue is that the BTree iterator uses next_unchecked for fast iteration, but it can be tricked into running off the end of the tree and segfaulting if range is called with a maximum that is less than the minimum. Since a user defined Ord should not determine the safety of BTreeMap, and we still want fast iteration, I've implemented the idea of @gereeter and walk the tree simultaneously searching for both keys to make sure that if our keys diverge, the min key is to the left of our max key. I currently panic if that is not the case. Open questions: 1. Do we want to panic in this error case or do we want to return an empty iterator? The drain API panics if the range is bad, but drain is given a range of index values, while this is a generic key type. Panicking is brittle and returning an empty iterator is probably the most flexible and matches what people would want it to do... but artificially returning a BTreeMap::Range with start==end seems like a pretty weird and unnatural thing to do, although it's doable since those fields are not accessible. The same question for other weird cases: 2. (Included(101), Excluded(100)) on a map that contains [1,2,3]. Both BTree edges end up on the same part of the map, but comparing the keys shows the range is backwards. 3. (Excluded(5), Excluded(5)). The keys are equal but BTree edges end up backwards if the map contains 5. 4. (Included(5), Excluded(5)). Should naturally produce an empty iterator, right?		2017-02-15 22:02:36 +00:00
man	Update man pages	2016-08-31 15:54:34 +02:00
src	Auto merge of #39457 - bvinc:master, r=alexcrichton	2017-02-15 22:02:36 +00:00
.gitattributes	fix gitattributes for vendor	2017-02-13 13:41:13 -05:00
.gitignore	include everything in the vendor directory	2017-02-13 13:41:17 -05:00
.gitmodules	Set correct hoedown submodule branch	2017-02-03 11:08:20 +01:00
.mailmap	Fix mailmap for @gifnksm	2017-02-09 02:10:14 +01:00
.travis.yml	Rollup merge of #39754 - alexcrichton:less-assertions, r=brson	2017-02-14 10:07:31 -05:00
COMPILER_TESTS.md	Add docs	2017-01-12 23:53:02 +01:00
CONTRIBUTING.md	std: Remove cfg(cargobuild) annotations	2017-02-06 08:42:54 -08:00
COPYRIGHT	Mention initial copyright year	2016-01-28 09:44:04 +05:30
LICENSE-APACHE	Update license, add license boilerplate to most files. Remainder will follow.	2012-12-03 17:12:14 -08:00
LICENSE-MIT	Mention initial copyright year	2016-01-28 09:44:04 +05:30
README.md	Clarify phrasing of MSYS2 dependencies in README.md.	2016-12-21 14:21:49 -08:00
RELEASES.md	Update 1.15.1 relnotes	2017-02-10 00:30:02 +00:00
appveyor.yml	Rollup merge of #39754 - alexcrichton:less-assertions, r=brson	2017-02-14 10:07:31 -05:00
configure	Auto merge of #39728 - eddyb:vendeur-tres-bien, r=alexcrichton	2017-02-14 07:06:25 +00:00
x.py	Handle Ctrl+C in the build script	2016-12-11 15:25:31 +00:00

README.md

The Rust Programming Language

This is the main source code repository for Rust. It contains the compiler, standard library, and documentation.

Quick Start

Read "Installing Rust" from The Book.

Building from Source

Make sure you have installed the dependencies:
- g++ 4.7 or later or clang++ 3.x
- python 2.7 (but not 3.x)
- GNU make 3.81 or later
- cmake 3.4.3 or later
- curl
- git

Clone the source with git:

$ git clone https://github.com/rust-lang/rust.git
$ cd rust

Build and install:
```
$ ./configure
$ make && sudo make install
```
Note: 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, sudo make install will place several programs into /usr/local/bin: rustc, the Rust compiler, and rustdoc, the API-documentation tool. This install does not include Cargo, Rust's package manager, which you may also want to build.

Building on Windows

There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust you need depends largely on what C/C++ libraries you want to interoperate with: for interop with software produced by Visual Studio use the MSVC build of Rust; for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU build.

MinGW

MSYS2 can be used to easily build Rust on Windows:

Grab the latest MSYS2 installer and go through the installer.
Run mingw32_shell.bat or mingw64_shell.bat from wherever you installed MSYS2 (i.e. C:\msys64), depending on whether you want 32-bit or 64-bit Rust. (As of the latest version of MSYS2 you have to run msys2_shell.cmd -mingw32 or msys2_shell.cmd -mingw64 from the command line instead)

From this terminal, install the required tools:

# Update package mirrors (may be needed if you have a fresh install of MSYS2)
$ pacman -Sy pacman-mirrors

# Install build tools needed for Rust. If you're building a 32-bit compiler,
# then replace "x86_64" below with "i686". If you've already got git, python,
# or CMake installed and in PATH you can remove them from this list. Note
# that it is important that you do **not** use the 'python2' and 'cmake'
# packages from the 'msys2' subsystem. The build has historically been known
# to fail with these packages.
$ pacman -S git \
            make \
            diffutils \
            tar \
            mingw-w64-x86_64-python2 \
            mingw-w64-x86_64-cmake \
            mingw-w64-x86_64-gcc

Navigate to Rust's source code (or clone it), then configure and build it:
```
$ ./configure
$ make && make install
```

MSVC

MSVC builds of Rust additionally require an installation of Visual Studio 2013 (or later) so rustc can use its linker. Make sure to check the “C++ tools” option.

With these dependencies installed, you can build the compiler in a cmd.exe shell with:

> python x.py build

If you're running inside of an msys shell, however, you can run:

$ ./configure --build=x86_64-pc-windows-msvc
$ make && make install

Currently building Rust only works with some known versions of Visual Studio. If you have a more recent version installed the build system doesn't understand then you may need to force rustbuild to use an older version. This can be done by manually calling the appropriate vcvars file before running the bootstrap.

CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat"
python x.py build

Building Documentation

If you’d like to build the documentation, it’s almost the same:

$ ./configure
$ make docs

The generated documentation will appear in a top-level doc directory, created by the make rule.

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:

Platform / Architecture	x86	x86_64
Windows (7, 8, Server 2008 R2)	✓	✓
Linux (2.6.18 or later)	✓	✓
OSX (10.7 Lion or later)	✓	✓

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

Rust currently needs between 600MiB and 1.5GiB to build, depending on platform. If it hits swap, it will take a very long time to build.

There is more advice about hacking on Rust in CONTRIBUTING.md.

Getting Help

The Rust community congregates in a few places:

Stack Overflow - Direct questions about using the language.
users.rust-lang.org - General discussion and broader questions.
/r/rust - News and general discussion.

Contributing

To contribute to Rust, please see CONTRIBUTING.

Rust has an IRC culture and most real-time collaboration happens in a variety of channels on Mozilla's IRC network, irc.mozilla.org. The most popular channel is #rust, a venue for general discussion about Rust. And a good place to ask for help would be #rust-beginners.

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.

README.md Unescape Escape