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/jamesgraves/rust-cookbook
$ cd rust-cookbook
$ cargo install mdbook --vers "0.4.15"
$ 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 # macFrom anywhere inside the Cookbook repository, you can run individual examples with cargo run --example:
$ cargo run --example crossbeam-spsc
Received 0
Received 1
Received 2
Received 3
Received 4Individual sections can be tested by going into that directory and running cargo test:
$ cd src/cli/arguments
$ cargo testTesting all the examples can be done by running cargo test at the top level of the
project. Note that this requires setting up the example database and Internet access for the
web-related examples.
See the About section to create a new project based around an example.
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, and the CHANGES.md for how this has changed from the rust-nursery version.
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.