// 什么是生命周期?
// 參考: https://doc.rust-lang.org/book/second-edition/ch10-03-lifetime-syntax.html
// 參考: https://stackoverflow.com/questions/31609137/why-are-explicit-lifetimes-needed-in-rust


// 核心: 生命周期只跟引用/借用有關(guān), 如果不是引用/借用, 那么就不存在生命周期的說(shuō)法,
//       因?yàn)榉且?借用都必然會(huì)產(chǎn)生所有權(quán)轉(zhuǎn)移, 所有權(quán)轉(zhuǎn)移會(huì)跳出scope的限制.


// 生命周期作用在function、method、trait 和 struct 中,
// 編譯器默認(rèn)情況下會(huì)為每個(gè)引用類型的參數(shù)自動(dòng)補(bǔ)充不同(為每個(gè)引用單獨(dú)增加一個(gè)'a/'b/'c)的生命周期,
// 只有出現(xiàn)它無(wú)法識(shí)別的情況時(shí), 才會(huì)報(bào)錯(cuò)并要求讓你自己來(lái)填寫生命周期.


// 什么情況下編譯器會(huì)自動(dòng)補(bǔ)充生命周期?
// 1. 當(dāng)參數(shù)含有多個(gè)引用, 且返回值類型不是引用時(shí), 編譯器會(huì)自動(dòng)為每個(gè)引用添加一個(gè)不同的聲明周期.
//    fn print(status: &i32, msg: &str) -> Message {};
//    編譯器自動(dòng)補(bǔ)充生命周期
//    fn print<'a, 'b>(status: &'a i32, msg: &'b i32) -> Message {};
fn multi_reference_parameters_and_return_value_is_not_reference_type() {

    #[allow(dead_code)]
    #[derive(Debug)]
    struct Message {
        status: i32,
        msg: String
    }

    // 不寫生命周期
    #[allow(unused_variables)]
    fn print1(status: &i32, msg: &str) -> Message {
        if status == &200 {
            Message {status: 200, msg: String::from("ok!")}
        } else {
            Message {status: 404, msg: String::from("page not found!")}
        }
    };

    // 寫生命周期
    #[allow(unused_variables)]
    fn print2<'a, 'b>(status: &'a i32, msg: &'b str) -> Message {
        if status == &200 {
            Message {status: 200, msg: String::from("ok!")}
        } else {
            Message {status: 404, msg: String::from("page not found!")}
        }
    }

    print1(&200, "ok!");
    print1(&404, "page not found!");

    print2(&200, "ok!");
    print2(&404, "page not found!");
}


// 2. 當(dāng)參數(shù)只含有一個(gè)引用類型, 那么編譯器會(huì)自動(dòng)補(bǔ)充生命周期, 如果返回值也是一個(gè)引用類型, 那么編譯器也會(huì)自動(dòng)給引用類型的返回值添加生命周期.
//    fn print(msg: &str) -> &str {}
//    編譯器自動(dòng)補(bǔ)充生命周期
//    fn print<'a>(msg: &'a str) -> &'a str {};
fn only_one_reference_parameter_and_return_value_type_is_reference_too() {

    // 不寫生命周期
    #[allow(unused_variables)]
    fn print1(status: i32, msg: &str) -> &str {
        if status == 200 {
            println!("{}", msg);
            msg
        } else {
            let s = "custom message";
            println!("{}", s);
            s
        }
    };

    // 寫生命周期
    #[allow(unused_variables)]
    fn print2<'a>(status: i32, msg: &'a str) -> &'a str {
        if status == 200 {
            println!("{}", msg);
            msg
        } else {
            let s = "custom message";
            println!("{}", s);
            s
        }
    }

    print1(200, "ok!");
    print1(404, "page not found!");

    print2(200, "ok!");
    print2(404, "page not found!");
}


// 3. 當(dāng)參數(shù)中含有 &self 或 &mut self 時(shí), 如果返回值也是一個(gè)引用類型, 那么編譯器會(huì)自動(dòng)給引用類型的返回值添加生命周期.
//    struct ImportantExcerpt<'a> {
//        part: &'a str,
//    }
//    impl<'a> ImportantExcerpt<'a> {
//        fn announce_and_return_part(&self, announcement: &str) -> &str {
//            println!("Attention please: {}", announcement);
//            self.part
//        }
//    }
//    編譯器自動(dòng)補(bǔ)充生命周期
//    struct ImportantExcerpt<'a> {
//        part: &'a str,
//    }
//    impl<'a> ImportantExcerpt<'a> {
//        fn announce_and_return_part(&'a self, announcement: &'a str) -> &'a str {
//            println!("Attention please: {}", announcement);
//            self.part
//        }
//    }
fn lifetime_on_method() {
    struct Message<'a> {
        id: &'a str,
        msg: &'a str,
    }

    // 不寫生命周期
    impl<'a> Message<'a> {
        fn get_msg_by_id1(&self, id: &str) -> &str {
            if self.id == id {
                println!("lifetime_on_method: {} {}", self.id, self.msg);
                self.msg
            } else {
                println!("lifetime_on_method: {} {}", id, self.msg);
                self.msg
            }
        }
    }
    let m = Message {id: "200", msg: "ok!"};
    m.get_msg_by_id1("200");
    m.get_msg_by_id1("404");

    // 寫生命周期
    impl<'a> Message<'a> {
        fn get_msg_by_id2(&'a self, id: &'a str) -> &'a str {
            if self.id == id {
                println!("lifetime_on_method: {} {}", self.id, self.msg);
                self.msg
            } else {
                println!("lifetime_on_method: {} {}", id, self.msg);
                self.msg
            }
        }
    }

    let m = Message {id: "200", msg: "ok!"};
    m.get_msg_by_id2("200");
    m.get_msg_by_id2("404");
}


// 什么情況下編譯器不會(huì)自動(dòng)補(bǔ)充生命周期?
// 當(dāng)參數(shù)含有大于一個(gè)引用類型, 并且返回值類型也是引用時(shí), 編譯器就要求必須填寫完整的生命周期.
fn error_example_that_compile_not_fill_lifetime() {        // 問(wèn)題代碼, 需注釋掉才能運(yùn)行
    fn print(status: &str, msg: &str) -> &str {          // 編譯器翻譯成 fn print<'a, 'b>(status: &'a str, msg: &'b str) -> &str {}
        if status == "200" {
            msg                                            // msg == &'b str        與   指定的 &str 不一致
        } else {
            status                                         // status == &'a str     與   指定的 &str 不一致
        }
    }

    print("200", "ok!");
    // error output: missing lifetime specifier, expected lifetime parameter.
    // 備注: 這個(gè)例子根本就不是比較生命周期的長(zhǎng)短問(wèn)題,
    //       而是實(shí)際返回值與指定返回值生命周期不一致的問(wèn)題.
    // 推理:
    //       1. 已知編譯器會(huì)自動(dòng)補(bǔ)充生命周期:
    //          fn print<'a, 'b>(status: &'a str, msg: &'b str) -> &str {}
    //          這是會(huì)報(bào)錯(cuò), 因?yàn)榫幾g器沒有給這個(gè)引用返回值類型補(bǔ)充生命周期,
    //          這是因?yàn)楫?dāng)返回值是一個(gè)引用時(shí), 必須包含生命周期.
    //
    //       2. 如果手動(dòng)生命生命周期:
    //          fn print<'a, 'b>(status: &'a str, msg: &'b str) -> &'a str {};
    //          這樣也會(huì)報(bào)錯(cuò), 這是因?yàn)檫壿嫶a塊里面不僅僅是返回 'a 這個(gè)生命周期里面的 status 引用變量,
    //          也有可能會(huì)返回 'b 生命周期里面的 msg 引用變量, 因此與指定的返回值 -> &'a str 不相符.
    //
    //       3. 唯一的解決辦法是, 認(rèn)為的鎖定引用的生命周期, 都在一個(gè)生命周期里面.
    //          fn print<'a>(status: &'a str, msg: &'a str) -> &'a str {};
    //          通過(guò)這種方式, 不論返回的是status還是msg都是屬于 'a 生命周期,
    //          這種表達(dá)方式滿足兩種情況, 1. 他們的生命周期長(zhǎng)短一致, 2. 返回值的類型與指定值的類型一致.
}


fn fix_error_example_that_compile_not_fill_lifetime() {
    fn print<'a>(status: &'a str, msg: &'a str) -> &'a str {
        if status == "200" {
            println!("{}: {}", status, msg);
            msg
        } else {
            println!("{}: {}", status, msg);
            status
        }
    }

    print("200", "ok!");
    print("404", "page not found!");
}


fn main() {
    multi_reference_parameters_and_return_value_is_not_reference_type();
    only_one_reference_parameter_and_return_value_type_is_reference_too();
    lifetime_on_method();
    // error_example_that_compile_not_fill_lifetime();
    fix_error_example_that_compile_not_fill_lifetime();
}