supreme/at.asitplus.signum.supreme/SignatureResult

SignatureResult

sealed interface SignatureResult<out T : CryptoSignature.RawByteEncodable>(source)

Inheritors

Types

object Companion

value class Error(val exception: Throwable) : SignatureResult<Nothing>

The signature failed for an unexpected reason. The thrown exception is contained.

value class Failure(val problem: UserInitiatedCancellationReason) : SignatureResult<Nothing>

The signature failed for expected reasons. Typically, this is because the user cancelled the operation.

value class Success<T : CryptoSignature.RawByteEncodable>(val signature: T) : SignatureResult<T>

The signature succeeded. A signature is contained.

Properties

val SignatureResult<*>.isSuccess: Boolean

val <T : CryptoSignature.RawByteEncodable> SignatureResult<T>.signature: T

Retrieves the contained signature, asserting it exists. If it does not exist, throws the contained problem.

signatureOrNull

val <T : CryptoSignature.RawByteEncodable> SignatureResult<T>.signatureOrNull: T?

Retrieves the contained signature, if one exists.

Functions

fun <T : CryptoSignature.RawByteEncodable> SignatureResult<T>.asKmmResult(): KmmResult<T>

Transforms this SignatureResult into a KmmResult. Both Failure and Error map to KmmResult.Failure.

inline fun <T : CryptoSignature.RawByteEncodable, S : CryptoSignature.RawByteEncodable> SignatureResult<T>.map(block: (T) -> S): SignatureResult<S>

Modifies the contained CryptoSignature, usually in order to reinterpret it as a more narrow type.

inline fun <T : CryptoSignature.RawByteEncodable, S : CryptoSignature.RawByteEncodable> SignatureResult<T>.modify(block: KmmResult<T>.() -> KmmResult<S>): SignatureResult<S>

Modifies the contained CryptoSignature, usually in order to reinterpret it as a more narrow type.