Struct Userdata 

pub struct Userdata { /* private fields */ }

Implementations

impl Userdata

pub const unsafe fn from_raw(raw: NonNull<RawUserdata>) -> Self

Constructs a non-owning handle from a VM userdata record.

Safety

raw must address a live RawUserdata owned by the VM in which this handle will be used. The handle does not root the userdata or extend its lifetime.

pub fn allocation_size_for_payload_len(payload_len: usize) -> Option<usize>

pub unsafe fn metatable(&self) -> Option<Table>

Returns this userdata’s metatable handle, if present.

Safety

The userdata and its owning VM must be live. The returned handle is non-owning and is invalidated when the metatable is freed.

pub unsafe fn set_metatable(&self, metatable: Option<Table>)

Replaces this userdata’s metatable pointer.

Safety

The userdata must be live, and metatable, when present, must belong to the same VM. The caller must maintain the VM’s GC barrier protocol.

pub fn total_payload_len(&self) -> usize

pub const fn data_ptr(&self) -> *const u8

pub const unsafe fn data_mut_ptr(&self) -> *mut u8

Returns the mutable address of this userdata’s inline payload.

Safety

The userdata must be live, and the caller must enforce bounds and aliasing for every access through the returned pointer.

pub unsafe fn set_inline_destructor( &self, requested_payload_len: usize, destructor: LuaInlineDestructor, )

Stores the inline destructor following the requested payload.

Safety

This must be an inline-destructor userdata whose allocation contains a destructor-sized trailer immediately after requested_payload_len.

pub unsafe fn inline_destructor(&self) -> LuaInlineDestructor

Loads the destructor stored after an inline-destructor payload.

Safety

This must be a live inline-destructor userdata whose payload trailer was initialized with a valid LuaInlineDestructor.

pub unsafe fn allocation_size(&self) -> usize

Returns this userdata allocation’s full GC size.

Safety

The userdata record must be live and its stored payload length must describe the allocation that contains it.

Trait Implementations

impl AsRef<Userdata> for Userdata

fn as_ref(&self) -> &Userdata

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Userdata

fn clone(&self) -> Userdata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Userdata

impl Eq for Userdata

impl From<Userdata> for GcObject

fn from(value: Userdata) -> Self

Converts to this type from the input type.

impl PartialEq for Userdata

fn eq(&self, other: &Userdata) -> bool

Equality operator ==.

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

Inequality operator !=.

impl RawHandle for Userdata

type Raw = RawUserdata

Raw VM record addressed by this handle.

fn as_ptr(&self) -> *mut Self::Raw

Returns the record address without dereferencing it.

impl StructuralPartialEq for Userdata