Readable

Acts as a proxy to an actual data source by handling read access.

Functions

fun Readable.asInputStream(range: LongRange? = null, wrapError: (ReadError) -> IOException = { ReadException(it) }): InputStream

Returns a new Readable accessing the same data but not owning them.

fun Readable.buffered(contentLength: Long? = null, bufferSize: Int = DEFAULT_BUFFER_SIZE): Readable

Wraps this resource into a buffer to improve reading performances.

abstract fun close()

Closes this object and releases any resources associated with it. If the object is already closed then invoking this method has no effect.

abstract suspend fun length(): Try<Long, ReadError>

Returns data length from metadata if available, or calculated from reading the bytes otherwise.

abstract suspend fun read(range: LongRange? = null): Try<ByteArray, ReadError>

Reads the bytes at the given range.

inline suspend fun <R> Readable.readDecodeOrElse(decode: (value: ByteArray) -> Try<R, DecodeError>, recover: (ReadError) -> R): R

inline suspend fun <R> Readable.readDecodeOrElse(decode: (value: ByteArray) -> Try<R, DecodeError>, recoverRead: (ReadError) -> R, recoverDecode: (DecodeError.Decoding) -> R): R

inline suspend fun <R> Readable.readDecodeOrNull(decode: (value: ByteArray) -> Try<R, DecodeError>): R?