Spec-Zone.ru › Kotlin 2

Result

kotlin-stdlib/kotlin/Result

Начиная с Kotlin: 1.3

@JvmInline
value class Result<out T> : Serializable

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

Типы

Companion

Начиная с Kotlin: 1.3

object Companion

Объект-компаньон класса Result, содержащий функции-конструкторы success и failure.

Свойства

isFailure

Начиная с Kotlin: 1.3

val isFailure: Boolean

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

isSuccess

Начиная с Kotlin: 1.3

val isSuccess: Boolean

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

Функции

exceptionOrNull

Начиная с Kotlin: 1.3

fun exceptionOrNull(): Throwable?

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

fold

Начиная с Kotlin: 1.3

inline fun <R, T> Result<T>.fold(onSuccess: (value: T) -> R, onFailure: (exception: Throwable) -> R): R

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

getOrDefault

Начиная с Kotlin: 1.3

inline fun <R, T : R> Result<T>.getOrDefault(defaultValue: R): R

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

getOrElse

Начиная с Kotlin: 1.3

inline fun <R, T : R> Result<T>.getOrElse(onFailure: (exception: Throwable) -> R): R

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

getOrNull

Начиная с Kotlin: 1.3

inline fun getOrNull(): T?

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

getOrThrow

Начиная с Kotlin: 1.3

inline fun <T> Result<T>.getOrThrow(): T

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

map

Начиная с Kotlin: 1.3

inline fun <R, T> Result<T>.map(transform: (value: T) -> R): Result<R>

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

mapCatching

Начиная с Kotlin: 1.3

inline fun <R, T> Result<T>.mapCatching(transform: (value: T) -> R): Result<R>

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

onFailure

Начиная с Kotlin: 1.3

@IgnorableReturnValue
inline fun <T> Result<T>.onFailure(action: (exception: Throwable) -> Unit): Result<T>

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

onSuccess

Начиная с Kotlin: 1.3

@IgnorableReturnValue
inline fun <T> Result<T>.onSuccess(action: (value: T) -> Unit): Result<T>

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

recover

Начиная с Kotlin: 1.3

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

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

recoverCatching

Начиная с Kotlin: 1.3

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

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

toString

Начиная с Kotlin: 1.3

open override fun toString(): String

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

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

Spec-Zone.ru

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