ByteString

open class ByteString : Comparable<ByteString>

An immutable sequence of bytes.

Byte strings compare lexicographically as a sequence of unsigned bytes. That is, the byte string ff sorts after 00. This is counter to the sort order of the corresponding bytes, where -1 sorts before 0.

Full disclosure: this class provides untrusted input and output streams with raw access to the underlying byte array. A hostile stream implementation could keep a reference to the mutable byte string, violating the immutable guarantee of this class. For this reason a byte string's immutability guarantee cannot be relied upon for security in applets and other environments that run both trusted and untrusted code in the same process.

open class ByteString : Serializable, Comparable<ByteString>

Types

Companion

common

object Companion

Functions

asByteBuffer

jvm

open fun asByteBuffer(): ByteBuffer

Returns a ByteBuffer view of the bytes in this ByteString.

base64

common

fun base64(): String

Returns this byte string encoded as Base64.

jvm

open fun base64(): String

base64Url

common

fun base64Url(): String

Returns this byte string encoded as URL-safe Base64.

jvm

open fun base64Url(): String

compareTo

common

open operator override fun compareTo(other: ByteString): Int

endsWith

common

fun endsWith(suffix: ByteArray): Boolean

fun endsWith(suffix: ByteString): Boolean

equals

common

open operator override fun equals(other: Any?): Boolean

get

common

@JvmName(name = "getByte")

operator fun get(index: Int): Byte

Returns the byte at index.

jvm

@JvmName(name = "getByte")

operator fun get(index: Int): Byte

hashCode

common

open override fun hashCode(): Int

hex

common

fun hex(): String

Returns this byte string encoded in hexadecimal.

jvm

open fun hex(): String

hmacSha1

common

fun hmacSha1(key: ByteString): ByteString

Returns the 160-bit SHA-1 HMAC of this byte string.

jvm

open fun hmacSha1(key: ByteString): ByteString

Returns the 160-bit SHA-1 HMAC of this byte string.

hmacSha256

common

fun hmacSha256(key: ByteString): ByteString

Returns the 256-bit SHA-256 HMAC of this byte string.

jvm

open fun hmacSha256(key: ByteString): ByteString

Returns the 256-bit SHA-256 HMAC of this byte string.

hmacSha512

common

fun hmacSha512(key: ByteString): ByteString

Returns the 512-bit SHA-512 HMAC of this byte string.

jvm

open fun hmacSha512(key: ByteString): ByteString

Returns the 512-bit SHA-512 HMAC of this byte string.

indexOf

@JvmOverloads()

fun indexOf(other: ByteArray, fromIndex: Int = 0): Int

@JvmOverloads()

fun indexOf(other: ByteString, fromIndex: Int = 0): Int

@JvmOverloads()

open fun indexOf(other: ByteArray, fromIndex: Int = 0): Int

@JvmOverloads()

fun indexOf(other: ByteString, fromIndex: Int = 0): Int

lastIndexOf

fun lastIndexOf(other: ByteArray, fromIndex: Int = size): Int

fun lastIndexOf(other: ByteString, fromIndex: Int = size): Int

@JvmOverloads()

open fun lastIndexOf(other: ByteArray, fromIndex: Int = size): Int

@JvmOverloads()

fun lastIndexOf(other: ByteString, fromIndex: Int = size): Int

md5

common

fun md5(): ByteString

Returns the 128-bit MD5 hash of this byte string.

jvm

fun md5(): ByteString

rangeEquals

common

fun rangeEquals(offset: Int, other: ByteArray, otherOffset: Int, byteCount: Int): Boolean

Returns true if the bytes of this in [offset..offset+byteCount) equal the bytes of other in [otherOffset..otherOffset+byteCount).

jvm

open fun rangeEquals(offset: Int, other: ByteArray, otherOffset: Int, byteCount: Int): Boolean

common

fun rangeEquals(offset: Int, other: ByteString, otherOffset: Int, byteCount: Int): Boolean

Returns true if the bytes of this in [offset..offset+byteCount) equal the bytes of other in [otherOffset..otherOffset+byteCount).

jvm

open fun rangeEquals(offset: Int, other: ByteString, otherOffset: Int, byteCount: Int): Boolean

sha1

common

fun sha1(): ByteString

Returns the 160-bit SHA-1 hash of this byte string.

jvm

fun sha1(): ByteString

sha256

common

fun sha256(): ByteString

Returns the 256-bit SHA-256 hash of this byte string.

jvm

fun sha256(): ByteString

sha512

common

fun sha512(): ByteString

Returns the 512-bit SHA-512 hash of this byte string.

jvm

fun sha512(): ByteString

startsWith

common

fun startsWith(prefix: ByteArray): Boolean

fun startsWith(prefix: ByteString): Boolean

string

jvm

open fun string(charset: Charset): String

Constructs a new String by decoding the bytes using charset.

substring

common

fun substring(beginIndex: Int = 0, endIndex: Int = size): ByteString

Returns a byte string that is a substring of this byte string, beginning at the specified beginIndex and ends at the specified endIndex.

jvm

@JvmOverloads()

open fun substring(beginIndex: Int = 0, endIndex: Int = size): ByteString

toAsciiLowercase

common

fun toAsciiLowercase(): ByteString

Returns a byte string equal to this byte string, but with the bytes 'A' through 'Z' replaced with the corresponding byte in 'a' through 'z'.

jvm

open fun toAsciiLowercase(): ByteString

toAsciiUppercase

common

fun toAsciiUppercase(): ByteString

Returns a byte string equal to this byte string, but with the bytes 'a' through 'z' replaced with the corresponding byte in 'A' through 'Z'.

jvm

open fun toAsciiUppercase(): ByteString

toByteArray

common

fun toByteArray(): ByteArray

Returns a byte array containing a copy of the bytes in this ByteString.

jvm

open fun toByteArray(): ByteArray

toString

common

open override fun toString(): String

Returns a human-readable string that describes the contents of this byte string.

jvm

open override fun toString(): String

utf8

common

fun utf8(): String

Constructs a new String by decoding the bytes as UTF-8.

jvm

open fun utf8(): String

write

jvm

open fun write(out: OutputStream)

Writes the contents of this byte string to out.

Properties

size

Returns the number of bytes in this ByteString.