nutrient/com.pspdfkit.utils/Response

Response

sealed class Response<out T>

A generic class that holds a value with its loading status. Can be used to represent any operation that can be in one of the following states: Loading, Success, Error.

fun example() { // With data val responseWithData: Response = Response.Success("Hello")

// Empty success
val emptyResponse: Response = Response.SuccessEmpty
// Or using convenience constructor
val anotherEmptyResponse: Response = Response.success()

// Handling all cases
when (response) {
    is Response.Success -> println("Success with data: ${response.data}")
    is Response.SuccessEmpty -> println("Success with no data")
    is Response.Error -> println("Error: ${response.exception.message}")
    is Response.Loading -> println("Loading...")
}

// Using handlers
response
    .onSuccess { data -> println("Success: $data") }
    .onSuccessEmpty { println("Success with no data") }
    .onError { error -> println("Error: ${error.message}") }
    .onLoading { println("Loading...") }

}

Inheritors

Types

data class Error(val exception: Throwable) : Response<Nothing>

Represents a failed response containing an exception.

data object Loading : Response<Nothing>

Represents a loading state while an operation is in progress.

data class Success<T>(val data: T) : Response<T>

Represents a successful response containing data.

data object SuccessEmpty : Response<Nothing>

Represents a successful response with no data. Use this when an operation completes successfully but doesn't return any data.

Properties

val isError: Boolean

Returns true if this response represents an error state.

val isLoading: Boolean

Returns true if this response represents a loading state.

val isSuccess: Boolean

Returns true if this response represents a successful state (either Success or SuccessEmpty).

Functions

fun getOrDefault(defaultValue: T): T

Returns the data if this is a Success response, or the provided default value otherwise.

fun getOrNull(): T?

Returns the data if this is a Success response, or null otherwise.

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

Transforms the data in this response using the provided transform function.

fun onError(action: (Throwable) -> Unit): Response<T>

Executes the given action if this is an Error response.

fun onLoading(action: () -> Unit): Response<T>

Executes the given action if this is a Loading response.

suspend fun onSuccess(action: suspend (T) -> Unit): Response<T>

Executes the given action if this is a Success response.

suspend fun onSuccessEmpty(action: suspend () -> Unit): Response<T>

Executes the given action if this is a SuccessEmpty response.