Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 3.96 KB

starting-rust.md

File metadata and controls

93 lines (63 loc) · 3.96 KB
Raw

Starting with Rust

Rust has multiple toolchains. For this course, we'll be using the 1.40.0 release. The easiest way to install Rust is to first install rustup, the Rust version management tool. The directions below should work both on Linux and in Windows (assuming you've first installed the Windows Linux Subsystem). More on installing Rust is available from the Rust website.

Install Rustup

curl https://sh.rustup.rs -sSf | sh

If you're uncomfortable running a script directly from the internet, you can first inspect the script by visiting the site https://rustup.rs/.

Install Rust 1.40.0

Once you've successfully installed rustup, you can install version 1.40.0 of the Rust compiler simply by doing:

rustup install 1.40.0

Rust Tools

In addition to the main rust toolchain, there are a couple of command line tools that will make writing your code easier. You can install these as follows:

rustup component add clippy
rustup component add rustfmt

Clippy is a linter for Rust that will help you write better code. You can read more about it here.

Rustfmt is a code formatter for Rust. You can read more about it here.

Additionally, if you plan to use the Rust Language Server (rls), you can do that with the following command:

rustup component add rls-preview rust-analysis rust-src

This is useful for setting up Rust support in your editor of choice (more on this below).

Accessing Rust Documentation

rustup installs an offline version of the Rust Book. To access it, run rustup doc --book. You can also access the Rust documentation online at https://doc.rust-lang.org/.

Setting up Your Editor

Below, we've documented steps for setting up Rust in the most common text editors. If you don't see your editor, let Tim Steinberger (ts409415@ohio.edu) know so he can update this document. There is a (slightly outdated) list of editors and IDEs with Rust support (and what features they support for Rust) available here.

Atom

Install the ide-rust package. More information on this package can be found here.

Emacs

Install rust-mode. The easiest way to install it is to configure MELPA with M-x package install rust-mode. If you do not want to use MELPA you can add

(add-to-list 'load-path "/path/to/rust-mode/")
(autoload 'rust-mode "rust-mode" nil t)
(add-to-list 'auto-mode-alist '("\\.rs\\'" . rust-mode))

To your .emacs file. More information on rust-mode (including configuring MELPA) is available here.

Sublime

Install the Rust Enhanced package. More information on the package can be found here.

VSCode

Install the Rust (rls) extension. More information can be found here.

There are other extensions, but I recommend this one since it is written by the Rust team.

Vim/Neovim

Install the vim-lsp, asyncomplete, asyncomplete-lsp, and async plugins using your preferred package manager (requires vim8 or neovim).

Add the following to your .vimrc (or .config/nvim/init.vim for neovim users).

if executable('rls')
    au User lsp_setup call lsp#register_server({
        \ 'name': 'rls',
        \ 'cmd': {server_info->['rustup', 'run', 'nightly', 'rls']},
        \ 'root_uri':{server_info->lsp#utils#path_to_uri(lsp#utils#find_nearest_parent_file_directory(lsp#utils#get_buffer_path(), 'Cargo.toml'))},
        \ 'whitelist': ['rust'],
        \ })
endif