Support loading ByteArrays. (#1202)

* Support loading ByteArrays. * Docs.
coil-kt · May 11, 2022 · d6ec2fe · d6ec2fe
1 parent dccb0a8
commit d6ec2fe
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 0 deletions.
diff --git a/coil-base/src/androidTest/java/coil/RealImageLoaderAndroidTest.kt b/coil-base/src/androidTest/java/coil/RealImageLoaderAndroidTest.kt
@@ -220,6 +220,13 @@ class RealImageLoaderAndroidTest {
         testExecute(data)
     }
 
+    @Test
+    fun byteArray() = runTest {
+        val data = context.resources.openRawResource(R.drawable.normal).readBytes()
+        testEnqueue(data)
+        testExecute(data)
+    }
+
     // endregion
 
     @Test

diff --git a/coil-base/src/main/java/coil/RealImageLoader.kt b/coil-base/src/main/java/coil/RealImageLoader.kt
@@ -17,6 +17,7 @@ import coil.intercept.EngineInterceptor
 import coil.intercept.RealInterceptorChain
 import coil.key.FileKeyer
 import coil.key.UriKeyer
+import coil.map.ByteArrayMapper
 import coil.map.FileUriMapper
 import coil.map.HttpUrlMapper
 import coil.map.ResourceIntMapper
@@ -86,6 +87,7 @@ internal class RealImageLoader(
         .add(FileUriMapper())
         .add(ResourceUriMapper())
         .add(ResourceIntMapper())
+        .add(ByteArrayMapper())
         // Keyers
         .add(UriKeyer())
         .add(FileKeyer(options.addLastModifiedToFileCacheKey))

diff --git a/coil-base/src/main/java/coil/map/ByteArrayMapper.kt b/coil-base/src/main/java/coil/map/ByteArrayMapper.kt
@@ -0,0 +1,9 @@
+package coil.map
+
+import coil.request.Options
+import java.nio.ByteBuffer
+
+internal class ByteArrayMapper : Mapper<ByteArray, ByteBuffer> {
+
+    override fun map(data: ByteArray, options: Options): ByteBuffer = ByteBuffer.wrap(data)
+}
diff --git a/coil-base/src/main/java/coil/request/ImageRequest.kt b/coil-base/src/main/java/coil/request/ImageRequest.kt
@@ -451,6 +451,7 @@ class ImageRequest private constructor(
          * - [DrawableRes]
          * - [Drawable]
          * - [Bitmap]
+         * - [ByteArray]
          * - [ByteBuffer]
          */
         fun data(data: Any?) = apply {

diff --git a/coil-singleton/src/main/java/coil/Extensions.kt b/coil-singleton/src/main/java/coil/Extensions.kt
@@ -43,6 +43,7 @@ inline val Context.imageLoader: ImageLoader
  * - [DrawableRes] [Int]
  * - [Drawable]
  * - [Bitmap]
+ * - [ByteArray]
  * - [ByteBuffer]
  *
  * @param data The data to load.

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -106,6 +106,7 @@ The base data types that are supported by all `ImageLoader` instances are:
 * @DrawableRes Int
 * Drawable
 * Bitmap
+* ByteArray
 * ByteBuffer
 
 ## Supported Image Formats