coil-core/coil3.decode/ImageSource

ImageSource

sealed interface ImageSource : AutoCloseable

Provides access to the image data to be decoded.

Types

abstract class Metadata

A marker class for metadata for an ImageSource.

Properties

abstract val fileSystem: FileSystem

The FileSystem which contains the file.

abstract val metadata: ImageSource.Metadata?

Return the Metadata for this ImageSource.

Functions

abstract fun file(): Path

Return a Path that resolves to a file containing this ImageSource's data.

abstract fun fileOrNull(): Path?

Return a Path that resolves to a file containing this ImageSource's data if one has already been created. Else, return 'null'.

abstract fun source(): BufferedSource

Return a BufferedSource to read this ImageSource.

abstract fun sourceOrNull(): BufferedSource?

Return the BufferedSource to read this ImageSource if one has already been created. Else, return 'null'.