Struct NativeHashMap<TKey, TValue>
An unordered, expandable associative array.
Implements
Namespace: Unity.Collections
Assembly: solution.dll
Syntax
[NativeContainer]
public struct NativeHashMap<TKey, TValue> : INativeDisposable where TKey : unmanaged, IEquatable<TKey> where TValue : unmanaged
Type Parameters
Name | Description |
---|---|
TKey | The type of the keys. |
TValue | The type of the values. |
Remarks
Not suitable for parallel write access. Use NativeParallelHashMap<TKey, TValue> instead.
Constructors
Name | Description |
---|---|
NativeHashMap(int, AllocatorHandle) | Initializes and returns an instance of UnsafeHashMap. |
Properties
Name | Description |
---|---|
Capacity | The number of key-value pairs that fit in the current allocation. |
Count | The current number of key-value pairs in this hash map. |
IsCreated | Whether this hash map has been allocated (and not yet deallocated). |
IsEmpty | Whether this hash map is empty. |
this[TKey] | Gets and sets values by key. |
Methods
Name | Description |
---|---|
Add(TKey, TValue) | Adds a new key-value pair. |
AsReadOnly() | Returns a readonly version of this NativeHashMap instance. |
Clear() | Removes all key-value pairs. |
ContainsKey(TKey) | Returns true if a given key is present in this hash map. |
Dispose() | Releases all resources (memory). |
Dispose(JobHandle) | Creates and schedules a job that will dispose this hash map. |
GetEnumerator() | Returns an enumerator over the key-value pairs of this hash map. |
GetKeyArray(AllocatorHandle) | Returns an array with a copy of all this hash map's keys (in no particular order). |
GetKeyValueArrays(AllocatorHandle) | Returns a NativeKeyValueArrays with a copy of all this hash map's keys and values. |
GetValueArray(AllocatorHandle) | Returns an array with a copy of all this hash map's values (in no particular order). |
Remove(TKey) | Removes a key-value pair. |
TrimExcess() | Sets the capacity to match what it would be if it had been originally initialized with all its entries. |
TryAdd(TKey, TValue) | Adds a new key-value pair. |
TryGetValue(TKey, out TValue) | Returns the value associated with a key. |