stdlib/kotlin/ByteArray

ByteArray

class ByteArray(size: Int)(source)

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

Since Kotlin

1.0

Constructors

Link copied to clipboard
fun ByteArray(size: Int, init: (Int) -> Byte)

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

Link copied to clipboard
fun ByteArray(size: Int)

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

Functions

Link copied to clipboard
operator fun get(index: Int): Byte

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

Since Kotlin 1.0
Link copied to clipboard
operator fun iterator(): ByteIterator

Creates an iterator over the elements of the array.

Since Kotlin 1.0
Link copied to clipboard
operator fun set(index: Int, value: Byte)

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

Since Kotlin 1.0

Properties

Link copied to clipboard
val size: Int

Returns the number of elements in the array.

Since Kotlin 1.0

Extensions

Link copied to clipboard
actual fun ByteArray.asList(): List<Byte>

Returns a List that wraps the original array.

Since Kotlin 1.0
Link copied to clipboard
fun ByteArray.binarySearch(element: Byte, fromIndex: Int = 0, toIndex: Int = size): Int

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.

Since Kotlin 1.0
Link copied to clipboard
actual inline fun ByteArray.copyOf(): ByteArray

Returns new array which is a copy of the original array.

Since Kotlin 1.0
actual inline fun ByteArray.copyOf(newSize: Int): ByteArray

Returns new array which is a copy of the original array, resized to the given newSize. The copy is either truncated or padded at the end with zero values if necessary.

Since Kotlin 1.0
Link copied to clipboard
@JvmName(name = "copyOfRangeInline")
actual inline fun ByteArray.copyOfRange(fromIndex: Int, toIndex: Int): ByteArray

Returns a new array which is a copy of the specified range of the original array.

Since Kotlin 1.0
Link copied to clipboard
actual inline fun ByteArray.elementAt(index: Int): Byte

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

Since Kotlin 1.0
Link copied to clipboard
actual fun ByteArray.fill(element: Byte, fromIndex: Int = 0, toIndex: Int = size)

Fills this array or its subrange with the specified element value.

Since Kotlin 1.0
Link copied to clipboard
inline fun ByteArray.inputStream(): ByteArrayInputStream

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

Since Kotlin 1.0
inline fun ByteArray.inputStream(offset: Int, length: Int): ByteArrayInputStream

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

Since Kotlin 1.0
Link copied to clipboard
fun ByteArray.max(): Byte?
Since Kotlin 1.0
Link copied to clipboard
inline fun <R : Comparable<R>> ByteArray.maxBy(selector: (Byte) -> R): Byte?
Since Kotlin 1.0
Link copied to clipboard
fun ByteArray.maxWith(comparator: Comparator<in Byte>): Byte?
Since Kotlin 1.0
Link copied to clipboard
fun ByteArray.min(): Byte?
Since Kotlin 1.0
Link copied to clipboard
inline fun <R : Comparable<R>> ByteArray.minBy(selector: (Byte) -> R): Byte?
Since Kotlin 1.0
Link copied to clipboard
fun ByteArray.minWith(comparator: Comparator<in Byte>): Byte?
Since Kotlin 1.0
Link copied to clipboard
actual operator fun ByteArray.plus(element: Byte): ByteArray

Returns an array containing all elements of the original array and then the given element.

Since Kotlin 1.0
actual operator fun ByteArray.plus(elements: Collection<Byte>): ByteArray

Returns an array containing all elements of the original array and then all elements of the given elements collection.

Since Kotlin 1.0
actual operator fun ByteArray.plus(elements: ByteArray): ByteArray

Returns an array containing all elements of the original array and then all elements of the given elements array.

Since Kotlin 1.0
Link copied to clipboard
actual fun ByteArray.sort()

Sorts the array in-place.

Since Kotlin 1.0
actual fun ByteArray.sort(fromIndex: Int = 0, toIndex: Int = size)

Sorts a range in the array in-place.

Since Kotlin 1.0
Link copied to clipboard
fun ByteArray.toSortedSet(): SortedSet<Byte>

Returns a new SortedSet of all elements.

Since Kotlin 1.0
Link copied to clipboard
inline fun ByteArray.toString(charset: Charset): String

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

Since Kotlin 1.0
Link copied to clipboard
actual fun ByteArray.toTypedArray(): ByteArray

Returns a typed object array containing all of the elements of this primitive array.

Since Kotlin 1.0