rusteal-core 0.5.0

Safe Rust runtime for rusteal (object refs, lifecycle, dynamic calls)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

// rusteal-core: Safe Rust API wrapping rusteal-ffi.
// All unsafe FFI calls are confined to this crate. Generated code and user
// code interact only with the safe types exported here.

pub mod api;
pub mod error;
pub mod traits;

/// FFI dispatch wrappers: thin `unsafe` shims around the API table sub-tables.
/// Auto-generated by `build.rs` from `rusteal-ffi/src/api_table.rs`.
#[allow(unused_imports, unused_unsafe, unsafe_op_in_unsafe_fn, clippy::all)]
pub mod ffi_dispatch {
    include!(concat!(env!("OUT_DIR"), "/ffi_dispatch.rs"));
}
pub mod object_ref;
pub mod subclass_of;
pub mod struct_ref;
pub mod pinned;
pub mod dynamic_call;
pub mod logging;
pub mod ffi_guard;
pub mod containers;
pub mod delegate_registry;
pub mod reify_registry;
pub mod ue_math;
pub mod fname;
pub mod weak_ptr;
pub mod widget;
pub mod input;
pub mod console;
pub mod task;
pub mod world;
pub mod soft_ref;

// Re-export the primary public API surface.
pub use api::{api, init_api};
pub use error::{check_ffi, check_ffi_ctx, ffi_infallible, ffi_infallible_ctx, RustealError, RustealResult};
pub use traits::{UeClass, UeStruct, UeEnum, UeHandle, ValidHandle, HasParent, Inherits};
pub use object_ref::{Checked, ObjectPointer, UObjectRef};
pub use subclass_of::SubclassOf;
pub use soft_ref::SoftObjectRef;
pub use struct_ref::UStructRef;
pub use pinned::Pinned;
pub use dynamic_call::{DynamicCall, DynamicCallResult};
pub use logging::{LOG_DISPLAY, LOG_WARNING, LOG_ERROR};
pub use ffi_guard::ffi_boundary;
pub use containers::{ContainerElement, OwnedStruct, UeArray, UeMap, UeSet};
pub use delegate_registry::DelegateBinding;
pub use console::ConsoleVariable;

// Phase 10 re-exports.
pub use fname::FName;
pub use struct_ref::{OutRef, out_ref_from_param, struct_ref_from_param};
pub use weak_ptr::TWeakObjectPtr;
pub use ue_math::{
    Rotator, Transform, LinearColor, Color,
    Plane, Ray, Sphere, UeBox, UeBox2d, BoxSphereBounds,
};

// Re-export FFI types needed by generated code in rusteal-bindings.
pub use rusteal_ffi::{
    UObjectHandle, UClassHandle, FPropertyHandle, UStructHandle,
    FNameHandle, FWeakObjectHandle, RustealErrorCode,
};

// ---------------------------------------------------------------------------
// Lock helpers — recover from mutex poisoning instead of panicking
// ---------------------------------------------------------------------------

use std::sync::{Mutex, MutexGuard, RwLock, RwLockReadGuard, RwLockWriteGuard};

/// Lock a Mutex, recovering from poison.
pub(crate) fn lock_or_recover<T>(m: &Mutex<T>) -> MutexGuard<'_, T> {
    m.lock().unwrap_or_else(|e| e.into_inner())
}

/// Read-lock a RwLock, recovering from poison.
pub(crate) fn read_or_recover<T>(m: &RwLock<T>) -> RwLockReadGuard<'_, T> {
    m.read().unwrap_or_else(|e| e.into_inner())
}

/// Write-lock a RwLock, recovering from poison.
pub(crate) fn write_or_recover<T>(m: &RwLock<T>) -> RwLockWriteGuard<'_, T> {
    m.write().unwrap_or_else(|e| e.into_inner())
}