Spec-Zone.ru › Kotlin 1.7

Результат

kotlin-stdlib / kotlin / Result
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)
inline class Result<out T> : Serializable

Дискриминированное объединение, которое инкапсулирует успешный результат со значением типа T или ошибку с произвольным исключением Throwable.

Свойства

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

isFailure

Возвращает значение true , если этот экземпляр представляет собой результат с ошибкой. В этом случае isSuccess возвращает false.

val isFailure: Boolean
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

isSuccess

Возвращает true , если этот экземпляр представляет собой успешный результат. В этом случае isFailure возвращает false.

val isSuccess: Boolean

Функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

exceptionOrNull

Возвращает инкапсулированное исключение Throwable, если этот экземпляр представляет собой ошибку failure, или null , если это успех.

fun exceptionOrNull(): Throwable?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

getOrNull

Возвращает инкапсулированное значение, если этот экземпляр представляет собой успех, или null , если это ошибка.

fun getOrNull(): T?
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toString

Возвращает строку Success(v) , если этот экземпляр представляет собой успех, где v — строковое представление значения, или строку Failure(x) , если это ошибка, где x — строковое представление исключения.

fun toString(): String

Функции компаньон-объекта

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

failure

Возвращает экземпляр, который инкапсулирует заданное исключение Throwable как ошибку.

fun <T> failure(exception: Throwable): Result<T>
Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

success

Возвращает экземпляр, который инкапсулирует заданное значение value как успешное значение.

fun <T> success(value: T): Result<T>

Расширяющие функции

Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

fold

Возвращает результат onSuccess для заключённого значения, если этот экземпляр представляет успех, или результат функции onFailure для заключённого исключения Throwable, если это ошибка.

fun <R, T> Result<T>.fold(
    onSuccess: (value: T) -> R, 
    onFailure: (exception: Throwable) -> R
): R
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

getOrDefault

Возвращает заключённое значение, если этот экземпляр представляет успех, или defaultValue, если это ошибка.

fun <R, T : R> Result<T>.getOrDefault(defaultValue: R): R
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

getOrElse

Возвращает заключённое значение, если этот экземпляр представляет успех, или результат функции onFailure для заключённого исключения Throwable, если это ошибка.

fun <R, T : R> Result<T>.getOrElse(
    onFailure: (exception: Throwable) -> R
): R
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

getOrThrow

Возвращает заключённое значение, если этот экземпляр представляет успех, или выбрасывает заключённое исключение Throwable, если это ошибка.

fun <T> Result<T>.getOrThrow(): T
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

map

Возвращает результат применения указанной функции transform к заключённому значению, если этот экземпляр представляет успех, или исходное заключённое исключение Throwable, если это ошибка.

fun <R, T> Result<T>.map(
    transform: (value: T) -> R
): Result<R>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

mapCatching

Возвращает результат применения указанной функции transform к заключённому значению, если этот экземпляр представляет успех, или исходное заключённое исключение Throwable, если это ошибка.

fun <R, T> Result<T>.mapCatching(
    transform: (value: T) -> R
): Result<R>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

onFailure

Выполняет заданное действие action над заключённым исключением Throwable, если этот экземпляр представляет ошибку. Возвращает исходный Result без изменений.

fun <T> Result<T>.onFailure(
    action: (exception: Throwable) -> Unit
): Result<T>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

onSuccess

Выполняет заданное действие action над заключённым значением, если этот экземпляр представляет успех. Возвращает исходный Result без изменений.

fun <T> Result<T>.onSuccess(
    action: (value: T) -> Unit
): Result<T>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

recover

Возвращает результат применения указанной функции transform к заключённому исключению Throwable, если этот экземпляр представляет ошибку, или исходное заключённое значение, если это успех.

fun <R, T : R> Result<T>.recover(
    transform: (exception: Throwable) -> R
): Result<R>
Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

recoverCatching

Возвращает результат применения указанной функции transform к заключённому исключению Throwable, если этот экземпляр представляет ошибку, или исходное заключённое значение, если это успех.

fun <R, T : R> Result<T>.recoverCatching(
    transform: (exception: Throwable) -> R
): Result<R>

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/index.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API