kitepdf-net/io.github.yuroyami.kitepdf.net

Package-level declarations

Properties

const val DEFAULT_MAX_REMOTE_DOCUMENT_BYTES: Int

Default post-decoding response-body ceiling for remote documents (128 MiB). KitePDF holds the download and parsed document in memory at once, so an unbounded body can otherwise terminate a mobile or browser host process.

DEFAULT_MAX_REMOTE_RESOURCE_BYTES

const val DEFAULT_MAX_REMOTE_RESOURCE_BYTES: Int

Default response-body ceiling for one resource that a book names by URL (16 MiB). A book keeps every remote resource in memory for its life, and holds 32 MiB of them at most.

Functions

downloadBytes

suspend fun KiteDoc.downloadBytes(url: String, client: HttpClient, configure: HttpRequestBuilder.() -> Unit = {}): ByteArray

Downloads url and returns the raw bytes, without opening anything.

suspend fun KiteDoc.downloadBytes(url: String, client: HttpClient, maxBytes: Int, configure: HttpRequestBuilder.() -> Unit = {}): ByteArray

downloadBytes with an explicit response-body maxBytes ceiling.

EpubResourceFetcher

fun EpubResourceFetcher(client: HttpClient, maxBytes: Int = DEFAULT_MAX_REMOTE_RESOURCE_BYTES, configure: HttpRequestBuilder.() -> Unit = {}): EpubResourceFetcher

A fetcher for the resources that a book names by an absolute https URL, such as a font or an image on a web server (EPUB 3.3, 3.6), on your client (#38). Set it on the book's settings:

openUrl

suspend fun KiteDoc.openUrl(url: String, client: HttpClient, password: String = "", epubSettings: EpubSettings = EpubSettings(), configure: HttpRequestBuilder.() -> Unit = {}): KiteDocument

Downloads url and opens it as whichever format it turns out to be.

suspend fun KiteDoc.openUrl(url: String, client: HttpClient, maxBytes: Int, password: String = "", epubSettings: EpubSettings = EpubSettings(), configure: HttpRequestBuilder.() -> Unit = {}): KiteDocument

openUrl with an explicit maxBytes ceiling. Raise the default only when the caller has an independent trust boundary and enough process memory.

openUrlOrNull

suspend fun KiteDoc.openUrlOrNull(url: String, client: HttpClient, password: String = "", epubSettings: EpubSettings = EpubSettings(), configure: HttpRequestBuilder.() -> Unit = {}): KiteDocument?

openUrl, but null instead of an exception on any failure, network included.

suspend fun KiteDoc.openUrlOrNull(url: String, client: HttpClient, maxBytes: Int, password: String = "", epubSettings: EpubSettings = EpubSettings(), configure: HttpRequestBuilder.() -> Unit = {}): KiteDocument?

openUrlOrNull with an explicit response-body maxBytes ceiling.