rusteal_core/
struct_ref.rs

1// UStructRef<T>: lightweight typed wrapper for struct memory pointers.
2//
3// Unlike UObjectRef<T>, struct memory is not garbage-collected by UE.
4// UStructRef is just a typed raw pointer to a struct instance in memory
5// (e.g., inside a UObject property or a parameter buffer).
6
7use std::marker::PhantomData;
8
9use rusteal_ffi::UObjectHandle;
10
11use crate::traits::UeStruct;
12
13/// A typed, non-owning reference to a UE struct instance in memory.
14///
15/// This wraps a raw pointer to struct data (e.g., an FVector stored inside
16/// a UObject property). The struct memory is managed by its container —
17/// no validity check is needed (unlike UObjectRef).
18///
19/// PropertyApi methods accept `UObjectHandle` (`*mut c_void`) which works
20/// for both UObject pointers and raw struct memory pointers.
21pub struct UStructRef<T: UeStruct> {
22    ptr: *mut u8,
23    _marker: PhantomData<T>,
24}
25
26impl<T: UeStruct> UStructRef<T> {
27    /// Create from a raw pointer to struct memory.
28    ///
29    /// # Safety
30    /// The caller must ensure `ptr` points to valid memory containing a `T`.
31    #[inline]
32    pub unsafe fn from_raw(ptr: *mut u8) -> Self {
33        UStructRef {
34            ptr,
35            _marker: PhantomData,
36        }
37    }
38
39    /// Get the raw pointer as a `UObjectHandle`.
40    ///
41    /// PropertyApi methods take `UObjectHandle` which is `*mut c_void` —
42    /// this works for both UObject pointers and raw struct memory.
43    #[inline]
44    pub fn as_ptr(&self) -> UObjectHandle {
45        UObjectHandle(self.ptr as *mut std::ffi::c_void)
46    }
47}
48
49/// Create a `UStructRef<T>` from a native parameter buffer pointer + byte offset.
50///
51/// Used by `#[uclass_impl]` macro for Override function struct parameters.
52///
53/// # Safety
54///
55/// `ptr` must point to a live parameter buffer and `offset` must be the offset
56/// of a `T` inside it, as UE laid the buffer out; the reference must not outlive
57/// the call the buffer belongs to.
58#[inline(always)]
59pub unsafe fn struct_ref_from_param<T: UeStruct>(ptr: *mut u8, offset: usize) -> UStructRef<T> {
60    unsafe { UStructRef::from_raw(ptr.add(offset)) }
61}
62
63impl<T: UeStruct> std::fmt::Debug for UStructRef<T> {
64    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
65        f.debug_struct("UStructRef").field("ptr", &self.ptr).finish()
66    }
67}
rusteal_core/struct_ref.rs

rusteal_core/
struct_ref.rs
