Struct Pinned 

pub struct Pinned<T>
where
    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.

#[repr(C)] guarantees deterministic layout so that the blanket Deref pointer cast (&Pinned<T> → &Pinned<T::Parent>) is sound.

Implementations

impl<T> Pinned<T>

where T: UeClass,

pub fn new(obj: UObjectRef<T>) -> Result<Pinned<T>, RustealError>

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> Debug for Pinned<T>

where T: UeClass,

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

Formats the value using the given formatter.

impl<T> Deref for Pinned<T>

where T: HasParent,

Blanket Deref: Pinned<Child> auto-derefs to Pinned<Parent>. Safe because Pinned<T> is #[repr(C)] and PhantomData is zero-sized, so Pinned<T> and Pinned<T::Parent> have identical layout.

No upcast() on Pinned — it owns a GC root, so consuming would be unsound. Use Deref for borrowed access to parent methods instead.

type Target = Pinned<<T as HasParent>::Parent>

The resulting type after dereferencing.

fn deref(&self) -> &Pinned<<T as HasParent>::Parent>

Dereferences the value.

impl<T> Drop for Pinned<T>

where T: UeClass,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> Send for Pinned<T>

where T: UeClass,

impl<T> UeHandle for Pinned<T>

where T: UeClass,

fn checked_handle(&self) -> Result<UObjectHandle, RustealError>

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> ValidHandle for Pinned<T>

where T: UeClass,

fn handle(&self) -> UObjectHandle

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