ByteArray

Common
JVM
JS
Native
1.0
For Common, JVM, JS

An array of bytes. When targeting the JVM, instances of this class are represented as byte[].

For Native

An array of bytes.

Constructors

Common
JVM
JS
Native
1.0

<init>

Creates a new array of the specified size, where each element is calculated by calling the specified init function.

<init>(size: Int, init: (Int) -> Byte)

Creates a new array of the specified size, with all elements initialized to zero.

<init>(size: Int)

Properties

Common
JVM
JS
Native
1.0

size

Returns the number of elements in the array.

val size: Int

Functions

Common
JVM
JS
Native
1.0

get

Returns the array element at the given index. This method can be called using the index operator.

operator fun get(index: Int): Byte
Common
JVM
JS
Native
1.0

iterator

Creates an iterator over the elements of the array.

operator fun iterator(): ByteIterator
Common
JVM
JS
Native
1.0

set

Sets the element at the given index to the given value. This method can be called using the index operator.

operator fun set(index: Int, value: Byte)

Extension Properties

Common
JVM
JS
Native
1.0

indices

Returns the range of valid indices for the array.

val ByteArray.indices: IntRange
Common
JVM
JS
Native
1.0

lastIndex

Returns the last valid index for the array.

val ByteArray.lastIndex: Int

Extension Functions

Common
JVM
JS
Native
1.0

all

Returns true if all elements match the given predicate.

fun ByteArray.all(predicate: (Byte) -> Boolean): Boolean
Common
JVM
JS
Native
1.0

any

Returns true if array has at least one element.

fun ByteArray.any(): Boolean

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

fun ByteArray.any(predicate: (Byte) -> Boolean): Boolean
Common
JVM
JS
Native
1.0

asIterable

Creates an Iterable instance that wraps the original array returning its elements when being iterated.

fun ByteArray.asIterable(): Iterable<Byte>
Common
JVM
JS
Native
1.0

asSequence

Creates a Sequence instance that wraps the original array returning its elements when being iterated.

fun ByteArray.asSequence(): Sequence<Byte>
Common
JVM
JS
Native
1.0

associate

Returns a Map containing key-value pairs provided by transform function applied to elements of the given array.

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

associateBy

Returns a Map containing the elements from the given array indexed by the key returned from keySelector function applied to each element.

fun <K> ByteArray.associateBy(
    keySelector: (Byte) -> K
): Map<K, Byte>

Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given array.

fun <K, V> ByteArray.associateBy(
    keySelector: (Byte) -> K,
    valueTransform: (Byte) -> 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 element of the given array and value is the element itself.

fun <K, M : MutableMap<in K, in Byte>> ByteArray.associateByTo(
    destination: M,
    keySelector: (Byte) -> 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 elements of the given array.

fun <K, V, M : MutableMap<in K, in V>> ByteArray.associateByTo(
    destination: M,
    keySelector: (Byte) -> K,
    valueTransform: (Byte) -> 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 element of the given array.

fun <K, V, M : MutableMap<in K, in V>> ByteArray.associateTo(
    destination: M,
    transform: (Byte) -> Pair<K, V>
): M
Common
JVM
JS
Native
1.4

associateWith

Returns a Map where keys are elements from the given array and values are produced by the valueSelector function applied to each element.

fun <V> ByteArray.associateWith(
    valueSelector: (Byte) -> V
): Map<Byte, V>
Common
JVM
JS
Native
1.4

associateWithTo

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

fun <V, M : MutableMap<in Byte, in V>> ByteArray.associateWithTo(
    destination: M,
    valueSelector: (Byte) -> V
): M
Common
JVM
JS
Native
1.3

asUByteArray

Returns an array of type UByteArray, which is a view of this array where each element is an unsigned reinterpretation of the corresponding element of this array.

fun ByteArray.asUByteArray(): UByteArray
Common
JVM
JS
Native
1.0

average

Returns an average value of elements in the array.

fun ByteArray.average(): Double
JVM
1.0

binarySearch

Searches the array or the range of the array for the provided element using the binary search algorithm. The array is expected to be sorted, otherwise the result is undefined.

fun ByteArray.binarySearch(
    element: Byte,
    fromIndex: Int = 0,
    toIndex: Int = size
): Int
Common
JVM
JS
Native
1.0

component1

Returns 1st element from the array.

operator fun ByteArray.component1(): Byte
Common
JVM
JS
Native
1.0

component2

Returns 2nd element from the array.

operator fun ByteArray.component2(): Byte
Common
JVM
JS
Native
1.0

component3

Returns 3rd element from the array.

operator fun ByteArray.component3(): Byte
Common
JVM
JS
Native
1.0

component4

Returns 4th element from the array.

operator fun ByteArray.component4(): Byte
Common
JVM
JS
Native
1.0

component5

Returns 5th element from the array.

operator fun ByteArray.component5(): Byte
Common
JVM
JS
Native
1.0

contains

Returns true if element is found in the array.

operator fun ByteArray.contains(element: Byte): Boolean
Native
1.1

contentEquals

Returns true if the two specified arrays are structurally equal to one another, i.e. contain the same number of the same elements in the same order.

infix fun ByteArray.contentEquals(other: ByteArray): Boolean
Native
1.1

contentHashCode

Returns a hash code based on the contents of this array as if it is List.

fun ByteArray.contentHashCode(): Int
Native
1.1

contentToString

Returns a string representation of the contents of the specified array as if it is List.

fun ByteArray.contentToString(): String
Common
JVM
JS
Native
1.0

count

Returns the number of elements in this array.

fun ByteArray.count(): Int

Returns the number of elements matching the given predicate.

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

distinct

Returns a list containing only distinct elements from the given array.

fun ByteArray.distinct(): List<Byte>
Common
JVM
JS
Native
1.0

distinctBy

Returns a list containing only elements from the given array having distinct keys returned by the given selector function.

fun <K> ByteArray.distinctBy(
    selector: (Byte) -> K
): List<Byte>
Common
JVM
JS
Native
1.0

drop

Returns a list containing all elements except first n elements.

fun ByteArray.drop(n: Int): List<Byte>
Common
JVM
JS
Native
1.0

dropLast

Returns a list containing all elements except last n elements.

fun ByteArray.dropLast(n: Int): List<Byte>
Common
JVM
JS
Native
1.0

dropLastWhile

Returns a list containing all elements except last elements that satisfy the given predicate.

fun ByteArray.dropLastWhile(
    predicate: (Byte) -> Boolean
): List<Byte>
Common
JVM
JS
Native
1.0

dropWhile

Returns a list containing all elements except first elements that satisfy the given predicate.

fun ByteArray.dropWhile(
    predicate: (Byte) -> Boolean
): List<Byte>
Common
JVM
JS
Native
1.0

elementAtOrElse

Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array.

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

elementAtOrNull

Returns an element at the given index or null if the index is out of bounds of this array.

fun ByteArray.elementAtOrNull(index: Int): Byte?
Common
JVM
JS
Native
1.0

filter

Returns a list containing only elements matching the given predicate.

fun ByteArray.filter(
    predicate: (Byte) -> Boolean
): List<Byte>
Common
JVM
JS
Native
1.0

filterIndexed

Returns a list containing only elements matching the given predicate.

fun ByteArray.filterIndexed(
    predicate: (index: Int, Byte) -> Boolean
): List<Byte>
Common
JVM
JS
Native
1.0

filterIndexedTo

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

fun <C : MutableCollection<in Byte>> ByteArray.filterIndexedTo(
    destination: C,
    predicate: (index: Int, Byte) -> Boolean
): C
Common
JVM
JS
Native
1.0

filterNot

Returns a list containing all elements not matching the given predicate.

fun ByteArray.filterNot(
    predicate: (Byte) -> Boolean
): List<Byte>
Common
JVM
JS
Native
1.0

filterNotTo

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

fun <C : MutableCollection<in Byte>> ByteArray.filterNotTo(
    destination: C,
    predicate: (Byte) -> Boolean
): C
Common
JVM
JS
Native
1.0

filterTo

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

fun <C : MutableCollection<in Byte>> ByteArray.filterTo(
    destination: C,
    predicate: (Byte) -> Boolean
): C
Common
JVM
JS
Native
1.0

find

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

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

findLast

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

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

first

Returns the first element.

fun ByteArray.first(): Byte

Returns the first element matching the given predicate.

fun ByteArray.first(predicate: (Byte) -> Boolean): Byte
Common
JVM
JS
Native
1.0

firstOrNull

Returns the first element, or null if the array is empty.

fun ByteArray.firstOrNull(): Byte?

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

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

flatMap

Returns a single list of all elements yielded from results of transform function being invoked on each element of original array.

fun <R> ByteArray.flatMap(
    transform: (Byte) -> Iterable<R>
): List<R>
Common
JVM
JS
Native
1.4

flatMapIndexed

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

fun <R> ByteArray.flatMapIndexed(
    transform: (index: Int, Byte) -> Iterable<R>
): List<R>
Common
JVM
JS
Native
1.4

flatMapIndexedTo

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

fun <R, C : MutableCollection<in R>> ByteArray.flatMapIndexedTo(
    destination: C,
    transform: (index: Int, Byte) -> Iterable<R>
): C
Common
JVM
JS
Native
1.0

flatMapTo

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

fun <R, C : MutableCollection<in R>> ByteArray.flatMapTo(
    destination: C,
    transform: (Byte) -> 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 element.

fun <R> ByteArray.fold(
    initial: R,
    operation: (acc: R, Byte) -> 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 element with its index in the original array.

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

foldRight

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

fun <R> ByteArray.foldRight(
    initial: R,
    operation: (Byte, 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 element with its index in the original array and current accumulator value.

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

forEach

Performs the given action on each element.

fun ByteArray.forEach(action: (Byte) -> Unit)
Common
JVM
JS
Native
1.0

forEachIndexed

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

fun ByteArray.forEachIndexed(
    action: (index: Int, Byte) -> Unit)
Native
1.3

getCharAt

Gets Char out of the ByteArray byte buffer at specified index index

fun ByteArray.getCharAt(index: Int): Char
Native
1.3

getDoubleAt

Gets Double out of the ByteArray byte buffer at specified index index

fun ByteArray.getDoubleAt(index: Int): Double
Native
1.3

getFloatAt

Gets Float out of the ByteArray byte buffer at specified index index

fun ByteArray.getFloatAt(index: Int): Float
Native
1.3

getIntAt

Gets Int out of the ByteArray byte buffer at specified index index

fun ByteArray.getIntAt(index: Int): Int
Native
1.3

getLongAt

Gets Long out of the ByteArray byte buffer at specified index index

fun ByteArray.getLongAt(index: Int): Long
Common
JVM
JS
Native
1.0

getOrElse

Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this array.

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

getOrNull

Returns an element at the given index or null if the index is out of bounds of this array.

fun ByteArray.getOrNull(index: Int): Byte?
Native
1.3

getShortAt

Gets Short out of the ByteArray byte buffer at specified index index

fun ByteArray.getShortAt(index: Int): Short
Native
1.3

getUByteAt

Gets UByte out of the ByteArray byte buffer at specified index index

fun ByteArray.getUByteAt(index: Int): UByte
Native
1.3

getUIntAt

Gets UInt out of the ByteArray byte buffer at specified index index

fun ByteArray.getUIntAt(index: Int): UInt
Native
1.3

getULongAt

Gets ULong out of the ByteArray byte buffer at specified index index

fun ByteArray.getULongAt(index: Int): ULong
Native
1.3

getUShortAt

Gets UShort out of the ByteArray byte buffer at specified index index

fun ByteArray.getUShortAt(index: Int): UShort
Common
JVM
JS
Native
1.0

groupBy

Groups elements of the original array by the key returned by the given keySelector function applied to each element and returns a map where each group key is associated with a list of corresponding elements.

fun <K> ByteArray.groupBy(
    keySelector: (Byte) -> K
): Map<K, List<Byte>>

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

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

groupByTo

Groups elements of the original array by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements.

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

Groups values returned by the valueTransform function applied to each element of the original array by the key returned by the given keySelector function applied to the element 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>>> ByteArray.groupByTo(
    destination: M,
    keySelector: (Byte) -> K,
    valueTransform: (Byte) -> V
): M
Common
JVM
JS
Native
1.0

indexOf

Returns first index of element, or -1 if the array does not contain element.

fun ByteArray.indexOf(element: Byte): Int
Common
JVM
JS
Native
1.0

indexOfFirst

Returns index of the first element matching the given predicate, or -1 if the array does not contain such element.

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

indexOfLast

Returns index of the last element matching the given predicate, or -1 if the array does not contain such element.

fun ByteArray.indexOfLast(predicate: (Byte) -> Boolean): Int
JVM
1.0

inputStream

Creates an input stream for reading data from this byte array.

fun ByteArray.inputStream(): ByteArrayInputStream

Creates an input stream for reading data from the specified portion of this byte array.

fun ByteArray.inputStream(
    offset: Int,
    length: Int
): ByteArrayInputStream
Common
JVM
JS
Native
1.0

intersect

Returns a set containing all elements that are contained by both this array and the specified collection.

infix fun ByteArray.intersect(
    other: Iterable<Byte>
): Set<Byte>
Common
JVM
JS
Native
1.0

isEmpty

Returns true if the array is empty.

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

isNotEmpty

Returns true if the array is not empty.

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

joinTo

Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.

fun <A : Appendable> ByteArray.joinTo(
    buffer: A,
    separator: CharSequence = ", ",
    prefix: CharSequence = "",
    postfix: CharSequence = "",
    limit: Int = -1,
    truncated: CharSequence = "...",
    transform: ((Byte) -> CharSequence)? = null
): A
Common
JVM
JS
Native
1.0

joinToString

Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied.

fun ByteArray.joinToString(
    separator: CharSequence = ", ",
    prefix: CharSequence = "",
    postfix: CharSequence = "",
    limit: Int = -1,
    truncated: CharSequence = "...",
    transform: ((Byte) -> CharSequence)? = null
): String
Common
JVM
JS
Native
1.0

last

Returns the last element.

fun ByteArray.last(): Byte

Returns the last element matching the given predicate.

fun ByteArray.last(predicate: (Byte) -> Boolean): Byte
Common
JVM
JS
Native
1.0

lastIndexOf

Returns last index of element, or -1 if the array does not contain element.

fun ByteArray.lastIndexOf(element: Byte): Int
Common
JVM
JS
Native
1.0

lastOrNull

Returns the last element, or null if the array is empty.

fun ByteArray.lastOrNull(): Byte?

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

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

map

Returns a list containing the results of applying the given transform function to each element in the original array.

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

mapIndexed

Returns a list containing the results of applying the given transform function to each element and its index in the original array.

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

mapIndexedTo

Applies the given transform function to each element and its index in the original array and appends the results to the given destination.

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

mapTo

Applies the given transform function to each element of the original array and appends the results to the given destination.

fun <R, C : MutableCollection<in R>> ByteArray.mapTo(
    destination: C,
    transform: (Byte) -> R
): C
Common
JVM
JS
Native
1.4

maxByOrNull

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

fun <R : Comparable<R>> ByteArray.maxByOrNull(
    selector: (Byte) -> R
): Byte?
Common
JVM
JS
Native
1.4

maxOf

Returns the largest value among all values produced by selector function applied to each element in the array.

fun <R : Comparable<R>> any_array<R>.maxOf(
    selector: (Byte) -> R
): R
Common
JVM
JS
Native
1.4

maxOfOrNull

Returns the largest value among all values produced by selector function applied to each element in the array or null if there are no elements.

fun <R : Comparable<R>> any_array<R>.maxOfOrNull(
    selector: (Byte) -> R
): R?
Common
JVM
JS
Native
1.4

maxOfWith

Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the array.

fun <R> ByteArray.maxOfWith(
    comparator: Comparator<in R>,
    selector: (Byte) -> R
): R
Common
JVM
JS
Native
1.4

maxOfWithOrNull

Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the array or null if there are no elements.

fun <R> ByteArray.maxOfWithOrNull(
    comparator: Comparator<in R>,
    selector: (Byte) -> R
): R?
Common
JVM
JS
Native
1.4

maxOrNull

Returns the largest element or null if there are no elements.

fun ByteArray.maxOrNull(): Byte?

maxWith

Common
JVM
JS
Native
1.7

Returns the first element having the largest value according to the provided comparator.

fun ByteArray.maxWith(comparator: Comparator<in Byte>): Byte
JVM
1.0
fun ByteArray.maxWith(comparator: Comparator<in Byte>): Byte?
Common
JVM
JS
Native
1.4

maxWithOrNull

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

fun ByteArray.maxWithOrNull(
    comparator: Comparator<in Byte>
): Byte?
Common
JVM
JS
Native
1.4

minByOrNull

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

fun <R : Comparable<R>> ByteArray.minByOrNull(
    selector: (Byte) -> R
): Byte?
Common
JVM
JS
Native
1.4

minOf

Returns the smallest value among all values produced by selector function applied to each element in the array.

fun <R : Comparable<R>> any_array<R>.minOf(
    selector: (Byte) -> R
): R
Common
JVM
JS
Native
1.4

minOfOrNull

Returns the smallest value among all values produced by selector function applied to each element in the array or null if there are no elements.

fun <R : Comparable<R>> any_array<R>.minOfOrNull(
    selector: (Byte) -> R
): R?
Common
JVM
JS
Native
1.4

minOfWith

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the array.

fun <R> ByteArray.minOfWith(
    comparator: Comparator<in R>,
    selector: (Byte) -> R
): R
Common
JVM
JS
Native
1.4

minOfWithOrNull

Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the array or null if there are no elements.

fun <R> ByteArray.minOfWithOrNull(
    comparator: Comparator<in R>,
    selector: (Byte) -> R
): R?
Common
JVM
JS
Native
1.4

minOrNull

Returns the smallest element or null if there are no elements.

fun ByteArray.minOrNull(): Byte?

minWith

Common
JVM
JS
Native
1.7

Returns the first element having the smallest value according to the provided comparator.

fun ByteArray.minWith(comparator: Comparator<in Byte>): Byte
JVM
1.0
fun ByteArray.minWith(comparator: Comparator<in Byte>): Byte?
Common
JVM
JS
Native
1.4

minWithOrNull

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

fun ByteArray.minWithOrNull(
    comparator: Comparator<in Byte>
): Byte?
Common
JVM
JS
Native
1.0

none

Returns true if the array has no elements.

fun ByteArray.none(): Boolean

Returns true if no elements match the given predicate.

fun ByteArray.none(predicate: (Byte) -> Boolean): Boolean
Common
JVM
JS
Native
1.4

onEach

Performs the given action on each element and returns the array itself afterwards.

fun ByteArray.onEach(action: (Byte) -> Unit): ByteArray
Common
JVM
JS
Native
1.4

onEachIndexed

Performs the given action on each element, providing sequential index with the element, and returns the array itself afterwards.

fun ByteArray.onEachIndexed(
    action: (index: Int, Byte) -> Unit
): ByteArray
Common
JVM
JS
Native
1.0

partition

Splits the original array into pair of lists, where first list contains elements for which predicate yielded true, while second list contains elements for which predicate yielded false.

fun ByteArray.partition(
    predicate: (Byte) -> Boolean
): Pair<List<Byte>, List<Byte>>
Common
JVM
JS
Native
1.3

random

Returns a random element from this array.

fun ByteArray.random(): Byte

Returns a random element from this array using the specified source of randomness.

fun ByteArray.random(random: Random): Byte
Common
JVM
JS
Native
1.4

randomOrNull

Returns a random element from this array, or null if this array is empty.

fun ByteArray.randomOrNull(): Byte?

Returns a random element from this array using the specified source of randomness, or null if this array is empty.

fun ByteArray.randomOrNull(random: Random): Byte?
Common
JVM
JS
Native
1.0

reduce

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

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

reduceIndexed

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

fun ByteArray.reduceIndexed(
    operation: (index: Int, acc: Byte, Byte) -> Byte
): Byte
Common
JVM
JS
Native
1.4

reduceIndexedOrNull

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

fun ByteArray.reduceIndexedOrNull(
    operation: (index: Int, acc: Byte, Byte) -> Byte
): Byte?
Common
JVM
JS
Native
1.4

reduceOrNull

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

fun ByteArray.reduceOrNull(
    operation: (acc: Byte, Byte) -> Byte
): Byte?
Common
JVM
JS
Native
1.0

reduceRight

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

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

reduceRightIndexed

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

fun ByteArray.reduceRightIndexed(
    operation: (index: Int, Byte, acc: Byte) -> Byte
): Byte
Common
JVM
JS
Native
1.4

reduceRightIndexedOrNull

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

fun ByteArray.reduceRightIndexedOrNull(
    operation: (index: Int, Byte, acc: Byte) -> Byte
): Byte?
Common
JVM
JS
Native
1.4

reduceRightOrNull

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

fun ByteArray.reduceRightOrNull(
    operation: (Byte, acc: Byte) -> Byte
): Byte?
Native
1.3

refTo

fun ByteArray.refTo(index: Int): CValuesRef<ByteVar>
Common
JVM
JS
Native
1.0

reverse

Reverses elements in the array in-place.

fun ByteArray.reverse()

Reverses elements of the array in the specified range in-place.

fun ByteArray.reverse(fromIndex: Int, toIndex: Int)
Common
JVM
JS
Native
1.0

reversed

Returns a list with elements in reversed order.

fun ByteArray.reversed(): List<Byte>
Common
JVM
JS
Native
1.0

reversedArray

Returns an array with elements of this array in reversed order.

fun ByteArray.reversedArray(): ByteArray
Common
JVM
JS
Native
1.4

runningFold

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

fun <R> ByteArray.runningFold(
    initial: R,
    operation: (acc: R, Byte) -> R
): List<R>
Common
JVM
JS
Native
1.4

runningFoldIndexed

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

fun <R> ByteArray.runningFoldIndexed(
    initial: R,
    operation: (index: Int, acc: R, Byte) -> R
): List<R>
Common
JVM
JS
Native
1.4

runningReduce

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

fun ByteArray.runningReduce(
    operation: (acc: Byte, Byte) -> Byte
): List<Byte>
Common
JVM
JS
Native
1.4

runningReduceIndexed

Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original array and current accumulator value that starts with the first element of this array.

fun ByteArray.runningReduceIndexed(
    operation: (index: Int, acc: Byte, Byte) -> Byte
): List<Byte>
Common
JVM
JS
Native
1.4

scan

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

fun <R> ByteArray.scan(
    initial: R,
    operation: (acc: R, Byte) -> R
): List<R>
Common
JVM
JS
Native
1.4

scanIndexed

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

fun <R> ByteArray.scanIndexed(
    initial: R,
    operation: (index: Int, acc: R, Byte) -> R
): List<R>
Native
1.3

setCharAt

Sets Char out of the ByteArray byte buffer at specified index index

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

setDoubleAt

Sets Double out of the ByteArray byte buffer at specified index index

fun ByteArray.setDoubleAt(index: Int, value: Double)
Native
1.3

setFloatAt

Sets Float out of the ByteArray byte buffer at specified index index

fun ByteArray.setFloatAt(index: Int, value: Float)
Native
1.3

setIntAt

Sets Int out of the ByteArray byte buffer at specified index index

fun ByteArray.setIntAt(index: Int, value: Int)
Native
1.3

setLongAt

Sets Long out of the ByteArray byte buffer at specified index index

fun ByteArray.setLongAt(index: Int, value: Long)
Native
1.3

setShortAt

Sets Short out of the ByteArray byte buffer at specified index index

fun ByteArray.setShortAt(index: Int, value: Short)
Native
1.3

setUByteAt

Sets UByte out of the ByteArray byte buffer at specified index index

fun ByteArray.setUByteAt(index: Int, value: UByte)
Native
1.3

setUIntAt

Sets UInt out of the ByteArray byte buffer at specified index index

fun ByteArray.setUIntAt(index: Int, value: UInt)
Native
1.3

setULongAt

Sets ULong out of the ByteArray byte buffer at specified index index

fun ByteArray.setULongAt(index: Int, value: ULong)
Native
1.3

setUShortAt

Sets UShort out of the ByteArray byte buffer at specified index index

fun ByteArray.setUShortAt(index: Int, value: UShort)
Common
JVM
JS
Native
1.4

shuffle

Randomly shuffles elements in this array in-place.

fun ByteArray.shuffle()

Randomly shuffles elements in this array in-place using the specified random instance as the source of randomness.

fun ByteArray.shuffle(random: Random)
Common
JVM
JS
Native
1.0

single

Returns the single element, or throws an exception if the array is empty or has more than one element.

fun ByteArray.single(): Byte

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

fun ByteArray.single(predicate: (Byte) -> Boolean): Byte
Common
JVM
JS
Native
1.0

singleOrNull

Returns single element, or null if the array is empty or has more than one element.

fun ByteArray.singleOrNull(): Byte?

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

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

slice

Returns a list containing elements at indices in the specified indices range.

fun ByteArray.slice(indices: IntRange): List<Byte>

Returns a list containing elements at specified indices.

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

sliceArray

Returns an array containing elements of this array at specified indices.

fun ByteArray.sliceArray(indices: Collection<Int>): ByteArray

Returns an array containing elements at indices in the specified indices range.

fun ByteArray.sliceArray(indices: IntRange): ByteArray
JS
1.1

sort

Sorts the array in-place according to the order specified by the given comparison function.

fun ByteArray.sort(comparison: (a: Byte, b: Byte) -> Int)
Common
JVM
JS
Native
1.0

sortDescending

Sorts elements in the array in-place descending according to their natural sort order.

fun ByteArray.sortDescending()

Sorts elements of the array in the specified range in-place. The elements are sorted descending according to their natural sort order.

fun ByteArray.sortDescending(fromIndex: Int, toIndex: Int)
Common
JVM
JS
Native
1.0

sorted

Returns a list of all elements sorted according to their natural sort order.

fun ByteArray.sorted(): List<Byte>
Common
JVM
JS
Native
1.0

sortedArray

Returns an array with all elements of this array sorted according to their natural sort order.

fun ByteArray.sortedArray(): ByteArray
Common
JVM
JS
Native
1.0

sortedArrayDescending

Returns an array with all elements of this array sorted descending according to their natural sort order.

fun ByteArray.sortedArrayDescending(): ByteArray
Common
JVM
JS
Native
1.0

sortedBy

Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function.

fun <R : Comparable<R>> ByteArray.sortedBy(
    selector: (Byte) -> R?
): List<Byte>
Common
JVM
JS
Native
1.0

sortedByDescending

Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function.

fun <R : Comparable<R>> ByteArray.sortedByDescending(
    selector: (Byte) -> R?
): List<Byte>
Common
JVM
JS
Native
1.0

sortedDescending

Returns a list of all elements sorted descending according to their natural sort order.

fun ByteArray.sortedDescending(): List<Byte>
Common
JVM
JS
Native
1.0

sortedWith

Returns a list of all elements sorted according to the specified comparator.

fun ByteArray.sortedWith(
    comparator: Comparator<in Byte>
): List<Byte>
Common
JVM
JS
Native
1.0

subtract

Returns a set containing all elements that are contained by this array and not contained by the specified collection.

infix fun ByteArray.subtract(
    other: Iterable<Byte>
): Set<Byte>
Common
JVM
JS
Native
1.0

sum

Returns the sum of all elements in the array.

fun ByteArray.sum(): Int
Common
JVM
JS
Native
1.0

sumBy

Returns the sum of all values produced by selector function applied to each element in the array.

fun ByteArray.sumBy(selector: (Byte) -> Int): Int
Common
JVM
JS
Native
1.0

sumByDouble

Returns the sum of all values produced by selector function applied to each element in the array.

fun ByteArray.sumByDouble(selector: (Byte) -> Double): Double

sumOf

Returns the sum of all values produced by selector function applied to each element in the array.

Common
JVM
JS
Native
1.4
fun ByteArray.sumOf(selector: (Byte) -> Double): Double
Common
JVM
JS
Native
1.4
fun ByteArray.sumOf(selector: (Byte) -> Int): Int
Common
JVM
JS
Native
1.4
fun ByteArray.sumOf(selector: (Byte) -> Long): Long
Common
JVM
JS
Native
1.5
fun ByteArray.sumOf(selector: (Byte) -> UInt): UInt
Common
JVM
JS
Native
1.5
fun ByteArray.sumOf(selector: (Byte) -> ULong): ULong
JVM
1.4
fun ByteArray.sumOf(
    selector: (Byte) -> BigDecimal
): BigDecimal
JVM
1.4
fun ByteArray.sumOf(
    selector: (Byte) -> BigInteger
): BigInteger
Common
JVM
JS
Native
1.0

take

Returns a list containing first n elements.

fun ByteArray.take(n: Int): List<Byte>
Common
JVM
JS
Native
1.0

takeLast

Returns a list containing last n elements.

fun ByteArray.takeLast(n: Int): List<Byte>
Common
JVM
JS
Native
1.0

takeLastWhile

Returns a list containing last elements satisfying the given predicate.

fun ByteArray.takeLastWhile(
    predicate: (Byte) -> Boolean
): List<Byte>
Common
JVM
JS
Native
1.0

takeWhile

Returns a list containing first elements satisfying the given predicate.

fun ByteArray.takeWhile(
    predicate: (Byte) -> Boolean
): List<Byte>
Common
JVM
JS
Native
1.0

toCollection

Appends all elements to the given destination collection.

fun <C : MutableCollection<in Byte>> ByteArray.toCollection(
    destination: C
): C
Native
1.3

toCValues

fun ByteArray.toCValues(): CValues<ByteVar>
Common
JVM
JS
Native
1.0

toHashSet

Returns a new HashSet of all elements.

fun ByteArray.toHashSet(): HashSet<Byte>
Common
JVM
JS
Native
1.9

toHexString

Formats bytes in this array using the specified format.

fun ByteArray.toHexString(
    format: HexFormat = HexFormat.Default
): String

Formats bytes in this array using the specified HexFormat.

fun ByteArray.toHexString(
    startIndex: Int = 0,
    endIndex: Int = size,
    format: HexFormat = HexFormat.Default
): String
Native
1.3

toKString

Decodes a string from the bytes in UTF-8 encoding in this array. Bytes following the first occurrence of 0 byte, if it occurs, are not decoded.

fun ByteArray.toKString(): String

Decodes a string from the bytes in UTF-8 encoding in this array or its subrange. Bytes following the first occurrence of 0 byte, if it occurs, are not decoded.

fun ByteArray.toKString(
    startIndex: Int = 0,
    endIndex: Int = this.size,
    throwOnInvalidSequence: Boolean = false
): String
Common
JVM
JS
Native
1.0

toList

Returns a List containing all elements.

fun ByteArray.toList(): List<Byte>
Common
JVM
JS
Native
1.0

toMutableList

Returns a new MutableList filled with all elements of this array.

fun ByteArray.toMutableList(): MutableList<Byte>
Common
JVM
JS
Native
1.0

toMutableSet

Returns a new MutableSet containing all distinct elements from the given array.

fun ByteArray.toMutableSet(): MutableSet<Byte>
Common
JVM
JS
Native
1.0

toSet

Returns a Set of all elements.

fun ByteArray.toSet(): Set<Byte>
JVM
1.0

toSortedSet

Returns a new SortedSet of all elements.

fun ByteArray.toSortedSet(): SortedSet<Byte>
JVM
1.0

toString

Converts the contents of this byte array to a string using the specified charset.

fun ByteArray.toString(charset: Charset): String
Common
JVM
JS
Native
1.3

toUByteArray

Returns an array of type UByteArray, which is a copy of this array where each element is an unsigned reinterpretation of the corresponding element of this array.

fun ByteArray.toUByteArray(): UByteArray
Common
JVM
JS
Native
1.0

union

Returns a set containing all distinct elements from both collections.

infix fun ByteArray.union(other: Iterable<Byte>): Set<Byte>
Common
JVM
JS
Native
1.0

withIndex

Returns a lazy Iterable that wraps each element of the original array into an IndexedValue containing the index of that element and the element itself.

fun ByteArray.withIndex(): Iterable<IndexedValue<Byte>>
Common
JVM
JS
Native
1.0

zip

Returns a list of pairs built from the elements of this array and the other array with the same index. The returned list has length of the shortest collection.

infix fun <R> any_array<R>.zip(
    other: Array<out R>
): List<Pair<Byte, R>>

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

fun <R, V> ByteArray.zip(
    other: Array<out R>,
    transform: (a: Byte, b: R) -> V
): List<V>

Returns a list of pairs built from the elements of this collection and other array with the same index. The returned list has length of the shortest collection.

infix fun <R> ByteArray.zip(
    other: Iterable<R>
): List<Pair<Byte, R>>

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

fun <R, V> ByteArray.zip(
    other: Iterable<R>,
    transform: (a: Byte, b: R) -> V
): List<V>

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

fun <V> ByteArray.zip(
    other: ByteArray,
    transform: (a: Byte, b: Byte) -> V
): List<V>