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.

Since Kotlin 1.0

inline fun <K, V, M : MutableMap<in K, in V>> CharSequence.associateByTo(destination: M, keySelector: (Char) -> K, valueTransform: (Char) -> V): 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.

Since Kotlin 1.0

associateTo

inline fun <K, V, M : MutableMap<in K, in V>> CharSequence.associateTo(destination: M, transform: (Char) -> Pair<K, V>): M

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

Since Kotlin 1.0

associateWith

inline fun <V> CharSequence.associateWith(valueSelector: (Char) -> V): Map<Char, V>

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

Since Kotlin 1.3

associateWithTo

inline fun <V, M : MutableMap<in Char, in V>> CharSequence.associateWithTo(destination: M, valueSelector: (Char) -> V): M

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.

Since Kotlin 1.3

chunked

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

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

Since Kotlin 1.2

fun <R> CharSequence.chunked(size: Int, transform: (CharSequence) -> R): List<R>

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

Since Kotlin 1.2

chunkedSequence

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

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

Since Kotlin 1.2

fun <R> CharSequence.chunkedSequence(size: Int, transform: (CharSequence) -> R): Sequence<R>

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

Since Kotlin 1.2

commonPrefixWith

fun CharSequence.commonPrefixWith(other: CharSequence, ignoreCase: Boolean = false): String

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.

Since Kotlin 1.0

commonSuffixWith

fun CharSequence.commonSuffixWith(other: CharSequence, ignoreCase: Boolean = false): String

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.

Since Kotlin 1.0

contains

inline operator fun CharSequence.contains(regex: Regex): Boolean

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

contentEquals

expect infix fun CharSequence?.contentEquals(other: CharSequence?): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, i.e. both char sequences contain the same number of the same characters in the same order.

Since Kotlin 1.5

expect fun CharSequence?.contentEquals(other: CharSequence?, ignoreCase: Boolean): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, optionally ignoring case difference.

Since Kotlin 1.5

actual infix fun CharSequence?.contentEquals(other: CharSequence?): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, i.e. both char sequences contain the same number of the same characters in the same order.

Since Kotlin 1.5

actual fun CharSequence?.contentEquals(other: CharSequence?, ignoreCase: Boolean): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, optionally ignoring case difference.

Since Kotlin 1.5

actual infix fun CharSequence?.contentEquals(other: CharSequence?): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, i.e. both char sequences contain the same number of the same characters in the same order.

Since Kotlin 1.5

actual fun CharSequence?.contentEquals(other: CharSequence?, ignoreCase: Boolean): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, optionally ignoring case difference.

Since Kotlin 1.5

actual infix fun CharSequence?.contentEquals(other: CharSequence?): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, i.e. both char sequences contain the same number of the same characters in the same order.

Since Kotlin 1.5

actual fun CharSequence?.contentEquals(other: CharSequence?, ignoreCase: Boolean): Boolean

Returns true if the contents of this char sequence are equal to the contents of the specified other, optionally ignoring case difference.

Since Kotlin 1.5

count

inline fun CharSequence.count(): Int

Returns the length of this char sequence.

Since Kotlin 1.0

inline fun CharSequence.count(predicate: (Char) -> Boolean): Int

Returns the number of characters matching the given predicate.

Since Kotlin 1.0

drop

fun CharSequence.drop(n: Int): CharSequence

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

Since Kotlin 1.0

dropLast

fun CharSequence.dropLast(n: Int): CharSequence

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

Since Kotlin 1.0

dropLastWhile

inline fun CharSequence.dropLastWhile(predicate: (Char) -> Boolean): CharSequence

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

Since Kotlin 1.0

dropWhile

inline fun CharSequence.dropWhile(predicate: (Char) -> Boolean): CharSequence

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

Since Kotlin 1.0

elementAt

expect fun CharSequence.elementAt(index: Int): Char

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

Since Kotlin 1.0

actual fun CharSequence.elementAt(index: Int): Char

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

Since Kotlin 1.1

actual inline fun CharSequence.elementAt(index: Int): Char

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

Since Kotlin 1.0

actual inline fun CharSequence.elementAt(index: Int): Char

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

Since Kotlin 1.3

elementAtOrElse

inline fun CharSequence.elementAtOrElse(index: Int, defaultValue: (Int) -> Char): Char

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.

Since Kotlin 1.0

elementAtOrNull

inline fun CharSequence.elementAtOrNull(index: Int): Char?

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

Since Kotlin 1.0

endsWith

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

filter

inline fun CharSequence.filter(predicate: (Char) -> Boolean): CharSequence

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

Since Kotlin 1.0

filterIndexed

inline fun CharSequence.filterIndexed(predicate: (index: Int, Char) -> Boolean): CharSequence

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

Since Kotlin 1.0

filterIndexedTo

inline fun <C : Appendable> CharSequence.filterIndexedTo(destination: C, predicate: (index: Int, Char) -> Boolean): C

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

Since Kotlin 1.0

filterNot

inline fun CharSequence.filterNot(predicate: (Char) -> Boolean): CharSequence

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

Since Kotlin 1.0

filterNotTo

inline fun <C : Appendable> CharSequence.filterNotTo(destination: C, predicate: (Char) -> Boolean): C

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

Since Kotlin 1.0

filterTo

inline fun <C : Appendable> CharSequence.filterTo(destination: C, predicate: (Char) -> Boolean): C

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

Since Kotlin 1.0

find

inline fun CharSequence.find(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0

findAnyOf

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

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

Since Kotlin 1.0

findLast

inline fun CharSequence.findLast(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0

findLastAnyOf

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

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

Since Kotlin 1.0

first

fun CharSequence.first(): Char

Returns first character.

Since Kotlin 1.0

inline fun CharSequence.first(predicate: (Char) -> Boolean): Char

Returns the first character matching the given predicate.

Since Kotlin 1.0

firstNotNullOf

inline fun <R : Any> CharSequence.firstNotNullOf(transform: (Char) -> R?): R

Returns the first non-null value produced by transform function being applied to characters of this char sequence in iteration order, or throws NoSuchElementException if no non-null value was produced.

Since Kotlin 1.5

firstNotNullOfOrNull

inline fun <R : Any> CharSequence.firstNotNullOfOrNull(transform: (Char) -> R?): R?

Returns the first non-null value produced by transform function being applied to characters of this char sequence in iteration order, or null if no non-null value was produced.

Since Kotlin 1.5

firstOrNull

fun CharSequence.firstOrNull(): Char?

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

Since Kotlin 1.0

inline fun CharSequence.firstOrNull(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0

flatMap

inline fun <R> CharSequence.flatMap(transform: (Char) -> Iterable<R>): List<R>

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

Since Kotlin 1.0

flatMapIndexed

@JvmName(name = "flatMapIndexedIterable")

inline fun <R> CharSequence.flatMapIndexed(transform: (index: Int, Char) -> Iterable<R>): List<R>

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

Since Kotlin 1.4

flatMapIndexedTo

@JvmName(name = "flatMapIndexedIterableTo")

inline fun <R, C : MutableCollection<in R>> CharSequence.flatMapIndexedTo(destination: C, transform: (index: Int, Char) -> Iterable<R>): C

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

Since Kotlin 1.4

flatMapTo

inline fun <R, C : MutableCollection<in R>> CharSequence.flatMapTo(destination: C, transform: (Char) -> Iterable<R>): C

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

Since Kotlin 1.0

fold

inline fun <R> CharSequence.fold(initial: R, operation: (acc: R, Char) -> R): R

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

Since Kotlin 1.0

foldIndexed

inline fun <R> CharSequence.foldIndexed(initial: R, operation: (index: Int, acc: R, Char) -> R): R

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.

Since Kotlin 1.0

foldRight

inline fun <R> CharSequence.foldRight(initial: R, operation: (Char, acc: R) -> R): R

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

Since Kotlin 1.0

foldRightIndexed

inline fun <R> CharSequence.foldRightIndexed(initial: R, operation: (index: Int, Char, acc: R) -> R): R

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.

Since Kotlin 1.0

forEach

inline fun CharSequence.forEach(action: (Char) -> Unit)

Performs the given action on each character.

Since Kotlin 1.0

forEachIndexed

inline fun CharSequence.forEachIndexed(action: (index: Int, Char) -> Unit)

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

Since Kotlin 1.0

get

abstract operator fun get(index: Int): Char

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

Since Kotlin 1.0

abstract operator fun get(index: Int): Char

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

Since Kotlin 1.3

getOrElse

inline fun CharSequence.getOrElse(index: Int, defaultValue: (Int) -> Char): Char

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.

Since Kotlin 1.0

getOrNull

fun CharSequence.getOrNull(index: Int): Char?

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

Since Kotlin 1.0

groupBy

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

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.

Since Kotlin 1.0

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

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.

Since Kotlin 1.0

groupByTo

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

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.

Since Kotlin 1.0

inline fun <K, V, M : MutableMap<in K, MutableList<V>>> CharSequence.groupByTo(destination: M, keySelector: (Char) -> K, valueTransform: (Char) -> V): 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.

Since Kotlin 1.0

groupingBy

inline fun <K> CharSequence.groupingBy(crossinline keySelector: (Char) -> K): Grouping<Char, K>

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.

Since Kotlin 1.1

hasSurrogatePairAt

fun CharSequence.hasSurrogatePairAt(index: Int): Boolean

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

Since Kotlin 1.0

indexOf

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

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

Since Kotlin 1.0

fun CharSequence.indexOf(string: String, 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.

Since Kotlin 1.0

indexOfAny

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

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.

Since Kotlin 1.0

fun CharSequence.indexOfAny(strings: Collection<String>, 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.

Since Kotlin 1.0

indexOfFirst

inline fun CharSequence.indexOfFirst(predicate: (Char) -> Boolean): Int

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

Since Kotlin 1.0

indexOfLast

inline fun CharSequence.indexOfLast(predicate: (Char) -> Boolean): Int

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

Since Kotlin 1.0

isBlank

expect fun CharSequence.isBlank(): Boolean

Since Kotlin 1.0

actual fun CharSequence.isBlank(): Boolean

Returns true if this string is empty or consists solely of whitespace characters.

Since Kotlin 1.1

actual fun CharSequence.isBlank(): Boolean

Returns true if this string is empty or consists solely of whitespace characters.

Since Kotlin 1.0

actual fun CharSequence.isBlank(): Boolean

Returns true if this string is empty or consists solely of whitespace characters.

Since Kotlin 1.3

isEmpty

inline fun CharSequence.isEmpty(): Boolean

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

Since Kotlin 1.0

isNotBlank

inline fun CharSequence.isNotBlank(): Boolean

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

Since Kotlin 1.0

isNotEmpty

inline fun CharSequence.isNotEmpty(): Boolean

Returns true if this char sequence is not empty.

Since Kotlin 1.0

isNullOrBlank

inline fun CharSequence?.isNullOrBlank(): Boolean

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

Since Kotlin 1.0

isNullOrEmpty

inline fun CharSequence?.isNullOrEmpty(): Boolean

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

Since Kotlin 1.0

iterator

operator fun CharSequence.iterator(): CharIterator

Iterator for characters of the given char sequence.

Since Kotlin 1.0

last

fun CharSequence.last(): Char

Returns the last character.

Since Kotlin 1.0

inline fun CharSequence.last(predicate: (Char) -> Boolean): Char

Returns the last character matching the given predicate.

Since Kotlin 1.0

lastIndexOf

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 character, starting from the specified startIndex.

Since Kotlin 1.0

fun CharSequence.lastIndexOf(string: String, 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.

Since Kotlin 1.0

lastIndexOfAny

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

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.

Since Kotlin 1.0

fun CharSequence.lastIndexOfAny(strings: Collection<String>, 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.

Since Kotlin 1.0

lastOrNull

fun CharSequence.lastOrNull(): Char?

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

Since Kotlin 1.0

inline fun CharSequence.lastOrNull(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0

lines

fun CharSequence.lines(): List<String>

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

Since Kotlin 1.0

lineSequence

fun CharSequence.lineSequence(): Sequence<String>

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

Since Kotlin 1.0

map

inline fun <R> CharSequence.map(transform: (Char) -> R): List<R>

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

Since Kotlin 1.0

mapIndexed

inline fun <R> CharSequence.mapIndexed(transform: (index: Int, Char) -> R): List<R>

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

Since Kotlin 1.0

mapIndexedNotNull

inline fun <R : Any> CharSequence.mapIndexedNotNull(transform: (index: Int, Char) -> R?): List<R>

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.

Since Kotlin 1.0

mapIndexedNotNullTo

inline fun <R : Any, C : MutableCollection<in R>> CharSequence.mapIndexedNotNullTo(destination: C, transform: (index: Int, Char) -> R?): C

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.

Since Kotlin 1.0

mapIndexedTo

inline fun <R, C : MutableCollection<in R>> CharSequence.mapIndexedTo(destination: C, transform: (index: Int, Char) -> R): C

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

Since Kotlin 1.0

mapNotNull

inline fun <R : Any> CharSequence.mapNotNull(transform: (Char) -> R?): List<R>

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

Since Kotlin 1.0

mapNotNullTo

inline fun <R : Any, C : MutableCollection<in R>> CharSequence.mapNotNullTo(destination: C, transform: (Char) -> R?): C

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

Since Kotlin 1.0

mapTo

inline fun <R, C : MutableCollection<in R>> CharSequence.mapTo(destination: C, transform: (Char) -> R): C

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

Since Kotlin 1.0

matches

infix inline fun CharSequence.matches(regex: Regex): Boolean

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

Since Kotlin 1.0

max

fun CharSequence.~~max~~(): Char?

Since Kotlin 1.0

maxBy

inline fun <R : Comparable<R>> CharSequence.~~maxBy~~(selector: (Char) -> R): Char?

Since Kotlin 1.0

maxByOrNull

inline fun <R : Comparable<R>> CharSequence.maxByOrNull(selector: (Char) -> R): Char?

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

Since Kotlin 1.4

maxOf

inline fun <R : Comparable<R>> CharSequence.maxOf(selector: (Char) -> R): R

inline fun CharSequence.maxOf(selector: (Char) -> Double): Double

inline fun CharSequence.maxOf(selector: (Char) -> Float): Float

Returns the largest value among all values produced by selector function applied to each character in the char sequence.

Since Kotlin 1.4

maxOfOrNull

inline fun <R : Comparable<R>> CharSequence.maxOfOrNull(selector: (Char) -> R): R?

inline fun CharSequence.maxOfOrNull(selector: (Char) -> Double): Double?

inline fun CharSequence.maxOfOrNull(selector: (Char) -> Float): Float?

Returns the largest value among all values produced by selector function applied to each character in the char sequence or null if there are no characters.

Since Kotlin 1.4

maxOfWith

inline fun <R> CharSequence.maxOfWith(comparator: Comparator<in R>, selector: (Char) -> R): R

Returns the largest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence.

Since Kotlin 1.4

maxOfWithOrNull

inline fun <R> CharSequence.maxOfWithOrNull(comparator: Comparator<in R>, selector: (Char) -> R): R?

Returns the largest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence or null if there are no characters.

Since Kotlin 1.4

maxOrNull

fun CharSequence.maxOrNull(): Char?

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

Since Kotlin 1.4

maxWith

fun CharSequence.~~maxWith~~(comparator: Comparator<in Char>): Char?

Since Kotlin 1.0

maxWithOrNull

fun CharSequence.maxWithOrNull(comparator: Comparator<in Char>): Char?

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

Since Kotlin 1.4

min

fun CharSequence.~~min~~(): Char?

Since Kotlin 1.0

minBy

inline fun <R : Comparable<R>> CharSequence.~~minBy~~(selector: (Char) -> R): Char?

Since Kotlin 1.0

minByOrNull

inline fun <R : Comparable<R>> CharSequence.minByOrNull(selector: (Char) -> R): Char?

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

Since Kotlin 1.4

minOf

inline fun <R : Comparable<R>> CharSequence.minOf(selector: (Char) -> R): R

inline fun CharSequence.minOf(selector: (Char) -> Double): Double

inline fun CharSequence.minOf(selector: (Char) -> Float): Float

Returns the smallest value among all values produced by selector function applied to each character in the char sequence.

Since Kotlin 1.4

minOfOrNull

inline fun <R : Comparable<R>> CharSequence.minOfOrNull(selector: (Char) -> R): R?

inline fun CharSequence.minOfOrNull(selector: (Char) -> Double): Double?

inline fun CharSequence.minOfOrNull(selector: (Char) -> Float): Float?

Returns the smallest value among all values produced by selector function applied to each character in the char sequence or null if there are no characters.

Since Kotlin 1.4

minOfWith

inline fun <R> CharSequence.minOfWith(comparator: Comparator<in R>, selector: (Char) -> R): R

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence.

Since Kotlin 1.4

minOfWithOrNull

inline fun <R> CharSequence.minOfWithOrNull(comparator: Comparator<in R>, selector: (Char) -> R): R?

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each character in the char sequence or null if there are no characters.

Since Kotlin 1.4

minOrNull

fun CharSequence.minOrNull(): Char?

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

Since Kotlin 1.4

minWith

fun CharSequence.~~minWith~~(comparator: Comparator<in Char>): Char?

Since Kotlin 1.0

minWithOrNull

fun CharSequence.minWithOrNull(comparator: Comparator<in Char>): Char?

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

Since Kotlin 1.4

none

fun CharSequence.none(): Boolean

Returns true if the char sequence has no characters.

Since Kotlin 1.0

inline fun CharSequence.none(predicate: (Char) -> Boolean): Boolean

Returns true if no characters match the given predicate.

Since Kotlin 1.0

padEnd

fun CharSequence.padEnd(length: Int, padChar: Char = ' '): CharSequence

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

Since Kotlin 1.0

padStart

fun CharSequence.padStart(length: Int, padChar: Char = ' '): CharSequence

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

Since Kotlin 1.0

partition

inline fun CharSequence.partition(predicate: (Char) -> Boolean): Pair<CharSequence, CharSequence>

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.

Since Kotlin 1.0

random

inline fun CharSequence.random(): Char

Returns a random character from this char sequence.

Since Kotlin 1.3

fun CharSequence.random(random: Random): Char

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

Since Kotlin 1.3

randomOrNull

inline fun CharSequence.randomOrNull(): Char?

Returns a random character from this char sequence, or null if this char sequence is empty.

Since Kotlin 1.4

fun CharSequence.randomOrNull(random: Random): Char?

Returns a random character from this char sequence using the specified source of randomness, or null if this char sequence is empty.

Since Kotlin 1.4

reduce

inline fun CharSequence.reduce(operation: (acc: Char, Char) -> Char): Char

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

Since Kotlin 1.0

reduceIndexed

inline fun CharSequence.reduceIndexed(operation: (index: Int, acc: Char, Char) -> Char): Char

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.

Since Kotlin 1.0

reduceIndexedOrNull

inline fun CharSequence.reduceIndexedOrNull(operation: (index: Int, acc: Char, Char) -> Char): Char?

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.

Since Kotlin 1.4

reduceOrNull

inline fun CharSequence.reduceOrNull(operation: (acc: Char, Char) -> Char): Char?

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

Since Kotlin 1.4

reduceRight

inline fun CharSequence.reduceRight(operation: (Char, acc: Char) -> Char): Char

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

Since Kotlin 1.0

reduceRightIndexed

inline fun CharSequence.reduceRightIndexed(operation: (index: Int, Char, acc: Char) -> Char): Char

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

Since Kotlin 1.0

reduceRightIndexedOrNull

inline fun CharSequence.reduceRightIndexedOrNull(operation: (index: Int, Char, acc: Char) -> Char): Char?

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

Since Kotlin 1.4

reduceRightOrNull

inline fun CharSequence.reduceRightOrNull(operation: (Char, acc: Char) -> Char): Char?

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

Since Kotlin 1.4

regionMatches

expect fun CharSequence.regionMatches(thisOffset: Int, other: CharSequence, otherOffset: Int, length: Int, ignoreCase: Boolean = false): Boolean

Returns true if the specified range in this char sequence is equal to the specified range in another char sequence.

Since Kotlin 1.0

actual fun CharSequence.regionMatches(thisOffset: Int, other: CharSequence, otherOffset: Int, length: Int, ignoreCase: Boolean = false): Boolean

Since Kotlin 1.1

actual fun CharSequence.regionMatches(thisOffset: Int, other: CharSequence, otherOffset: Int, length: Int, ignoreCase: Boolean = false): Boolean

Returns true if the specified range in this char sequence is equal to the specified range in another char sequence.

Since Kotlin 1.0

actual fun CharSequence.regionMatches(thisOffset: Int, other: CharSequence, otherOffset: Int, length: Int, ignoreCase: Boolean = false): Boolean

Returns true if the specified range in this char sequence is equal to the specified range in another char sequence.

Since Kotlin 1.3

removePrefix

fun CharSequence.removePrefix(prefix: CharSequence): CharSequence

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.

Since Kotlin 1.0

removeRange

fun CharSequence.removeRange(range: IntRange): CharSequence

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

Since Kotlin 1.0

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.

Since Kotlin 1.0

removeSuffix

fun CharSequence.removeSuffix(suffix: CharSequence): CharSequence

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.

Since Kotlin 1.0

removeSurrounding

fun CharSequence.removeSurrounding(delimiter: 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.

Since Kotlin 1.0

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

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.

Since Kotlin 1.0

repeat

expect fun CharSequence.repeat(n: Int): String

Returns a string containing this char sequence repeated n times.

Since Kotlin 1.0

actual fun CharSequence.repeat(n: Int): String

Returns a string containing this char sequence repeated n times.

Since Kotlin 1.1

actual fun CharSequence.repeat(n: Int): String

Returns a string containing this char sequence repeated n times.

Since Kotlin 1.0

actual fun CharSequence.repeat(n: Int): String

Returns a string containing this char sequence repeated n times.

Since Kotlin 1.3

replace

inline fun CharSequence.replace(regex: Regex, noinline transform: (MatchResult) -> CharSequence): 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.

Since Kotlin 1.0

inline 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 given replacement.

Since Kotlin 1.0

replaceFirst

inline fun CharSequence.replaceFirst(regex: Regex, replacement: String): String

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

Since Kotlin 1.0

replaceRange

fun CharSequence.replaceRange(range: IntRange, 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.

Since Kotlin 1.0

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.

Since Kotlin 1.0

reversed

fun CharSequence.reversed(): CharSequence

Returns a char sequence with characters in reversed order.

Since Kotlin 1.0

runningFold

inline fun <R> CharSequence.runningFold(initial: R, operation: (acc: R, Char) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each character and current accumulator value that starts with initial value.

Since Kotlin 1.4

runningFoldIndexed

inline fun <R> CharSequence.runningFoldIndexed(initial: R, operation: (index: Int, acc: R, Char) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each character, its index in the original char sequence and current accumulator value that starts with initial value.

Since Kotlin 1.4

runningReduce

inline fun CharSequence.runningReduce(operation: (acc: Char, Char) -> Char): List<Char>

Returns a list containing successive accumulation values generated by applying operation from left to right to each character and current accumulator value that starts with the first character of this char sequence.

Since Kotlin 1.4

runningReduceIndexed

inline fun CharSequence.runningReduceIndexed(operation: (index: Int, acc: Char, Char) -> Char): List<Char>

Since Kotlin 1.4

scan

inline fun <R> CharSequence.scan(initial: R, operation: (acc: R, Char) -> R): List<R>

Returns a list containing successive accumulation values generated by applying operation from left to right to each character and current accumulator value that starts with initial value.

Since Kotlin 1.4

scanIndexed

inline fun <R> CharSequence.scanIndexed(initial: R, operation: (index: Int, acc: R, Char) -> R): List<R>

Since Kotlin 1.4

single

fun CharSequence.single(): Char

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

Since Kotlin 1.0

inline fun CharSequence.single(predicate: (Char) -> Boolean): Char

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

Since Kotlin 1.0

singleOrNull

fun CharSequence.singleOrNull(): Char?

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

Since Kotlin 1.0

inline fun CharSequence.singleOrNull(predicate: (Char) -> Boolean): Char?

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

Since Kotlin 1.0

slice

fun CharSequence.slice(indices: Iterable<Int>): CharSequence

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

Since Kotlin 1.0

fun CharSequence.slice(indices: IntRange): CharSequence

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

Since Kotlin 1.0

split

inline fun CharSequence.split(regex: Regex, limit: Int = 0): List<String>

Splits this char sequence to a list of strings around matches of the given regular expression.

Since Kotlin 1.0

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 to a list of strings around occurrences of the specified delimiters.

Since Kotlin 1.0

fun CharSequence.split(regex: Pattern, limit: Int = 0): List<String>

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

Since Kotlin 1.0

splitToSequence

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>

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

Since Kotlin 1.0

startsWith

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

subSequence

abstract fun subSequence(startIndex: Int, endIndex: Int): CharSequence

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.

Since Kotlin 1.0

abstract fun subSequence(startIndex: Int, endIndex: Int): CharSequence

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.

Since Kotlin 1.3

subSequence

fun CharSequence.subSequence(range: IntRange): CharSequence

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

Since Kotlin 1.0

substring

fun CharSequence.substring(range: IntRange): String

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

sumBy

inline fun CharSequence.~~sumBy~~(selector: (Char) -> Int): Int

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

Since Kotlin 1.0

sumByDouble

inline fun CharSequence.~~sumByDouble~~(selector: (Char) -> Double): Double

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

Since Kotlin 1.0

sumOf

@JvmName(name = "sumOfDouble")

inline fun CharSequence.sumOf(selector: (Char) -> Double): Double

@JvmName(name = "sumOfInt")

inline fun CharSequence.sumOf(selector: (Char) -> Int): Int

@JvmName(name = "sumOfLong")

inline fun CharSequence.sumOf(selector: (Char) -> Long): Long

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

Since Kotlin 1.4

@JvmName(name = "sumOfUInt")

inline fun CharSequence.sumOf(selector: (Char) -> UInt): UInt

@JvmName(name = "sumOfULong")

inline fun CharSequence.sumOf(selector: (Char) -> ULong): ULong

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

Since Kotlin 1.5

@JvmName(name = "sumOfBigDecimal")

inline fun CharSequence.sumOf(selector: (Char) -> BigDecimal): BigDecimal

@JvmName(name = "sumOfBigInteger")

inline fun CharSequence.sumOf(selector: (Char) -> BigInteger): BigInteger

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

Since Kotlin 1.4

take

fun CharSequence.take(n: Int): CharSequence

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.

Since Kotlin 1.0

takeLast

fun CharSequence.takeLast(n: Int): CharSequence

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.

Since Kotlin 1.0

takeLastWhile

inline fun CharSequence.takeLastWhile(predicate: (Char) -> Boolean): CharSequence

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

Since Kotlin 1.0

takeWhile

inline fun CharSequence.takeWhile(predicate: (Char) -> Boolean): CharSequence

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

Since Kotlin 1.0

toCollection

fun <C : MutableCollection<in Char>> CharSequence.toCollection(destination: C): C

Appends all characters to the given destination collection.

Since Kotlin 1.0

toHashSet

fun CharSequence.toHashSet(): HashSet<Char>

Returns a new HashSet of all characters.

Since Kotlin 1.0

toList

fun CharSequence.toList(): List<Char>

Returns a List containing all characters.

Since Kotlin 1.0

toMutableList

fun CharSequence.toMutableList(): MutableList<Char>

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

Since Kotlin 1.0

toSet

fun CharSequence.toSet(): Set<Char>

Returns a Set of all characters.

Since Kotlin 1.0

toSortedSet

fun CharSequence.toSortedSet(): SortedSet<Char>

Returns a new SortedSet of all characters.

Since Kotlin 1.0

trim

fun CharSequence.trim(): CharSequence

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

trimEnd

fun CharSequence.trimEnd(): CharSequence

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

trimStart

fun CharSequence.trimStart(): CharSequence

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

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

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

Since Kotlin 1.0

windowed

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

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.

Since Kotlin 1.2

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

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.

Since Kotlin 1.2

windowedSequence

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

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.

Since Kotlin 1.2

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

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.

Since Kotlin 1.2

withIndex

fun CharSequence.withIndex(): Iterable<IndexedValue<Char>>

Returns a lazy Iterable that wraps each character of the original char sequence into an IndexedValue containing the index of that character and the character itself.

Since Kotlin 1.0

zip

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

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.

Since Kotlin 1.0

inline fun <V> CharSequence.zip(other: CharSequence, transform: (a: Char, b: Char) -> V): List<V>

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.

Since Kotlin 1.0

zipWithNext

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

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

Since Kotlin 1.2

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

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

Since Kotlin 1.2

Thanks for your feedback!

Was this page helpful?