Struct PluginCustomDataRef 

pub struct PluginCustomDataRef { /* private fields */ }

Borrowed view of a plug-in custom-data value during on_data dispatch.

The value stays owned by the host-side wrapper. Plug-in code can inspect the type name and downcast to a concrete custom-data type that was declared in the same cdylib manifest.

Implementations

impl PluginCustomDataRef

pub unsafe fn from_raw_parts( type_name: BorrowedStr<'static>, vtable: *const CustomDataVTable, handle: *const CustomDataHandle, ) -> Self

Constructs a borrowed custom-data reference from raw boundary parts.

Safety

handle must be null or point at a live value allocated by vtable, and type_name must name the same concrete custom-data type for the duration of the call.

pub fn type_name(&self) -> &str

Returns the canonical custom-data type name.

pub fn is<T>(&self) -> bool

where T: PluginCustomData + PartialEq + Clone,

Returns whether this value was allocated by the vtable for T.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: PluginCustomData + PartialEq + Clone,

Returns the value as T when it was allocated by T’s vtable.

Trait Implementations

impl Clone for PluginCustomDataRef

fn clone(&self) -> PluginCustomDataRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PluginCustomDataRef