ballerina/lang.string

function 'join(string separator, string... strs) returns string

Joins zero or more strings together with a separator.

function codePointCompare(string str1, string str2) returns int

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.

function concat(string... strs) returns string

Concatenates zero or more strings.

function endsWith(string str, string substr) returns boolean

Tests whether a string ends with another string.

function equalsIgnoreCaseAscii(string str1, string str2) returns boolean

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.

function fromBytes(byte[] bytes) returns string|error

Constructs a string from its UTF-8 representation in bytes.

function fromCodePointInt(int codePoint) returns Char|error

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.

function fromCodePointInts(int[] codePoints) returns string|error

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.

function getCodePoint(string str, int index) returns int

Returns the code point of a character in a string.

function includes(string str, string substr, int startIndex) returns boolean

Tests whether a string includes another string.

function includesMatch(string str, RegExp re, int startIndex) returns boolean

Tests whether there is a match of a regular expression somewhere within a string. This is equivalent to regexp:find(re, str, startIndex) != ().

function indexOf(string str, string substr, int startIndex) returns int?

Finds the first occurrence of one string in another string.

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.

function lastIndexOf(string str, string substr, int startIndex) returns int?

Finds the last occurrence of one string in another string.

function length(string str) returns int

Returns the length of the string.

function matches(string str, RegExp re) returns boolean

Tests whether there is a full match of a regular expression with a string. A match of a regular expression in a string is a full match if it starts at index 0 and ends at index n, where n is the length of the string. This is equivalent to regex:isFullMatch(re, str).

function padEnd(string str, int len, Char padChar) returns string

Adds padding to the end of a string. Adds sufficient padChar characters to the end of str to make its length be len. If the length of str is >= len, returns str.

function padStart(string str, int len, Char padChar) returns string

Adds padding to the start of a string. Adds sufficient padChar characters at the start of str to make its length be len. If the length of str is >= len, returns str.

function padZero(string str, int len, Char zeroChar) returns string

Pads a string with zeros. The zeros are added at the start of the string, after a + or - sign if there is one. Sufficient zero characters are added to str to make its length be len. If the length of str is >= len, returns str.

function startsWith(string str, string substr) returns boolean

Tests whether a string starts with another string.

function substring(string str, int startIndex, int endIndex) returns string

Returns a substring of a string.

function toBytes(string str) returns byte[]

Represents a string as an array of bytes using UTF-8.

function toCodePointInt(Char ch) returns int

Converts a single character string to a code point.

function toCodePointInts(string str) returns int[]

Converts a string to an array of code points.

function toLowerAscii(string str) returns string

Converts occurrences of A-Z to a-z.

Other characters are left unchanged.

function toUpperAscii(string str) returns string

Converts occurrences of a-z to A-Z.

Other characters are left unchanged.

function trim(string str) returns string

Removes ASCII white space characters from the start and end of a string.

The ASCII white space characters are 0x9...0xD, 0x20.