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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
% API
# Builtins
# Byte
## Byte.hex
```tomo
Byte.hex : func(byte: Byte, uppercase: Bool = yes, prefix: Bool = no -> Text)
```
Convert a byte to a hexidecimal text representation.
Argument | Type | Description | Default
---------|------|-------------|---------
byte | `Byte` | The byte to convert to hex. |
uppercase | `Bool` | Whether or not to use uppercase hexidecimal letters. | **Default:** `yes`
prefix | `Bool` | Whether or not to prepend a `0x` prefix. | **Default:** `no`
**Return:** The byte as a hexidecimal text.
**Example:**
```tomo
>> Byte(18).hex()
= "0x12"
```
## Byte.is_between
```tomo
Byte.is_between : func(x: Byte, low: Byte, high: Byte -> Bool)
```
Determines if an integer is between two numbers (inclusive).
Argument | Type | Description | Default
---------|------|-------------|---------
x | `Byte` | The integer to be checked. |
low | `Byte` | The lower bound to check (inclusive). |
high | `Byte` | The upper bound to check (inclusive). |
**Return:** `yes` if `low <= x and x <= high`, otherwise `no`
**Example:**
```tomo
>> Byte(7).is_between(1, 10)
= yes
>> Byte(7).is_between(100, 200)
= no
>> Byte(7).is_between(1, 7)
= yes
```
## Byte.parse
```tomo
Byte.parse : func(text: Text -> Byte?)
```
Parse a byte literal from text.
Argument | Type | Description | Default
---------|------|-------------|---------
text | `Text` | The text to parse. |
**Return:** The byte parsed from the text, if successful, otherwise `none`.
**Example:**
```tomo
>> Byte.parse("5")
= Byte(5)?
>> Byte.parse("asdf")
= none
```
## Byte.to
```tomo
Byte.to : func(first: Byte, last: Byte, step: Byte? = none -> func(->Byte?))
```
Returns an iterator function that iterates over the range of bytes specified.
Argument | Type | Description | Default
---------|------|-------------|---------
first | `Byte` | The starting value of the range. |
last | `Byte` | The ending value of the range. |
step | `Byte?` | An optional step size to use. If unspecified or `none`, the step will be inferred to be `+1` if `last >= first`, otherwise `-1`. | **Default:** `none`
**Return:** An iterator function that returns each byte in the given range (inclusive).
**Example:**
```tomo
>> Byte(2).to(5)
= func(->Byte?)
>> [x for x in Byte(2).to(5)]
= [Byte(2), Byte(3), Byte(4), Byte(5)]
>> [x for x in Byte(5).to(2)]
= [Byte(5), Byte(4), Byte(3), Byte(2)]
>> [x for x in Byte(2).to(5, step=2)]
= [Byte(2), Byte(4)]
```
|
