aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Int.parse.3
blob: 282dc2889f6912ca10adcf093ed7ec52999d9632 (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
44
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Int.parse 3 2025-04-19T14:48:15.710864 "Tomo man-pages"
.SH NAME
Int.parse \- Converts a text representation of an integer into an integer.

.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.parse\ :\ func(text:\ Text\ ->\ Int?)
.fi

.SH DESCRIPTION
Converts a text representation of an integer into an integer.


.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
text	Text	The text containing the integer. 	-
.TE
.SH RETURN
The integer represented by the text. If the given text contains a value outside of the representable range or if the entire text can't be parsed as an integer, `none` will be returned.

.SH EXAMPLES
.EX
>> Int.parse("123")
= 123 : Int?
>> Int.parse("0xFF")
= 255 : Int?

# Can't parse:
>> Int.parse("asdf")
= none : Int?

# Outside valid range:
>> Int8.parse("9999999")
= none : Int8?
.EE