Home / Docs / Standard library / Built-in methods

get

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.get(key: K) -> Option[V]
  where m: Map[K, V]

Some exactly when m.has(key: k). A missing key gives None, not a failure (spec/21 §2). On a HashMap, in O(|k|) expected (spec/28 §7).

Edition 0.5 preview

una
m.get(key: K) -> Option[V]
  where m: Map[K, V]
m.get(key: K) -> Option[V]
  where m: HashMap[K, V]

Some exactly when m.has(key: k). A missing key gives None, not a failure (spec/21 §2). On a HashMap, in O(|k|) expected (spec/28 §7).

In editions 0.5. In edition 0.2, 0.3, 0.4: no HashMap[K, V] receiver, since std.collections begins in edition 0.5: it has no where m: HashMap[K, V].

Receiver

Parameters

Returns

Option[V]: Some of the value at key, Some exactly when m.has(key: key); a missing key gives None, not a failure.

See also

has

Cost

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

Example

src/shop.unauna
module shop

--- The stock of an item, or a note that it is not stocked.
describe(name: Text, units: Option[Int]) -> Text
=
  when units
    is Some(n) -> "{name}: {n}"
    is None -> "{name}: not stocked"

pub main() -> Unit
  uses @console: Console[print]
=
  let stock = empty_map().with(key: "lamp", value: 3).with(key: "desk", value: 1)
  @console.print(describe("lamp", units: stock.get(key: "lamp")))
  @console.print(describe("chair", units: stock.get(key: "chair")))

una run . prints:

Output
lamp: 3
chair: not stocked

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.