Rust学习记录

简介

Rust学习的再再次尝试。所有coding相关会记录在

give-rust-one-more-chance

Github

give-rust-one-more-chance

Owner

citrus327

Updated

May 30, 2023

1. 使用Rust完成一个简易CLI，可以进行一定的流程流转，最终写入文件或修改文件

2. 使用Rust调用swc等以Rust为基础语言的基建工具，做二次开发

3. 参考
   awesome-for-beginners

   Github

   awesome-for-beginners

   Owner

   MunGell

   Updated

   Nov 21, 2024

   
   Rust部分

4. 参考 Rust部分

5. https://the-ray-tracing-road-to-rust.vercel.app/

6. https://tomassedovic.github.io/roguelike-tutorial/

Types

• const定义的常量类型必须定于类型。
• const可以定义表达式，但是表达式中必须全部为常量。以下例子将报错

const A_CONSTANT_VALUE: i32 = 6;
let tmp: i32 = 5;
// "tmp" attempt to use a non-constant value in a constant
const YET_ANTHOER_CONSTANT_VALUE: i32 = A_CONSTANT_VALUE * tmp;

• Shadowing: 覆盖定义
• 本质与mut不同，类似reassign一个值，只是覆盖了名称而已。

let x = 5;
let x = 6;
// 允许的语法，x为6

• Rust属于静态类型语言，也就是说所有类型需要在compile时全部已知，有些API，类似于string.parse会要求主动声明parse完成的类型。

// u32不加的话，会报出compile error, 因为rust无法推断guess的类型
let guess: u32 = "42".parse().expect("Not a number!");

Scalar Types (Primitive types)

• Integer
• 类型的范围：

Length	Signed	Unsigned
8-bit	i8	u8
16-bit	i16	u16
32-bit	i32	u32
64-bit	i64	u64
128-bit	i128	u128
arch	isize	usize

• signed的范围
• unsigned的范围
• i8的范围即为-128到127，u8即为0到255
• Integer overflow在rust中的解决方案？？

Compound Types

• Tuple
• Rust中的Tuple解构

fn main1() {
    let tup = (500, 6.4, 1);

    let (x, y, z) = tup;

    println!("The value of y is: {y}");
}

fn main2() {
    let x: (i32, f64, u8) = (500, 6.4, 1);

    let five_hundred = x.0;

    let six_point_four = x.1;

    let one = x.2;
}

• Array
• Array内的所有元素必须为统一类型
• Array的类型定义：let a: [i32; 5] = [1, 2, 3, 4, 5];

Functions

• Functions不存在js中的变量提升，在Rust中只要被定义的函数就可以被定义，因为Rust在编译过程中会进行函数声明信息的收集

• 注意x + 1和x + 1;的区别，一个是expression, 一个是statement。

fn main() {
		// {..}代表一个block
    let y = {
        let x = 3;
        x + 1 // 没有分号，代表一个expression，即当前block返回4，同时赋值给y
    };

    println!("The value of y is: {y}");
}

• function的类型定义：

fn five() -> i32 { // 使用->定义返回类型。
    5
}

• function可以使用return关键字来提供当前函数的返回值，或者缺省分号，使用最后一行expression的值作为返回值。

Control Flows

fn main() {
    let number = 6;

    if number % 4 == 0 {
        println!("number is divisible by 4");
    } else if number % 3 == 0 {
        println!("number is divisible by 3");
    } else if number % 2 == 0 {
        println!("number is divisible by 2");
    } else {
        println!("number is not divisible by 4, 3, or 2");
    }

    // 可以直接赋值
    let number = if true { 5 } else { 6 };
    println!("The number is {}", number);

    // infinite loop
    // loop {
    //     println!("again");
    // }

    // 使用loop + break直接使用循环对一个变量赋值
    let mut counter = 0;

    let result = loop {
        counter += 1;

        if counter == 10 {
            break counter * 2;
        }
    };
    println!("Result is {result}");

    // while loop
    let mut count: i32 = 5;

    while count != 1 {
        println!("in while loop");
        count -= 1;
    }

    // for loop an array
    let a = [10, 20, 30, 40, 50];

    for element in a {
        println!("the value is: {element}");
    }
}

Ownership

• 前言：Heap and Stack
• Stack存放已知且固定大小的数据。Heap存放未知大小的数据，但会返回指针，指针本身为已知且固定的数据，可存入Stack中。
• 存放数据：stack的速度大于heap，因为mem allocator需要找寻一个足够大的的地方存够数据且为下次存放做准备。
• 获取数据：stack的速度大于heap，因为需要follow一个指针进行查找，而且处理器更擅长寻找相互临近的数据（stack数据相对临近）
• 调用函数的场景：parameter and local variables入栈，函数结束后全部出栈
• ownership解决的问题：Keeping track of what parts of code are using what data on the heap, minimizing the amount of duplicate data on the heap, and cleaning up unused data on the heap so you don’t run out of space are all problems that ownership addresses

• 规则：
• Each value in Rust has an owner. - 每个值均有一个owner对应
• There can only be one owner at a time. - 当值转移的时候，该值的owner会转移（move）到另外一个owner
• When the owner goes out of scope, the value will be dropped. - 出scope后直接gc了

• 详细解释：
下方图片展示的是shallow copy一个heap中的string类型，即s2会复制s1的指针，s1和s2会同时指向一个内存空间。但是这个会带来一个问题就是当s1 s2均跳出scope后，Rust会free2个指针，导致double free问题。所以这并不是Rust做的 ❌



相对的，Rust为了解决这种问题，没有采取2个指针指向一个内存空间的解法。而是采用ownership的机制，见下图 ✅



当s2 = s1 后，s1的owner会转移到s2，也就是说执行完成后s2为这块内存的owner，s1直接被gc。所以在这行代码执行完成后s1不再存在。但是可以clone（类似deep clone）来复制这片内存空间

let s1 = String::from("hello");
// s1已经move到了s2, s1在后续scope中不再存在
// let s2 = s1;
// 可以使用clone来进行shallowcopy
let s2 = s1.clone();

println!("{}, world!", s1);

以上所有说的均是针对heap中的数据类型（即String)

---

而针对stack中存放的数据（初始类型）由于本身存放在stack中，操作复制的成本很低，所以不存在shallow copy与deep copy一说（因为实际效果一致）
针对stack中的数据，Rust可以添加一个叫做Copy的Trait到对应类型中，带有Copy Trait的类型可以保证值在assign后继续时候（被copy)。相对应的，在内存中的数据类型（例如String）会带有一个叫做Drop的Trait，实现Drop的Trait不能实现Copy。
而实现了Copy trait的类型一共5种：即4个初始类型（scalar types)还有仅含有初始类型的tuple，例如(i32, i32) ，而(i32, String)则不是，因为String不是初始类型

• 函数中的ownership
当值传入函数中，相当于ownership的转移，函数的返回值的ownership会转交到外部。
以下的例子中由于s1的ownership转换，s1不再是s2，s1无法被重用。
所以在函数中来回传递heap中的值，会较为麻烦（因为ownership一直转移），所以Rust含有Reference和Borrowing的概念来解决这个麻烦。

fn main() {
    let s1 = String::from("hello");

    let (s2, len) = calculate_length(s1);

		// 由于s1的ownership转换，s1不再是s2，s1无法被重用
    println!("The length of '{}' is {}.", s2, len);
}

fn calculate_length(s: String) -> (String, usize) {
    let length = s.len(); // len() returns the length of a String

    (s, length)
}

Reference & Borrowing

fn main() {
    let s1 = String::from("hello");

    let len = calculate_length(&s1);

    println!("The length of '{}' is {}. The Ref is {}", s1, len, &s1);
}

fn calculate_length(s: &String) -> usize {
    s.len()
}

Mutable Reference

fn main() {
    let mut s = String::from("hello");

    change(&mut s);

		// The changed s is hello world
    println!("The changed s is {s}");
}

fn change(some_string: &mut String) {
    some_string.push_str(", world");
}

• mutable reference的限制是只能存在一个mutable的reference。这种设计是为了防治data race，即竞争关系。
当然可以通过创建一个scope来完成2个&mut的存在。

fn main() {
    let mut s = String::from("hello");

    change(&mut s);

    println!("The changed s is {s}");


    {
        let r1 = &mut s;
        r1.push_str(" inner")
    } // r1 goes out of scope here, so we can make a new reference with no problems.

    let r2 = &mut s;

    r2.push_str(" outter");

		// after two &mut, s is $hello, world inner outter
    println!("after two &mut, s is ${s}")
}

fn change(some_string: &mut String) {
    some_string.push_str(", world");
}

• 当mutable reference和reference同时存在时，已经被借用的值，不能被借用为mutable reference。 换一种理解，就是reference和mutable reference的scope不能重叠。一个reference的scope，是从声明到最后一次使用。在println!之前，r3与r1 r2同时出现。reference和mutable reference的scope重叠就会导致compiler error。见下面的2个例子。

let mut s = String::from("hello");

let r1 = &s; // no problem
let r2 = &s; // no problem
let r3 = &mut s; // BIG PROBLEM

println!("{}, {}, and {}", r1, r2, r3);

let mut s = String::from("hello");

let r1 = &s; // no problem
let r2 = &s; // no problem
println!("{}, {}", r1, r2);

let r3 = &mut s;
r3.push_str(" world");

// r1, r2的scope在这结束，而在这中间，r3这个mut reference的scope相互重叠了。
println!("{}, {}, {}", r1, r2, r3);
// println!("{}", r3); // 使用这行将解决这个问题

Dangling Reference

fn main() {
    let reference_to_nothing = dangle();
}

fn dangle() -> &String {
    let s = String::from("hello");

		// s is dropped after dangle fn(), but we try to return a reference value to it.
    &s
}

Structs

• 对整体struct进行修改时，需要对struct实例整体表明mut

• merge使用.. 符号，merge的顺序与js相反。且..的merge必须放在最后一行。

• 整体规则符合ownership，heap variable和stack variable的规则同样受用。

struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn build_user(email: String, username: String) -> User {
    User {
        active: true,
        username: username,
        email: email,
        sign_in_count: 1,
    }
}


fn main() {
    let mut user1 = User {
        active: true,
        username: String::from("someusername123"),
        email: String::from("someone@example.com"),
        sign_in_count: 1,
    };

    // user1需要整体标注为mut
    user1.email = String::from("anotheremail@example.com");

    let user2 = build_user(
        String::from("citrus327@outlook.com"),
        String::from("hophop")
    );

    // 取user1的username，剩下的采用user2，而非使用user2进行全量覆盖
    let merged_user = User {username: user1.username, sign_in_count: user2.sign_in_count, ..user2 };

    println!("user email is {}", user1.email);

    // user1.username已经被merged_user借用，无法再次使用。
    // println!("user email is {}", user1.username); 

    // 而sign_in_count的类型属于u64, 属于scalar type, 可以再次使用（实现了Copy Trait)
    println!("user2 sign_in_count is {}", user2.sign_in_count); 
    println!("merged user name is {}", merged_user.username); // someusername123
    println!("merged user email is {}", merged_user.email); // citrus327@outlook.com
}

• struct可以定义方法，属于struct本身（或者与struct本身有关联的）称之为method。与struct本身无关的，称之为associated functions。associated functions可以使用Rectangle::print()来调用。
• P.S. associated functions类似于直接调用类下的静态方法，method即为成员方法。但是每个成员方法也可以使用associated functions的方式来调用。或者说表明了&self的，可以直接使用实例调用（当然也可以静态调用）这点Rust做的相当灵活，类似于js的apply

#[derive(Debug)]
struct Rectangle {
    width: u32,
    height: u32
}

impl Rectangle {
    fn area(&self) -> u32 {
        self.width * self.height
    }

		// method
    fn print(&self) {
        println!("The area of the rectangle {:#?} is {}", self, self.area());
    }
		// associated functions
    fn square(size: u32) -> Self {
        Self {
            width: size,
            height: size,
        }
    }
}

fn main() {
    let rectangle = Rectangle {
        width: 40,
        height: 40
    };

    // println!("The area of the rectangle {:#?} is {}", rectangle, calc_area(&rectangle));
    // println!("The area of the rectangle {:#?} is {}", rectangle, rectangle.area());
    rectangle.print();
		// 可以使用这种方式（associated functions）调用。
		Rectangle::print(&rectangle);

		// associated functions的调用方式
    let square = Rectangle::square(12);

    square.print();

}

fn calc_area (rectangle: &Rectangle) -> u32{
    return rectangle.width * rectangle.height;
}

Enums

enum Message {
    Quit,
    Move { x: i32, y: i32 },
    Write(String),
    ChangeColor(i32, i32, i32),
}

the concept that null is trying to express is still a useful one: a null is a value that is currently invalid or absent for some reason.

let x: i8 = 5;
let y: Option<i8> = Some(5);

let sum = x + y;

Pattern Matching

enum Coin {
    Penny,
    Nickel,
    Dime,
    Quarter,
}

fn value_in_cents(coin: Coin) -> u8 {
    match coin {
        Coin::Penny => 1,
        Coin::Nickel => 5,
        Coin::Dime => 10,
        Coin::Quarter => 25,
    }
}

enum Coin {
    Penny,
    Nickel,
    Dime,
    Quarter(UsState),
}

fn value_in_cents(coin: Coin) -> u8 {
    match coin {
        Coin::Penny => 1,
        // Coin::Nickel => 5,
        // Coin::Dime => 10,
        Coin::Quarter(state) => {
            println!("the state is from {:?}", state);
            return 25;
        }
				// 使用other做缺省处理，例如js中switch case的default
        other => {
            println!("other");
            return 2;
        }
    }
}

fn main() {
    println!("value is {}", value_in_cents(Coin::Nickel));
}

let config_max = Some(3);
match config_max {
    Some(max) => println!("The maximum is configured to be {}", max),
    _ => (),
}

let config_max = Some(3u8);
if let Some(max) = config_max {
    println!("The maximum is configured to be {}", max);
}

unwrap 系列

fn divide(a: i32, b: i32) -> Result<i32, String> {
    if b == 0 {
        Err(String::from("Cannot divide by zero"))
    } else {
        Ok(a / b)
    }
}

fn main() {
    let result = divide(10, 2);
    let value = result.unwrap_or_else(|err| {
        println!("Error occurred: {}", err);
        0
    });
    println!("Result: {}", value);
}

Vector

• 创建Vector的方式：

// 从0创建
let mut v: Vec<i32> = Vec::new();

// mutating vector
v.push(1);
v.push(2);
v.push(3);
v.push(4);

// 包含初始值
let v = vec![1, 2, 3, 4, 5];

• 修改Vector的方法：push, pop等, 不过多赘述

• 遍历与读取：

fn iterate_vec(v: &Vec<i32>) {
    for i in v {
        println!("the value at index {i} is {}", i);
    }
}

fn reading_vec_by_index(v: &Vec<i32>, index: usize) {
    println!(
        "reading index {} from vector {:?}, value is {}",
        index, v, v[index]
    );
}

fn reading_vec_by_get(v: &Vec<i32>, index: usize) {
    // let third3 = v.get(index);

    // let result: i32;
    // match third3 {
    //     Some(v) => result = *v,
    //     None => println!("There is no third element."),
    // }

    // return result;

		// 使用.get去获取值，将会返回一个Option
    let third4 = v.get(index);
    if let Some(third) = third4 {
        println!(
            "reading index {} from vector {:?}, value is {}",
            index, v, third
        );
    } else {
        println!("There is no third element.");
    }
}

• 涉及到ownership相关：

Strings

fn main() {
    println!("Hello, world!");

    let str = create_str_from_new();
    print_str(&str);

    let str = create_str_with_initial_values();
    print_str(&str);

    let mut str = create_str_from_string_literal();
    print_str(&str);

    str.push_str(" world"); // can push str
    str.push('!'); // can only push char

    print_str(&str);

    // use + operator to append
    let str_part_1 = String::from("hello");
    let str_part_2 = String::from("world");

    // 需要使用&进行引用的原因是因为 + operator本质是调用add function，add fn的定义要求传入&str
    // add fn: fn add(self, s: &str) -> String {
    // 因为str_part_1的ownership被add拿走，str_part_1在+号后不再存在，而str_part_2为引用，后续依旧可用。
    let str = str_part_1 + " " + &str_part_2 + "!";

    // print_str(&str_part_1); // 报错 ownership
    // print_str(&str_part_2); // OK

    print_str(&str);

    let s1 = String::from("tic");
    let s2 = String::from("tac");
    let s3 = String::from("toe");

    let str = s1 + "-" + &s2 + "-" + &s3;

    print_str(&str);

    let s1 = String::from("tic");
    let s2 = String::from("tac");
    let s3 = String::from("toe");

    let str = format!("{s1}-{s2}-{s3}");
    print_str(&str);

    // string不支持index访问。
    // 原因是String的本质实现是存放着asciicode的vector: Vec<u8>，
    // 若允许indexing，则会返回相对应的number，为了保证意外的情况，Rust完全禁止了String indexing
    // let s1 = String::from("hello");
    // let h = s1[0]; // Compile Error
}

fn create_str_from_new() -> String {
    let mut s = String::new();
    s.push('h');
    s.push('e');
    s.push('l');
    s.push('l');
    s.push('o');
    s
}

fn create_str_with_initial_values() -> String {
    let s = String::from("hello");

    s
}

fn create_str_from_string_literal() -> String {
    let s = "hello";

    s.to_string()
}

fn print_str(str: &str) {
    println!("The str created is {}", str);
}

1. String本身实现是由Vec<u8> 实现，通过index访问将会返回对应的ascii code

2. 某些unicode字符本身占用2个bytes，例如नमस्ते，从bytes角度看，展示为[224, 164, 168, 224, 164, 174, 224, 164, 184, 224, 165, 141, 224, 164, 164, 224, 165, 135]，若能够通过index访问，将会返回number，且无法明确对应的index值。

3. Rust认为通过index访问String，应该保证一致的O(1) 复杂度，但实际并不是如此，且无法保证

let str = "Здравствуйте";

let s = &str[0..4];
// Зд本身占用4个bytes，0-4会得到Зд，而不是Здра
print_str(&s);

for c in "Зд".chars() {
    println!("{c}");
}

HashMap

use std::collections::HashMap;

fn main() {
    let scores = create_hash_map();

    let score = scores.get("Blue").copied().unwrap_or(0);

    println!("score is {}", score);

    iterate_hash_map(&scores);

    let field_name = String::from("Favorite color");
    let field_value = String::from("Blue");

    let mut map = HashMap::new();
    map.insert(field_name, field_value);

    // map.insert(&field_name, &field_value);

    // ownership已经被转移到了map，后续无法再获取field_name和field_value
    // println!("field_name {}", field_name);
    // println!("field_value {}", field_value);

    update_hash_map();
}

fn create_hash_map() -> HashMap<String, i32> {
    let mut scores = HashMap::new();

    scores.insert(String::from("Blue"), 10);
    scores.insert(String::from("Yellow"), 50);

    scores
}

fn iterate_hash_map(map: &HashMap<String, i32>) {
    for (key, value) in map {
        println!("{key}: {value}");
    }
}

fn update_hash_map() {
    let mut scores = HashMap::new();

    // overwriting
    scores.insert(String::from("Blue"), 10);
    scores.insert(String::from("Blue"), 25);

    // overwriting by checking if already has value
    scores.entry(String::from("Yellow")).or_insert(50);
    scores.entry(String::from("Blue")).or_insert(50);

    println!("{:?}", scores);
}

Crates, Packages and Modules

• crate: 分成binary crate和library crate两种
• binrary crate可以编译成一个executable
• library crate提供功能，在程序之间共享

• package: bundle of crates, package内含有Cargo.toml 文件进行描述如何构建内含的crates
• 一个package可以有n多个binary crate，但是至多只能有一个library crate
• 使用cargo new创建package
• src/main.rs 是Rust package中默认的crate root

• module: 模块，使用:: 调用模块子方法（或枚举或struct），使用pub 进行模块公开，默认模块及模块方法全私有。

use std::fmt::Result;
use std::io::Result as IoResult;

fn function1() -> Result {
    // --snip--
}

fn function2() -> IoResult<()> {
    // --snip--
}

// (1)
pub use terminal::Terminal;

fn main() {
    // xxx
}

// (2) 
// 可以直接使用crate的Terminal，其实应该写成 use crate::terminal::Terminal
// 但是因为main.rs内部使用了pub use terminal::Terminal，
// 相当于将terminal下的Terminal暴露至了crate级别
// 类似js中index.js全部re-export，所有子模块就可以直接从入口处统一导入
use crate::Terminal;

pub struct Size {
    pub width: u16,
    pub height: u16,
}

pub struct Terminal {
    size: Size,
}

impl Terminal {
    pub fn default() -> Result<Self, std::io::Error> {
        // xxx
    }

    pub fn get_size(&self) -> &Size {
        &self.size
    }
}

Error Handling

• 两类异常：可恢复与不可恢复类型

• 使用panic! 应对不可恢复类型异常

fn main() {
    // a manual panic! call
    // panic!("plz panic!");

    let vec = [1, 2, 3];

    // this will break the program
    vec[99];
}

当程序因为panic而停止运行后，Rust会打印出报错信息 → unwind → 清除栈 → 退出。unwinding本身会从堆栈信息中挨个获取每个function call对应的数据做清理。这个行为本身相当消耗性能（原文使用a lot of work形容）。可以通过配置

[profile.release]
panic = 'abort'

来使程序在release中碰到panic直接中止程序，而将清理工作交给操作系统处理。
Unrecoverable Errors with panic! - The Rust Programming Language

https://doc.rust-lang.org/book/ch09-01-unrecoverable-errors-with-panic.html#unwinding-the-stack-or-aborting-in-response-to-a-panic

• 使用Result来应对可恢复类型异常

fn try_open_file_with_specific_errors() {
    let greeting_file_result = File::open("hello.txt");

    let greeting_file = match greeting_file_result {
        Ok(file) => file,
        Err(error) => match error.kind() {
            // 如果是NotFound的Kind，直接生成文件。
            ErrorKind::NotFound => match File::create("hello.txt") {
                Ok(fc) => fc,
                Err(e) => panic!("Problem creating the file: {:?}", e),
            },
            other_error => {
                panic!("Problem opening the file: {:?}", other_error);
            }
        },
    };

    println!("success!, {:#?}", greeting_file)
}

使用match方法会显得略显累赘，使用Result相关的方法可以简化代码，例如使用unwrap以及expect

use std::fs::File;

fn main() {
    let greeting_file = File::open("hello.txt").unwrap();

		let greeting_file = File::open("hello.txt")
        .expect("hello.txt should be included in this project");
}

若Result结果是Ok，unwrap则会直接返回Result内的值，否则会调用panic!。使用expect可以填入自定义的panic信息，报错信息会更加语义化。推荐使用expect
 
• 除了函数体内直接处理异常外，也可以将Err传递。

use std::fs::File;
use std::io::{self, Read};

fn read_username_from_file() -> Result<String, io::Error> {
    let username_file_result = File::open("hello.txt");

    let mut username_file = match username_file_result {
        Ok(file) => file,
        Err(e) => return Err(e),
    };

    let mut username = String::new();

    match username_file.read_to_string(&mut username) {
        Ok(_) => Ok(username),
        Err(e) => Err(e),
    }
}

这段代码会在Err分支内直接将错误返回，注意函数返回类型。
 
• 简化Result以及match

use std::fs::File;
use std::io::{self, Read};

fn read_username_from_file() -> Result<String, io::Error> {
    let mut username_file = File::open("hello.txt")?;
    let mut username = String::new();
    username_file.read_to_string(&mut username)?;
    Ok(username)
}

在Result后标明? 代表若有错误，直接返回一个Err的Result至外部。
注意带有在Result后带有？则表示会对外界传递Err ，返回类型一定要注意写。

Generic & Trait

• 范型：
• 与其他语言类似，compiler时可确认，不影响性能。compiler时会执行Monomorphization，将特定类型填充至范型坑位

• Trait：特性？其实就是接口。
• 一个简单的范型定义

trait Summary {
    fn summarize(&self) -> String;
}

• 2个不同的struct，实现同一个接口

pub struct NewsArticle {
    pub headline: String,
    pub location: String,
    pub author: String,
    pub content: String,
}

impl Summary for NewsArticle {
    fn summarize(&self) -> String {
        format!("{}, by {} ({})", self.headline, self.author, self.location)
    }
}

pub struct Tweet {
    pub username: String,
    pub content: String,
    pub reply: bool,
    pub retweet: bool,
}

impl Summary for Tweet {
    fn summarize(&self) -> String {
        format!("{}: {}", self.username, self.content)
    }
}

• 接口可以有默认实现

pub trait Summary {
    fn summarize(&self) -> String {
        String::from("(Read more...)")
    }
}

• 要求参数必须实现某些接口

fn need_to_impl_summary<T: Summary>(item: &T) {
    item.summarize()
}

// 缩略版
fn need_to_impl_summary_simple(item: &impl Summary) {
    item.summarize()
}

• 要求参数实现多个接口

pub fn notify<T: Summary + Display>(item: &T) {}

pub fn notify(item: &(impl Summary + Display)) {}

• 当范型要求比较多，可读性不高时可使用where 关键字

fn some_function<T, U>(t: &T, u: &U) -> i32
where
    T: Display + Clone,
    U: Clone + Debug,
{}

• 要求返回值必须实现某些接口

fn returns_summarizable() -> impl Summary {
    Tweet {
        username: String::from("horse_ebooks"),
        content: String::from(
            "of course, as you probably already know, people",
        ),
        reply: false,
        retweet: false,
    }
}

如果返回值要求实现Summary接口，这里有一个隐形的限制就是返回类型必须得是一种。必能返回2种不同的struct，但是都实现了Sumary

Lifetimes

Lifetimes are another kind of generic that we’ve already been using. Rather than ensuring that a type has the behavior we want, lifetimes ensure that references are valid as long as we need them to be.

fn main() {
    let r;

    {
        let x = 5;
        r = &x;
    }

    println!("r: {}", r);
}

$ cargo run
   Compiling chapter10 v0.1.0 (file:///projects/chapter10)
error[E0597]: `x` does not live long enough
 --> src/main.rs:6:13
  |
6 |         r = &x;
  |             ^^ borrowed value does not live long enough
7 |     }
  |     - `x` dropped here while still borrowed
8 |
9 |     println!("r: {}", r);
  |                       - borrow later used here

For more information about this error, try `rustc --explain E0597`.
error: could not compile `chapter10` due to previous error

fn main() {
    let r;                // ---------+-- 'a
                          //          |
    {                     //          |
        let x = 5;        // -+-- 'b  |
        r = &x;           //  |       |
    }                     // -+       |
                          //          |
    println!("r: {}", r); //          |
}                         // ---------+

fn main() {
    let x = 5;            // ----------+-- 'b
                          //           |
    let r = &x;           // --+-- 'a  |
                          //   |       |
    println!("r: {}", r); //   |       |
                          // --+       |
}                         // ----------+

fn longest(x: &str, y: &str) -> &str {
    if x.len() > y.len() {
        x
    } else {
        y
    }
}

&i32        // a reference
&'a i32     // a reference with an explicit lifetime
&'a mut i32 // a mutable reference with an explicit lifetime

fn longest<'a>(x: &'a str, y: &'a str) -> &'a str {
    if x.len() > y.len() {
        x
    } else {
        y
    }
}

struct ImportantExcerpt<'a> {
    part: &'a str,
}

fn main() {
    let novel = String::from("Call me Ishmael. Some years ago...");
    let first_sentence = novel.split('.').next().expect("Could not find a '.'");
    let i = ImportantExcerpt {
        part: first_sentence,
    };
}

1. 编辑器会给每个参数reference分配一个lifetime anotation
1. 例如fn first_word(s: &str) -> &str 将变成 fn first_word<'a>(s: &'a str) -> &str

2. 如果只有一个input lifetime parameter，那输出必定也是这个lifetime parameter
1. 例如fn first_word<'a>(s: &'a str) -> &str 将变成fn first_word<'a>(s: &'a str) -> &'a str

3. method中&self的lifetime会直接赋给所有的output lifetime

let s: &'static str = "I have a static lifetime.";

Closure

类型推断

let example_closure = |x| x;

let s = example_closure(String::from("hello"));

// 报错，Rustc会根据第一次调用进行类型推断，第二次的类型与第一次不同
let n = example_closure(5);

值的自动捕获

let list = vec![1, 2, 3];
println!("Before defining closure: {:?}", list);

// 使用闭包就不报错
let only_borrows = || println!("From closure: {:?}", list);

fn only_borrows() {
		// list报错，can't capture dynamic environment in a fn item
    println!("From function: {:?}", list);
}

println!("Before calling closure: {:?}", list);
only_borrows();
println!("After calling closure: {:?}", list);

3种闭包类型

Macro

简介

• 宏的优点（摘自官网）

1. Don't repeat yourself. There are many cases where you may need similar functionality in multiple places but with different types. Often, writing a macro is a useful way to avoid repeating code.

2. Domain-specific languages. Macros allow you to define special syntax for a specific purpose. (More on this later)

3. Variadic interfaces. Sometimes you want to define an interface that takes a variable number of arguments. An example is println! which could take any number of arguments, depending on the format string.

• Rust 的宏（macros）和普通函数有以下区别：
1. 调用时机：宏是在编译期间进行展开，而函数是在运行时执行的。这意味着宏的展开发生在代码编译阶段，而函数的执行发生在程序运行阶段。
2. 语法：宏使用 macro_rules! 关键字定义，可以在代码中匹配和转换模式。而函数使用 fn 关键字定义，并遵循 Rust 函数的语法规则。
3. 参数和类型检查：宏可以接受任意数量和类型的参数，并且不进行类型检查。它们在展开时根据上下文进行解释和处理。相比之下，函数在编译前会进行类型检查，并且参数的数量和类型必须与函数签名一致。
4. 代码生成：宏可以生成任意数量和类型的代码，并在展开时将其插入到源代码中。而函数的结果是在运行时通过执行函数体得出的，无法在编译期间生成额外的代码。
5. 功能扩展：宏具有更大的灵活性，可以用于元编程和代码生成。宏可以根据需要生成重复的代码、生成不同的代码分支、进行模式匹配等。这使得宏在代码重用和构建领域特定语言（DSL）方面非常有用。函数则更适合用于封装可重用的代码块。

• 元编程(metaprogramming)
• 元编程（Metaprogramming）是一种编程技术，它使得开发人员能够编写能够生成、操作和转换程序代码的代码。元编程的目的是通过编写代码来生成代码，通过程序生成程序。宏是 Rust 中的元编程机制，允许你在编译期间操作代码，并使用宏定义来生成、转换或扩展代码。

• Macro Expanding （宏的展开）
• 宏的展开指的是在编译期间，将宏调用所在的代码替换为宏定义中所指定的代码。这个替换过程发生在代码的预处理阶段，称为宏展开。
• 使用宏，你可以编写一些代码模板，然后通过宏来生成具体的代码。宏可以接受参数，并可以基于这些参数在编译期间进行逻辑处理，最终生成符合需求的代码。这种能力使得宏在减少重复代码、生成大量重复代码、实现领域特定语言（DSL）等方面非常有用。
• 例如，Rust 中的 println! 宏就是一个常见的宏。在编写代码时，你可以使用 println!("Hello, {}!", name) 来打印带有变量 name 值的消息。在宏展开时，println! 宏会根据提供的参数生成对应的代码，以在运行时打印消息。这样，你可以在编写代码时使用宏来简化打印操作，而不必手动编写打印代码的重复代码。
• 总结起来，宏的展开是指在编译期间将宏调用替换为宏定义中所指定的代码，而元编程是一种编程技术，通过编写代码来生成、操作和转换程序代码，而不仅仅是在运行时执行代码。它使得宏能够在编译期间进行代码生成和转换，以提供更高的灵活性和复用性。

Concurrency

Rust并没有在Concurrent（并发）和Parallel（并行）上进行很大程度的区分，而是希望通过一种解法，解决两者带来的问题。

Parallel要求有多个可处理的CPU核心，而Concurrent要求多线程。如果没有多核CPU来承载多个任务执行，就不能以Parallel来解决问题。

• 关于M:N和1:1

有些语言在线程的处理上，会使用M:N的模型，这个的意思是程序创建M的“线程”，但是实际创建的线程是N个，这两者之间的关心完全取决于编程语言。而Rust选择的是1:1模型，也就是Rust中创建的1个线程，对应的就是实际操作系统的一个线程。

 

• 线程的创建
• thread::spawn 返回一个JoinHandle, 可以等待当前线程结束或do something else

use std::thread;
use std::time::Duration;

fn main() {
    let handle = thread::spawn(|| {
        for i in 1..10 {
            println!("hi number {} from the spawned thread!", i);
            thread::sleep(Duration::from_millis(1));
        }
    });

    for i in 1..5 {
        println!("hi number {} from the main thread!", i);
        thread::sleep(Duration::from_millis(1));
    }

		// join会等待线程的结束，会成功打印1-9，若没有则会答应出1-4（因为主线程提前退出）
    handle.join().unwrap();
}

use std::thread;
use std::time::Duration;

fn main() {
    let handle = thread::spawn(|| {
        for i in 1..10 {
            println!("hi number {} from the spawned thread!", i);
            thread::sleep(Duration::from_millis(1));
        }
    });

    // 若放在中间，join会等待新thread完全运行完成再执行主线程代码
    handle.join().unwrap();

    for i in 1..5 {
        println!("hi number {} from the main thread!", i);
        thread::sleep(Duration::from_millis(1));
    }
}

 

上图说明了Concurrent和Parallel的区别

排队的队列对应现成，咖啡机对应CPU核心。

• 并发(Concurrent) 是多个队列使用同一个咖啡机，然后两个队列轮换着使用（未必是 1:1 轮换，也可能是其它轮换规则），最终每个人都能接到咖啡

• 并行(Parallel) 是每个队列都拥有一个咖啡机，最终也是每个人都能接到咖啡，但是效率更高，因为同时可以有两个人在接咖啡

并发和并行都是对“多任务”处理的描述，其中并发是轮流处理，而并行是同时处理。

 

Publish

1. cargo package 检查打包后的crate文件

2. cargo publish

额外信息

[profile.dev]
opt-level = 0

[profile.release]
opt-level = 3

//! # My Crate
//!
//! `my_crate` is a collection of utilities to make performing certain
//! calculations more convenient.

/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let arg = 5;
/// let answer = my_crate::add_one(arg);
///
/// assert_eq!(6, answer);
/// ```
pub fn add_one(x: i32) -> i32 {
    x + 1
}

# .cargo/config.toml
[registry]
default = "crates-io"

Suggestions

• 跟着这个学习非常有效 https://www.flenker.blog/hecto-chapter-1/

• rust-clippy是rust的lint工具
• cargo clippy -- -W clippy::pedantic针对所有lint rules的一次校验
• 由于cargo每次只compile changed files, 所以在执行上面命令时，可使用cargo clean清理build文件，让lint作用于所有文件

一些常用方法记录

let results = if config.ignore_case {
    search_case_insensitive(&config.query, &contents)
} else {
    search(&config.query, &contents)
};

let results = match config.ignore_case {
    true => search_case_insensitive(&config.query, &contents),
    false => search(&config.query, &contents),
};

println!(
    "The spawned thread is {}",
    if let true = handler.is_finished() { "finished" } else { "not finished" }
);

let width = 5;
let sliced = &String::from("xxxxxxxx")[..width]

macro_rules! print_env {
    ($name: expr) => {
        println!("{}={}", $name, env!($name))
    };
}

print_env!("CARGO_PKG_VERSION_MAJOR");
print_env!("CARGO_MANIFEST_DIR");
print_env!("CARGO_PKG_AUTHORS");
print_env!("CARGO_PKG_DESCRIPTION");
print_env!("CARGO_PKG_HOMEPAGE");
print_env!("CARGO_PKG_NAME");
print_env!("CARGO_PKG_REPOSITORY");
print_env!("CARGO_PKG_VERSION");
print_env!("CARGO_PKG_VERSION_MAJOR");
print_env!("CARGO_PKG_VERSION_MINOR");
print_env!("CARGO_PKG_VERSION_PATCH");
print_env!("CARGO_PKG_VERSION_PRE");

let b = Vec::<bool>::new(); // 使用turbofish语法直接表明b的类型
let b: Vec<bool> = Vec::new(); // explicit表明类型