kotlin-stdlib/kotlin.text/toByte

toByte

expect fun String.toByte(): Byte(source)

Parses the string to a Byte number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Byte value range (within Byte.MIN_VALUE..Byte.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.0

Throws

if the string is not a valid representation of a Byte.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toByte()) // 0
println("42".toByte()) // 42
println("042".toByte()) // 42
println("-42".toByte()) // -42
// Byte.MAX_VALUE
println("127".toByte()) // 127
// Byte overflow
// "128".toByte() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toByte() // will fail with NumberFormatException
// underscore
// "1_00".toByte() // will fail with NumberFormatException
// whitespaces
// " 22 ".toByte() // will fail with NumberFormatException 
   //sampleEnd
}
expect fun String.toByte(radix: Int): Byte(source)

Parses the string as a signed Byte number and returns the result.

Since Kotlin

1.0

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual fun String.toByte(): Byte(source)

Parses the string to a Byte number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Byte value range (within Byte.MIN_VALUE..Byte.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.1

Throws

if the string is not a valid representation of a Byte.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toByte()) // 0
println("42".toByte()) // 42
println("042".toByte()) // 42
println("-42".toByte()) // -42
// Byte.MAX_VALUE
println("127".toByte()) // 127
// Byte overflow
// "128".toByte() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toByte() // will fail with NumberFormatException
// underscore
// "1_00".toByte() // will fail with NumberFormatException
// whitespaces
// " 22 ".toByte() // will fail with NumberFormatException 
   //sampleEnd
}
actual fun String.toByte(radix: Int): Byte(source)

Parses the string as a signed Byte number and returns the result.

Since Kotlin

1.1

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual inline fun String.toByte(): Byte(source)

Parses the string to a Byte number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Byte value range (within Byte.MIN_VALUE..Byte.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.0

Throws

if the string is not a valid representation of a Byte.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toByte()) // 0
println("42".toByte()) // 42
println("042".toByte()) // 42
println("-42".toByte()) // -42
// Byte.MAX_VALUE
println("127".toByte()) // 127
// Byte overflow
// "128".toByte() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toByte() // will fail with NumberFormatException
// underscore
// "1_00".toByte() // will fail with NumberFormatException
// whitespaces
// " 22 ".toByte() // will fail with NumberFormatException 
   //sampleEnd
}
actual inline fun String.toByte(radix: Int): Byte(source)

Parses the string as a signed Byte number and returns the result.

Since Kotlin

1.1

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual inline fun String.toByte(): Byte(source)

Parses the string to a Byte number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Byte value range (within Byte.MIN_VALUE..Byte.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.3

Throws

if the string is not a valid representation of a Byte.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toByte()) // 0
println("42".toByte()) // 42
println("042".toByte()) // 42
println("-42".toByte()) // -42
// Byte.MAX_VALUE
println("127".toByte()) // 127
// Byte overflow
// "128".toByte() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toByte() // will fail with NumberFormatException
// underscore
// "1_00".toByte() // will fail with NumberFormatException
// whitespaces
// " 22 ".toByte() // will fail with NumberFormatException 
   //sampleEnd
}
actual inline fun String.toByte(radix: Int): Byte(source)

Parses the string as a signed Byte number and returns the result.

Since Kotlin

1.3

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual fun String.toByte(): Byte(source)

Parses the string to a Byte number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Byte value range (within Byte.MIN_VALUE..Byte.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a Byte.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toByte()) // 0
println("42".toByte()) // 42
println("042".toByte()) // 42
println("-42".toByte()) // -42
// Byte.MAX_VALUE
println("127".toByte()) // 127
// Byte overflow
// "128".toByte() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toByte() // will fail with NumberFormatException
// underscore
// "1_00".toByte() // will fail with NumberFormatException
// whitespaces
// " 22 ".toByte() // will fail with NumberFormatException 
   //sampleEnd
}
actual fun String.toByte(radix: Int): Byte(source)

Parses the string as a signed Byte number and returns the result.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.

actual fun String.toByte(): Byte(source)

Parses the string to a Byte number.

The string must consist of an optional leading + or - sign and decimal digits (0-9), and fit the valid Byte value range (within Byte.MIN_VALUE..Byte.MAX_VALUE), otherwise a NumberFormatException will be thrown.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a Byte.

Samples

import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   println("0".toByte()) // 0
println("42".toByte()) // 42
println("042".toByte()) // 42
println("-42".toByte()) // -42
// Byte.MAX_VALUE
println("127".toByte()) // 127
// Byte overflow
// "128".toByte() // will fail with NumberFormatException
// 'a' is not a digit
// "-1a".toByte() // will fail with NumberFormatException
// underscore
// "1_00".toByte() // will fail with NumberFormatException
// whitespaces
// " 22 ".toByte() // will fail with NumberFormatException 
   //sampleEnd
}
actual fun String.toByte(radix: Int): Byte(source)

Parses the string as a signed Byte number and returns the result.

Since Kotlin

1.8

Throws

if the string is not a valid representation of a number.

when radix is not a valid radix for string to number conversion.