aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Table.get.3
blob: 87dc40ec8403d5480b31857acc295ed476046651 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Table.get 3 2025-11-29 "Tomo man-pages"
.SH NAME
Table.get \- get an item from a table
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.get\ :\ func(t:\ {K:V},\ key:\ K\ ->\ V?)
.fi
.SH DESCRIPTION
Retrieves the value associated with a key, or returns `none` if the key is not present.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx
l l l.
Name	Type	Description
t	{K:V}	The table. 
key	K	The key whose associated value is to be retrieved. 
.TE
.SH RETURN
The value associated with the key or `none` if the key is not found.

.SH NOTES
Default values for the table are ignored.

.SH EXAMPLES
.EX
t := {"A": 1, "B": 2}
assert t.get("A") == 1
assert t.get("????") == none
assert t.get("A")! == 1
assert t.get("????") or 0 == 0
.EE
.SH SEE ALSO
.BR Tomo-Table (3)