高级生命周期

ch19-02-advanced-lifetimes.md
commit 1fedfc4b96c2017f64ecfcf41a0a07e2e815f24f

回顾第十章 “生命周期与引用有效性” 部分,我们学习了怎样使用生命周期参数注解引用来帮助 Rust 理解不同引用的生命周期如何相互联系。我们理解了每一个引用都有生命周期,不过大部分情况 Rust 允许我们省略生命周期。这里我们会看到三个还未涉及到的生命周期高级特征:

  • 生命周期子类型(lifetime subtyping),一个确保某个生命周期长于另一个生命周期的方式
  • 生命周期 bound(lifetime bounds),用于指定泛型引用的生命周期
  • trait 对象生命周期(trait object lifetimes),以及他们是如何推断的,以及何时需要指定
  • 匿名生命周期:使(生命周期)省略更为明显

生命周期子类型确保某个生命周期长于另一个生命周期

生命周期子类型是一个指定某个生命周期应该长于另一个生命周期的方式。为了探索生命周期子类型,想象一下我们想要编写一个解析器。为此会有一个储存了需要解析的字符串的引用的结构体 Context。解析器将会解析字符串并返回成功或失败。解析器需要借用 Context 来进行解析。其实现看起来像示例 19-12 中的代码,除了缺少了必须的生命周期注解,所以这还不能编译:

文件名: src/lib.rs

struct Context(&str);

struct Parser {
    context: &Context,
}

impl Parser {
    fn parse(&self) -> Result<(), &str> {
        Err(&self.context.0[1..])
    }
}

示例 19-12: 定义一个不带生命周期注解的解析器

编译代码会导致一个表明 Rust 期望 Context 中字符串 slice 和 ParserContext 的引用的生命周期的错误。

为了简单起见,parse 方法返回 Result<(), &str>。也就是说,成功时不做任何操作,失败时则返回字符串 slice 没有正确解析的部分。真实的实现将会包含比这更多的错误信息,并将会在解析成功时返回实际结果,不过我们将去掉这些部分的实现,因为他们与这个例子的生命周期部分并不相关。

为了保持代码简单,我们不准备实际编写任何解析逻辑。解析逻辑的某处非常有可能通过返回引用输入中无效部分的错误来处理无效输入,而考虑到生命周期,这个引用是使得这个例子有趣的地方。所以我们将假设解析器的逻辑为输入的第一个字节之后是无效的。注意如果第一个字节并不位于一个有效的字符范围内(比如 Unicode)代码将会 panic;这里又一次简化了例子以专注于涉及到的生命周期。

为了使代码能够编译,我们需要放入 Context 中字符串 slice 和 ParserContext 引用的生命周期参数。最直接的方法是在每处都使用相同的生命周期,如示例 19-13 所示。回忆第十章 “结构体定义中的生命周期注解” 部分,struct Context<'a>struct Parser<'a>impl<'a> 每一个都声明了一个新的生命周期参数。虽然这些名字碰巧都一样,例子中声明的三个生命周期参数并不相关。

文件名: src/lib.rs


# #![allow(unused_variables)]
#fn main() {
struct Context<'a>(&'a str);

struct Parser<'a> {
    context: &'a Context<'a>,
}

impl<'a> Parser<'a> {
    fn parse(&self) -> Result<(), &str> {
        Err(&self.context.0[1..])
    }
}
#}

示例 19-13: 将所有 ContextParser 中的引用标注生命周期参数

这次可以编译了,并告诉了 Rust Parser 存放了一个 Context 的引用,拥有生命周期 'a,且 Context 存放了一个字符串 slice,它也与 ParserContext 的引用存在的一样久。Rust 编译器的错误信息表明这些引用需要生命周期参数,现在我们增加了这些生命周期参数。

接下来,在示例 19-14 中,让我们编写一个获取 Context 的实例,使用 Parser 来解析其内容,并返回 parse 的返回值的函数。这还不能运行:

文件名: src/lib.rs

fn parse_context(context: Context) -> Result<(), &str> {
    Parser { context: &context }.parse()
}

示例 19-14: 一个增加获取 Context 并使用 Parser 的函数 parse_context 的尝试

当尝试编译这段额外带有 parse_context 函数的代码时会得到两个相当冗长的错误:

error[E0597]: borrowed value does not live long enough
  --> src/lib.rs:14:5
   |
14 |     Parser { context: &context }.parse()
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ does not live long enough
15 | }
   | - temporary value only lives until here
   |
note: borrowed value must be valid for the anonymous lifetime #1 defined on the function body at 13:1...
  --> src/lib.rs:13:1
   |
13 | / fn parse_context(context: Context) -> Result<(), &str> {
14 | |     Parser { context: &context }.parse()
15 | | }
   | |_^

error[E0597]: `context` does not live long enough
  --> src/lib.rs:14:24
   |
14 |     Parser { context: &context }.parse()
   |                        ^^^^^^^ does not live long enough
15 | }
   | - borrowed value only lives until here
   |
note: borrowed value must be valid for the anonymous lifetime #1 defined on the function body at 13:1...
  --> src/lib.rs:13:1
   |
13 | / fn parse_context(context: Context) -> Result<(), &str> {
14 | |     Parser { context: &context }.parse()
15 | | }
   | |_^

这些错误表明我们创建的两个 Parser 实例和 context 参数从 Parser 被创建开始一直存活到 parse_context 函数结束。不过他们都需要在整个函数的生命周期中都有效。

换句话说,Parsercontext 需要比整个函数 长寿outlive)并在函数开始之前和结束之后都有效以确保代码中的所有引用始终是有效的。虽然我们创建的两个 Parsercontext 参数在函数的结尾就离开了作用域,因为 parse_context 获取了 context 的所有权。

为了理解为什么会得到这些错误,让我们再次看看示例 19-13 中的定义,特别是 parse 方法的签名中的引用:

    fn parse(&self) -> Result<(), &str> {

还记得(生命周期)省略规则吗?如果标注了引用生命周期而不加以省略,签名看起来应该是这样:

    fn parse<'a>(&'a self) -> Result<(), &'a str> {

正是如此,parse 返回值的错误部分的生命周期与 Parser 实例的生命周期(parse 方法签名中的 &self)相绑定。这就可以理解了:因为返回的字符串 slice 引用了 Parser 存放的 Context 实例中的字符串 slice,同时在 Parser 结构体的定义中指定了 Parser 中存放的 Context 引用的生命周期和 Context 中存放的字符串 slice 的生命周期应该一致。

问题是 parse_context 函数返回 parse 的返回值,所以 parse_context 返回值的生命周期也与 Parser 的生命周期相联系。不过 parse_context 函数中创建的 Parser 实例并不能存活到函数结束之后(它是临时的),同时 context 将会在函数的结尾离开作用域(parse_context 获取了它的所有权)。

Rust 认为我们尝试返回一个在函数结尾离开作用域的值,因为我们将所有的生命周期都标注为相同的生命周期参数。这告诉了 Rust Context 中存放的字符串 slice 的生命周期与 Parser 中存放的 Context 引用的生命周期一致。

parse_context 函数并不知道 parse 函数里面是什么,返回的字符串 slice 将比 ContextParser 都存活的更久,同时 parse_context 返回的引用指向字符串 slice,而不是 ContextParser

通过了解 parse 实现所做的工作,可以知道 parse 的返回值(的生命周期)与 Parser 相联系的唯一理由是它引用了 ParserContext,也就是引用了这个字符串 slice,这正是 parse_context 所需要关心的生命周期。需要一个方法来告诉 Rust Context 中的字符串 slice 与 ParserContext 的引用有着不同的生命周期,而且 parse_context 返回值与 Context 中字符串 slice 的生命周期相联系。

首先尝试像示例 19-15 那样给予 ParserContext 不同的生命周期参数。这里选择了生命周期参数名 's'c 是为了使得 Context 中字符串 slice 与 ParserContext 引用的生命周期显得更明了(英文首字母)。注意这并不能完全解决问题,不过这是一个开始,我们将看看为什么这还不足以能够编译代码。

文件名: src/lib.rs

struct Context<'s>(&'s str);

struct Parser<'c, 's> {
    context: &'c Context<'s>,
}

impl<'c, 's> Parser<'c, 's> {
    fn parse(&self) -> Result<(), &'s str> {
        Err(&self.context.0[1..])
    }
}

fn parse_context(context: Context) -> Result<(), &str> {
    Parser { context: &context }.parse()
}

示例 19-15: 为字符串 slice 和 Context 的引用指定不同的生命周期参数

这里在与示例 19-13 完全相同的地方标注了引用的生命周期,不过根据引用是字符串 slice 或 Context 与否使用了不同的参数。另外还在 parse 返回值的字符串 slice 部分增加了注解来表明它与 Context 中字符串 slice 的生命周期相关联。

这里是现在尝试编译时得到的错误:

error[E0491]: in type `&'c Context<'s>`, reference has a longer lifetime than the data it references
 --> src/lib.rs:4:5
  |
4 |     context: &'c Context<'s>,
  |     ^^^^^^^^^^^^^^^^^^^^^^^^
  |
note: the pointer is valid for the lifetime 'c as defined on the struct at 3:1
 --> src/lib.rs:3:1
  |
3 | / struct Parser<'c, 's> {
4 | |     context: &'c Context<'s>,
5 | | }
  | |_^
note: but the referenced data is only valid for the lifetime 's as defined on the struct at 3:1
 --> src/lib.rs:3:1
  |
3 | / struct Parser<'c, 's> {
4 | |     context: &'c Context<'s>,
5 | | }
  | |_^

Rust 并不知道 'c's 之间的任何联系。为了保证有效性,Context 中引用的带有生命周期 's 的数据需要遵守它比带有生命周期 'cContext 的引用存活得更久的保证。如果 's 不比 'c 更长久,那么 Context 的引用可能不再有效。

这就引出了本部分的要点:Rust 的 生命周期子类型lifetime subtyping)功能,这是一个指定一个生命周期不会短于另一个的方法。在声明生命周期参数的尖括号中,可以照常声明一个生命周期 'a,并通过语法 'b: 'a 声明一个不短于 'a 的生命周期 'b

Parser 的定义中,为了表明 's(字符串 slice 的生命周期)保证至少与 'cContext 引用的生命周期)一样长,需将生命周期声明改为如此:

文件名: src/lib.rs


# #![allow(unused_variables)]
#fn main() {
# struct Context<'a>(&'a str);
#
struct Parser<'c, 's: 'c> {
    context: &'c Context<'s>,
}
#}

现在 ParserContext 的引用与 Context 中字符串 slice 就有了不同的生命周期,并且保证了字符串 slice 的生命周期比 Context 引用的要长。

这是一个非常冗长的例子,不过正如本章的开头所提到的,这类功能是很小众的。你并不会经常需要这个语法,不过当出现类似这样的情形时,却还是有地方可以参考的。

生命周期 bound 用于泛型的引用

在第十章 “trait bound” 部分,我们讨论了如何在泛型类型上使用 trait bound。也可以像泛型那样为生命周期参数增加限制,这被称为 生命周期 boundlifetime bounds)。生命周期 bound 帮助 Rust 验证泛型的引用不会存在的比其引用的数据更久。

例如,考虑一下一个封装了引用的类型。回忆一下第十五章 “RefCell<T> 和内部可变性模式” 部分的 RefCell<T> 类型:其 borrowborrow_mut 方法分别返回 RefRefMut 类型。这些类型是引用的封装,他们在运行时记录检查借用规则。Ref 结构体的定义如示例 19-16 所示,目前还不带有生命周期 bound:

文件名: src/lib.rs

struct Ref<'a, T>(&'a T);

示例 19-16: 定义结构体来封装泛型的引用,没有生命周期 bound

若不显式限制生命周期 'a 为与泛型参数 T 有关,会得到一个错误因为 Rust 不知道泛型 T 会存活多久:

error[E0309]: the parameter type `T` may not live long enough
 --> src/lib.rs:1:19
  |
1 | struct Ref<'a, T>(&'a T);
  |                   ^^^^^^
  |
  = help: consider adding an explicit lifetime bound `T: 'a`...
note: ...so that the reference type `&'a T` does not outlive the data it points at
 --> src/lib.rs:1:19
  |
1 | struct Ref<'a, T>(&'a T);
  |                   ^^^^^^

因为 T 可以是任意类型,T 自身也可能是一个引用,或者是一个存放了一个或多个引用的类型,而他们各自可能有着不同的生命周期。Rust 不能确认 T 会与 'a 存活的一样久。

幸运的是,Rust 提供了这个情况下如何指定生命周期 bound 的有用建议:

consider adding an explicit lifetime bound `T: 'a` so that the reference type
`&'a T` does not outlive the data it points at

示例 19-17 展示了如何按照这个建议,在声明泛型 T 时指定生命周期 bound。。


# #![allow(unused_variables)]
#fn main() {
struct Ref<'a, T: 'a>(&'a T);
#}

示例 19-17: 为 T 增加生命周期 bound 来指定 T 中的任何引用需至少与 'a 存活的一样久

现在代码可以编译了,因为 T: 'a 语法指定了 T 可以为任意类型,不过如果它包含任何引用的话,其生命周期必须至少与 'a 一样长。

我们可以选择不同的方法来解决这个问题,如示例 19-18 中 StaticRef 的结构体定义所示,通过在 T 上增加 'static 生命周期约束。这意味着如果 T 包含任何引用,他们必须有 'static 生命周期:


# #![allow(unused_variables)]
#fn main() {
struct StaticRef<T: 'static>(&'static T);
#}

示例 19-18: 在 T 上增加 'static 生命周期 bound,来限制 T 为只拥有 'static 生命周期的引用或没有引用的类型

因为 'static 意味着引用必须同整个程序存活的一样长,一个不包含引用的类型满足所有引用都与整个程序存活的一样长的标准(因为他们没有引用)。对于借用检查器来说它关心的是引用是否存活的足够久,没有引用的类型与有永远存在的引用的类型并没有真正的区别;对于确定引用是否比其所引用的值存活得较短的目的来说两者是一样的。

trait 对象生命周期的推断

在第十七章的 “为使用不同类型的值而设计的 trait 对象” 部分,我们讨论了 trait 对象,它包含一个位于引用之后的 trait,这允许我们进行动态分发。我们所没有讨论的是如果 trait 对象中实现 trait 的类型带有生命周期时会发生什么。考虑一下示例 19-19,其中有 trait Red 和结构体 BallBall 存放了一个引用(因此有一个生命周期参数)并实现了 trait Red。我们希望使用一个作为 trait 对象 Box<Red>Ball 实例:

文件名: src/main.rs

trait Red { }

struct Ball<'a> {
    diameter: &'a i32,
}

impl<'a> Red for Ball<'a> { }

fn main() {
    let num = 5;

    let obj = Box::new(Ball { diameter: &num }) as Box<dyn Red>;
}

示例 19-19: 使用一个带有生命周期的类型用于 trait 对象

这段代码能没有任何错误的编译,即便并没有明确指出 obj 中涉及的任何生命周期。这是因为有如下生命周期与 trait 对象必须遵守的规则:

  • trait 对象的默认生命周期是 'static
  • 如果有 &'a X&'a mut X,则默认生命周期是 'a
  • 如果只有 T: 'a 从句, 则默认生命周期是 'a
  • 如果有多个类似 T: 'a 的从句,则没有默认生命周期;必须明确指定。

当必须明确指定时,可以为像 Box<Red> 这样的 trait 对象增加生命周期 bound,根据需要使用语法 Box<Foo + 'a>Box<Foo + 'static>。正如其他的 bound,这意味着任何 Red trait 的实现如果在内部包含有引用, 这些引用就必须拥有与 trait 对象 bound 中所指定的相同的生命周期。

匿名生命周期

比方说有一个封装了一个字符串 slice 的结构体,如下:


# #![allow(unused_variables)]
#fn main() {
struct StrWrap<'a>(&'a str);
#}

可以像这样编写一个返回它们的函数:


# #![allow(unused_variables)]
#fn main() {
# struct StrWrap<'a>(&'a str);
fn foo<'a>(string: &'a str) -> StrWrap<'a> {
    StrWrap(string)
}
#}

不过这里有很多的 'a!为了消除这些噪音,可以使用匿名生命周期,'_,如下:


# #![allow(unused_variables)]
#fn main() {
# struct StrWrap<'a>(&'a str);
fn foo(string: &str) -> StrWrap<'_> {
    StrWrap(string)
}
#}

'_ 表明 “在此处使用省略的生命周期。” 这意味着我们仍然知道 StrWrap 包含一个引用,不过无需所有的生命周期注解来知道。

其也能用于 impl;例如:

// 冗余
impl<'a> fmt::Debug for StrWrap<'a> {

// 省略
impl fmt::Debug for StrWrap<'_> {

接下来,让我们看看一些其他处理 trait 的高级功能吧!