Skip to content

Latest commit

 

History

History
157 lines (115 loc) · 4.11 KB

trait-object.md

File metadata and controls

157 lines (115 loc) · 4.11 KB

trait对象 (trait object)

trait对象在Rust中是指使用指针封装了的 trait,比如 &SomeTraitBox<SomeTrait>

trait Foo { fn method(&self) -> String; }

impl Foo for u8 { fn method(&self) -> String { format!("u8: {}", *self) } }
impl Foo for String { fn method(&self) -> String { format!("string: {}", *self) } }

fn do_something(x: &Foo) {
    x.method();
}

fn main() {
    let x = "Hello".to_string();
    do_something(&x);
    let y = 8u8;
    do_something(&y);
}

x: &Foo其中x是一个trait对象,这里用指针是因为x可以是任意实现Foo的类型实例,内存大小并不确定,但指针的大小是固定的。

trait对象的实现

&SomeTrait 类型和普通的指针类型&i32不同。它不仅包括指向真实对象的指针,还包括一个指向虚函数表的指针。它的内部实现定义在在std::raw模块中:

pub struct TraitObject {
    pub data: *mut (),
    pub vtable: *mut (),
}

其中data是一个指向实际类型实例的指针, vtable是一个指向实际类型对于该trait的实现的虚函数表:

Foo的虚函数表类型:

struct FooVtable {
    destructor: fn(*mut ()),
    size: usize,
    align: usize,
    method: fn(*const ()) -> String,
}

之前的代码可以解读为:

// u8:
// 这个函数只会被指向u8的指针调用
fn call_method_on_u8(x: *const ()) -> String {
    let byte: &u8 = unsafe { &*(x as *const u8) };

    byte.method()
}

static Foo_for_u8_vtable: FooVtable = FooVtable {
    destructor: /* compiler magic */,
    size: 1,
    align: 1,

    method: call_method_on_u8 as fn(*const ()) -> String,
};


// String:
// 这个函数只会被指向String的指针调用
fn call_method_on_String(x: *const ()) -> String {
    let string: &String = unsafe { &*(x as *const String) };

    string.method()
}

static Foo_for_String_vtable: FooVtable = FooVtable {
    destructor: /* compiler magic */,
    size: 24,
    align: 8,

    method: call_method_on_String as fn(*const ()) -> String,
};


let a: String = "foo".to_string();
let x: u8 = 1;

// let b: &Foo = &a;
let b = TraitObject {
    // data存储实际值的引用
    data: &a,
    // vtable存储实际类型实现Foo的方法
    vtable: &Foo_for_String_vtable
};

// let y: &Foo = x;
let y = TraitObject {
    data: &x,
    vtable: &Foo_for_u8_vtable
};

// b.method();
(b.vtable.method)(b.data);

// y.method();
(y.vtable.method)(y.data);

对象安全

并不是所有的trait都能作为trait对象使用的,比如:

let v = vec![1, 2, 3];
let o = &v as &Clone;

会有一个错误:

error: cannot convert to a trait object because trait `core::clone::Clone` is not object-safe [E0038]
let o = &v as &Clone;
        ^~
note: the trait cannot require that `Self : Sized`
let o = &v as &Clone;
        ^~

让我来分析一下错误的原因:

pub trait Clone: Sized {
    fn clone(&self) -> Self;

    fn clone_from(&mut self, source: &Self) { ... }
}

虽然Clone本身继承了Sized这个trait,但是它的方法fn clone(&self) -> Selffn clone_from(&mut self, source: &Self) { ... }含有Self类型,而在使用trait对象方法的时候Rust是动态派发的,我们根本不知道这个trait对象的实际类型,它可以是任何一个实现了该trait的类型的值,所以Self在这里的大小不是Self: Sized的,这样的情况在Rust中被称为object-unsafe或者not object-safe,这样的trait是不能成为trait对象的。

总结:

如果一个trait方法是object safe的,它需要满足:

  • 方法有Self: Sized约束, 或者
  • 同时满足以下所有条件:
    • 没有泛型参数
    • 不是静态函数
    • 除了self之外的其它参数和返回值不能使用Self类型

如果一个traitobject-safe的,它需要满足:

  • 所有的方法都是object-safe的,并且
  • trait 不要求 Self: Sized 约束

参考stackoverflow object safe rfc