API Host ScriptHashMap

ScriptHashMap

High-performance runtime hash map that hosts may create or inspect.

Namespace: AuroraScript.Runtime.Types. Kind: class.

Back to .NET Host API Reference

Overview

High-performance runtime hash map that hosts may create or inspect.

Quick Reference

A minimal use of ScriptHashMap.

var map = new ScriptHashMap();
var key = ScriptDatum.FromString("answer");

map.Put(key, ScriptDatum.FromNumber(42));
Console.WriteLine(map.Get(key).Number); // 42

Constructors

ScriptHashMap()

Creates a ScriptHashMap instance.

ScriptHashMap()

Parameters

None.

Returns

A new ScriptHashMap instance.

ScriptHashMap(int capacity)

Creates a ScriptHashMap instance.

ScriptHashMap(int capacity)

Parameters

Name	Type	Required	Description
capacity	int	Yes	Initial storage capacity.

Returns

A new ScriptHashMap instance.

Methods

Put

void Put(ScriptDatum key, ScriptDatum value)

Parameters

Name	Type	Required	Description
key	ScriptDatum	Yes	Key to look up or store.
value	ScriptDatum	Yes	Map value associated with key.

Returns

None.

Get

ScriptDatum Get(ScriptDatum key)

Parameters

Name	Type	Required	Description
key	ScriptDatum	Yes	Key to look up or store.

Returns

Returns ScriptDatum.

GetOrInsert

ScriptDatum GetOrInsert(ScriptDatum key, ScriptDatum value)

ScriptDatum GetOrInsert(ScriptContext ctx, ScriptDatum key, ClosureFunction callback)

• ScriptDatum GetOrInsert(ScriptDatum key, ScriptDatum value)
• ScriptDatum GetOrInsert(ScriptContext ctx, ScriptDatum key, ClosureFunction callback)

Parameters

Name	Type	Required	Description
key	ScriptDatum	Yes	Key to look up or store.
value	ScriptDatum	Varies	Value inserted when key is absent.
ctx	ScriptContext	Varies	Current script execution context.
callback	ClosureFunction	Varies	Callback invoked by the runtime.

Returns

Returns ScriptDatum.

Has

bool Has(ScriptDatum key)

Parameters

Name	Type	Required	Description
key	ScriptDatum	Yes	Key to look up or store.

Returns

Returns bool.

Delete

ScriptDatum Delete(ScriptDatum key)

Parameters

Name	Type	Required	Description
key	ScriptDatum	Yes	Key to look up or store.

Returns

Returns ScriptDatum.

Keys

ScriptDatum[] Keys()

Parameters

None.

Returns

Returns ScriptDatum[].

Values

ScriptDatum[] Values()

Parameters

None.

Returns

Returns ScriptDatum[].

Length

int Length()

Parameters

None.

Returns

Returns int.

Clear

void Clear()

Parameters

None.

Returns

None.