diff options
Diffstat (limited to 'api')
| -rw-r--r-- | api/api.md | 6 | ||||
| -rw-r--r-- | api/integers.md | 6 | ||||
| -rw-r--r-- | api/integers.yaml | 12 |
3 files changed, 22 insertions, 2 deletions
@@ -662,7 +662,7 @@ assert nums[] == [5, 6, 7, 8, 9, 10] ## Int.parse ```tomo -Int.parse : func(text: Text, remainder: &Text? = none -> Int?) +Int.parse : func(text: Text, base: Int? = none, remainder: &Text? = none -> Int?) ``` Converts a text representation of an integer into an integer. @@ -670,6 +670,7 @@ Converts a text representation of an integer into an integer. Argument | Type | Description | Default ---------|------|-------------|--------- text | `Text` | The text containing the integer. | - +base | `Int?` | The numeric base to use when parsing the integer. If unspecified, the integer's base will be inferred from the text prefix. After any "+" or "-" sign, if the text begins with "0x", the base will be assumed to be 16, "0o" will assume base 8, "0b" will assume base 2, otherwise the base will be assumed to be 10. | `none` remainder | `&Text?` | If non-none, this argument will be set to the remainder of the text after the matching part. If none, parsing will only succeed if the entire text matches. | `none` **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. @@ -690,6 +691,9 @@ assert Int.parse("asdf") == none # Outside valid range: assert Int8.parse("9999999") == none +# Explicitly specifying base: +assert Int.parse("10", base=16) == 16 + ``` ## Int.prev_prime diff --git a/api/integers.md b/api/integers.md index 6af66b0d..ef3a6a60 100644 --- a/api/integers.md +++ b/api/integers.md @@ -255,7 +255,7 @@ assert nums[] == [5, 6, 7, 8, 9, 10] ## Int.parse ```tomo -Int.parse : func(text: Text, remainder: &Text? = none -> Int?) +Int.parse : func(text: Text, base: Int? = none, remainder: &Text? = none -> Int?) ``` Converts a text representation of an integer into an integer. @@ -263,6 +263,7 @@ Converts a text representation of an integer into an integer. Argument | Type | Description | Default ---------|------|-------------|--------- text | `Text` | The text containing the integer. | - +base | `Int?` | The numeric base to use when parsing the integer. If unspecified, the integer's base will be inferred from the text prefix. After any "+" or "-" sign, if the text begins with "0x", the base will be assumed to be 16, "0o" will assume base 8, "0b" will assume base 2, otherwise the base will be assumed to be 10. | `none` remainder | `&Text?` | If non-none, this argument will be set to the remainder of the text after the matching part. If none, parsing will only succeed if the entire text matches. | `none` **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. @@ -283,6 +284,9 @@ assert Int.parse("asdf") == none # Outside valid range: assert Int8.parse("9999999") == none +# Explicitly specifying base: +assert Int.parse("10", base=16) == 16 + ``` ## Int.prev_prime diff --git a/api/integers.yaml b/api/integers.yaml index 70709b04..b3c6b579 100644 --- a/api/integers.yaml +++ b/api/integers.yaml @@ -280,6 +280,15 @@ Int.parse: type: 'Text' description: > The text containing the integer. + base: + type: 'Int?' + default: 'none' + description: > + The numeric base to use when parsing the integer. If unspecified, the + integer's base will be inferred from the text prefix. After any "+" or + "-" sign, if the text begins with "0x", the base will be assumed to be + 16, "0o" will assume base 8, "0b" will assume base 2, otherwise the + base will be assumed to be 10. remainder: type: '&Text?' default: 'none' @@ -300,6 +309,9 @@ Int.parse: # Outside valid range: assert Int8.parse("9999999") == none + # Explicitly specifying base: + assert Int.parse("10", base=16) == 16 + Int.prev_prime: short: get the previous prime description: > |