Functions
'join | I Joins zero or more strings together with a separator. |
codePointCompare | I Lexicographically compares strings using their Unicode code points. |
concat | I Concatenates zero or more strings. |
endsWith | I Tests whether a string ends with another string. |
equalsIgnoreCaseAscii | I Tests whether two strings are the same, ignoring the case of ASCII characters. |
fromBytes | I Constructs a string from its UTF-8 representation in bytes. |
fromCodePointInt | I Constructs a single character string from a code point. |
fromCodePointInts | I Constructs a string from an array of code points. |
getCodePoint | I Returns the code point of a character in a string. |
includes | I Tests whether a string includes another string. |
indexOf | I Finds the first occurrence of one string in another string. |
iterator | I Returns an iterator over the string. |
lastIndexOf | I Finds the last occurrence of one string in another string. |
length | I Returns the length of the string. |
startsWith | I Tests whether a string starts with another string. |
substring | I Returns a substring of a string. |
toBytes | I Represents a string as an array of bytes using UTF-8. |
toCodePointInt | I Converts a single character string to a code point. |
toCodePointInts | I Converts a string to an array of code points. |
toLowerAscii | I Converts occurrences of A-Z to a-z. |
toUpperAscii | I Converts occurrences of a-z to A-Z. |
trim | I Removes ASCII white space characters from the start and end of a string. |
'join
Joins zero or more strings together with a separator.
Return Type
(string)a string consisting of all of parameter strs
concatenated in order
with parameter separator
in between them
codePointCompare
Lexicographically compares strings using their Unicode code points.
This orders strings in a consistent and well-defined way, but the ordering will often not be consistent with cultural expectations for sorted order.
Return Type
(int)an int that is less than, equal to or greater than zero,
according as parameter str1
is less than, equal to or greater than parameter str2
concat
Concatenates zero or more strings.
Parameters
- strs string...
strings to be concatenated
Return Type
(string)concatenation of all of the parameter strs
; empty string if parameter strs
is empty
endsWith
Tests whether a string ends with another string.
equalsIgnoreCaseAscii
Tests whether two strings are the same, ignoring the case of ASCII characters.
A character in the range a-z is treated the same as the corresponding character in the range A-Z.
Return Type
(boolean)true if parameter str1
is the same as parameter str2
, treating upper-case and lower-case
ASCII letters as the same; false, otherwise
fromBytes
Constructs a string from its UTF-8 representation in bytes.
Parameters
- bytes byte[ ]
UTF-8 byte array
fromCodePointInt
Constructs a single character string from a code point.
An int is a valid code point if it is in the range 0 to 0x10FFFF inclusive, but not in the range 0xD800 or 0xDFFF inclusive.
Parameters
- codePoint int
an int specifying a code point
fromCodePointInts
Constructs a string from an array of code points.
An int is a valid code point if it is in the range 0 to 0x10FFFF inclusive, but not in the range 0xD800 or 0xDFFF inclusive.
Parameters
- codePoints int[ ]
an array of ints, each specifying a code point
getCodePoint
Returns the code point of a character in a string.
includes
Tests whether a string includes another string.
Parameters
- str string
the string in which to search
- substr string
the string to search for
- startIndex int (default 0)
index to start searching from
Return Type
(boolean)true
if there is an occurrence of parameter substr
in parameter str
at an index >= parameter startIndex
,
or false
otherwise
indexOf
Finds the first occurrence of one string in another string.
Parameters
- str string
the string in which to search
- substr string
the string to search for
- startIndex int (default 0)
index to start searching from
Return Type
(int?)index of the first occurrence of parameter substr
in parameter str
that is >= parameter startIndex
,
or ()
if there is no such occurrence
iterator
function iterator(string str) returns object {
public isolated function next() returns record {| Char value; |}?;
}
Returns an iterator over the string.
The iterator will yield the substrings of length 1 in order.
Parameters
- str string
the string to be iterated over
Return Type
(object { public isolated function next() returns record {| Char value; |}?; })a new iterator object
lastIndexOf
Finds the last occurrence of one string in another string.
Parameters
- str string
the string in which to search
- substr string
the string to search for
- startIndex int (default str.length() - substr.length())
index to start searching backwards from
Return Type
(int?)index of the last occurrence of parameter substr
in parameter str
that is <= parameter startIndex
,
or ()
if there is no such occurrence
startsWith
Tests whether a string starts with another string.
substring
Returns a substring of a string.
toBytes
function toBytes(string str) returns byte[ ]
Represents a string as an array of bytes using UTF-8.
Parameters
- str string
the string
Return Type
(byte[ ])UTF-8 byte array
toCodePointInt
Converts a single character string to a code point.
Parameters
- ch Char
a single character string
toCodePointInts
Converts a string to an array of code points.
Parameters
- str string
the string
toLowerAscii
Converts occurrences of A-Z to a-z.
Other characters are left unchanged.
Parameters
- str string
the string to be converted
toUpperAscii
Converts occurrences of a-z to A-Z.
Other characters are left unchanged.
Parameters
- str string
the string to be converted
trim
Removes ASCII white space characters from the start and end of a string.
The ASCII white space characters are 0x9...0xD, 0x20.
Parameters
- str string
the string