Setting up your Rust development environment using Dev Containers
Setting up a new development environment that's configured with all the SDKs and tools you need to get started working can be a multi-step process that is error-prone. Especially when you don't know whether you want to commit to a specific technology or don't have too much space on your device, you might not want to install everything on your device. Additionally, cleaning up and removing everything you installed isn't always 100%. This is where development environments like Dev Containers can come in handy.
What are Dev Containers
A development container (Dev Container) lets you use a container as a full development environment.
Because your development environment is in a container, the environment is isolated. The builds are reproducible and disposable. This means you can quickly stand up a new clean development environments and dispose of them just as easily.
For more details, see the Dev Containers website.
If you have Docker installed, you can run them locally. Otherwise, you can run Dev Containers using GitHub Codespaces
What are GitHub Codespaces
A codespace is a development environment that's hosted in the cloud.
For more details, see the GitHub Codespaces website.
Set up Dev Container for Rust Development
Create a new directory.
Add a Dev Container configuration file called .devcontainer.json that contains the following content:
{ "name": "Rust Development Environment", "image": "mcr.microsoft.com/devcontainers/rust:latest", "customizations": { "vscode": { "extensions": [ "rust-lang.rust-analyzer" ] } } }
- name: A human friendly name to identify your development environment. It's not as important when you only have one environment but if you have different environments, it can be useful for differentiating between the various configurations.
- image: For the most customization, you can provide the path to a Docker file. However, to make things easier, there are a set of prebuilt container images. In this case, I'm using the Rust image.
- customizations.vscode.extensions: A list of Visual Studio Code extensions that can help you with your development. In this case, it's the rust-analyzer.
At minimum, this is all you need to get started.
Start your environment
Visual Studio Code provides good support for Dev Containers.
- Install VS Code
- Open your directory where you configured your Dev Container in Visual Studio Code
- Install the Dev Containers VS Code extension.
- Open the command palette in VS Code. In the menu bar, select View > Command Palette.
- Enter the following command >Dev Containers: Open Dev Container. This will start building your dev container. Wait for it to start.
Check your environment
Once your Dev Container starts, check that rustc
is installed.
- Open the terminal.
- Run
rustc -h
. A help message should output to the console for the Rust compiler.
Build your app
For simplicity, I've used the Hello World sample from the Rust By Example website.
Create a new file called hello.rs.
Add the following code:
fn main () { println!("Hello World!"); }
Compile your program
rustc hello.rs
This will generate an executable called hello
Run your app
./hello
The application should print out the string "Hello World" to the console.
That's it! You now have a Rust development environment to get started learning and building apps.
Conclusion
Dev Containers make it easy for you to configure full-featured development environments. When paired with Visual Studio Code and GitHub Codespaces, they can help you focus on learning and building applications rather than setting up your environment. You can find a final version of the configured environment and app on GitHub. Happy coding!