readium-shared/org.readium.r2.shared.util.data

Package-level declarations

Types

AccessError

interface AccessError : Error

Marker interface for source-specific access errors.

CompositeContainer

class CompositeContainer<E : Readable>(containers: List<Container<E>>) : Container<E>

Concatenates several containers.

Container

interface Container<out E : Readable> : Iterable<Url> , Closeable

A container provides access to a list of Readable entries.

DecodeError

sealed class DecodeError : Error

Errors produced when trying to decode content.

EmptyContainer

class EmptyContainer<E : Readable> : Container<E>

A Container providing no entries at all.

Readable

interface Readable : Closeable

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

ReadError

sealed class ReadError : Error

Errors occurring while reading a resource.

ReadException

class ReadException(val error: ReadError) : IOException

An IOException wrapping a ReadError.

ReadTry

typealias ReadTry<SuccessT> = Try<SuccessT, ReadError>

Functions

asInputStream

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

Wraps a Readable into an InputStream.

borrow

fun Readable.borrow(): Readable

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

buffered

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

Wraps this resource into a buffer to improve reading performances.

decode

suspend fun <R, S> S.decode(block: (value: S) -> R, wrapError: (Exception) -> Error): Try<R, DecodeError>

Decodes receiver properly wrapping exceptions into DecodeErrors.

decodeBitmap

suspend fun ByteArray.decodeBitmap(): Try<Bitmap, DecodeError>

Reads the full content as a Bitmap.

decodeJson

suspend fun ByteArray.decodeJson(): Try<JSONObject, DecodeError>

Content parsed from JSON.

decodeOrElse

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

decodeOrNull

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

decodeRwpm

suspend fun ByteArray.decodeRwpm(): Try<Manifest, DecodeError>

Readium Web Publication Manifest parsed from the content.

suspend fun JSONObject.decodeRwpm(): Try<Manifest, DecodeError>

Readium Web Publication Manifest parsed from JSON.

decodeString

suspend fun ByteArray.decodeString(charset: Charset = Charsets.UTF_8): Try<String, DecodeError>

Content as plain text.

decodeXml

suspend fun ByteArray.decodeXml(): Try<ElementNode, DecodeError>

Content as an XML document.

readDecodeOrElse

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

readDecodeOrNull

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

inline suspend fun <S> Container<Readable>.readDecodeOrNull(url: Url, decode: (ByteArray) -> Try<S, DecodeError>): S?

readOrElse

inline suspend fun Readable.readOrElse(recover: (ReadError) -> ByteArray): ByteArray