Struct UObjectRef 

pub struct UObjectRef<T>
where
    T: UeClass,
{ /* private fields */ }

A typed, non-owning reference to a UObject.

• Copy + Send — can be freely cloned and sent across threads.
• !Sync — must only be used on the game thread.
• Does not prevent garbage collection; call is_valid before use, or upgrade to Pinned<T> via pin.

Implementations

impl<T> UObjectRef<T>

where T: UeClass,

pub fn null() -> UObjectRef<T>

No object: what C++ returns as nullptr. Never valid.

pub unsafe fn from_raw(handle: UObjectHandle) -> UObjectRef<T>

Create from a raw FFI handle.

Safety

The caller must ensure the handle points to an object whose UClass is T or a subclass of T.

pub fn raw(&self) -> UObjectHandle

Get the underlying raw handle.

pub fn is_valid(&self) -> bool

Check whether the underlying UObject is still alive.

pub fn checked(&self) -> Result<Checked<T>, RustealError>

Validate that the object is still alive, returning a Checked<T> handle that provides infallible access to extension trait methods.

pub fn cast<U>(self) -> Result<UObjectRef<U>, RustealError>

where U: UeClass,

Cast to a different UClass type. Fails if the object is destroyed or is not an instance of U.

pub fn pin(self) -> Result<Pinned<T>, RustealError>

Upgrade to a Pinned<T>, adding a GC root to keep the object alive.

pub fn get_name(&self) -> Result<String, RustealError>

Get the object’s FName as a String.

pub fn get_class(&self) -> Result<UClassHandle, RustealError>

Get the object’s UClass handle.

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

Get the object’s Outer.

pub fn is_a<U>(&self) -> bool

where U: UeClass,

Check whether this object is an instance of U (or a subclass of U). Returns false if the object has been destroyed.

impl<T> UObjectRef<T>

where T: HasParent,

pub fn upcast(self) -> UObjectRef<<T as HasParent>::Parent>

Infallible upcast to the parent class. Zero-cost (same handle).

impl<T> UObjectRef<T>

where T: UeClass,

pub fn upcast_to<U>(self) -> UObjectRef<U>

where U: UeClass, T: Inherits<U>,

Infallible upcast to any ancestor class, checked at compile time (character.upcast_to::<Object>() for a world context). Zero-cost.

Trait Implementations

impl<T> Clone for UObjectRef<T>

where T: UeClass,

fn clone(&self) -> UObjectRef<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> ContainerElement for UObjectRef<T>

where T: UeClass,

const BUF_SIZE: u32

Buffer size for FFI transport. Must be large enough for the C++ side to write the element value.

unsafe fn read_from_buf(buf: *const u8, _written: u32) -> UObjectRef<T>

Interpret bytes from the C++ side into a Rust value.

unsafe fn write_to_buf(&self, buf: *mut u8) -> u32

Write this value into a buffer for C++ WriteElement to consume. Returns the number of bytes written.

const RAW_COPYABLE: bool = false

Whether this type can be bulk-copied as raw bytes (no per-element framing). True for fixed-size primitives (bool, integers, floats) and FName.

impl<T> Copy for UObjectRef<T>

where T: UeClass,

impl<T> Debug for UObjectRef<T>

where T: UeClass,

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

Formats the value using the given formatter.

impl<T> Default for UObjectRef<T>

where T: UeClass,

fn default() -> UObjectRef<T>

No object: nullptr.

impl<T> Deref for UObjectRef<T>

where T: HasParent,

Blanket Deref: UObjectRef<Child> auto-derefs to UObjectRef<Parent>. Safe because UObjectRef<T> is #[repr(transparent)] over UObjectHandle.

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

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> Eq for UObjectRef<T>

where T: UeClass,

impl<T> Hash for UObjectRef<T>

where T: UeClass,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> ObjectPointer for UObjectRef<T>

where T: UeClass,

unsafe fn from_object_handle(handle: UObjectHandle) -> UObjectRef<T>

Wrap a pointer the engine returned.

fn object_handle(&self) -> UObjectHandle

The pointer to hand to the engine.

impl<T> PartialEq for UObjectRef<T>

where T: UeClass,

fn eq(&self, other: &UObjectRef<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T> Send for UObjectRef<T>

where T: UeClass,

impl<T> UeHandle for UObjectRef<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.