# my-rust

**Repository Path**: sn_yang/my-rust

## Basic Information

- **Project Name**: my-rust
- **Description**: Rust 学习
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-13
- **Last Updated**: 2025-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 我的 Rust 学习笔记

## Rust 资源

- [Rust 官网 English](https://www.rust-lang.org)
- [The Rust Programming Language](https://doc.rust-lang.org/book/)
- [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
- [Rust’s standard library](https://doc.rust-lang.org/std/)
- 中文文档
- [Rust 官网 中文](https://www.rust-lang.org/zh-CN)
- [Rust 官方文档中文翻译](https://rustwiki.org/zh-CN/)
- [Rust 程序设计语言](https://rustwiki.org/zh-CN/book)
- [Rust by Example 中文](https://rustwiki.org/zh-CN/rust-by-example/index.html)
- [Rust 标准库](https://rustwiki.org/zh-CN/std)
- [Rust 文档翻译指引](https://rustwiki.org/wiki/translate/rust-translation-guide/)
  这个很有用，包含了主要的文档。

## Rust 工具链

- rustup：Rust 的工具链管理工具
- [Cargo](https://doc.rust-lang.org/cargo/index.html): Rust 的包管理工具
- rustc：Rust 的编译器
- rustdoc：Rust 包文档生成工具（根据当前项目的源码，）
- mdbook：Rust 书文档生成工具（根据 markdown 文件，用于生成书和文章）
- Rustfmt
  Rustfmt 用于自动格式化 Rust 代码，使代码更加容易阅读、编写和维护。最重要的一点是：您再也不必为空格或大括号位置而争论了。
- Clippy
  Clippy 能够帮助所有不同经验水平的开发者编写出符合惯例的代码及推行标准写法。
- Cargo Doc
  Cargo 文档构建器让所有 API 都有文档。 您可以通过 cargo doc 在本地生成文档， 还可以通过 docs.rs 在线获取公开的 crate 文档

## Rust 准备

### 下载和安装

- 安装 rust
  [Rust 安装](https://www.rust-lang.org/zh-CN/install.html)

- vscode 插件
  - rust-lang.rust-analyzer

### 常用命令

#### rustup

```sh
# rustup 版本
rustup --version

# rustup 更新
rustup update

# 打开本地文档(***)
rustup doc

rustup self update
rustup toolchain list
rustup toolchain install stable
```

#### cargo

```sh
# cargo 版本
cargo --version

# cargo 创建项目(指定项目名)
cargo new hello_world

# cargo 创建项目(使用当前目录名作为项目名)
cargo init

# cargo 格式化代码
cargo fmt

# cargo 构建
cargo build

# cargo 运行
cargo run

# cargo 运行，并启动日志
RUST_LOG=debug cargo run

# cargo 检查
cargo check

# cargo 文档
cargo doc

# cargo 测试
cargo test
```

## Rust 学习笔记

- [Rust 所有权](./doc/rust-onwership.md)
- [Rust 引用-借用-生命周期](./doc/rust-reference.md)