Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/concepts/components.html b/concepts/components.html
new file mode 100644
index 0000000000..f7a6aa6580
--- /dev/null
+++ b/concepts/components.html
@@ -0,0 +1,296 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Channels
+Rust is released to three different “channels”: stable, beta, and nightly. The
+stable releases are made every 6 weeks (with occasional point releases). Beta
+releases are the version that will appear in the next stable release. Nightly
+releases are made every night. See The Rust Book for more details
+on Rust’s train release model. The release schedule is posted to the Rust
+Forge. rustup assists with installing different channels, keeping them
+up-to-date, and easily switching between them.
After a release channel has been installed, rustup can be used to update the
+installed version to the latest release on that channel. See the Keeping rust
+up to date section for more information.
rustup can also install specific versions of Rust, such as 1.45.2 or
+nightly-2020-07-27. See the Toolchains chapter for more information on
+installing different channels and releases. See the Overrides chapter for
+details on switching between toolchains and pinning your project to a specific
+toolchain.
Working with nightly Rust
+rustup gives you easy access to the nightly compiler and its experimental
+features. To add it just run rustup toolchain install nightly:
$ rustup toolchain install nightly
+info: syncing channel updates for 'nightly'
+info: downloading toolchain manifest
+info: downloading component 'rustc'
+info: downloading component 'rust-std'
+info: downloading component 'rust-docs'
+info: downloading component 'cargo'
+info: installing component 'rustc'
+info: installing component 'rust-std'
+info: installing component 'rust-docs'
+info: installing component 'cargo'
+
+ nightly installed: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now Rust nightly is installed, but not activated. To test it out you can run a +command from the nightly toolchain like
+$ rustup run nightly rustc --version
+rustc 1.9.0-nightly (02310fd31 2016-03-19)
+But more likely you want to use it for a while. To switch to nightly globally,
+change the default with rustup default nightly:
$ rustup default nightly
+info: using existing install for 'nightly'
+info: default toolchain set to 'nightly'
+
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now any time you run cargo or rustc you will be running the nightly
+compiler.
With nightly installed any time you run rustup update, the nightly channel
+will be updated in addition to stable:
$ rustup update
+info: syncing channel updates for 'stable'
+info: syncing channel updates for 'nightly'
+info: checking for self-update
+info: downloading self-update
+
+ stable unchanged: rustc 1.7.0 (a5d1e7a59 2016-02-29)
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Nightly availability
+Nightly toolchains may fail to build, so for any given date and target
+platform there may not be a toolchain available. Furthermore, nightly builds
+may be published with missing non-default components (such as clippy).
+As such, it can be difficult to find fully-working nightlies. Use the
+rustup-components-history project to find the build status of recent
+nightly toolchains and components.
When you attempt to install or update the nightly channel, rustup will
+check if a required or previously installed component is missing. If it is
+missing, rustup will automatically search for an older release that contains
+the required components. There are several ways to change this behavior:
-
+
- Use the
--forceflag torustup toolchain installto force it to install +the most recent version even if there is a missing component.
+ - Use the
--profileflag torustup toolchain installto use a different +profile that does not contain the missing component. For example, +--profile=minimalshould always work, as the minimal set is required to +exist. See the Profiles chapter for more detail.
+ - Install a specific date that contains the components you need. For example,
+
rustup toolchain install nightly-2020-07-27. You can then use overrides +to pin to that specific release.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/concepts/index.html b/concepts/index.html
new file mode 100644
index 0000000000..896c63c832
--- /dev/null
+++ b/concepts/index.html
@@ -0,0 +1,281 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Components
+Each toolchain has several “components”, some of which are required (like
+rustc) and some that are optional (like clippy). The rustup component command is used to manage the installed components. For example,
+run rustup component list to see a list of available and installed
+components.
Components can be added when installing a toolchain with the --component
+flag. For example:
rustup toolchain install nightly --component rust-docs
+Components can be added to an already-installed toolchain with the rustup component command:
rustup component add rust-docs
+To make it easier to choose which components are installed, rustup has the
+concept of “profiles” which provide named groupings of different components.
+See the Profiles chapter for more detail.
Most components have a target-triple suffix, such as
+rustc-x86_64-apple-darwin, to signify the platform the component is for.
The set of available components may vary with different releases and +toolchains. The following is an overview of the different components:
+-
+
rustc— The Rust compiler and Rustdoc.
+cargo— Cargo is a package manager and build tool.
+rustfmt— Rustfmt is a tool for automatically formatting code.
+rust-std— This is the Rust standard library. There is a separate +rust-stdcomponent for each target thatrustcsupports, such as +rust-std-x86_64-pc-windows-msvc. See the Cross-compilation chapter for +more detail.
+rust-docs— This is a local copy of the Rust documentation. Use the +rustup doccommand to open the documentation in a web browser. Runrustup doc --helpfor more options.
+rust-analyzer— rust-analyzer is a language server that provides support +for editors and IDEs.
+clippy— Clippy is a lint tool that provides extra checks for common +mistakes and stylistic choices.
+miri— Miri is an experimental Rust interpreter, which can be used for +checking for undefined-behavior.
+rust-src— This is a local copy of the source code of the Rust standard +library. This can be used by some tools, such as rust-analyzer, to provide +auto-completion for functions within the standard library; Miri which is a +Rust interpreter; and Cargo’s experimental build-std feature, which allows +you to rebuild the standard library locally.
+rust-mingw— This contains a linker and platform libraries for building on +thex86_64-pc-windows-gnuplatform.
+llvm-tools— This component contains a collection of LLVM tools. +Note that this component has not been stabilized and may change in the +future and is provided as-is. +See #85658.
+rustc-dev— This component contains the compiler as a library. Most users +will not need this; it is only needed for development of tools that link +to the compiler, such as making modifications to Clippy.
+
Previous components
+These components have been deprecated and are not published in new Rust releases.
+-
+
rls— RLS is a language server that is deprecated and has been replaced +by rust-analyzer.
+rust-analysis— Metadata about the standard library, used by RLS.
+
Component availability
+Not all components are available for all toolchains. Especially on the nightly +channel, some components may not be included if they are in a broken state. +The current status of all the components may be found on the rustup +components history page. See the Nightly availability section for more +details.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/concepts/profiles.html b/concepts/profiles.html
new file mode 100644
index 0000000000..0d9320ddce
--- /dev/null
+++ b/concepts/profiles.html
@@ -0,0 +1,266 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Concepts
+How rustup works
+rustup is a toolchain multiplexer. It installs and manages many Rust
+toolchains and presents them all through a single set of tools installed to
+~/.cargo/bin. The rustc and cargo executables installed in
+~/.cargo/bin are proxies that delegate to the real toolchain. rustup
+then provides mechanisms to easily change the active toolchain by
+reconfiguring the behavior of the proxies.
So when rustup is first installed, running rustc will run the proxy in
+$HOME/.cargo/bin/rustc, which in turn will run the stable compiler. If you
+later change the default toolchain to nightly with rustup default nightly,
+then that same proxy will run the nightly compiler instead.
This is similar to Ruby’s rbenv, Python’s pyenv, or Node’s nvm.
+Terminology
+-
+
-
+
channel — Rust is released to three different “channels”: stable, beta, +and nightly. See the Channels chapter for more details.
+
+ -
+
toolchain — A “toolchain” is a complete installation of the Rust +compiler (
+rustc) and related tools (likecargo). A toolchain +specification includes the release channel or version, and the host +platform that the toolchain runs on.
+ -
+
target —
+rustcis capable of generating code for many platforms. The +“target” specifies the platform that the code will be generated for. By +default,cargoandrustcuse the host toolchain’s platform as the +target. To build for a different target, usually the target’s standard +library needs to be installed first via therustup targetcommand. See the +Cross-compilation chapter for more details.
+ -
+
component — Each release of Rust includes several “components”, some of +which are required (like
+rustc) and some that are optional (like +clippy). See the Components chapter for more detail.
+ -
+
profile — In order to make it easier to work with components, a +“profile” defines a grouping of components. See the Profiles chapter for +more details.
+
+ -
+
proxy — A wrapper for a common Rust component (like
+rustc), built to forward +CLI invocations to the active Rust toolchain. See the Proxies chapter for more details.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/concepts/proxies.html b/concepts/proxies.html
new file mode 100644
index 0000000000..2248ca5b63
--- /dev/null
+++ b/concepts/proxies.html
@@ -0,0 +1,264 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Profiles
+rustup has the concept of “profiles”. They are groups of components you
+can choose to download while installing a new Rust toolchain. The profiles
+available at this time are minimal, default, and complete:
-
+
- The minimal profile includes as few components as possible to get a
+working compiler (
rustc,rust-std, andcargo). It’s recommended to use +this component on Windows systems if you don’t use local documentation (the +large number of files can cause issues with some Antivirus systems), and in +CI.
+ - The default profile includes all of components in the minimal
+profile, and adds
rust-docs,rustfmt, andclippy. This profile will be +used byrustupby default, and it’s the one recommended for general use.
+ - The complete profile includes all the components available through
+
rustup. This should never be used, as it includes every component ever +included in the metadata and thus will almost always fail. If you are +looking for a way to install devtools such asmirior IDE integration +tools (rust-analyzer), you should use thedefaultprofile and +install the needed additional components manually, either by usingrustup component addor by using-cwhen installing the toolchain.
+
To change the profile rustup install uses by default, you can use the
+rustup set profile command.
+For example, to select the minimal profile you can use:
rustup set profile minimal
+You can also directly select the profile used when installing a toolchain with:
+rustup install --profile <name>
+It’s also possible to choose the default profile when installing rustup for
+the first time, either interactively by choosing the “Customize installation”
+option or programmatically by passing the --profile=<name> flag. Profiles
+will only affect newly installed toolchains: as usual it will be possible to
+install individual components later with: rustup component add.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/concepts/toolchains.html b/concepts/toolchains.html
new file mode 100644
index 0000000000..133565080b
--- /dev/null
+++ b/concepts/toolchains.html
@@ -0,0 +1,279 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Proxies
+rustup provides a number of wrappers for common Rust tools.
+These are called proxies and represent commands which are
+provided by the various components.
The list of proxies is currently static in rustup and is as follows:
-
+
-
+
+rustcis the compiler for the Rust programming language, provided by the project itself and comes from therustccomponent.
+ -
+
+rustdocis a tool distributed in therustccomponent which helps you to generate documentation for Rust projects.
+ -
+
+cargois the Rust package manager which downloads your Rust package’s dependencies, compiles your packages, makes distributable packages, and uploads them to crates.io (the Rust community’s package registry). It comes from thecargocomponent.
+ -
+
+rust-lldb,rust-gdb, andrust-gdbguiare simple wrappers around thelldb,gdb, andgdbguidebuggers respectively. The wrappers enable some pretty-printing of Rust values and add some convenience features to the debuggers by means of their scripting interfaces.
+ -
+
+rust-analyzeris part of the Rust IDE integration tooling. It implements the language-server protocol to permit IDEs and editors such as Visual Studio Code, Vim, or Emacs, access to the semantics of the Rust code you are editing. It comes from therust-analyzercomponent.
+ -
+
+cargo-clippyandclippy-driverare related to theclippylinting tool which provides extra checks for common mistakes and stylistic choices and it comes from theclippycomponent.
+ -
+
+cargo-miriis an experimental interpreter for Rust’s mid-level intermediate representation (MIR) and it comes from themiricomponent.
+ -
+
+rlsis a deprecated IDE tool that has been replaced byrust-analyzer. It comes from therlscomponent.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/configuration.html b/configuration.html
new file mode 100644
index 0000000000..c5687c5ee4
--- /dev/null
+++ b/configuration.html
@@ -0,0 +1,241 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Toolchains
+Many rustup commands deal with toolchains, a single installation of the
+Rust compiler. rustup supports multiple types of toolchains. The most basic
+track the official release channels: stable, beta and nightly; but
+rustup can also install toolchains from the official archives, for alternate
+host platforms, and from local builds.
Toolchain specification
+Standard release channel toolchain names have the following form:
+<channel>[-<date>][-<host>]
+
+<channel> = stable|beta|nightly|<major.minor>|<major.minor.patch>
+<date> = YYYY-MM-DD
+<host> = <target-triple>
+‘channel’ is a named release channel, a major and minor version number such as
+1.42, or a fully specified version number, such as 1.42.0. Channel names
+can be optionally appended with an archive date, as in nightly-2014-12-18, in
+which case the toolchain is downloaded from the archive for that date.
Finally, the host may be specified as a target triple. This is most useful for +installing a 32-bit compiler on a 64-bit platform, or for installing the +MSVC-based toolchain on Windows. For example:
+$ rustup toolchain install stable-x86_64-pc-windows-msvc
+For convenience, elements of the target triple that are omitted will be +inferred, so the above could be written:
+$ rustup toolchain install stable-msvc
+Toolchain names that don’t name a channel instead can be used to name custom +toolchains.
+Custom toolchains
+For convenience of developers working on Rust itself, rustup can manage
+local builds of the Rust toolchain. To teach rustup about your build, run:
$ rustup toolchain link my-toolchain path/to/my/toolchain/sysroot
+For example, on Ubuntu you might clone rust-lang/rust into ~/rust, build
+it, and then run:
$ rustup toolchain link my-toolchain ~/rust/build/x86_64-unknown-linux-gnu/stage2/
+$ rustup default my-toolchain
+Now you can name my-toolchain as any other rustup toolchain. Create a
+rustup toolchain for each of your rust-lang/rust workspaces and test them
+easily with rustup run my-toolchain rustc.
Because the rust-lang/rust tree does not include Cargo, when cargo is
+invoked for a custom toolchain and it is not available, rustup will attempt
+to use cargo from one of the release channels, preferring ‘nightly’, then
+‘beta’ or ‘stable’.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/cross-compilation.html b/cross-compilation.html
new file mode 100644
index 0000000000..3d64bb55bb
--- /dev/null
+++ b/cross-compilation.html
@@ -0,0 +1,260 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Configuration
+Rustup has a TOML settings file at
+${RUSTUP_HOME}/settings.toml (which defaults to ~/.rustup or
+%USERPROFILE%/.rustup). The schema for this file is not part of the public
+interface for rustup - the rustup CLI should be used to query and set settings.
On Unix operating systems a fallback settings file is consulted for some
+settings. This fallback file is located at /etc/rustup/settings.toml and
+currently can define only default_toolchain.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/css/chrome.css b/css/chrome.css
new file mode 100644
index 0000000000..8b78255de5
--- /dev/null
+++ b/css/chrome.css
@@ -0,0 +1,606 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+@import 'variables.css';
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/css/general.css b/css/general.css
new file mode 100644
index 0000000000..e7d20da725
--- /dev/null
+++ b/css/general.css
@@ -0,0 +1,234 @@
+/* Base styles and content styles */
+
+@import 'variables.css';
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/css/print.css b/css/print.css
new file mode 100644
index 0000000000..80ec3a5441
--- /dev/null
+++ b/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/css/variables.css b/css/variables.css
new file mode 100644
index 0000000000..0da55e8c9a
--- /dev/null
+++ b/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/dev-guide/.nojekyll b/dev-guide/.nojekyll
new file mode 100644
index 0000000000..f17311098f
--- /dev/null
+++ b/dev-guide/.nojekyll
@@ -0,0 +1 @@
+This file makes sure that Github Pages doesn't process mdBook's output.
diff --git a/dev-guide/404.html b/dev-guide/404.html
new file mode 100644
index 0000000000..19362b0f80
--- /dev/null
+++ b/dev-guide/404.html
@@ -0,0 +1,221 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Cross-compilation
+Rust supports a great number of platforms. For many of these platforms
+The Rust Project publishes binary releases of the standard library, and for
+some the full compiler. rustup gives easy access to all of them.
When you first install a toolchain, rustup installs only the standard
+library for your host platform - that is, the architecture and operating
+system you are presently running. To compile to other platforms you must
+install other target platforms. This is done with the rustup target add
+command. For example, to add the Android target:
$ rustup target add arm-linux-androideabi
+info: downloading component 'rust-std' for 'arm-linux-androideabi'
+info: installing component 'rust-std' for 'arm-linux-androideabi'
+With the arm-linux-androideabi target installed you can then build for
+Android with Cargo by passing the --target flag, as in cargo build --target=arm-linux-androideabi.
Note that rustup target add only installs the Rust standard library for a
+given target. There are typically other tools necessary to cross-compile,
+particularly a linker. For example, to cross compile to Android the Android
+NDK must be installed. In the future, rustup will provide assistance
+installing the NDK components as well. See the target section of the
+cargo configuration for how to setup a linker to use for a certain target.
To install a target for a toolchain that isn’t the default toolchain use the
+--toolchain argument of rustup target add, like so:
$ rustup target add --toolchain <toolchain> <target>...
+To see a list of available targets, rustup target list. To remove a
+previously-added target, rustup target remove.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/FontAwesome/css/font-awesome.css b/dev-guide/FontAwesome/css/font-awesome.css
new file mode 100644
index 0000000000..540440ce89
--- /dev/null
+++ b/dev-guide/FontAwesome/css/font-awesome.css
@@ -0,0 +1,4 @@
+/*!
+ * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
+ * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
+ */@font-face{font-family:'FontAwesome';src:url('../fonts/fontawesome-webfont.eot?v=4.7.0');src:url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'),url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'),url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'),url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'),url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');font-weight:normal;font-style:normal}.fa{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571429em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14285714em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14285714em;width:2.14285714em;top:.14285714em;text-align:center}.fa-li.fa-lg{left:-1.85714286em}.fa-border{padding:.2em .25em .15em;border:solid .08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left{margin-right:.3em}.fa.fa-pull-right{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left{margin-right:.3em}.fa.pull-right{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:"\f000"}.fa-music:before{content:"\f001"}.fa-search:before{content:"\f002"}.fa-envelope-o:before{content:"\f003"}.fa-heart:before{content:"\f004"}.fa-star:before{content:"\f005"}.fa-star-o:before{content:"\f006"}.fa-user:before{content:"\f007"}.fa-film:before{content:"\f008"}.fa-th-large:before{content:"\f009"}.fa-th:before{content:"\f00a"}.fa-th-list:before{content:"\f00b"}.fa-check:before{content:"\f00c"}.fa-remove:before,.fa-close:before,.fa-times:before{content:"\f00d"}.fa-search-plus:before{content:"\f00e"}.fa-search-minus:before{content:"\f010"}.fa-power-off:before{content:"\f011"}.fa-signal:before{content:"\f012"}.fa-gear:before,.fa-cog:before{content:"\f013"}.fa-trash-o:before{content:"\f014"}.fa-home:before{content:"\f015"}.fa-file-o:before{content:"\f016"}.fa-clock-o:before{content:"\f017"}.fa-road:before{content:"\f018"}.fa-download:before{content:"\f019"}.fa-arrow-circle-o-down:before{content:"\f01a"}.fa-arrow-circle-o-up:before{content:"\f01b"}.fa-inbox:before{content:"\f01c"}.fa-play-circle-o:before{content:"\f01d"}.fa-rotate-right:before,.fa-repeat:before{content:"\f01e"}.fa-refresh:before{content:"\f021"}.fa-list-alt:before{content:"\f022"}.fa-lock:before{content:"\f023"}.fa-flag:before{content:"\f024"}.fa-headphones:before{content:"\f025"}.fa-volume-off:before{content:"\f026"}.fa-volume-down:before{content:"\f027"}.fa-volume-up:before{content:"\f028"}.fa-qrcode:before{content:"\f029"}.fa-barcode:before{content:"\f02a"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-book:before{content:"\f02d"}.fa-bookmark:before{content:"\f02e"}.fa-print:before{content:"\f02f"}.fa-camera:before{content:"\f030"}.fa-font:before{content:"\f031"}.fa-bold:before{content:"\f032"}.fa-italic:before{content:"\f033"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-align-left:before{content:"\f036"}.fa-align-center:before{content:"\f037"}.fa-align-right:before{content:"\f038"}.fa-align-justify:before{content:"\f039"}.fa-list:before{content:"\f03a"}.fa-dedent:before,.fa-outdent:before{content:"\f03b"}.fa-indent:before{content:"\f03c"}.fa-video-camera:before{content:"\f03d"}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:"\f03e"}.fa-pencil:before{content:"\f040"}.fa-map-marker:before{content:"\f041"}.fa-adjust:before{content:"\f042"}.fa-tint:before{content:"\f043"}.fa-edit:before,.fa-pencil-square-o:before{content:"\f044"}.fa-share-square-o:before{content:"\f045"}.fa-check-square-o:before{content:"\f046"}.fa-arrows:before{content:"\f047"}.fa-step-backward:before{content:"\f048"}.fa-fast-backward:before{content:"\f049"}.fa-backward:before{content:"\f04a"}.fa-play:before{content:"\f04b"}.fa-pause:before{content:"\f04c"}.fa-stop:before{content:"\f04d"}.fa-forward:before{content:"\f04e"}.fa-fast-forward:before{content:"\f050"}.fa-step-forward:before{content:"\f051"}.fa-eject:before{content:"\f052"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-plus-circle:before{content:"\f055"}.fa-minus-circle:before{content:"\f056"}.fa-times-circle:before{content:"\f057"}.fa-check-circle:before{content:"\f058"}.fa-question-circle:before{content:"\f059"}.fa-info-circle:before{content:"\f05a"}.fa-crosshairs:before{content:"\f05b"}.fa-times-circle-o:before{content:"\f05c"}.fa-check-circle-o:before{content:"\f05d"}.fa-ban:before{content:"\f05e"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrow-down:before{content:"\f063"}.fa-mail-forward:before,.fa-share:before{content:"\f064"}.fa-expand:before{content:"\f065"}.fa-compress:before{content:"\f066"}.fa-plus:before{content:"\f067"}.fa-minus:before{content:"\f068"}.fa-asterisk:before{content:"\f069"}.fa-exclamation-circle:before{content:"\f06a"}.fa-gift:before{content:"\f06b"}.fa-leaf:before{content:"\f06c"}.fa-fire:before{content:"\f06d"}.fa-eye:before{content:"\f06e"}.fa-eye-slash:before{content:"\f070"}.fa-warning:before,.fa-exclamation-triangle:before{content:"\f071"}.fa-plane:before{content:"\f072"}.fa-calendar:before{content:"\f073"}.fa-random:before{content:"\f074"}.fa-comment:before{content:"\f075"}.fa-magnet:before{content:"\f076"}.fa-chevron-up:before{content:"\f077"}.fa-chevron-down:before{content:"\f078"}.fa-retweet:before{content:"\f079"}.fa-shopping-cart:before{content:"\f07a"}.fa-folder:before{content:"\f07b"}.fa-folder-open:before{content:"\f07c"}.fa-arrows-v:before{content:"\f07d"}.fa-arrows-h:before{content:"\f07e"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:"\f080"}.fa-twitter-square:before{content:"\f081"}.fa-facebook-square:before{content:"\f082"}.fa-camera-retro:before{content:"\f083"}.fa-key:before{content:"\f084"}.fa-gears:before,.fa-cogs:before{content:"\f085"}.fa-comments:before{content:"\f086"}.fa-thumbs-o-up:before{content:"\f087"}.fa-thumbs-o-down:before{content:"\f088"}.fa-star-half:before{content:"\f089"}.fa-heart-o:before{content:"\f08a"}.fa-sign-out:before{content:"\f08b"}.fa-linkedin-square:before{content:"\f08c"}.fa-thumb-tack:before{content:"\f08d"}.fa-external-link:before{content:"\f08e"}.fa-sign-in:before{content:"\f090"}.fa-trophy:before{content:"\f091"}.fa-github-square:before{content:"\f092"}.fa-upload:before{content:"\f093"}.fa-lemon-o:before{content:"\f094"}.fa-phone:before{content:"\f095"}.fa-square-o:before{content:"\f096"}.fa-bookmark-o:before{content:"\f097"}.fa-phone-square:before{content:"\f098"}.fa-twitter:before{content:"\f099"}.fa-facebook-f:before,.fa-facebook:before{content:"\f09a"}.fa-github:before{content:"\f09b"}.fa-unlock:before{content:"\f09c"}.fa-credit-card:before{content:"\f09d"}.fa-feed:before,.fa-rss:before{content:"\f09e"}.fa-hdd-o:before{content:"\f0a0"}.fa-bullhorn:before{content:"\f0a1"}.fa-bell:before{content:"\f0f3"}.fa-certificate:before{content:"\f0a3"}.fa-hand-o-right:before{content:"\f0a4"}.fa-hand-o-left:before{content:"\f0a5"}.fa-hand-o-up:before{content:"\f0a6"}.fa-hand-o-down:before{content:"\f0a7"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-globe:before{content:"\f0ac"}.fa-wrench:before{content:"\f0ad"}.fa-tasks:before{content:"\f0ae"}.fa-filter:before{content:"\f0b0"}.fa-briefcase:before{content:"\f0b1"}.fa-arrows-alt:before{content:"\f0b2"}.fa-group:before,.fa-users:before{content:"\f0c0"}.fa-chain:before,.fa-link:before{content:"\f0c1"}.fa-cloud:before{content:"\f0c2"}.fa-flask:before{content:"\f0c3"}.fa-cut:before,.fa-scissors:before{content:"\f0c4"}.fa-copy:before,.fa-files-o:before{content:"\f0c5"}.fa-paperclip:before{content:"\f0c6"}.fa-save:before,.fa-floppy-o:before{content:"\f0c7"}.fa-square:before{content:"\f0c8"}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:"\f0c9"}.fa-list-ul:before{content:"\f0ca"}.fa-list-ol:before{content:"\f0cb"}.fa-strikethrough:before{content:"\f0cc"}.fa-underline:before{content:"\f0cd"}.fa-table:before{content:"\f0ce"}.fa-magic:before{content:"\f0d0"}.fa-truck:before{content:"\f0d1"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-square:before{content:"\f0d3"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-plus:before{content:"\f0d5"}.fa-money:before{content:"\f0d6"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-up:before{content:"\f0d8"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-columns:before{content:"\f0db"}.fa-unsorted:before,.fa-sort:before{content:"\f0dc"}.fa-sort-down:before,.fa-sort-desc:before{content:"\f0dd"}.fa-sort-up:before,.fa-sort-asc:before{content:"\f0de"}.fa-envelope:before{content:"\f0e0"}.fa-linkedin:before{content:"\f0e1"}.fa-rotate-left:before,.fa-undo:before{content:"\f0e2"}.fa-legal:before,.fa-gavel:before{content:"\f0e3"}.fa-dashboard:before,.fa-tachometer:before{content:"\f0e4"}.fa-comment-o:before{content:"\f0e5"}.fa-comments-o:before{content:"\f0e6"}.fa-flash:before,.fa-bolt:before{content:"\f0e7"}.fa-sitemap:before{content:"\f0e8"}.fa-umbrella:before{content:"\f0e9"}.fa-paste:before,.fa-clipboard:before{content:"\f0ea"}.fa-lightbulb-o:before{content:"\f0eb"}.fa-exchange:before{content:"\f0ec"}.fa-cloud-download:before{content:"\f0ed"}.fa-cloud-upload:before{content:"\f0ee"}.fa-user-md:before{content:"\f0f0"}.fa-stethoscope:before{content:"\f0f1"}.fa-suitcase:before{content:"\f0f2"}.fa-bell-o:before{content:"\f0a2"}.fa-coffee:before{content:"\f0f4"}.fa-cutlery:before{content:"\f0f5"}.fa-file-text-o:before{content:"\f0f6"}.fa-building-o:before{content:"\f0f7"}.fa-hospital-o:before{content:"\f0f8"}.fa-ambulance:before{content:"\f0f9"}.fa-medkit:before{content:"\f0fa"}.fa-fighter-jet:before{content:"\f0fb"}.fa-beer:before{content:"\f0fc"}.fa-h-square:before{content:"\f0fd"}.fa-plus-square:before{content:"\f0fe"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angle-down:before{content:"\f107"}.fa-desktop:before{content:"\f108"}.fa-laptop:before{content:"\f109"}.fa-tablet:before{content:"\f10a"}.fa-mobile-phone:before,.fa-mobile:before{content:"\f10b"}.fa-circle-o:before{content:"\f10c"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-spinner:before{content:"\f110"}.fa-circle:before{content:"\f111"}.fa-mail-reply:before,.fa-reply:before{content:"\f112"}.fa-github-alt:before{content:"\f113"}.fa-folder-o:before{content:"\f114"}.fa-folder-open-o:before{content:"\f115"}.fa-smile-o:before{content:"\f118"}.fa-frown-o:before{content:"\f119"}.fa-meh-o:before{content:"\f11a"}.fa-gamepad:before{content:"\f11b"}.fa-keyboard-o:before{content:"\f11c"}.fa-flag-o:before{content:"\f11d"}.fa-flag-checkered:before{content:"\f11e"}.fa-terminal:before{content:"\f120"}.fa-code:before{content:"\f121"}.fa-mail-reply-all:before,.fa-reply-all:before{content:"\f122"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:"\f123"}.fa-location-arrow:before{content:"\f124"}.fa-crop:before{content:"\f125"}.fa-code-fork:before{content:"\f126"}.fa-unlink:before,.fa-chain-broken:before{content:"\f127"}.fa-question:before{content:"\f128"}.fa-info:before{content:"\f129"}.fa-exclamation:before{content:"\f12a"}.fa-superscript:before{content:"\f12b"}.fa-subscript:before{content:"\f12c"}.fa-eraser:before{content:"\f12d"}.fa-puzzle-piece:before{content:"\f12e"}.fa-microphone:before{content:"\f130"}.fa-microphone-slash:before{content:"\f131"}.fa-shield:before{content:"\f132"}.fa-calendar-o:before{content:"\f133"}.fa-fire-extinguisher:before{content:"\f134"}.fa-rocket:before{content:"\f135"}.fa-maxcdn:before{content:"\f136"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-html5:before{content:"\f13b"}.fa-css3:before{content:"\f13c"}.fa-anchor:before{content:"\f13d"}.fa-unlock-alt:before{content:"\f13e"}.fa-bullseye:before{content:"\f140"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-rss-square:before{content:"\f143"}.fa-play-circle:before{content:"\f144"}.fa-ticket:before{content:"\f145"}.fa-minus-square:before{content:"\f146"}.fa-minus-square-o:before{content:"\f147"}.fa-level-up:before{content:"\f148"}.fa-level-down:before{content:"\f149"}.fa-check-square:before{content:"\f14a"}.fa-pencil-square:before{content:"\f14b"}.fa-external-link-square:before{content:"\f14c"}.fa-share-square:before{content:"\f14d"}.fa-compass:before{content:"\f14e"}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:"\f150"}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:"\f151"}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:"\f152"}.fa-euro:before,.fa-eur:before{content:"\f153"}.fa-gbp:before{content:"\f154"}.fa-dollar:before,.fa-usd:before{content:"\f155"}.fa-rupee:before,.fa-inr:before{content:"\f156"}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:"\f157"}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:"\f158"}.fa-won:before,.fa-krw:before{content:"\f159"}.fa-bitcoin:before,.fa-btc:before{content:"\f15a"}.fa-file:before{content:"\f15b"}.fa-file-text:before{content:"\f15c"}.fa-sort-alpha-asc:before{content:"\f15d"}.fa-sort-alpha-desc:before{content:"\f15e"}.fa-sort-amount-asc:before{content:"\f160"}.fa-sort-amount-desc:before{content:"\f161"}.fa-sort-numeric-asc:before{content:"\f162"}.fa-sort-numeric-desc:before{content:"\f163"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbs-down:before{content:"\f165"}.fa-youtube-square:before{content:"\f166"}.fa-youtube:before{content:"\f167"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-youtube-play:before{content:"\f16a"}.fa-dropbox:before{content:"\f16b"}.fa-stack-overflow:before{content:"\f16c"}.fa-instagram:before{content:"\f16d"}.fa-flickr:before{content:"\f16e"}.fa-adn:before{content:"\f170"}.fa-bitbucket:before{content:"\f171"}.fa-bitbucket-square:before{content:"\f172"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-long-arrow-down:before{content:"\f175"}.fa-long-arrow-up:before{content:"\f176"}.fa-long-arrow-left:before{content:"\f177"}.fa-long-arrow-right:before{content:"\f178"}.fa-apple:before{content:"\f179"}.fa-windows:before{content:"\f17a"}.fa-android:before{content:"\f17b"}.fa-linux:before{content:"\f17c"}.fa-dribbble:before{content:"\f17d"}.fa-skype:before{content:"\f17e"}.fa-foursquare:before{content:"\f180"}.fa-trello:before{content:"\f181"}.fa-female:before{content:"\f182"}.fa-male:before{content:"\f183"}.fa-gittip:before,.fa-gratipay:before{content:"\f184"}.fa-sun-o:before{content:"\f185"}.fa-moon-o:before{content:"\f186"}.fa-archive:before{content:"\f187"}.fa-bug:before{content:"\f188"}.fa-vk:before{content:"\f189"}.fa-weibo:before{content:"\f18a"}.fa-renren:before{content:"\f18b"}.fa-pagelines:before{content:"\f18c"}.fa-stack-exchange:before{content:"\f18d"}.fa-arrow-circle-o-right:before{content:"\f18e"}.fa-arrow-circle-o-left:before{content:"\f190"}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:"\f191"}.fa-dot-circle-o:before{content:"\f192"}.fa-wheelchair:before{content:"\f193"}.fa-vimeo-square:before{content:"\f194"}.fa-turkish-lira:before,.fa-try:before{content:"\f195"}.fa-plus-square-o:before{content:"\f196"}.fa-space-shuttle:before{content:"\f197"}.fa-slack:before{content:"\f198"}.fa-envelope-square:before{content:"\f199"}.fa-wordpress:before{content:"\f19a"}.fa-openid:before{content:"\f19b"}.fa-institution:before,.fa-bank:before,.fa-university:before{content:"\f19c"}.fa-mortar-board:before,.fa-graduation-cap:before{content:"\f19d"}.fa-yahoo:before{content:"\f19e"}.fa-google:before{content:"\f1a0"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-square:before{content:"\f1a2"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-stumbleupon:before{content:"\f1a4"}.fa-delicious:before{content:"\f1a5"}.fa-digg:before{content:"\f1a6"}.fa-pied-piper-pp:before{content:"\f1a7"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-drupal:before{content:"\f1a9"}.fa-joomla:before{content:"\f1aa"}.fa-language:before{content:"\f1ab"}.fa-fax:before{content:"\f1ac"}.fa-building:before{content:"\f1ad"}.fa-child:before{content:"\f1ae"}.fa-paw:before{content:"\f1b0"}.fa-spoon:before{content:"\f1b1"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-recycle:before{content:"\f1b8"}.fa-automobile:before,.fa-car:before{content:"\f1b9"}.fa-cab:before,.fa-taxi:before{content:"\f1ba"}.fa-tree:before{content:"\f1bb"}.fa-spotify:before{content:"\f1bc"}.fa-deviantart:before{content:"\f1bd"}.fa-soundcloud:before{content:"\f1be"}.fa-database:before{content:"\f1c0"}.fa-file-pdf-o:before{content:"\f1c1"}.fa-file-word-o:before{content:"\f1c2"}.fa-file-excel-o:before{content:"\f1c3"}.fa-file-powerpoint-o:before{content:"\f1c4"}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:"\f1c5"}.fa-file-zip-o:before,.fa-file-archive-o:before{content:"\f1c6"}.fa-file-sound-o:before,.fa-file-audio-o:before{content:"\f1c7"}.fa-file-movie-o:before,.fa-file-video-o:before{content:"\f1c8"}.fa-file-code-o:before{content:"\f1c9"}.fa-vine:before{content:"\f1ca"}.fa-codepen:before{content:"\f1cb"}.fa-jsfiddle:before{content:"\f1cc"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:"\f1cd"}.fa-circle-o-notch:before{content:"\f1ce"}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:"\f1d0"}.fa-ge:before,.fa-empire:before{content:"\f1d1"}.fa-git-square:before{content:"\f1d2"}.fa-git:before{content:"\f1d3"}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:"\f1d4"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-qq:before{content:"\f1d6"}.fa-wechat:before,.fa-weixin:before{content:"\f1d7"}.fa-send:before,.fa-paper-plane:before{content:"\f1d8"}.fa-send-o:before,.fa-paper-plane-o:before{content:"\f1d9"}.fa-history:before{content:"\f1da"}.fa-circle-thin:before{content:"\f1db"}.fa-header:before{content:"\f1dc"}.fa-paragraph:before{content:"\f1dd"}.fa-sliders:before{content:"\f1de"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-bomb:before{content:"\f1e2"}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:"\f1e3"}.fa-tty:before{content:"\f1e4"}.fa-binoculars:before{content:"\f1e5"}.fa-plug:before{content:"\f1e6"}.fa-slideshare:before{content:"\f1e7"}.fa-twitch:before{content:"\f1e8"}.fa-yelp:before{content:"\f1e9"}.fa-newspaper-o:before{content:"\f1ea"}.fa-wifi:before{content:"\f1eb"}.fa-calculator:before{content:"\f1ec"}.fa-paypal:before{content:"\f1ed"}.fa-google-wallet:before{content:"\f1ee"}.fa-cc-visa:before{content:"\f1f0"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-bell-slash:before{content:"\f1f6"}.fa-bell-slash-o:before{content:"\f1f7"}.fa-trash:before{content:"\f1f8"}.fa-copyright:before{content:"\f1f9"}.fa-at:before{content:"\f1fa"}.fa-eyedropper:before{content:"\f1fb"}.fa-paint-brush:before{content:"\f1fc"}.fa-birthday-cake:before{content:"\f1fd"}.fa-area-chart:before{content:"\f1fe"}.fa-pie-chart:before{content:"\f200"}.fa-line-chart:before{content:"\f201"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-bicycle:before{content:"\f206"}.fa-bus:before{content:"\f207"}.fa-ioxhost:before{content:"\f208"}.fa-angellist:before{content:"\f209"}.fa-cc:before{content:"\f20a"}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:"\f20b"}.fa-meanpath:before{content:"\f20c"}.fa-buysellads:before{content:"\f20d"}.fa-connectdevelop:before{content:"\f20e"}.fa-dashcube:before{content:"\f210"}.fa-forumbee:before{content:"\f211"}.fa-leanpub:before{content:"\f212"}.fa-sellsy:before{content:"\f213"}.fa-shirtsinbulk:before{content:"\f214"}.fa-simplybuilt:before{content:"\f215"}.fa-skyatlas:before{content:"\f216"}.fa-cart-plus:before{content:"\f217"}.fa-cart-arrow-down:before{content:"\f218"}.fa-diamond:before{content:"\f219"}.fa-ship:before{content:"\f21a"}.fa-user-secret:before{content:"\f21b"}.fa-motorcycle:before{content:"\f21c"}.fa-street-view:before{content:"\f21d"}.fa-heartbeat:before{content:"\f21e"}.fa-venus:before{content:"\f221"}.fa-mars:before{content:"\f222"}.fa-mercury:before{content:"\f223"}.fa-intersex:before,.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-venus-double:before{content:"\f226"}.fa-mars-double:before{content:"\f227"}.fa-venus-mars:before{content:"\f228"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-neuter:before{content:"\f22c"}.fa-genderless:before{content:"\f22d"}.fa-facebook-official:before{content:"\f230"}.fa-pinterest-p:before{content:"\f231"}.fa-whatsapp:before{content:"\f232"}.fa-server:before{content:"\f233"}.fa-user-plus:before{content:"\f234"}.fa-user-times:before{content:"\f235"}.fa-hotel:before,.fa-bed:before{content:"\f236"}.fa-viacoin:before{content:"\f237"}.fa-train:before{content:"\f238"}.fa-subway:before{content:"\f239"}.fa-medium:before{content:"\f23a"}.fa-yc:before,.fa-y-combinator:before{content:"\f23b"}.fa-optin-monster:before{content:"\f23c"}.fa-opencart:before{content:"\f23d"}.fa-expeditedssl:before{content:"\f23e"}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:"\f240"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:"\f241"}.fa-battery-2:before,.fa-battery-half:before{content:"\f242"}.fa-battery-1:before,.fa-battery-quarter:before{content:"\f243"}.fa-battery-0:before,.fa-battery-empty:before{content:"\f244"}.fa-mouse-pointer:before{content:"\f245"}.fa-i-cursor:before{content:"\f246"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-sticky-note:before{content:"\f249"}.fa-sticky-note-o:before{content:"\f24a"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-diners-club:before{content:"\f24c"}.fa-clone:before{content:"\f24d"}.fa-balance-scale:before{content:"\f24e"}.fa-hourglass-o:before{content:"\f250"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:"\f251"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:"\f253"}.fa-hourglass:before{content:"\f254"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:"\f255"}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:"\f256"}.fa-hand-scissors-o:before{content:"\f257"}.fa-hand-lizard-o:before{content:"\f258"}.fa-hand-spock-o:before{content:"\f259"}.fa-hand-pointer-o:before{content:"\f25a"}.fa-hand-peace-o:before{content:"\f25b"}.fa-trademark:before{content:"\f25c"}.fa-registered:before{content:"\f25d"}.fa-creative-commons:before{content:"\f25e"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-tripadvisor:before{content:"\f262"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-get-pocket:before{content:"\f265"}.fa-wikipedia-w:before{content:"\f266"}.fa-safari:before{content:"\f267"}.fa-chrome:before{content:"\f268"}.fa-firefox:before{content:"\f269"}.fa-opera:before{content:"\f26a"}.fa-internet-explorer:before{content:"\f26b"}.fa-tv:before,.fa-television:before{content:"\f26c"}.fa-contao:before{content:"\f26d"}.fa-500px:before{content:"\f26e"}.fa-amazon:before{content:"\f270"}.fa-calendar-plus-o:before{content:"\f271"}.fa-calendar-minus-o:before{content:"\f272"}.fa-calendar-times-o:before{content:"\f273"}.fa-calendar-check-o:before{content:"\f274"}.fa-industry:before{content:"\f275"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-map-o:before{content:"\f278"}.fa-map:before{content:"\f279"}.fa-commenting:before{content:"\f27a"}.fa-commenting-o:before{content:"\f27b"}.fa-houzz:before{content:"\f27c"}.fa-vimeo:before{content:"\f27d"}.fa-black-tie:before{content:"\f27e"}.fa-fonticons:before{content:"\f280"}.fa-reddit-alien:before{content:"\f281"}.fa-edge:before{content:"\f282"}.fa-credit-card-alt:before{content:"\f283"}.fa-codiepie:before{content:"\f284"}.fa-modx:before{content:"\f285"}.fa-fort-awesome:before{content:"\f286"}.fa-usb:before{content:"\f287"}.fa-product-hunt:before{content:"\f288"}.fa-mixcloud:before{content:"\f289"}.fa-scribd:before{content:"\f28a"}.fa-pause-circle:before{content:"\f28b"}.fa-pause-circle-o:before{content:"\f28c"}.fa-stop-circle:before{content:"\f28d"}.fa-stop-circle-o:before{content:"\f28e"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-hashtag:before{content:"\f292"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-percent:before{content:"\f295"}.fa-gitlab:before{content:"\f296"}.fa-wpbeginner:before{content:"\f297"}.fa-wpforms:before{content:"\f298"}.fa-envira:before{content:"\f299"}.fa-universal-access:before{content:"\f29a"}.fa-wheelchair-alt:before{content:"\f29b"}.fa-question-circle-o:before{content:"\f29c"}.fa-blind:before{content:"\f29d"}.fa-audio-description:before{content:"\f29e"}.fa-volume-control-phone:before{content:"\f2a0"}.fa-braille:before{content:"\f2a1"}.fa-assistive-listening-systems:before{content:"\f2a2"}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:"\f2a3"}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:"\f2a4"}.fa-glide:before{content:"\f2a5"}.fa-glide-g:before{content:"\f2a6"}.fa-signing:before,.fa-sign-language:before{content:"\f2a7"}.fa-low-vision:before{content:"\f2a8"}.fa-viadeo:before{content:"\f2a9"}.fa-viadeo-square:before{content:"\f2aa"}.fa-snapchat:before{content:"\f2ab"}.fa-snapchat-ghost:before{content:"\f2ac"}.fa-snapchat-square:before{content:"\f2ad"}.fa-pied-piper:before{content:"\f2ae"}.fa-first-order:before{content:"\f2b0"}.fa-yoast:before{content:"\f2b1"}.fa-themeisle:before{content:"\f2b2"}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:"\f2b3"}.fa-fa:before,.fa-font-awesome:before{content:"\f2b4"}.fa-handshake-o:before{content:"\f2b5"}.fa-envelope-open:before{content:"\f2b6"}.fa-envelope-open-o:before{content:"\f2b7"}.fa-linode:before{content:"\f2b8"}.fa-address-book:before{content:"\f2b9"}.fa-address-book-o:before{content:"\f2ba"}.fa-vcard:before,.fa-address-card:before{content:"\f2bb"}.fa-vcard-o:before,.fa-address-card-o:before{content:"\f2bc"}.fa-user-circle:before{content:"\f2bd"}.fa-user-circle-o:before{content:"\f2be"}.fa-user-o:before{content:"\f2c0"}.fa-id-badge:before{content:"\f2c1"}.fa-drivers-license:before,.fa-id-card:before{content:"\f2c2"}.fa-drivers-license-o:before,.fa-id-card-o:before{content:"\f2c3"}.fa-quora:before{content:"\f2c4"}.fa-free-code-camp:before{content:"\f2c5"}.fa-telegram:before{content:"\f2c6"}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:"\f2c7"}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:"\f2c8"}.fa-thermometer-2:before,.fa-thermometer-half:before{content:"\f2c9"}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:"\f2ca"}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:"\f2cb"}.fa-shower:before{content:"\f2cc"}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:"\f2cd"}.fa-podcast:before{content:"\f2ce"}.fa-window-maximize:before{content:"\f2d0"}.fa-window-minimize:before{content:"\f2d1"}.fa-window-restore:before{content:"\f2d2"}.fa-times-rectangle:before,.fa-window-close:before{content:"\f2d3"}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:"\f2d4"}.fa-bandcamp:before{content:"\f2d5"}.fa-grav:before{content:"\f2d6"}.fa-etsy:before{content:"\f2d7"}.fa-imdb:before{content:"\f2d8"}.fa-ravelry:before{content:"\f2d9"}.fa-eercast:before{content:"\f2da"}.fa-microchip:before{content:"\f2db"}.fa-snowflake-o:before{content:"\f2dc"}.fa-superpowers:before{content:"\f2dd"}.fa-wpexplorer:before{content:"\f2de"}.fa-meetup:before{content:"\f2e0"}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}
diff --git a/dev-guide/FontAwesome/fonts/FontAwesome.ttf b/dev-guide/FontAwesome/fonts/FontAwesome.ttf
new file mode 100644
index 0000000000..35acda2fa1
Binary files /dev/null and b/dev-guide/FontAwesome/fonts/FontAwesome.ttf differ
diff --git a/dev-guide/FontAwesome/fonts/fontawesome-webfont.eot b/dev-guide/FontAwesome/fonts/fontawesome-webfont.eot
new file mode 100644
index 0000000000..e9f60ca953
Binary files /dev/null and b/dev-guide/FontAwesome/fonts/fontawesome-webfont.eot differ
diff --git a/dev-guide/FontAwesome/fonts/fontawesome-webfont.svg b/dev-guide/FontAwesome/fonts/fontawesome-webfont.svg
new file mode 100644
index 0000000000..855c845e53
--- /dev/null
+++ b/dev-guide/FontAwesome/fonts/fontawesome-webfont.svg
@@ -0,0 +1,2671 @@
+
+
+
diff --git a/dev-guide/FontAwesome/fonts/fontawesome-webfont.ttf b/dev-guide/FontAwesome/fonts/fontawesome-webfont.ttf
new file mode 100644
index 0000000000..35acda2fa1
Binary files /dev/null and b/dev-guide/FontAwesome/fonts/fontawesome-webfont.ttf differ
diff --git a/dev-guide/FontAwesome/fonts/fontawesome-webfont.woff b/dev-guide/FontAwesome/fonts/fontawesome-webfont.woff
new file mode 100644
index 0000000000..400014a4b0
Binary files /dev/null and b/dev-guide/FontAwesome/fonts/fontawesome-webfont.woff differ
diff --git a/dev-guide/FontAwesome/fonts/fontawesome-webfont.woff2 b/dev-guide/FontAwesome/fonts/fontawesome-webfont.woff2
new file mode 100644
index 0000000000..4d13fc6040
Binary files /dev/null and b/dev-guide/FontAwesome/fonts/fontawesome-webfont.woff2 differ
diff --git a/dev-guide/ayu-highlight.css b/dev-guide/ayu-highlight.css
new file mode 100644
index 0000000000..32c9432224
--- /dev/null
+++ b/dev-guide/ayu-highlight.css
@@ -0,0 +1,78 @@
+/*
+Based off of the Ayu theme
+Original by Dempfi (https://github.com/dempfi/ayu)
+*/
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #191f26;
+ color: #e6e1cf;
+}
+
+.hljs-comment,
+.hljs-quote {
+ color: #5c6773;
+ font-style: italic;
+}
+
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-attr,
+.hljs-regexp,
+.hljs-link,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #ff7733;
+}
+
+.hljs-number,
+.hljs-meta,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #ffee99;
+}
+
+.hljs-string,
+.hljs-bullet {
+ color: #b8cc52;
+}
+
+.hljs-title,
+.hljs-built_in,
+.hljs-section {
+ color: #ffb454;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-symbol {
+ color: #ff7733;
+}
+
+.hljs-name {
+ color: #36a3d9;
+}
+
+.hljs-tag {
+ color: #00568d;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #91b362;
+}
+
+.hljs-deletion {
+ color: #d96c75;
+}
diff --git a/dev-guide/book.js b/dev-guide/book.js
new file mode 100644
index 0000000000..aa12e7eccf
--- /dev/null
+++ b/dev-guide/book.js
@@ -0,0 +1,697 @@
+"use strict";
+
+// Fix back button cache problem
+window.onunload = function () { };
+
+// Global variable, shared between modules
+function playground_text(playground, hidden = true) {
+ let code_block = playground.querySelector("code");
+
+ if (window.ace && code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ return editor.getValue();
+ } else if (hidden) {
+ return code_block.textContent;
+ } else {
+ return code_block.innerText;
+ }
+}
+
+(function codeSnippets() {
+ function fetch_with_timeout(url, options, timeout = 6000) {
+ return Promise.race([
+ fetch(url, options),
+ new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), timeout))
+ ]);
+ }
+
+ var playgrounds = Array.from(document.querySelectorAll(".playground"));
+ if (playgrounds.length > 0) {
+ fetch_with_timeout("https://play.rust-lang.org/meta/crates", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ })
+ .then(response => response.json())
+ .then(response => {
+ // get list of crates available in the rust playground
+ let playground_crates = response.crates.map(item => item["id"]);
+ playgrounds.forEach(block => handle_crate_list_update(block, playground_crates));
+ });
+ }
+
+ function handle_crate_list_update(playground_block, playground_crates) {
+ // update the play buttons after receiving the response
+ update_play_button(playground_block, playground_crates);
+
+ // and install on change listener to dynamically update ACE editors
+ if (window.ace) {
+ let code_block = playground_block.querySelector("code");
+ if (code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ editor.addEventListener("change", function (e) {
+ update_play_button(playground_block, playground_crates);
+ });
+ // add Ctrl-Enter command to execute rust code
+ editor.commands.addCommand({
+ name: "run",
+ bindKey: {
+ win: "Ctrl-Enter",
+ mac: "Ctrl-Enter"
+ },
+ exec: _editor => run_rust_code(playground_block)
+ });
+ }
+ }
+ }
+
+ // updates the visibility of play button based on `no_run` class and
+ // used crates vs ones available on https://play.rust-lang.org
+ function update_play_button(pre_block, playground_crates) {
+ var play_button = pre_block.querySelector(".play-button");
+
+ // skip if code is `no_run`
+ if (pre_block.querySelector('code').classList.contains("no_run")) {
+ play_button.classList.add("hidden");
+ return;
+ }
+
+ // get list of `extern crate`'s from snippet
+ var txt = playground_text(pre_block);
+ var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
+ var snippet_crates = [];
+ var item;
+ while (item = re.exec(txt)) {
+ snippet_crates.push(item[1]);
+ }
+
+ // check if all used crates are available on play.rust-lang.org
+ var all_available = snippet_crates.every(function (elem) {
+ return playground_crates.indexOf(elem) > -1;
+ });
+
+ if (all_available) {
+ play_button.classList.remove("hidden");
+ } else {
+ play_button.classList.add("hidden");
+ }
+ }
+
+ function run_rust_code(code_block) {
+ var result_block = code_block.querySelector(".result");
+ if (!result_block) {
+ result_block = document.createElement('code');
+ result_block.className = 'result hljs language-bash';
+
+ code_block.append(result_block);
+ }
+
+ let text = playground_text(code_block);
+ let classes = code_block.querySelector('code').classList;
+ let edition = "2015";
+ if(classes.contains("edition2018")) {
+ edition = "2018";
+ } else if(classes.contains("edition2021")) {
+ edition = "2021";
+ }
+ var params = {
+ version: "stable",
+ optimize: "0",
+ code: text,
+ edition: edition
+ };
+
+ if (text.indexOf("#![feature") !== -1) {
+ params.version = "nightly";
+ }
+
+ result_block.innerText = "Running...";
+
+ fetch_with_timeout("https://play.rust-lang.org/evaluate.json", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ body: JSON.stringify(params)
+ })
+ .then(response => response.json())
+ .then(response => {
+ if (response.result.trim() === '') {
+ result_block.innerText = "No output";
+ result_block.classList.add("result-no-output");
+ } else {
+ result_block.innerText = response.result;
+ result_block.classList.remove("result-no-output");
+ }
+ })
+ .catch(error => result_block.innerText = "Playground Communication: " + error.message);
+ }
+
+ // Syntax highlighting Configuration
+ hljs.configure({
+ tabReplace: ' ', // 4 spaces
+ languages: [], // Languages used for auto-detection
+ });
+
+ let code_nodes = Array
+ .from(document.querySelectorAll('code'))
+ // Don't highlight `inline code` blocks in headers.
+ .filter(function (node) {return !node.parentElement.classList.contains("header"); });
+
+ if (window.ace) {
+ // language-rust class needs to be removed for editable
+ // blocks or highlightjs will capture events
+ code_nodes
+ .filter(function (node) {return node.classList.contains("editable"); })
+ .forEach(function (block) { block.classList.remove('language-rust'); });
+
+ code_nodes
+ .filter(function (node) {return !node.classList.contains("editable"); })
+ .forEach(function (block) { hljs.highlightBlock(block); });
+ } else {
+ code_nodes.forEach(function (block) { hljs.highlightBlock(block); });
+ }
+
+ // Adding the hljs class gives code blocks the color css
+ // even if highlighting doesn't apply
+ code_nodes.forEach(function (block) { block.classList.add('hljs'); });
+
+ Array.from(document.querySelectorAll("code.hljs")).forEach(function (block) {
+
+ var lines = Array.from(block.querySelectorAll('.boring'));
+ // If no lines were hidden, return
+ if (!lines.length) { return; }
+ block.classList.add("hide-boring");
+
+ var buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ buttons.innerHTML = "";
+
+ // add expand button
+ var pre_block = block.parentNode;
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+
+ pre_block.querySelector('.buttons').addEventListener('click', function (e) {
+ if (e.target.classList.contains('fa-eye')) {
+ e.target.classList.remove('fa-eye');
+ e.target.classList.add('fa-eye-slash');
+ e.target.title = 'Hide lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.remove('hide-boring');
+ } else if (e.target.classList.contains('fa-eye-slash')) {
+ e.target.classList.remove('fa-eye-slash');
+ e.target.classList.add('fa-eye');
+ e.target.title = 'Show hidden lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.add('hide-boring');
+ }
+ });
+ });
+
+ if (window.playground_copyable) {
+ Array.from(document.querySelectorAll('pre code')).forEach(function (block) {
+ var pre_block = block.parentNode;
+ if (!pre_block.classList.contains('playground')) {
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var clipButton = document.createElement('button');
+ clipButton.className = 'fa fa-copy clip-button';
+ clipButton.title = 'Copy to clipboard';
+ clipButton.setAttribute('aria-label', clipButton.title);
+ clipButton.innerHTML = '';
+
+ buttons.insertBefore(clipButton, buttons.firstChild);
+ }
+ });
+ }
+
+ // Process playground code blocks
+ Array.from(document.querySelectorAll(".playground")).forEach(function (pre_block) {
+ // Add play button
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var runCodeButton = document.createElement('button');
+ runCodeButton.className = 'fa fa-play play-button';
+ runCodeButton.hidden = true;
+ runCodeButton.title = 'Run this code';
+ runCodeButton.setAttribute('aria-label', runCodeButton.title);
+
+ buttons.insertBefore(runCodeButton, buttons.firstChild);
+ runCodeButton.addEventListener('click', function (e) {
+ run_rust_code(pre_block);
+ });
+
+ if (window.playground_copyable) {
+ var copyCodeClipboardButton = document.createElement('button');
+ copyCodeClipboardButton.className = 'fa fa-copy clip-button';
+ copyCodeClipboardButton.innerHTML = '';
+ copyCodeClipboardButton.title = 'Copy to clipboard';
+ copyCodeClipboardButton.setAttribute('aria-label', copyCodeClipboardButton.title);
+
+ buttons.insertBefore(copyCodeClipboardButton, buttons.firstChild);
+ }
+
+ let code_block = pre_block.querySelector("code");
+ if (window.ace && code_block.classList.contains("editable")) {
+ var undoChangesButton = document.createElement('button');
+ undoChangesButton.className = 'fa fa-history reset-button';
+ undoChangesButton.title = 'Undo changes';
+ undoChangesButton.setAttribute('aria-label', undoChangesButton.title);
+
+ buttons.insertBefore(undoChangesButton, buttons.firstChild);
+
+ undoChangesButton.addEventListener('click', function () {
+ let editor = window.ace.edit(code_block);
+ editor.setValue(editor.originalCode);
+ editor.clearSelection();
+ });
+ }
+ });
+})();
+
+(function themes() {
+ var html = document.querySelector('html');
+ var themeToggleButton = document.getElementById('theme-toggle');
+ var themePopup = document.getElementById('theme-list');
+ var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
+ var stylesheets = {
+ ayuHighlight: document.querySelector("[href$='ayu-highlight.css']"),
+ tomorrowNight: document.querySelector("[href$='tomorrow-night.css']"),
+ highlight: document.querySelector("[href$='highlight.css']"),
+ };
+
+ function showThemes() {
+ themePopup.style.display = 'block';
+ themeToggleButton.setAttribute('aria-expanded', true);
+ themePopup.querySelector("button#" + get_theme()).focus();
+ }
+
+ function updateThemeSelected() {
+ themePopup.querySelectorAll('.theme-selected').forEach(function (el) {
+ el.classList.remove('theme-selected');
+ });
+ themePopup.querySelector("button#" + get_theme()).classList.add('theme-selected');
+ }
+
+ function hideThemes() {
+ themePopup.style.display = 'none';
+ themeToggleButton.setAttribute('aria-expanded', false);
+ themeToggleButton.focus();
+ }
+
+ function get_theme() {
+ var theme;
+ try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
+ if (theme === null || theme === undefined) {
+ return default_theme;
+ } else {
+ return theme;
+ }
+ }
+
+ function set_theme(theme, store = true) {
+ let ace_theme;
+
+ if (theme == 'coal' || theme == 'navy') {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = false;
+ stylesheets.highlight.disabled = true;
+
+ ace_theme = "ace/theme/tomorrow_night";
+ } else if (theme == 'ayu') {
+ stylesheets.ayuHighlight.disabled = false;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = true;
+ ace_theme = "ace/theme/tomorrow_night";
+ } else {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = false;
+ ace_theme = "ace/theme/dawn";
+ }
+
+ setTimeout(function () {
+ themeColorMetaTag.content = getComputedStyle(document.documentElement).backgroundColor;
+ }, 1);
+
+ if (window.ace && window.editors) {
+ window.editors.forEach(function (editor) {
+ editor.setTheme(ace_theme);
+ });
+ }
+
+ var previousTheme = get_theme();
+
+ if (store) {
+ try { localStorage.setItem('mdbook-theme', theme); } catch (e) { }
+ }
+
+ html.classList.remove(previousTheme);
+ html.classList.add(theme);
+ updateThemeSelected();
+ }
+
+ // Set theme
+ var theme = get_theme();
+
+ set_theme(theme, false);
+
+ themeToggleButton.addEventListener('click', function () {
+ if (themePopup.style.display === 'block') {
+ hideThemes();
+ } else {
+ showThemes();
+ }
+ });
+
+ themePopup.addEventListener('click', function (e) {
+ var theme;
+ if (e.target.className === "theme") {
+ theme = e.target.id;
+ } else if (e.target.parentElement.className === "theme") {
+ theme = e.target.parentElement.id;
+ } else {
+ return;
+ }
+ set_theme(theme);
+ });
+
+ themePopup.addEventListener('focusout', function(e) {
+ // e.relatedTarget is null in Safari and Firefox on macOS (see workaround below)
+ if (!!e.relatedTarget && !themeToggleButton.contains(e.relatedTarget) && !themePopup.contains(e.relatedTarget)) {
+ hideThemes();
+ }
+ });
+
+ // Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
+ document.addEventListener('click', function(e) {
+ if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
+ hideThemes();
+ }
+ });
+
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (!themePopup.contains(e.target)) { return; }
+
+ switch (e.key) {
+ case 'Escape':
+ e.preventDefault();
+ hideThemes();
+ break;
+ case 'ArrowUp':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.previousElementSibling) {
+ li.previousElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'ArrowDown':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.nextElementSibling) {
+ li.nextElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'Home':
+ e.preventDefault();
+ themePopup.querySelector('li:first-child button').focus();
+ break;
+ case 'End':
+ e.preventDefault();
+ themePopup.querySelector('li:last-child button').focus();
+ break;
+ }
+ });
+})();
+
+(function sidebar() {
+ var body = document.querySelector("body");
+ var sidebar = document.getElementById("sidebar");
+ var sidebarLinks = document.querySelectorAll('#sidebar a');
+ var sidebarToggleButton = document.getElementById("sidebar-toggle");
+ var sidebarResizeHandle = document.getElementById("sidebar-resize-handle");
+ var firstContact = null;
+
+ function showSidebar() {
+ body.classList.remove('sidebar-hidden')
+ body.classList.add('sidebar-visible');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', 0);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', true);
+ sidebar.setAttribute('aria-hidden', false);
+ try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
+ }
+
+
+ var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
+
+ function toggleSection(ev) {
+ ev.currentTarget.parentElement.classList.toggle('expanded');
+ }
+
+ Array.from(sidebarAnchorToggles).forEach(function (el) {
+ el.addEventListener('click', toggleSection);
+ });
+
+ function hideSidebar() {
+ body.classList.remove('sidebar-visible')
+ body.classList.add('sidebar-hidden');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', -1);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', false);
+ sidebar.setAttribute('aria-hidden', true);
+ try { localStorage.setItem('mdbook-sidebar', 'hidden'); } catch (e) { }
+ }
+
+ // Toggle sidebar
+ sidebarToggleButton.addEventListener('click', function sidebarToggle() {
+ if (body.classList.contains("sidebar-hidden")) {
+ var current_width = parseInt(
+ document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
+ if (current_width < 150) {
+ document.documentElement.style.setProperty('--sidebar-width', '150px');
+ }
+ showSidebar();
+ } else if (body.classList.contains("sidebar-visible")) {
+ hideSidebar();
+ } else {
+ if (getComputedStyle(sidebar)['transform'] === 'none') {
+ hideSidebar();
+ } else {
+ showSidebar();
+ }
+ }
+ });
+
+ sidebarResizeHandle.addEventListener('mousedown', initResize, false);
+
+ function initResize(e) {
+ window.addEventListener('mousemove', resize, false);
+ window.addEventListener('mouseup', stopResize, false);
+ body.classList.add('sidebar-resizing');
+ }
+ function resize(e) {
+ var pos = (e.clientX - sidebar.offsetLeft);
+ if (pos < 20) {
+ hideSidebar();
+ } else {
+ if (body.classList.contains("sidebar-hidden")) {
+ showSidebar();
+ }
+ pos = Math.min(pos, window.innerWidth - 100);
+ document.documentElement.style.setProperty('--sidebar-width', pos + 'px');
+ }
+ }
+ //on mouseup remove windows functions mousemove & mouseup
+ function stopResize(e) {
+ body.classList.remove('sidebar-resizing');
+ window.removeEventListener('mousemove', resize, false);
+ window.removeEventListener('mouseup', stopResize, false);
+ }
+
+ document.addEventListener('touchstart', function (e) {
+ firstContact = {
+ x: e.touches[0].clientX,
+ time: Date.now()
+ };
+ }, { passive: true });
+
+ document.addEventListener('touchmove', function (e) {
+ if (!firstContact)
+ return;
+
+ var curX = e.touches[0].clientX;
+ var xDiff = curX - firstContact.x,
+ tDiff = Date.now() - firstContact.time;
+
+ if (tDiff < 250 && Math.abs(xDiff) >= 150) {
+ if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
+ showSidebar();
+ else if (xDiff < 0 && curX < 300)
+ hideSidebar();
+
+ firstContact = null;
+ }
+ }, { passive: true });
+})();
+
+(function chapterNavigation() {
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (window.search && window.search.hasFocus()) { return; }
+ var html = document.querySelector('html');
+
+ function next() {
+ var nextButton = document.querySelector('.nav-chapters.next');
+ if (nextButton) {
+ window.location.href = nextButton.href;
+ }
+ }
+ function prev() {
+ var previousButton = document.querySelector('.nav-chapters.previous');
+ if (previousButton) {
+ window.location.href = previousButton.href;
+ }
+ }
+ switch (e.key) {
+ case 'ArrowRight':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ prev();
+ } else {
+ next();
+ }
+ break;
+ case 'ArrowLeft':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ next();
+ } else {
+ prev();
+ }
+ break;
+ }
+ });
+})();
+
+(function clipboard() {
+ var clipButtons = document.querySelectorAll('.clip-button');
+
+ function hideTooltip(elem) {
+ elem.firstChild.innerText = "";
+ elem.className = 'fa fa-copy clip-button';
+ }
+
+ function showTooltip(elem, msg) {
+ elem.firstChild.innerText = msg;
+ elem.className = 'fa fa-copy tooltipped';
+ }
+
+ var clipboardSnippets = new ClipboardJS('.clip-button', {
+ text: function (trigger) {
+ hideTooltip(trigger);
+ let playground = trigger.closest("pre");
+ return playground_text(playground, false);
+ }
+ });
+
+ Array.from(clipButtons).forEach(function (clipButton) {
+ clipButton.addEventListener('mouseout', function (e) {
+ hideTooltip(e.currentTarget);
+ });
+ });
+
+ clipboardSnippets.on('success', function (e) {
+ e.clearSelection();
+ showTooltip(e.trigger, "Copied!");
+ });
+
+ clipboardSnippets.on('error', function (e) {
+ showTooltip(e.trigger, "Clipboard error!");
+ });
+})();
+
+(function scrollToTop () {
+ var menuTitle = document.querySelector('.menu-title');
+
+ menuTitle.addEventListener('click', function () {
+ document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
+ });
+})();
+
+(function controllMenu() {
+ var menu = document.getElementById('menu-bar');
+
+ (function controllPosition() {
+ var scrollTop = document.scrollingElement.scrollTop;
+ var prevScrollTop = scrollTop;
+ var minMenuY = -menu.clientHeight - 50;
+ // When the script loads, the page can be at any scroll (e.g. if you reforesh it).
+ menu.style.top = scrollTop + 'px';
+ // Same as parseInt(menu.style.top.slice(0, -2), but faster
+ var topCache = menu.style.top.slice(0, -2);
+ menu.classList.remove('sticky');
+ var stickyCache = false; // Same as menu.classList.contains('sticky'), but faster
+ document.addEventListener('scroll', function () {
+ scrollTop = Math.max(document.scrollingElement.scrollTop, 0);
+ // `null` means that it doesn't need to be updated
+ var nextSticky = null;
+ var nextTop = null;
+ var scrollDown = scrollTop > prevScrollTop;
+ var menuPosAbsoluteY = topCache - scrollTop;
+ if (scrollDown) {
+ nextSticky = false;
+ if (menuPosAbsoluteY > 0) {
+ nextTop = prevScrollTop;
+ }
+ } else {
+ if (menuPosAbsoluteY > 0) {
+ nextSticky = true;
+ } else if (menuPosAbsoluteY < minMenuY) {
+ nextTop = prevScrollTop + minMenuY;
+ }
+ }
+ if (nextSticky === true && stickyCache === false) {
+ menu.classList.add('sticky');
+ stickyCache = true;
+ } else if (nextSticky === false && stickyCache === true) {
+ menu.classList.remove('sticky');
+ stickyCache = false;
+ }
+ if (nextTop !== null) {
+ menu.style.top = nextTop + 'px';
+ topCache = nextTop;
+ }
+ prevScrollTop = scrollTop;
+ }, { passive: true });
+ })();
+ (function controllBorder() {
+ function updateBorder() {
+ if (menu.offsetTop === 0) {
+ menu.classList.remove('bordered');
+ } else {
+ menu.classList.add('bordered');
+ }
+ }
+ updateBorder();
+ document.addEventListener('scroll', updateBorder, { passive: true });
+ })();
+})();
diff --git a/dev-guide/clipboard.min.js b/dev-guide/clipboard.min.js
new file mode 100644
index 0000000000..02c549e35c
--- /dev/null
+++ b/dev-guide/clipboard.min.js
@@ -0,0 +1,7 @@
+/*!
+ * clipboard.js v2.0.4
+ * https://zenorocha.github.io/clipboard.js
+ *
+ * Licensed MIT © Zeno Rocha
+ */
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return function(n){var o={};function r(t){if(o[t])return o[t].exports;var e=o[t]={i:t,l:!1,exports:{}};return n[t].call(e.exports,e,e.exports,r),e.l=!0,e.exports}return r.m=n,r.c=o,r.d=function(t,e,n){r.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:n})},r.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return r.d(e,"a",e),e},r.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},r.p="",r(r.s=0)}([function(t,e,n){"use strict";var r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},i=function(){function o(t,e){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/css/chrome.css b/dev-guide/css/chrome.css
new file mode 100644
index 0000000000..8b78255de5
--- /dev/null
+++ b/dev-guide/css/chrome.css
@@ -0,0 +1,606 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+@import 'variables.css';
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/dev-guide/css/general.css b/dev-guide/css/general.css
new file mode 100644
index 0000000000..e7d20da725
--- /dev/null
+++ b/dev-guide/css/general.css
@@ -0,0 +1,234 @@
+/* Base styles and content styles */
+
+@import 'variables.css';
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/dev-guide/css/print.css b/dev-guide/css/print.css
new file mode 100644
index 0000000000..80ec3a5441
--- /dev/null
+++ b/dev-guide/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/dev-guide/css/variables.css b/dev-guide/css/variables.css
new file mode 100644
index 0000000000..0da55e8c9a
--- /dev/null
+++ b/dev-guide/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/dev-guide/elasticlunr.min.js b/dev-guide/elasticlunr.min.js
new file mode 100644
index 0000000000..94b20dd2ef
--- /dev/null
+++ b/dev-guide/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Coding standards
+Generally we just follow good sensible Rust practices, clippy and so forth. +However there are some practices we’ve agreed on that are not machine-enforced; +meeting those requirements in a PR will make it easier to merge.
+Import grouping
+In each file the imports should be grouped into at most 4 groups in the +following order:
+-
+
- stdlib +
- non-repository local crates +
- repository local other crates +
- this crate +
Separate each group with a blank line, and rustfmt will sort into a canonical +order. Any file that is not grouped like this can be rearranged whenever the +file is touched - we’re not precious about having it done in a separate commit, +though that is helpful.
+No direct use of process state outside rustup::process
+The rustup::process module abstracts the global state that is
+std::env::args, std::env::vars, std::io::std*, std::process::id,
+std::env::current_dir and std::process::exit permitting threaded tests of
+the CLI logic; use process() rather than those APIs directly.
Clippy lints
+We do not enforce lint status in the checks done by GitHub Actions, because +clippy is a moving target that can make it hard to merge for little benefit.
+We do ask that contributors keep the clippy status clean themselves.
+Minimally, run cargo clippy --all --all-targets --features test -- -D warnings before
+submitting code.
If possible, adding --all-features to the command is useful, but will require
+additional dependencies like libcurl-dev.
Regular contributors or contributors to particularly OS-specific code should +also make sure that their clippy checking is done on at least Linux and Windows, +as OS-conditional code is a common source of unused imports and other small +lints, which can build up over time.
+For developers using BSD/Linux/Mac OS, there are Windows VM’s suitable for such +development tasks for use with virtualbox and other hypervisors are downloadable +from +Microsoft. +Similarly, there are many Linux and Unix operating systems images available for +developers whose usual operating system is Windows. Currently Rustup has no Mac +OS specific code, so there should be no need to worry about Mac VM images.
+Clippy is also run in GitHub Actions, in the General Checks / Checks build
+task, but not currently run per-platform, which means there is no way to find
+out the status of clippy per platform without running it on that platform as a
+developer.
import rustup-macros::{integration,unit}_test into test modules
+These test helpers add pre-and-post logic to tests to enable the use of tracing +inside tests, which can be helpful for tracking down behaviours in larger tests.
+ +":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/linting.html b/dev-guide/linting.html
new file mode 100644
index 0000000000..64869bfe35
--- /dev/null
+++ b/dev-guide/linting.html
@@ -0,0 +1,274 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contributing to rustup
+-
+
- Fork it! +
- Create your feature branch:
git checkout -b my-new-feature
+ - Test it:
cargo test --features=test
+ - Lint it! +
- Commit your changes:
git commit -am 'Add some feature'
+ - Push to the branch:
git push origin my-new-feature
+ - Submit a pull request :D +
For developing on rustup itself, you may want to install into a temporary
+directory, with a series of commands similar to this:
cargo build
+mkdir home
+RUSTUP_HOME=home CARGO_HOME=home target/debug/rustup-init --no-modify-path -y
+You can then try out rustup with your changes by running home/bin/rustup, without
+affecting any existing installation. Remember to keep those two environment variables
+set when running your compiled rustup-init or the toolchains it installs, but unset
+when rebuilding rustup itself.
If you wish to install your new build to try out longer term in your home directory
+then you can run cargo dev-install which is an alias in .cargo/config which
+runs cargo run -- --no-modify-path -y to install your build into your homedir.
We use rustfmt to keep our codebase consistently formatted. Please ensure that
+you have correctly formatted your code (most editors will do this automatically
+when saving) or it may not pass the CI tests.
If you are moving, renaming or removing an existing mdBook page, please use mdBook’s
+output.html.redirect feature to ensure that the old URL gets redirected.
Unless you explicitly state otherwise, any contribution intentionally +submitted for inclusion in the work by you, as defined in the +Apache-2.0 license, shall be dual licensed as in the README, without any +additional terms or conditions.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/mark.min.js b/dev-guide/mark.min.js
new file mode 100644
index 0000000000..1636231883
--- /dev/null
+++ b/dev-guide/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Linting
+We use cargo clippy to ensure high-quality code and to enforce a set of best practices for Rust programming.
+However, not all lints provided by cargo clippy are relevant or applicable to our project.
+We may choose to ignore some lints if they are unstable, experimental, or specific to our project.
+If you are unsure about a lint, please ask us in the rustup Discord channel.
Manual linting
+When checking the codebase with clippy,
+it is recommended to use the following command:
$ cargo clippy --all --all-targets --all-features -- -D warnings
+Please note the --all-features flag: it is used because we need to enable the test feature
+to make lints fully work, for which --all-features happens to be a convenient shortcut.
The test feature is required because rustup uses
+cargo features to
+conditionally compile
+support code for integration tests, as #[cfg(test)] is only available for unit tests.
If you encounter an issue or wish to speed up the initial analysis, you could also try
+activating only the test feature by replacing --all-features with --features=test.
Rust-Analyzer
+When checking the codebase using rust-analyzer, the first thing to do remains unchanged:
+enabling the features.
This is done by setting the rust-analyzer.cargo.features property to "all".
For example, if you are using rust-analyzer within VSCode, you would want to
+add the following to your project’s .vscode/settings.json1:
"rust-analyzer.cargo.features": "all",
+1
+
+Alternatively, if you want to apply the configuration to all your Rust projects,
+you can add it to your global configuration at ~/.config/Code/User/settings.json instead.
Alternatively, if you want to enable the test feature only, you should set the
+following instead:
"rust-analyzer.cargo.features": ["test"]
+Next, as rust-analyzer depends on cargo check by default, it is also recommended to
+enable the cargo clippy integration by adding the following:
"rust-analyzer.check.command": "clippy",
+You might also want to refer to the
+rust-analyzer manual
+for more details on properly setting up rust-analyzer in your IDE of choice.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/release-process.html b/dev-guide/release-process.html
new file mode 100644
index 0000000000..ce6fa21bbc
--- /dev/null
+++ b/dev-guide/release-process.html
@@ -0,0 +1,318 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Contributing to rustup
+-
+
- Fork it! +
- Create your feature branch:
git checkout -b my-new-feature
+ - Test it:
cargo test --features=test
+ - Lint it! +
- Commit your changes:
git commit -am 'Add some feature'
+ - Push to the branch:
git push origin my-new-feature
+ - Submit a pull request :D +
For developing on rustup itself, you may want to install into a temporary
+directory, with a series of commands similar to this:
cargo build
+mkdir home
+RUSTUP_HOME=home CARGO_HOME=home target/debug/rustup-init --no-modify-path -y
+You can then try out rustup with your changes by running home/bin/rustup, without
+affecting any existing installation. Remember to keep those two environment variables
+set when running your compiled rustup-init or the toolchains it installs, but unset
+when rebuilding rustup itself.
If you wish to install your new build to try out longer term in your home directory
+then you can run cargo dev-install which is an alias in .cargo/config which
+runs cargo run -- --no-modify-path -y to install your build into your homedir.
We use rustfmt to keep our codebase consistently formatted. Please ensure that
+you have correctly formatted your code (most editors will do this automatically
+when saving) or it may not pass the CI tests.
If you are moving, renaming or removing an existing mdBook page, please use mdBook’s
+output.html.redirect feature to ensure that the old URL gets redirected.
Unless you explicitly state otherwise, any contribution intentionally +submitted for inclusion in the work by you, as defined in the +Apache-2.0 license, shall be dual licensed as in the README, without any +additional terms or conditions.
+Linting
+We use cargo clippy to ensure high-quality code and to enforce a set of best practices for Rust programming.
+However, not all lints provided by cargo clippy are relevant or applicable to our project.
+We may choose to ignore some lints if they are unstable, experimental, or specific to our project.
+If you are unsure about a lint, please ask us in the rustup Discord channel.
Manual linting
+When checking the codebase with clippy,
+it is recommended to use the following command:
$ cargo clippy --all --all-targets --all-features -- -D warnings
+Please note the --all-features flag: it is used because we need to enable the test feature
+to make lints fully work, for which --all-features happens to be a convenient shortcut.
The test feature is required because rustup uses
+cargo features to
+conditionally compile
+support code for integration tests, as #[cfg(test)] is only available for unit tests.
If you encounter an issue or wish to speed up the initial analysis, you could also try
+activating only the test feature by replacing --all-features with --features=test.
Rust-Analyzer
+When checking the codebase using rust-analyzer, the first thing to do remains unchanged:
+enabling the features.
This is done by setting the rust-analyzer.cargo.features property to "all".
For example, if you are using rust-analyzer within VSCode, you would want to
+add the following to your project’s .vscode/settings.json1:
"rust-analyzer.cargo.features": "all",
+1
+
+Alternatively, if you want to apply the configuration to all your Rust projects,
+you can add it to your global configuration at ~/.config/Code/User/settings.json instead.
Alternatively, if you want to enable the test feature only, you should set the
+following instead:
"rust-analyzer.cargo.features": ["test"]
+Next, as rust-analyzer depends on cargo check by default, it is also recommended to
+enable the cargo clippy integration by adding the following:
"rust-analyzer.check.command": "clippy",
+You might also want to refer to the
+rust-analyzer manual
+for more details on properly setting up rust-analyzer in your IDE of choice.
Coding standards
+Generally we just follow good sensible Rust practices, clippy and so forth. +However there are some practices we’ve agreed on that are not machine-enforced; +meeting those requirements in a PR will make it easier to merge.
+Import grouping
+In each file the imports should be grouped into at most 4 groups in the +following order:
+-
+
- stdlib +
- non-repository local crates +
- repository local other crates +
- this crate +
Separate each group with a blank line, and rustfmt will sort into a canonical +order. Any file that is not grouped like this can be rearranged whenever the +file is touched - we’re not precious about having it done in a separate commit, +though that is helpful.
+No direct use of process state outside rustup::process
+The rustup::process module abstracts the global state that is
+std::env::args, std::env::vars, std::io::std*, std::process::id,
+std::env::current_dir and std::process::exit permitting threaded tests of
+the CLI logic; use process() rather than those APIs directly.
Clippy lints
+We do not enforce lint status in the checks done by GitHub Actions, because +clippy is a moving target that can make it hard to merge for little benefit.
+We do ask that contributors keep the clippy status clean themselves.
+Minimally, run cargo clippy --all --all-targets --features test -- -D warnings before
+submitting code.
If possible, adding --all-features to the command is useful, but will require
+additional dependencies like libcurl-dev.
Regular contributors or contributors to particularly OS-specific code should +also make sure that their clippy checking is done on at least Linux and Windows, +as OS-conditional code is a common source of unused imports and other small +lints, which can build up over time.
+For developers using BSD/Linux/Mac OS, there are Windows VM’s suitable for such +development tasks for use with virtualbox and other hypervisors are downloadable +from +Microsoft. +Similarly, there are many Linux and Unix operating systems images available for +developers whose usual operating system is Windows. Currently Rustup has no Mac +OS specific code, so there should be no need to worry about Mac VM images.
+Clippy is also run in GitHub Actions, in the General Checks / Checks build
+task, but not currently run per-platform, which means there is no way to find
+out the status of clippy per platform without running it on that platform as a
+developer.
import rustup-macros::{integration,unit}_test into test modules
+These test helpers add pre-and-post logic to tests to enable the use of tracing +inside tests, which can be helpful for tracking down behaviours in larger tests.
+Version numbers
+If you ever see a released version of rustup which has :: in its version string
+then something went wrong with the CI and that needs to be addressed.
We use git-testament to construct our version strings. This records, as a
+struct, details of the git commit, tag description, and also an indication
+of modifications to the working tree present when the binary was compiled.
During normal development you may get information from invoking rustup --version
+which looks like rustup-init 1.18.3+15 (a54051502 2019-05-26) or even
+rustup-init 1.18.3+15 (a54051502 2019-05-26) dirty 1 modification.
The first part is always the binary name as per clap’s normal operation. The
+version number is a combination of the most recent tag in the git repo, and the
+number of commits since that tag. The parenthesised information is, naturally,
+the SHA of the most recent commit and the date of that commit. If the indication
+of a dirty tree is present, the number of changes is indicated. This combines
+adds, deletes, modifies, and unknown entries.
You can request further information of a rustup binary with the
+rustup dump-testament hidden command. It produces output of the form:
$ rustup dump-testament
+Rustup version renders as: 1.18.3+15 (a54051502 2019-05-26) dirty 1 modification
+Current crate version: 1.18.3
+Built from branch: kinnison/version-strings
+Commit info: 1.18.3+15 (a54051502 2019-05-26)
+Modified: CONTRIBUTING.md
+This can be handy when you are testing development versions on your PC +and cannot remember exactly which version you had installed, or if you have given +a development copy (or instruction to build such) to a user, and wish to have them +confirm exactly what they are using.
+Finally, we tell git-testament that we trust the stable branch to carry
+releases. If the build is being performed when not on the stable branch, and
+the tag and CARGO_PKG_VERSION differ, then the short version string will include
+both, in the form rustup-init 1.18.3 :: 1.18.2+99 (a54051502 2019-05-26) which
+indicates the crate version before the rest of the commit.
+On the other hand, if the build was on the stable branch then regardless
+of the tag information, providing the commit was clean, the version is
+always replaced by the crate version. The dump-testament hidden command can
+reveal the truth however.
Making a release
+Before making a release, ensure that rustup-init.sh is behaving correctly,
+and that you’re satisfied that nothing in the ecosystem is breaking because
+of the update. A useful set of things to check includes verifying that
+real-world toolchains install okay, and that rust-analyzer isn’t broken by
+the release. While it’s not our responsibility if they depend on non-stable
+APIs, we should behave well if we can.
As a maintainer, you have two options to choose from when cutting a new
+release: a beta release or an official release.
+The main difference between the two is that they use different values for
+the RUSTUP_UPDATE_ROOT environment variable:
-
+
- A beta release is deployed on
https://dev-static.rust-lang.org/rustup.
+ - An official release is deployed on
https://static.rust-lang.org/rustup.
+
By switching between those two values, Rustup effectively provides two “self
+update channels”, making beta testing possible with rustup self update.
Producing the final release artifacts is a bit involved because of the way +Rustup is distributed. +Below is a list of things to be done in order to cut a new [b]eta release +or an official [r]elease:
+-
+
- [b/r] In a separate PR:
+
-
+
- If the version strings in
Cargo.tomls haven’t been updated: +-
+
- Decide what the new version number
$VER_NUMshould be. ++
+Note: We always increment the minor number unless:
+-
+
- A major incompatibility has been introduced in this release: +increment the major number instead. +
- This release is a hotfix because the last one had a defect: +increment the patch number instead. +
+ - Update
Cargo.tomlanddownload/Cargo.tomlto have that same new +version number, then runcargo buildand reviewCargo.lockchanges. +If all looks well, make a commit.
+
+ - Decide what the new version number
- Update
CHANGELOG.mdaccordingly if necessary.
+
+ - If the version strings in
- [b/r] After merging the PR made in step 1, in a separate PR:
+
-
+
- Update the commit shasum in
rustup-init.shto match the latest commit +onmaster.
+
+ - Update the commit shasum in
- [b/r] After merging the PR made in step 2, sync
mastertostableusing +--ff-only: +-
+
git fetch origin master:master
+git checkout stable && git merge --ff-only master
+git push origin HEAD:stable
+
+ - [b/r] While you wait for green CI on
stable, double-check the +functionality ofrustup-init.shandrustup-initjust in case.
+ - [b/r] Ensure all of CI is green on the
stablebranch. +Once it is, check through a representative proportion of the builds looking +for the reported version statements to ensure that +we definitely built something cleanly which reports as the right version +number when run--version.
+ - [r] Make a new PR to the Rust Blog adding a new release announcement post. +
- [b/r] Ping someone in the release team to perform the actual release.
+They can find instructions in
ci/sync-dist.py. ++
+Note: Some manual testing occurs here, so hopefully they’ll catch +anything egregious in which case abort the change and roll back.
+
+ - [b] Once the beta release has happened, post a new topic named “Seeking beta +testers for Rustup $VER_NUM” on the Internals Forum. +
- [r] Once the official release has happened, prepare and push a tag on the
+latest
stablecommit. +-
+
git tag -as $VER_NUM -m $VER_NUM(optionally without-sif not GPG +signing the tag)
+git push origin $VER_NUM
+
+
Developer tips and tricks
+RUSTUP_FORCE_ARG0
+The environment variable RUSTUP_FORCE_ARG0 can be used to get rustup to think
+it’s a particular binary, rather than e.g. copying it, symlinking it or other
+tricks with exec. This is handy when testing particular code paths from cargo
+run.
RUSTUP_FORCE_ARG0=rustup cargo run -- uninstall nightly
+RUSTUP_BACKTRACK_LIMIT
+If it’s necessary to alter the backtracking limit from the default of half
+a release cycle for some reason, you can set the RUSTUP_BACKTRACK_LIMIT
+environment variable. If this is unparsable as an i32 or if it’s absent
+then the default of 21 days (half a cycle) is used. If it parses and is less
+than 1, it is clamped to 1 at minimum.
This is not meant for use by users, but can be suggested in diagnosing an issue +should one arise with the backtrack limits.
+RUSTUP_MAX_RETRIES
+When downloading a file, rustup will retry the download a number of times. The
+default is 3 times, but if this variable is set to a valid usize then it is the
+max retry count. A value of 0 means no retries, thus the default of 3 will
+mean a download is tried a total of four times before failing out.
RUSTUP_BACKTRACE
+By default while running tests, we unset some environment variables that will
+break our testing (like RUSTUP_TOOLCHAIN, SHELL, ZDOTDIR, RUST_BACKTRACE).
+But if you want to debug locally, you may need backtrace. RUSTUP_BACKTRACE
+is used like RUST_BACKTRACE to enable backtraces of failed tests.
NOTE: This is a backtrace for the test, not for any subprocess invocation of +rustup process running in the test
+$ RUSTUP_BACKTRACE=1 cargo test --release --test cli-v1 -- remove_toolchain_then_add_again
+ Finished release [optimized] target(s) in 0.38s
+ Running target\release\deps\cli_v1-1f29f824792f6dc1.exe
+
+running 1 test
+test remove_toolchain_then_add_again ... FAILED
+
+failures:
+
+---- remove_toolchain_then_add_again stdout ----
+thread 'remove_toolchain_then_add_again' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 1142, kind: Other, message: "An attempt was made to create more links on a file than the file system supports." }', src\libcore\result.rs:999:5
+stack backtrace:
+ 0: backtrace::backtrace::trace_unsynchronized
+ at C:\Users\appveyor\.cargo\registry\src\github.com-1ecc6299db9ec823\backtrace-0.3.29\src\backtrace\mod.rs:66
+ 1: std::sys_common::backtrace::_print
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\sys_common\backtrace.rs:47
+ 2: std::sys_common::backtrace::print
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\sys_common\backtrace.rs:36
+ 3: std::panicking::default_hook::{{closure}}
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:198
+ 4: std::panicking::default_hook
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:209
+ 5: std::panicking::rust_panic_with_hook
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:475
+ 6: std::panicking::continue_panic_fmt
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:382
+ 7: std::panicking::rust_begin_panic
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:309
+ 8: core::panicking::panic_fmt
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libcore\panicking.rs:85
+ 9: core::result::unwrap_failed
+ 10: cli_v1::mock::clitools::test
+ 11: alloc::boxed::{{impl}}::call_once<(),FnOnce<()>>
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\src\liballoc\boxed.rs:746
+ 12: panic_unwind::__rust_maybe_catch_panic
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libpanic_unwind\lib.rs:82
+ 13: std::panicking::try
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\src\libstd\panicking.rs:273
+ 14: std::panic::catch_unwind
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\src\libstd\panic.rs:388
+ 15: test::run_test::run_test_inner::{{closure}}
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libtest\lib.rs:1466
+note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
+
+
+failures:
+ remove_toolchain_then_add_again
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 26 filtered out
+
+error: test failed, to rerun pass '--test cli-v1'
+Tracing
+Similar to other tools in the Rust ecosystem like rustc and cargo,
+rustup also provides observability/logging features via the tracing crate.
The verbosity of logs is controlled via the RUSTUP_LOG environment
+variable using tracing_subscriber’s directive syntax.
Console-based tracing
+A tracing_subscriber that prints log lines directly to stderr is directly
+available in the prebuilt version of rustup since v1.28.0.
For historical reasons, if RUSTUP_LOG is not set, this subscriber will print
+the log lines in a format that mimics the “legacy” stderr output in older
+versions of rustup:
> rustup default stable
+info: using existing install for 'stable-aarch64-apple-darwin'
+info: default toolchain set to 'stable-aarch64-apple-darwin'
+
+ stable-aarch64-apple-darwin unchanged - rustc 1.79.0 (129f3b996 2024-06-10)
+However, once RUSTUP_LOG is set to any value, rustup’s “custom logging mode” will
+be activated, and tracing_subscriber’s builtin output format will be used instead:
> RUSTUP_LOG=trace rustup default stable
+2024-06-16T12:08:48.732894Z INFO rustup::cli::common: using existing install for 'stable-aarch64-apple-darwin'
+2024-06-16T12:08:48.739232Z INFO rustup::cli::common: default toolchain set to 'stable-aarch64-apple-darwin'
+
+ stable-aarch64-apple-darwin unchanged - rustc 1.79.0 (129f3b996 2024-06-10)
+Please note that since RUSTUP_LOG=trace essentially accepts log lines from
+all possible sources, you might sometimes see log lines coming from rustup’s
+dependencies, such as hyper_util in the following example:
> RUSTUP_LOG=trace rustup update
+[..]
+2024-06-16T12:12:45.569428Z TRACE hyper_util::client::legacy::client: http1 handshake complete, spawning background dispatcher task
+2024-06-16T12:12:45.648682Z TRACE hyper_util::client::legacy::pool: pool dropped, dropping pooled (("https", static.rust-lang.org))
+
+ stable-aarch64-apple-darwin unchanged - rustc 1.79.0 (129f3b996 2024-06-10)
+ nightly-aarch64-apple-darwin unchanged - rustc 1.81.0-nightly (3cf924b93 2024-06-15)
+
+2024-06-16T12:12:45.693350Z INFO rustup::cli::rustup_mode: cleaning up downloads & tmp directories
+It is also possible to limit the sources of the log lines and the desired
+max level for each source. For example, set RUSTUP_LOG=rustup=DEBUG to
+receive log lines only from rustup itself with a max verbosity of DEBUG.
Opentelemetry tracing
+++Prerequisites: Before following the instructions in this section, +
+protocmust be installed, which can be downloaded from GitHub +or installed via a package manager.
The feature otel can be used when building rustup to turn on Opentelemetry
+tracing with an OLTP GRPC exporter.
This can be very useful for diagnosing performance or correctness issues in more +complicated scenarios.
+The normal OTLP environment +variables +can be used to customise its behaviour, but often the simplest thing is to just +run a Jaeger docker container on the same host:
+docker run -d --name jaeger -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 -e COLLECTOR_OTLP_ENABLED=true -p 6831:6831/udp -p 6832:6832/udp -p 5778:5778 -p 16686:16686 -p 4317:4317 -p 4318:4318 -p 14250:14250 -p 14268:14268 -p 14269:14269 -p 9411:9411 jaegertracing/all-in-one:latest
+Then build rustup-init with tracing:
cargo build --features=otel
+Run the operation you want to analyze. For example, we can now run rustup show with tracing:
RUSTUP_FORCE_ARG0="rustup" ./target/debug/rustup-init show
+And look in Jaeger for a trace.
+Tracing can also be used in tests to get a trace of the operations taken during the test.
+To use this feature, build the project with --features=otel,test.
Adding instrumentation
+The otel feature uses conditional compilation to only add function instrument
+when enabled. Instrumenting a currently uninstrumented function is mostly simply
+done like so:
+#![allow(unused)] +fn main() { +#[tracing::instrument(level = "trace", err(level = "trace"), skip_all)] +}
skip_all is not required, but some core structs don’t implement Debug yet, and
+others have a lot of output in Debug : tracing adds some overheads, so keeping
+spans lightweight can help avoid frequency bias in the results - where
+parameters with large debug in frequently called functions show up as much
+slower than they are.
Some good general heuristics:
+-
+
- Do instrument slow blocking functions +
- Do instrument functions with many callers or that call many different things, +as these tend to help figure the puzzle of what-is-happening +
- Default to not instrumenting thin shim functions (or at least, only instrument +them temporarily while figuring out the shape of a problem) +
- Be way of debug build timing - release optimisations make a huge difference, +though debug is a lot faster to iterate on. If something isn’t a problem in +release don’t pay it too much heed in debug. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/searcher.js b/dev-guide/searcher.js
new file mode 100644
index 0000000000..dc03e0a02d
--- /dev/null
+++ b/dev-guide/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Making a release
+Before making a release, ensure that rustup-init.sh is behaving correctly,
+and that you’re satisfied that nothing in the ecosystem is breaking because
+of the update. A useful set of things to check includes verifying that
+real-world toolchains install okay, and that rust-analyzer isn’t broken by
+the release. While it’s not our responsibility if they depend on non-stable
+APIs, we should behave well if we can.
As a maintainer, you have two options to choose from when cutting a new
+release: a beta release or an official release.
+The main difference between the two is that they use different values for
+the RUSTUP_UPDATE_ROOT environment variable:
-
+
- A beta release is deployed on
https://dev-static.rust-lang.org/rustup.
+ - An official release is deployed on
https://static.rust-lang.org/rustup.
+
By switching between those two values, Rustup effectively provides two “self
+update channels”, making beta testing possible with rustup self update.
Producing the final release artifacts is a bit involved because of the way +Rustup is distributed. +Below is a list of things to be done in order to cut a new [b]eta release +or an official [r]elease:
+-
+
- [b/r] In a separate PR:
+
-
+
- If the version strings in
Cargo.tomls haven’t been updated: +-
+
- Decide what the new version number
$VER_NUMshould be. ++
+Note: We always increment the minor number unless:
+-
+
- A major incompatibility has been introduced in this release: +increment the major number instead. +
- This release is a hotfix because the last one had a defect: +increment the patch number instead. +
+ - Update
Cargo.tomlanddownload/Cargo.tomlto have that same new +version number, then runcargo buildand reviewCargo.lockchanges. +If all looks well, make a commit.
+
+ - Decide what the new version number
- Update
CHANGELOG.mdaccordingly if necessary.
+
+ - If the version strings in
- [b/r] After merging the PR made in step 1, in a separate PR:
+
-
+
- Update the commit shasum in
rustup-init.shto match the latest commit +onmaster.
+
+ - Update the commit shasum in
- [b/r] After merging the PR made in step 2, sync
mastertostableusing +--ff-only: +-
+
git fetch origin master:master
+git checkout stable && git merge --ff-only master
+git push origin HEAD:stable
+
+ - [b/r] While you wait for green CI on
stable, double-check the +functionality ofrustup-init.shandrustup-initjust in case.
+ - [b/r] Ensure all of CI is green on the
stablebranch. +Once it is, check through a representative proportion of the builds looking +for the reported version statements to ensure that +we definitely built something cleanly which reports as the right version +number when run--version.
+ - [r] Make a new PR to the Rust Blog adding a new release announcement post. +
- [b/r] Ping someone in the release team to perform the actual release.
+They can find instructions in
ci/sync-dist.py. ++
+Note: Some manual testing occurs here, so hopefully they’ll catch +anything egregious in which case abort the change and roll back.
+
+ - [b] Once the beta release has happened, post a new topic named “Seeking beta +testers for Rustup $VER_NUM” on the Internals Forum. +
- [r] Once the official release has happened, prepare and push a tag on the
+latest
stablecommit. +-
+
git tag -as $VER_NUM -m $VER_NUM(optionally without-sif not GPG +signing the tag)
+git push origin $VER_NUM
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/tomorrow-night.css b/dev-guide/tomorrow-night.css
new file mode 100644
index 0000000000..81fe276e7f
--- /dev/null
+++ b/dev-guide/tomorrow-night.css
@@ -0,0 +1,102 @@
+/* Tomorrow Night Theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment {
+ color: #969896;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-regexp,
+.ruby .hljs-constant,
+.xml .hljs-tag .hljs-title,
+.xml .hljs-pi,
+.xml .hljs-doctype,
+.html .hljs-doctype,
+.css .hljs-id,
+.css .hljs-class,
+.css .hljs-pseudo {
+ color: #cc6666;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.hljs-built_in,
+.hljs-literal,
+.hljs-params,
+.hljs-constant {
+ color: #de935f;
+}
+
+/* Tomorrow Yellow */
+.ruby .hljs-class .hljs-title,
+.css .hljs-rule .hljs-attribute {
+ color: #f0c674;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-value,
+.hljs-inheritance,
+.hljs-header,
+.hljs-name,
+.ruby .hljs-symbol,
+.xml .hljs-cdata {
+ color: #b5bd68;
+}
+
+/* Tomorrow Aqua */
+.hljs-title,
+.css .hljs-hexcolor {
+ color: #8abeb7;
+}
+
+/* Tomorrow Blue */
+.hljs-function,
+.python .hljs-decorator,
+.python .hljs-title,
+.ruby .hljs-function .hljs-title,
+.ruby .hljs-title .hljs-keyword,
+.perl .hljs-sub,
+.javascript .hljs-title,
+.coffeescript .hljs-title {
+ color: #81a2be;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.javascript .hljs-function {
+ color: #b294bb;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #1d1f21;
+ color: #c5c8c6;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+ opacity: 0.5;
+}
+
+.hljs-addition {
+ color: #718c00;
+}
+
+.hljs-deletion {
+ color: #c82829;
+}
diff --git a/dev-guide/tracing.html b/dev-guide/tracing.html
new file mode 100644
index 0000000000..bcaedf855b
--- /dev/null
+++ b/dev-guide/tracing.html
@@ -0,0 +1,317 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Developer tips and tricks
+RUSTUP_FORCE_ARG0
+The environment variable RUSTUP_FORCE_ARG0 can be used to get rustup to think
+it’s a particular binary, rather than e.g. copying it, symlinking it or other
+tricks with exec. This is handy when testing particular code paths from cargo
+run.
RUSTUP_FORCE_ARG0=rustup cargo run -- uninstall nightly
+RUSTUP_BACKTRACK_LIMIT
+If it’s necessary to alter the backtracking limit from the default of half
+a release cycle for some reason, you can set the RUSTUP_BACKTRACK_LIMIT
+environment variable. If this is unparsable as an i32 or if it’s absent
+then the default of 21 days (half a cycle) is used. If it parses and is less
+than 1, it is clamped to 1 at minimum.
This is not meant for use by users, but can be suggested in diagnosing an issue +should one arise with the backtrack limits.
+RUSTUP_MAX_RETRIES
+When downloading a file, rustup will retry the download a number of times. The
+default is 3 times, but if this variable is set to a valid usize then it is the
+max retry count. A value of 0 means no retries, thus the default of 3 will
+mean a download is tried a total of four times before failing out.
RUSTUP_BACKTRACE
+By default while running tests, we unset some environment variables that will
+break our testing (like RUSTUP_TOOLCHAIN, SHELL, ZDOTDIR, RUST_BACKTRACE).
+But if you want to debug locally, you may need backtrace. RUSTUP_BACKTRACE
+is used like RUST_BACKTRACE to enable backtraces of failed tests.
NOTE: This is a backtrace for the test, not for any subprocess invocation of +rustup process running in the test
+$ RUSTUP_BACKTRACE=1 cargo test --release --test cli-v1 -- remove_toolchain_then_add_again
+ Finished release [optimized] target(s) in 0.38s
+ Running target\release\deps\cli_v1-1f29f824792f6dc1.exe
+
+running 1 test
+test remove_toolchain_then_add_again ... FAILED
+
+failures:
+
+---- remove_toolchain_then_add_again stdout ----
+thread 'remove_toolchain_then_add_again' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 1142, kind: Other, message: "An attempt was made to create more links on a file than the file system supports." }', src\libcore\result.rs:999:5
+stack backtrace:
+ 0: backtrace::backtrace::trace_unsynchronized
+ at C:\Users\appveyor\.cargo\registry\src\github.com-1ecc6299db9ec823\backtrace-0.3.29\src\backtrace\mod.rs:66
+ 1: std::sys_common::backtrace::_print
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\sys_common\backtrace.rs:47
+ 2: std::sys_common::backtrace::print
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\sys_common\backtrace.rs:36
+ 3: std::panicking::default_hook::{{closure}}
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:198
+ 4: std::panicking::default_hook
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:209
+ 5: std::panicking::rust_panic_with_hook
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:475
+ 6: std::panicking::continue_panic_fmt
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:382
+ 7: std::panicking::rust_begin_panic
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libstd\panicking.rs:309
+ 8: core::panicking::panic_fmt
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libcore\panicking.rs:85
+ 9: core::result::unwrap_failed
+ 10: cli_v1::mock::clitools::test
+ 11: alloc::boxed::{{impl}}::call_once<(),FnOnce<()>>
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\src\liballoc\boxed.rs:746
+ 12: panic_unwind::__rust_maybe_catch_panic
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libpanic_unwind\lib.rs:82
+ 13: std::panicking::try
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\src\libstd\panicking.rs:273
+ 14: std::panic::catch_unwind
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\src\libstd\panic.rs:388
+ 15: test::run_test::run_test_inner::{{closure}}
+ at /rustc/de02101e6d949c4a9040211e9ce8c488a997497e\/src\libtest\lib.rs:1466
+note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
+
+
+failures:
+ remove_toolchain_then_add_again
+
+test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 26 filtered out
+
+error: test failed, to rerun pass '--test cli-v1'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dev-guide/version-numbers.html b/dev-guide/version-numbers.html
new file mode 100644
index 0000000000..66d3597e40
--- /dev/null
+++ b/dev-guide/version-numbers.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Tracing
+Similar to other tools in the Rust ecosystem like rustc and cargo,
+rustup also provides observability/logging features via the tracing crate.
The verbosity of logs is controlled via the RUSTUP_LOG environment
+variable using tracing_subscriber’s directive syntax.
Console-based tracing
+A tracing_subscriber that prints log lines directly to stderr is directly
+available in the prebuilt version of rustup since v1.28.0.
For historical reasons, if RUSTUP_LOG is not set, this subscriber will print
+the log lines in a format that mimics the “legacy” stderr output in older
+versions of rustup:
> rustup default stable
+info: using existing install for 'stable-aarch64-apple-darwin'
+info: default toolchain set to 'stable-aarch64-apple-darwin'
+
+ stable-aarch64-apple-darwin unchanged - rustc 1.79.0 (129f3b996 2024-06-10)
+However, once RUSTUP_LOG is set to any value, rustup’s “custom logging mode” will
+be activated, and tracing_subscriber’s builtin output format will be used instead:
> RUSTUP_LOG=trace rustup default stable
+2024-06-16T12:08:48.732894Z INFO rustup::cli::common: using existing install for 'stable-aarch64-apple-darwin'
+2024-06-16T12:08:48.739232Z INFO rustup::cli::common: default toolchain set to 'stable-aarch64-apple-darwin'
+
+ stable-aarch64-apple-darwin unchanged - rustc 1.79.0 (129f3b996 2024-06-10)
+Please note that since RUSTUP_LOG=trace essentially accepts log lines from
+all possible sources, you might sometimes see log lines coming from rustup’s
+dependencies, such as hyper_util in the following example:
> RUSTUP_LOG=trace rustup update
+[..]
+2024-06-16T12:12:45.569428Z TRACE hyper_util::client::legacy::client: http1 handshake complete, spawning background dispatcher task
+2024-06-16T12:12:45.648682Z TRACE hyper_util::client::legacy::pool: pool dropped, dropping pooled (("https", static.rust-lang.org))
+
+ stable-aarch64-apple-darwin unchanged - rustc 1.79.0 (129f3b996 2024-06-10)
+ nightly-aarch64-apple-darwin unchanged - rustc 1.81.0-nightly (3cf924b93 2024-06-15)
+
+2024-06-16T12:12:45.693350Z INFO rustup::cli::rustup_mode: cleaning up downloads & tmp directories
+It is also possible to limit the sources of the log lines and the desired
+max level for each source. For example, set RUSTUP_LOG=rustup=DEBUG to
+receive log lines only from rustup itself with a max verbosity of DEBUG.
Opentelemetry tracing
+++Prerequisites: Before following the instructions in this section, +
+protocmust be installed, which can be downloaded from GitHub +or installed via a package manager.
The feature otel can be used when building rustup to turn on Opentelemetry
+tracing with an OLTP GRPC exporter.
This can be very useful for diagnosing performance or correctness issues in more +complicated scenarios.
+The normal OTLP environment +variables +can be used to customise its behaviour, but often the simplest thing is to just +run a Jaeger docker container on the same host:
+docker run -d --name jaeger -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 -e COLLECTOR_OTLP_ENABLED=true -p 6831:6831/udp -p 6832:6832/udp -p 5778:5778 -p 16686:16686 -p 4317:4317 -p 4318:4318 -p 14250:14250 -p 14268:14268 -p 14269:14269 -p 9411:9411 jaegertracing/all-in-one:latest
+Then build rustup-init with tracing:
cargo build --features=otel
+Run the operation you want to analyze. For example, we can now run rustup show with tracing:
RUSTUP_FORCE_ARG0="rustup" ./target/debug/rustup-init show
+And look in Jaeger for a trace.
+Tracing can also be used in tests to get a trace of the operations taken during the test.
+To use this feature, build the project with --features=otel,test.
Adding instrumentation
+The otel feature uses conditional compilation to only add function instrument
+when enabled. Instrumenting a currently uninstrumented function is mostly simply
+done like so:
+#![allow(unused)] +fn main() { +#[tracing::instrument(level = "trace", err(level = "trace"), skip_all)] +}
skip_all is not required, but some core structs don’t implement Debug yet, and
+others have a lot of output in Debug : tracing adds some overheads, so keeping
+spans lightweight can help avoid frequency bias in the results - where
+parameters with large debug in frequently called functions show up as much
+slower than they are.
Some good general heuristics:
+-
+
- Do instrument slow blocking functions +
- Do instrument functions with many callers or that call many different things, +as these tend to help figure the puzzle of what-is-happening +
- Default to not instrumenting thin shim functions (or at least, only instrument +them temporarily while figuring out the shape of a problem) +
- Be way of debug build timing - release optimisations make a huge difference, +though debug is a lot faster to iterate on. If something isn’t a problem in +release don’t pay it too much heed in debug. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/.nojekyll b/devel/.nojekyll
new file mode 100644
index 0000000000..f17311098f
--- /dev/null
+++ b/devel/.nojekyll
@@ -0,0 +1 @@
+This file makes sure that Github Pages doesn't process mdBook's output.
diff --git a/devel/404.html b/devel/404.html
new file mode 100644
index 0000000000..4069bd7833
--- /dev/null
+++ b/devel/404.html
@@ -0,0 +1,221 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Version numbers
+If you ever see a released version of rustup which has :: in its version string
+then something went wrong with the CI and that needs to be addressed.
We use git-testament to construct our version strings. This records, as a
+struct, details of the git commit, tag description, and also an indication
+of modifications to the working tree present when the binary was compiled.
During normal development you may get information from invoking rustup --version
+which looks like rustup-init 1.18.3+15 (a54051502 2019-05-26) or even
+rustup-init 1.18.3+15 (a54051502 2019-05-26) dirty 1 modification.
The first part is always the binary name as per clap’s normal operation. The
+version number is a combination of the most recent tag in the git repo, and the
+number of commits since that tag. The parenthesised information is, naturally,
+the SHA of the most recent commit and the date of that commit. If the indication
+of a dirty tree is present, the number of changes is indicated. This combines
+adds, deletes, modifies, and unknown entries.
You can request further information of a rustup binary with the
+rustup dump-testament hidden command. It produces output of the form:
$ rustup dump-testament
+Rustup version renders as: 1.18.3+15 (a54051502 2019-05-26) dirty 1 modification
+Current crate version: 1.18.3
+Built from branch: kinnison/version-strings
+Commit info: 1.18.3+15 (a54051502 2019-05-26)
+Modified: CONTRIBUTING.md
+This can be handy when you are testing development versions on your PC +and cannot remember exactly which version you had installed, or if you have given +a development copy (or instruction to build such) to a user, and wish to have them +confirm exactly what they are using.
+Finally, we tell git-testament that we trust the stable branch to carry
+releases. If the build is being performed when not on the stable branch, and
+the tag and CARGO_PKG_VERSION differ, then the short version string will include
+both, in the form rustup-init 1.18.3 :: 1.18.2+99 (a54051502 2019-05-26) which
+indicates the crate version before the rest of the commit.
+On the other hand, if the build was on the stable branch then regardless
+of the tag information, providing the commit was clean, the version is
+always replaced by the crate version. The dump-testament hidden command can
+reveal the truth however.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/FontAwesome/css/font-awesome.css b/devel/FontAwesome/css/font-awesome.css
new file mode 100644
index 0000000000..540440ce89
--- /dev/null
+++ b/devel/FontAwesome/css/font-awesome.css
@@ -0,0 +1,4 @@
+/*!
+ * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
+ * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
+ */@font-face{font-family:'FontAwesome';src:url('../fonts/fontawesome-webfont.eot?v=4.7.0');src:url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'),url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'),url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'),url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'),url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');font-weight:normal;font-style:normal}.fa{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571429em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14285714em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14285714em;width:2.14285714em;top:.14285714em;text-align:center}.fa-li.fa-lg{left:-1.85714286em}.fa-border{padding:.2em .25em .15em;border:solid .08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left{margin-right:.3em}.fa.fa-pull-right{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left{margin-right:.3em}.fa.pull-right{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:"\f000"}.fa-music:before{content:"\f001"}.fa-search:before{content:"\f002"}.fa-envelope-o:before{content:"\f003"}.fa-heart:before{content:"\f004"}.fa-star:before{content:"\f005"}.fa-star-o:before{content:"\f006"}.fa-user:before{content:"\f007"}.fa-film:before{content:"\f008"}.fa-th-large:before{content:"\f009"}.fa-th:before{content:"\f00a"}.fa-th-list:before{content:"\f00b"}.fa-check:before{content:"\f00c"}.fa-remove:before,.fa-close:before,.fa-times:before{content:"\f00d"}.fa-search-plus:before{content:"\f00e"}.fa-search-minus:before{content:"\f010"}.fa-power-off:before{content:"\f011"}.fa-signal:before{content:"\f012"}.fa-gear:before,.fa-cog:before{content:"\f013"}.fa-trash-o:before{content:"\f014"}.fa-home:before{content:"\f015"}.fa-file-o:before{content:"\f016"}.fa-clock-o:before{content:"\f017"}.fa-road:before{content:"\f018"}.fa-download:before{content:"\f019"}.fa-arrow-circle-o-down:before{content:"\f01a"}.fa-arrow-circle-o-up:before{content:"\f01b"}.fa-inbox:before{content:"\f01c"}.fa-play-circle-o:before{content:"\f01d"}.fa-rotate-right:before,.fa-repeat:before{content:"\f01e"}.fa-refresh:before{content:"\f021"}.fa-list-alt:before{content:"\f022"}.fa-lock:before{content:"\f023"}.fa-flag:before{content:"\f024"}.fa-headphones:before{content:"\f025"}.fa-volume-off:before{content:"\f026"}.fa-volume-down:before{content:"\f027"}.fa-volume-up:before{content:"\f028"}.fa-qrcode:before{content:"\f029"}.fa-barcode:before{content:"\f02a"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-book:before{content:"\f02d"}.fa-bookmark:before{content:"\f02e"}.fa-print:before{content:"\f02f"}.fa-camera:before{content:"\f030"}.fa-font:before{content:"\f031"}.fa-bold:before{content:"\f032"}.fa-italic:before{content:"\f033"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-align-left:before{content:"\f036"}.fa-align-center:before{content:"\f037"}.fa-align-right:before{content:"\f038"}.fa-align-justify:before{content:"\f039"}.fa-list:before{content:"\f03a"}.fa-dedent:before,.fa-outdent:before{content:"\f03b"}.fa-indent:before{content:"\f03c"}.fa-video-camera:before{content:"\f03d"}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:"\f03e"}.fa-pencil:before{content:"\f040"}.fa-map-marker:before{content:"\f041"}.fa-adjust:before{content:"\f042"}.fa-tint:before{content:"\f043"}.fa-edit:before,.fa-pencil-square-o:before{content:"\f044"}.fa-share-square-o:before{content:"\f045"}.fa-check-square-o:before{content:"\f046"}.fa-arrows:before{content:"\f047"}.fa-step-backward:before{content:"\f048"}.fa-fast-backward:before{content:"\f049"}.fa-backward:before{content:"\f04a"}.fa-play:before{content:"\f04b"}.fa-pause:before{content:"\f04c"}.fa-stop:before{content:"\f04d"}.fa-forward:before{content:"\f04e"}.fa-fast-forward:before{content:"\f050"}.fa-step-forward:before{content:"\f051"}.fa-eject:before{content:"\f052"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-plus-circle:before{content:"\f055"}.fa-minus-circle:before{content:"\f056"}.fa-times-circle:before{content:"\f057"}.fa-check-circle:before{content:"\f058"}.fa-question-circle:before{content:"\f059"}.fa-info-circle:before{content:"\f05a"}.fa-crosshairs:before{content:"\f05b"}.fa-times-circle-o:before{content:"\f05c"}.fa-check-circle-o:before{content:"\f05d"}.fa-ban:before{content:"\f05e"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrow-down:before{content:"\f063"}.fa-mail-forward:before,.fa-share:before{content:"\f064"}.fa-expand:before{content:"\f065"}.fa-compress:before{content:"\f066"}.fa-plus:before{content:"\f067"}.fa-minus:before{content:"\f068"}.fa-asterisk:before{content:"\f069"}.fa-exclamation-circle:before{content:"\f06a"}.fa-gift:before{content:"\f06b"}.fa-leaf:before{content:"\f06c"}.fa-fire:before{content:"\f06d"}.fa-eye:before{content:"\f06e"}.fa-eye-slash:before{content:"\f070"}.fa-warning:before,.fa-exclamation-triangle:before{content:"\f071"}.fa-plane:before{content:"\f072"}.fa-calendar:before{content:"\f073"}.fa-random:before{content:"\f074"}.fa-comment:before{content:"\f075"}.fa-magnet:before{content:"\f076"}.fa-chevron-up:before{content:"\f077"}.fa-chevron-down:before{content:"\f078"}.fa-retweet:before{content:"\f079"}.fa-shopping-cart:before{content:"\f07a"}.fa-folder:before{content:"\f07b"}.fa-folder-open:before{content:"\f07c"}.fa-arrows-v:before{content:"\f07d"}.fa-arrows-h:before{content:"\f07e"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:"\f080"}.fa-twitter-square:before{content:"\f081"}.fa-facebook-square:before{content:"\f082"}.fa-camera-retro:before{content:"\f083"}.fa-key:before{content:"\f084"}.fa-gears:before,.fa-cogs:before{content:"\f085"}.fa-comments:before{content:"\f086"}.fa-thumbs-o-up:before{content:"\f087"}.fa-thumbs-o-down:before{content:"\f088"}.fa-star-half:before{content:"\f089"}.fa-heart-o:before{content:"\f08a"}.fa-sign-out:before{content:"\f08b"}.fa-linkedin-square:before{content:"\f08c"}.fa-thumb-tack:before{content:"\f08d"}.fa-external-link:before{content:"\f08e"}.fa-sign-in:before{content:"\f090"}.fa-trophy:before{content:"\f091"}.fa-github-square:before{content:"\f092"}.fa-upload:before{content:"\f093"}.fa-lemon-o:before{content:"\f094"}.fa-phone:before{content:"\f095"}.fa-square-o:before{content:"\f096"}.fa-bookmark-o:before{content:"\f097"}.fa-phone-square:before{content:"\f098"}.fa-twitter:before{content:"\f099"}.fa-facebook-f:before,.fa-facebook:before{content:"\f09a"}.fa-github:before{content:"\f09b"}.fa-unlock:before{content:"\f09c"}.fa-credit-card:before{content:"\f09d"}.fa-feed:before,.fa-rss:before{content:"\f09e"}.fa-hdd-o:before{content:"\f0a0"}.fa-bullhorn:before{content:"\f0a1"}.fa-bell:before{content:"\f0f3"}.fa-certificate:before{content:"\f0a3"}.fa-hand-o-right:before{content:"\f0a4"}.fa-hand-o-left:before{content:"\f0a5"}.fa-hand-o-up:before{content:"\f0a6"}.fa-hand-o-down:before{content:"\f0a7"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-globe:before{content:"\f0ac"}.fa-wrench:before{content:"\f0ad"}.fa-tasks:before{content:"\f0ae"}.fa-filter:before{content:"\f0b0"}.fa-briefcase:before{content:"\f0b1"}.fa-arrows-alt:before{content:"\f0b2"}.fa-group:before,.fa-users:before{content:"\f0c0"}.fa-chain:before,.fa-link:before{content:"\f0c1"}.fa-cloud:before{content:"\f0c2"}.fa-flask:before{content:"\f0c3"}.fa-cut:before,.fa-scissors:before{content:"\f0c4"}.fa-copy:before,.fa-files-o:before{content:"\f0c5"}.fa-paperclip:before{content:"\f0c6"}.fa-save:before,.fa-floppy-o:before{content:"\f0c7"}.fa-square:before{content:"\f0c8"}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:"\f0c9"}.fa-list-ul:before{content:"\f0ca"}.fa-list-ol:before{content:"\f0cb"}.fa-strikethrough:before{content:"\f0cc"}.fa-underline:before{content:"\f0cd"}.fa-table:before{content:"\f0ce"}.fa-magic:before{content:"\f0d0"}.fa-truck:before{content:"\f0d1"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-square:before{content:"\f0d3"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-plus:before{content:"\f0d5"}.fa-money:before{content:"\f0d6"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-up:before{content:"\f0d8"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-columns:before{content:"\f0db"}.fa-unsorted:before,.fa-sort:before{content:"\f0dc"}.fa-sort-down:before,.fa-sort-desc:before{content:"\f0dd"}.fa-sort-up:before,.fa-sort-asc:before{content:"\f0de"}.fa-envelope:before{content:"\f0e0"}.fa-linkedin:before{content:"\f0e1"}.fa-rotate-left:before,.fa-undo:before{content:"\f0e2"}.fa-legal:before,.fa-gavel:before{content:"\f0e3"}.fa-dashboard:before,.fa-tachometer:before{content:"\f0e4"}.fa-comment-o:before{content:"\f0e5"}.fa-comments-o:before{content:"\f0e6"}.fa-flash:before,.fa-bolt:before{content:"\f0e7"}.fa-sitemap:before{content:"\f0e8"}.fa-umbrella:before{content:"\f0e9"}.fa-paste:before,.fa-clipboard:before{content:"\f0ea"}.fa-lightbulb-o:before{content:"\f0eb"}.fa-exchange:before{content:"\f0ec"}.fa-cloud-download:before{content:"\f0ed"}.fa-cloud-upload:before{content:"\f0ee"}.fa-user-md:before{content:"\f0f0"}.fa-stethoscope:before{content:"\f0f1"}.fa-suitcase:before{content:"\f0f2"}.fa-bell-o:before{content:"\f0a2"}.fa-coffee:before{content:"\f0f4"}.fa-cutlery:before{content:"\f0f5"}.fa-file-text-o:before{content:"\f0f6"}.fa-building-o:before{content:"\f0f7"}.fa-hospital-o:before{content:"\f0f8"}.fa-ambulance:before{content:"\f0f9"}.fa-medkit:before{content:"\f0fa"}.fa-fighter-jet:before{content:"\f0fb"}.fa-beer:before{content:"\f0fc"}.fa-h-square:before{content:"\f0fd"}.fa-plus-square:before{content:"\f0fe"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angle-down:before{content:"\f107"}.fa-desktop:before{content:"\f108"}.fa-laptop:before{content:"\f109"}.fa-tablet:before{content:"\f10a"}.fa-mobile-phone:before,.fa-mobile:before{content:"\f10b"}.fa-circle-o:before{content:"\f10c"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-spinner:before{content:"\f110"}.fa-circle:before{content:"\f111"}.fa-mail-reply:before,.fa-reply:before{content:"\f112"}.fa-github-alt:before{content:"\f113"}.fa-folder-o:before{content:"\f114"}.fa-folder-open-o:before{content:"\f115"}.fa-smile-o:before{content:"\f118"}.fa-frown-o:before{content:"\f119"}.fa-meh-o:before{content:"\f11a"}.fa-gamepad:before{content:"\f11b"}.fa-keyboard-o:before{content:"\f11c"}.fa-flag-o:before{content:"\f11d"}.fa-flag-checkered:before{content:"\f11e"}.fa-terminal:before{content:"\f120"}.fa-code:before{content:"\f121"}.fa-mail-reply-all:before,.fa-reply-all:before{content:"\f122"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:"\f123"}.fa-location-arrow:before{content:"\f124"}.fa-crop:before{content:"\f125"}.fa-code-fork:before{content:"\f126"}.fa-unlink:before,.fa-chain-broken:before{content:"\f127"}.fa-question:before{content:"\f128"}.fa-info:before{content:"\f129"}.fa-exclamation:before{content:"\f12a"}.fa-superscript:before{content:"\f12b"}.fa-subscript:before{content:"\f12c"}.fa-eraser:before{content:"\f12d"}.fa-puzzle-piece:before{content:"\f12e"}.fa-microphone:before{content:"\f130"}.fa-microphone-slash:before{content:"\f131"}.fa-shield:before{content:"\f132"}.fa-calendar-o:before{content:"\f133"}.fa-fire-extinguisher:before{content:"\f134"}.fa-rocket:before{content:"\f135"}.fa-maxcdn:before{content:"\f136"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-html5:before{content:"\f13b"}.fa-css3:before{content:"\f13c"}.fa-anchor:before{content:"\f13d"}.fa-unlock-alt:before{content:"\f13e"}.fa-bullseye:before{content:"\f140"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-rss-square:before{content:"\f143"}.fa-play-circle:before{content:"\f144"}.fa-ticket:before{content:"\f145"}.fa-minus-square:before{content:"\f146"}.fa-minus-square-o:before{content:"\f147"}.fa-level-up:before{content:"\f148"}.fa-level-down:before{content:"\f149"}.fa-check-square:before{content:"\f14a"}.fa-pencil-square:before{content:"\f14b"}.fa-external-link-square:before{content:"\f14c"}.fa-share-square:before{content:"\f14d"}.fa-compass:before{content:"\f14e"}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:"\f150"}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:"\f151"}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:"\f152"}.fa-euro:before,.fa-eur:before{content:"\f153"}.fa-gbp:before{content:"\f154"}.fa-dollar:before,.fa-usd:before{content:"\f155"}.fa-rupee:before,.fa-inr:before{content:"\f156"}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:"\f157"}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:"\f158"}.fa-won:before,.fa-krw:before{content:"\f159"}.fa-bitcoin:before,.fa-btc:before{content:"\f15a"}.fa-file:before{content:"\f15b"}.fa-file-text:before{content:"\f15c"}.fa-sort-alpha-asc:before{content:"\f15d"}.fa-sort-alpha-desc:before{content:"\f15e"}.fa-sort-amount-asc:before{content:"\f160"}.fa-sort-amount-desc:before{content:"\f161"}.fa-sort-numeric-asc:before{content:"\f162"}.fa-sort-numeric-desc:before{content:"\f163"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbs-down:before{content:"\f165"}.fa-youtube-square:before{content:"\f166"}.fa-youtube:before{content:"\f167"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-youtube-play:before{content:"\f16a"}.fa-dropbox:before{content:"\f16b"}.fa-stack-overflow:before{content:"\f16c"}.fa-instagram:before{content:"\f16d"}.fa-flickr:before{content:"\f16e"}.fa-adn:before{content:"\f170"}.fa-bitbucket:before{content:"\f171"}.fa-bitbucket-square:before{content:"\f172"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-long-arrow-down:before{content:"\f175"}.fa-long-arrow-up:before{content:"\f176"}.fa-long-arrow-left:before{content:"\f177"}.fa-long-arrow-right:before{content:"\f178"}.fa-apple:before{content:"\f179"}.fa-windows:before{content:"\f17a"}.fa-android:before{content:"\f17b"}.fa-linux:before{content:"\f17c"}.fa-dribbble:before{content:"\f17d"}.fa-skype:before{content:"\f17e"}.fa-foursquare:before{content:"\f180"}.fa-trello:before{content:"\f181"}.fa-female:before{content:"\f182"}.fa-male:before{content:"\f183"}.fa-gittip:before,.fa-gratipay:before{content:"\f184"}.fa-sun-o:before{content:"\f185"}.fa-moon-o:before{content:"\f186"}.fa-archive:before{content:"\f187"}.fa-bug:before{content:"\f188"}.fa-vk:before{content:"\f189"}.fa-weibo:before{content:"\f18a"}.fa-renren:before{content:"\f18b"}.fa-pagelines:before{content:"\f18c"}.fa-stack-exchange:before{content:"\f18d"}.fa-arrow-circle-o-right:before{content:"\f18e"}.fa-arrow-circle-o-left:before{content:"\f190"}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:"\f191"}.fa-dot-circle-o:before{content:"\f192"}.fa-wheelchair:before{content:"\f193"}.fa-vimeo-square:before{content:"\f194"}.fa-turkish-lira:before,.fa-try:before{content:"\f195"}.fa-plus-square-o:before{content:"\f196"}.fa-space-shuttle:before{content:"\f197"}.fa-slack:before{content:"\f198"}.fa-envelope-square:before{content:"\f199"}.fa-wordpress:before{content:"\f19a"}.fa-openid:before{content:"\f19b"}.fa-institution:before,.fa-bank:before,.fa-university:before{content:"\f19c"}.fa-mortar-board:before,.fa-graduation-cap:before{content:"\f19d"}.fa-yahoo:before{content:"\f19e"}.fa-google:before{content:"\f1a0"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-square:before{content:"\f1a2"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-stumbleupon:before{content:"\f1a4"}.fa-delicious:before{content:"\f1a5"}.fa-digg:before{content:"\f1a6"}.fa-pied-piper-pp:before{content:"\f1a7"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-drupal:before{content:"\f1a9"}.fa-joomla:before{content:"\f1aa"}.fa-language:before{content:"\f1ab"}.fa-fax:before{content:"\f1ac"}.fa-building:before{content:"\f1ad"}.fa-child:before{content:"\f1ae"}.fa-paw:before{content:"\f1b0"}.fa-spoon:before{content:"\f1b1"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-recycle:before{content:"\f1b8"}.fa-automobile:before,.fa-car:before{content:"\f1b9"}.fa-cab:before,.fa-taxi:before{content:"\f1ba"}.fa-tree:before{content:"\f1bb"}.fa-spotify:before{content:"\f1bc"}.fa-deviantart:before{content:"\f1bd"}.fa-soundcloud:before{content:"\f1be"}.fa-database:before{content:"\f1c0"}.fa-file-pdf-o:before{content:"\f1c1"}.fa-file-word-o:before{content:"\f1c2"}.fa-file-excel-o:before{content:"\f1c3"}.fa-file-powerpoint-o:before{content:"\f1c4"}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:"\f1c5"}.fa-file-zip-o:before,.fa-file-archive-o:before{content:"\f1c6"}.fa-file-sound-o:before,.fa-file-audio-o:before{content:"\f1c7"}.fa-file-movie-o:before,.fa-file-video-o:before{content:"\f1c8"}.fa-file-code-o:before{content:"\f1c9"}.fa-vine:before{content:"\f1ca"}.fa-codepen:before{content:"\f1cb"}.fa-jsfiddle:before{content:"\f1cc"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:"\f1cd"}.fa-circle-o-notch:before{content:"\f1ce"}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:"\f1d0"}.fa-ge:before,.fa-empire:before{content:"\f1d1"}.fa-git-square:before{content:"\f1d2"}.fa-git:before{content:"\f1d3"}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:"\f1d4"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-qq:before{content:"\f1d6"}.fa-wechat:before,.fa-weixin:before{content:"\f1d7"}.fa-send:before,.fa-paper-plane:before{content:"\f1d8"}.fa-send-o:before,.fa-paper-plane-o:before{content:"\f1d9"}.fa-history:before{content:"\f1da"}.fa-circle-thin:before{content:"\f1db"}.fa-header:before{content:"\f1dc"}.fa-paragraph:before{content:"\f1dd"}.fa-sliders:before{content:"\f1de"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-bomb:before{content:"\f1e2"}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:"\f1e3"}.fa-tty:before{content:"\f1e4"}.fa-binoculars:before{content:"\f1e5"}.fa-plug:before{content:"\f1e6"}.fa-slideshare:before{content:"\f1e7"}.fa-twitch:before{content:"\f1e8"}.fa-yelp:before{content:"\f1e9"}.fa-newspaper-o:before{content:"\f1ea"}.fa-wifi:before{content:"\f1eb"}.fa-calculator:before{content:"\f1ec"}.fa-paypal:before{content:"\f1ed"}.fa-google-wallet:before{content:"\f1ee"}.fa-cc-visa:before{content:"\f1f0"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-bell-slash:before{content:"\f1f6"}.fa-bell-slash-o:before{content:"\f1f7"}.fa-trash:before{content:"\f1f8"}.fa-copyright:before{content:"\f1f9"}.fa-at:before{content:"\f1fa"}.fa-eyedropper:before{content:"\f1fb"}.fa-paint-brush:before{content:"\f1fc"}.fa-birthday-cake:before{content:"\f1fd"}.fa-area-chart:before{content:"\f1fe"}.fa-pie-chart:before{content:"\f200"}.fa-line-chart:before{content:"\f201"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-bicycle:before{content:"\f206"}.fa-bus:before{content:"\f207"}.fa-ioxhost:before{content:"\f208"}.fa-angellist:before{content:"\f209"}.fa-cc:before{content:"\f20a"}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:"\f20b"}.fa-meanpath:before{content:"\f20c"}.fa-buysellads:before{content:"\f20d"}.fa-connectdevelop:before{content:"\f20e"}.fa-dashcube:before{content:"\f210"}.fa-forumbee:before{content:"\f211"}.fa-leanpub:before{content:"\f212"}.fa-sellsy:before{content:"\f213"}.fa-shirtsinbulk:before{content:"\f214"}.fa-simplybuilt:before{content:"\f215"}.fa-skyatlas:before{content:"\f216"}.fa-cart-plus:before{content:"\f217"}.fa-cart-arrow-down:before{content:"\f218"}.fa-diamond:before{content:"\f219"}.fa-ship:before{content:"\f21a"}.fa-user-secret:before{content:"\f21b"}.fa-motorcycle:before{content:"\f21c"}.fa-street-view:before{content:"\f21d"}.fa-heartbeat:before{content:"\f21e"}.fa-venus:before{content:"\f221"}.fa-mars:before{content:"\f222"}.fa-mercury:before{content:"\f223"}.fa-intersex:before,.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-venus-double:before{content:"\f226"}.fa-mars-double:before{content:"\f227"}.fa-venus-mars:before{content:"\f228"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-neuter:before{content:"\f22c"}.fa-genderless:before{content:"\f22d"}.fa-facebook-official:before{content:"\f230"}.fa-pinterest-p:before{content:"\f231"}.fa-whatsapp:before{content:"\f232"}.fa-server:before{content:"\f233"}.fa-user-plus:before{content:"\f234"}.fa-user-times:before{content:"\f235"}.fa-hotel:before,.fa-bed:before{content:"\f236"}.fa-viacoin:before{content:"\f237"}.fa-train:before{content:"\f238"}.fa-subway:before{content:"\f239"}.fa-medium:before{content:"\f23a"}.fa-yc:before,.fa-y-combinator:before{content:"\f23b"}.fa-optin-monster:before{content:"\f23c"}.fa-opencart:before{content:"\f23d"}.fa-expeditedssl:before{content:"\f23e"}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:"\f240"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:"\f241"}.fa-battery-2:before,.fa-battery-half:before{content:"\f242"}.fa-battery-1:before,.fa-battery-quarter:before{content:"\f243"}.fa-battery-0:before,.fa-battery-empty:before{content:"\f244"}.fa-mouse-pointer:before{content:"\f245"}.fa-i-cursor:before{content:"\f246"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-sticky-note:before{content:"\f249"}.fa-sticky-note-o:before{content:"\f24a"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-diners-club:before{content:"\f24c"}.fa-clone:before{content:"\f24d"}.fa-balance-scale:before{content:"\f24e"}.fa-hourglass-o:before{content:"\f250"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:"\f251"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:"\f253"}.fa-hourglass:before{content:"\f254"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:"\f255"}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:"\f256"}.fa-hand-scissors-o:before{content:"\f257"}.fa-hand-lizard-o:before{content:"\f258"}.fa-hand-spock-o:before{content:"\f259"}.fa-hand-pointer-o:before{content:"\f25a"}.fa-hand-peace-o:before{content:"\f25b"}.fa-trademark:before{content:"\f25c"}.fa-registered:before{content:"\f25d"}.fa-creative-commons:before{content:"\f25e"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-tripadvisor:before{content:"\f262"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-get-pocket:before{content:"\f265"}.fa-wikipedia-w:before{content:"\f266"}.fa-safari:before{content:"\f267"}.fa-chrome:before{content:"\f268"}.fa-firefox:before{content:"\f269"}.fa-opera:before{content:"\f26a"}.fa-internet-explorer:before{content:"\f26b"}.fa-tv:before,.fa-television:before{content:"\f26c"}.fa-contao:before{content:"\f26d"}.fa-500px:before{content:"\f26e"}.fa-amazon:before{content:"\f270"}.fa-calendar-plus-o:before{content:"\f271"}.fa-calendar-minus-o:before{content:"\f272"}.fa-calendar-times-o:before{content:"\f273"}.fa-calendar-check-o:before{content:"\f274"}.fa-industry:before{content:"\f275"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-map-o:before{content:"\f278"}.fa-map:before{content:"\f279"}.fa-commenting:before{content:"\f27a"}.fa-commenting-o:before{content:"\f27b"}.fa-houzz:before{content:"\f27c"}.fa-vimeo:before{content:"\f27d"}.fa-black-tie:before{content:"\f27e"}.fa-fonticons:before{content:"\f280"}.fa-reddit-alien:before{content:"\f281"}.fa-edge:before{content:"\f282"}.fa-credit-card-alt:before{content:"\f283"}.fa-codiepie:before{content:"\f284"}.fa-modx:before{content:"\f285"}.fa-fort-awesome:before{content:"\f286"}.fa-usb:before{content:"\f287"}.fa-product-hunt:before{content:"\f288"}.fa-mixcloud:before{content:"\f289"}.fa-scribd:before{content:"\f28a"}.fa-pause-circle:before{content:"\f28b"}.fa-pause-circle-o:before{content:"\f28c"}.fa-stop-circle:before{content:"\f28d"}.fa-stop-circle-o:before{content:"\f28e"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-hashtag:before{content:"\f292"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-percent:before{content:"\f295"}.fa-gitlab:before{content:"\f296"}.fa-wpbeginner:before{content:"\f297"}.fa-wpforms:before{content:"\f298"}.fa-envira:before{content:"\f299"}.fa-universal-access:before{content:"\f29a"}.fa-wheelchair-alt:before{content:"\f29b"}.fa-question-circle-o:before{content:"\f29c"}.fa-blind:before{content:"\f29d"}.fa-audio-description:before{content:"\f29e"}.fa-volume-control-phone:before{content:"\f2a0"}.fa-braille:before{content:"\f2a1"}.fa-assistive-listening-systems:before{content:"\f2a2"}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:"\f2a3"}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:"\f2a4"}.fa-glide:before{content:"\f2a5"}.fa-glide-g:before{content:"\f2a6"}.fa-signing:before,.fa-sign-language:before{content:"\f2a7"}.fa-low-vision:before{content:"\f2a8"}.fa-viadeo:before{content:"\f2a9"}.fa-viadeo-square:before{content:"\f2aa"}.fa-snapchat:before{content:"\f2ab"}.fa-snapchat-ghost:before{content:"\f2ac"}.fa-snapchat-square:before{content:"\f2ad"}.fa-pied-piper:before{content:"\f2ae"}.fa-first-order:before{content:"\f2b0"}.fa-yoast:before{content:"\f2b1"}.fa-themeisle:before{content:"\f2b2"}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:"\f2b3"}.fa-fa:before,.fa-font-awesome:before{content:"\f2b4"}.fa-handshake-o:before{content:"\f2b5"}.fa-envelope-open:before{content:"\f2b6"}.fa-envelope-open-o:before{content:"\f2b7"}.fa-linode:before{content:"\f2b8"}.fa-address-book:before{content:"\f2b9"}.fa-address-book-o:before{content:"\f2ba"}.fa-vcard:before,.fa-address-card:before{content:"\f2bb"}.fa-vcard-o:before,.fa-address-card-o:before{content:"\f2bc"}.fa-user-circle:before{content:"\f2bd"}.fa-user-circle-o:before{content:"\f2be"}.fa-user-o:before{content:"\f2c0"}.fa-id-badge:before{content:"\f2c1"}.fa-drivers-license:before,.fa-id-card:before{content:"\f2c2"}.fa-drivers-license-o:before,.fa-id-card-o:before{content:"\f2c3"}.fa-quora:before{content:"\f2c4"}.fa-free-code-camp:before{content:"\f2c5"}.fa-telegram:before{content:"\f2c6"}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:"\f2c7"}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:"\f2c8"}.fa-thermometer-2:before,.fa-thermometer-half:before{content:"\f2c9"}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:"\f2ca"}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:"\f2cb"}.fa-shower:before{content:"\f2cc"}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:"\f2cd"}.fa-podcast:before{content:"\f2ce"}.fa-window-maximize:before{content:"\f2d0"}.fa-window-minimize:before{content:"\f2d1"}.fa-window-restore:before{content:"\f2d2"}.fa-times-rectangle:before,.fa-window-close:before{content:"\f2d3"}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:"\f2d4"}.fa-bandcamp:before{content:"\f2d5"}.fa-grav:before{content:"\f2d6"}.fa-etsy:before{content:"\f2d7"}.fa-imdb:before{content:"\f2d8"}.fa-ravelry:before{content:"\f2d9"}.fa-eercast:before{content:"\f2da"}.fa-microchip:before{content:"\f2db"}.fa-snowflake-o:before{content:"\f2dc"}.fa-superpowers:before{content:"\f2dd"}.fa-wpexplorer:before{content:"\f2de"}.fa-meetup:before{content:"\f2e0"}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}
diff --git a/devel/FontAwesome/fonts/FontAwesome.ttf b/devel/FontAwesome/fonts/FontAwesome.ttf
new file mode 100644
index 0000000000..35acda2fa1
Binary files /dev/null and b/devel/FontAwesome/fonts/FontAwesome.ttf differ
diff --git a/devel/FontAwesome/fonts/fontawesome-webfont.eot b/devel/FontAwesome/fonts/fontawesome-webfont.eot
new file mode 100644
index 0000000000..e9f60ca953
Binary files /dev/null and b/devel/FontAwesome/fonts/fontawesome-webfont.eot differ
diff --git a/devel/FontAwesome/fonts/fontawesome-webfont.svg b/devel/FontAwesome/fonts/fontawesome-webfont.svg
new file mode 100644
index 0000000000..855c845e53
--- /dev/null
+++ b/devel/FontAwesome/fonts/fontawesome-webfont.svg
@@ -0,0 +1,2671 @@
+
+
+
diff --git a/devel/FontAwesome/fonts/fontawesome-webfont.ttf b/devel/FontAwesome/fonts/fontawesome-webfont.ttf
new file mode 100644
index 0000000000..35acda2fa1
Binary files /dev/null and b/devel/FontAwesome/fonts/fontawesome-webfont.ttf differ
diff --git a/devel/FontAwesome/fonts/fontawesome-webfont.woff b/devel/FontAwesome/fonts/fontawesome-webfont.woff
new file mode 100644
index 0000000000..400014a4b0
Binary files /dev/null and b/devel/FontAwesome/fonts/fontawesome-webfont.woff differ
diff --git a/devel/FontAwesome/fonts/fontawesome-webfont.woff2 b/devel/FontAwesome/fonts/fontawesome-webfont.woff2
new file mode 100644
index 0000000000..4d13fc6040
Binary files /dev/null and b/devel/FontAwesome/fonts/fontawesome-webfont.woff2 differ
diff --git a/devel/ayu-highlight.css b/devel/ayu-highlight.css
new file mode 100644
index 0000000000..32c9432224
--- /dev/null
+++ b/devel/ayu-highlight.css
@@ -0,0 +1,78 @@
+/*
+Based off of the Ayu theme
+Original by Dempfi (https://github.com/dempfi/ayu)
+*/
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #191f26;
+ color: #e6e1cf;
+}
+
+.hljs-comment,
+.hljs-quote {
+ color: #5c6773;
+ font-style: italic;
+}
+
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-attr,
+.hljs-regexp,
+.hljs-link,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #ff7733;
+}
+
+.hljs-number,
+.hljs-meta,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #ffee99;
+}
+
+.hljs-string,
+.hljs-bullet {
+ color: #b8cc52;
+}
+
+.hljs-title,
+.hljs-built_in,
+.hljs-section {
+ color: #ffb454;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-symbol {
+ color: #ff7733;
+}
+
+.hljs-name {
+ color: #36a3d9;
+}
+
+.hljs-tag {
+ color: #00568d;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #91b362;
+}
+
+.hljs-deletion {
+ color: #d96c75;
+}
diff --git a/devel/basics.html b/devel/basics.html
new file mode 100644
index 0000000000..04f9352ffb
--- /dev/null
+++ b/devel/basics.html
@@ -0,0 +1,285 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/book.js b/devel/book.js
new file mode 100644
index 0000000000..aa12e7eccf
--- /dev/null
+++ b/devel/book.js
@@ -0,0 +1,697 @@
+"use strict";
+
+// Fix back button cache problem
+window.onunload = function () { };
+
+// Global variable, shared between modules
+function playground_text(playground, hidden = true) {
+ let code_block = playground.querySelector("code");
+
+ if (window.ace && code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ return editor.getValue();
+ } else if (hidden) {
+ return code_block.textContent;
+ } else {
+ return code_block.innerText;
+ }
+}
+
+(function codeSnippets() {
+ function fetch_with_timeout(url, options, timeout = 6000) {
+ return Promise.race([
+ fetch(url, options),
+ new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), timeout))
+ ]);
+ }
+
+ var playgrounds = Array.from(document.querySelectorAll(".playground"));
+ if (playgrounds.length > 0) {
+ fetch_with_timeout("https://play.rust-lang.org/meta/crates", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ })
+ .then(response => response.json())
+ .then(response => {
+ // get list of crates available in the rust playground
+ let playground_crates = response.crates.map(item => item["id"]);
+ playgrounds.forEach(block => handle_crate_list_update(block, playground_crates));
+ });
+ }
+
+ function handle_crate_list_update(playground_block, playground_crates) {
+ // update the play buttons after receiving the response
+ update_play_button(playground_block, playground_crates);
+
+ // and install on change listener to dynamically update ACE editors
+ if (window.ace) {
+ let code_block = playground_block.querySelector("code");
+ if (code_block.classList.contains("editable")) {
+ let editor = window.ace.edit(code_block);
+ editor.addEventListener("change", function (e) {
+ update_play_button(playground_block, playground_crates);
+ });
+ // add Ctrl-Enter command to execute rust code
+ editor.commands.addCommand({
+ name: "run",
+ bindKey: {
+ win: "Ctrl-Enter",
+ mac: "Ctrl-Enter"
+ },
+ exec: _editor => run_rust_code(playground_block)
+ });
+ }
+ }
+ }
+
+ // updates the visibility of play button based on `no_run` class and
+ // used crates vs ones available on https://play.rust-lang.org
+ function update_play_button(pre_block, playground_crates) {
+ var play_button = pre_block.querySelector(".play-button");
+
+ // skip if code is `no_run`
+ if (pre_block.querySelector('code').classList.contains("no_run")) {
+ play_button.classList.add("hidden");
+ return;
+ }
+
+ // get list of `extern crate`'s from snippet
+ var txt = playground_text(pre_block);
+ var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
+ var snippet_crates = [];
+ var item;
+ while (item = re.exec(txt)) {
+ snippet_crates.push(item[1]);
+ }
+
+ // check if all used crates are available on play.rust-lang.org
+ var all_available = snippet_crates.every(function (elem) {
+ return playground_crates.indexOf(elem) > -1;
+ });
+
+ if (all_available) {
+ play_button.classList.remove("hidden");
+ } else {
+ play_button.classList.add("hidden");
+ }
+ }
+
+ function run_rust_code(code_block) {
+ var result_block = code_block.querySelector(".result");
+ if (!result_block) {
+ result_block = document.createElement('code');
+ result_block.className = 'result hljs language-bash';
+
+ code_block.append(result_block);
+ }
+
+ let text = playground_text(code_block);
+ let classes = code_block.querySelector('code').classList;
+ let edition = "2015";
+ if(classes.contains("edition2018")) {
+ edition = "2018";
+ } else if(classes.contains("edition2021")) {
+ edition = "2021";
+ }
+ var params = {
+ version: "stable",
+ optimize: "0",
+ code: text,
+ edition: edition
+ };
+
+ if (text.indexOf("#![feature") !== -1) {
+ params.version = "nightly";
+ }
+
+ result_block.innerText = "Running...";
+
+ fetch_with_timeout("https://play.rust-lang.org/evaluate.json", {
+ headers: {
+ 'Content-Type': "application/json",
+ },
+ method: 'POST',
+ mode: 'cors',
+ body: JSON.stringify(params)
+ })
+ .then(response => response.json())
+ .then(response => {
+ if (response.result.trim() === '') {
+ result_block.innerText = "No output";
+ result_block.classList.add("result-no-output");
+ } else {
+ result_block.innerText = response.result;
+ result_block.classList.remove("result-no-output");
+ }
+ })
+ .catch(error => result_block.innerText = "Playground Communication: " + error.message);
+ }
+
+ // Syntax highlighting Configuration
+ hljs.configure({
+ tabReplace: ' ', // 4 spaces
+ languages: [], // Languages used for auto-detection
+ });
+
+ let code_nodes = Array
+ .from(document.querySelectorAll('code'))
+ // Don't highlight `inline code` blocks in headers.
+ .filter(function (node) {return !node.parentElement.classList.contains("header"); });
+
+ if (window.ace) {
+ // language-rust class needs to be removed for editable
+ // blocks or highlightjs will capture events
+ code_nodes
+ .filter(function (node) {return node.classList.contains("editable"); })
+ .forEach(function (block) { block.classList.remove('language-rust'); });
+
+ code_nodes
+ .filter(function (node) {return !node.classList.contains("editable"); })
+ .forEach(function (block) { hljs.highlightBlock(block); });
+ } else {
+ code_nodes.forEach(function (block) { hljs.highlightBlock(block); });
+ }
+
+ // Adding the hljs class gives code blocks the color css
+ // even if highlighting doesn't apply
+ code_nodes.forEach(function (block) { block.classList.add('hljs'); });
+
+ Array.from(document.querySelectorAll("code.hljs")).forEach(function (block) {
+
+ var lines = Array.from(block.querySelectorAll('.boring'));
+ // If no lines were hidden, return
+ if (!lines.length) { return; }
+ block.classList.add("hide-boring");
+
+ var buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ buttons.innerHTML = "";
+
+ // add expand button
+ var pre_block = block.parentNode;
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+
+ pre_block.querySelector('.buttons').addEventListener('click', function (e) {
+ if (e.target.classList.contains('fa-eye')) {
+ e.target.classList.remove('fa-eye');
+ e.target.classList.add('fa-eye-slash');
+ e.target.title = 'Hide lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.remove('hide-boring');
+ } else if (e.target.classList.contains('fa-eye-slash')) {
+ e.target.classList.remove('fa-eye-slash');
+ e.target.classList.add('fa-eye');
+ e.target.title = 'Show hidden lines';
+ e.target.setAttribute('aria-label', e.target.title);
+
+ block.classList.add('hide-boring');
+ }
+ });
+ });
+
+ if (window.playground_copyable) {
+ Array.from(document.querySelectorAll('pre code')).forEach(function (block) {
+ var pre_block = block.parentNode;
+ if (!pre_block.classList.contains('playground')) {
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var clipButton = document.createElement('button');
+ clipButton.className = 'fa fa-copy clip-button';
+ clipButton.title = 'Copy to clipboard';
+ clipButton.setAttribute('aria-label', clipButton.title);
+ clipButton.innerHTML = '';
+
+ buttons.insertBefore(clipButton, buttons.firstChild);
+ }
+ });
+ }
+
+ // Process playground code blocks
+ Array.from(document.querySelectorAll(".playground")).forEach(function (pre_block) {
+ // Add play button
+ var buttons = pre_block.querySelector(".buttons");
+ if (!buttons) {
+ buttons = document.createElement('div');
+ buttons.className = 'buttons';
+ pre_block.insertBefore(buttons, pre_block.firstChild);
+ }
+
+ var runCodeButton = document.createElement('button');
+ runCodeButton.className = 'fa fa-play play-button';
+ runCodeButton.hidden = true;
+ runCodeButton.title = 'Run this code';
+ runCodeButton.setAttribute('aria-label', runCodeButton.title);
+
+ buttons.insertBefore(runCodeButton, buttons.firstChild);
+ runCodeButton.addEventListener('click', function (e) {
+ run_rust_code(pre_block);
+ });
+
+ if (window.playground_copyable) {
+ var copyCodeClipboardButton = document.createElement('button');
+ copyCodeClipboardButton.className = 'fa fa-copy clip-button';
+ copyCodeClipboardButton.innerHTML = '';
+ copyCodeClipboardButton.title = 'Copy to clipboard';
+ copyCodeClipboardButton.setAttribute('aria-label', copyCodeClipboardButton.title);
+
+ buttons.insertBefore(copyCodeClipboardButton, buttons.firstChild);
+ }
+
+ let code_block = pre_block.querySelector("code");
+ if (window.ace && code_block.classList.contains("editable")) {
+ var undoChangesButton = document.createElement('button');
+ undoChangesButton.className = 'fa fa-history reset-button';
+ undoChangesButton.title = 'Undo changes';
+ undoChangesButton.setAttribute('aria-label', undoChangesButton.title);
+
+ buttons.insertBefore(undoChangesButton, buttons.firstChild);
+
+ undoChangesButton.addEventListener('click', function () {
+ let editor = window.ace.edit(code_block);
+ editor.setValue(editor.originalCode);
+ editor.clearSelection();
+ });
+ }
+ });
+})();
+
+(function themes() {
+ var html = document.querySelector('html');
+ var themeToggleButton = document.getElementById('theme-toggle');
+ var themePopup = document.getElementById('theme-list');
+ var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
+ var stylesheets = {
+ ayuHighlight: document.querySelector("[href$='ayu-highlight.css']"),
+ tomorrowNight: document.querySelector("[href$='tomorrow-night.css']"),
+ highlight: document.querySelector("[href$='highlight.css']"),
+ };
+
+ function showThemes() {
+ themePopup.style.display = 'block';
+ themeToggleButton.setAttribute('aria-expanded', true);
+ themePopup.querySelector("button#" + get_theme()).focus();
+ }
+
+ function updateThemeSelected() {
+ themePopup.querySelectorAll('.theme-selected').forEach(function (el) {
+ el.classList.remove('theme-selected');
+ });
+ themePopup.querySelector("button#" + get_theme()).classList.add('theme-selected');
+ }
+
+ function hideThemes() {
+ themePopup.style.display = 'none';
+ themeToggleButton.setAttribute('aria-expanded', false);
+ themeToggleButton.focus();
+ }
+
+ function get_theme() {
+ var theme;
+ try { theme = localStorage.getItem('mdbook-theme'); } catch (e) { }
+ if (theme === null || theme === undefined) {
+ return default_theme;
+ } else {
+ return theme;
+ }
+ }
+
+ function set_theme(theme, store = true) {
+ let ace_theme;
+
+ if (theme == 'coal' || theme == 'navy') {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = false;
+ stylesheets.highlight.disabled = true;
+
+ ace_theme = "ace/theme/tomorrow_night";
+ } else if (theme == 'ayu') {
+ stylesheets.ayuHighlight.disabled = false;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = true;
+ ace_theme = "ace/theme/tomorrow_night";
+ } else {
+ stylesheets.ayuHighlight.disabled = true;
+ stylesheets.tomorrowNight.disabled = true;
+ stylesheets.highlight.disabled = false;
+ ace_theme = "ace/theme/dawn";
+ }
+
+ setTimeout(function () {
+ themeColorMetaTag.content = getComputedStyle(document.documentElement).backgroundColor;
+ }, 1);
+
+ if (window.ace && window.editors) {
+ window.editors.forEach(function (editor) {
+ editor.setTheme(ace_theme);
+ });
+ }
+
+ var previousTheme = get_theme();
+
+ if (store) {
+ try { localStorage.setItem('mdbook-theme', theme); } catch (e) { }
+ }
+
+ html.classList.remove(previousTheme);
+ html.classList.add(theme);
+ updateThemeSelected();
+ }
+
+ // Set theme
+ var theme = get_theme();
+
+ set_theme(theme, false);
+
+ themeToggleButton.addEventListener('click', function () {
+ if (themePopup.style.display === 'block') {
+ hideThemes();
+ } else {
+ showThemes();
+ }
+ });
+
+ themePopup.addEventListener('click', function (e) {
+ var theme;
+ if (e.target.className === "theme") {
+ theme = e.target.id;
+ } else if (e.target.parentElement.className === "theme") {
+ theme = e.target.parentElement.id;
+ } else {
+ return;
+ }
+ set_theme(theme);
+ });
+
+ themePopup.addEventListener('focusout', function(e) {
+ // e.relatedTarget is null in Safari and Firefox on macOS (see workaround below)
+ if (!!e.relatedTarget && !themeToggleButton.contains(e.relatedTarget) && !themePopup.contains(e.relatedTarget)) {
+ hideThemes();
+ }
+ });
+
+ // Should not be needed, but it works around an issue on macOS & iOS: https://github.com/rust-lang/mdBook/issues/628
+ document.addEventListener('click', function(e) {
+ if (themePopup.style.display === 'block' && !themeToggleButton.contains(e.target) && !themePopup.contains(e.target)) {
+ hideThemes();
+ }
+ });
+
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (!themePopup.contains(e.target)) { return; }
+
+ switch (e.key) {
+ case 'Escape':
+ e.preventDefault();
+ hideThemes();
+ break;
+ case 'ArrowUp':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.previousElementSibling) {
+ li.previousElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'ArrowDown':
+ e.preventDefault();
+ var li = document.activeElement.parentElement;
+ if (li && li.nextElementSibling) {
+ li.nextElementSibling.querySelector('button').focus();
+ }
+ break;
+ case 'Home':
+ e.preventDefault();
+ themePopup.querySelector('li:first-child button').focus();
+ break;
+ case 'End':
+ e.preventDefault();
+ themePopup.querySelector('li:last-child button').focus();
+ break;
+ }
+ });
+})();
+
+(function sidebar() {
+ var body = document.querySelector("body");
+ var sidebar = document.getElementById("sidebar");
+ var sidebarLinks = document.querySelectorAll('#sidebar a');
+ var sidebarToggleButton = document.getElementById("sidebar-toggle");
+ var sidebarResizeHandle = document.getElementById("sidebar-resize-handle");
+ var firstContact = null;
+
+ function showSidebar() {
+ body.classList.remove('sidebar-hidden')
+ body.classList.add('sidebar-visible');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', 0);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', true);
+ sidebar.setAttribute('aria-hidden', false);
+ try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
+ }
+
+
+ var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
+
+ function toggleSection(ev) {
+ ev.currentTarget.parentElement.classList.toggle('expanded');
+ }
+
+ Array.from(sidebarAnchorToggles).forEach(function (el) {
+ el.addEventListener('click', toggleSection);
+ });
+
+ function hideSidebar() {
+ body.classList.remove('sidebar-visible')
+ body.classList.add('sidebar-hidden');
+ Array.from(sidebarLinks).forEach(function (link) {
+ link.setAttribute('tabIndex', -1);
+ });
+ sidebarToggleButton.setAttribute('aria-expanded', false);
+ sidebar.setAttribute('aria-hidden', true);
+ try { localStorage.setItem('mdbook-sidebar', 'hidden'); } catch (e) { }
+ }
+
+ // Toggle sidebar
+ sidebarToggleButton.addEventListener('click', function sidebarToggle() {
+ if (body.classList.contains("sidebar-hidden")) {
+ var current_width = parseInt(
+ document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
+ if (current_width < 150) {
+ document.documentElement.style.setProperty('--sidebar-width', '150px');
+ }
+ showSidebar();
+ } else if (body.classList.contains("sidebar-visible")) {
+ hideSidebar();
+ } else {
+ if (getComputedStyle(sidebar)['transform'] === 'none') {
+ hideSidebar();
+ } else {
+ showSidebar();
+ }
+ }
+ });
+
+ sidebarResizeHandle.addEventListener('mousedown', initResize, false);
+
+ function initResize(e) {
+ window.addEventListener('mousemove', resize, false);
+ window.addEventListener('mouseup', stopResize, false);
+ body.classList.add('sidebar-resizing');
+ }
+ function resize(e) {
+ var pos = (e.clientX - sidebar.offsetLeft);
+ if (pos < 20) {
+ hideSidebar();
+ } else {
+ if (body.classList.contains("sidebar-hidden")) {
+ showSidebar();
+ }
+ pos = Math.min(pos, window.innerWidth - 100);
+ document.documentElement.style.setProperty('--sidebar-width', pos + 'px');
+ }
+ }
+ //on mouseup remove windows functions mousemove & mouseup
+ function stopResize(e) {
+ body.classList.remove('sidebar-resizing');
+ window.removeEventListener('mousemove', resize, false);
+ window.removeEventListener('mouseup', stopResize, false);
+ }
+
+ document.addEventListener('touchstart', function (e) {
+ firstContact = {
+ x: e.touches[0].clientX,
+ time: Date.now()
+ };
+ }, { passive: true });
+
+ document.addEventListener('touchmove', function (e) {
+ if (!firstContact)
+ return;
+
+ var curX = e.touches[0].clientX;
+ var xDiff = curX - firstContact.x,
+ tDiff = Date.now() - firstContact.time;
+
+ if (tDiff < 250 && Math.abs(xDiff) >= 150) {
+ if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
+ showSidebar();
+ else if (xDiff < 0 && curX < 300)
+ hideSidebar();
+
+ firstContact = null;
+ }
+ }, { passive: true });
+})();
+
+(function chapterNavigation() {
+ document.addEventListener('keydown', function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
+ if (window.search && window.search.hasFocus()) { return; }
+ var html = document.querySelector('html');
+
+ function next() {
+ var nextButton = document.querySelector('.nav-chapters.next');
+ if (nextButton) {
+ window.location.href = nextButton.href;
+ }
+ }
+ function prev() {
+ var previousButton = document.querySelector('.nav-chapters.previous');
+ if (previousButton) {
+ window.location.href = previousButton.href;
+ }
+ }
+ switch (e.key) {
+ case 'ArrowRight':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ prev();
+ } else {
+ next();
+ }
+ break;
+ case 'ArrowLeft':
+ e.preventDefault();
+ if (html.dir == 'rtl') {
+ next();
+ } else {
+ prev();
+ }
+ break;
+ }
+ });
+})();
+
+(function clipboard() {
+ var clipButtons = document.querySelectorAll('.clip-button');
+
+ function hideTooltip(elem) {
+ elem.firstChild.innerText = "";
+ elem.className = 'fa fa-copy clip-button';
+ }
+
+ function showTooltip(elem, msg) {
+ elem.firstChild.innerText = msg;
+ elem.className = 'fa fa-copy tooltipped';
+ }
+
+ var clipboardSnippets = new ClipboardJS('.clip-button', {
+ text: function (trigger) {
+ hideTooltip(trigger);
+ let playground = trigger.closest("pre");
+ return playground_text(playground, false);
+ }
+ });
+
+ Array.from(clipButtons).forEach(function (clipButton) {
+ clipButton.addEventListener('mouseout', function (e) {
+ hideTooltip(e.currentTarget);
+ });
+ });
+
+ clipboardSnippets.on('success', function (e) {
+ e.clearSelection();
+ showTooltip(e.trigger, "Copied!");
+ });
+
+ clipboardSnippets.on('error', function (e) {
+ showTooltip(e.trigger, "Clipboard error!");
+ });
+})();
+
+(function scrollToTop () {
+ var menuTitle = document.querySelector('.menu-title');
+
+ menuTitle.addEventListener('click', function () {
+ document.scrollingElement.scrollTo({ top: 0, behavior: 'smooth' });
+ });
+})();
+
+(function controllMenu() {
+ var menu = document.getElementById('menu-bar');
+
+ (function controllPosition() {
+ var scrollTop = document.scrollingElement.scrollTop;
+ var prevScrollTop = scrollTop;
+ var minMenuY = -menu.clientHeight - 50;
+ // When the script loads, the page can be at any scroll (e.g. if you reforesh it).
+ menu.style.top = scrollTop + 'px';
+ // Same as parseInt(menu.style.top.slice(0, -2), but faster
+ var topCache = menu.style.top.slice(0, -2);
+ menu.classList.remove('sticky');
+ var stickyCache = false; // Same as menu.classList.contains('sticky'), but faster
+ document.addEventListener('scroll', function () {
+ scrollTop = Math.max(document.scrollingElement.scrollTop, 0);
+ // `null` means that it doesn't need to be updated
+ var nextSticky = null;
+ var nextTop = null;
+ var scrollDown = scrollTop > prevScrollTop;
+ var menuPosAbsoluteY = topCache - scrollTop;
+ if (scrollDown) {
+ nextSticky = false;
+ if (menuPosAbsoluteY > 0) {
+ nextTop = prevScrollTop;
+ }
+ } else {
+ if (menuPosAbsoluteY > 0) {
+ nextSticky = true;
+ } else if (menuPosAbsoluteY < minMenuY) {
+ nextTop = prevScrollTop + minMenuY;
+ }
+ }
+ if (nextSticky === true && stickyCache === false) {
+ menu.classList.add('sticky');
+ stickyCache = true;
+ } else if (nextSticky === false && stickyCache === true) {
+ menu.classList.remove('sticky');
+ stickyCache = false;
+ }
+ if (nextTop !== null) {
+ menu.style.top = nextTop + 'px';
+ topCache = nextTop;
+ }
+ prevScrollTop = scrollTop;
+ }, { passive: true });
+ })();
+ (function controllBorder() {
+ function updateBorder() {
+ if (menu.offsetTop === 0) {
+ menu.classList.remove('bordered');
+ } else {
+ menu.classList.add('bordered');
+ }
+ }
+ updateBorder();
+ document.addEventListener('scroll', updateBorder, { passive: true });
+ })();
+})();
diff --git a/devel/clipboard.min.js b/devel/clipboard.min.js
new file mode 100644
index 0000000000..02c549e35c
--- /dev/null
+++ b/devel/clipboard.min.js
@@ -0,0 +1,7 @@
+/*!
+ * clipboard.js v2.0.4
+ * https://zenorocha.github.io/clipboard.js
+ *
+ * Licensed MIT © Zeno Rocha
+ */
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return function(n){var o={};function r(t){if(o[t])return o[t].exports;var e=o[t]={i:t,l:!1,exports:{}};return n[t].call(e.exports,e,e.exports,r),e.l=!0,e.exports}return r.m=n,r.c=o,r.d=function(t,e,n){r.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:n})},r.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return r.d(e,"a",e),e},r.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},r.p="",r(r.s=0)}([function(t,e,n){"use strict";var r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},i=function(){function o(t,e){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keeping
+
+
+
+
+ Basic usage
+Keeping Rust up to date
+Rust is distributed on three different release channels: stable, beta, and
+nightly. rustup uses the stable channel by default, which
+represents the latest release of Rust. Stable publishes new releases every six weeks.
When a new version of Rust is released, simply type rustup update to update:
$ rustup update
+info: syncing channel updates for 'stable'
+info: downloading component 'rustc'
+info: downloading component 'rust-std'
+info: downloading component 'rust-docs'
+info: downloading component 'cargo'
+info: installing component 'rustc'
+info: installing component 'rust-std'
+info: installing component 'rust-docs'
+info: installing component 'cargo'
+info: checking for self-update
+info: downloading self-update
+
+ stable updated: rustc 1.7.0 (a5d1e7a59 2016-02-29)
+
+Keeping rustup up to date
+If your rustup was built with the no-self-update feature, it can not update
+itself. This is not the default, and only versions of rustup built with
+--no-default-features, or obtained from a third-party distributor who has
+disabled it (such as NixOS).
Otherwise Rustup can update itself. It is possible to control Rustup’s automatic
+self update mechanism with the auto-self-update configuration variable. This
+setting supports three values: enable and disable and check-only.
-
+
disablewill ensure that no automatic self updating actions are taken.
+enablewill mean thatrustup updateand similar commands will also check for, and install, any update to Rustup.
+check-onlywill cause any automatic self update to check and report on any updates, but not to automatically install them.
+
Whether auto-self-update is enable or not, you can request that Rustup
+update itself to the latest version of rustup by running rustup self update.
+This will not download new toolchains:
$ rustup self update
+info: checking for self-update
+info: downloading self-update
+Disabling self updates on a per-invocation basis
+++Self updates can also be suppressed on individual invocations of
+rustupby +passing the argument--no-self-updatewhen runningrustup updateor +rustup toolchain install.
Help system
+The rustup command-line has a built-in help system that provides more
+information about each command. Run rustup help for an overview. Detailed
+help for each subcommand is also available. For example, run rustup toolchain install --help for specifics on installing toolchains.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/concepts/components.html b/devel/concepts/components.html
new file mode 100644
index 0000000000..f7a6aa6580
--- /dev/null
+++ b/devel/concepts/components.html
@@ -0,0 +1,296 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Channels
+Rust is released to three different “channels”: stable, beta, and nightly. The
+stable releases are made every 6 weeks (with occasional point releases). Beta
+releases are the version that will appear in the next stable release. Nightly
+releases are made every night. See The Rust Book for more details
+on Rust’s train release model. The release schedule is posted to the Rust
+Forge. rustup assists with installing different channels, keeping them
+up-to-date, and easily switching between them.
After a release channel has been installed, rustup can be used to update the
+installed version to the latest release on that channel. See the Keeping rust
+up to date section for more information.
rustup can also install specific versions of Rust, such as 1.45.2 or
+nightly-2020-07-27. See the Toolchains chapter for more information on
+installing different channels and releases. See the Overrides chapter for
+details on switching between toolchains and pinning your project to a specific
+toolchain.
Working with nightly Rust
+rustup gives you easy access to the nightly compiler and its experimental
+features. To add it just run rustup toolchain install nightly:
$ rustup toolchain install nightly
+info: syncing channel updates for 'nightly'
+info: downloading toolchain manifest
+info: downloading component 'rustc'
+info: downloading component 'rust-std'
+info: downloading component 'rust-docs'
+info: downloading component 'cargo'
+info: installing component 'rustc'
+info: installing component 'rust-std'
+info: installing component 'rust-docs'
+info: installing component 'cargo'
+
+ nightly installed: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now Rust nightly is installed, but not activated. To test it out you can run a +command from the nightly toolchain like
+$ rustup run nightly rustc --version
+rustc 1.9.0-nightly (02310fd31 2016-03-19)
+But more likely you want to use it for a while. To switch to nightly globally,
+change the default with rustup default nightly:
$ rustup default nightly
+info: using existing install for 'nightly'
+info: default toolchain set to 'nightly'
+
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now any time you run cargo or rustc you will be running the nightly
+compiler.
With nightly installed any time you run rustup update, the nightly channel
+will be updated in addition to stable:
$ rustup update
+info: syncing channel updates for 'stable'
+info: syncing channel updates for 'nightly'
+info: checking for self-update
+info: downloading self-update
+
+ stable unchanged: rustc 1.7.0 (a5d1e7a59 2016-02-29)
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Nightly availability
+Nightly toolchains may fail to build, so for any given date and target
+platform there may not be a toolchain available. Furthermore, nightly builds
+may be published with missing non-default components (such as clippy).
+As such, it can be difficult to find fully-working nightlies. Use the
+rustup-components-history project to find the build status of recent
+nightly toolchains and components.
When you attempt to install or update the nightly channel, rustup will
+check if a required or previously installed component is missing. If it is
+missing, rustup will automatically search for an older release that contains
+the required components. There are several ways to change this behavior:
-
+
- Use the
--forceflag torustup toolchain installto force it to install +the most recent version even if there is a missing component.
+ - Use the
--profileflag torustup toolchain installto use a different +profile that does not contain the missing component. For example, +--profile=minimalshould always work, as the minimal set is required to +exist. See the Profiles chapter for more detail.
+ - Install a specific date that contains the components you need. For example,
+
rustup toolchain install nightly-2020-07-27. You can then use overrides +to pin to that specific release.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/concepts/index.html b/devel/concepts/index.html
new file mode 100644
index 0000000000..896c63c832
--- /dev/null
+++ b/devel/concepts/index.html
@@ -0,0 +1,281 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Components
+Each toolchain has several “components”, some of which are required (like
+rustc) and some that are optional (like clippy). The rustup component command is used to manage the installed components. For example,
+run rustup component list to see a list of available and installed
+components.
Components can be added when installing a toolchain with the --component
+flag. For example:
rustup toolchain install nightly --component rust-docs
+Components can be added to an already-installed toolchain with the rustup component command:
rustup component add rust-docs
+To make it easier to choose which components are installed, rustup has the
+concept of “profiles” which provide named groupings of different components.
+See the Profiles chapter for more detail.
Most components have a target-triple suffix, such as
+rustc-x86_64-apple-darwin, to signify the platform the component is for.
The set of available components may vary with different releases and +toolchains. The following is an overview of the different components:
+-
+
rustc— The Rust compiler and Rustdoc.
+cargo— Cargo is a package manager and build tool.
+rustfmt— Rustfmt is a tool for automatically formatting code.
+rust-std— This is the Rust standard library. There is a separate +rust-stdcomponent for each target thatrustcsupports, such as +rust-std-x86_64-pc-windows-msvc. See the Cross-compilation chapter for +more detail.
+rust-docs— This is a local copy of the Rust documentation. Use the +rustup doccommand to open the documentation in a web browser. Runrustup doc --helpfor more options.
+rust-analyzer— rust-analyzer is a language server that provides support +for editors and IDEs.
+clippy— Clippy is a lint tool that provides extra checks for common +mistakes and stylistic choices.
+miri— Miri is an experimental Rust interpreter, which can be used for +checking for undefined-behavior.
+rust-src— This is a local copy of the source code of the Rust standard +library. This can be used by some tools, such as rust-analyzer, to provide +auto-completion for functions within the standard library; Miri which is a +Rust interpreter; and Cargo’s experimental build-std feature, which allows +you to rebuild the standard library locally.
+rust-mingw— This contains a linker and platform libraries for building on +thex86_64-pc-windows-gnuplatform.
+llvm-tools— This component contains a collection of LLVM tools. +Note that this component has not been stabilized and may change in the +future and is provided as-is. +See #85658.
+rustc-dev— This component contains the compiler as a library. Most users +will not need this; it is only needed for development of tools that link +to the compiler, such as making modifications to Clippy.
+
Previous components
+These components have been deprecated and are not published in new Rust releases.
+-
+
rls— RLS is a language server that is deprecated and has been replaced +by rust-analyzer.
+rust-analysis— Metadata about the standard library, used by RLS.
+
Component availability
+Not all components are available for all toolchains. Especially on the nightly +channel, some components may not be included if they are in a broken state. +The current status of all the components may be found on the rustup +components history page. See the Nightly availability section for more +details.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/concepts/profiles.html b/devel/concepts/profiles.html
new file mode 100644
index 0000000000..0d9320ddce
--- /dev/null
+++ b/devel/concepts/profiles.html
@@ -0,0 +1,266 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Concepts
+How rustup works
+rustup is a toolchain multiplexer. It installs and manages many Rust
+toolchains and presents them all through a single set of tools installed to
+~/.cargo/bin. The rustc and cargo executables installed in
+~/.cargo/bin are proxies that delegate to the real toolchain. rustup
+then provides mechanisms to easily change the active toolchain by
+reconfiguring the behavior of the proxies.
So when rustup is first installed, running rustc will run the proxy in
+$HOME/.cargo/bin/rustc, which in turn will run the stable compiler. If you
+later change the default toolchain to nightly with rustup default nightly,
+then that same proxy will run the nightly compiler instead.
This is similar to Ruby’s rbenv, Python’s pyenv, or Node’s nvm.
+Terminology
+-
+
-
+
channel — Rust is released to three different “channels”: stable, beta, +and nightly. See the Channels chapter for more details.
+
+ -
+
toolchain — A “toolchain” is a complete installation of the Rust +compiler (
+rustc) and related tools (likecargo). A toolchain +specification includes the release channel or version, and the host +platform that the toolchain runs on.
+ -
+
target —
+rustcis capable of generating code for many platforms. The +“target” specifies the platform that the code will be generated for. By +default,cargoandrustcuse the host toolchain’s platform as the +target. To build for a different target, usually the target’s standard +library needs to be installed first via therustup targetcommand. See the +Cross-compilation chapter for more details.
+ -
+
component — Each release of Rust includes several “components”, some of +which are required (like
+rustc) and some that are optional (like +clippy). See the Components chapter for more detail.
+ -
+
profile — In order to make it easier to work with components, a +“profile” defines a grouping of components. See the Profiles chapter for +more details.
+
+ -
+
proxy — A wrapper for a common Rust component (like
+rustc), built to forward +CLI invocations to the active Rust toolchain. See the Proxies chapter for more details.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/concepts/proxies.html b/devel/concepts/proxies.html
new file mode 100644
index 0000000000..2248ca5b63
--- /dev/null
+++ b/devel/concepts/proxies.html
@@ -0,0 +1,264 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Profiles
+rustup has the concept of “profiles”. They are groups of components you
+can choose to download while installing a new Rust toolchain. The profiles
+available at this time are minimal, default, and complete:
-
+
- The minimal profile includes as few components as possible to get a
+working compiler (
rustc,rust-std, andcargo). It’s recommended to use +this component on Windows systems if you don’t use local documentation (the +large number of files can cause issues with some Antivirus systems), and in +CI.
+ - The default profile includes all of components in the minimal
+profile, and adds
rust-docs,rustfmt, andclippy. This profile will be +used byrustupby default, and it’s the one recommended for general use.
+ - The complete profile includes all the components available through
+
rustup. This should never be used, as it includes every component ever +included in the metadata and thus will almost always fail. If you are +looking for a way to install devtools such asmirior IDE integration +tools (rust-analyzer), you should use thedefaultprofile and +install the needed additional components manually, either by usingrustup component addor by using-cwhen installing the toolchain.
+
To change the profile rustup install uses by default, you can use the
+rustup set profile command.
+For example, to select the minimal profile you can use:
rustup set profile minimal
+You can also directly select the profile used when installing a toolchain with:
+rustup install --profile <name>
+It’s also possible to choose the default profile when installing rustup for
+the first time, either interactively by choosing the “Customize installation”
+option or programmatically by passing the --profile=<name> flag. Profiles
+will only affect newly installed toolchains: as usual it will be possible to
+install individual components later with: rustup component add.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/concepts/toolchains.html b/devel/concepts/toolchains.html
new file mode 100644
index 0000000000..133565080b
--- /dev/null
+++ b/devel/concepts/toolchains.html
@@ -0,0 +1,279 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Proxies
+rustup provides a number of wrappers for common Rust tools.
+These are called proxies and represent commands which are
+provided by the various components.
The list of proxies is currently static in rustup and is as follows:
-
+
-
+
+rustcis the compiler for the Rust programming language, provided by the project itself and comes from therustccomponent.
+ -
+
+rustdocis a tool distributed in therustccomponent which helps you to generate documentation for Rust projects.
+ -
+
+cargois the Rust package manager which downloads your Rust package’s dependencies, compiles your packages, makes distributable packages, and uploads them to crates.io (the Rust community’s package registry). It comes from thecargocomponent.
+ -
+
+rust-lldb,rust-gdb, andrust-gdbguiare simple wrappers around thelldb,gdb, andgdbguidebuggers respectively. The wrappers enable some pretty-printing of Rust values and add some convenience features to the debuggers by means of their scripting interfaces.
+ -
+
+rust-analyzeris part of the Rust IDE integration tooling. It implements the language-server protocol to permit IDEs and editors such as Visual Studio Code, Vim, or Emacs, access to the semantics of the Rust code you are editing. It comes from therust-analyzercomponent.
+ -
+
+cargo-clippyandclippy-driverare related to theclippylinting tool which provides extra checks for common mistakes and stylistic choices and it comes from theclippycomponent.
+ -
+
+cargo-miriis an experimental interpreter for Rust’s mid-level intermediate representation (MIR) and it comes from themiricomponent.
+ -
+
+rlsis a deprecated IDE tool that has been replaced byrust-analyzer. It comes from therlscomponent.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/configuration.html b/devel/configuration.html
new file mode 100644
index 0000000000..c5687c5ee4
--- /dev/null
+++ b/devel/configuration.html
@@ -0,0 +1,241 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Toolchains
+Many rustup commands deal with toolchains, a single installation of the
+Rust compiler. rustup supports multiple types of toolchains. The most basic
+track the official release channels: stable, beta and nightly; but
+rustup can also install toolchains from the official archives, for alternate
+host platforms, and from local builds.
Toolchain specification
+Standard release channel toolchain names have the following form:
+<channel>[-<date>][-<host>]
+
+<channel> = stable|beta|nightly|<major.minor>|<major.minor.patch>
+<date> = YYYY-MM-DD
+<host> = <target-triple>
+‘channel’ is a named release channel, a major and minor version number such as
+1.42, or a fully specified version number, such as 1.42.0. Channel names
+can be optionally appended with an archive date, as in nightly-2014-12-18, in
+which case the toolchain is downloaded from the archive for that date.
Finally, the host may be specified as a target triple. This is most useful for +installing a 32-bit compiler on a 64-bit platform, or for installing the +MSVC-based toolchain on Windows. For example:
+$ rustup toolchain install stable-x86_64-pc-windows-msvc
+For convenience, elements of the target triple that are omitted will be +inferred, so the above could be written:
+$ rustup toolchain install stable-msvc
+Toolchain names that don’t name a channel instead can be used to name custom +toolchains.
+Custom toolchains
+For convenience of developers working on Rust itself, rustup can manage
+local builds of the Rust toolchain. To teach rustup about your build, run:
$ rustup toolchain link my-toolchain path/to/my/toolchain/sysroot
+For example, on Ubuntu you might clone rust-lang/rust into ~/rust, build
+it, and then run:
$ rustup toolchain link my-toolchain ~/rust/build/x86_64-unknown-linux-gnu/stage2/
+$ rustup default my-toolchain
+Now you can name my-toolchain as any other rustup toolchain. Create a
+rustup toolchain for each of your rust-lang/rust workspaces and test them
+easily with rustup run my-toolchain rustc.
Because the rust-lang/rust tree does not include Cargo, when cargo is
+invoked for a custom toolchain and it is not available, rustup will attempt
+to use cargo from one of the release channels, preferring ‘nightly’, then
+‘beta’ or ‘stable’.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/cross-compilation.html b/devel/cross-compilation.html
new file mode 100644
index 0000000000..3d64bb55bb
--- /dev/null
+++ b/devel/cross-compilation.html
@@ -0,0 +1,260 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Configuration
+Rustup has a TOML settings file at
+${RUSTUP_HOME}/settings.toml (which defaults to ~/.rustup or
+%USERPROFILE%/.rustup). The schema for this file is not part of the public
+interface for rustup - the rustup CLI should be used to query and set settings.
On Unix operating systems a fallback settings file is consulted for some
+settings. This fallback file is located at /etc/rustup/settings.toml and
+currently can define only default_toolchain.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/css/chrome.css b/devel/css/chrome.css
new file mode 100644
index 0000000000..8b78255de5
--- /dev/null
+++ b/devel/css/chrome.css
@@ -0,0 +1,606 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+@import 'variables.css';
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/devel/css/general.css b/devel/css/general.css
new file mode 100644
index 0000000000..e7d20da725
--- /dev/null
+++ b/devel/css/general.css
@@ -0,0 +1,234 @@
+/* Base styles and content styles */
+
+@import 'variables.css';
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/devel/css/print.css b/devel/css/print.css
new file mode 100644
index 0000000000..80ec3a5441
--- /dev/null
+++ b/devel/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/devel/css/variables.css b/devel/css/variables.css
new file mode 100644
index 0000000000..0da55e8c9a
--- /dev/null
+++ b/devel/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/devel/elasticlunr.min.js b/devel/elasticlunr.min.js
new file mode 100644
index 0000000000..94b20dd2ef
--- /dev/null
+++ b/devel/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Cross-compilation
+Rust supports a great number of platforms. For many of these platforms
+The Rust Project publishes binary releases of the standard library, and for
+some the full compiler. rustup gives easy access to all of them.
When you first install a toolchain, rustup installs only the standard
+library for your host platform - that is, the architecture and operating
+system you are presently running. To compile to other platforms you must
+install other target platforms. This is done with the rustup target add
+command. For example, to add the Android target:
$ rustup target add arm-linux-androideabi
+info: downloading component 'rust-std' for 'arm-linux-androideabi'
+info: installing component 'rust-std' for 'arm-linux-androideabi'
+With the arm-linux-androideabi target installed you can then build for
+Android with Cargo by passing the --target flag, as in cargo build --target=arm-linux-androideabi.
Note that rustup target add only installs the Rust standard library for a
+given target. There are typically other tools necessary to cross-compile,
+particularly a linker. For example, to cross compile to Android the Android
+NDK must be installed. In the future, rustup will provide assistance
+installing the NDK components as well. See the target section of the
+cargo configuration for how to setup a linker to use for a certain target.
To install a target for a toolchain that isn’t the default toolchain use the
+--toolchain argument of rustup target add, like so:
$ rustup target add --toolchain <toolchain> <target>...
+To see a list of available targets, rustup target list. To remove a
+previously-added target, rustup target remove.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/examples.html b/devel/examples.html
new file mode 100644
index 0000000000..e7646b55fe
--- /dev/null
+++ b/devel/examples.html
@@ -0,0 +1,251 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Environment variables
+-
+
-
+
+RUSTUP_LOG(default: none). Enables Rustup’s “custom logging mode”. In this mode, +the verbosity of Rustup’s log lines can be specified withtracing_subscriber’s +directive syntax. For example, setRUSTUP_LOG=rustup=DEBUGto receive log lines +fromrustupitself with a maximal verbosity ofDEBUG.
+ -
+
+RUSTUP_HOME(default:~/.rustupor%USERPROFILE%/.rustup). Sets the +rootrustupfolder, used for storing installed toolchains and +configuration options.
+ -
+
+RUSTUP_TOOLCHAIN(default: none). If set, will override the toolchain used +for all rust tool invocations. A toolchain with this name should be installed, +or invocations will fail. This can specify custom toolchains, installable +toolchains, or the absolute path to a toolchain.
+ -
+
+RUSTUP_DIST_SERVER(default:https://static.rust-lang.org). Sets the root +URL for downloading static resources related to Rust. You can change this to +instead use a local mirror, or to test the binaries from the staging +directory.
+ -
+
+RUSTUP_DIST_ROOThttps://static.rust-lang.org/dist). +UseRUSTUP_DIST_SERVERinstead.
+ -
+
+RUSTUP_UPDATE_ROOT(defaulthttps://static.rust-lang.org/rustup). Sets +the root URL for downloading self-update.
+ -
+
+RUSTUP_IO_THREADSunstable (defaults to reported cpu count). Sets the +number of threads to perform close IO in. Set to1to force +single-threaded IO for troubleshooting, or an arbitrary number to override +automatic detection.
+ -
+
+RUSTUP_TRACE_DIRunstable (default: no tracing). Enables tracing and +determines the directory that traces will be written too. Traces are of the +form PID.trace. Traces can be read by the Catapult project tracing viewer.
+ -
+
+RUSTUP_TERM_COLOR(default:auto). Controls whether colored output is used in the terminal. +Set toautoto use colors only in tty streams, toalwaysto always enable colors, +or toneverto disable colors.
+ -
+
+RUSTUP_UNPACK_RAMunstable (default free memory or 500MiB if unable to tell, min 210MiB). Caps the amount of +RAMrustupwill use for IO tasks while unpacking.
+ -
+
+RUSTUP_NO_BACKTRACE. Disables backtraces on non-panic errors even when +RUST_BACKTRACEis set.
+ -
+
+RUSTUP_PERMIT_COPY_RENAMEunstable. When set, allows rustup to fall-back +to copying files if attempts torenameresult in cross-device link +errors. These errors occur on OverlayFS, which is used by Docker. This +feature sacrifices some transactions protections and may be removed at any +point. Linux only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/faq.html b/devel/faq.html
new file mode 100644
index 0000000000..e225f8081c
--- /dev/null
+++ b/devel/faq.html
@@ -0,0 +1,249 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Examples
+| Command | Description |
|---|---|
rustup default nightly | Set the default toolchain to the latest nightly |
rustup set profile minimal | Set the default profile |
rustup target list | List all available targets for the active toolchain |
rustup target add arm-linux-androideabi | Install the Android target |
rustup target remove arm-linux-androideabi | Remove the Android target |
rustup run nightly rustc foo.rs | Run the nightly regardless of the active toolchain |
rustc +nightly foo.rs | Shorthand way to run a nightly compiler |
rustup run nightly bash | Run a shell configured for the nightly compiler |
rustup default stable-msvc | On Windows, use the MSVC toolchain instead of GNU |
rustup override set nightly-2015-04-01 | For the current directory, use a nightly from a specific date |
rustup toolchain link my-toolchain "C:\RustInstallation" | Install a custom toolchain by symlinking an existing installation |
rustup show | Show which toolchain will be used in the current directory |
rustup toolchain uninstall nightly | Uninstall a given toolchain |
rustup toolchain help | Show the help page for a subcommand (like toolchain) |
rustup man cargo | (Unix only) View the man page for a given command (like cargo) |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/favicon.png b/devel/favicon.png
new file mode 100644
index 0000000000..a5b1aa16c4
Binary files /dev/null and b/devel/favicon.png differ
diff --git a/devel/favicon.svg b/devel/favicon.svg
new file mode 100644
index 0000000000..90e0ea58bd
--- /dev/null
+++ b/devel/favicon.svg
@@ -0,0 +1,22 @@
+
+
diff --git a/devel/fonts/OPEN-SANS-LICENSE.txt b/devel/fonts/OPEN-SANS-LICENSE.txt
new file mode 100644
index 0000000000..d645695673
--- /dev/null
+++ b/devel/fonts/OPEN-SANS-LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/devel/fonts/SOURCE-CODE-PRO-LICENSE.txt b/devel/fonts/SOURCE-CODE-PRO-LICENSE.txt
new file mode 100644
index 0000000000..366206f549
--- /dev/null
+++ b/devel/fonts/SOURCE-CODE-PRO-LICENSE.txt
@@ -0,0 +1,93 @@
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/devel/fonts/fonts.css b/devel/fonts/fonts.css
new file mode 100644
index 0000000000..858efa5980
--- /dev/null
+++ b/devel/fonts/fonts.css
@@ -0,0 +1,100 @@
+/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
+/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
+
+/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 300;
+ src: local('Open Sans Light'), local('OpenSans-Light'),
+ url('open-sans-v17-all-charsets-300.woff2') format('woff2');
+}
+
+/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 300;
+ src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
+ url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
+}
+
+/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 400;
+ src: local('Open Sans Regular'), local('OpenSans-Regular'),
+ url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
+}
+
+/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 400;
+ src: local('Open Sans Italic'), local('OpenSans-Italic'),
+ url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
+}
+
+/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 600;
+ src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
+ url('open-sans-v17-all-charsets-600.woff2') format('woff2');
+}
+
+/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 600;
+ src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
+ url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
+}
+
+/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 700;
+ src: local('Open Sans Bold'), local('OpenSans-Bold'),
+ url('open-sans-v17-all-charsets-700.woff2') format('woff2');
+}
+
+/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 700;
+ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
+ url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
+}
+
+/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
+ url('open-sans-v17-all-charsets-800.woff2') format('woff2');
+}
+
+/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
+ url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
+}
+
+/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Source Code Pro';
+ font-style: normal;
+ font-weight: 500;
+ src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
+}
diff --git a/devel/fonts/open-sans-v17-all-charsets-300.woff2 b/devel/fonts/open-sans-v17-all-charsets-300.woff2
new file mode 100644
index 0000000000..9f51be370f
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-300.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-300italic.woff2 b/devel/fonts/open-sans-v17-all-charsets-300italic.woff2
new file mode 100644
index 0000000000..2f54544841
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-300italic.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-600.woff2 b/devel/fonts/open-sans-v17-all-charsets-600.woff2
new file mode 100644
index 0000000000..f503d558d5
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-600.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-600italic.woff2 b/devel/fonts/open-sans-v17-all-charsets-600italic.woff2
new file mode 100644
index 0000000000..c99aabe803
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-600italic.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-700.woff2 b/devel/fonts/open-sans-v17-all-charsets-700.woff2
new file mode 100644
index 0000000000..421a1ab25f
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-700.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-700italic.woff2 b/devel/fonts/open-sans-v17-all-charsets-700italic.woff2
new file mode 100644
index 0000000000..12ce3d20d1
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-700italic.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-800.woff2 b/devel/fonts/open-sans-v17-all-charsets-800.woff2
new file mode 100644
index 0000000000..c94a223b03
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-800.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-800italic.woff2 b/devel/fonts/open-sans-v17-all-charsets-800italic.woff2
new file mode 100644
index 0000000000..eed7d3c63d
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-800italic.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-italic.woff2 b/devel/fonts/open-sans-v17-all-charsets-italic.woff2
new file mode 100644
index 0000000000..398b68a085
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-italic.woff2 differ
diff --git a/devel/fonts/open-sans-v17-all-charsets-regular.woff2 b/devel/fonts/open-sans-v17-all-charsets-regular.woff2
new file mode 100644
index 0000000000..8383e94c65
Binary files /dev/null and b/devel/fonts/open-sans-v17-all-charsets-regular.woff2 differ
diff --git a/devel/fonts/source-code-pro-v11-all-charsets-500.woff2 b/devel/fonts/source-code-pro-v11-all-charsets-500.woff2
new file mode 100644
index 0000000000..722245682f
Binary files /dev/null and b/devel/fonts/source-code-pro-v11-all-charsets-500.woff2 differ
diff --git a/devel/highlight.css b/devel/highlight.css
new file mode 100644
index 0000000000..ba57b82b27
--- /dev/null
+++ b/devel/highlight.css
@@ -0,0 +1,82 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/devel/highlight.js b/devel/highlight.js
new file mode 100644
index 0000000000..3256c00ed3
--- /dev/null
+++ b/devel/highlight.js
@@ -0,0 +1,53 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ rustup exited successfully but I can’t run
+
+
+
+
+ FAQ
+Is this an official Rust project?
+Yes. rustup is an official Rust project. It is the recommended way to install +Rust at https://www.rust-lang.org.
+How is this related to multirust?
+rustup is the successor to multirust. rustup began as multirust-rs, a +rewrite of multirust from shell script to Rust, by Diggory Blake, and is now +maintained by The Rust Project.
+Can rustup download the Rust source code?
+The source for Rust’s standard library can be obtained by running rustup component add rust-src. It will be downloaded to the <toolchain root>/lib/rustlib/src/rust directory of the current toolchain.
The source for the compiler and tools must be obtained from the Rust +repository or the standalone source tarballs.
+rustup fails with Windows error 32
+If rustup fails with Windows error 32, it may be due to antivirus scanning
+in the background. Disable antivirus scanner and try again.
I get “error: could not remove ‘rustup-bin’ file: ‘C:\Users\USER\.cargo\bin\rustup.exe’”
+If rustup fails to self-update in this way it’s usually because RLS is
+running (your editor is open and running RLS). The solution is to stop RLS (by
+closing your editor) and try again.
rustup exited successfully but I can’t run rustc --version
+Restart your shell. This will reload your PATH environment
+variable to include Cargo’s bin directory ($CARGO_HOME/bin).
":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/installation/already-installed-rust.html b/devel/installation/already-installed-rust.html
new file mode 100644
index 0000000000..122012c753
--- /dev/null
+++ b/devel/installation/already-installed-rust.html
@@ -0,0 +1,254 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+rustup installs The Rust Programming Language from the official +release channels, enabling you to easily switch between stable, beta, and +nightly compilers and keep them updated. It makes cross-compiling simpler with +binary builds of the standard library for common platforms. And it runs on all +platforms Rust supports.
+Check out the Concepts chapter for an overview of how rustup works and some +of the terminology it uses. The Installation chapter covers installing +rustup and getting started.
+The source code of rustup and this manual may be found at +https://github.com/rust-lang/rustup. If you find a problem, check out the +issue tracker.
+Release notes for rustup may be found in the CHANGELOG.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/installation/images/component-msvc.png b/devel/installation/images/component-msvc.png
new file mode 100644
index 0000000000..db301d6be7
Binary files /dev/null and b/devel/installation/images/component-msvc.png differ
diff --git a/devel/installation/images/component-sdk.png b/devel/installation/images/component-sdk.png
new file mode 100644
index 0000000000..f4d11f0e21
Binary files /dev/null and b/devel/installation/images/component-sdk.png differ
diff --git a/devel/installation/images/step1.png b/devel/installation/images/step1.png
new file mode 100644
index 0000000000..d450b05211
Binary files /dev/null and b/devel/installation/images/step1.png differ
diff --git a/devel/installation/images/step2.png b/devel/installation/images/step2.png
new file mode 100644
index 0000000000..c5daca1f4d
Binary files /dev/null and b/devel/installation/images/step2.png differ
diff --git a/devel/installation/images/step3.png b/devel/installation/images/step3.png
new file mode 100644
index 0000000000..04ce4913dd
Binary files /dev/null and b/devel/installation/images/step3.png differ
diff --git a/devel/installation/images/step4.png b/devel/installation/images/step4.png
new file mode 100644
index 0000000000..6caef3036f
Binary files /dev/null and b/devel/installation/images/step4.png differ
diff --git a/devel/installation/images/step5.png b/devel/installation/images/step5.png
new file mode 100644
index 0000000000..867a65fa3f
Binary files /dev/null and b/devel/installation/images/step5.png differ
diff --git a/devel/installation/index.html b/devel/installation/index.html
new file mode 100644
index 0000000000..a1e70e2451
--- /dev/null
+++ b/devel/installation/index.html
@@ -0,0 +1,301 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Already installed Rust?
+Several Linux distributions package Rust, and you may wish to use the packaged
+toolchain, such as for distribution package development. You may also wish to
+use a rustup-managed toolchain such as nightly or beta. Normally, rustup
+will complain that you already have Rust installed in /usr and refuse to
+install. However, you can install Rust via rustup and have it coexist with
+your distribution’s packaged Rust.
When you initially install Rust with rustup, pass the -y option to make it
+ignore the packaged Rust toolchain and install a rustup-managed toolchain
+into ~/.cargo/bin. Add that directory to your $PATH (or let rustup do it
+for you by not passing --no-modify-path). Then, to tell rustup about your
+system toolchain, run:
rustup toolchain link system /usr
+You can then use “system” as a rustup toolchain, just like “nightly”.
+For example, using the toolchain override shorthand, you can run cargo +system build
+to build with the system toolchain, or cargo +nightly build to build with nightly.
If you do distribution Rust development, you should likely make “system” your +default toolchain:
+rustup default system
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/installation/other.html b/devel/installation/other.html
new file mode 100644
index 0000000000..8d7582464d
--- /dev/null
+++ b/devel/installation/other.html
@@ -0,0 +1,508 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+Follow the instructions at https://www.rust-lang.org/tools/install. If that +doesn’t work for you there are other installation methods.
+rustup installs rustc, cargo, rustup and other standard tools to
+Cargo’s bin directory. On Unix it is located at $HOME/.cargo/bin and on
+Windows at %USERPROFILE%\.cargo\bin. This is the same directory that cargo install will install Rust programs and Cargo plugins.
This directory will be in your $PATH environment variable, which means you
+can run them from the shell without further configuration. Open a new shell
+and type the following:
rustc --version
+If you see something like rustc 1.19.0 (0ade33941 2017-07-17) then you are
+ready to Rust. If you decide Rust isn’t your thing, you can completely remove
+it from your system by running rustup self uninstall.
Choosing where to install
+rustup allows you to customise your installation by setting the environment
+variables CARGO_HOME and RUSTUP_HOME before running the rustup-init
+executable. As mentioned in the Environment Variables section, RUSTUP_HOME
+sets the root rustup folder, which is used for storing installed toolchains
+and configuration options. CARGO_HOME contains cache files used by cargo.
Note that you will need to ensure these environment variables are always set
+and that CARGO_HOME/bin is in the $PATH environment variable when using
+the toolchain.
Installing nightly
+If you specify the nightly channel when installing rustup, the
+rustup-init script will do a “forced” installation by default. A “forced”
+installation means it will install the nightly channel regardless of whether
+it might be missing components that you want. If you want to install rustup
+with the nightly channel, and ensure it has the components that you want, you
+will need to do this in two phases. For example, if you want to make a fresh
+installation of rustup and then install nightly along with clippy or
+miri, first install rustup without a toolchain:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
+Next you can install nightly allowing rustup to downgrade until it finds
+the components you need:
rustup toolchain install nightly --allow-downgrade --profile minimal --component clippy
+This can be used to great effect in CI, to get you a toolchain rapidly which +meets your criteria.
+Enable tab completion for Bash, Fish, Zsh, or PowerShell
+rustup now supports generating completion scripts for Bash, Fish, Zsh, and
+PowerShell. See rustup help completions for full details, but the gist is as
+simple as using one of the following:
# Bash
+$ rustup completions bash > ~/.local/share/bash-completion/completions/rustup
+
+# Bash (macOS/Homebrew)
+$ rustup completions bash > $(brew --prefix)/etc/bash_completion.d/rustup.bash-completion
+
+# Fish
+$ mkdir -p ~/.config/fish/completions
+$ rustup completions fish > ~/.config/fish/completions/rustup.fish
+
+# Zsh
+$ rustup completions zsh > ~/.zfunc/_rustup
+
+# PowerShell v5.0+
+$ rustup completions powershell >> $PROFILE.CurrentUserCurrentHost
+# or
+$ rustup completions powershell | Out-String | Invoke-Expression
+Note: you may need to restart your shell in order for the changes to take +effect.
+For zsh, you must then add the following line in your ~/.zshrc before
+compinit:
fpath+=~/.zfunc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/installation/package-managers.html b/devel/installation/package-managers.html
new file mode 100644
index 0000000000..299ea679dc
--- /dev/null
+++ b/devel/installation/package-managers.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Other installation methods
+The primary installation method, as described at https://rustup.rs, differs +by platform:
+-
+
- On Windows, download and run the
rustup-init.exebuilt for the +x86_64-pc-windows-msvcoraarch64-pc-windows-msvctarget, +depending on your OS architecture. In general, this is the build of +rustupone should install on Windows. This will require the Visual C++ +Build Tools 2019 or equivalent (Visual Studio 2019, etc.) to already be +installed. If you would prefer to install GNU toolchains or the i686 +toolchains by default this can be modified at install time, either +interactively, with the--default-hostflag, or after installation +viarustup set default-host.
+ - On Unix, run
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | shin your shell. This +downloads and runsrustup-init.sh, which in turn downloads and runs the +correct version of therustup-initexecutable for your platform.
+
rustup-init accepts arguments, which can be passed through the shell script.
+Some examples:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --help
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --no-modify-path
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --profile minimal --default-toolchain nightly
+Using a package manager
+++Please note that the rustup project is not maintaining any package mentioned in this section. +If you have encountered any problems installing
+rustupwith a package manager, +please contact the package maintainer(s) for further information.
General tips
+Different package managers take slightly different approaches towards managing rustup. +After installing rustup with your favorite package manager, there are usually two possibilities:
+-
+
-
+
If your package manager has made the
+rustupcommand available +together with proxies for Rust tools such asrustcandcargo, +picking a default toolchain (e.g.stable) would usually be enough:
+$ rustup default stable ++
+As of 2024/07/24, this is the case for +DNF.
+
+ -
+
If your package manager has only made the
+rustup-initcommand available, simply run:
+$ rustup-init +This will allow you to perform the initial setup of
+rustup, populate all the proxies +managed by rustup, and install a default toolchain. When the installation is completed, +please make sure that these proxies (usually under$HOME/.cargo/bin) are exposed via your$PATH.+
+As of 2024/07/24, this is the case for +APT, +homebrew +and pacman.
+
+
Now you should be able to run rustup, rustc, cargo, etc. normally.
APT
+Starting from Debian 13 (trixie) and Ubuntu 24.04 (noble),
+you may use apt to install rustup:
$ sudo apt install rustup
+Homebrew
+You can use brew to install rustup1:
$ brew install rustup
+Please note that Rust tools like rustc and cargo are not available via $PATH by default
+in this rustup distribution
+(see homebrew-core#177582 for more details).
+You might want to add $(brew --prefix rustup)/bin to $PATH to make them easier to access.
1
+
+This is not to be confused with the rust package,
+which is a brew-managed rust toolchain installation.
Manual installation
+You can manually download rustup-init for a given target from
+https://static.rust-lang.org/rustup/dist/{target-triple}/rustup-init[.exe]2 3.
+
+Direct links
+-
+
- aarch64-apple-darwin
+
-
+
- sha256 file +
+ - aarch64-linux-android
+
-
+
- sha256 file +
+ - aarch64-pc-windows-msvc
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-musl
+
-
+
- sha256 file +
+ - arm-linux-androideabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - armv7-linux-androideabi
+
-
+
- sha256 file +
+ - armv7-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - i686-apple-darwin
+
-
+
- sha256 file +
+ - i686-linux-android
+
-
+
- sha256 file +
+ - i686-pc-windows-gnu2
+
-
+
- sha256 file +
+ - i686-pc-windows-msvc3
+
-
+
- sha256 file +
+ - i686-unknown-linux-gnu
+
-
+
- sha256 file +
+ - loongarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - loongarch64-unknown-linux-musl
+
-
+
- sha256 file +
+ - mips-unknown-linux-gnu
+
-
+
- sha256 file +
+ - mips64-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mips64el-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mipsel-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64le-unknown-linux-gnu
+
-
+
- sha256 file +
+ - s390x-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-apple-darwin
+
-
+
- sha256 file +
+ - x86_64-linux-android
+
-
+
- sha256 file +
+ - x86_64-pc-windows-gnu2
+
-
+
- sha256 file +
+ - x86_64-pc-windows-msvc3
+
-
+
- sha256 file +
+ - x86_64-unknown-freebsd
+
-
+
- sha256 file +
+ - x86_64-unknown-illumos
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-musl
+
-
+
- sha256 file +
+ - x86_64-unknown-netbsd
+
-
+
- sha256 file +
+
To get a previous version, use
+https://static.rust-lang.org/rustup/archive/{rustup-version}/{target-triple}/rustup-init[.exe].
SHA-256 checksums are also available by appending .sha256 to the link.
2
+
+Windows GNU builds require no additional software for basic use. +However, many library crates will not be able to compile until +the full MSYS2 with MinGW has been installed.
+3
+
+MSVC builds of rustup additionally require an installation of
+Visual Studio 2019 or the Visual C++ Build Tools 2019. For Visual
+Studio, make sure to check the “C++ tools” and “Windows 10 SDK” option.
Self-compiled installation
+To install rustup from source, check out the git repository from
+https://github.com/rust-lang/rustup and run cargo run --release. Note that
+after installation the rustup toolchains will supersede any pre-existing
+toolchains by prepending ~/.cargo/bin to the PATH environment variable.
Redirecting to... already-installed-rust.html.
+ + diff --git a/devel/installation/windows-msvc.html b/devel/installation/windows-msvc.html new file mode 100644 index 0000000000..89821ea482 --- /dev/null +++ b/devel/installation/windows-msvc.html @@ -0,0 +1,277 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/installation/windows.html b/devel/installation/windows.html
new file mode 100644
index 0000000000..b8922114dc
--- /dev/null
+++ b/devel/installation/windows.html
@@ -0,0 +1,274 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSVC prerequisites
+To compile programs into an exe file, Rust requires a linker, libraries and Windows API import libraries.
+For msvc targets these can be acquired through Visual Studio.
Automatic install
+If you don’t have Visual Studio already installed then rustup-init will offer to automatically install the prerequisites. +Doing so means you can skip the rest of this page. +However, it installs Visual Studio Community edition which may not be appropriate for all users. +It is free for individuals, academic and open source use, but not for other uses, such as in proprietary enterprise software. +Users should ask their organisation which edition is right for them. +See licensing terms for more details.
+Manual install
+Download Visual Studio. +Rust supports Visual Studio 2017 and later but it is recommended that you use the latest version (currently 2022) for new projects. +You can opt to download only the Build Tools for Visual Studio, which does not include the IDE. +However this requires you already have a license to the Community, Professional or Enterprise edition.
+Once you’ve downloaded and started the installer, the easiest way to get everything installed is to select “Desktop Development with C++”. +This will include the necessary components. +On the “Language Packs” tab, make sure the English language pack is installed in addition to your preferred language.
+If you want more details on the installation process or want to further customize the install then follow the walkthrough below. +Otherwise complete the Visual Studio install and continue with installing Rust.
+Walkthrough: Installing Visual Studio 2022
+This walkthrough uses the Community edition of Visual Studio but the Professional, Enterprise and the Build Tools all work the same way.
+The installer will start by linking to the license and for your edition of Visual Studio and then preparing the installer.
+
+
Once this finishes, you can then select the components to be installed.
+Here we use the “Workload” tab to select the “Desktop Development with C++” workload.
+This will includes all needed components for Rust:
+
Installing only the required components (optional)
+If you’d like a more minimal install (and won’t be doing C++ development) then you can use the “Individual Components” tab to select just the essentials, which are:
+-
+
- MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) +
- Windows 11 SDK (10.0.22621.0) +
Note that the specific version of the Windows SDK doesn’t matter for pure Rust code but if using C++ as well you’ll likely want either the latest or whichever version is required by the C++ project (or both).
+
+
Completing the install
+After choosing the components, switch to the “Language Packs” tab and add the English language pack in addition to your preferred language.
+
Finally click the install button and wait for everything to be installed.
+
Once finished, you can continue on to installing Rust.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/mark.min.js b/devel/mark.min.js
new file mode 100644
index 0000000000..1636231883
--- /dev/null
+++ b/devel/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Windows
+rustup works the same on Windows as it does on Unix, but there are some
+special considerations for Rust developers on Windows. As mentioned on the
+Rust download page, there are two 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.
When targeting the MSVC ABI, Rust additionally requires an installation of
+Visual Studio so rustc can use its linker and libraries.
When targeting the GNU ABI, no additional software is strictly required for basic use. +However, many library crates will not be able to compile until the full MSYS2 with MinGW has been installed.
+By default rustup on Windows configures Rust to target the MSVC ABI, that is
+a target triple of either i686-pc-windows-msvc, x86_64-pc-windows-msvc, or aarch64-pc-windows-msvc
+depending on the CPU architecture of the host Windows OS. The toolchains that
+rustup chooses to install, unless told otherwise through the toolchain
+specification, will be compiled to run on that target triple host and will
+target that triple by default.
You can change this behavior with rustup set default-host or during
+installation.
For example, to explicitly select the 32-bit MSVC host:
+$ rustup set default-host i686-pc-windows-msvc
+Or to choose the 64 bit GNU toolchain:
+$ rustup set default-host x86_64-pc-windows-gnu
+Since the MSVC ABI provides the best interoperation with other Windows
+software it is recommended for most purposes. The GNU toolchain is always
+available, even if you don’t use it by default. Just install it with rustup toolchain install:
$ rustup toolchain install stable-gnu
+You don’t need to switch toolchains to support all windows targets though; a +single toolchain supports all four x86 windows targets:
+$ rustup target add x86_64-pc-windows-msvc
+$ rustup target add x86_64-pc-windows-gnu
+$ rustup target add i686-pc-windows-msvc
+$ rustup target add i686-pc-windows-gnu
+See the Cross-compilation chapter for more details on specifying different +targets with the same compiler.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/overrides.html b/devel/overrides.html
new file mode 100644
index 0000000000..97f09c8c9f
--- /dev/null
+++ b/devel/overrides.html
@@ -0,0 +1,348 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Network proxies
+Enterprise networks often don’t have direct outside HTTP access, but enforce
+the use of proxies. If you’re on such a network, you can request that rustup
+uses a proxy by setting its URL in the environment. In most cases, setting
+https_proxy should be sufficient. Commands may differ between different
+systems and shells:
-
+
- On a Unix-like system with a shell like bash or zsh:
+
+export https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows Command Prompt (cmd):
+
+set https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows PowerShell (or PowerShell Core):
+
+$env:https_proxy="socks5://proxy.example.com:1080" +
+ - Replace
socks5://proxy.example.com:1080with +http://proxy.example.com:8080when an HTTP proxy is used instead.
+
If you need a more complex setup, rustup supports the convention used by the
+curl program, documented in the ENVIRONMENT section of its manual
+page.
The use of curl is presently deprecated, however it can still be used by
+providing the RUSTUP_USE_CURL environment variable, for example:
RUSTUP_USE_CURL=1 rustup update
+Note that some versions of libcurl apparently require you to drop the
+http:// or https:// prefix in environment variables. For example, export http_proxy=proxy.example.com:1080 (and likewise for HTTPS). If you are
+getting an SSL unknown protocol error from rustup via libcurl but the
+command-line curl command works fine, this may be the problem.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/print.html b/devel/print.html
new file mode 100644
index 0000000000..4a553b9041
--- /dev/null
+++ b/devel/print.html
@@ -0,0 +1,1339 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Overrides
+rustup automatically determines which toolchain to use when one of the
+installed commands like rustc is executed. There are several ways to control
+and override which toolchain is used:
-
+
- A toolchain override shorthand used on the command-line, such as
cargo +beta.
+ - The
RUSTUP_TOOLCHAINenvironment variable.
+ - A directory override, set with the
rustup overridecommand.
+ - The
rust-toolchain.tomlfile.
+ - The default toolchain. +
The toolchain is chosen in the order listed above, using the first one that is
+specified. There is one exception though: directory overrides and the
+rust-toolchain.toml file are also preferred by their proximity to the current
+directory. That is, these two override methods are discovered by walking up
+the directory tree toward the filesystem root, and a rust-toolchain.toml file
+that is closer to the current directory will be preferred over a directory
+override that is further away.
To verify which toolchain is active, you can use rustup show.
Toolchain override shorthand
+The rustup toolchain proxies can be instructed directly to use a specific
+toolchain, a convenience for developers who often test different toolchains.
+If the first argument to cargo, rustc or other tools in the toolchain
+begins with +, it will be interpreted as a rustup toolchain name, and that
+toolchain will be preferred, as in
cargo +beta test
+Directory overrides
+Directories can be assigned their own Rust toolchain with rustup override.
+When a directory has an override then any time rustc or cargo is run
+inside that directory, or one of its child directories, the override toolchain
+will be invoked.
To use to a specific nightly for a directory:
+rustup override set nightly-2014-12-18
+Or a specific stable release:
+rustup override set 1.0.0
+To see the active toolchain use rustup show. To remove the override and use
+the default toolchain again, rustup override unset.
The per-directory overrides are stored in a configuration file in rustup’s
+home directory.
The toolchain file
+Some projects find themselves ‘pinned’ to a specific release of Rust and want +this information reflected in their source repository. This is most often the +case for nightly-only software that pins to a revision from the release +archives.
+In these cases the toolchain can be named in the project’s directory in a file
+called rust-toolchain.toml or rust-toolchain. If both files are present in
+a directory, the latter is used for backwards compatibility. The files use the
+TOML format and have the following layout:
[toolchain]
+channel = "nightly-2020-07-10"
+components = [ "rustfmt", "rustc-dev" ]
+targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
+profile = "minimal"
+The [toolchain] section is mandatory, and at least one property must be
+specified. channel and path are mutually exclusive.
For backwards compatibility, rust-toolchain files also support a legacy
+format that only contains a toolchain name without any TOML encoding, e.g.
+just nightly-2021-01-21. The file has to be encoded in US-ASCII in this case
+(if you are on Windows, check the encoding and that it does not start with a
+BOM). The legacy format is not available in rust-toolchain.toml files.
If you see the following error (when running rustc, cargo or other command)
error: invalid channel name '[toolchain]' in '/PATH/TO/DIRECTORY/rust-toolchain'
+it means you’re running rustup pre-1.23.0 and trying to interact with a project
+that uses the new TOML encoding in the rust-toolchain file. You need to upgrade
+rustup to 1.23.0+.
The rust-toolchain.toml/rust-toolchain files are suitable to check in to
+source control. If that’s done, Cargo.lock should probably be tracked too if
+the toolchain is pinned to a specific release, to avoid potential compatibility
+issues with dependencies.
Toolchain file settings
+channel
+The channel setting specifies which toolchain to use. The value is a
+string in the following form:
(<channel>[-<date>])|<custom toolchain name>
+
+<channel> = stable|beta|nightly|<major.minor.patch>
+<date> = YYYY-MM-DD
+path
+The path setting allows a custom toolchain to be used. The value is an
+absolute path string.
Since a path directive directly names a local toolchain, other options
+like components, targets, and profile have no effect.
channel and path are mutually exclusive, since a path already
+points to a specific toolchain.
profile
+The profile setting names a group of components to be installed. The
+value is a string. The valid options are: minimal, default, and
+complete. See profiles for details of each.
Note that if not specified, the default profile is not necessarily
+used, as a different default profile might have been set with rustup set profile.
components
+The components setting contains a list of additional components to
+install. The value is a list of strings. See components for a list of
+components. Note that different toolchains may have different components
+available.
The components listed here are additive with the current profile.
+targets
+The targets setting contains a list of platforms to install for
+cross-compilation. The value is a list of strings.
The host platform is automatically included; the targets listed here are +additive.
+Default toolchain
+If no other overrides are set, the global default toolchain will be used. This
+default can be chosen when rustup is installed. The rustup default
+command can be used to set and query the current default. Run rustup default
+without any arguments to print the current default. Specify a toolchain as an
+argument to change the default:
rustup default nightly-2020-07-27
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/searcher.js b/devel/searcher.js
new file mode 100644
index 0000000000..dc03e0a02d
--- /dev/null
+++ b/devel/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keeping
+
+rustup exited successfully but I can’t run
+
+
+
+
+ Introduction
+rustup installs The Rust Programming Language from the official +release channels, enabling you to easily switch between stable, beta, and +nightly compilers and keep them updated. It makes cross-compiling simpler with +binary builds of the standard library for common platforms. And it runs on all +platforms Rust supports.
+Check out the Concepts chapter for an overview of how rustup works and some +of the terminology it uses. The Installation chapter covers installing +rustup and getting started.
+The source code of rustup and this manual may be found at +https://github.com/rust-lang/rustup. If you find a problem, check out the +issue tracker.
+Release notes for rustup may be found in the CHANGELOG.
+Installation
+Follow the instructions at https://www.rust-lang.org/tools/install. If that +doesn’t work for you there are other installation methods.
+rustup installs rustc, cargo, rustup and other standard tools to
+Cargo’s bin directory. On Unix it is located at $HOME/.cargo/bin and on
+Windows at %USERPROFILE%\.cargo\bin. This is the same directory that cargo install will install Rust programs and Cargo plugins.
This directory will be in your $PATH environment variable, which means you
+can run them from the shell without further configuration. Open a new shell
+and type the following:
rustc --version
+If you see something like rustc 1.19.0 (0ade33941 2017-07-17) then you are
+ready to Rust. If you decide Rust isn’t your thing, you can completely remove
+it from your system by running rustup self uninstall.
Choosing where to install
+rustup allows you to customise your installation by setting the environment
+variables CARGO_HOME and RUSTUP_HOME before running the rustup-init
+executable. As mentioned in the Environment Variables section, RUSTUP_HOME
+sets the root rustup folder, which is used for storing installed toolchains
+and configuration options. CARGO_HOME contains cache files used by cargo.
Note that you will need to ensure these environment variables are always set
+and that CARGO_HOME/bin is in the $PATH environment variable when using
+the toolchain.
Installing nightly
+If you specify the nightly channel when installing rustup, the
+rustup-init script will do a “forced” installation by default. A “forced”
+installation means it will install the nightly channel regardless of whether
+it might be missing components that you want. If you want to install rustup
+with the nightly channel, and ensure it has the components that you want, you
+will need to do this in two phases. For example, if you want to make a fresh
+installation of rustup and then install nightly along with clippy or
+miri, first install rustup without a toolchain:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
+Next you can install nightly allowing rustup to downgrade until it finds
+the components you need:
rustup toolchain install nightly --allow-downgrade --profile minimal --component clippy
+This can be used to great effect in CI, to get you a toolchain rapidly which +meets your criteria.
+Enable tab completion for Bash, Fish, Zsh, or PowerShell
+rustup now supports generating completion scripts for Bash, Fish, Zsh, and
+PowerShell. See rustup help completions for full details, but the gist is as
+simple as using one of the following:
# Bash
+$ rustup completions bash > ~/.local/share/bash-completion/completions/rustup
+
+# Bash (macOS/Homebrew)
+$ rustup completions bash > $(brew --prefix)/etc/bash_completion.d/rustup.bash-completion
+
+# Fish
+$ mkdir -p ~/.config/fish/completions
+$ rustup completions fish > ~/.config/fish/completions/rustup.fish
+
+# Zsh
+$ rustup completions zsh > ~/.zfunc/_rustup
+
+# PowerShell v5.0+
+$ rustup completions powershell >> $PROFILE.CurrentUserCurrentHost
+# or
+$ rustup completions powershell | Out-String | Invoke-Expression
+Note: you may need to restart your shell in order for the changes to take +effect.
+For zsh, you must then add the following line in your ~/.zshrc before
+compinit:
fpath+=~/.zfunc
+Windows
+rustup works the same on Windows as it does on Unix, but there are some
+special considerations for Rust developers on Windows. As mentioned on the
+Rust download page, there are two 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.
When targeting the MSVC ABI, Rust additionally requires an installation of
+Visual Studio so rustc can use its linker and libraries.
When targeting the GNU ABI, no additional software is strictly required for basic use. +However, many library crates will not be able to compile until the full MSYS2 with MinGW has been installed.
+By default rustup on Windows configures Rust to target the MSVC ABI, that is
+a target triple of either i686-pc-windows-msvc, x86_64-pc-windows-msvc, or aarch64-pc-windows-msvc
+depending on the CPU architecture of the host Windows OS. The toolchains that
+rustup chooses to install, unless told otherwise through the toolchain
+specification, will be compiled to run on that target triple host and will
+target that triple by default.
You can change this behavior with rustup set default-host or during
+installation.
For example, to explicitly select the 32-bit MSVC host:
+$ rustup set default-host i686-pc-windows-msvc
+Or to choose the 64 bit GNU toolchain:
+$ rustup set default-host x86_64-pc-windows-gnu
+Since the MSVC ABI provides the best interoperation with other Windows
+software it is recommended for most purposes. The GNU toolchain is always
+available, even if you don’t use it by default. Just install it with rustup toolchain install:
$ rustup toolchain install stable-gnu
+You don’t need to switch toolchains to support all windows targets though; a +single toolchain supports all four x86 windows targets:
+$ rustup target add x86_64-pc-windows-msvc
+$ rustup target add x86_64-pc-windows-gnu
+$ rustup target add i686-pc-windows-msvc
+$ rustup target add i686-pc-windows-gnu
+See the Cross-compilation chapter for more details on specifying different +targets with the same compiler.
+MSVC prerequisites
+To compile programs into an exe file, Rust requires a linker, libraries and Windows API import libraries.
+For msvc targets these can be acquired through Visual Studio.
Automatic install
+If you don’t have Visual Studio already installed then rustup-init will offer to automatically install the prerequisites. +Doing so means you can skip the rest of this page. +However, it installs Visual Studio Community edition which may not be appropriate for all users. +It is free for individuals, academic and open source use, but not for other uses, such as in proprietary enterprise software. +Users should ask their organisation which edition is right for them. +See licensing terms for more details.
+Manual install
+Download Visual Studio. +Rust supports Visual Studio 2017 and later but it is recommended that you use the latest version (currently 2022) for new projects. +You can opt to download only the Build Tools for Visual Studio, which does not include the IDE. +However this requires you already have a license to the Community, Professional or Enterprise edition.
+Once you’ve downloaded and started the installer, the easiest way to get everything installed is to select “Desktop Development with C++”. +This will include the necessary components. +On the “Language Packs” tab, make sure the English language pack is installed in addition to your preferred language.
+If you want more details on the installation process or want to further customize the install then follow the walkthrough below. +Otherwise complete the Visual Studio install and continue with installing Rust.
+Walkthrough: Installing Visual Studio 2022
+This walkthrough uses the Community edition of Visual Studio but the Professional, Enterprise and the Build Tools all work the same way.
+The installer will start by linking to the license and for your edition of Visual Studio and then preparing the installer.
+
+
Once this finishes, you can then select the components to be installed.
+Here we use the “Workload” tab to select the “Desktop Development with C++” workload.
+This will includes all needed components for Rust:
+
Installing only the required components (optional)
+If you’d like a more minimal install (and won’t be doing C++ development) then you can use the “Individual Components” tab to select just the essentials, which are:
+-
+
- MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) +
- Windows 11 SDK (10.0.22621.0) +
Note that the specific version of the Windows SDK doesn’t matter for pure Rust code but if using C++ as well you’ll likely want either the latest or whichever version is required by the C++ project (or both).
+
+
Completing the install
+After choosing the components, switch to the “Language Packs” tab and add the English language pack in addition to your preferred language.
+
Finally click the install button and wait for everything to be installed.
+
Once finished, you can continue on to installing Rust.
+Other installation methods
+The primary installation method, as described at https://rustup.rs, differs +by platform:
+-
+
- On Windows, download and run the
rustup-init.exebuilt for the +x86_64-pc-windows-msvcoraarch64-pc-windows-msvctarget, +depending on your OS architecture. In general, this is the build of +rustupone should install on Windows. This will require the Visual C++ +Build Tools 2019 or equivalent (Visual Studio 2019, etc.) to already be +installed. If you would prefer to install GNU toolchains or the i686 +toolchains by default this can be modified at install time, either +interactively, with the--default-hostflag, or after installation +viarustup set default-host.
+ - On Unix, run
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | shin your shell. This +downloads and runsrustup-init.sh, which in turn downloads and runs the +correct version of therustup-initexecutable for your platform.
+
rustup-init accepts arguments, which can be passed through the shell script.
+Some examples:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --help
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --no-modify-path
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --profile minimal --default-toolchain nightly
+Using a package manager
+++Please note that the rustup project is not maintaining any package mentioned in this section. +If you have encountered any problems installing
+rustupwith a package manager, +please contact the package maintainer(s) for further information.
General tips
+Different package managers take slightly different approaches towards managing rustup. +After installing rustup with your favorite package manager, there are usually two possibilities:
+-
+
-
+
If your package manager has made the
+rustupcommand available +together with proxies for Rust tools such asrustcandcargo, +picking a default toolchain (e.g.stable) would usually be enough:
+$ rustup default stable ++
+As of 2024/07/24, this is the case for +DNF.
+
+ -
+
If your package manager has only made the
+rustup-initcommand available, simply run:
+$ rustup-init +This will allow you to perform the initial setup of
+rustup, populate all the proxies +managed by rustup, and install a default toolchain. When the installation is completed, +please make sure that these proxies (usually under$HOME/.cargo/bin) are exposed via your$PATH.+
+As of 2024/07/24, this is the case for +APT, +homebrew +and pacman.
+
+
Now you should be able to run rustup, rustc, cargo, etc. normally.
APT
+Starting from Debian 13 (trixie) and Ubuntu 24.04 (noble),
+you may use apt to install rustup:
$ sudo apt install rustup
+Homebrew
+You can use brew to install rustup1:
$ brew install rustup
+Please note that Rust tools like rustc and cargo are not available via $PATH by default
+in this rustup distribution
+(see homebrew-core#177582 for more details).
+You might want to add $(brew --prefix rustup)/bin to $PATH to make them easier to access.
1
+
+This is not to be confused with the rust package,
+which is a brew-managed rust toolchain installation.
Manual installation
+You can manually download rustup-init for a given target from
+https://static.rust-lang.org/rustup/dist/{target-triple}/rustup-init[.exe]2 3.
+
+Direct links
+-
+
- aarch64-apple-darwin
+
-
+
- sha256 file +
+ - aarch64-linux-android
+
-
+
- sha256 file +
+ - aarch64-pc-windows-msvc
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-musl
+
-
+
- sha256 file +
+ - arm-linux-androideabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - armv7-linux-androideabi
+
-
+
- sha256 file +
+ - armv7-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - i686-apple-darwin
+
-
+
- sha256 file +
+ - i686-linux-android
+
-
+
- sha256 file +
+ - i686-pc-windows-gnu2
+
-
+
- sha256 file +
+ - i686-pc-windows-msvc3
+
-
+
- sha256 file +
+ - i686-unknown-linux-gnu
+
-
+
- sha256 file +
+ - loongarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - loongarch64-unknown-linux-musl
+
-
+
- sha256 file +
+ - mips-unknown-linux-gnu
+
-
+
- sha256 file +
+ - mips64-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mips64el-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mipsel-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64le-unknown-linux-gnu
+
-
+
- sha256 file +
+ - s390x-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-apple-darwin
+
-
+
- sha256 file +
+ - x86_64-linux-android
+
-
+
- sha256 file +
+ - x86_64-pc-windows-gnu2
+
-
+
- sha256 file +
+ - x86_64-pc-windows-msvc3
+
-
+
- sha256 file +
+ - x86_64-unknown-freebsd
+
-
+
- sha256 file +
+ - x86_64-unknown-illumos
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-musl
+
-
+
- sha256 file +
+ - x86_64-unknown-netbsd
+
-
+
- sha256 file +
+
To get a previous version, use
+https://static.rust-lang.org/rustup/archive/{rustup-version}/{target-triple}/rustup-init[.exe].
SHA-256 checksums are also available by appending .sha256 to the link.
2
+
+Windows GNU builds require no additional software for basic use. +However, many library crates will not be able to compile until +the full MSYS2 with MinGW has been installed.
+3
+
+MSVC builds of rustup additionally require an installation of
+Visual Studio 2019 or the Visual C++ Build Tools 2019. For Visual
+Studio, make sure to check the “C++ tools” and “Windows 10 SDK” option.
Self-compiled installation
+To install rustup from source, check out the git repository from
+https://github.com/rust-lang/rustup and run cargo run --release. Note that
+after installation the rustup toolchains will supersede any pre-existing
+toolchains by prepending ~/.cargo/bin to the PATH environment variable.
Already installed Rust?
+Several Linux distributions package Rust, and you may wish to use the packaged
+toolchain, such as for distribution package development. You may also wish to
+use a rustup-managed toolchain such as nightly or beta. Normally, rustup
+will complain that you already have Rust installed in /usr and refuse to
+install. However, you can install Rust via rustup and have it coexist with
+your distribution’s packaged Rust.
When you initially install Rust with rustup, pass the -y option to make it
+ignore the packaged Rust toolchain and install a rustup-managed toolchain
+into ~/.cargo/bin. Add that directory to your $PATH (or let rustup do it
+for you by not passing --no-modify-path). Then, to tell rustup about your
+system toolchain, run:
rustup toolchain link system /usr
+You can then use “system” as a rustup toolchain, just like “nightly”.
+For example, using the toolchain override shorthand, you can run cargo +system build
+to build with the system toolchain, or cargo +nightly build to build with nightly.
If you do distribution Rust development, you should likely make “system” your +default toolchain:
+rustup default system
+Concepts
+How rustup works
+rustup is a toolchain multiplexer. It installs and manages many Rust
+toolchains and presents them all through a single set of tools installed to
+~/.cargo/bin. The rustc and cargo executables installed in
+~/.cargo/bin are proxies that delegate to the real toolchain. rustup
+then provides mechanisms to easily change the active toolchain by
+reconfiguring the behavior of the proxies.
So when rustup is first installed, running rustc will run the proxy in
+$HOME/.cargo/bin/rustc, which in turn will run the stable compiler. If you
+later change the default toolchain to nightly with rustup default nightly,
+then that same proxy will run the nightly compiler instead.
This is similar to Ruby’s rbenv, Python’s pyenv, or Node’s nvm.
+Terminology
+-
+
-
+
channel — Rust is released to three different “channels”: stable, beta, +and nightly. See the Channels chapter for more details.
+
+ -
+
toolchain — A “toolchain” is a complete installation of the Rust +compiler (
+rustc) and related tools (likecargo). A toolchain +specification includes the release channel or version, and the host +platform that the toolchain runs on.
+ -
+
target —
+rustcis capable of generating code for many platforms. The +“target” specifies the platform that the code will be generated for. By +default,cargoandrustcuse the host toolchain’s platform as the +target. To build for a different target, usually the target’s standard +library needs to be installed first via therustup targetcommand. See the +Cross-compilation chapter for more details.
+ -
+
component — Each release of Rust includes several “components”, some of +which are required (like
+rustc) and some that are optional (like +clippy). See the Components chapter for more detail.
+ -
+
profile — In order to make it easier to work with components, a +“profile” defines a grouping of components. See the Profiles chapter for +more details.
+
+ -
+
proxy — A wrapper for a common Rust component (like
+rustc), built to forward +CLI invocations to the active Rust toolchain. See the Proxies chapter for more details.
+
Channels
+Rust is released to three different “channels”: stable, beta, and nightly. The
+stable releases are made every 6 weeks (with occasional point releases). Beta
+releases are the version that will appear in the next stable release. Nightly
+releases are made every night. See The Rust Book for more details
+on Rust’s train release model. The release schedule is posted to the Rust
+Forge. rustup assists with installing different channels, keeping them
+up-to-date, and easily switching between them.
After a release channel has been installed, rustup can be used to update the
+installed version to the latest release on that channel. See the Keeping rust
+up to date section for more information.
rustup can also install specific versions of Rust, such as 1.45.2 or
+nightly-2020-07-27. See the Toolchains chapter for more information on
+installing different channels and releases. See the Overrides chapter for
+details on switching between toolchains and pinning your project to a specific
+toolchain.
Working with nightly Rust
+rustup gives you easy access to the nightly compiler and its experimental
+features. To add it just run rustup toolchain install nightly:
$ rustup toolchain install nightly
+info: syncing channel updates for 'nightly'
+info: downloading toolchain manifest
+info: downloading component 'rustc'
+info: downloading component 'rust-std'
+info: downloading component 'rust-docs'
+info: downloading component 'cargo'
+info: installing component 'rustc'
+info: installing component 'rust-std'
+info: installing component 'rust-docs'
+info: installing component 'cargo'
+
+ nightly installed: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now Rust nightly is installed, but not activated. To test it out you can run a +command from the nightly toolchain like
+$ rustup run nightly rustc --version
+rustc 1.9.0-nightly (02310fd31 2016-03-19)
+But more likely you want to use it for a while. To switch to nightly globally,
+change the default with rustup default nightly:
$ rustup default nightly
+info: using existing install for 'nightly'
+info: default toolchain set to 'nightly'
+
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now any time you run cargo or rustc you will be running the nightly
+compiler.
With nightly installed any time you run rustup update, the nightly channel
+will be updated in addition to stable:
$ rustup update
+info: syncing channel updates for 'stable'
+info: syncing channel updates for 'nightly'
+info: checking for self-update
+info: downloading self-update
+
+ stable unchanged: rustc 1.7.0 (a5d1e7a59 2016-02-29)
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Nightly availability
+Nightly toolchains may fail to build, so for any given date and target
+platform there may not be a toolchain available. Furthermore, nightly builds
+may be published with missing non-default components (such as clippy).
+As such, it can be difficult to find fully-working nightlies. Use the
+rustup-components-history project to find the build status of recent
+nightly toolchains and components.
When you attempt to install or update the nightly channel, rustup will
+check if a required or previously installed component is missing. If it is
+missing, rustup will automatically search for an older release that contains
+the required components. There are several ways to change this behavior:
-
+
- Use the
--forceflag torustup toolchain installto force it to install +the most recent version even if there is a missing component.
+ - Use the
--profileflag torustup toolchain installto use a different +profile that does not contain the missing component. For example, +--profile=minimalshould always work, as the minimal set is required to +exist. See the Profiles chapter for more detail.
+ - Install a specific date that contains the components you need. For example,
+
rustup toolchain install nightly-2020-07-27. You can then use overrides +to pin to that specific release.
+
Toolchains
+Many rustup commands deal with toolchains, a single installation of the
+Rust compiler. rustup supports multiple types of toolchains. The most basic
+track the official release channels: stable, beta and nightly; but
+rustup can also install toolchains from the official archives, for alternate
+host platforms, and from local builds.
Toolchain specification
+Standard release channel toolchain names have the following form:
+<channel>[-<date>][-<host>]
+
+<channel> = stable|beta|nightly|<major.minor>|<major.minor.patch>
+<date> = YYYY-MM-DD
+<host> = <target-triple>
+‘channel’ is a named release channel, a major and minor version number such as
+1.42, or a fully specified version number, such as 1.42.0. Channel names
+can be optionally appended with an archive date, as in nightly-2014-12-18, in
+which case the toolchain is downloaded from the archive for that date.
Finally, the host may be specified as a target triple. This is most useful for +installing a 32-bit compiler on a 64-bit platform, or for installing the +MSVC-based toolchain on Windows. For example:
+$ rustup toolchain install stable-x86_64-pc-windows-msvc
+For convenience, elements of the target triple that are omitted will be +inferred, so the above could be written:
+$ rustup toolchain install stable-msvc
+Toolchain names that don’t name a channel instead can be used to name custom +toolchains.
+Custom toolchains
+For convenience of developers working on Rust itself, rustup can manage
+local builds of the Rust toolchain. To teach rustup about your build, run:
$ rustup toolchain link my-toolchain path/to/my/toolchain/sysroot
+For example, on Ubuntu you might clone rust-lang/rust into ~/rust, build
+it, and then run:
$ rustup toolchain link my-toolchain ~/rust/build/x86_64-unknown-linux-gnu/stage2/
+$ rustup default my-toolchain
+Now you can name my-toolchain as any other rustup toolchain. Create a
+rustup toolchain for each of your rust-lang/rust workspaces and test them
+easily with rustup run my-toolchain rustc.
Because the rust-lang/rust tree does not include Cargo, when cargo is
+invoked for a custom toolchain and it is not available, rustup will attempt
+to use cargo from one of the release channels, preferring ‘nightly’, then
+‘beta’ or ‘stable’.
Components
+Each toolchain has several “components”, some of which are required (like
+rustc) and some that are optional (like clippy). The rustup component command is used to manage the installed components. For example,
+run rustup component list to see a list of available and installed
+components.
Components can be added when installing a toolchain with the --component
+flag. For example:
rustup toolchain install nightly --component rust-docs
+Components can be added to an already-installed toolchain with the rustup component command:
rustup component add rust-docs
+To make it easier to choose which components are installed, rustup has the
+concept of “profiles” which provide named groupings of different components.
+See the Profiles chapter for more detail.
Most components have a target-triple suffix, such as
+rustc-x86_64-apple-darwin, to signify the platform the component is for.
The set of available components may vary with different releases and +toolchains. The following is an overview of the different components:
+-
+
rustc— The Rust compiler and Rustdoc.
+cargo— Cargo is a package manager and build tool.
+rustfmt— Rustfmt is a tool for automatically formatting code.
+rust-std— This is the Rust standard library. There is a separate +rust-stdcomponent for each target thatrustcsupports, such as +rust-std-x86_64-pc-windows-msvc. See the Cross-compilation chapter for +more detail.
+rust-docs— This is a local copy of the Rust documentation. Use the +rustup doccommand to open the documentation in a web browser. Runrustup doc --helpfor more options.
+rust-analyzer— rust-analyzer is a language server that provides support +for editors and IDEs.
+clippy— Clippy is a lint tool that provides extra checks for common +mistakes and stylistic choices.
+miri— Miri is an experimental Rust interpreter, which can be used for +checking for undefined-behavior.
+rust-src— This is a local copy of the source code of the Rust standard +library. This can be used by some tools, such as rust-analyzer, to provide +auto-completion for functions within the standard library; Miri which is a +Rust interpreter; and Cargo’s experimental build-std feature, which allows +you to rebuild the standard library locally.
+rust-mingw— This contains a linker and platform libraries for building on +thex86_64-pc-windows-gnuplatform.
+llvm-tools— This component contains a collection of LLVM tools. +Note that this component has not been stabilized and may change in the +future and is provided as-is. +See #85658.
+rustc-dev— This component contains the compiler as a library. Most users +will not need this; it is only needed for development of tools that link +to the compiler, such as making modifications to Clippy.
+
Previous components
+These components have been deprecated and are not published in new Rust releases.
+-
+
rls— RLS is a language server that is deprecated and has been replaced +by rust-analyzer.
+rust-analysis— Metadata about the standard library, used by RLS.
+
Component availability
+Not all components are available for all toolchains. Especially on the nightly +channel, some components may not be included if they are in a broken state. +The current status of all the components may be found on the rustup +components history page. See the Nightly availability section for more +details.
+Profiles
+rustup has the concept of “profiles”. They are groups of components you
+can choose to download while installing a new Rust toolchain. The profiles
+available at this time are minimal, default, and complete:
-
+
- The minimal profile includes as few components as possible to get a
+working compiler (
rustc,rust-std, andcargo). It’s recommended to use +this component on Windows systems if you don’t use local documentation (the +large number of files can cause issues with some Antivirus systems), and in +CI.
+ - The default profile includes all of components in the minimal
+profile, and adds
rust-docs,rustfmt, andclippy. This profile will be +used byrustupby default, and it’s the one recommended for general use.
+ - The complete profile includes all the components available through
+
rustup. This should never be used, as it includes every component ever +included in the metadata and thus will almost always fail. If you are +looking for a way to install devtools such asmirior IDE integration +tools (rust-analyzer), you should use thedefaultprofile and +install the needed additional components manually, either by usingrustup component addor by using-cwhen installing the toolchain.
+
To change the profile rustup install uses by default, you can use the
+rustup set profile command.
+For example, to select the minimal profile you can use:
rustup set profile minimal
+You can also directly select the profile used when installing a toolchain with:
+rustup install --profile <name>
+It’s also possible to choose the default profile when installing rustup for
+the first time, either interactively by choosing the “Customize installation”
+option or programmatically by passing the --profile=<name> flag. Profiles
+will only affect newly installed toolchains: as usual it will be possible to
+install individual components later with: rustup component add.
Proxies
+rustup provides a number of wrappers for common Rust tools.
+These are called proxies and represent commands which are
+provided by the various components.
The list of proxies is currently static in rustup and is as follows:
-
+
-
+
+rustcis the compiler for the Rust programming language, provided by the project itself and comes from therustccomponent.
+ -
+
+rustdocis a tool distributed in therustccomponent which helps you to generate documentation for Rust projects.
+ -
+
+cargois the Rust package manager which downloads your Rust package’s dependencies, compiles your packages, makes distributable packages, and uploads them to crates.io (the Rust community’s package registry). It comes from thecargocomponent.
+ -
+
+rust-lldb,rust-gdb, andrust-gdbguiare simple wrappers around thelldb,gdb, andgdbguidebuggers respectively. The wrappers enable some pretty-printing of Rust values and add some convenience features to the debuggers by means of their scripting interfaces.
+ -
+
+rust-analyzeris part of the Rust IDE integration tooling. It implements the language-server protocol to permit IDEs and editors such as Visual Studio Code, Vim, or Emacs, access to the semantics of the Rust code you are editing. It comes from therust-analyzercomponent.
+ -
+
+cargo-clippyandclippy-driverare related to theclippylinting tool which provides extra checks for common mistakes and stylistic choices and it comes from theclippycomponent.
+ -
+
+cargo-miriis an experimental interpreter for Rust’s mid-level intermediate representation (MIR) and it comes from themiricomponent.
+ -
+
+rlsis a deprecated IDE tool that has been replaced byrust-analyzer. It comes from therlscomponent.
+
Basic usage
+Keeping Rust up to date
+Rust is distributed on three different release channels: stable, beta, and
+nightly. rustup uses the stable channel by default, which
+represents the latest release of Rust. Stable publishes new releases every six weeks.
When a new version of Rust is released, simply type rustup update to update:
$ rustup update
+info: syncing channel updates for 'stable'
+info: downloading component 'rustc'
+info: downloading component 'rust-std'
+info: downloading component 'rust-docs'
+info: downloading component 'cargo'
+info: installing component 'rustc'
+info: installing component 'rust-std'
+info: installing component 'rust-docs'
+info: installing component 'cargo'
+info: checking for self-update
+info: downloading self-update
+
+ stable updated: rustc 1.7.0 (a5d1e7a59 2016-02-29)
+
+Keeping rustup up to date
+If your rustup was built with the no-self-update feature, it can not update
+itself. This is not the default, and only versions of rustup built with
+--no-default-features, or obtained from a third-party distributor who has
+disabled it (such as NixOS).
Otherwise Rustup can update itself. It is possible to control Rustup’s automatic
+self update mechanism with the auto-self-update configuration variable. This
+setting supports three values: enable and disable and check-only.
-
+
disablewill ensure that no automatic self updating actions are taken.
+enablewill mean thatrustup updateand similar commands will also check for, and install, any update to Rustup.
+check-onlywill cause any automatic self update to check and report on any updates, but not to automatically install them.
+
Whether auto-self-update is enable or not, you can request that Rustup
+update itself to the latest version of rustup by running rustup self update.
+This will not download new toolchains:
$ rustup self update
+info: checking for self-update
+info: downloading self-update
+Disabling self updates on a per-invocation basis
+++Self updates can also be suppressed on individual invocations of
+rustupby +passing the argument--no-self-updatewhen runningrustup updateor +rustup toolchain install.
Help system
+The rustup command-line has a built-in help system that provides more
+information about each command. Run rustup help for an overview. Detailed
+help for each subcommand is also available. For example, run rustup toolchain install --help for specifics on installing toolchains.
Overrides
+rustup automatically determines which toolchain to use when one of the
+installed commands like rustc is executed. There are several ways to control
+and override which toolchain is used:
-
+
- A toolchain override shorthand used on the command-line, such as
cargo +beta.
+ - The
RUSTUP_TOOLCHAINenvironment variable.
+ - A directory override, set with the
rustup overridecommand.
+ - The
rust-toolchain.tomlfile.
+ - The default toolchain. +
The toolchain is chosen in the order listed above, using the first one that is
+specified. There is one exception though: directory overrides and the
+rust-toolchain.toml file are also preferred by their proximity to the current
+directory. That is, these two override methods are discovered by walking up
+the directory tree toward the filesystem root, and a rust-toolchain.toml file
+that is closer to the current directory will be preferred over a directory
+override that is further away.
To verify which toolchain is active, you can use rustup show.
Toolchain override shorthand
+The rustup toolchain proxies can be instructed directly to use a specific
+toolchain, a convenience for developers who often test different toolchains.
+If the first argument to cargo, rustc or other tools in the toolchain
+begins with +, it will be interpreted as a rustup toolchain name, and that
+toolchain will be preferred, as in
cargo +beta test
+Directory overrides
+Directories can be assigned their own Rust toolchain with rustup override.
+When a directory has an override then any time rustc or cargo is run
+inside that directory, or one of its child directories, the override toolchain
+will be invoked.
To use to a specific nightly for a directory:
+rustup override set nightly-2014-12-18
+Or a specific stable release:
+rustup override set 1.0.0
+To see the active toolchain use rustup show. To remove the override and use
+the default toolchain again, rustup override unset.
The per-directory overrides are stored in a configuration file in rustup’s
+home directory.
The toolchain file
+Some projects find themselves ‘pinned’ to a specific release of Rust and want +this information reflected in their source repository. This is most often the +case for nightly-only software that pins to a revision from the release +archives.
+In these cases the toolchain can be named in the project’s directory in a file
+called rust-toolchain.toml or rust-toolchain. If both files are present in
+a directory, the latter is used for backwards compatibility. The files use the
+TOML format and have the following layout:
[toolchain]
+channel = "nightly-2020-07-10"
+components = [ "rustfmt", "rustc-dev" ]
+targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
+profile = "minimal"
+The [toolchain] section is mandatory, and at least one property must be
+specified. channel and path are mutually exclusive.
For backwards compatibility, rust-toolchain files also support a legacy
+format that only contains a toolchain name without any TOML encoding, e.g.
+just nightly-2021-01-21. The file has to be encoded in US-ASCII in this case
+(if you are on Windows, check the encoding and that it does not start with a
+BOM). The legacy format is not available in rust-toolchain.toml files.
If you see the following error (when running rustc, cargo or other command)
error: invalid channel name '[toolchain]' in '/PATH/TO/DIRECTORY/rust-toolchain'
+it means you’re running rustup pre-1.23.0 and trying to interact with a project
+that uses the new TOML encoding in the rust-toolchain file. You need to upgrade
+rustup to 1.23.0+.
The rust-toolchain.toml/rust-toolchain files are suitable to check in to
+source control. If that’s done, Cargo.lock should probably be tracked too if
+the toolchain is pinned to a specific release, to avoid potential compatibility
+issues with dependencies.
Toolchain file settings
+channel
+The channel setting specifies which toolchain to use. The value is a
+string in the following form:
(<channel>[-<date>])|<custom toolchain name>
+
+<channel> = stable|beta|nightly|<major.minor.patch>
+<date> = YYYY-MM-DD
+path
+The path setting allows a custom toolchain to be used. The value is an
+absolute path string.
Since a path directive directly names a local toolchain, other options
+like components, targets, and profile have no effect.
channel and path are mutually exclusive, since a path already
+points to a specific toolchain.
profile
+The profile setting names a group of components to be installed. The
+value is a string. The valid options are: minimal, default, and
+complete. See profiles for details of each.
Note that if not specified, the default profile is not necessarily
+used, as a different default profile might have been set with rustup set profile.
components
+The components setting contains a list of additional components to
+install. The value is a list of strings. See components for a list of
+components. Note that different toolchains may have different components
+available.
The components listed here are additive with the current profile.
+targets
+The targets setting contains a list of platforms to install for
+cross-compilation. The value is a list of strings.
The host platform is automatically included; the targets listed here are +additive.
+Default toolchain
+If no other overrides are set, the global default toolchain will be used. This
+default can be chosen when rustup is installed. The rustup default
+command can be used to set and query the current default. Run rustup default
+without any arguments to print the current default. Specify a toolchain as an
+argument to change the default:
rustup default nightly-2020-07-27
+Cross-compilation
+Rust supports a great number of platforms. For many of these platforms
+The Rust Project publishes binary releases of the standard library, and for
+some the full compiler. rustup gives easy access to all of them.
When you first install a toolchain, rustup installs only the standard
+library for your host platform - that is, the architecture and operating
+system you are presently running. To compile to other platforms you must
+install other target platforms. This is done with the rustup target add
+command. For example, to add the Android target:
$ rustup target add arm-linux-androideabi
+info: downloading component 'rust-std' for 'arm-linux-androideabi'
+info: installing component 'rust-std' for 'arm-linux-androideabi'
+With the arm-linux-androideabi target installed you can then build for
+Android with Cargo by passing the --target flag, as in cargo build --target=arm-linux-androideabi.
Note that rustup target add only installs the Rust standard library for a
+given target. There are typically other tools necessary to cross-compile,
+particularly a linker. For example, to cross compile to Android the Android
+NDK must be installed. In the future, rustup will provide assistance
+installing the NDK components as well. See the target section of the
+cargo configuration for how to setup a linker to use for a certain target.
To install a target for a toolchain that isn’t the default toolchain use the
+--toolchain argument of rustup target add, like so:
$ rustup target add --toolchain <toolchain> <target>...
+To see a list of available targets, rustup target list. To remove a
+previously-added target, rustup target remove.
Environment variables
+-
+
-
+
+RUSTUP_LOG(default: none). Enables Rustup’s “custom logging mode”. In this mode, +the verbosity of Rustup’s log lines can be specified withtracing_subscriber’s +directive syntax. For example, setRUSTUP_LOG=rustup=DEBUGto receive log lines +fromrustupitself with a maximal verbosity ofDEBUG.
+ -
+
+RUSTUP_HOME(default:~/.rustupor%USERPROFILE%/.rustup). Sets the +rootrustupfolder, used for storing installed toolchains and +configuration options.
+ -
+
+RUSTUP_TOOLCHAIN(default: none). If set, will override the toolchain used +for all rust tool invocations. A toolchain with this name should be installed, +or invocations will fail. This can specify custom toolchains, installable +toolchains, or the absolute path to a toolchain.
+ -
+
+RUSTUP_DIST_SERVER(default:https://static.rust-lang.org). Sets the root +URL for downloading static resources related to Rust. You can change this to +instead use a local mirror, or to test the binaries from the staging +directory.
+ -
+
+RUSTUP_DIST_ROOThttps://static.rust-lang.org/dist). +UseRUSTUP_DIST_SERVERinstead.
+ -
+
+RUSTUP_UPDATE_ROOT(defaulthttps://static.rust-lang.org/rustup). Sets +the root URL for downloading self-update.
+ -
+
+RUSTUP_IO_THREADSunstable (defaults to reported cpu count). Sets the +number of threads to perform close IO in. Set to1to force +single-threaded IO for troubleshooting, or an arbitrary number to override +automatic detection.
+ -
+
+RUSTUP_TRACE_DIRunstable (default: no tracing). Enables tracing and +determines the directory that traces will be written too. Traces are of the +form PID.trace. Traces can be read by the Catapult project tracing viewer.
+ -
+
+RUSTUP_TERM_COLOR(default:auto). Controls whether colored output is used in the terminal. +Set toautoto use colors only in tty streams, toalwaysto always enable colors, +or toneverto disable colors.
+ -
+
+RUSTUP_UNPACK_RAMunstable (default free memory or 500MiB if unable to tell, min 210MiB). Caps the amount of +RAMrustupwill use for IO tasks while unpacking.
+ -
+
+RUSTUP_NO_BACKTRACE. Disables backtraces on non-panic errors even when +RUST_BACKTRACEis set.
+ -
+
+RUSTUP_PERMIT_COPY_RENAMEunstable. When set, allows rustup to fall-back +to copying files if attempts torenameresult in cross-device link +errors. These errors occur on OverlayFS, which is used by Docker. This +feature sacrifices some transactions protections and may be removed at any +point. Linux only.
+
Configuration
+Rustup has a TOML settings file at
+${RUSTUP_HOME}/settings.toml (which defaults to ~/.rustup or
+%USERPROFILE%/.rustup). The schema for this file is not part of the public
+interface for rustup - the rustup CLI should be used to query and set settings.
On Unix operating systems a fallback settings file is consulted for some
+settings. This fallback file is located at /etc/rustup/settings.toml and
+currently can define only default_toolchain.
Network proxies
+Enterprise networks often don’t have direct outside HTTP access, but enforce
+the use of proxies. If you’re on such a network, you can request that rustup
+uses a proxy by setting its URL in the environment. In most cases, setting
+https_proxy should be sufficient. Commands may differ between different
+systems and shells:
-
+
- On a Unix-like system with a shell like bash or zsh:
+
+export https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows Command Prompt (cmd):
+
+set https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows PowerShell (or PowerShell Core):
+
+$env:https_proxy="socks5://proxy.example.com:1080" +
+ - Replace
socks5://proxy.example.com:1080with +http://proxy.example.com:8080when an HTTP proxy is used instead.
+
If you need a more complex setup, rustup supports the convention used by the
+curl program, documented in the ENVIRONMENT section of its manual
+page.
The use of curl is presently deprecated, however it can still be used by
+providing the RUSTUP_USE_CURL environment variable, for example:
RUSTUP_USE_CURL=1 rustup update
+Note that some versions of libcurl apparently require you to drop the
+http:// or https:// prefix in environment variables. For example, export http_proxy=proxy.example.com:1080 (and likewise for HTTPS). If you are
+getting an SSL unknown protocol error from rustup via libcurl but the
+command-line curl command works fine, this may be the problem.
Examples
+| Command | Description |
|---|---|
rustup default nightly | Set the default toolchain to the latest nightly |
rustup set profile minimal | Set the default profile |
rustup target list | List all available targets for the active toolchain |
rustup target add arm-linux-androideabi | Install the Android target |
rustup target remove arm-linux-androideabi | Remove the Android target |
rustup run nightly rustc foo.rs | Run the nightly regardless of the active toolchain |
rustc +nightly foo.rs | Shorthand way to run a nightly compiler |
rustup run nightly bash | Run a shell configured for the nightly compiler |
rustup default stable-msvc | On Windows, use the MSVC toolchain instead of GNU |
rustup override set nightly-2015-04-01 | For the current directory, use a nightly from a specific date |
rustup toolchain link my-toolchain "C:\RustInstallation" | Install a custom toolchain by symlinking an existing installation |
rustup show | Show which toolchain will be used in the current directory |
rustup toolchain uninstall nightly | Uninstall a given toolchain |
rustup toolchain help | Show the help page for a subcommand (like toolchain) |
rustup man cargo | (Unix only) View the man page for a given command (like cargo) |
Security
+rustup is secure enough for most people, but it still needs work.
+rustup performs all downloads over HTTPS, but does not yet validate
+signatures of downloads.
File modes on installation honor umask as of 1.18.4, use umask if very tight +controls are desired.
+If you wish to report a security issue, please follow the Rust security +policy.
+FAQ
+Is this an official Rust project?
+Yes. rustup is an official Rust project. It is the recommended way to install +Rust at https://www.rust-lang.org.
+How is this related to multirust?
+rustup is the successor to multirust. rustup began as multirust-rs, a +rewrite of multirust from shell script to Rust, by Diggory Blake, and is now +maintained by The Rust Project.
+Can rustup download the Rust source code?
+The source for Rust’s standard library can be obtained by running rustup component add rust-src. It will be downloaded to the <toolchain root>/lib/rustlib/src/rust directory of the current toolchain.
The source for the compiler and tools must be obtained from the Rust +repository or the standalone source tarballs.
+rustup fails with Windows error 32
+If rustup fails with Windows error 32, it may be due to antivirus scanning
+in the background. Disable antivirus scanner and try again.
I get “error: could not remove ‘rustup-bin’ file: ‘C:\Users\USER\.cargo\bin\rustup.exe’”
+If rustup fails to self-update in this way it’s usually because RLS is
+running (your editor is open and running RLS). The solution is to stop RLS (by
+closing your editor) and try again.
rustup exited successfully but I can’t run rustc --version
+Restart your shell. This will reload your PATH environment
+variable to include Cargo’s bin directory ($CARGO_HOME/bin).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/devel/tomorrow-night.css b/devel/tomorrow-night.css
new file mode 100644
index 0000000000..81fe276e7f
--- /dev/null
+++ b/devel/tomorrow-night.css
@@ -0,0 +1,102 @@
+/* Tomorrow Night Theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment {
+ color: #969896;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-regexp,
+.ruby .hljs-constant,
+.xml .hljs-tag .hljs-title,
+.xml .hljs-pi,
+.xml .hljs-doctype,
+.html .hljs-doctype,
+.css .hljs-id,
+.css .hljs-class,
+.css .hljs-pseudo {
+ color: #cc6666;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.hljs-built_in,
+.hljs-literal,
+.hljs-params,
+.hljs-constant {
+ color: #de935f;
+}
+
+/* Tomorrow Yellow */
+.ruby .hljs-class .hljs-title,
+.css .hljs-rule .hljs-attribute {
+ color: #f0c674;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-value,
+.hljs-inheritance,
+.hljs-header,
+.hljs-name,
+.ruby .hljs-symbol,
+.xml .hljs-cdata {
+ color: #b5bd68;
+}
+
+/* Tomorrow Aqua */
+.hljs-title,
+.css .hljs-hexcolor {
+ color: #8abeb7;
+}
+
+/* Tomorrow Blue */
+.hljs-function,
+.python .hljs-decorator,
+.python .hljs-title,
+.ruby .hljs-function .hljs-title,
+.ruby .hljs-title .hljs-keyword,
+.perl .hljs-sub,
+.javascript .hljs-title,
+.coffeescript .hljs-title {
+ color: #81a2be;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.javascript .hljs-function {
+ color: #b294bb;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #1d1f21;
+ color: #c5c8c6;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+ opacity: 0.5;
+}
+
+.hljs-addition {
+ color: #718c00;
+}
+
+.hljs-deletion {
+ color: #c82829;
+}
diff --git a/elasticlunr.min.js b/elasticlunr.min.js
new file mode 100644
index 0000000000..94b20dd2ef
--- /dev/null
+++ b/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Security
+rustup is secure enough for most people, but it still needs work.
+rustup performs all downloads over HTTPS, but does not yet validate
+signatures of downloads.
File modes on installation honor umask as of 1.18.4, use umask if very tight +controls are desired.
+If you wish to report a security issue, please follow the Rust security +policy.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/examples.html b/examples.html
new file mode 100644
index 0000000000..e7646b55fe
--- /dev/null
+++ b/examples.html
@@ -0,0 +1,251 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Environment variables
+-
+
-
+
+RUSTUP_HOME(default:~/.rustupor%USERPROFILE%/.rustup). Sets the +rootrustupfolder, used for storing installed toolchains and +configuration options.
+ -
+
+RUSTUP_TOOLCHAIN(default: none). If set, will override the toolchain used +for all rust tool invocations. A toolchain with this name should be installed, +or invocations will fail. This can specify custom toolchains, installable +toolchains, or the absolute path to a toolchain.
+ -
+
+RUSTUP_DIST_SERVER(default:https://static.rust-lang.org). Sets the root +URL for downloading static resources related to Rust. You can change this to +instead use a local mirror, or to test the binaries from the staging +directory.
+ -
+
+RUSTUP_DIST_ROOThttps://static.rust-lang.org/dist). +UseRUSTUP_DIST_SERVERinstead.
+ -
+
+RUSTUP_UPDATE_ROOT(defaulthttps://static.rust-lang.org/rustup). Sets +the root URL for downloading self-update.
+ -
+
+RUSTUP_IO_THREADSunstable (defaults to reported cpu count). Sets the +number of threads to perform close IO in. Set to1to force +single-threaded IO for troubleshooting, or an arbitrary number to override +automatic detection.
+ -
+
+RUSTUP_TRACE_DIRunstable (default: no tracing). Enables tracing and +determines the directory that traces will be written too. Traces are of the +form PID.trace. Traces can be read by the Catapult project tracing viewer.
+ -
+
+RUSTUP_DEBUGunstable. When set, enables rustup’s debug logging.
+ -
+
+RUSTUP_TERM_COLOR(default:auto). Controls whether colored output is used in the terminal. +Set toautoto use colors only in tty streams, toalwaysto always enable colors, +or toneverto disable colors.
+ -
+
+RUSTUP_UNPACK_RAMunstable (default free memory or 500MiB if unable to tell, min 210MiB). Caps the amount of +RAMrustupwill use for IO tasks while unpacking.
+ -
+
+RUSTUP_NO_BACKTRACE. Disables backtraces on non-panic errors even when +RUST_BACKTRACEis set.
+ -
+
+RUSTUP_PERMIT_COPY_RENAMEunstable. When set, allows rustup to fall-back +to copying files if attempts torenameresult in cross-device link +errors. These errors occur on OverlayFS, which is used by Docker. This +feature sacrifices some transactions protections and may be removed at any +point. Linux only.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/faq.html b/faq.html
new file mode 100644
index 0000000000..e225f8081c
--- /dev/null
+++ b/faq.html
@@ -0,0 +1,249 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Examples
+| Command | Description |
|---|---|
rustup default nightly | Set the default toolchain to the latest nightly |
rustup set profile minimal | Set the default profile |
rustup target list | List all available targets for the active toolchain |
rustup target add arm-linux-androideabi | Install the Android target |
rustup target remove arm-linux-androideabi | Remove the Android target |
rustup run nightly rustc foo.rs | Run the nightly regardless of the active toolchain |
rustc +nightly foo.rs | Shorthand way to run a nightly compiler |
rustup run nightly bash | Run a shell configured for the nightly compiler |
rustup default stable-msvc | On Windows, use the MSVC toolchain instead of GNU |
rustup override set nightly-2015-04-01 | For the current directory, use a nightly from a specific date |
rustup toolchain link my-toolchain "C:\RustInstallation" | Install a custom toolchain by symlinking an existing installation |
rustup show | Show which toolchain will be used in the current directory |
rustup toolchain uninstall nightly | Uninstall a given toolchain |
rustup toolchain help | Show the help page for a subcommand (like toolchain) |
rustup man cargo | (Unix only) View the man page for a given command (like cargo) |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/favicon.png b/favicon.png
new file mode 100644
index 0000000000..a5b1aa16c4
Binary files /dev/null and b/favicon.png differ
diff --git a/favicon.svg b/favicon.svg
new file mode 100644
index 0000000000..90e0ea58bd
--- /dev/null
+++ b/favicon.svg
@@ -0,0 +1,22 @@
+
+
diff --git a/fonts/OPEN-SANS-LICENSE.txt b/fonts/OPEN-SANS-LICENSE.txt
new file mode 100644
index 0000000000..d645695673
--- /dev/null
+++ b/fonts/OPEN-SANS-LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/fonts/SOURCE-CODE-PRO-LICENSE.txt b/fonts/SOURCE-CODE-PRO-LICENSE.txt
new file mode 100644
index 0000000000..366206f549
--- /dev/null
+++ b/fonts/SOURCE-CODE-PRO-LICENSE.txt
@@ -0,0 +1,93 @@
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/fonts/fonts.css b/fonts/fonts.css
new file mode 100644
index 0000000000..858efa5980
--- /dev/null
+++ b/fonts/fonts.css
@@ -0,0 +1,100 @@
+/* Open Sans is licensed under the Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 */
+/* Source Code Pro is under the Open Font License. See https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL */
+
+/* open-sans-300 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 300;
+ src: local('Open Sans Light'), local('OpenSans-Light'),
+ url('open-sans-v17-all-charsets-300.woff2') format('woff2');
+}
+
+/* open-sans-300italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 300;
+ src: local('Open Sans Light Italic'), local('OpenSans-LightItalic'),
+ url('open-sans-v17-all-charsets-300italic.woff2') format('woff2');
+}
+
+/* open-sans-regular - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 400;
+ src: local('Open Sans Regular'), local('OpenSans-Regular'),
+ url('open-sans-v17-all-charsets-regular.woff2') format('woff2');
+}
+
+/* open-sans-italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 400;
+ src: local('Open Sans Italic'), local('OpenSans-Italic'),
+ url('open-sans-v17-all-charsets-italic.woff2') format('woff2');
+}
+
+/* open-sans-600 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 600;
+ src: local('Open Sans SemiBold'), local('OpenSans-SemiBold'),
+ url('open-sans-v17-all-charsets-600.woff2') format('woff2');
+}
+
+/* open-sans-600italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 600;
+ src: local('Open Sans SemiBold Italic'), local('OpenSans-SemiBoldItalic'),
+ url('open-sans-v17-all-charsets-600italic.woff2') format('woff2');
+}
+
+/* open-sans-700 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 700;
+ src: local('Open Sans Bold'), local('OpenSans-Bold'),
+ url('open-sans-v17-all-charsets-700.woff2') format('woff2');
+}
+
+/* open-sans-700italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 700;
+ src: local('Open Sans Bold Italic'), local('OpenSans-BoldItalic'),
+ url('open-sans-v17-all-charsets-700italic.woff2') format('woff2');
+}
+
+/* open-sans-800 - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: normal;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold'), local('OpenSans-ExtraBold'),
+ url('open-sans-v17-all-charsets-800.woff2') format('woff2');
+}
+
+/* open-sans-800italic - latin_vietnamese_latin-ext_greek-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Open Sans';
+ font-style: italic;
+ font-weight: 800;
+ src: local('Open Sans ExtraBold Italic'), local('OpenSans-ExtraBoldItalic'),
+ url('open-sans-v17-all-charsets-800italic.woff2') format('woff2');
+}
+
+/* source-code-pro-500 - latin_vietnamese_latin-ext_greek_cyrillic-ext_cyrillic */
+@font-face {
+ font-family: 'Source Code Pro';
+ font-style: normal;
+ font-weight: 500;
+ src: url('source-code-pro-v11-all-charsets-500.woff2') format('woff2');
+}
diff --git a/fonts/open-sans-v17-all-charsets-300.woff2 b/fonts/open-sans-v17-all-charsets-300.woff2
new file mode 100644
index 0000000000..9f51be370f
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-300italic.woff2 b/fonts/open-sans-v17-all-charsets-300italic.woff2
new file mode 100644
index 0000000000..2f54544841
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-300italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600.woff2 b/fonts/open-sans-v17-all-charsets-600.woff2
new file mode 100644
index 0000000000..f503d558d5
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-600italic.woff2 b/fonts/open-sans-v17-all-charsets-600italic.woff2
new file mode 100644
index 0000000000..c99aabe803
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-600italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700.woff2 b/fonts/open-sans-v17-all-charsets-700.woff2
new file mode 100644
index 0000000000..421a1ab25f
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-700italic.woff2 b/fonts/open-sans-v17-all-charsets-700italic.woff2
new file mode 100644
index 0000000000..12ce3d20d1
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-700italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800.woff2 b/fonts/open-sans-v17-all-charsets-800.woff2
new file mode 100644
index 0000000000..c94a223b03
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-800italic.woff2 b/fonts/open-sans-v17-all-charsets-800italic.woff2
new file mode 100644
index 0000000000..eed7d3c63d
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-800italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-italic.woff2 b/fonts/open-sans-v17-all-charsets-italic.woff2
new file mode 100644
index 0000000000..398b68a085
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-italic.woff2 differ
diff --git a/fonts/open-sans-v17-all-charsets-regular.woff2 b/fonts/open-sans-v17-all-charsets-regular.woff2
new file mode 100644
index 0000000000..8383e94c65
Binary files /dev/null and b/fonts/open-sans-v17-all-charsets-regular.woff2 differ
diff --git a/fonts/source-code-pro-v11-all-charsets-500.woff2 b/fonts/source-code-pro-v11-all-charsets-500.woff2
new file mode 100644
index 0000000000..722245682f
Binary files /dev/null and b/fonts/source-code-pro-v11-all-charsets-500.woff2 differ
diff --git a/highlight.css b/highlight.css
new file mode 100644
index 0000000000..ba57b82b27
--- /dev/null
+++ b/highlight.css
@@ -0,0 +1,82 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/highlight.js b/highlight.js
new file mode 100644
index 0000000000..3256c00ed3
--- /dev/null
+++ b/highlight.js
@@ -0,0 +1,53 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ rustup exited successfully but I can’t run
+
+
+
+
+ FAQ
+Is this an official Rust project?
+Yes. rustup is an official Rust project. It is the recommended way to install +Rust at https://www.rust-lang.org.
+How is this related to multirust?
+rustup is the successor to multirust. rustup began as multirust-rs, a +rewrite of multirust from shell script to Rust, by Diggory Blake, and is now +maintained by The Rust Project.
+Can rustup download the Rust source code?
+The source for Rust’s standard library can be obtained by running rustup component add rust-src. It will be downloaded to the <toolchain root>/lib/rustlib/src/rust directory of the current toolchain.
The source for the compiler and tools must be obtained from the Rust +repository or the standalone source tarballs.
+rustup fails with Windows error 32
+If rustup fails with Windows error 32, it may be due to antivirus scanning
+in the background. Disable antivirus scanner and try again.
I get “error: could not remove ‘rustup-bin’ file: ‘C:\Users\USER\.cargo\bin\rustup.exe’”
+If rustup fails to self-update in this way it’s usually because RLS is
+running (your editor is open and running RLS). The solution is to stop RLS (by
+closing your editor) and try again.
rustup exited successfully but I can’t run rustc --version
+Restart your shell. This will reload your PATH environment
+variable to include Cargo’s bin directory ($CARGO_HOME/bin).
":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/already-installed-rust.html b/installation/already-installed-rust.html
new file mode 100644
index 0000000000..122012c753
--- /dev/null
+++ b/installation/already-installed-rust.html
@@ -0,0 +1,254 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction
+rustup installs The Rust Programming Language from the official +release channels, enabling you to easily switch between stable, beta, and +nightly compilers and keep them updated. It makes cross-compiling simpler with +binary builds of the standard library for common platforms. And it runs on all +platforms Rust supports.
+Check out the Concepts chapter for an overview of how rustup works and some +of the terminology it uses. The Installation chapter covers installing +rustup and getting started.
+The source code of rustup and this manual may be found at +https://github.com/rust-lang/rustup. If you find a problem, check out the +issue tracker.
+Release notes for rustup may be found in the CHANGELOG.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/images/component-msvc.png b/installation/images/component-msvc.png
new file mode 100644
index 0000000000..db301d6be7
Binary files /dev/null and b/installation/images/component-msvc.png differ
diff --git a/installation/images/component-sdk.png b/installation/images/component-sdk.png
new file mode 100644
index 0000000000..f4d11f0e21
Binary files /dev/null and b/installation/images/component-sdk.png differ
diff --git a/installation/images/step1.png b/installation/images/step1.png
new file mode 100644
index 0000000000..d450b05211
Binary files /dev/null and b/installation/images/step1.png differ
diff --git a/installation/images/step2.png b/installation/images/step2.png
new file mode 100644
index 0000000000..c5daca1f4d
Binary files /dev/null and b/installation/images/step2.png differ
diff --git a/installation/images/step3.png b/installation/images/step3.png
new file mode 100644
index 0000000000..04ce4913dd
Binary files /dev/null and b/installation/images/step3.png differ
diff --git a/installation/images/step4.png b/installation/images/step4.png
new file mode 100644
index 0000000000..6caef3036f
Binary files /dev/null and b/installation/images/step4.png differ
diff --git a/installation/images/step5.png b/installation/images/step5.png
new file mode 100644
index 0000000000..867a65fa3f
Binary files /dev/null and b/installation/images/step5.png differ
diff --git a/installation/index.html b/installation/index.html
new file mode 100644
index 0000000000..a1e70e2451
--- /dev/null
+++ b/installation/index.html
@@ -0,0 +1,301 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Already installed Rust?
+Several Linux distributions package Rust, and you may wish to use the packaged
+toolchain, such as for distribution package development. You may also wish to
+use a rustup-managed toolchain such as nightly or beta. Normally, rustup
+will complain that you already have Rust installed in /usr and refuse to
+install. However, you can install Rust via rustup and have it coexist with
+your distribution’s packaged Rust.
When you initially install Rust with rustup, pass the -y option to make it
+ignore the packaged Rust toolchain and install a rustup-managed toolchain
+into ~/.cargo/bin. Add that directory to your $PATH (or let rustup do it
+for you by not passing --no-modify-path). Then, to tell rustup about your
+system toolchain, run:
rustup toolchain link system /usr
+You can then use “system” as a rustup toolchain, just like “nightly”.
+For example, using the toolchain override shorthand, you can run cargo +system build
+to build with the system toolchain, or cargo +nightly build to build with nightly.
If you do distribution Rust development, you should likely make “system” your +default toolchain:
+rustup default system
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/other.html b/installation/other.html
new file mode 100644
index 0000000000..01679105e2
--- /dev/null
+++ b/installation/other.html
@@ -0,0 +1,466 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+Follow the instructions at https://www.rust-lang.org/tools/install. If that +doesn’t work for you there are other installation methods.
+rustup installs rustc, cargo, rustup and other standard tools to
+Cargo’s bin directory. On Unix it is located at $HOME/.cargo/bin and on
+Windows at %USERPROFILE%\.cargo\bin. This is the same directory that cargo install will install Rust programs and Cargo plugins.
This directory will be in your $PATH environment variable, which means you
+can run them from the shell without further configuration. Open a new shell
+and type the following:
rustc --version
+If you see something like rustc 1.19.0 (0ade33941 2017-07-17) then you are
+ready to Rust. If you decide Rust isn’t your thing, you can completely remove
+it from your system by running rustup self uninstall.
Choosing where to install
+rustup allows you to customise your installation by setting the environment
+variables CARGO_HOME and RUSTUP_HOME before running the rustup-init
+executable. As mentioned in the Environment Variables section, RUSTUP_HOME
+sets the root rustup folder, which is used for storing installed toolchains
+and configuration options. CARGO_HOME contains cache files used by cargo.
Note that you will need to ensure these environment variables are always set
+and that CARGO_HOME/bin is in the $PATH environment variable when using
+the toolchain.
Installing nightly
+If you specify the nightly channel when installing rustup, the
+rustup-init script will do a “forced” installation by default. A “forced”
+installation means it will install the nightly channel regardless of whether
+it might be missing components that you want. If you want to install rustup
+with the nightly channel, and ensure it has the components that you want, you
+will need to do this in two phases. For example, if you want to make a fresh
+installation of rustup and then install nightly along with clippy or
+miri, first install rustup without a toolchain:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
+Next you can install nightly allowing rustup to downgrade until it finds
+the components you need:
rustup toolchain install nightly --allow-downgrade --profile minimal --component clippy
+This can be used to great effect in CI, to get you a toolchain rapidly which +meets your criteria.
+Enable tab completion for Bash, Fish, Zsh, or PowerShell
+rustup now supports generating completion scripts for Bash, Fish, Zsh, and
+PowerShell. See rustup help completions for full details, but the gist is as
+simple as using one of the following:
# Bash
+$ rustup completions bash > ~/.local/share/bash-completion/completions/rustup
+
+# Bash (macOS/Homebrew)
+$ rustup completions bash > $(brew --prefix)/etc/bash_completion.d/rustup.bash-completion
+
+# Fish
+$ mkdir -p ~/.config/fish/completions
+$ rustup completions fish > ~/.config/fish/completions/rustup.fish
+
+# Zsh
+$ rustup completions zsh > ~/.zfunc/_rustup
+
+# PowerShell v5.0+
+$ rustup completions powershell >> $PROFILE.CurrentUserCurrentHost
+# or
+$ rustup completions powershell | Out-String | Invoke-Expression
+Note: you may need to restart your shell in order for the changes to take +effect.
+For zsh, you must then add the following line in your ~/.zshrc before
+compinit:
fpath+=~/.zfunc
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/package-managers.html b/installation/package-managers.html
new file mode 100644
index 0000000000..299ea679dc
--- /dev/null
+++ b/installation/package-managers.html
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Other installation methods
+The primary installation method, as described at https://rustup.rs, differs +by platform:
+-
+
- On Windows, download and run the
rustup-init.exebuilt for the +x86_64-pc-windows-msvctarget. In general, this is the build of +rustupone should install on Windows. This will require the Visual C++ +Build Tools 2019 or equivalent (Visual Studio 2019, etc.) to already be +installed. If you would prefer to install GNU toolchains or the i686 +toolchains by default this can be modified at install time, either +interactively, with the--default-hostflag, or after installation +viarustup set default-host.
+ - On Unix, run
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | shin your shell. This +downloads and runsrustup-init.sh, which in turn downloads and runs the +correct version of therustup-initexecutable for your platform.
+
rustup-init accepts arguments, which can be passed through the shell script.
+Some examples:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --help
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --no-modify-path
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --profile minimal --default-toolchain nightly
+Using a package manager
+++Please note that the rustup project is not maintaining any package mentioned in this section. +If you have encountered any problems installing
+rustupwith a package manager, +please contact the package maintainer(s) for further information.
APT
+Starting from Debian 13 (trixie) and Ubuntu 24.04 (noble),
+you may use apt to install rustup:
$ sudo apt install rustup
+Homebrew
+You can use brew to install rustup-init1:
$ brew install rustup-init
+Then execute rustup-init to proceed with the installation.
When the installation is complete,
+make sure that $HOME/.cargo/bin is in your $PATH,
+and you should be able to use rustup normally.
1
+
+This is not to be confused with the rust package,
+which is a brew-managed rust toolchain installation.
Manual installation
+You can manually download rustup-init for a given target from
+https://static.rust-lang.org/rustup/dist/{target-triple}/rustup-init[.exe]2 3.
+
+Direct links
+-
+
- aarch64-apple-darwin
+
-
+
- sha256 file +
+ - aarch64-linux-android
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-musl
+
-
+
- sha256 file +
+ - arm-linux-androideabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - armv7-linux-androideabi
+
-
+
- sha256 file +
+ - armv7-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - i686-apple-darwin
+
-
+
- sha256 file +
+ - i686-linux-android
+
-
+
- sha256 file +
+ - i686-pc-windows-gnu2
+
-
+
- sha256 file +
+ - i686-pc-windows-msvc3
+
-
+
- sha256 file +
+ - i686-unknown-linux-gnu
+
-
+
- sha256 file +
+ - loongarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - mips-unknown-linux-gnu
+
-
+
- sha256 file +
+ - mips64-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mips64el-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mipsel-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64le-unknown-linux-gnu
+
-
+
- sha256 file +
+ - s390x-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-apple-darwin
+
-
+
- sha256 file +
+ - x86_64-linux-android
+
-
+
- sha256 file +
+ - x86_64-pc-windows-gnu2
+
-
+
- sha256 file +
+ - x86_64-pc-windows-msvc3
+
-
+
- sha256 file +
+ - x86_64-unknown-freebsd
+
-
+
- sha256 file +
+ - x86_64-unknown-illumos
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-musl
+
-
+
- sha256 file +
+ - x86_64-unknown-netbsd
+
-
+
- sha256 file +
+
To get a previous version, use
+https://static.rust-lang.org/rustup/archive/{rustup-version}/{target-triple}/rustup-init[.exe].
SHA-256 checksums are also available by appending .sha256 to the link.
2
+
+Windows GNU builds require no additional software for basic use. +However, many library crates will not be able to compile until +the full MSYS2 with MinGW has been installed.
+3
+
+MSVC builds of rustup additionally require an installation of
+Visual Studio 2019 or the Visual C++ Build Tools 2019. For Visual
+Studio, make sure to check the “C++ tools” and “Windows 10 SDK” option.
Self-compiled installation
+To install rustup from source, check out the git repository from
+https://github.com/rust-lang/rustup and run cargo run --release. Note that
+after installation the rustup toolchains will supersede any pre-existing
+toolchains by prepending ~/.cargo/bin to the PATH environment variable.
Redirecting to... already-installed-rust.html.
+ + diff --git a/installation/windows-msvc.html b/installation/windows-msvc.html new file mode 100644 index 0000000000..4c12168a32 --- /dev/null +++ b/installation/windows-msvc.html @@ -0,0 +1,277 @@ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation/windows.html b/installation/windows.html
new file mode 100644
index 0000000000..b8922114dc
--- /dev/null
+++ b/installation/windows.html
@@ -0,0 +1,274 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MSVC prerequisites
+To compile programs into an exe file, Rust requires a linker, libraries and Windows API import libraries.
+For msvc targets these can be acquired through Visual Studio.
Automatic install
+If you don’t have Visual Studio already installed then rustup-init will offer to automatically install the prerequisites. +Doing so means you can skip the rest of this page. +However, it installs Visual Studio Community edition which may not be appropriate for all users. +It is free for individuals, academic and open source use, but not for other uses, such as in proprietary enterprise software. +Users should ask their organisation which edition is right for them. +See licensing terms for more details.
+Manual install
+Download Visual Studio. +Rust supports Visual Studio 2013 and later but it is recommended that you use the latest version (currently 2022) for new projects. +You can opt to download only the Build Tools for Visual Studio, which does not include the IDE. +However this requires you already have a license to the Community, Professional or Enterprise edition.
+Once you’ve downloaded and started the installer, the easiest way to get everything installed is to select “Desktop Development with C++”. +This will include the necessary components. +On the “Language Packs” tab, make sure the English language pack is installed in addition to your preferred language.
+If you want more details on the installation process or want to further customize the install then follow the walkthrough below. +Otherwise complete the Visual Studio install and continue with installing Rust.
+Walkthrough: Installing Visual Studio 2022
+This walkthrough uses the Community edition of Visual Studio but the Professional, Enterprise and the Build Tools all work the same way.
+The installer will start by linking to the license and for your edition of Visual Studio and then preparing the installer.
+
+
Once this finishes, you can then select the components to be installed.
+Here we use the “Workload” tab to select the “Desktop Development with C++” workload.
+This will includes all needed components for Rust:
+
Installing only the required components (optional)
+If you’d like a more minimal install (and won’t be doing C++ development) then you can use the “Individual Components” tab to select just the essentials, which are:
+-
+
- MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) +
- Windows 11 SDK (10.0.22621.0) +
Note that the specific version of the Windows SDK doesn’t matter for pure Rust code but if using C++ as well you’ll likely want either the latest or whichever version is required by the C++ project (or both).
+
+
Completing the install
+After choosing the components, switch to the “Language Packs” tab and add the English language pack in addition to your preferred language.
+
Finally click the install button and wait for everything to be installed.
+
Once finished, you can continue on to installing Rust.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 0000000000..1636231883
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Windows
+rustup works the same on Windows as it does on Unix, but there are some
+special considerations for Rust developers on Windows. As mentioned on the
+Rust download page, there are two 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.
When targeting the MSVC ABI, Rust additionally requires an installation of
+Visual Studio so rustc can use its linker and libraries.
When targeting the GNU ABI, no additional software is strictly required for basic use. +However, many library crates will not be able to compile until the full MSYS2 with MinGW has been installed.
+By default rustup on Windows configures Rust to target the MSVC ABI, that is
+a target triple of either i686-pc-windows-msvc, x86_64-pc-windows-msvc, or aarch64-pc-windows-msvc
+depending on the CPU architecture of the host Windows OS. The toolchains that
+rustup chooses to install, unless told otherwise through the toolchain
+specification, will be compiled to run on that target triple host and will
+target that triple by default.
You can change this behavior with rustup set default-host or during
+installation.
For example, to explicitly select the 32-bit MSVC host:
+$ rustup set default-host i686-pc-windows-msvc
+Or to choose the 64 bit GNU toolchain:
+$ rustup set default-host x86_64-pc-windows-gnu
+Since the MSVC ABI provides the best interoperation with other Windows
+software it is recommended for most purposes. The GNU toolchain is always
+available, even if you don’t use it by default. Just install it with rustup toolchain install:
$ rustup toolchain install stable-gnu
+You don’t need to switch toolchains to support all windows targets though; a +single toolchain supports all four x86 windows targets:
+$ rustup target add x86_64-pc-windows-msvc
+$ rustup target add x86_64-pc-windows-gnu
+$ rustup target add i686-pc-windows-msvc
+$ rustup target add i686-pc-windows-gnu
+See the Cross-compilation chapter for more details on specifying different +targets with the same compiler.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/overrides.html b/overrides.html
new file mode 100644
index 0000000000..21dc08acab
--- /dev/null
+++ b/overrides.html
@@ -0,0 +1,354 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Network proxies
+Enterprise networks often don’t have direct outside HTTP access, but enforce
+the use of proxies. If you’re on such a network, you can request that rustup
+uses a proxy by setting its URL in the environment. In most cases, setting
+https_proxy should be sufficient. Commands may differ between different
+systems and shells:
-
+
- On a Unix-like system with a shell like bash or zsh:
+
+export https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows Command Prompt (cmd):
+
+set https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows PowerShell (or PowerShell Core):
+
+$env:https_proxy="socks5://proxy.example.com:1080" +
+ - Replace
socks5://proxy.example.com:1080with +http://proxy.example.com:8080when an HTTP proxy is used instead.
+
If you need a more complex setup, rustup supports the convention used by the
+curl program, documented in the ENVIRONMENT section of its manual
+page.
The use of curl is presently deprecated, however it can still be used by
+providing the RUSTUP_USE_CURL environment variable, for example:
RUSTUP_USE_CURL=1 rustup update
+Note that some versions of libcurl apparently require you to drop the
+http:// or https:// prefix in environment variables. For example, export http_proxy=proxy.example.com:1080 (and likewise for HTTPS). If you are
+getting an SSL unknown protocol error from rustup via libcurl but the
+command-line curl command works fine, this may be the problem.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/print.html b/print.html
new file mode 100644
index 0000000000..7825477929
--- /dev/null
+++ b/print.html
@@ -0,0 +1,1300 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Overrides
+rustup automatically determines which toolchain to use when one of the
+installed commands like rustc is executed. There are several ways to control
+and override which toolchain is used:
-
+
- A toolchain override shorthand used on the command-line, such as
cargo +beta.
+ - The
RUSTUP_TOOLCHAINenvironment variable.
+ - A directory override, set with the
rustup overridecommand.
+ - The
rust-toolchain.tomlfile.
+ - The default toolchain. +
The toolchain is chosen in the order listed above, using the first one that is
+specified. There is one exception though: directory overrides and the
+rust-toolchain.toml file are also preferred by their proximity to the current
+directory. That is, these two override methods are discovered by walking up
+the directory tree toward the filesystem root, and a rust-toolchain.toml file
+that is closer to the current directory will be preferred over a directory
+override that is further away.
To verify which toolchain is active, you can use rustup show,
+which will also try to install the corresponding
+toolchain if the current one has not been installed according to the above rules.
+(Please note that this behavior is subject to change, as detailed in issue #1397.)
Toolchain override shorthand
+The rustup toolchain proxies can be instructed directly to use a specific
+toolchain, a convenience for developers who often test different toolchains.
+If the first argument to cargo, rustc or other tools in the toolchain
+begins with +, it will be interpreted as a rustup toolchain name, and that
+toolchain will be preferred, as in
cargo +beta test
+Directory overrides
+Directories can be assigned their own Rust toolchain with rustup override.
+When a directory has an override then any time rustc or cargo is run
+inside that directory, or one of its child directories, the override toolchain
+will be invoked.
To use to a specific nightly for a directory:
+rustup override set nightly-2014-12-18
+Or a specific stable release:
+rustup override set 1.0.0
+To see the active toolchain use rustup show. To remove the override and use
+the default toolchain again, rustup override unset.
The per-directory overrides are stored in a configuration file in rustup’s
+home directory.
The toolchain file
+Some projects find themselves ‘pinned’ to a specific release of Rust and want +this information reflected in their source repository. This is most often the +case for nightly-only software that pins to a revision from the release +archives.
+In these cases the toolchain can be named in the project’s directory in a file
+called rust-toolchain.toml or rust-toolchain. If both files are present in
+a directory, the latter is used for backwards compatibility. The files use the
+TOML format and have the following layout:
[toolchain]
+channel = "nightly-2020-07-10"
+components = [ "rustfmt", "rustc-dev" ]
+targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
+profile = "minimal"
+The [toolchain] section is mandatory, and at least one property must be
+specified. channel and path are mutually exclusive.
For backwards compatibility, rust-toolchain files also support a legacy
+format that only contains a toolchain name without any TOML encoding, e.g.
+just nightly-2021-01-21. The file has to be encoded in US-ASCII in this case
+(if you are on Windows, check the encoding and that it does not start with a
+BOM). The legacy format is not available in rust-toolchain.toml files.
If you see the following error (when running rustc, cargo or other command)
error: invalid channel name '[toolchain]' in '/PATH/TO/DIRECTORY/rust-toolchain'
+it means you’re running rustup pre-1.23.0 and trying to interact with a project
+that uses the new TOML encoding in the rust-toolchain file. You need to upgrade
+rustup to 1.23.0+.
The rust-toolchain.toml/rust-toolchain files are suitable to check in to
+source control. If that’s done, Cargo.lock should probably be tracked too if
+the toolchain is pinned to a specific release, to avoid potential compatibility
+issues with dependencies.
Toolchain file settings
+channel
+The channel setting specifies which toolchain to use. The value is a
+string in the following form:
<channel>[-<date>]
+
+<channel> = stable|beta|nightly|<major.minor.patch>
+<date> = YYYY-MM-DD
+Note that this is a more restricted form than rustup toolchains
+generally, and cannot be used to specify custom toolchains or
+host-specific toolchains.
path
+The path setting allows a custom toolchain to be used. The value is an
+absolute path string.
Since a path directive directly names a local toolchain, other options
+like components, targets, and profile have no effect.
channel and path are mutually exclusive, since a path already
+points to a specific toolchain.
profile
+The profile setting names a group of components to be installed. The
+value is a string. The valid options are: minimal, default, and
+complete. See profiles for details of each.
Note that if not specified, the default profile is not necessarily
+used, as a different default profile might have been set with rustup set profile.
components
+The components setting contains a list of additional components to
+install. The value is a list of strings. See components for a list of
+components. Note that different toolchains may have different components
+available.
The components listed here are additive with the current profile.
+targets
+The targets setting contains a list of platforms to install for
+cross-compilation. The value is a list of strings.
The host platform is automatically included; the targets listed here are +additive.
+Default toolchain
+If no other overrides are set, the global default toolchain will be used. This
+default can be chosen when rustup is installed. The rustup default
+command can be used to set and query the current default. Run rustup default
+without any arguments to print the current default. Specify a toolchain as an
+argument to change the default:
rustup default nightly-2020-07-27
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 0000000000..dc03e0a02d
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keeping
+
+rustup exited successfully but I can’t run
+
+
+
+
+ Introduction
+rustup installs The Rust Programming Language from the official +release channels, enabling you to easily switch between stable, beta, and +nightly compilers and keep them updated. It makes cross-compiling simpler with +binary builds of the standard library for common platforms. And it runs on all +platforms Rust supports.
+Check out the Concepts chapter for an overview of how rustup works and some +of the terminology it uses. The Installation chapter covers installing +rustup and getting started.
+The source code of rustup and this manual may be found at +https://github.com/rust-lang/rustup. If you find a problem, check out the +issue tracker.
+Release notes for rustup may be found in the CHANGELOG.
+Installation
+Follow the instructions at https://www.rust-lang.org/tools/install. If that +doesn’t work for you there are other installation methods.
+rustup installs rustc, cargo, rustup and other standard tools to
+Cargo’s bin directory. On Unix it is located at $HOME/.cargo/bin and on
+Windows at %USERPROFILE%\.cargo\bin. This is the same directory that cargo install will install Rust programs and Cargo plugins.
This directory will be in your $PATH environment variable, which means you
+can run them from the shell without further configuration. Open a new shell
+and type the following:
rustc --version
+If you see something like rustc 1.19.0 (0ade33941 2017-07-17) then you are
+ready to Rust. If you decide Rust isn’t your thing, you can completely remove
+it from your system by running rustup self uninstall.
Choosing where to install
+rustup allows you to customise your installation by setting the environment
+variables CARGO_HOME and RUSTUP_HOME before running the rustup-init
+executable. As mentioned in the Environment Variables section, RUSTUP_HOME
+sets the root rustup folder, which is used for storing installed toolchains
+and configuration options. CARGO_HOME contains cache files used by cargo.
Note that you will need to ensure these environment variables are always set
+and that CARGO_HOME/bin is in the $PATH environment variable when using
+the toolchain.
Installing nightly
+If you specify the nightly channel when installing rustup, the
+rustup-init script will do a “forced” installation by default. A “forced”
+installation means it will install the nightly channel regardless of whether
+it might be missing components that you want. If you want to install rustup
+with the nightly channel, and ensure it has the components that you want, you
+will need to do this in two phases. For example, if you want to make a fresh
+installation of rustup and then install nightly along with clippy or
+miri, first install rustup without a toolchain:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none -y
+Next you can install nightly allowing rustup to downgrade until it finds
+the components you need:
rustup toolchain install nightly --allow-downgrade --profile minimal --component clippy
+This can be used to great effect in CI, to get you a toolchain rapidly which +meets your criteria.
+Enable tab completion for Bash, Fish, Zsh, or PowerShell
+rustup now supports generating completion scripts for Bash, Fish, Zsh, and
+PowerShell. See rustup help completions for full details, but the gist is as
+simple as using one of the following:
# Bash
+$ rustup completions bash > ~/.local/share/bash-completion/completions/rustup
+
+# Bash (macOS/Homebrew)
+$ rustup completions bash > $(brew --prefix)/etc/bash_completion.d/rustup.bash-completion
+
+# Fish
+$ mkdir -p ~/.config/fish/completions
+$ rustup completions fish > ~/.config/fish/completions/rustup.fish
+
+# Zsh
+$ rustup completions zsh > ~/.zfunc/_rustup
+
+# PowerShell v5.0+
+$ rustup completions powershell >> $PROFILE.CurrentUserCurrentHost
+# or
+$ rustup completions powershell | Out-String | Invoke-Expression
+Note: you may need to restart your shell in order for the changes to take +effect.
+For zsh, you must then add the following line in your ~/.zshrc before
+compinit:
fpath+=~/.zfunc
+Windows
+rustup works the same on Windows as it does on Unix, but there are some
+special considerations for Rust developers on Windows. As mentioned on the
+Rust download page, there are two 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.
When targeting the MSVC ABI, Rust additionally requires an installation of
+Visual Studio so rustc can use its linker and libraries.
When targeting the GNU ABI, no additional software is strictly required for basic use. +However, many library crates will not be able to compile until the full MSYS2 with MinGW has been installed.
+By default rustup on Windows configures Rust to target the MSVC ABI, that is
+a target triple of either i686-pc-windows-msvc, x86_64-pc-windows-msvc, or aarch64-pc-windows-msvc
+depending on the CPU architecture of the host Windows OS. The toolchains that
+rustup chooses to install, unless told otherwise through the toolchain
+specification, will be compiled to run on that target triple host and will
+target that triple by default.
You can change this behavior with rustup set default-host or during
+installation.
For example, to explicitly select the 32-bit MSVC host:
+$ rustup set default-host i686-pc-windows-msvc
+Or to choose the 64 bit GNU toolchain:
+$ rustup set default-host x86_64-pc-windows-gnu
+Since the MSVC ABI provides the best interoperation with other Windows
+software it is recommended for most purposes. The GNU toolchain is always
+available, even if you don’t use it by default. Just install it with rustup toolchain install:
$ rustup toolchain install stable-gnu
+You don’t need to switch toolchains to support all windows targets though; a +single toolchain supports all four x86 windows targets:
+$ rustup target add x86_64-pc-windows-msvc
+$ rustup target add x86_64-pc-windows-gnu
+$ rustup target add i686-pc-windows-msvc
+$ rustup target add i686-pc-windows-gnu
+See the Cross-compilation chapter for more details on specifying different +targets with the same compiler.
+MSVC prerequisites
+To compile programs into an exe file, Rust requires a linker, libraries and Windows API import libraries.
+For msvc targets these can be acquired through Visual Studio.
Automatic install
+If you don’t have Visual Studio already installed then rustup-init will offer to automatically install the prerequisites. +Doing so means you can skip the rest of this page. +However, it installs Visual Studio Community edition which may not be appropriate for all users. +It is free for individuals, academic and open source use, but not for other uses, such as in proprietary enterprise software. +Users should ask their organisation which edition is right for them. +See licensing terms for more details.
+Manual install
+Download Visual Studio. +Rust supports Visual Studio 2013 and later but it is recommended that you use the latest version (currently 2022) for new projects. +You can opt to download only the Build Tools for Visual Studio, which does not include the IDE. +However this requires you already have a license to the Community, Professional or Enterprise edition.
+Once you’ve downloaded and started the installer, the easiest way to get everything installed is to select “Desktop Development with C++”. +This will include the necessary components. +On the “Language Packs” tab, make sure the English language pack is installed in addition to your preferred language.
+If you want more details on the installation process or want to further customize the install then follow the walkthrough below. +Otherwise complete the Visual Studio install and continue with installing Rust.
+Walkthrough: Installing Visual Studio 2022
+This walkthrough uses the Community edition of Visual Studio but the Professional, Enterprise and the Build Tools all work the same way.
+The installer will start by linking to the license and for your edition of Visual Studio and then preparing the installer.
+
+
Once this finishes, you can then select the components to be installed.
+Here we use the “Workload” tab to select the “Desktop Development with C++” workload.
+This will includes all needed components for Rust:
+
Installing only the required components (optional)
+If you’d like a more minimal install (and won’t be doing C++ development) then you can use the “Individual Components” tab to select just the essentials, which are:
+-
+
- MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) +
- Windows 11 SDK (10.0.22621.0) +
Note that the specific version of the Windows SDK doesn’t matter for pure Rust code but if using C++ as well you’ll likely want either the latest or whichever version is required by the C++ project (or both).
+
+
Completing the install
+After choosing the components, switch to the “Language Packs” tab and add the English language pack in addition to your preferred language.
+
Finally click the install button and wait for everything to be installed.
+
Once finished, you can continue on to installing Rust.
+Other installation methods
+The primary installation method, as described at https://rustup.rs, differs +by platform:
+-
+
- On Windows, download and run the
rustup-init.exebuilt for the +x86_64-pc-windows-msvctarget. In general, this is the build of +rustupone should install on Windows. This will require the Visual C++ +Build Tools 2019 or equivalent (Visual Studio 2019, etc.) to already be +installed. If you would prefer to install GNU toolchains or the i686 +toolchains by default this can be modified at install time, either +interactively, with the--default-hostflag, or after installation +viarustup set default-host.
+ - On Unix, run
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | shin your shell. This +downloads and runsrustup-init.sh, which in turn downloads and runs the +correct version of therustup-initexecutable for your platform.
+
rustup-init accepts arguments, which can be passed through the shell script.
+Some examples:
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --help
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --no-modify-path
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain nightly
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain none
+$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --profile minimal --default-toolchain nightly
+Using a package manager
+++Please note that the rustup project is not maintaining any package mentioned in this section. +If you have encountered any problems installing
+rustupwith a package manager, +please contact the package maintainer(s) for further information.
APT
+Starting from Debian 13 (trixie) and Ubuntu 24.04 (noble),
+you may use apt to install rustup:
$ sudo apt install rustup
+Homebrew
+You can use brew to install rustup-init1:
$ brew install rustup-init
+Then execute rustup-init to proceed with the installation.
When the installation is complete,
+make sure that $HOME/.cargo/bin is in your $PATH,
+and you should be able to use rustup normally.
1
+
+This is not to be confused with the rust package,
+which is a brew-managed rust toolchain installation.
Manual installation
+You can manually download rustup-init for a given target from
+https://static.rust-lang.org/rustup/dist/{target-triple}/rustup-init[.exe]2 3.
+
+Direct links
+-
+
- aarch64-apple-darwin
+
-
+
- sha256 file +
+ - aarch64-linux-android
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - aarch64-unknown-linux-musl
+
-
+
- sha256 file +
+ - arm-linux-androideabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabi
+
-
+
- sha256 file +
+ - arm-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - armv7-linux-androideabi
+
-
+
- sha256 file +
+ - armv7-unknown-linux-gnueabihf
+
-
+
- sha256 file +
+ - i686-apple-darwin
+
-
+
- sha256 file +
+ - i686-linux-android
+
-
+
- sha256 file +
+ - i686-pc-windows-gnu2
+
-
+
- sha256 file +
+ - i686-pc-windows-msvc3
+
-
+
- sha256 file +
+ - i686-unknown-linux-gnu
+
-
+
- sha256 file +
+ - loongarch64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - mips-unknown-linux-gnu
+
-
+
- sha256 file +
+ - mips64-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mips64el-unknown-linux-gnuabi64
+
-
+
- sha256 file +
+ - mipsel-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - powerpc64le-unknown-linux-gnu
+
-
+
- sha256 file +
+ - s390x-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-apple-darwin
+
-
+
- sha256 file +
+ - x86_64-linux-android
+
-
+
- sha256 file +
+ - x86_64-pc-windows-gnu2
+
-
+
- sha256 file +
+ - x86_64-pc-windows-msvc3
+
-
+
- sha256 file +
+ - x86_64-unknown-freebsd
+
-
+
- sha256 file +
+ - x86_64-unknown-illumos
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-gnu
+
-
+
- sha256 file +
+ - x86_64-unknown-linux-musl
+
-
+
- sha256 file +
+ - x86_64-unknown-netbsd
+
-
+
- sha256 file +
+
To get a previous version, use
+https://static.rust-lang.org/rustup/archive/{rustup-version}/{target-triple}/rustup-init[.exe].
SHA-256 checksums are also available by appending .sha256 to the link.
2
+
+Windows GNU builds require no additional software for basic use. +However, many library crates will not be able to compile until +the full MSYS2 with MinGW has been installed.
+3
+
+MSVC builds of rustup additionally require an installation of
+Visual Studio 2019 or the Visual C++ Build Tools 2019. For Visual
+Studio, make sure to check the “C++ tools” and “Windows 10 SDK” option.
Self-compiled installation
+To install rustup from source, check out the git repository from
+https://github.com/rust-lang/rustup and run cargo run --release. Note that
+after installation the rustup toolchains will supersede any pre-existing
+toolchains by prepending ~/.cargo/bin to the PATH environment variable.
Already installed Rust?
+Several Linux distributions package Rust, and you may wish to use the packaged
+toolchain, such as for distribution package development. You may also wish to
+use a rustup-managed toolchain such as nightly or beta. Normally, rustup
+will complain that you already have Rust installed in /usr and refuse to
+install. However, you can install Rust via rustup and have it coexist with
+your distribution’s packaged Rust.
When you initially install Rust with rustup, pass the -y option to make it
+ignore the packaged Rust toolchain and install a rustup-managed toolchain
+into ~/.cargo/bin. Add that directory to your $PATH (or let rustup do it
+for you by not passing --no-modify-path). Then, to tell rustup about your
+system toolchain, run:
rustup toolchain link system /usr
+You can then use “system” as a rustup toolchain, just like “nightly”.
+For example, using the toolchain override shorthand, you can run cargo +system build
+to build with the system toolchain, or cargo +nightly build to build with nightly.
If you do distribution Rust development, you should likely make “system” your +default toolchain:
+rustup default system
+Concepts
+How rustup works
+rustup is a toolchain multiplexer. It installs and manages many Rust
+toolchains and presents them all through a single set of tools installed to
+~/.cargo/bin. The rustc and cargo executables installed in
+~/.cargo/bin are proxies that delegate to the real toolchain. rustup
+then provides mechanisms to easily change the active toolchain by
+reconfiguring the behavior of the proxies.
So when rustup is first installed, running rustc will run the proxy in
+$HOME/.cargo/bin/rustc, which in turn will run the stable compiler. If you
+later change the default toolchain to nightly with rustup default nightly,
+then that same proxy will run the nightly compiler instead.
This is similar to Ruby’s rbenv, Python’s pyenv, or Node’s nvm.
+Terminology
+-
+
-
+
channel — Rust is released to three different “channels”: stable, beta, +and nightly. See the Channels chapter for more details.
+
+ -
+
toolchain — A “toolchain” is a complete installation of the Rust +compiler (
+rustc) and related tools (likecargo). A toolchain +specification includes the release channel or version, and the host +platform that the toolchain runs on.
+ -
+
target —
+rustcis capable of generating code for many platforms. The +“target” specifies the platform that the code will be generated for. By +default,cargoandrustcuse the host toolchain’s platform as the +target. To build for a different target, usually the target’s standard +library needs to be installed first via therustup targetcommand. See the +Cross-compilation chapter for more details.
+ -
+
component — Each release of Rust includes several “components”, some of +which are required (like
+rustc) and some that are optional (like +clippy). See the Components chapter for more detail.
+ -
+
profile — In order to make it easier to work with components, a +“profile” defines a grouping of components. See the Profiles chapter for +more details.
+
+ -
+
proxy — A wrapper for a common Rust component (like
+rustc), built to forward +CLI invocations to the active Rust toolchain. See the Proxies chapter for more details.
+
Channels
+Rust is released to three different “channels”: stable, beta, and nightly. The
+stable releases are made every 6 weeks (with occasional point releases). Beta
+releases are the version that will appear in the next stable release. Nightly
+releases are made every night. See The Rust Book for more details
+on Rust’s train release model. The release schedule is posted to the Rust
+Forge. rustup assists with installing different channels, keeping them
+up-to-date, and easily switching between them.
After a release channel has been installed, rustup can be used to update the
+installed version to the latest release on that channel. See the Keeping rust
+up to date section for more information.
rustup can also install specific versions of Rust, such as 1.45.2 or
+nightly-2020-07-27. See the Toolchains chapter for more information on
+installing different channels and releases. See the Overrides chapter for
+details on switching between toolchains and pinning your project to a specific
+toolchain.
Working with nightly Rust
+rustup gives you easy access to the nightly compiler and its experimental
+features. To add it just run rustup toolchain install nightly:
$ rustup toolchain install nightly
+info: syncing channel updates for 'nightly'
+info: downloading toolchain manifest
+info: downloading component 'rustc'
+info: downloading component 'rust-std'
+info: downloading component 'rust-docs'
+info: downloading component 'cargo'
+info: installing component 'rustc'
+info: installing component 'rust-std'
+info: installing component 'rust-docs'
+info: installing component 'cargo'
+
+ nightly installed: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now Rust nightly is installed, but not activated. To test it out you can run a +command from the nightly toolchain like
+$ rustup run nightly rustc --version
+rustc 1.9.0-nightly (02310fd31 2016-03-19)
+But more likely you want to use it for a while. To switch to nightly globally,
+change the default with rustup default nightly:
$ rustup default nightly
+info: using existing install for 'nightly'
+info: default toolchain set to 'nightly'
+
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Now any time you run cargo or rustc you will be running the nightly
+compiler.
With nightly installed any time you run rustup update, the nightly channel
+will be updated in addition to stable:
$ rustup update
+info: syncing channel updates for 'stable'
+info: syncing channel updates for 'nightly'
+info: checking for self-update
+info: downloading self-update
+
+ stable unchanged: rustc 1.7.0 (a5d1e7a59 2016-02-29)
+ nightly unchanged: rustc 1.9.0-nightly (02310fd31 2016-03-19)
+
+Nightly availability
+Nightly toolchains may fail to build, so for any given date and target
+platform there may not be a toolchain available. Furthermore, nightly builds
+may be published with missing non-default components (such as clippy).
+As such, it can be difficult to find fully-working nightlies. Use the
+rustup-components-history project to find the build status of recent
+nightly toolchains and components.
When you attempt to install or update the nightly channel, rustup will
+check if a required or previously installed component is missing. If it is
+missing, rustup will automatically search for an older release that contains
+the required components. There are several ways to change this behavior:
-
+
- Use the
--forceflag torustup toolchain installto force it to install +the most recent version even if there is a missing component.
+ - Use the
--profileflag torustup toolchain installto use a different +profile that does not contain the missing component. For example, +--profile=minimalshould always work, as the minimal set is required to +exist. See the Profiles chapter for more detail.
+ - Install a specific date that contains the components you need. For example,
+
rustup toolchain install nightly-2020-07-27. You can then use overrides +to pin to that specific release.
+
Toolchains
+Many rustup commands deal with toolchains, a single installation of the
+Rust compiler. rustup supports multiple types of toolchains. The most basic
+track the official release channels: stable, beta and nightly; but
+rustup can also install toolchains from the official archives, for alternate
+host platforms, and from local builds.
Toolchain specification
+Standard release channel toolchain names have the following form:
+<channel>[-<date>][-<host>]
+
+<channel> = stable|beta|nightly|<major.minor>|<major.minor.patch>
+<date> = YYYY-MM-DD
+<host> = <target-triple>
+‘channel’ is a named release channel, a major and minor version number such as
+1.42, or a fully specified version number, such as 1.42.0. Channel names
+can be optionally appended with an archive date, as in nightly-2014-12-18, in
+which case the toolchain is downloaded from the archive for that date.
Finally, the host may be specified as a target triple. This is most useful for +installing a 32-bit compiler on a 64-bit platform, or for installing the +MSVC-based toolchain on Windows. For example:
+$ rustup toolchain install stable-x86_64-pc-windows-msvc
+For convenience, elements of the target triple that are omitted will be +inferred, so the above could be written:
+$ rustup toolchain install stable-msvc
+Toolchain names that don’t name a channel instead can be used to name custom +toolchains.
+Custom toolchains
+For convenience of developers working on Rust itself, rustup can manage
+local builds of the Rust toolchain. To teach rustup about your build, run:
$ rustup toolchain link my-toolchain path/to/my/toolchain/sysroot
+For example, on Ubuntu you might clone rust-lang/rust into ~/rust, build
+it, and then run:
$ rustup toolchain link my-toolchain ~/rust/build/x86_64-unknown-linux-gnu/stage2/
+$ rustup default my-toolchain
+Now you can name my-toolchain as any other rustup toolchain. Create a
+rustup toolchain for each of your rust-lang/rust workspaces and test them
+easily with rustup run my-toolchain rustc.
Because the rust-lang/rust tree does not include Cargo, when cargo is
+invoked for a custom toolchain and it is not available, rustup will attempt
+to use cargo from one of the release channels, preferring ‘nightly’, then
+‘beta’ or ‘stable’.
Components
+Each toolchain has several “components”, some of which are required (like
+rustc) and some that are optional (like clippy). The rustup component command is used to manage the installed components. For example,
+run rustup component list to see a list of available and installed
+components.
Components can be added when installing a toolchain with the --component
+flag. For example:
rustup toolchain install nightly --component rust-docs
+Components can be added to an already-installed toolchain with the rustup component command:
rustup component add rust-docs
+To make it easier to choose which components are installed, rustup has the
+concept of “profiles” which provide named groupings of different components.
+See the Profiles chapter for more detail.
Most components have a target-triple suffix, such as
+rustc-x86_64-apple-darwin, to signify the platform the component is for.
The set of available components may vary with different releases and +toolchains. The following is an overview of the different components:
+-
+
rustc— The Rust compiler and Rustdoc.
+cargo— Cargo is a package manager and build tool.
+rustfmt— Rustfmt is a tool for automatically formatting code.
+rust-std— This is the Rust standard library. There is a separate +rust-stdcomponent for each target thatrustcsupports, such as +rust-std-x86_64-pc-windows-msvc. See the Cross-compilation chapter for +more detail.
+rust-docs— This is a local copy of the Rust documentation. Use the +rustup doccommand to open the documentation in a web browser. Runrustup doc --helpfor more options.
+rust-analyzer— rust-analyzer is a language server that provides support +for editors and IDEs.
+clippy— Clippy is a lint tool that provides extra checks for common +mistakes and stylistic choices.
+miri— Miri is an experimental Rust interpreter, which can be used for +checking for undefined-behavior.
+rust-src— This is a local copy of the source code of the Rust standard +library. This can be used by some tools, such as rust-analyzer, to provide +auto-completion for functions within the standard library; Miri which is a +Rust interpreter; and Cargo’s experimental build-std feature, which allows +you to rebuild the standard library locally.
+rust-mingw— This contains a linker and platform libraries for building on +thex86_64-pc-windows-gnuplatform.
+llvm-tools— This component contains a collection of LLVM tools. +Note that this component has not been stabilized and may change in the +future and is provided as-is. +See #85658.
+rustc-dev— This component contains the compiler as a library. Most users +will not need this; it is only needed for development of tools that link +to the compiler, such as making modifications to Clippy.
+
Previous components
+These components have been deprecated and are not published in new Rust releases.
+-
+
rls— RLS is a language server that is deprecated and has been replaced +by rust-analyzer.
+rust-analysis— Metadata about the standard library, used by RLS.
+
Component availability
+Not all components are available for all toolchains. Especially on the nightly +channel, some components may not be included if they are in a broken state. +The current status of all the components may be found on the rustup +components history page. See the Nightly availability section for more +details.
+Profiles
+rustup has the concept of “profiles”. They are groups of components you
+can choose to download while installing a new Rust toolchain. The profiles
+available at this time are minimal, default, and complete:
-
+
- The minimal profile includes as few components as possible to get a
+working compiler (
rustc,rust-std, andcargo). It’s recommended to use +this component on Windows systems if you don’t use local documentation (the +large number of files can cause issues with some Antivirus systems), and in +CI.
+ - The default profile includes all of components in the minimal
+profile, and adds
rust-docs,rustfmt, andclippy. This profile will be +used byrustupby default, and it’s the one recommended for general use.
+ - The complete profile includes all the components available through
+
rustup. This should never be used, as it includes every component ever +included in the metadata and thus will almost always fail. If you are +looking for a way to install devtools such asmirior IDE integration +tools (rust-analyzer), you should use thedefaultprofile and +install the needed additional components manually, either by usingrustup component addor by using-cwhen installing the toolchain.
+
To change the profile rustup install uses by default, you can use the
+rustup set profile command.
+For example, to select the minimal profile you can use:
rustup set profile minimal
+You can also directly select the profile used when installing a toolchain with:
+rustup install --profile <name>
+It’s also possible to choose the default profile when installing rustup for
+the first time, either interactively by choosing the “Customize installation”
+option or programmatically by passing the --profile=<name> flag. Profiles
+will only affect newly installed toolchains: as usual it will be possible to
+install individual components later with: rustup component add.
Proxies
+rustup provides a number of wrappers for common Rust tools.
+These are called proxies and represent commands which are
+provided by the various components.
The list of proxies is currently static in rustup and is as follows:
-
+
-
+
+rustcis the compiler for the Rust programming language, provided by the project itself and comes from therustccomponent.
+ -
+
+rustdocis a tool distributed in therustccomponent which helps you to generate documentation for Rust projects.
+ -
+
+cargois the Rust package manager which downloads your Rust package’s dependencies, compiles your packages, makes distributable packages, and uploads them to crates.io (the Rust community’s package registry). It comes from thecargocomponent.
+ -
+
+rust-lldb,rust-gdb, andrust-gdbguiare simple wrappers around thelldb,gdb, andgdbguidebuggers respectively. The wrappers enable some pretty-printing of Rust values and add some convenience features to the debuggers by means of their scripting interfaces.
+ -
+
+rust-analyzeris part of the Rust IDE integration tooling. It implements the language-server protocol to permit IDEs and editors such as Visual Studio Code, Vim, or Emacs, access to the semantics of the Rust code you are editing. It comes from therust-analyzercomponent.
+ -
+
+cargo-clippyandclippy-driverare related to theclippylinting tool which provides extra checks for common mistakes and stylistic choices and it comes from theclippycomponent.
+ -
+
+cargo-miriis an experimental interpreter for Rust’s mid-level intermediate representation (MIR) and it comes from themiricomponent.
+ -
+
+rlsis a deprecated IDE tool that has been replaced byrust-analyzer. It comes from therlscomponent.
+
Basic usage
+Keeping Rust up to date
+Rust is distributed on three different release channels: stable, beta, and
+nightly. rustup uses the stable channel by default, which
+represents the latest release of Rust. Stable publishes new releases every six weeks.
When a new version of Rust is released, simply type rustup update to update:
$ rustup update
+info: syncing channel updates for 'stable'
+info: downloading component 'rustc'
+info: downloading component 'rust-std'
+info: downloading component 'rust-docs'
+info: downloading component 'cargo'
+info: installing component 'rustc'
+info: installing component 'rust-std'
+info: installing component 'rust-docs'
+info: installing component 'cargo'
+info: checking for self-update
+info: downloading self-update
+
+ stable updated: rustc 1.7.0 (a5d1e7a59 2016-02-29)
+
+Keeping rustup up to date
+If your rustup was built with the no-self-update feature, it can not update
+itself. This is not the default, and only versions of rustup built with
+--no-default-features, or obtained from a third-party distributor who has
+disabled it (such as NixOS).
Otherwise Rustup can update itself. It is possible to control Rustup’s automatic
+self update mechanism with the auto-self-update configuration variable. This
+setting supports three values: enable and disable and check-only.
-
+
disablewill ensure that no automatic self updating actions are taken.
+enablewill mean thatrustup updateand similar commands will also check for, and install, any update to Rustup.
+check-onlywill cause any automatic self update to check and report on any updates, but not to automatically install them.
+
Whether auto-self-update is enable or not, you can request that Rustup
+update itself to the latest version of rustup by running rustup self update.
+This will not download new toolchains:
$ rustup self update
+info: checking for self-update
+info: downloading self-update
+Disabling self updates on a per-invocation basis
+++Self updates can also be suppressed on individual invocations of
+rustupby +passing the argument--no-self-updatewhen runningrustup updateor +rustup toolchain install.
Help system
+The rustup command-line has a built-in help system that provides more
+information about each command. Run rustup help for an overview. Detailed
+help for each subcommand is also available. For example, run rustup toolchain install --help for specifics on installing toolchains.
Overrides
+rustup automatically determines which toolchain to use when one of the
+installed commands like rustc is executed. There are several ways to control
+and override which toolchain is used:
-
+
- A toolchain override shorthand used on the command-line, such as
cargo +beta.
+ - The
RUSTUP_TOOLCHAINenvironment variable.
+ - A directory override, set with the
rustup overridecommand.
+ - The
rust-toolchain.tomlfile.
+ - The default toolchain. +
The toolchain is chosen in the order listed above, using the first one that is
+specified. There is one exception though: directory overrides and the
+rust-toolchain.toml file are also preferred by their proximity to the current
+directory. That is, these two override methods are discovered by walking up
+the directory tree toward the filesystem root, and a rust-toolchain.toml file
+that is closer to the current directory will be preferred over a directory
+override that is further away.
To verify which toolchain is active, you can use rustup show,
+which will also try to install the corresponding
+toolchain if the current one has not been installed according to the above rules.
+(Please note that this behavior is subject to change, as detailed in issue #1397.)
Toolchain override shorthand
+The rustup toolchain proxies can be instructed directly to use a specific
+toolchain, a convenience for developers who often test different toolchains.
+If the first argument to cargo, rustc or other tools in the toolchain
+begins with +, it will be interpreted as a rustup toolchain name, and that
+toolchain will be preferred, as in
cargo +beta test
+Directory overrides
+Directories can be assigned their own Rust toolchain with rustup override.
+When a directory has an override then any time rustc or cargo is run
+inside that directory, or one of its child directories, the override toolchain
+will be invoked.
To use to a specific nightly for a directory:
+rustup override set nightly-2014-12-18
+Or a specific stable release:
+rustup override set 1.0.0
+To see the active toolchain use rustup show. To remove the override and use
+the default toolchain again, rustup override unset.
The per-directory overrides are stored in a configuration file in rustup’s
+home directory.
The toolchain file
+Some projects find themselves ‘pinned’ to a specific release of Rust and want +this information reflected in their source repository. This is most often the +case for nightly-only software that pins to a revision from the release +archives.
+In these cases the toolchain can be named in the project’s directory in a file
+called rust-toolchain.toml or rust-toolchain. If both files are present in
+a directory, the latter is used for backwards compatibility. The files use the
+TOML format and have the following layout:
[toolchain]
+channel = "nightly-2020-07-10"
+components = [ "rustfmt", "rustc-dev" ]
+targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
+profile = "minimal"
+The [toolchain] section is mandatory, and at least one property must be
+specified. channel and path are mutually exclusive.
For backwards compatibility, rust-toolchain files also support a legacy
+format that only contains a toolchain name without any TOML encoding, e.g.
+just nightly-2021-01-21. The file has to be encoded in US-ASCII in this case
+(if you are on Windows, check the encoding and that it does not start with a
+BOM). The legacy format is not available in rust-toolchain.toml files.
If you see the following error (when running rustc, cargo or other command)
error: invalid channel name '[toolchain]' in '/PATH/TO/DIRECTORY/rust-toolchain'
+it means you’re running rustup pre-1.23.0 and trying to interact with a project
+that uses the new TOML encoding in the rust-toolchain file. You need to upgrade
+rustup to 1.23.0+.
The rust-toolchain.toml/rust-toolchain files are suitable to check in to
+source control. If that’s done, Cargo.lock should probably be tracked too if
+the toolchain is pinned to a specific release, to avoid potential compatibility
+issues with dependencies.
Toolchain file settings
+channel
+The channel setting specifies which toolchain to use. The value is a
+string in the following form:
<channel>[-<date>]
+
+<channel> = stable|beta|nightly|<major.minor.patch>
+<date> = YYYY-MM-DD
+Note that this is a more restricted form than rustup toolchains
+generally, and cannot be used to specify custom toolchains or
+host-specific toolchains.
path
+The path setting allows a custom toolchain to be used. The value is an
+absolute path string.
Since a path directive directly names a local toolchain, other options
+like components, targets, and profile have no effect.
channel and path are mutually exclusive, since a path already
+points to a specific toolchain.
profile
+The profile setting names a group of components to be installed. The
+value is a string. The valid options are: minimal, default, and
+complete. See profiles for details of each.
Note that if not specified, the default profile is not necessarily
+used, as a different default profile might have been set with rustup set profile.
components
+The components setting contains a list of additional components to
+install. The value is a list of strings. See components for a list of
+components. Note that different toolchains may have different components
+available.
The components listed here are additive with the current profile.
+targets
+The targets setting contains a list of platforms to install for
+cross-compilation. The value is a list of strings.
The host platform is automatically included; the targets listed here are +additive.
+Default toolchain
+If no other overrides are set, the global default toolchain will be used. This
+default can be chosen when rustup is installed. The rustup default
+command can be used to set and query the current default. Run rustup default
+without any arguments to print the current default. Specify a toolchain as an
+argument to change the default:
rustup default nightly-2020-07-27
+Cross-compilation
+Rust supports a great number of platforms. For many of these platforms
+The Rust Project publishes binary releases of the standard library, and for
+some the full compiler. rustup gives easy access to all of them.
When you first install a toolchain, rustup installs only the standard
+library for your host platform - that is, the architecture and operating
+system you are presently running. To compile to other platforms you must
+install other target platforms. This is done with the rustup target add
+command. For example, to add the Android target:
$ rustup target add arm-linux-androideabi
+info: downloading component 'rust-std' for 'arm-linux-androideabi'
+info: installing component 'rust-std' for 'arm-linux-androideabi'
+With the arm-linux-androideabi target installed you can then build for
+Android with Cargo by passing the --target flag, as in cargo build --target=arm-linux-androideabi.
Note that rustup target add only installs the Rust standard library for a
+given target. There are typically other tools necessary to cross-compile,
+particularly a linker. For example, to cross compile to Android the Android
+NDK must be installed. In the future, rustup will provide assistance
+installing the NDK components as well. See the target section of the
+cargo configuration for how to setup a linker to use for a certain target.
To install a target for a toolchain that isn’t the default toolchain use the
+--toolchain argument of rustup target add, like so:
$ rustup target add --toolchain <toolchain> <target>...
+To see a list of available targets, rustup target list. To remove a
+previously-added target, rustup target remove.
Environment variables
+-
+
-
+
+RUSTUP_HOME(default:~/.rustupor%USERPROFILE%/.rustup). Sets the +rootrustupfolder, used for storing installed toolchains and +configuration options.
+ -
+
+RUSTUP_TOOLCHAIN(default: none). If set, will override the toolchain used +for all rust tool invocations. A toolchain with this name should be installed, +or invocations will fail. This can specify custom toolchains, installable +toolchains, or the absolute path to a toolchain.
+ -
+
+RUSTUP_DIST_SERVER(default:https://static.rust-lang.org). Sets the root +URL for downloading static resources related to Rust. You can change this to +instead use a local mirror, or to test the binaries from the staging +directory.
+ -
+
+RUSTUP_DIST_ROOThttps://static.rust-lang.org/dist). +UseRUSTUP_DIST_SERVERinstead.
+ -
+
+RUSTUP_UPDATE_ROOT(defaulthttps://static.rust-lang.org/rustup). Sets +the root URL for downloading self-update.
+ -
+
+RUSTUP_IO_THREADSunstable (defaults to reported cpu count). Sets the +number of threads to perform close IO in. Set to1to force +single-threaded IO for troubleshooting, or an arbitrary number to override +automatic detection.
+ -
+
+RUSTUP_TRACE_DIRunstable (default: no tracing). Enables tracing and +determines the directory that traces will be written too. Traces are of the +form PID.trace. Traces can be read by the Catapult project tracing viewer.
+ -
+
+RUSTUP_DEBUGunstable. When set, enables rustup’s debug logging.
+ -
+
+RUSTUP_TERM_COLOR(default:auto). Controls whether colored output is used in the terminal. +Set toautoto use colors only in tty streams, toalwaysto always enable colors, +or toneverto disable colors.
+ -
+
+RUSTUP_UNPACK_RAMunstable (default free memory or 500MiB if unable to tell, min 210MiB). Caps the amount of +RAMrustupwill use for IO tasks while unpacking.
+ -
+
+RUSTUP_NO_BACKTRACE. Disables backtraces on non-panic errors even when +RUST_BACKTRACEis set.
+ -
+
+RUSTUP_PERMIT_COPY_RENAMEunstable. When set, allows rustup to fall-back +to copying files if attempts torenameresult in cross-device link +errors. These errors occur on OverlayFS, which is used by Docker. This +feature sacrifices some transactions protections and may be removed at any +point. Linux only.
+
Configuration
+Rustup has a TOML settings file at
+${RUSTUP_HOME}/settings.toml (which defaults to ~/.rustup or
+%USERPROFILE%/.rustup). The schema for this file is not part of the public
+interface for rustup - the rustup CLI should be used to query and set settings.
On Unix operating systems a fallback settings file is consulted for some
+settings. This fallback file is located at /etc/rustup/settings.toml and
+currently can define only default_toolchain.
Network proxies
+Enterprise networks often don’t have direct outside HTTP access, but enforce
+the use of proxies. If you’re on such a network, you can request that rustup
+uses a proxy by setting its URL in the environment. In most cases, setting
+https_proxy should be sufficient. Commands may differ between different
+systems and shells:
-
+
- On a Unix-like system with a shell like bash or zsh:
+
+export https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows Command Prompt (cmd):
+
+set https_proxy=socks5://proxy.example.com:1080 +
+ - On Windows PowerShell (or PowerShell Core):
+
+$env:https_proxy="socks5://proxy.example.com:1080" +
+ - Replace
socks5://proxy.example.com:1080with +http://proxy.example.com:8080when an HTTP proxy is used instead.
+
If you need a more complex setup, rustup supports the convention used by the
+curl program, documented in the ENVIRONMENT section of its manual
+page.
The use of curl is presently deprecated, however it can still be used by
+providing the RUSTUP_USE_CURL environment variable, for example:
RUSTUP_USE_CURL=1 rustup update
+Note that some versions of libcurl apparently require you to drop the
+http:// or https:// prefix in environment variables. For example, export http_proxy=proxy.example.com:1080 (and likewise for HTTPS). If you are
+getting an SSL unknown protocol error from rustup via libcurl but the
+command-line curl command works fine, this may be the problem.
Examples
+| Command | Description |
|---|---|
rustup default nightly | Set the default toolchain to the latest nightly |
rustup set profile minimal | Set the default profile |
rustup target list | List all available targets for the active toolchain |
rustup target add arm-linux-androideabi | Install the Android target |
rustup target remove arm-linux-androideabi | Remove the Android target |
rustup run nightly rustc foo.rs | Run the nightly regardless of the active toolchain |
rustc +nightly foo.rs | Shorthand way to run a nightly compiler |
rustup run nightly bash | Run a shell configured for the nightly compiler |
rustup default stable-msvc | On Windows, use the MSVC toolchain instead of GNU |
rustup override set nightly-2015-04-01 | For the current directory, use a nightly from a specific date |
rustup toolchain link my-toolchain "C:\RustInstallation" | Install a custom toolchain by symlinking an existing installation |
rustup show | Show which toolchain will be used in the current directory |
rustup toolchain uninstall nightly | Uninstall a given toolchain |
rustup toolchain help | Show the help page for a subcommand (like toolchain) |
rustup man cargo | (Unix only) View the man page for a given command (like cargo) |
Security
+rustup is secure enough for most people, but it still needs work.
+rustup performs all downloads over HTTPS, but does not yet validate
+signatures of downloads.
File modes on installation honor umask as of 1.18.4, use umask if very tight +controls are desired.
+If you wish to report a security issue, please follow the Rust security +policy.
+FAQ
+Is this an official Rust project?
+Yes. rustup is an official Rust project. It is the recommended way to install +Rust at https://www.rust-lang.org.
+How is this related to multirust?
+rustup is the successor to multirust. rustup began as multirust-rs, a +rewrite of multirust from shell script to Rust, by Diggory Blake, and is now +maintained by The Rust Project.
+Can rustup download the Rust source code?
+The source for Rust’s standard library can be obtained by running rustup component add rust-src. It will be downloaded to the <toolchain root>/lib/rustlib/src/rust directory of the current toolchain.
The source for the compiler and tools must be obtained from the Rust +repository or the standalone source tarballs.
+rustup fails with Windows error 32
+If rustup fails with Windows error 32, it may be due to antivirus scanning
+in the background. Disable antivirus scanner and try again.
I get “error: could not remove ‘rustup-bin’ file: ‘C:\Users\USER\.cargo\bin\rustup.exe’”
+If rustup fails to self-update in this way it’s usually because RLS is
+running (your editor is open and running RLS). The solution is to stop RLS (by
+closing your editor) and try again.
rustup exited successfully but I can’t run rustc --version
+Restart your shell. This will reload your PATH environment
+variable to include Cargo’s bin directory ($CARGO_HOME/bin).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tomorrow-night.css b/tomorrow-night.css
new file mode 100644
index 0000000000..81fe276e7f
--- /dev/null
+++ b/tomorrow-night.css
@@ -0,0 +1,102 @@
+/* Tomorrow Night Theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* https://github.com/jmblog/color-themes-for-highlightjs */
+
+/* Tomorrow Comment */
+.hljs-comment {
+ color: #969896;
+}
+
+/* Tomorrow Red */
+.hljs-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-regexp,
+.ruby .hljs-constant,
+.xml .hljs-tag .hljs-title,
+.xml .hljs-pi,
+.xml .hljs-doctype,
+.html .hljs-doctype,
+.css .hljs-id,
+.css .hljs-class,
+.css .hljs-pseudo {
+ color: #cc6666;
+}
+
+/* Tomorrow Orange */
+.hljs-number,
+.hljs-preprocessor,
+.hljs-pragma,
+.hljs-built_in,
+.hljs-literal,
+.hljs-params,
+.hljs-constant {
+ color: #de935f;
+}
+
+/* Tomorrow Yellow */
+.ruby .hljs-class .hljs-title,
+.css .hljs-rule .hljs-attribute {
+ color: #f0c674;
+}
+
+/* Tomorrow Green */
+.hljs-string,
+.hljs-value,
+.hljs-inheritance,
+.hljs-header,
+.hljs-name,
+.ruby .hljs-symbol,
+.xml .hljs-cdata {
+ color: #b5bd68;
+}
+
+/* Tomorrow Aqua */
+.hljs-title,
+.css .hljs-hexcolor {
+ color: #8abeb7;
+}
+
+/* Tomorrow Blue */
+.hljs-function,
+.python .hljs-decorator,
+.python .hljs-title,
+.ruby .hljs-function .hljs-title,
+.ruby .hljs-title .hljs-keyword,
+.perl .hljs-sub,
+.javascript .hljs-title,
+.coffeescript .hljs-title {
+ color: #81a2be;
+}
+
+/* Tomorrow Purple */
+.hljs-keyword,
+.javascript .hljs-function {
+ color: #b294bb;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #1d1f21;
+ color: #c5c8c6;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+ opacity: 0.5;
+}
+
+.hljs-addition {
+ color: #718c00;
+}
+
+.hljs-deletion {
+ color: #c82829;
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Security
+rustup is secure enough for most people, but it still needs work.
+rustup performs all downloads over HTTPS, but does not yet validate
+signatures of downloads.
File modes on installation honor umask as of 1.18.4, use umask if very tight +controls are desired.
+If you wish to report a security issue, please follow the Rust security +policy.
+ +