Dict

dict#

Builtin (dict args...) Creates a dictionary from a set of arguments, grouping them 2 by 2 to create (key, value) pairs

Parameter#

• args...: the arguments of the function

Author#

@SuperFola

Example#

(let d (dict "key" "value" 5 12))
(print d)  # {key: value, 5: 12}

get#

(let get (fun (_D _key) (...))) Get a value from a given dictionary using a key, or nil if it doesn’t exist

Parameters#

• _D: dictionary
• _key: key to get

Author#

@SuperFola

Example#

(let data (dict "key" "value"))
(print (dict:get data "key"))  # value

add#

(let add (fun (_D _key _value) (...))) Adds or replaces an entry to a dictionary, given a (key, value) pair

Note: The dictionary is modified in place

Parameters#

• _D: dictionary
• _key: key to add (or replace)
• _value: value for the given key

Author#

@SuperFola

Example#

(let data (dict "key" "value"))
(dict:add data "hello" "world")
(dict:add data "key" "hole")  # key:value will be replaced by key:hole
(print data)  # {key: hole, hello: world}

contains#

(let contains (fun (_D _key) (...)))

Parameter#

• _D: dictionary

Author#

@SuperFola

Example#

(let data (dict "key" "value"))
(print (dict:contains data "key"))  # true
(print (dict:contains data "test"))  # false

remove#

(let remove (fun (_D _key) (...))) Deletes an entry from a dictionary, given a key

Note: The dictionary is modified in place

Parameters#

• _D: dictionary
• _key: key to delete

Author#

@SuperFola

Example#

(let data (dict "key" "value"))
(dict:remove data "key")
(print (dict:get data "key"))  # nil

keys#

(let keys (fun (_D) (...))) Returns a list of the keys of a dictionary

Parameter#

• _D: dictionary

Author#

@SuperFola

Example#

(let data (dict "key" "value" 5 12))
(print (dict:keys data))  # [key, 5]

size#

(let size (fun (_D) (...))) Computes the number of (key, value) pairs in a given dictionary

Parameter#

• _D: dictionary

Author#

@SuperFola

Example#

(let data (dict "key" "value"))
(print (dict:size data))  # 1

values#

(let values (fun (_D) (...))) Returns a list of the values of a dictionary

Parameter#

• _D: dictionary

Author#

@SuperFola

Example#

(let data (dict "key" "value" 5 12))
(print (dict:values data))  # [value, 12]

entries#

(let entries (fun (_D) (...))) Returns a list of the entries of a dictionary

Parameter#

• _D: dictionary

Author#

@SuperFola

Example#

(let data (dict "key" "value" 5 12))
(print (dict:entries data))  # [[key, value], [5, 12]]

map#

(let map (fun (_D _f) (...))) Map each value in a dictionary with a given function

Note: The original dictionary is not modified

Parameters#

• _D: dictionary
• _f: function to apply to each value, taking both key and value as arguments

Author#

@SuperFola

Example#

(let data (dict "key" "value"))
(let new (dict:map data (fun (key value) (format "{}-{}" key value))))
(print data)  # {key: value}
(print new)  # {key: key-value}

map!#

(let map! (fun (_D _f) (...))) Map each value in a dictionary with a given function

Note: The original dictionary is updated in place

Parameters#

• _D: dictionary
• _f: function to apply to each value, taking both key and value as arguments

Author#

@SuperFola

Example#

(let data (dict "key" "value"))
(dict:map! data (fun (key value) (format "{}-{}" key value)))
(print data)  # {key: key-value}

forEach#

(let forEach (fun (_D _f) (...))) Iterate over the pairs of a dictionary with a given function

Parameters#

• _D: dictionary
• _f: function to call on each pair

Author#

@SuperFola

Example#

(let data (dict "key" "value" 5 12))
(dict:forEach data (fun (key value) (print (format "{}-{}" key value))))
# key-value
# 5-12

filter#

(let filter (fun (_D _f) (...))) Filter a dictionary with a predicate

Note: The original dictionary is not modified

Parameters#

• _D: dictionary
• _f: predicate, taking both key and value as arguments

Author#

@SuperFola

Example#

(let data (dict "key" "value" "hello" "world"))
(let new (dict:filter data (fun (key value) (> (len key) 3))))
(print data)  # {key: value, hello: world}
(print new)  # {hello: world}

filter!#

(let filter! (fun (_D _f) (...))) Filter a dictionary with a predicate

Note: The original dictionary is updated in place

Parameters#

• _D: dictionary
• _f: predicate, taking both key and value as arguments

Author#

@SuperFola

Example#

(let data (dict "key" "value" "hello" "world"))
(dict:filter! data (fun (key value) (> (len key) 3)))
(print data)  # {hello: world}

copy#

(let copy (fun (_D) (...))) Copy a dictionary

Note: The original dictionary is not modified

Parameter#

• _D: dictionary to copy

Author#

@SuperFola

Example#

(let data (dict "key" "value" "hello" "world"))
(let new (dict:copy data))
(dict:add data "test" 12)
(print data)  # {key: value, hello: world, test: 12}
(print new)  # {key: value, hello: world}

update!#

(let update! (fun (_D _D2) (...))) Update a dictionary with (key, value) pairs from a second dictionary

Note: The original dictionary is updated in place

Parameters#

• _D: dictionary to update
• _D2: second dictionary

Author#

@SuperFola

Example#

(let data (dict "key" "value" "hello" "world"))
(let new (dict "key" "new value" 5 12))
(dict:update! data new)
(print data)  # {key: new value, hello: world, 5: 12}