Rust Source Code Analysis

English 简体中文

• KusionStack(Go): https://github.com/KusionStack/kusion
• KCLVM(Rust): https://github.com/KusionStack/KCLVM

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, 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. And if you are interested in Rust, programming languages or compilers, maybe you prefer 👉 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. 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.

• Github Repo: https://github.com/awesome-kusion/rust-code-book
• Read Online: https://awesome-kusion.github.io/rust-code-book

Catalog

Preface

• Intro
• Standard Library
• Sort: Timsort and pdqsort[WIP: Zh-ver.] 🕒
• Rust Compiler
• Overview
• Invocation
• Lexer

• Parser

• Sema

  • Lint ✅

• Codegen

• General

  • Errors[WIP: Zh-ver.] 🕒
  • SourceMap & Span[WIP] 🕒

• Rust Tools

• Rust Open Source Project

• KCLVM ✅
• Appendix

Welcome to contact us in following ways: - Slack: https://join.slack.com/t/rustcodebook/shared_invite/zt-1htuqzkf9-45i6FO1L~ihwnmbGGh7QEw - Twitter: He1pa