StringBuilder

Common
JS
1.0
class StringBuilder : Appendable, CharSequence
JVM
1.1
typealias StringBuilder = StringBuilder
Native
1.3
class StringBuilder : CharSequence, Appendable

Constructors

<init>

Common
JS
Native
1.0
<init>()
Common
JS
Native
1.0
<init>(capacity: Int)
Common
JS
Native
1.0
<init>(content: CharSequence)
JS
1.1
<init>(content: String = "")
Native
1.3
<init>(string: String)

Properties

Common
JS
Native
1.0

length

Returns the length of this character sequence.

val length: Int

Functions

append

Native
1.3
fun append(it: CharArray): StringBuilder
Native
1.3
fun append(it: String): StringBuilder
Native
1.3
fun append(it: Boolean): StringBuilder
Native
1.3
fun append(it: Byte): StringBuilder
Native
1.3
fun append(it: Short): StringBuilder
Native
1.3
fun append(it: Int): StringBuilder
Native
1.3
fun append(it: Long): StringBuilder
Native
1.3
fun append(it: Float): StringBuilder
Native
1.3
fun append(it: Double): StringBuilder
Common
JS
Native
1.0
fun append(c: Char): StringBuilder
Common
JS
Native
1.0
fun append(csq: CharSequence?): StringBuilder
Common
JS
Native
1.0
fun append(
    csq: CharSequence?,
    start: Int,
    end: Int
): StringBuilder
Common
JS
Native
1.0
fun append(obj: Any?): StringBuilder
JS
1.3

clear

Clears the content of this string builder making it empty.

fun clear(): StringBuilder
Native
1.3

deleteCharAt

fun deleteCharAt(index: Int)
Native
1.3

ensureCapacity

fun ensureCapacity(capacity: Int)

get

Returns the character at the specified index in this character sequence.

Common
1.0
operator fun get(index: Int): Char
JS
Native
1.1
fun get(index: Int): Char
Native
1.3

insert

fun insert(index: Int, c: Char): StringBuilder
fun insert(index: Int, csq: CharSequence?): StringBuilder
fun insert(
    index: Int,
    csq: CharSequence?,
    start: Int,
    end: Int
): StringBuilder
fun insert(index: Int, chars: CharArray): StringBuilder
fun insert(index: Int, string: String): StringBuilder
fun insert(index: Int, value: Boolean): StringBuilder
fun insert(index: Int, value: Byte): StringBuilder
fun insert(index: Int, value: Short): StringBuilder
fun insert(index: Int, value: Int): StringBuilder
fun insert(index: Int, value: Long): StringBuilder
fun insert(index: Int, value: Float): StringBuilder
fun insert(index: Int, value: Double): StringBuilder
fun insert(index: Int, value: Any?): StringBuilder
Common
JS
Native
1.0

reverse

fun reverse(): StringBuilder
Native
1.3

setCharAt

fun setCharAt(index: Int, value: Char)
Native
1.3

setLength

fun setLength(l: Int)
Common
JS
Native
1.0

subSequence

Returns a new character sequence that is a subsequence of this character sequence, starting at the specified startIndex and ending right before the specified endIndex.

fun subSequence(startIndex: Int, endIndex: Int): CharSequence
Native
1.3

substring

fun substring(startIndex: Int, endIndex: Int): String
JS
Native
1.1

toString

Returns a string representation of the object.

fun toString(): String
Native
1.3

trimToSize

fun trimToSize()

Extension Properties

Common
JVM
JS
Native
1.0

indices

Returns the range of valid character indices for this char sequence.

val CharSequence.indices: IntRange
Common
JVM
JS
Native
1.0

lastIndex

Returns the index of the last character in the char sequence or -1 if it is empty.

val CharSequence.lastIndex: Int

Extension Functions

Common
JVM
JS
Native
1.0

all

Returns true if all characters match the given predicate.

fun CharSequence.all(predicate: (Char) -> Boolean): Boolean
Common
JVM
JS
Native
1.0

any

Returns true if char sequence has at least one character.

fun CharSequence.any(): Boolean

Returns true if at least one character matches the given predicate.

fun CharSequence.any(predicate: (Char) -> Boolean): Boolean
Common
JVM
JS
Native
1.0

append

Appends all arguments to the given StringBuilder.

fun StringBuilder.append(
    vararg value: String?
): StringBuilder
fun StringBuilder.append(vararg value: Any?): StringBuilder

Appends all arguments to the given Appendable.

fun <T : Appendable> T.append(vararg value: CharSequence?): T
Native
1.3

appendln

fun StringBuilder.appendln(it: String): StringBuilder
fun StringBuilder.appendln(it: Boolean): StringBuilder
fun StringBuilder.appendln(it: Byte): StringBuilder
fun StringBuilder.appendln(it: Short): StringBuilder
fun StringBuilder.appendln(it: Int): StringBuilder
fun StringBuilder.appendln(it: Long): StringBuilder
fun StringBuilder.appendln(it: Float): StringBuilder
fun StringBuilder.appendln(it: Double): StringBuilder
fun StringBuilder.appendln(it: Any?): StringBuilder
Common
JVM
JS
Native
1.0

asIterable

Creates an Iterable instance that wraps the original char sequence returning its characters when being iterated.

fun CharSequence.asIterable(): Iterable<Char>
Common
JVM
JS
Native
1.0

asSequence

Creates a Sequence instance that wraps the original char sequence returning its characters when being iterated.

fun CharSequence.asSequence(): Sequence<Char>
Common
JVM
JS
Native
1.0

associate

Returns a Map containing key-value pairs provided by transform function applied to characters of the given char sequence.

fun <K, V> CharSequence.associate(
    transform: (Char) -> Pair<K, V>
): Map<K, V>
Common
JVM
JS
Native
1.0

associateBy

Returns a Map containing the characters from the given char sequence indexed by the key returned from keySelector function applied to each character.

fun <K> CharSequence.associateBy(
    keySelector: (Char) -> K
): Map<K, Char>

Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to characters of the given char sequence.

fun <K, V> CharSequence.associateBy(
    keySelector: (Char) -> K,
    valueTransform: (Char) -> V
): Map<K, V>
Common
JVM
JS
Native
1.0

associateByTo

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each character of the given char sequence and value is the character itself.

fun <K, M : MutableMap<in K, in Char>> CharSequence.associateByTo(
    destination: M,
    keySelector: (Char) -> K
): M

Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to characters of the given char sequence.

fun <K, V, M : MutableMap<in K, in V>> CharSequence.associateByTo(
    destination: M,
    keySelector: (Char) -> K,
    valueTransform: (Char) -> V
): M
Common
JVM
JS
Native
1.0

associateTo

Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each character of the given char sequence.

fun <K, V, M : MutableMap<in K, in V>> CharSequence.associateTo(
    destination: M,
    transform: (Char) -> Pair<K, V>
): M
Common
JVM
JS
Native
1.3

associateWith

Returns a Map where keys are characters from the given char sequence and values are produced by the valueSelector function applied to each character.

fun <V> CharSequence.associateWith(
    valueSelector: (Char) -> V
): Map<Char, V>
Common
JVM
JS
Native
1.3

associateWithTo

Populates and returns the destination mutable map with key-value pairs for each character of the given char sequence, where key is the character itself and value is provided by the valueSelector function applied to that key.

fun <V, M : MutableMap<in Char, in V>> CharSequence.associateWithTo(
    destination: M,
    valueSelector: (Char) -> V
): M
Common
JVM
JS
Native
1.2

chunked

Splits this char sequence into a list of strings each not exceeding the given size.

fun CharSequence.chunked(size: Int): List<String>

Splits this char sequence into several char sequences each not exceeding the given size and applies the given transform function to an each.

fun <R> CharSequence.chunked(
    size: Int,
    transform: (CharSequence) -> R
): List<R>
Common
JVM
JS
Native
1.2

chunkedSequence

Splits this char sequence into a sequence of strings each not exceeding the given size.

fun CharSequence.chunkedSequence(size: Int): Sequence<String>

Splits this char sequence into several char sequences each not exceeding the given size and applies the given transform function to an each.

fun <R> CharSequence.chunkedSequence(
    size: Int,
    transform: (CharSequence) -> R
): Sequence<R>
Common
JVM
JS
Native
1.0

commonPrefixWith

Returns the longest string prefix such that this char sequence and other char sequence both start with this prefix, taking care not to split surrogate pairs. If this and other have no common prefix, returns the empty string.

fun CharSequence.commonPrefixWith(
    other: CharSequence,
    ignoreCase: Boolean = false
): String
Common
JVM
JS
Native
1.0

commonSuffixWith

Returns the longest string suffix such that this char sequence and other char sequence both end with this suffix, taking care not to split surrogate pairs. If this and other have no common suffix, returns the empty string.

fun CharSequence.commonSuffixWith(
    other: CharSequence,
    ignoreCase: Boolean = false
): String
Common
JVM
JS
Native
1.0

contains

Returns true if this char sequence contains the specified other sequence of characters as a substring.

operator fun CharSequence.contains(
    other: CharSequence,
    ignoreCase: Boolean = false
): Boolean

Returns true if this char sequence contains the specified character char.

operator fun CharSequence.contains(
    char: Char,
    ignoreCase: Boolean = false
): Boolean

Returns true if this char sequence contains at least one match of the specified regular expression regex.

operator fun CharSequence.contains(regex: Regex): Boolean
Common
JVM
JS
Native
1.0

count

Returns the length of this char sequence.

fun CharSequence.count(): Int

Returns the number of characters matching the given predicate.

fun CharSequence.count(predicate: (Char) -> Boolean): Int
Common
JVM
JS
Native
1.0

drop

Returns a subsequence of this char sequence with the first n characters removed.

fun CharSequence.drop(n: Int): CharSequence
Common
JVM
JS
Native
1.0

dropLast

Returns a subsequence of this char sequence with the last n characters removed.

fun CharSequence.dropLast(n: Int): CharSequence
Common
JVM
JS
Native
1.0

dropLastWhile

Returns a subsequence of this char sequence containing all characters except last characters that satisfy the given predicate.

fun CharSequence.dropLastWhile(
    predicate: (Char) -> Boolean
): CharSequence
Common
JVM
JS
Native
1.0

dropWhile

Returns a subsequence of this char sequence containing all characters except first characters that satisfy the given predicate.

fun CharSequence.dropWhile(
    predicate: (Char) -> Boolean
): CharSequence
Common
JVM
JS
Native
1.0

elementAt

Returns a character at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this char sequence.

fun CharSequence.elementAt(index: Int): Char
Common
JVM
JS
Native
1.0

elementAtOrElse

Returns a character at the given index or the result of calling the defaultValue function if the index is out of bounds of this char sequence.

fun CharSequence.elementAtOrElse(
    index: Int,
    defaultValue: (Int) -> Char
): Char
Common
JVM
JS
Native
1.0

elementAtOrNull

Returns a character at the given index or null if the index is out of bounds of this char sequence.

fun CharSequence.elementAtOrNull(index: Int): Char?
Common
JVM
JS
Native
1.0

endsWith

Returns true if this char sequence ends with the specified character.

fun CharSequence.endsWith(
    char: Char,
    ignoreCase: Boolean = false
): Boolean

Returns true if this char sequence ends with the specified suffix.

fun CharSequence.endsWith(
    suffix: CharSequence,
    ignoreCase: Boolean = false
): Boolean
Common
JVM
JS
Native
1.0

filter

Returns a char sequence containing only those characters from the original char sequence that match the given predicate.

fun CharSequence.filter(
    predicate: (Char) -> Boolean
): CharSequence
Common
JVM
JS
Native
1.0

filterIndexed

Returns a char sequence containing only those characters from the original char sequence that match the given predicate.

fun CharSequence.filterIndexed(
    predicate: (index: Int, Char) -> Boolean
): CharSequence
Common
JVM
JS
Native
1.0

filterIndexedTo

Appends all characters matching the given predicate to the given destination.

fun <C : Appendable> CharSequence.filterIndexedTo(
    destination: C,
    predicate: (index: Int, Char) -> Boolean
): C
Common
JVM
JS
Native
1.0

filterNot

Returns a char sequence containing only those characters from the original char sequence that do not match the given predicate.

fun CharSequence.filterNot(
    predicate: (Char) -> Boolean
): CharSequence
Common
JVM
JS
Native
1.0

filterNotTo

Appends all characters not matching the given predicate to the given destination.

fun <C : Appendable> CharSequence.filterNotTo(
    destination: C,
    predicate: (Char) -> Boolean
): C
Common
JVM
JS
Native
1.0

filterTo

Appends all characters matching the given predicate to the given destination.

fun <C : Appendable> CharSequence.filterTo(
    destination: C,
    predicate: (Char) -> Boolean
): C
Common
JVM
JS
Native
1.0

find

Returns the first character matching the given predicate, or null if no such character was found.

fun CharSequence.find(predicate: (Char) -> Boolean): Char?
Common
JVM
JS
Native
1.0

findAnyOf

Finds the first occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.

fun CharSequence.findAnyOf(
    strings: Collection<String>,
    startIndex: Int = 0,
    ignoreCase: Boolean = false
): Pair<Int, String>?
Common
JVM
JS
Native
1.0

findLast

Returns the last character matching the given predicate, or null if no such character was found.

fun CharSequence.findLast(
    predicate: (Char) -> Boolean
): Char?
Common
JVM
JS
Native
1.0

findLastAnyOf

Finds the last occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.

fun CharSequence.findLastAnyOf(
    strings: Collection<String>,
    startIndex: Int = lastIndex,
    ignoreCase: Boolean = false
): Pair<Int, String>?
Common
JVM
JS
Native
1.0

first

Returns first character.

fun CharSequence.first(): Char

Returns the first character matching the given predicate.

fun CharSequence.first(predicate: (Char) -> Boolean): Char
Common
JVM
JS
Native
1.0

firstOrNull

Returns the first character, or null if the char sequence is empty.

fun CharSequence.firstOrNull(): Char?

Returns the first character matching the given predicate, or null if character was not found.

fun CharSequence.firstOrNull(
    predicate: (Char) -> Boolean
): Char?
Common
JVM
JS
Native
1.0

flatMap

Returns a single list of all elements yielded from results of transform function being invoked on each character of original char sequence.

fun <R> CharSequence.flatMap(
    transform: (Char) -> Iterable<R>
): List<R>
Common
JVM
JS
Native
1.0

flatMapTo

Appends all elements yielded from results of transform function being invoked on each character of original char sequence, to the given destination.

fun <R, C : MutableCollection<in R>> CharSequence.flatMapTo(
    destination: C,
    transform: (Char) -> Iterable<R>
): C
Common
JVM
JS
Native
1.0

fold

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each character.

fun <R> CharSequence.fold(
    initial: R,
    operation: (acc: R, Char) -> R
): R
Common
JVM
JS
Native
1.0

foldIndexed

Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each character with its index in the original char sequence.

fun <R> CharSequence.foldIndexed(
    initial: R,
    operation: (index: Int, acc: R, Char) -> R
): R
Common
JVM
JS
Native
1.0

foldRight

Accumulates value starting with initial value and applying operation from right to left to each character and current accumulator value.

fun <R> CharSequence.foldRight(
    initial: R,
    operation: (Char, acc: R) -> R
): R
Common
JVM
JS
Native
1.0

foldRightIndexed

Accumulates value starting with initial value and applying operation from right to left to each character with its index in the original char sequence and current accumulator value.

fun <R> CharSequence.foldRightIndexed(
    initial: R,
    operation: (index: Int, Char, acc: R) -> R
): R
Common
JVM
JS
Native
1.0

forEach

Performs the given action on each character.

fun CharSequence.forEach(action: (Char) -> Unit)
Common
JVM
JS
Native
1.0

forEachIndexed

Performs the given action on each character, providing sequential index with the character.

fun CharSequence.forEachIndexed(
    action: (index: Int, Char) -> Unit)
Common
JVM
JS
Native
1.0

getOrElse

Returns a character at the given index or the result of calling the defaultValue function if the index is out of bounds of this char sequence.

fun CharSequence.getOrElse(
    index: Int,
    defaultValue: (Int) -> Char
): Char
Common
JVM
JS
Native
1.0

getOrNull

Returns a character at the given index or null if the index is out of bounds of this char sequence.

fun CharSequence.getOrNull(index: Int): Char?
Common
JVM
JS
Native
1.0

groupBy

Groups characters of the original char sequence by the key returned by the given keySelector function applied to each character and returns a map where each group key is associated with a list of corresponding characters.

fun <K> CharSequence.groupBy(
    keySelector: (Char) -> K
): Map<K, List<Char>>

Groups values returned by the valueTransform function applied to each character of the original char sequence by the key returned by the given keySelector function applied to the character and returns a map where each group key is associated with a list of corresponding values.

fun <K, V> CharSequence.groupBy(
    keySelector: (Char) -> K,
    valueTransform: (Char) -> V
): Map<K, List<V>>
Common
JVM
JS
Native
1.0

groupByTo

Groups characters of the original char sequence by the key returned by the given keySelector function applied to each character and puts to the destination map each group key associated with a list of corresponding characters.

fun <K, M : MutableMap<in K, MutableList<Char>>> CharSequence.groupByTo(
    destination: M,
    keySelector: (Char) -> K
): M

Groups values returned by the valueTransform function applied to each character of the original char sequence by the key returned by the given keySelector function applied to the character and puts to the destination map each group key associated with a list of corresponding values.

fun <K, V, M : MutableMap<in K, MutableList<V>>> CharSequence.groupByTo(
    destination: M,
    keySelector: (Char) -> K,
    valueTransform: (Char) -> V
): M
Common
JVM
JS
Native
1.1

groupingBy

Creates a Grouping source from a char sequence to be used later with one of group-and-fold operations using the specified keySelector function to extract a key from each character.

fun <K> CharSequence.groupingBy(
    keySelector: (Char) -> K
): Grouping<Char, K>
Common
JVM
JS
Native
1.0

hasSurrogatePairAt

Returns true if this CharSequence has Unicode surrogate pair at the specified index.

fun CharSequence.hasSurrogatePairAt(index: Int): Boolean
Common
JVM
JS
Native
1.3

ifBlank

Returns this char sequence if it is not empty and doesn't consist solely of whitespace characters, or the result of calling defaultValue function otherwise.

fun <C, R> C.ifBlank(
    defaultValue: () -> R
): R where C : CharSequence, C : R
Common
JVM
JS
Native
1.3

ifEmpty

Returns this char sequence if it's not empty or the result of calling defaultValue function if the char sequence is empty.

fun <C, R> C.ifEmpty(
    defaultValue: () -> R
): R where C : CharSequence, C : R
Common
JVM
JS
Native
1.0

indexOf

Returns the index within this string of the first occurrence of the specified character, starting from the specified startIndex.

fun CharSequence.indexOf(
    char: Char,
    startIndex: Int = 0,
    ignoreCase: Boolean = false
): Int

Returns the index within this char sequence of the first occurrence of the specified string, starting from the specified startIndex.

fun CharSequence.indexOf(
    string: String,
    startIndex: Int = 0,
    ignoreCase: Boolean = false
): Int
Common
JVM
JS
Native
1.0

indexOfAny

Finds the index of the first occurrence of any of the specified chars in this char sequence, starting from the specified startIndex and optionally ignoring the case.

fun CharSequence.indexOfAny(
    chars: CharArray,
    startIndex: Int = 0,
    ignoreCase: Boolean = false
): Int

Finds the index of the first occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.

fun CharSequence.indexOfAny(
    strings: Collection<String>,
    startIndex: Int = 0,
    ignoreCase: Boolean = false
): Int
Common
JVM
JS
Native
1.0

indexOfFirst

Returns index of the first character matching the given predicate, or -1 if the char sequence does not contain such character.

fun CharSequence.indexOfFirst(
    predicate: (Char) -> Boolean
): Int
Common
JVM
JS
Native
1.0

indexOfLast

Returns index of the last character matching the given predicate, or -1 if the char sequence does not contain such character.

fun CharSequence.indexOfLast(
    predicate: (Char) -> Boolean
): Int
Common
JVM
JS
Native
1.0

isEmpty

Returns true if this char sequence is empty (contains no characters).

fun CharSequence.isEmpty(): Boolean
Common
JVM
JS
Native
1.0

isNotBlank

Returns true if this char sequence is not empty and contains some characters except of whitespace characters.

fun CharSequence.isNotBlank(): Boolean
Common
JVM
JS
Native
1.0

isNotEmpty

Returns true if this char sequence is not empty.

fun CharSequence.isNotEmpty(): Boolean
Common
JVM
JS
Native
1.0

isNullOrBlank

Returns true if this nullable char sequence is either null or empty or consists solely of whitespace characters.

fun CharSequence?.isNullOrBlank(): Boolean
Common
JVM
JS
Native
1.0

isNullOrEmpty

Returns true if this nullable char sequence is either null or empty.

fun CharSequence?.isNullOrEmpty(): Boolean
Common
JVM
JS
Native
1.0

iterator

Iterator for characters of the given char sequence.

operator fun CharSequence.iterator(): CharIterator
Common
JVM
JS
Native
1.0

last

Returns the last character.

fun CharSequence.last(): Char

Returns the last character matching the given predicate.

fun CharSequence.last(predicate: (Char) -> Boolean): Char
Common
JVM
JS
Native
1.0

lastIndexOf

Returns the index within this char sequence of the last occurrence of the specified character, starting from the specified startIndex.

fun CharSequence.lastIndexOf(
    char: Char,
    startIndex: Int = lastIndex,
    ignoreCase: Boolean = false
): Int

Returns the index within this char sequence of the last occurrence of the specified string, starting from the specified startIndex.

fun CharSequence.lastIndexOf(
    string: String,
    startIndex: Int = lastIndex,
    ignoreCase: Boolean = false
): Int
Common
JVM
JS
Native
1.0

lastIndexOfAny

Finds the index of the last occurrence of any of the specified chars in this char sequence, starting from the specified startIndex and optionally ignoring the case.

fun CharSequence.lastIndexOfAny(
    chars: CharArray,
    startIndex: Int = lastIndex,
    ignoreCase: Boolean = false
): Int

Finds the index of the last occurrence of any of the specified strings in this char sequence, starting from the specified startIndex and optionally ignoring the case.

fun CharSequence.lastIndexOfAny(
    strings: Collection<String>,
    startIndex: Int = lastIndex,
    ignoreCase: Boolean = false
): Int
Common
JVM
JS
Native
1.0

lastOrNull

Returns the last character, or null if the char sequence is empty.

fun CharSequence.lastOrNull(): Char?

Returns the last character matching the given predicate, or null if no such character was found.

fun CharSequence.lastOrNull(
    predicate: (Char) -> Boolean
): Char?
Common
JVM
JS
Native
1.0

lines

Splits this char sequence to a list of lines delimited by any of the following character sequences: CRLF, LF or CR.

fun CharSequence.lines(): List<String>
Common
JVM
JS
Native
1.0

lineSequence

Splits this char sequence to a sequence of lines delimited by any of the following character sequences: CRLF, LF or CR.

fun CharSequence.lineSequence(): Sequence<String>
Common
JVM
JS
Native
1.0

map

Returns a list containing the results of applying the given transform function to each character in the original char sequence.

fun <R> CharSequence.map(transform: (Char) -> R): List<R>
Common
JVM
JS
Native
1.0

mapIndexed

Returns a list containing the results of applying the given transform function to each character and its index in the original char sequence.

fun <R> CharSequence.mapIndexed(
    transform: (index: Int, Char) -> R
): List<R>
Common
JVM
JS
Native
1.0

mapIndexedNotNull

Returns a list containing only the non-null results of applying the given transform function to each character and its index in the original char sequence.

fun <R : Any> CharSequence.mapIndexedNotNull(
    transform: (index: Int, Char) -> R?
): List<R>
Common
JVM
JS
Native
1.0

mapIndexedNotNullTo

Applies the given transform function to each character and its index in the original char sequence and appends only the non-null results to the given destination.

fun <R : Any, C : MutableCollection<in R>> CharSequence.mapIndexedNotNullTo(
    destination: C,
    transform: (index: Int, Char) -> R?
): C
Common
JVM
JS
Native
1.0

mapIndexedTo

Applies the given transform function to each character and its index in the original char sequence and appends the results to the given destination.

fun <R, C : MutableCollection<in R>> CharSequence.mapIndexedTo(
    destination: C,
    transform: (index: Int, Char) -> R
): C
Common
JVM
JS
Native
1.0

mapNotNull

Returns a list containing only the non-null results of applying the given transform function to each character in the original char sequence.

fun <R : Any> CharSequence.mapNotNull(
    transform: (Char) -> R?
): List<R>
Common
JVM
JS
Native
1.0

mapNotNullTo

Applies the given transform function to each character in the original char sequence and appends only the non-null results to the given destination.

fun <R : Any, C : MutableCollection<in R>> CharSequence.mapNotNullTo(
    destination: C,
    transform: (Char) -> R?
): C
Common
JVM
JS
Native
1.0

mapTo

Applies the given transform function to each character of the original char sequence and appends the results to the given destination.

fun <R, C : MutableCollection<in R>> CharSequence.mapTo(
    destination: C,
    transform: (Char) -> R
): C
Common
JVM
JS
Native
1.0

matches

Returns true if this char sequence matches the given regular expression.

infix fun CharSequence.matches(regex: Regex): Boolean
Common
JVM
JS
Native
1.0

max

Returns the largest character or null if there are no characters.

fun CharSequence.max(): Char?
Common
JVM
JS
Native
1.0

maxBy

Returns the first character yielding the largest value of the given function or null if there are no characters.

fun <R : Comparable<R>> CharSequence.maxBy(
    selector: (Char) -> R
): Char?
Common
JVM
JS
Native
1.0

maxWith

Returns the first character having the largest value according to the provided comparator or null if there are no characters.

fun CharSequence.maxWith(
    comparator: Comparator<in Char>
): Char?
Common
JVM
JS
Native
1.0

min

Returns the smallest character or null if there are no characters.

fun CharSequence.min(): Char?
Common
JVM
JS
Native
1.0

minBy

Returns the first character yielding the smallest value of the given function or null if there are no characters.

fun <R : Comparable<R>> CharSequence.minBy(
    selector: (Char) -> R
): Char?
Common
JVM
JS
Native
1.0

minWith

Returns the first character having the smallest value according to the provided comparator or null if there are no characters.

fun CharSequence.minWith(
    comparator: Comparator<in Char>
): Char?
Common
JVM
JS
Native
1.0

none

Returns true if the char sequence has no characters.

fun CharSequence.none(): Boolean

Returns true if no characters match the given predicate.

fun CharSequence.none(predicate: (Char) -> Boolean): Boolean
Common
JVM
JS
Native
1.1

onEach

Performs the given action on each character and returns the char sequence itself afterwards.

fun <S : CharSequence> S.onEach(action: (Char) -> Unit): S
Common
JVM
JS
Native
1.0

padEnd

Returns a char sequence with content of this char sequence padded at the end to the specified length with the specified character or space.

fun CharSequence.padEnd(
    length: Int,
    padChar: Char = ' '
): CharSequence
Common
JVM
JS
Native
1.0

padStart

Returns a char sequence with content of this char sequence padded at the beginning to the specified length with the specified character or space.

fun CharSequence.padStart(
    length: Int,
    padChar: Char = ' '
): CharSequence
Common
JVM
JS
Native
1.0

partition

Splits the original char sequence into pair of char sequences, where first char sequence contains characters for which predicate yielded true, while second char sequence contains characters for which predicate yielded false.

fun CharSequence.partition(
    predicate: (Char) -> Boolean
): Pair<CharSequence, CharSequence>
Common
JVM
JS
Native
1.3

random

Returns a random character from this char sequence.

fun CharSequence.random(): Char

Returns a random character from this char sequence using the specified source of randomness.

fun CharSequence.random(random: Random): Char
Common
JVM
JS
Native
1.0

reduce

Accumulates value starting with the first character and applying operation from left to right to current accumulator value and each character.

fun CharSequence.reduce(
    operation: (acc: Char, Char) -> Char
): Char
Common
JVM
JS
Native
1.0

reduceIndexed

Accumulates value starting with the first character and applying operation from left to right to current accumulator value and each character with its index in the original char sequence.

fun CharSequence.reduceIndexed(
    operation: (index: Int, acc: Char, Char) -> Char
): Char
Common
JVM
JS
Native
1.0

reduceRight

Accumulates value starting with last character and applying operation from right to left to each character and current accumulator value.

fun CharSequence.reduceRight(
    operation: (Char, acc: Char) -> Char
): Char
Common
JVM
JS
Native
1.0

reduceRightIndexed

Accumulates value starting with last character and applying operation from right to left to each character with its index in the original char sequence and current accumulator value.

fun CharSequence.reduceRightIndexed(
    operation: (index: Int, Char, acc: Char) -> Char
): Char
Common
JVM
JS
Native
1.0

removePrefix

If this char sequence starts with the given prefix, returns a new char sequence with the prefix removed. Otherwise, returns a new char sequence with the same characters.

fun CharSequence.removePrefix(
    prefix: CharSequence
): CharSequence
Common
JVM
JS
Native
1.0

removeRange

Returns a char sequence with content of this char sequence where its part at the given range is removed.

fun CharSequence.removeRange(
    startIndex: Int,
    endIndex: Int
): CharSequence

Returns a char sequence with content of this char sequence where its part at the given range is removed.

fun CharSequence.removeRange(range: IntRange): CharSequence
Common
JVM
JS
Native
1.0

removeSuffix

If this char sequence ends with the given suffix, returns a new char sequence with the suffix removed. Otherwise, returns a new char sequence with the same characters.

fun CharSequence.removeSuffix(
    suffix: CharSequence
): CharSequence
Common
JVM
JS
Native
1.0

removeSurrounding

When this char sequence starts with the given prefix and ends with the given suffix, returns a new char sequence having both the given prefix and suffix removed. Otherwise returns a new char sequence with the same characters.

fun CharSequence.removeSurrounding(
    prefix: CharSequence,
    suffix: CharSequence
): CharSequence

When this char sequence starts with and ends with the given delimiter, returns a new char sequence having this delimiter removed both from the start and end. Otherwise returns a new char sequence with the same characters.

fun CharSequence.removeSurrounding(
    delimiter: CharSequence
): CharSequence
Common
JVM
JS
Native
1.0

replace

Returns a new string obtained by replacing each substring of this char sequence that matches the given regular expression with the given replacement.

fun CharSequence.replace(
    regex: Regex,
    replacement: String
): String

Returns a new string obtained by replacing each substring of this char sequence that matches the given regular expression with the result of the given function transform that takes MatchResult and returns a string to be used as a replacement for that match.

fun CharSequence.replace(
    regex: Regex,
    transform: (MatchResult) -> CharSequence
): String
Common
JVM
JS
Native
1.0

replaceFirst

Replaces the first occurrence of the given regular expression regex in this char sequence with specified replacement expression.

fun CharSequence.replaceFirst(
    regex: Regex,
    replacement: String
): String
Common
JVM
JS
Native
1.0

replaceRange

Returns a char sequence with content of this char sequence where its part at the given range is replaced with the replacement char sequence.

fun CharSequence.replaceRange(
    startIndex: Int,
    endIndex: Int,
    replacement: CharSequence
): CharSequence

Returns a char sequence with content of this char sequence where its part at the given range is replaced with the replacement char sequence.

fun CharSequence.replaceRange(
    range: IntRange,
    replacement: CharSequence
): CharSequence
Common
JVM
JS
Native
1.0

reversed

Returns a char sequence with characters in reversed order.

fun CharSequence.reversed(): CharSequence
Native
1.3

set

Sets the character at the specified index to the specified value.

operator fun StringBuilder.set(index: Int, value: Char)
Common
JVM
JS
Native
1.0

single

Returns the single character, or throws an exception if the char sequence is empty or has more than one character.

fun CharSequence.single(): Char

Returns the single character matching the given predicate, or throws exception if there is no or more than one matching character.

fun CharSequence.single(predicate: (Char) -> Boolean): Char
Common
JVM
JS
Native
1.0

singleOrNull

Returns single character, or null if the char sequence is empty or has more than one character.

fun CharSequence.singleOrNull(): Char?

Returns the single character matching the given predicate, or null if character was not found or more than one character was found.

fun CharSequence.singleOrNull(
    predicate: (Char) -> Boolean
): Char?
Common
JVM
JS
Native
1.0

slice

Returns a char sequence containing characters of the original char sequence at the specified range of indices.

fun CharSequence.slice(indices: IntRange): CharSequence

Returns a char sequence containing characters of the original char sequence at specified indices.

fun CharSequence.slice(indices: Iterable<Int>): CharSequence
Common
JVM
JS
Native
1.0

split

Splits this char sequence to a list of strings around occurrences of the specified delimiters.

fun CharSequence.split(
    vararg delimiters: String,
    ignoreCase: Boolean = false,
    limit: Int = 0
): List<String>
fun CharSequence.split(
    vararg delimiters: Char,
    ignoreCase: Boolean = false,
    limit: Int = 0
): List<String>

Splits this char sequence around matches of the given regular expression.

fun CharSequence.split(
    regex: Regex,
    limit: Int = 0
): List<String>
Common
JVM
JS
Native
1.0

splitToSequence

Splits this char sequence to a sequence of strings around occurrences of the specified delimiters.

fun CharSequence.splitToSequence(
    vararg delimiters: String,
    ignoreCase: Boolean = false,
    limit: Int = 0
): Sequence<String>
fun CharSequence.splitToSequence(
    vararg delimiters: Char,
    ignoreCase: Boolean = false,
    limit: Int = 0
): Sequence<String>
Common
JVM
JS
Native
1.0

startsWith

Returns true if this char sequence starts with the specified character.

fun CharSequence.startsWith(
    char: Char,
    ignoreCase: Boolean = false
): Boolean

Returns true if this char sequence starts with the specified prefix.

fun CharSequence.startsWith(
    prefix: CharSequence,
    ignoreCase: Boolean = false
): Boolean

Returns true if a substring of this char sequence starting at the specified offset startIndex starts with the specified prefix.

fun CharSequence.startsWith(
    prefix: CharSequence,
    startIndex: Int,
    ignoreCase: Boolean = false
): Boolean
Common
JVM
JS
Native
1.0

subSequence

Returns a subsequence of this char sequence specified by the given range of indices.

fun CharSequence.subSequence(range: IntRange): CharSequence
Common
JVM
JS
Native
1.0

substring

Returns a substring of chars from a range of this char sequence starting at the startIndex and ending right before the endIndex.

fun CharSequence.substring(
    startIndex: Int,
    endIndex: Int = length
): String

Returns a substring of chars at indices from the specified range of this char sequence.

fun CharSequence.substring(range: IntRange): String
Common
JVM
JS
Native
1.0

sumBy

Returns the sum of all values produced by selector function applied to each character in the char sequence.

fun CharSequence.sumBy(selector: (Char) -> Int): Int
Common
JVM
JS
Native
1.0

sumByDouble

Returns the sum of all values produced by selector function applied to each character in the char sequence.

fun CharSequence.sumByDouble(
    selector: (Char) -> Double
): Double
Common
JVM
JS
Native
1.0

take

Returns a subsequence of this char sequence containing the first n characters from this char sequence, or the entire char sequence if this char sequence is shorter.

fun CharSequence.take(n: Int): CharSequence
Common
JVM
JS
Native
1.0

takeLast

Returns a subsequence of this char sequence containing the last n characters from this char sequence, or the entire char sequence if this char sequence is shorter.

fun CharSequence.takeLast(n: Int): CharSequence
Common
JVM
JS
Native
1.0

takeLastWhile

Returns a subsequence of this char sequence containing last characters that satisfy the given predicate.

fun CharSequence.takeLastWhile(
    predicate: (Char) -> Boolean
): CharSequence
Common
JVM
JS
Native
1.0

takeWhile

Returns a subsequence of this char sequence containing the first characters that satisfy the given predicate.

fun CharSequence.takeWhile(
    predicate: (Char) -> Boolean
): CharSequence
Common
JVM
JS
Native
1.0

toCollection

Appends all characters to the given destination collection.

fun <C : MutableCollection<in Char>> CharSequence.toCollection(
    destination: C
): C
Common
JVM
JS
Native
1.0

toHashSet

Returns a HashSet of all characters.

fun CharSequence.toHashSet(): HashSet<Char>
Common
JVM
JS
Native
1.0

toList

Returns a List containing all characters.

fun CharSequence.toList(): List<Char>
Common
JVM
JS
Native
1.0

toMutableList

Returns a MutableList filled with all characters of this char sequence.

fun CharSequence.toMutableList(): MutableList<Char>
Common
JVM
JS
Native
1.0

toSet

Returns a Set of all characters.

fun CharSequence.toSet(): Set<Char>
Common
JVM
JS
Native
1.0

trim

Returns a sub sequence of this char sequence having leading and trailing characters matching the predicate removed.

fun CharSequence.trim(
    predicate: (Char) -> Boolean
): CharSequence

Returns a sub sequence of this char sequence having leading and trailing characters from the chars array removed.

fun CharSequence.trim(vararg chars: Char): CharSequence

Returns a sub sequence of this char sequence having leading and trailing whitespace removed.

Common
JVM
JS
Native
1.0

trimEnd

Returns a sub sequence of this char sequence having trailing characters matching the predicate removed.

fun CharSequence.trimEnd(
    predicate: (Char) -> Boolean
): CharSequence

Returns a sub sequence of this char sequence having trailing characters from the chars array removed.

fun CharSequence.trimEnd(vararg chars: Char): CharSequence

Returns a sub sequence of this char sequence having trailing whitespace removed.

fun CharSequence.trimEnd(): CharSequence
Common
JVM
JS
Native
1.0

trimStart

Returns a sub sequence of this char sequence having leading characters matching the predicate removed.

fun CharSequence.trimStart(
    predicate: (Char) -> Boolean
): CharSequence

Returns a sub sequence of this char sequence having leading characters from the chars array removed.

fun CharSequence.trimStart(vararg chars: Char): CharSequence

Returns a sub sequence of this char sequence having leading whitespace removed.

fun CharSequence.trimStart(): CharSequence
Common
JVM
JS
Native
1.2

windowed

Returns a list of snapshots of the window of the given size sliding along this char sequence with the given step, where each snapshot is a string.

fun CharSequence.windowed(
    size: Int,
    step: Int = 1,
    partialWindows: Boolean = false
): List<String>

Returns a list of results of applying the given transform function to an each char sequence representing a view over the window of the given size sliding along this char sequence with the given step.

fun <R> CharSequence.windowed(
    size: Int,
    step: Int = 1,
    partialWindows: Boolean = false,
    transform: (CharSequence) -> R
): List<R>
Common
JVM
JS
Native
1.2

windowedSequence

Returns a sequence of snapshots of the window of the given size sliding along this char sequence with the given step, where each snapshot is a string.

fun CharSequence.windowedSequence(
    size: Int,
    step: Int = 1,
    partialWindows: Boolean = false
): Sequence<String>

Returns a sequence of results of applying the given transform function to an each char sequence representing a view over the window of the given size sliding along this char sequence with the given step.

fun <R> CharSequence.windowedSequence(
    size: Int,
    step: Int = 1,
    partialWindows: Boolean = false,
    transform: (CharSequence) -> R
): Sequence<R>
Common
JVM
JS
Native
1.0

withIndex

Returns a lazy Iterable of IndexedValue for each character of the original char sequence.

fun CharSequence.withIndex(): Iterable<IndexedValue<Char>>
Common
JVM
JS
Native
1.0

zip

Returns a list of pairs built from the characters of this and the other char sequences with the same index The returned list has length of the shortest char sequence.

infix fun CharSequence.zip(
    other: CharSequence
): List<Pair<Char, Char>>

Returns a list of values built from the characters of this and the other char sequences with the same index using the provided transform function applied to each pair of characters. The returned list has length of the shortest char sequence.

fun <V> CharSequence.zip(
    other: CharSequence,
    transform: (a: Char, b: Char) -> V
): List<V>
Common
JVM
JS
Native
1.2

zipWithNext

Returns a list of pairs of each two adjacent characters in this char sequence.

fun CharSequence.zipWithNext(): List<Pair<Char, Char>>

Returns a list containing the results of applying the given transform function to an each pair of two adjacent characters in this char sequence.

fun <R> CharSequence.zipWithNext(
    transform: (a: Char, b: Char) -> R
): List<R>