core/org.meshtastic.sdk/AdminResult

AdminResult

sealed interface AdminResult<out T>(source)

Result of an admin (configuration) RPC operation.

Admin operations can fail for expected reasons (device unreachable, unauthorized, timeout) without throwing an exception.

Since

0.1.0

Inheritors

Types

Failed

data class Failed(val routingError: Routing.Error) : AdminResult<Nothing>

Device reported a routing error.

NodeUnreachable

data object NodeUnreachable : AdminResult<Nothing>

Destination node is unreachable.

RateLimited

data object RateLimited : AdminResult<Nothing>

The device rate-limited the request; back off before retrying.

SessionKeyExpired

data object SessionKeyExpired : AdminResult<Nothing>

Session key expired or was never established.

Success

data class Success<T>(val value: T) : AdminResult<T>

Operation succeeded.

Timeout

data object Timeout : AdminResult<Nothing>

Operation timed out waiting for a device response.

Unauthorized

data object Unauthorized : AdminResult<Nothing>

Client is not authorized to perform this operation.

Properties

isSuccess

val <T> AdminResult<T>.isSuccess: Boolean

Returns true if this is AdminResult.Success.

Functions

fold

inline fun <T, R> AdminResult<T>.fold(onSuccess: (T) -> R, onFailure: (AdminResult<T>) -> R): R

Applies onSuccess or onFailure depending on the result.

getOrElse

fun <T> AdminResult<T>.getOrElse(default: T): T

Returns the Success value, or default if the result is not a success.

inline fun <T> AdminResult<T>.getOrElse(block: (AdminResult<T>) -> T): T

Returns the Success value, or the result of block if the result is not a success.

getOrNull

fun <T> AdminResult<T>.getOrNull(): T?

Returns the Success value, or null if the result is not a success.

getOrThrow

fun <T> AdminResult<T>.getOrThrow(): T

Returns the Success value or throws AdminResultException describing the failure.

map

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

Transforms the Success value with transform, propagating failures unchanged.

onFailure

inline fun <T> AdminResult<T>.onFailure(action: (AdminResult<T>) -> Unit): AdminResult<T>

Performs action if this is not a Success. Returns the original result for chaining.

onSuccess

inline fun <T> AdminResult<T>.onSuccess(action: (T) -> Unit): AdminResult<T>

Performs action if this is a Success. Returns the original result for chaining.