Struct koto_runtime::KMap

pub struct KMap { /* private fields */ }

The core hashmap value type used in Koto, containing a ValueMap and a MetaMap

Implementations

impl KMap

pub fn new() -> Self

Creates an empty KMap

pub fn with_type(type_name: &str) -> Self

Creates an empty KMap, with a MetaMap containing the given @type string

pub fn with_capacity(capacity: usize) -> Self

Creates an empty KMap with the given capacity

pub fn with_data(data: ValueMap) -> Self

Creates a KMap initialized with the provided data

pub fn with_contents(data: ValueMap, meta: Option<MetaMap>) -> Self

Creates a KMap initialized with the provided data and meta map

pub fn from_data_and_meta_maps(data: &Self, meta: &Self) -> Self

Makes a KMap taking the data map from the first arg, and the meta map from the second

pub fn data(&self) -> Borrow<'_, ValueMap>

Provides a reference to the data map

pub fn data_mut(&self) -> BorrowMut<'_, ValueMap>

Provides a mutable reference to the data map

pub fn meta_map(&self) -> Option<&PtrMut<MetaMap>>

Provides a reference to the KMap’s meta map

This is returned as a reference to the meta map’s PtrMut to allow for cloning.

pub fn set_meta_map(&mut self, meta: Option<PtrMut<MetaMap>>)

Sets the KMap’s meta map

Note that this change isn’t shared with maps that share the same data.

pub fn contains_meta_key(&self, key: &MetaKey) -> bool

Returns true if the meta map contains an entry with the given key

pub fn get<K>(&self, key: &K) -> Option<KValue>

where K: Hash + Equivalent<ValueKey> + ?Sized,

Returns a clone of the data value corresponding to the given key

pub fn get_meta_value(&self, key: &MetaKey) -> Option<KValue>

Returns a clone of the meta value corresponding to the given key

pub fn insert(&self, key: impl Into<ValueKey>, value: impl Into<KValue>)

Insert an entry into the KMap’s data

pub fn insert_meta(&mut self, key: MetaKey, value: KValue)

Inserts a value into the meta map, initializing the meta map if it doesn’t yet exist

pub fn add_fn(&self, id: &str, f: impl KotoFunction)

Adds a function to the KMap’s data map

pub fn len(&self) -> usize

Returns the number of entries in the KMap’s data map

Note that this doesn’t include entries in the meta map.

pub fn is_empty(&self) -> bool

Returns true if the KMap’s data map contains no entries

Note that this doesn’t take entries in the meta map into account.

pub fn clear(&mut self)

Removes all contents from the data map, and removes the meta map

pub fn is_same_instance(&self, other: &Self) -> bool

Returns true if the provided KMap occupies the same memory address

pub fn display(&self, ctx: &mut DisplayContext<'_>) -> Result<()>

Renders the map to the provided display context

Trait Implementations

impl Clone for KMap

fn clone(&self) -> KMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for KMap

fn default() -> KMap

Returns the “default value” for a type.

impl From<KMap> for KValue

fn from(value: KMap) -> Self

Converts to this type from the input type.

impl From<ValueMap> for KMap

fn from(value: ValueMap) -> Self

Converts to this type from the input type.