Skip to main content

UeArray

Struct UeArray 

Source
pub struct UeArray<T: ContainerElement> { /* private fields */ }
Expand description

A view into a UE TArray<T> property on a UObject.

This is a lightweight Copy handle — it does not own the data. All operations go through FFI calls to the C++ container API.

Implementations§

Source§

impl<T: ContainerElement> UeArray<T>

Source

pub fn new(owner: UObjectHandle, prop: FPropertyHandle) -> Self

Create a new array view from an owner object handle and a property handle.

Source

pub fn len(&self) -> UikaResult<usize>

Returns the number of elements in the array.

Source

pub fn is_empty(&self) -> UikaResult<bool>

Returns true if the array is empty.

Source

pub fn get(&self, index: usize) -> UikaResult<T>

Get the element at index.

Source

pub fn set(&self, index: usize, val: &T) -> UikaResult<()>

Set the element at index.

Source

pub fn push(&self, val: &T) -> UikaResult<()>

Append an element to the end of the array.

Source

pub fn remove(&self, index: usize) -> UikaResult<()>

Remove the element at index, shifting subsequent elements down.

Source

pub fn clear(&self) -> UikaResult<()>

Remove all elements from the array.

Source

pub fn iter(&self) -> UeArrayIter<'_, T>

Returns an iterator over the elements.

Source§

impl<T: ContainerElement> UeArray<T>

Source

pub fn to_vec(&self) -> UikaResult<Vec<T>>

Bulk-copy all elements to a Vec<T> in a single FFI call.

Source

pub fn bulk_iter(&self) -> UikaResult<BulkArrayIter<T>>

Bulk-fetch all elements as a lazy iterator (single FFI call).

Source

pub fn set_all(&self, items: &[T]) -> UikaResult<()>

Replace all array elements from a slice in a single FFI call.

Trait Implementations§

Source§

impl<T: Clone + ContainerElement> Clone for UeArray<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, T: ContainerElement> IntoIterator for &'a UeArray<T>

Source§

type Item = Result<T, UikaError>

The type of the elements being iterated over.
Source§

type IntoIter = UeArrayIter<'a, T>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<T: Copy + ContainerElement> Copy for UeArray<T>

Auto Trait Implementations§

§

impl<T> Freeze for UeArray<T>

§

impl<T> RefUnwindSafe for UeArray<T>
where T: RefUnwindSafe,

§

impl<T> Send for UeArray<T>
where T: Send,

§

impl<T> Sync for UeArray<T>
where T: Sync,

§

impl<T> Unpin for UeArray<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for UeArray<T>

§

impl<T> UnwindSafe for UeArray<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.