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

Package-level declarations

Types

data class AttributeKey<T>(val name: String)

Specifies a key for an attribute

interface Attributes

Immutable type safe property bag

AttributesBuilder

class AttributesBuilder

ExpiringKeyedCache

interface ExpiringKeyedCache<K, V>

A multi-value cache which supports retrieval and invalidation via a key paired with each value. The get and invalidate methods are suspend functions to allow for cross-context synchronization and potentially-expensive value lookup.

interface MultiMap<K, V> : Map<K, List<V>>

A collection similar to a Map except it allows multiple values to be associated with a single key. The associated values are not necessarily distinct (e.g., key foo may be associated with value bar multiple times).

MutableAttributes

interface MutableAttributes : Attributes

Mutable type safe property bag

MutableMultiMap

interface MutableMultiMap<K, V> : MutableMap<K, MutableList<V>>

A mutable collection similar to a MutableMap except it allows multiple values to be associated with a single key. The associated values are not necessarily distinct (e.g., key foo may be associated with value bar multiple times).

interface ValuesMap<T>

Mapping of String to a List of T values

Inherited properties

val Attributes.isNotEmpty: Boolean

Flag indicating if attributes is not empty

Functions

inline fun attributesOf(block: AttributesBuilder.() -> Unit): Attributes

Return a new set of attributes using AttributesBuilder.

fun <T> createOrAppend(dest: List<T>?, x: T): List<T>

Creates a new list or appends to an existing one if not null.

emptyAttributes

fun emptyAttributes(): Attributes

Returns an empty read-only set of attributes

fun <K, V> multiMapOf(vararg pairs: <Error class: unknown class><K, V>): MultiMap<K, V>

Create a new MultiMap from the given key-value pairs

mutableAttributes

fun mutableAttributes(): MutableAttributes

Returns an empty new mutable set of attributes

mutableAttributesOf

inline fun mutableAttributesOf(block: AttributesBuilder.() -> Unit): MutableAttributes

Return a new set of mutable attributes using AttributesBuilder.

mutableMultiMapOf

fun <K, V> mutableMultiMapOf(vararg pairs: <Error class: unknown class><K, V>): MutableMultiMap<K, V>

Create a new MutableMultiMap from the given key-value pairs.

Inherited functions

fun <E> MutableAttributes.appendValue(key: AttributeKey<List<E>>, element: E)

Appends a value to a list-typed attribute. If the attribute does not exist, it will be created.

operator fun <T : Any> Attributes.get(key: AttributeKey<T>): T

Gets a value of the attribute for the specified key or throws an IllegalStateException if key does not exist

fun MutableAttributes.merge(other: Attributes)

Merge another attributes instance into this set of attributes favoring other

fun <T : Any> MutableAttributes.putIfAbsent(key: AttributeKey<T>, value: T)

Set a value for key only if it is not already set

putIfAbsentNotNull

fun <T : Any> MutableAttributes.putIfAbsentNotNull(key: AttributeKey<T>, value: T?)

Set a value for key only if it is not already set and if value is not null.

setIfValueNotNull

fun <T : Any> MutableAttributes.setIfValueNotNull(key: AttributeKey<T>, value: T?)

Set a value for key only if value is not null

fun <T : Any> MutableAttributes.take(key: AttributeKey<T>): T

Removes an attribute with the specified key and returns its current value, throws an exception if an attribute doesn't exist

fun <T : Any> MutableAttributes.takeOrNull(key: AttributeKey<T>): T?

Removes an attribute with the specified key and returns its current value, returns null if an attribute doesn't exist

toMutableAttributes

fun Attributes.toMutableAttributes(): MutableAttributes

Returns a new MutableAttributes instance with elements from this set of attributes.