blockchain-kit-sdk/com.cramium.blockchain.kit.storage/SecureLocalStorageResult

SecureLocalStorageResult

A sealed class representing the result of an operation in secure local storage.

This class is used to encapsulate the outcome of secure local storage operations, allowing differentiation between successful and unsuccessful results.

Inheritors

Success

Failure

Types

Failure

data class Failure(val error: SecureLocalStorageError) : SecureLocalStorageResult

Represents a failure result in a secure local storage operation.

Success

data class Success(val data: Any? = null) : SecureLocalStorageResult

Represents a successful result of a secure local storage operation.

Properties

isFailure

val isFailure: Boolean

Indicates whether the result of the secure local storage operation represents a failure.

isSuccess

val isSuccess: Boolean

Indicates whether the result represents a successful operation.

Functions

exceptionOrNull

fun exceptionOrNull(): Exception?

Returns the exception associated with a failed operation or null if the operation was successful.

getDataOrNull

fun getDataOrNull(): ByteArray?

Returns the stored data as a ByteArray if this instance is a successful result and the data can be cast to ByteArray. If the result is unsuccessful or the data cannot be cast, returns null.

getOrNull

fun getOrNull(): Any?

Retrieves the stored data if the result is a success, or returns null if it is a failure.

getStringOrNull

fun getStringOrNull(): String?

Retrieves the encapsulated data from the result as a String, or returns null if the data is not a String or if the result is a failure.

map

inline fun <R> SecureLocalStorageResult.map(transform: (Any?) -> R): Result<R>

Map success value to another type.

onFailure

inline fun SecureLocalStorageResult.onFailure(block: (SecureLocalStorageError) -> Unit): SecureLocalStorageResult

Execute a block if the result is a failure.

onSuccess

inline fun SecureLocalStorageResult.onSuccess(block: (Any?) -> Unit): SecureLocalStorageResult

Execute a block if the result is successful.