Home / Docs / Standard library / Built-in methods

with

Release v0.4.0Edition 0.2 and later

A built-in method, resolved by the type of its receiver (spec/14 §2). Edition 0.2 and later.

Edition 0.2 and later

una
m.with(key: K, value: V) -> Map[K, V]
  where m: Map[K, V]

A map with the contract of set, for the result (spec/21 §2). On a Set, a set with the contract of add, for the result (spec/28 §6); on a HashMap and a HashSet, the same for the hash table (spec/28 §7); on a BitSet, the same for the bit set (spec/28 §9).

Edition 0.5 preview

una
m.with(key: K, value: V) -> Map[K, V]
  where m: Map[K, V]
s.with(item: T) -> Set[T]
  where s: Set[T]
m.with(key: K, value: V) -> HashMap[K, V]
  where m: HashMap[K, V]
s.with(item: T) -> HashSet[T]
  where s: HashSet[T]
b.with(item: Int) -> BitSet
  where b: BitSet

A map with the contract of set, for the result (spec/21 §2). On a Set, a set with the contract of add, for the result (spec/28 §6); on a HashMap and a HashSet, the same for the hash table (spec/28 §7); on a BitSet, the same for the bit set (spec/28 §9).

In editions 0.5. In edition 0.2, 0.3, 0.4: no Set[T], HashMap[K, V], HashSet[T] or BitSet receiver, since std.collections begins in edition 0.5: it has none of s.with(item: T) -> Set[T], where s: Set[T], m.with(key: K, value: V) -> HashMap[K, V], where m: HashMap[K, V], s.with(item: T) -> HashSet[T], where s: HashSet[T], b.with(item: Int) -> BitSet and where b: BitSet.

On a Map[K, V]

The receiver is the map m.

Parameters

Returns

Map[K, V]: a map with the contract of set for the result: m with value at key; m itself is unchanged.

On a Set[T]

The receiver is the set s.

Parameters

Returns

Set[T]: a set with the contract of add for the result: s with item; s itself is unchanged.

On a HashMap[K, V]

The receiver is the hash map m.

Parameters

Returns

HashMap[K, V]: a map with the contract of set for the result: m with value at key, a new key listed last; m itself is unchanged.

On a HashSet[T]

The receiver is the hash set s.

Parameters

Returns

HashSet[T]: a set with the contract of add for the result: s with item, a new item listed last; s itself is unchanged.

On a BitSet

The receiver is the bit set b.

Parameters

Returns

BitSet: a bit set with the contract of add for the result: b with item, of the same size; b itself is unchanged.

See also

set, without

Cost

Time O(log n) per lookup, insertion and removal on a Map[K, V] (spec/21 §5), where:

Example

src/shop.unauna
module shop

--- A price list built one entry at a time.
pub main() -> Unit
  uses @console: Console[print]
=
  let prices = empty_map().with(key: "lamp", value: 1999).with(key: "desk", value: 4999)
  @console.print("{prices.len} prices")

una run . prints:

Output
2 prices

Specification

Generated from una v0.4.0 (docs/std/builtins.json, which is not part of the specification): built-in methods have no declaration, so una writes these signature lines and tests each against its checker. The specification governs: spec/14 §2.