Struct Reference 

pub struct Reference<'a> { /* private fields */ }

See ArgData for details. A reference to data that will be passed through FFI.

Safety

The referenced data must outlive the NSI context that uses this reference. The data must remain at a stable memory address.

This type now properly enforces pinning by requiring heap-allocated data through Box, Arc, or similar types that guarantee stable addresses.

Implementations

impl<'a> Reference<'a>

pub fn new<S: StableDeref<'a>>(data: S) -> Self

Create a reference from any type that implements StableDeref. This includes &Box, &Arc, and &Pin<Box>.

pub fn from_box<T: ?Sized>(data: &'a Box<T>) -> Self

Create a reference from a Box.

Box guarantees a stable heap address, making it safe for FFI.

pub fn from_arc<T: ?Sized>(data: &'a Arc<T>) -> Self

Create a reference from an Arc.

Arc guarantees a stable heap address, making it safe for FFI.

pub fn from_pin_box<T: ?Sized>(data: &'a Pin<Box<T>>) -> Self

Create a reference from a pinned Box.

This is the safest option as it guarantees the data cannot be moved.

pub unsafe fn from_stable<T: ?Sized>(data: &'a T) -> Self

Create a reference from data with a stable address.

Safety

The caller must guarantee that data has a stable address for its entire lifetime. This is automatically true for:

• Heap allocated types (Box, Arc, Vec’s data, String’s data)
• Static data
• Pinned data

This is NOT safe for:

• Stack allocated data that might move
• Data inside collections that might reallocate

pub unsafe fn from_ptr(ptr: *const c_void) -> Self

Create a reference from a raw pointer.

Safety

The caller must ensure that:

1. The pointer is valid and non-null
2. The pointed-to data outlives ’a
3. The data won’t be moved or freed while this reference exists

Trait Implementations

impl<'a> Clone for Reference<'a>

fn clone(&self) -> Reference<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Reference<'a>

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

Formats the value using the given formatter.

impl<'a, 'b> From<Reference<'b>> for ArgData<'a, 'b>

fn from(v: Reference<'b>) -> ArgData<'a, 'b>

Converts to this type from the input type.

impl<'a, 'b> TryInto<Reference<'b>> for ArgData<'a, 'b>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<Reference<'b>, <Self as TryInto<Reference<'b>>>::Error>

Performs the conversion.

impl Send for Reference<'static>

impl Sync for Reference<'static>