core/dev.keyboardr.mapsl

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalKeyType

This annotation marks a ServiceKey type that is considered experimental. Its API may be changed or removed in future releases.

Key

typealias Key<T> = ServiceKey<T, *, *, *>

A Key type used in ServiceLocator. Will provide values of type T.

ServiceLocator

abstract class ServiceLocator @JvmOverloads constructor(allowReregister: Boolean = false)

A basic service locator for storing common dependencies. ServiceLocator acts like a heterogeneous map, holding values of different types. The ServiceKey dictates which type will be accessed.

Functions

classKey

inline fun <T : Any> classKey(): LazyKey<T>

Creates a LazyClassKey for the reified type T, which can be used for class-based lookups.

get

inline fun <T : Any> ServiceLocator.get(): T

A convenience extension to fetch a singleton instance from the ServiceLocator using its reified type T as the key.

fun <T : Any> ServiceLocator.get(key: ServiceKey<T, *, Unit, *>): T

Fetches an item for key. If no provider has been registered, this will delegate to ServiceLocator.onMiss.

getOrNull

inline fun <T : Any> ServiceLocator.getOrNull(): T?

A convenience extension to fetch a singleton instance from the ServiceLocator using its reified type T as the key.

fun <T : Any> ServiceLocator.getOrNull(key: ServiceKey<T, *, Unit, *>): T?

Fetches the item for key. If no provider has been registered, returns null. Does not invoke ServiceLocator.onMiss.