Struct Pinned 

pub struct Pinned<T: UeClass> { /* private fields */ }

An owning GC root for a UObject.

• !Copy, !Clone — unique ownership of the GC root.
• Send — can be moved across threads.
• !Sync — must only be used on the game thread.
• Drop removes the GC root and unregisters from destroy notification.

Method calls on Pinned<T> use a local alive flag (~1-3 cycles) instead of an FFI is_valid call (~15-30 cycles) for validity checking.

Implementations

impl<T: UeClass> Pinned<T>

pub fn new(obj: UObjectRef<T>) -> UikaResult<Self>

Pin an object by adding a GC root and registering for destroy notification. Fails if the object is already destroyed.

pub fn is_alive(&self) -> bool

Check whether the pinned object is still alive (local memory read).

pub fn handle(&self) -> UObjectHandle

Get the underlying raw handle. Guaranteed valid while this Pinned exists and is_alive() returns true.

pub fn as_ref(&self) -> UObjectRef<T>

Borrow as a lightweight UObjectRef. The returned ref is valid as long as this Pinned is alive.

pub fn as_checked(&self) -> Checked<T>

Create a Checked<T> handle from this pinned reference. Valid as long as is_alive() returns true (debug-asserted).

Trait Implementations

impl<T: UeClass> Debug for Pinned<T>

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

Formats the value using the given formatter.

impl<T: UeClass> Drop for Pinned<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: UeClass> UeHandle for Pinned<T>

fn checked_handle(&self) -> UikaResult<UObjectHandle>

Return the raw handle if the object is alive, or Err(ObjectDestroyed).

fn raw_handle(&self) -> UObjectHandle

Return the raw handle without validity check.

impl<T: UeClass> ValidHandle for Pinned<T>

fn handle(&self) -> UObjectHandle

Return the raw handle. The implementor guarantees (or debug-asserts) that the handle is valid.

impl<T: UeClass> Send for Pinned<T>