coil-test/coil3.test/FakeImageLoaderEngine

FakeImageLoaderEngine

class FakeImageLoaderEngine : Interceptor

An ImageLoader interceptor that intercepts all incoming requests before they're fetched and decoded by the image loader's real image engine. This class is useful for overriding an image loader's responses in tests:

val engine = FakeImageLoaderEngine.Builder()
    .intercept("https://www.example.com/image.jpg", FakeImage())
    .intercept({ it is String && it.endsWith("test.png") }, FakeImage())
    .default(FakeImage(color = 0x0000FF))
    .build()
val imageLoader = ImageLoader.Builder(context)
    .components { add(engine) }
    .build()

Types

OptionalInterceptor

fun interface OptionalInterceptor

An Interceptor that can either:

RequestTransformer

fun interface RequestTransformer

A callback to support modifying an ImageRequest before it's handled by the OptionalInterceptors.

class RequestValue(val request: ImageRequest, val size: Size)

class ResultValue(val request: FakeImageLoaderEngine.RequestValue, val result: ImageResult)

Properties

defaultInterceptor

val defaultInterceptor: Interceptor

val interceptors: List<FakeImageLoaderEngine.OptionalInterceptor>

val requests: Flow<FakeImageLoaderEngine.RequestValue>

Returns a Flow that emits when a request starts.

requestTransformer

val requestTransformer: FakeImageLoaderEngine.RequestTransformer

val results: Flow<FakeImageLoaderEngine.ResultValue>

Returns a Flow that emits when a request completes.

Functions

open suspend override fun intercept(chain: Interceptor.Chain): ImageResult

fun newBuilder(): FakeImageLoaderEngine.Builder

Create a new FakeImageLoaderEngine.Builder with the same configuration.