Char

Utilities for working with the Char type.

The Char type represents a single Unicode scalar value.

1

from "char" include Char

1

'a'

1

'1'

1

'🌾'

Types

Type declarations included in the Char module.

Char.Encoding

1
2
3
4
5

enum Encoding {
  UTF8,
  UTF16,
  UTF32,
}

Byte encodings

Values

Functions and constants included in the Char module.

Char.min

1

min: Number

The minimum valid Unicode scalar value.

Char.max

1

max: Number

The maximum valid Unicode scalar value.

Char.isValid

1

isValid: (charCode: Number) => Bool

Determines whether the given character code is a valid Unicode scalar value.

Parameters:

Returns:

Examples:

1

Char.isValid(0) == true

1

Char.isValid(-1) == false

Char.code

1

code: (char: Char) => Number

Determines the Unicode scalar value for a character.

Parameters:

Returns:

Examples:

1

Char.code('a') == 97

1

Char.code('🌾') == 127806

Char.fromCode

1

fromCode: (usv: Number) => Char

Creates a character from the given Unicode scalar value.

Parameters:

Returns:

Throws:

InvalidArgument(String)

• When the Unicode scalar value is invalid

Examples:

1

Char.fromCode(97) == 'a'

1

Char.fromCode(127806) == '🌾'

Char.succ

1

succ: (char: Char) => Char

Returns the next valid character by Unicode scalar value.

Parameters:

Returns:

Throws:

Failure(String)

• When the input character is the maximum valid Unicode scalar value

Examples:

1

Char.succ('a') == 'b'

1

Char.succ('1') == '2'

Char.pred

1

pred: (char: Char) => Char

Returns the previous valid character by Unicode scalar value.

Parameters:

Returns:

Throws:

Failure(String)

• When the input character is the minimum valid Unicode scalar value

Examples:

1

Char.pred('b') == 'a'

1

Char.pred('2') == '1'

Char.toString

1

toString: (char: Char) => String

Converts the given character to a string.

Parameters:

Returns:

Examples:

1

Char.toString('a') == "a"

1

Char.toString('🌾') == "🌾"

Char.encodedLength

1

encodedLength: (encoding: Encoding, char: Char) => Number

Returns the byte count of a character if encoded in the given encoding.

Parameters:

Returns:

Examples:

1

Char.encodedLength(Char.UTF8, 'a') == 1

1

Char.encodedLength(Char.UTF8, '🌾') == 4

1

Char.encodedLength(Char.UTF16, '©') == 1

Char.(<)

1

(<): (x: Char, y: Char) => Bool

Checks if the first character is less than the second character by Unicode scalar value.

Parameters:

Returns:

Examples:

1
2

use Char.{ (<) }
assert 'a' < 'b'

1
2

use Char.{ (<) }
assert '1' < '2'

Char.(<=)

1

(<=): (x: Char, y: Char) => Bool

Checks if the first character is less than or equal to the second character by Unicode scalar value.

Parameters:

Returns:

Examples:

1
2

use Char.{ (<=) }
assert 'a' <= 'b'

1
2

use Char.{ (<=) }
assert '1' <= '2'

1
2

use Char.{ (<=) }
assert 'a' <= 'a'

Char.(>)

1

(>): (x: Char, y: Char) => Bool

Checks if the first character is greater than the second character by Unicode scalar value.

Parameters:

Returns:

Examples:

1
2

use Char.{ (>) }
assert 'b' > 'a'

1
2

use Char.{ (>) }
assert '2' > '1'

Char.(>=)

1

(>=): (x: Char, y: Char) => Bool

Checks if the first character is greater than or equal to the second character by Unicode scalar value.

Parameters:

Returns:

Examples:

1
2

use Char.{ (>=) }
assert 'b' >= 'a'

1
2

use Char.{ (>=) }
assert '2' >= '1'

1
2

use Char.{ (>=) }
assert 'a' >= 'a'

Char.Ascii

Utilities for working with ASCII characters.

1

Char.Ascii.isAscii('1')

Values

Functions and constants included in the Char.Ascii module.

Char.Ascii.min

1

min: Number

The minimum valid ASCII character code.

Char.Ascii.max

1

max: Number

The maximum valid ASCII character code.

Char.Ascii.isValid

1

isValid: (char: Char) => Bool

Checks if the character is a valid ASCII character.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.isValid('1')

1

assert Char.Ascii.isValid('a')

1

assert !Char.Ascii.isValid('🌾')

Char.Ascii.isDigit

1

isDigit: (char: Char) => Bool

Checks if the character is an ASCII digit.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.isDigit('1')

1

assert !Char.Ascii.isDigit('a')

Char.Ascii.isAlpha

1

isAlpha: (char: Char) => Bool

Checks if the character is an ASCII alphabetical character.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.isAlpha('a')

1

assert !Char.Ascii.isAlpha('1')

Char.Ascii.isControl

1

isControl: (char: Char) => Bool

Checks if the character is an ASCII control character.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.isControl('\t')

1

assert Char.Ascii.isControl('\n')

1

assert !Char.Ascii.isControl('1')

1

assert !Char.Ascii.isControl('a')

Char.Ascii.isWhitespace

1

isWhitespace: (char: Char) => Bool

Checks if the character is an ASCII whitespace character.

Parameters:

Returns:

Examples:

1

assert Char.isWhitespace('\t')

1

assert Char.isWhitespace('\n')

1

assert !Char.isWhitespace('1')

1

assert !Char.isWhitespace('a')

Char.Ascii.isPunctuation

1

isPunctuation: (char: Char) => Bool

Checks if the character is an ASCII punctuation character.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.isPunctuation('!')

1

assert !Char.Ascii.isPunctuation('1')

Char.Ascii.isGraphic

1

isGraphic: (char: Char) => Bool

Checks if the character is an ASCII graphic character.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.isGraphic('!')

1

assert !Char.Ascii.isGraphic('\t')

Char.Ascii.toLowercase

1

toLowercase: (char: Char) => Char

Converts the character to ASCII lowercase if it is an ASCII uppercase character.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.toLowercase('B') == 'b'

Char.Ascii.toUppercase

1

toUppercase: (char: Char) => Char

Converts the character to ASCII uppercase if it is an ASCII lowercase character.

Parameters:

Returns:

Examples:

1

assert Char.Ascii.toUppercase('b') == 'B'