https://awesome-kusion.github.io/rust-code-book/

:books: Open Source book: Rust Source Code Analysis
https://awesome-kusion.github.io/rust-code-book/

awesome book rust rust-code-book rust-lang

Last synced: about 1 year ago
JSON representation

:books: Open Source book: Rust Source Code Analysis

• Host: GitHub
• URL: https://awesome-kusion.github.io/rust-code-book/
• Owner: awesome-kusion
• Created: 2022-08-15T07:50:02.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-14T05:17:08.000Z (over 3 years ago)
• Last Synced: 2025-04-10T10:11:48.236Z (about 1 year ago)
• Topics: awesome, book, rust, rust-code-book, rust-lang
• Language: Rust
• Homepage: https://awesome-kusion.github.io/rust-code-book/
• Size: 5.93 MB
• Stars: 206
• Watchers: 5
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Rust Source Code Analysis

[English](https://github.com/awesome-kusion/rust-code-book) [简体中文](https://github.com/awesome-kusion/rust-code-book-zh)

- *KusionStack(Go): *

- *KCLVM(Rust): *

## Preface

When I was working on KusionStack and KCLVM projects, I started to learn the source code of Rustc with the idea of learning the design of excellent compiler. I took some notes and documents during this process. With the suggestion of [Chai](https://github.com/chai2010), I organized them into an article and posted it. I didn't expect people to be interested in it, so I decided to continue writing articles on Rustc source code analysis. This is the original intention of writing this e-book.

KCLVM is a compiler we developed with Rust in the project of Kusion, and some parts of this book are applied to KCLVM. If you are interested in the cloud-native ecology and technology, you can learn about the project 👉 [KusionStack](https://github.com/KusionStack/kusion). And if you are interested in Rust, programming languages or compilers, maybe you prefer 👉 [KCLVM]( https://github.com/KusionStack/KCLVM).

Finally, most of the content in these e-book are my personal understanding when reading the source code, as well as some descriptions in the [rust-dev-guide](https://rustc-dev-guide.rust-lang.org/about-this-guide.html). Owing to the limitation of my knowledge, there must be mistakes and errors in the book. So we welcome all forms of conrtibutions(fix typo/polish english/translation/write article or other) from everyone.

---

## E-book

Target: Analysis and learn from the source code of Rust standard library, Rust compiler(Rustc) and open source project written by Rust.

![cover](cover-full.png)

- Github Repo: [https://github.com/awesome-kusion/rust-code-book](https://github.com/awesome-kusion/rust-code-book)

- Read Online: [https://awesome-kusion.github.io/rust-code-book](https://awesome-kusion.github.io/rust-code-book)

## Catalog

[Preface](preface.md)

- [Intro](intro/readme.md)

- [Standard Library](stdlib/readme.md)

  - [Sort: Timsort and pdqsort[WIP: Zh-ver.]](stdlib/sort/readme.md) 🕒

- [Rust Compiler](rustc/readme.md)

  - [Overview](rustc/overview/readme.md)

  - [Invocation](rustc/invocation/readme.md)

  - [Lexer](rustc/lexer/readme.md)

  - [Parser](rustc/parser/readme.md)

    

  - [Sema](rustc/sema/readme.md)

    - [Lint](rustc/sema/lint/readme.md) ✅

      

    

  - [Codegen](rustc/codegen/readme.md)

  - [General](rustc/general/readme.md)

    - [Errors[WIP: Zh-ver.]](rustc/general/errors/readme.md)  🕒

    - [SourceMap & Span[WIP]](rustc/general/sourcemap-span/readme.md)  🕒

- [Rust Tools](rust-tools/readme.md)

  

- [Rust Open Source Project](open-source/readme.md)

  - [KCLVM](open-source/KCLVM/readme.md) ✅

- [Appendix](appendix/readme.md)

---

[![Star History Chart](https://api.star-history.com/svg?repos=awesome-kusion/rust-code-book&type=Date)](https://star-history.com/#awesome-kusion/rust-code-book&Date)

Welcome to contact us in following ways:

- Slack: https://join.slack.com/t/rustcodebook/shared_invite/zt-1htuqzkf9-45i6FO1L~ihwnmbGGh7QEw

- Twitter: [He1pa](https://twitter.com/ZhengZh79945795)