parse_error

Types

ParseError

pub type ParseError {
  EmptyString
  WhitespaceOnlyString
  InvalidUnderscorePosition(index: Int)
  InvalidDecimalPosition(index: Int)
  InvalidSignPosition(index: Int, character: String)
  InvalidDigitPosition(index: Int, character: String)
  BasePrefixOnly(index_range: #(Int, Int), prefix: String)
  OutOfBaseRange(
    index: Int,
    character: String,
    value: Int,
    base: Int,
  )
  InvalidExponentSymbolPosition(index: Int, character: String)
  UnknownCharacter(index: Int, character: String)
  InvalidBaseValue(base: Int)
  OutOfIntRange(integer_string: String)
  OutOfFloatRange(float_string: String)
}

Constructors

```
EmptyString
```
Represents an error when the input string is empty.
```
WhitespaceOnlyString
```
Represents an error when the input string contains only whitespace characters.
```
InvalidUnderscorePosition(index: Int)
```
Represents an error when an underscore is in an invalid position within the number string.
- index: The position of the invalid underscore in the input string.
```
InvalidDecimalPosition(index: Int)
```
Represents an error when a decimal point is in an invalid position within the number string.
- index: The position of the invalid decimal point in the input string.
```
InvalidSignPosition(index: Int, character: String)
```
Represents an error when a sign (+ or -) is in an invalid position within the number string.
- index: The position of the invalid sign in the input string.
- character: The sign character that caused the error as a String.
```
InvalidDigitPosition(index: Int, character: String)
```
Represents an error when a digit is in an invalid position within the number string.
- index: The position of the invalid digit in the input string.
- character: The digit character that caused the error as a String.
```
BasePrefixOnly(index_range: #(Int, Int), prefix: String)
```
Represents an error when the user specifies base = 0, but the input string only contains a base prefix (0b, 0o, 0x), and no value.
- index_range: The position range of the prefix in the input string.
- prefix: The base prefix as a String.
```
OutOfBaseRange(
  index: Int,
  character: String,
  value: Int,
  base: Int,
)
```
Represents an error when a digit character is out of the valid range for the specified base.
- index: The position of the out-of-range digit in the input string.
- character: The string representation of the out-of-range digit.
- value: The integer value of the out-of-range digit.
- base: The base in which the digit is out of range.
```
InvalidExponentSymbolPosition(index: Int, character: String)
```
Represents an error when an exponent symbol (e or E) is in an invalid position within the number string.
- index: The position of the invalid exponent symbol in the input string.
- character: The exponent symbol that caused the error as a String.
```
UnknownCharacter(index: Int, character: String)
```
Represents an error when an invalid character is encountered during parsing.
- index: The position of the invalid character in the input string.
- character: The invalid character as a String.
```
InvalidBaseValue(base: Int)
```
Represents an error when the base provided for parsing is invalid.
- base: The invalid base as an Int. The base must be between 2 and 36 inclusive.
```
OutOfIntRange(integer_string: String)
```
Represents an error when the parsed number is outside the safe integer range when ran on the JavaScript target.
- MDN: Number.MAX_SAFE_INTEGER
- MDN: Number.MIN_SAFE_INTEGER
This also implies that numbers that parse to Infinity and -Infinity, on the JavaScript target, will emit this error.

Note that Erlang’s max and min integer limits are not handled. This error is specific to the JavaScript target.
```
OutOfFloatRange(float_string: String)
```
Represents an error when the parsed number cannot be fit within the float type.