colibrio-reader-framework/com.colibrio.core.io

Package-level declarations

Types

Represents result of an operation. Can be either ColibrioResult.Success holding data of type T, or ColibrioResult.Error holding exception of type ColibrioException.

RandomAccessDataSource

interface RandomAccessDataSource

A RandomAccessDataSource is used for reading chunks of bytes from file.

RangeRequestNotSupportedException

class RangeRequestNotSupportedException(val url: String, errorMessage: String? = null) : ColibrioException

The caller tried to make a Range request, but the provider did not support range requests for that URL.

ResourceProvider

interface ResourceProvider

The ResourceProvider is an abstraction hiding the details about resource retrieval from the reading system.

ResourceRequestOptions

class ResourceRequestOptions(val accept: List<String>? = null, val range: ByteRangeRequest? = null)

Options object used with ResourceProvider.fetch and ResourceProvider.fetchMetadata.

ResourceResponse

interface ResourceResponse

Describes a response from ResourceProvider.fetch. It contains metadata about the resource and methods for reading the resource body.

ResourceTemporarilyUnavailableException

class ResourceTemporarilyUnavailableException(val url: String, errorMessage: String? = null) : ColibrioException

There was a problem retrieving the resource at that time, but it might work if the resource request is retried later. For example, the user temporarily lost internet connection in a HTTP ResourceProvider.

ZipResourceProvider

interface ZipResourceProvider : ResourceProvider

The ZipResourceProvider is used for fetching resources from a ZIP archive. It reads ZIP archive data from a RandomAccessDataSource.