Struct vtable::VRef

#[repr(transparent)]pub struct VRef<'a, T: ?Sized + VTableMeta> { /* fields omitted */ }

VRef<'a MyTraitVTable> can be thought as a &'a dyn MyTrait

It will dereference to a structure that has the same members as MyTrait.

Implementations

impl<'a, T: ?Sized + VTableMeta> VRef<'a, T>

pub fn new<X: HasStaticVTable<T>>(value: &'a X) -> Self

Create a new VRef from an reference of a type that can be associated with a VTable.

(the HasStaticVTable is implemented by the “MyTrait”VTable_static! macro generated by the #vtable macro)

pub fn new_pin<X: HasStaticVTable<T>>(value: Pin<&'a X>) -> Pin<Self>

Create a new Pin<VRef<_>> from a pinned reference. This is similar to VRef::new.

pub unsafe fn from_raw(vtable: NonNull<T::VTable>, ptr: NonNull<u8>) -> Self

Create a new VRef from raw pointers

Safety

The ptr needs to be a valid object fitting the vtable. Both vtable and ptr lifetime must outlive 'a

pub fn downcast<X: HasStaticVTable<T>>(&self) -> Option<&X>

Return a reference of the given type if the type is matching.

pub fn downcast_pin<X: HasStaticVTable<T>>(
    this: Pin<Self>
) -> Option<Pin<&'a X>>

Return a reference of the given type if the type is matching

Trait Implementations

impl<'a, T: ?Sized + VTableMeta> Clone for VRef<'a, T>

pub fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: ?Sized + VTableMeta> Copy for VRef<'a, T>

impl<'a, T: ?Sized + VTableMeta> Deref for VRef<'a, T>

type Target = T::Target

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.