runtime-core/aws.smithy.kotlin.runtime.util

Package-level declarations

Types

interface Buildable<out T>

A type that knows how to build another type

class CachedValue<T>(value: ExpiringValue<T>? = null, bufferTime: <Error class: unknown class> = Duration.ZERO, clock: Clock = Clock.System) : Closeable

Expiry aware value

interface CanDeepCopy<out T>

Indicates that an object supports a deepCopy operation which will return a copy that can be safely mutated without affecting other instances.

DslBuilderProperty

class DslBuilderProperty<SuperBuilder, SuperBuilt>(defaultFactory: DslFactory<SuperBuilder, SuperBuilt>, toBuilderApplicator: SuperBuilt.() -> SuperBuilder.() -> Unit, managedTransform: (SuperBuilt) -> SuperBuilt = { it })

Encapsulates a mutable property for a complex (i.e., non-scalar) type meant to be modified in a mutable builder implementation. This single property provides an instance field for setting a literal value and two dsl overloads for providing configuration for a dynamically-constructed instance. Note that callers should not read the value of instance and should instead use the supply function.

interface DslFactory<out Builder, out Built>

A factory type that can turn a Builder instance into a Built instance. Implementing this factory type can enable usage of custom classes in DSL builders.

EnvironmentProvider

interface EnvironmentProvider

Provide a mapping from key to value

data class ExpiringValue<T>(val value: T, val expiresAt: Instant)

A value with an expiration

interface Filesystem

Abstraction over filesystem

interface LazyAsyncValue<out T>

A value that is produced asynchronously and cached after first initialized.

OperatingSystem

data class OperatingSystem(val family: OsFamily, val version: String?)

enum OsFamily : Enum<OsFamily>

PlatformEnvironProvider

interface PlatformEnvironProvider : EnvironmentProvider, PropertyProvider

PlatformProvider

interface PlatformProvider : PlatformEnvironProvider, Filesystem

PropertyProvider

interface PropertyProvider

Provide a mapping from (JVM) property key to value

SingleFlightGroup

class SingleFlightGroup<T>

Dedupe multiple calls for a resource. A new SingleFlightGroup should be created for each async call that requires debouncing.

TestPlatformProvider

class TestPlatformProvider(env: Map<String, String> = emptyMap(), props: Map<String, String> = emptyMap(), fs: Map<String, String> = emptyMap(), os: OperatingSystem = OperatingSystem(OsFamily.Linux, "test")) : PlatformProvider, Filesystem

An implementation of PlatformProvider meant for testing

data class Uuid(val high: Long, val low: Long)

A KMP-compatible implementation of UUID, necessary because no cross-platform implementation exists yet.

Properties

val <T> Collection<T>.length: Int

Determines the length of a collection. This is a synonym for Collection.size.

Functions

fun <T> asyncLazy(initializer: suspend () -> T): LazyAsyncValue<T>

Create a LazyAsyncValue with the given initializer

fun <Error class: unknown class>.derivedName(name: String): <Error class: unknown class>

Append to the existing coroutine name if it exists in the context otherwise use name as is.

flattenIfPossible

inline fun <T> Collection<T>.flattenIfPossible(): Collection<T>

inline fun <T> Collection<Collection<T>>.flattenIfPossible(): Collection<T>

inline fun <T> <Error class: unknown class><T>.mapErr(onFailure: (Throwable) -> Throwable): <Error class: unknown class><T>

Maps the exception to a new error if this instance represents Result.isFailure, leaving a Result.isSuccess value untouched.

mergeSequential

fun <T> mergeSequential(vararg flows: <Error class: unknown class><T>): <Error class: unknown class><T>

fun Any.toNumber(): Nothing?

fun Double.toNumber(): Double

fun Float.toNumber(): Float

fun Int.toNumber(): Int

fun Long.toNumber(): Long

fun Short.toNumber(): Short

fun String.toNumber(): Double?

fun truthiness(value: Any?): Boolean

Evaluates the "truthiness" of a value based on JMESPath definitions.

fun Any?.type(): String

Returns a JS type as a string