runtime/dev.zacsweers.metro.internal

Package-level declarations

Types

sealed class AbstractMapFactory<K : Any, V, V2> : Factory<Map<K, V2>>

An abstract Factory implementation used to implement Map bindings.

@Target(allowedTargets = [AnnotationTarget.CLASS])

Marker annotation for generated assisted inject factory classes. This is used internally by Metro to denote factories that were generated for assisted-injected types.

BaseDoubleCheck

abstract class BaseDoubleCheck<T>(provider: Provider<T>) : SynchronizedObject, Provider<T> , Lazy<T>

A Lazy and Provider implementation that memoizes the value returned from a provider. The provider instance is released after it's called.

CallableMetadata

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class CallableMetadata(val callableName: String, val propertyName: String, val startOffset: Int, val endOffset: Int, val newInstanceName: String = "")

Marker for generated factories or binding mirrors indicating their source callable ID.

ComptimeOnly

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class ComptimeOnly

Marks classes or methods that exist only for compile-time purposes and should be removed by minification tools like R8/proguard.

DelegateFactory

class DelegateFactory<T : Any> : Factory<T>

A DelegateFactory that is used to stitch Provider/Lazy indirection based dependency cycles.

DoubleCheck

class DoubleCheck<T> : BaseDoubleCheck<T>

Factory

fun interface Factory<T> : Provider<T>

GraphFactoryInvokeFunctionMarker

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class GraphFactoryInvokeFunctionMarker

Marker for generated factories indicating their invoke function.

InjectedFunctionClass

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class InjectedFunctionClass(val callableName: String)

Marker for generated class wrappers for injected top level functions.

InstanceFactory

class InstanceFactory<T> : Factory<T> , Lazy<T>

A Factory implementation that returns a single instance for all invocations of invoke.

MapFactory

class MapFactory<K : Any, V> : AbstractMapFactory<K, V, V>

A Factory implementation used to implement Map bindings. This factory returns a Map<K, V> when calling invoke (as specified by Factory).

MapLazyFactory

class MapLazyFactory<K : Any, V : Any> : AbstractMapFactory<K, V, Lazy<V>>

A Factory implementation used to implement Map bindings. This factory returns a Map<K, Lazy<V>> when calling .get (as specified by Factory).

MapProviderFactory

class MapProviderFactory<K : Any, V> : AbstractMapFactory<K, V, Provider<V>> , Lazy<Map<K, Provider<V>>>

A Factory implementation used to implement Map bindings. This factory returns a Map<K, Provider<V>> when calling invoke (as specified by Factory).

MapProviderLazyFactory

class MapProviderLazyFactory<K : Any, V : Any> : AbstractMapFactory<K, V, Provider<Lazy<V>>>

A Factory implementation used to implement Map bindings. This factory returns a Map<K, Provider<Lazy<V>>> when calling .get (as specified by Factory).

MembersInjectors

object MembersInjectors

Basic MembersInjector implementations used by the framework.

MetroContribution

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class MetroContribution(val scope: KClass<*>)

Marker for generated nested classes for top-level declarations annotated with @Contributes_.

MetroImplMarker

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class MetroImplMarker

Marker annotation for generated Metro impl classes. Useful for Metro to discover classes across compilations.

MultibindingElement

annotation class MultibindingElement(val bindingId: String, val elementId: String)

Disambiguates between multiple elements of the same type in a set or map. Inspired by Guice.

ProviderOfLazy

class ProviderOfLazy<T> : Provider<Lazy<T>>

A Provider of Lazy instances that each delegate to a given Provider.

SetFactory

class SetFactory<T : Any> : Factory<Set<T>>

A Factory implementation used to implement Set bindings. This factory always returns a new Set instance for each call to invoke (as required by Factory) whose elements are populated by subsequent calls to their Provider.invoke methods.

Functions

hasDuplicates

fun List<*>.hasDuplicates(): Boolean

Returns true if at least one pair of items in this are equal.

newLinkedHashMapWithExpectedSize

fun <K, V> newLinkedHashMapWithExpectedSize(expectedSize: Int): LinkedHashMap<K, V>

Creates a LinkedHashMap instance, with a high enough "initial capacity" that it should hold expectedSize elements without growth.

presizedList

fun <T : Any> presizedList(size: Int): MutableList<T>

Returns a new list that is pre-sized to size, or emptyList if empty. The list returned is never intended to grow beyond size, so adding to a list when the size is 0 is an error.