ArchGrid

在最近的编码中遇到了一个提示the trait cannot be made into an object的问题。这个问题其实是从其他语言中直接迁移来的习惯造成的，这里记录一下问题所在。

这个问题涉及到了Rust语言中“对象安全性”的问题，这个问题在其他语言中大多都是被语言自动处理掉的，但是在Rust这种“手动档”语言中，就需要自己解决一下了。就不要说这个“对象安全性”问题也经常是被忽略的事情。

起因

这个问题的起因实际上非常简单，我在一个特征中定义了一个异步方法。比如下面这样：

1
2
3


trait Protocol {
  async fn device_name(&self) -> Option<String>;
}

单看这个定义其实是没有什么错的，在很多其他语言中也的确是这么定义的。但是在使用动态分发来完成多态特性的时候就出现问题了，比如这样定义一个结构。

1
2
3


pub struct State {
  pub protocol: Arc<Mutex<Option<Box<dyn Protocol>>>>,
}

然后在dyn Protocol这里就开始提示了：the trait Protocol cannot be made into an object。

单看这个错误提示是会非常懵圈的，这个特征到底怎么了，为什么就不能通过动态分发实现多态的特性呢？

解决

回顾完动态分发和对象安全性的规则，就可以确定前面的代码实际上是违反了对象安全性规则的第四条：定义了一个async fn。那么解决方法也就确定了，代替Rust编译器默认完成的工作，显式在特征中声明异步函数的返回值，确定返回的Future类型。所以修改一下前面的代码就变成了下面的样子。

1
2
3


trait Protocol {
  fn device_name(&self) -> Pin<Box<dyn Future<Output = String> + Send>>;
}

这样在实现的时候可以这样来做：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


impl Protocol for Driver {
  // 注意这里如果不显式声明生命期，会提示生命期不够长的错误。
  fn device_name(&'_ self) -> Pin<Box<dyn Future<Output = String> + Send>> {
    let device = Arc::clone(&self.device);
    Box::pin(async move {
      let device = device.lock().await;
      let properties = device.properties().await;
      properties.local_name.clone()
    })
  }
}

Box::pin可以将Future对象放入堆内存中，并且可以保证其生命期足够长。与Box<T>不同的是，Pin<Box<T>>是一个固定的堆内存分配指针，这种稳定内存地址的数据结构在多线程和异步操作中非常有用（数据结构中存在自引用也需要）。一个数据一旦被固定，那么就不能再移动或者替换。

尝试使用mem::swap()来交换被固定的值会出现编译错误。

另外一个不同就是Box<T>这种可移动的堆分配指针是可以把数据中一个Box<T>中移动到另一个的。

只有在类型T实现了特征Unpin的时候，才可以将Box<T>转换为Pin<Box<T>>，否则就需要使用Box::pin来固定数据。

Box::pin中出现的async move {}是一个异步代码块，它会立即返回一个实现了Future特征的值，但并不直接执行其中的代码。这个返回的Future会在后续使用.await调用的时候运行其中的实际逻辑。由于返回的这个Future是匿名的，无法直接在已有结构中显式存储，所以就需要使用Box::pin将其固定在堆上，并在运行时中保持其内存地址的稳定。

总结

如果需要在特征中定义一个异步方法，请手动完成它的具体返回值类型。

在编码的过程中，Rust编译器实际上做了很多的自动化工作，这虽然节省了很多时间，但是也带来了一些非常容易忽视的问题，对于这些从其他语言中搬移过来的设计方法和编码习惯，在Rust中需要格外的留心一些。

对象安全性带来的一个大坑

起因

相关知识点

动态分发和静态分发

对象安全性

方法不能返回`Self`

方法不能使用泛型参数

`Sized`不能作为隐式要求

方法不能是`async fn`

解决

总结

索引标签