Struct SmartPointerDef

#[non_exhaustive]
#[repr(C)]
pub struct SmartPointerDef<'shape> {
    pub vtable: &'shape SmartPointerVTable,
    pub pointee: Option<fn() -> &'shape Shape<'shape>>,
    pub weak: Option<fn() -> &'shape Shape<'shape>>,
    pub strong: Option<fn() -> &'shape Shape<'shape>>,
    pub flags: SmartPointerFlags,
    pub known: Option<KnownSmartPointer>,
}

Describes a smart pointer — including a vtable to query and alter its state, and the inner shape (the pointee type in the smart pointer).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

vtable: &'shape SmartPointerVTable

vtable for interacting with the smart pointer

pointee: Option<fn() -> &'shape Shape<'shape>>

shape of the inner type of the smart pointer, if not opaque

weak: Option<fn() -> &'shape Shape<'shape>>

shape of the corresponding strong pointer, if this pointer is weak

strong: Option<fn() -> &'shape Shape<'shape>>

shape of the corresponding weak pointer, if this pointer is strong

flags: SmartPointerFlags

Flags representing various characteristics of the smart pointer

known: Option<KnownSmartPointer>

An optional field to identify the kind of smart pointer

Implementations

impl<'shape> SmartPointerDef<'shape>

pub const fn builder() -> SmartPointerDefBuilder<'shape>

Creates a new SmartPointerDefBuilder with all fields set to None.

pub fn pointee(&self) -> Option<&'shape Shape<'shape>>

Returns shape of the inner type of the smart pointer, if not opaque

pub fn weak(&self) -> Option<&'shape Shape<'shape>>

Returns shape of the corresponding strong pointer, if this pointer is weak

pub fn strong(&self) -> Option<&'shape Shape<'shape>>

Returns shape of the corresponding weak pointer, if this pointer is strong

Trait Implementations

impl<'shape> Clone for SmartPointerDef<'shape>

fn clone(&self) -> SmartPointerDef<'shape>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'shape> Debug for SmartPointerDef<'shape>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'shape> Hash for SmartPointerDef<'shape>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'shape> PartialEq for SmartPointerDef<'shape>

fn eq(&self, other: &SmartPointerDef<'shape>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'shape> Copy for SmartPointerDef<'shape>

impl<'shape> Eq for SmartPointerDef<'shape>

impl<'shape> StructuralPartialEq for SmartPointerDef<'shape>