This Rust Cookbook is a collection of simple Rust examples that demonstrate good practices to accomplish common programming tasks, using the crates of the Rust ecosystem.
These examples are complete, and suitable for copying directly into new cargo projects. They are tested and guaranteed to work.
If you'd like to read it locally:
$ git clone https://github.com/rust-lang-nursery/rust-cookbook
$ cd rust-cookbook
$ cargo install mdbook --vers "0.4.43"
$ mdbook serve --openThe output can also be opened from the book subdirectory in your web browser.
$ xdg-open ./book/index.html # linux
$ start .\book\index.html # windows
$ open ./book/index.html # macFor local development and testing, you can use the provided Makefile:
# Show all available commands
make help
# Build the book locally
make build
# Run tests
make test
# Build and test (development workflow)
make dev
# Serve the book locally with live reload
make serve
# Clean build artifacts
make cleanAs a maintainer, you can deploy the site locally using:
# Deploy to GitHub Pages (requires maintainer permissions)
make deploy
# Or use the script directly
./scripts/deploy.shThe deployment script will:
- Build and test the book
- Push the built site to the
gh-pagesbranch - GitHub Pages will automatically serve the updated site
Note: This requires maintainer permissions to push to the gh-pages branch.
This project is intended to be easy for new Rust programmers to contribute to, and an easy way to get involved with the Rust community. It needs and welcomes help.
For details see CONTRIBUTING.md on GitHub.
Rust Cookbook is licensed under Creative Commons Zero v1.0 Universal License (LICENSE-CC0 or https://creativecommons.org/publicdomain/zero/1.0/legalcode)
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Rust Cookbook by you, as defined in the CC0-1.0 license, shall be dedicated to the public domain and licensed as above, without any additional terms or conditions.
