Skip to main content

UeMap

Struct UeMap 

Source
pub struct UeMap<K: ContainerElement, V: ContainerElement> { /* private fields */ }
Expand description

A view into a UE TMap<K, V> property on a UObject.

Implementations§

Source§

impl<K: ContainerElement, V: ContainerElement> UeMap<K, V>

Source

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

Source

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

Returns the number of key-value pairs in the map.

Source

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

Source

pub fn find(&self, key: &K) -> UikaResult<V>

Look up a value by key. Returns Err(PropertyNotFound) if the key is not in the map.

Source

pub fn add(&self, key: &K, val: &V) -> UikaResult<()>

Insert or replace a key-value pair.

Source

pub fn remove(&self, key: &K) -> UikaResult<()>

Remove a key from the map.

Source

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

Remove all key-value pairs.

Source

pub fn get_pair(&self, logical_index: usize) -> UikaResult<(K, V)>

Get the key-value pair at logical index (for iteration).

Source

pub fn iter(&self) -> UeMapIter<'_, K, V>

Returns an iterator over key-value pairs.

Source§

impl<K: ContainerElement, V: ContainerElement> UeMap<K, V>

Source

pub fn bulk_iter(&self) -> UikaResult<BulkMapIter<K, V>>

Bulk-fetch all key-value pairs as a lazy iterator (single FFI call).

Source§

impl<K: ContainerElement + Hash + Eq, V: ContainerElement> UeMap<K, V>

Source

pub fn to_hash_map(&self) -> UikaResult<HashMap<K, V>>

Bulk-copy all key-value pairs to a HashMap in a single FFI call.

Trait Implementations§

Source§

impl<K: Clone + ContainerElement, V: Clone + ContainerElement> Clone for UeMap<K, V>

Source§

fn clone(&self) -> UeMap<K, V>

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, K: ContainerElement, V: ContainerElement> IntoIterator for &'a UeMap<K, V>

Source§

type Item = Result<(K, V), UikaError>

The type of the elements being iterated over.
Source§

type IntoIter = UeMapIter<'a, K, V>

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<K: Copy + ContainerElement, V: Copy + ContainerElement> Copy for UeMap<K, V>

Auto Trait Implementations§

§

impl<K, V> Freeze for UeMap<K, V>

§

impl<K, V> RefUnwindSafe for UeMap<K, V>

§

impl<K, V> Send for UeMap<K, V>
where K: Send, V: Send,

§

impl<K, V> Sync for UeMap<K, V>
where K: Sync, V: Sync,

§

impl<K, V> Unpin for UeMap<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnsafeUnpin for UeMap<K, V>

§

impl<K, V> UnwindSafe for UeMap<K, V>
where K: UnwindSafe, V: 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.