Package coil.request

Types

CachePolicy

Represents the read/write policy for a cache source.

DefaultRequestOptions

class DefaultRequestOptions(interceptorDispatcher: CoroutineDispatcher, fetcherDispatcher: CoroutineDispatcher, decoderDispatcher: CoroutineDispatcher, transformationDispatcher: CoroutineDispatcher, transitionFactory: Transition.Factory, precision: Precision, bitmapConfig: Bitmap.Config, allowHardware: Boolean, allowRgb565: Boolean, placeholder: Drawable?, error: Drawable?, fallback: Drawable?, memoryCachePolicy: CachePolicy, diskCachePolicy: CachePolicy, networkCachePolicy: CachePolicy)

A set of default options that are used to fill in unset ImageRequest values.

DefinedRequestOptions

class DefinedRequestOptions(lifecycle: Lifecycle?, sizeResolver: SizeResolver?, scale: Scale?, interceptorDispatcher: CoroutineDispatcher?, fetcherDispatcher: CoroutineDispatcher?, decoderDispatcher: CoroutineDispatcher?, transformationDispatcher: CoroutineDispatcher?, transitionFactory: Transition.Factory?, precision: Precision?, bitmapConfig: Bitmap.Config?, allowHardware: Boolean?, allowRgb565: Boolean?, memoryCachePolicy: CachePolicy?, diskCachePolicy: CachePolicy?, networkCachePolicy: CachePolicy?)

Tracks which values have been set (instead of computed automatically using a default) when building an ImageRequest.

Disposable

Represents the work of an ImageRequest that has been executed by an ImageLoader.

ErrorResult

Indicates that an error occurred while executing the request.

ImageRequest

An immutable value object that represents a request for an image.

ImageResult

sealed class ImageResult

Represents the result of an executed ImageRequest.

NullRequestData

The value for ImageRequest.data if the request's data was not set or was set to null.

NullRequestDataException

Exception thrown when an ImageRequest with empty/null data is executed by an ImageLoader.

Options

class Options(context: Context, config: Bitmap.Config, colorSpace: ColorSpace?, size: Size, scale: Scale, allowInexactSize: Boolean, allowRgb565: Boolean, premultipliedAlpha: Boolean, diskCacheKey: String?, headers: Headers, tags: Tags, parameters: Parameters, memoryCachePolicy: CachePolicy, diskCachePolicy: CachePolicy, networkCachePolicy: CachePolicy)

A set of configuration options for fetching and decoding an image.

Parameters

A map of generic values that can be used to pass custom data to Fetchers and Decoders.

SuccessResult

class SuccessResult(drawable: Drawable, request: ImageRequest, dataSource: DataSource, memoryCacheKey: MemoryCache.Key?, diskCacheKey: String?, isSampled: Boolean, isPlaceholderCached: Boolean) : ImageResult

Indicates that the request completed successfully.