## Module overview

The `lang.string` module corresponds to the `string` basic type.


Joins zero or more strings together with a separator.



'join

separator

string

strs

a string consisting of all of parameter `strs` concatenated in order
with parameter `separator` in between them


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.



codePointCompare

str1

str2

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

concatenation of all of the parameter `strs`; empty string if parameter `strs` is empty


Tests whether a string ends with another string.



endsWith

substr

true if parameter `str` ends with parameter `substr`; false otherwise


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.



equalsIgnoreCaseAscii

true if parameter `str1` is the same as parameter `str2`, treating upper-case and lower-case
ASCII letters as the same; false, otherwise


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



fromBytes

bytes

byte

parameter `bytes` converted to string or error


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.



fromCodePointInt

codePoint

a single character string whose code point is parameter `codePoint`; or an error
if parameter `codePoint` is not a valid code point


Char

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.



fromCodePointInts

an array of ints, each specifying a code point


codePoints

a string with a character for each code point in parameter `codePoints`; or an error
if any member of parameter `codePoints` is not a valid code point


Returns the code point of a character in a string.



getCodePoint

index

the Unicode code point of the character at parameter `index` in parameter `str`


Tests whether a string includes another string.



includes

startIndex

`true` if there is an occurrence of parameter `substr` in parameter `str` at an index >= parameter `startIndex`,
or `false` otherwise


Finds the first occurrence of one string in another string.



indexOf

index of the first occurrence of parameter `substr` in parameter `str` that is >= parameter `startIndex`,
or `()` if there is no such occurrence


Returns an iterator over the string.

The iterator will yield the substrings of length 1 in order.



iterator

object {
    public isolated function next() returns record {| Char value; |}?;
}

Finds the last occurrence of one string in another string.



lastIndexOf

index of the last occurrence of parameter `substr` in parameter `str` that is <= parameter `startIndex`,
or `()` if there is no such occurrence


length

the number of characters (code points) in parameter `str`


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`.



padEnd

the character to use for padding `str`; defaults to a space character


padChar

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`.



padStart

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`.



padZero

the character to use for the zero; defaults to ASCII zero `0`


zeroChar

Tests whether a string starts with another string.



startsWith

true if parameter `str` starts with parameter `substr`; false otherwise


substring

endIndex

substring consisting of characters with index >= `startIndex` and < `endIndex`


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



toBytes

Converts a single character string to a code point.



toCodePointInt

Converts a string to an array of code points.



toCodePointInts

an array with a code point for each character of parameter `str`


Converts occurrences of A-Z to a-z.

Other characters are left unchanged.



toLowerAscii

parameter `str` with any occurrences of A-Z converted to a-z


Converts occurrences of a-z to A-Z.

Other characters are left unchanged.



toUpperAscii

parameter `str` with any occurrences of a-z converted to A-Z


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

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



trim

parameter `str` with leading or trailing ASCII white space characters removed


The `lang.string` module corresponds to the `string` basic type.


Built-in subtype of string containing strings of length 1.


ballerina/lang.string : 0.0.0

Module overview

Functions

Types