Skip to content

README.md

Latest commit

 

History

History
65 lines (47 loc) · 1.67 KB

README.md

File metadata and controls

65 lines (47 loc) · 1.67 KB

Resource management in Rust

Documentation about resource management in the Rust programming language. We zoom in on some concepts that are specific to Rust:

  • ownership
  • borrowing
  • lifetimes

Read online.

Unmaintained and probably outdated

I wrote this at the time to better understand Rust. I don't maintain it anymore. It is probably outdated. It is not part of the official Rust documentation.

Target audience

This documentation is for you if you

  • are learning the Rust programming language and you want to understand lifetimes, ownership, borrowing etc. better,
  • already understand the basics (structs, enums, traits, ...),
  • have some experience with a garbage-collected object oriented programming language,
  • are comfortable reading simple technical English,
  • have no problem with the fact that this documentation is probably a work in progress for ever.

Building

We use mdBook to build the HTML version of the documentation. You can install mdBook with the following command:

cargo install mdbook

To build, go to the folder containing the src folder and run the following command:

mdbook build

The result is in the book directory.

Contributing

We welcome contributions, big and small. See CONTRIBUTING for details.

License

"Resource management in Rust" is licensed under the Apache License, Version 2.0 (see LICENSE-APACHE), or the MIT license (see LICENSE-APACHE), at your opinion.